2 * nozomi.c -- HSDPA driver Broadband Wireless Data Card - Globe Trotter
4 * Written by: Ulf Jakobsson,
8 * Maintained by: Paul Hardwick (p.hardwick@option.com)
11 * Locking code changes for Vodafone by Sphere Systems Ltd,
12 * Andrew Bird (ajb@spheresystems.co.uk )
15 * Source has been ported from an implementation made by Filip Aben @ Option
17 * --------------------------------------------------------------------------
19 * Copyright (c) 2005,2006 Option Wireless Sweden AB
20 * Copyright (c) 2006 Sphere Systems Ltd
21 * Copyright (c) 2006 Option Wireless n/v
22 * All rights Reserved.
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation; either version 2 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program; if not, write to the Free Software
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
38 * --------------------------------------------------------------------------
41 /* Enable this to have a lot of debug printouts */
44 #include <linux/kernel.h>
45 #include <linux/module.h>
46 #include <linux/pci.h>
47 #include <linux/ioport.h>
48 #include <linux/tty.h>
49 #include <linux/tty_driver.h>
50 #include <linux/tty_flip.h>
51 #include <linux/sched.h>
52 #include <linux/serial.h>
53 #include <linux/interrupt.h>
54 #include <linux/kmod.h>
55 #include <linux/init.h>
56 #include <linux/kfifo.h>
57 #include <linux/uaccess.h>
58 #include <asm/byteorder.h>
60 #include <linux/delay.h>
63 #define VERSION_STRING DRIVER_DESC " 2.1d (build date: " \
64 __DATE__ " " __TIME__ ")"
66 /* Macros definitions */
68 /* Default debug printout level */
69 #define NOZOMI_DEBUG_LEVEL 0x00
71 #define P_BUF_SIZE 128
72 #define NFO(_err_flag_, args...) \
74 char tmp[P_BUF_SIZE]; \
75 snprintf(tmp, sizeof(tmp), ##args); \
76 printk(_err_flag_ "[%d] %s(): %s\n", __LINE__, \
80 #define DBG1(args...) D_(0x01, ##args)
81 #define DBG2(args...) D_(0x02, ##args)
82 #define DBG3(args...) D_(0x04, ##args)
83 #define DBG4(args...) D_(0x08, ##args)
84 #define DBG5(args...) D_(0x10, ##args)
85 #define DBG6(args...) D_(0x20, ##args)
86 #define DBG7(args...) D_(0x40, ##args)
87 #define DBG8(args...) D_(0x80, ##args)
90 /* Do we need this settable at runtime? */
91 static int debug = NOZOMI_DEBUG_LEVEL;
93 #define D(lvl, args...) do \
94 {if (lvl & debug) NFO(KERN_DEBUG, ##args); } \
96 #define D_(lvl, args...) D(lvl, ##args)
98 /* These printouts are always printed */
102 #define D_(lvl, args...)
105 /* TODO: rewrite to optimize macros... */
107 #define TMP_BUF_MAX 256
109 #define DUMP(buf__,len__) \
111 char tbuf[TMP_BUF_MAX] = {0};\
113 snprintf(tbuf, len__ > TMP_BUF_MAX ? TMP_BUF_MAX : len__, "%s", buf__);\
114 if (tbuf[len__-2] == '\r') {\
115 tbuf[len__-2] = 'r';\
117 DBG1("SENDING: '%s' (%d+n)", tbuf, len__);\
119 DBG1("SENDING: '%s' (%d)", tbuf, len__);\
124 #define NOZOMI_NAME "nozomi"
125 #define NOZOMI_NAME_TTY "nozomi_tty"
126 #define DRIVER_DESC "Nozomi driver"
128 #define NTTY_TTY_MAXMINORS 256
129 #define NTTY_FIFO_BUFFER_SIZE 8192
131 /* Must be power of 2 */
132 #define FIFO_BUFFER_SIZE_UL 8192
134 /* Size of tmp send buffer to card */
135 #define SEND_BUF_MAX 1024
136 #define RECEIVE_BUF_MAX 4
139 /* Define all types of vendors and devices to support */
140 #define VENDOR1 0x1931 /* Vendor Option */
141 #define DEVICE1 0x000c /* HSDPA card */
143 #define R_IIR 0x0000 /* Interrupt Identity Register */
144 #define R_FCR 0x0000 /* Flow Control Register */
145 #define R_IER 0x0004 /* Interrupt Enable Register */
147 #define CONFIG_MAGIC 0xEFEFFEFE
148 #define TOGGLE_VALID 0x0000
150 /* Definition of interrupt tokens */
151 #define MDM_DL1 0x0001
152 #define MDM_UL1 0x0002
153 #define MDM_DL2 0x0004
154 #define MDM_UL2 0x0008
155 #define DIAG_DL1 0x0010
156 #define DIAG_DL2 0x0020
157 #define DIAG_UL 0x0040
158 #define APP1_DL 0x0080
159 #define APP1_UL 0x0100
160 #define APP2_DL 0x0200
161 #define APP2_UL 0x0400
162 #define CTRL_DL 0x0800
163 #define CTRL_UL 0x1000
166 #define MDM_DL (MDM_DL1 | MDM_DL2)
167 #define MDM_UL (MDM_UL1 | MDM_UL2)
168 #define DIAG_DL (DIAG_DL1 | DIAG_DL2)
170 /* modem signal definition */
171 #define CTRL_DSR 0x0001
172 #define CTRL_DCD 0x0002
173 #define CTRL_RI 0x0004
174 #define CTRL_CTS 0x0008
176 #define CTRL_DTR 0x0001
177 #define CTRL_RTS 0x0002
180 #define NOZOMI_MAX_PORTS 5
181 #define NOZOMI_MAX_CARDS (NTTY_TTY_MAXMINORS / MAX_PORT)
183 /* Type definitions */
186 * There are two types of nozomi cards,
187 * one with 2048 memory and with 8192 memory
190 F32_2 = 2048, /* 512 bytes downlink + uplink * 2 -> 2048 */
191 F32_8 = 8192, /* 3072 bytes downl. + 1024 bytes uplink * 2 -> 8192 */
194 /* Initialization states a card can be in */
196 NOZOMI_STATE_UKNOWN = 0,
197 NOZOMI_STATE_ENABLED = 1, /* pci device enabled */
198 NOZOMI_STATE_ALLOCATED = 2, /* config setup done */
199 NOZOMI_STATE_READY = 3, /* flowcontrols received */
202 /* Two different toggle channels exist */
208 /* Port definition for the card regarding flow control */
209 enum ctrl_port_type {
218 /* Ports that the nozomi has */
232 unsigned int enabled:5; /*
233 * Toggle fields are valid if enabled is 0,
234 * else A-channels must always be used.
236 unsigned int diag_dl:1;
237 unsigned int mdm_dl:1;
238 unsigned int mdm_ul:1;
239 } __attribute__ ((packed));
241 /* Configuration table to read at startup of card */
242 /* Is for now only needed during initialization phase */
243 struct config_table {
245 u16 product_information;
248 struct toggles toggle;
251 * If this is 64, it can hold
252 * 60 bytes + 4 that is length field
258 * If this is 64, it can hold
259 * 60 bytes + 4 that is length field
274 } __attribute__ ((packed));
276 /* This stores all control downlink flags */
279 unsigned int reserved:4;
284 } __attribute__ ((packed));
286 /* This stores all control uplink flags */
289 unsigned int reserved:6;
292 } __attribute__ ((packed));
297 /* This represents the toggle information */
299 unsigned int mdm_ul:1;
300 unsigned int mdm_dl:1;
301 unsigned int diag_dl:1;
302 unsigned int enabled:5; /*
303 * Toggle fields are valid if enabled is 0,
304 * else A-channels must always be used.
306 } __attribute__ ((packed));
308 /* Configuration table to read at startup of card */
309 struct config_table {
312 u16 product_information;
313 struct toggles toggle;
317 * If this is 64, it can hold
318 * 60 bytes + 4 that is length field
334 } __attribute__ ((packed));
336 /* This stores all control downlink flags */
342 unsigned int reserverd:4;
344 } __attribute__ ((packed));
346 /* This stores all control uplink flags */
350 unsigned int reserved:6;
352 } __attribute__ ((packed));
355 /* This holds all information that is needed regarding a port */
357 struct tty_port port;
358 u8 update_flow_control;
359 struct ctrl_ul ctrl_ul;
360 struct ctrl_dl ctrl_dl;
361 struct kfifo fifo_ul;
362 void __iomem *dl_addr[2];
365 void __iomem *ul_addr[2];
370 /* mutex to ensure one access patch to this port */
371 struct mutex tty_sem;
372 wait_queue_head_t tty_wait;
373 struct async_icount tty_icount;
376 /* Private data one for each card in the system */
378 void __iomem *base_addr;
381 /* Pointers to registers */
382 void __iomem *reg_iir;
383 void __iomem *reg_fcr;
384 void __iomem *reg_ier;
387 enum card_type card_type;
388 struct config_table config_table; /* Configuration table */
389 struct pci_dev *pdev;
390 struct port port[NOZOMI_MAX_PORTS];
393 spinlock_t spin_mutex; /* secures access to registers and tty */
395 unsigned int index_start;
396 enum card_state state;
400 /* This is a data packet that is read or written to/from card */
402 u32 size; /* size is the length of the data buffer */
404 } __attribute__ ((packed));
406 /* Global variables */
407 static const struct pci_device_id nozomi_pci_tbl[] __devinitconst = {
408 {PCI_DEVICE(VENDOR1, DEVICE1)},
412 MODULE_DEVICE_TABLE(pci, nozomi_pci_tbl);
414 static struct nozomi *ndevs[NOZOMI_MAX_CARDS];
415 static struct tty_driver *ntty_driver;
418 * find card by tty_index
420 static inline struct nozomi *get_dc_by_tty(const struct tty_struct *tty)
422 return tty ? ndevs[tty->index / MAX_PORT] : NULL;
425 static inline struct port *get_port_by_tty(const struct tty_struct *tty)
427 struct nozomi *ndev = get_dc_by_tty(tty);
428 return ndev ? &ndev->port[tty->index % MAX_PORT] : NULL;
437 static void read_mem32(u32 *buf, const void __iomem *mem_addr_start,
441 const u32 __iomem *ptr = mem_addr_start;
444 if (unlikely(!ptr || !buf))
447 /* shortcut for extremely often used cases */
448 switch (size_bytes) {
449 case 2: /* 2 bytes */
451 *buf16 = __le16_to_cpu(readw(ptr));
454 case 4: /* 4 bytes */
455 *(buf) = __le32_to_cpu(readl(ptr));
460 while (i < size_bytes) {
461 if (size_bytes - i == 2) {
462 /* Handle 2 bytes in the end */
464 *(buf16) = __le16_to_cpu(readw(ptr));
468 *(buf) = __le32_to_cpu(readl(ptr));
483 static u32 write_mem32(void __iomem *mem_addr_start, const u32 *buf,
487 u32 __iomem *ptr = mem_addr_start;
490 if (unlikely(!ptr || !buf))
493 /* shortcut for extremely often used cases */
494 switch (size_bytes) {
495 case 2: /* 2 bytes */
496 buf16 = (const u16 *)buf;
497 writew(__cpu_to_le16(*buf16), ptr);
501 * also needs to write 4 bytes in this case
502 * so falling through..
504 case 4: /* 4 bytes */
505 writel(__cpu_to_le32(*buf), ptr);
510 while (i < size_bytes) {
511 if (size_bytes - i == 2) {
513 buf16 = (const u16 *)buf;
514 writew(__cpu_to_le16(*buf16), ptr);
518 writel(__cpu_to_le32(*buf), ptr);
527 /* Setup pointers to different channels and also setup buffer sizes. */
528 static void setup_memory(struct nozomi *dc)
530 void __iomem *offset = dc->base_addr + dc->config_table.dl_start;
531 /* The length reported is including the length field of 4 bytes,
532 * hence subtract with 4.
534 const u16 buff_offset = 4;
536 /* Modem port dl configuration */
537 dc->port[PORT_MDM].dl_addr[CH_A] = offset;
538 dc->port[PORT_MDM].dl_addr[CH_B] =
539 (offset += dc->config_table.dl_mdm_len1);
540 dc->port[PORT_MDM].dl_size[CH_A] =
541 dc->config_table.dl_mdm_len1 - buff_offset;
542 dc->port[PORT_MDM].dl_size[CH_B] =
543 dc->config_table.dl_mdm_len2 - buff_offset;
545 /* Diag port dl configuration */
546 dc->port[PORT_DIAG].dl_addr[CH_A] =
547 (offset += dc->config_table.dl_mdm_len2);
548 dc->port[PORT_DIAG].dl_size[CH_A] =
549 dc->config_table.dl_diag_len1 - buff_offset;
550 dc->port[PORT_DIAG].dl_addr[CH_B] =
551 (offset += dc->config_table.dl_diag_len1);
552 dc->port[PORT_DIAG].dl_size[CH_B] =
553 dc->config_table.dl_diag_len2 - buff_offset;
555 /* App1 port dl configuration */
556 dc->port[PORT_APP1].dl_addr[CH_A] =
557 (offset += dc->config_table.dl_diag_len2);
558 dc->port[PORT_APP1].dl_size[CH_A] =
559 dc->config_table.dl_app1_len - buff_offset;
561 /* App2 port dl configuration */
562 dc->port[PORT_APP2].dl_addr[CH_A] =
563 (offset += dc->config_table.dl_app1_len);
564 dc->port[PORT_APP2].dl_size[CH_A] =
565 dc->config_table.dl_app2_len - buff_offset;
567 /* Ctrl dl configuration */
568 dc->port[PORT_CTRL].dl_addr[CH_A] =
569 (offset += dc->config_table.dl_app2_len);
570 dc->port[PORT_CTRL].dl_size[CH_A] =
571 dc->config_table.dl_ctrl_len - buff_offset;
573 offset = dc->base_addr + dc->config_table.ul_start;
575 /* Modem Port ul configuration */
576 dc->port[PORT_MDM].ul_addr[CH_A] = offset;
577 dc->port[PORT_MDM].ul_size[CH_A] =
578 dc->config_table.ul_mdm_len1 - buff_offset;
579 dc->port[PORT_MDM].ul_addr[CH_B] =
580 (offset += dc->config_table.ul_mdm_len1);
581 dc->port[PORT_MDM].ul_size[CH_B] =
582 dc->config_table.ul_mdm_len2 - buff_offset;
584 /* Diag port ul configuration */
585 dc->port[PORT_DIAG].ul_addr[CH_A] =
586 (offset += dc->config_table.ul_mdm_len2);
587 dc->port[PORT_DIAG].ul_size[CH_A] =
588 dc->config_table.ul_diag_len - buff_offset;
590 /* App1 port ul configuration */
591 dc->port[PORT_APP1].ul_addr[CH_A] =
592 (offset += dc->config_table.ul_diag_len);
593 dc->port[PORT_APP1].ul_size[CH_A] =
594 dc->config_table.ul_app1_len - buff_offset;
596 /* App2 port ul configuration */
597 dc->port[PORT_APP2].ul_addr[CH_A] =
598 (offset += dc->config_table.ul_app1_len);
599 dc->port[PORT_APP2].ul_size[CH_A] =
600 dc->config_table.ul_app2_len - buff_offset;
602 /* Ctrl ul configuration */
603 dc->port[PORT_CTRL].ul_addr[CH_A] =
604 (offset += dc->config_table.ul_app2_len);
605 dc->port[PORT_CTRL].ul_size[CH_A] =
606 dc->config_table.ul_ctrl_len - buff_offset;
609 /* Dump config table under initalization phase */
611 static void dump_table(const struct nozomi *dc)
613 DBG3("signature: 0x%08X", dc->config_table.signature);
614 DBG3("version: 0x%04X", dc->config_table.version);
615 DBG3("product_information: 0x%04X", \
616 dc->config_table.product_information);
617 DBG3("toggle enabled: %d", dc->config_table.toggle.enabled);
618 DBG3("toggle up_mdm: %d", dc->config_table.toggle.mdm_ul);
619 DBG3("toggle dl_mdm: %d", dc->config_table.toggle.mdm_dl);
620 DBG3("toggle dl_dbg: %d", dc->config_table.toggle.diag_dl);
622 DBG3("dl_start: 0x%04X", dc->config_table.dl_start);
623 DBG3("dl_mdm_len0: 0x%04X, %d", dc->config_table.dl_mdm_len1,
624 dc->config_table.dl_mdm_len1);
625 DBG3("dl_mdm_len1: 0x%04X, %d", dc->config_table.dl_mdm_len2,
626 dc->config_table.dl_mdm_len2);
627 DBG3("dl_diag_len0: 0x%04X, %d", dc->config_table.dl_diag_len1,
628 dc->config_table.dl_diag_len1);
629 DBG3("dl_diag_len1: 0x%04X, %d", dc->config_table.dl_diag_len2,
630 dc->config_table.dl_diag_len2);
631 DBG3("dl_app1_len: 0x%04X, %d", dc->config_table.dl_app1_len,
632 dc->config_table.dl_app1_len);
633 DBG3("dl_app2_len: 0x%04X, %d", dc->config_table.dl_app2_len,
634 dc->config_table.dl_app2_len);
635 DBG3("dl_ctrl_len: 0x%04X, %d", dc->config_table.dl_ctrl_len,
636 dc->config_table.dl_ctrl_len);
637 DBG3("ul_start: 0x%04X, %d", dc->config_table.ul_start,
638 dc->config_table.ul_start);
639 DBG3("ul_mdm_len[0]: 0x%04X, %d", dc->config_table.ul_mdm_len1,
640 dc->config_table.ul_mdm_len1);
641 DBG3("ul_mdm_len[1]: 0x%04X, %d", dc->config_table.ul_mdm_len2,
642 dc->config_table.ul_mdm_len2);
643 DBG3("ul_diag_len: 0x%04X, %d", dc->config_table.ul_diag_len,
644 dc->config_table.ul_diag_len);
645 DBG3("ul_app1_len: 0x%04X, %d", dc->config_table.ul_app1_len,
646 dc->config_table.ul_app1_len);
647 DBG3("ul_app2_len: 0x%04X, %d", dc->config_table.ul_app2_len,
648 dc->config_table.ul_app2_len);
649 DBG3("ul_ctrl_len: 0x%04X, %d", dc->config_table.ul_ctrl_len,
650 dc->config_table.ul_ctrl_len);
653 static inline void dump_table(const struct nozomi *dc) { }
657 * Read configuration table from card under intalization phase
658 * Returns 1 if ok, else 0
660 static int nozomi_read_config_table(struct nozomi *dc)
662 read_mem32((u32 *) &dc->config_table, dc->base_addr + 0,
663 sizeof(struct config_table));
665 if (dc->config_table.signature != CONFIG_MAGIC) {
666 dev_err(&dc->pdev->dev, "ConfigTable Bad! 0x%08X != 0x%08X\n",
667 dc->config_table.signature, CONFIG_MAGIC);
671 if ((dc->config_table.version == 0)
672 || (dc->config_table.toggle.enabled == TOGGLE_VALID)) {
674 DBG1("Second phase, configuring card");
678 dc->port[PORT_MDM].toggle_ul = dc->config_table.toggle.mdm_ul;
679 dc->port[PORT_MDM].toggle_dl = dc->config_table.toggle.mdm_dl;
680 dc->port[PORT_DIAG].toggle_dl = dc->config_table.toggle.diag_dl;
681 DBG1("toggle ports: MDM UL:%d MDM DL:%d, DIAG DL:%d",
682 dc->port[PORT_MDM].toggle_ul,
683 dc->port[PORT_MDM].toggle_dl, dc->port[PORT_DIAG].toggle_dl);
687 for (i = PORT_MDM; i < MAX_PORT; i++) {
688 memset(&dc->port[i].ctrl_dl, 0, sizeof(struct ctrl_dl));
689 memset(&dc->port[i].ctrl_ul, 0, sizeof(struct ctrl_ul));
692 /* Enable control channel */
693 dc->last_ier = dc->last_ier | CTRL_DL;
694 writew(dc->last_ier, dc->reg_ier);
696 dc->state = NOZOMI_STATE_ALLOCATED;
697 dev_info(&dc->pdev->dev, "Initialization OK!\n");
701 if ((dc->config_table.version > 0)
702 && (dc->config_table.toggle.enabled != TOGGLE_VALID)) {
704 DBG1("First phase: pushing upload buffers, clearing download");
706 dev_info(&dc->pdev->dev, "Version of card: %d\n",
707 dc->config_table.version);
709 /* Here we should disable all I/O over F32. */
713 * We should send ALL channel pair tokens back along
717 /* push upload modem buffers */
718 write_mem32(dc->port[PORT_MDM].ul_addr[CH_A],
720 write_mem32(dc->port[PORT_MDM].ul_addr[CH_B],
723 writew(MDM_UL | DIAG_DL | MDM_DL, dc->reg_fcr);
725 DBG1("First phase done");
731 /* Enable uplink interrupts */
732 static void enable_transmit_ul(enum port_type port, struct nozomi *dc)
734 static const u16 mask[] = {MDM_UL, DIAG_UL, APP1_UL, APP2_UL, CTRL_UL};
736 if (port < NOZOMI_MAX_PORTS) {
737 dc->last_ier |= mask[port];
738 writew(dc->last_ier, dc->reg_ier);
740 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
744 /* Disable uplink interrupts */
745 static void disable_transmit_ul(enum port_type port, struct nozomi *dc)
747 static const u16 mask[] =
748 {~MDM_UL, ~DIAG_UL, ~APP1_UL, ~APP2_UL, ~CTRL_UL};
750 if (port < NOZOMI_MAX_PORTS) {
751 dc->last_ier &= mask[port];
752 writew(dc->last_ier, dc->reg_ier);
754 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
758 /* Enable downlink interrupts */
759 static void enable_transmit_dl(enum port_type port, struct nozomi *dc)
761 static const u16 mask[] = {MDM_DL, DIAG_DL, APP1_DL, APP2_DL, CTRL_DL};
763 if (port < NOZOMI_MAX_PORTS) {
764 dc->last_ier |= mask[port];
765 writew(dc->last_ier, dc->reg_ier);
767 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
771 /* Disable downlink interrupts */
772 static void disable_transmit_dl(enum port_type port, struct nozomi *dc)
774 static const u16 mask[] =
775 {~MDM_DL, ~DIAG_DL, ~APP1_DL, ~APP2_DL, ~CTRL_DL};
777 if (port < NOZOMI_MAX_PORTS) {
778 dc->last_ier &= mask[port];
779 writew(dc->last_ier, dc->reg_ier);
781 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
786 * Return 1 - send buffer to card and ack.
787 * Return 0 - don't ack, don't send buffer to card.
789 static int send_data(enum port_type index, struct nozomi *dc)
792 struct port *port = &dc->port[index];
793 const u8 toggle = port->toggle_ul;
794 void __iomem *addr = port->ul_addr[toggle];
795 const u32 ul_size = port->ul_size[toggle];
796 struct tty_struct *tty = tty_port_tty_get(&port->port);
798 /* Get data from tty and place in buf for now */
799 size = kfifo_out(&port->fifo_ul, dc->send_buf,
800 ul_size < SEND_BUF_MAX ? ul_size : SEND_BUF_MAX);
803 DBG4("No more data to send, disable link:");
808 /* DUMP(buf, size); */
810 /* Write length + data */
811 write_mem32(addr, (u32 *) &size, 4);
812 write_mem32(addr + 4, (u32 *) dc->send_buf, size);
821 /* If all data has been read, return 1, else 0 */
822 static int receive_data(enum port_type index, struct nozomi *dc)
824 u8 buf[RECEIVE_BUF_MAX] = { 0 };
827 struct port *port = &dc->port[index];
828 void __iomem *addr = port->dl_addr[port->toggle_dl];
829 struct tty_struct *tty = tty_port_tty_get(&port->port);
832 if (unlikely(!tty)) {
833 DBG1("tty not open for port: %d?", index);
837 read_mem32((u32 *) &size, addr, 4);
838 /* DBG1( "%d bytes port: %d", size, index); */
840 if (test_bit(TTY_THROTTLED, &tty->flags)) {
841 DBG1("No room in tty, don't read data, don't ack interrupt, "
842 "disable interrupt");
844 /* disable interrupt in downlink... */
845 disable_transmit_dl(index, dc);
850 if (unlikely(size == 0)) {
851 dev_err(&dc->pdev->dev, "size == 0?\n");
856 tty_buffer_request_room(tty, size);
859 read_mem32((u32 *) buf, addr + offset, RECEIVE_BUF_MAX);
862 tty_insert_flip_char(tty, buf[0], TTY_NORMAL);
864 } else if (size < RECEIVE_BUF_MAX) {
865 size -= tty_insert_flip_string(tty, (char *) buf, size);
867 i = tty_insert_flip_string(tty, \
868 (char *) buf, RECEIVE_BUF_MAX);
874 set_bit(index, &dc->flip);
881 /* Debug for interrupts */
883 static char *interrupt2str(u16 interrupt)
885 static char buf[TMP_BUF_MAX];
888 interrupt & MDM_DL1 ? p += snprintf(p, TMP_BUF_MAX, "MDM_DL1 ") : NULL;
889 interrupt & MDM_DL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
892 interrupt & MDM_UL1 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
894 interrupt & MDM_UL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
897 interrupt & DIAG_DL1 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
899 interrupt & DIAG_DL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
902 interrupt & DIAG_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
905 interrupt & APP1_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
907 interrupt & APP2_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
910 interrupt & APP1_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
912 interrupt & APP2_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
915 interrupt & CTRL_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
917 interrupt & CTRL_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
920 interrupt & RESET ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
928 * Receive flow control
929 * Return 1 - If ok, else 0
931 static int receive_flow_control(struct nozomi *dc)
933 enum port_type port = PORT_MDM;
934 struct ctrl_dl ctrl_dl;
935 struct ctrl_dl old_ctrl;
938 read_mem32((u32 *) &ctrl_dl, dc->port[PORT_CTRL].dl_addr[CH_A], 2);
940 switch (ctrl_dl.port) {
942 DBG1("The Base Band sends this value as a response to a "
943 "request for IMSI detach sent over the control "
944 "channel uplink (see section 7.6.1).");
952 enable_ier = DIAG_DL;
956 enable_ier = APP1_DL;
960 enable_ier = APP2_DL;
961 if (dc->state == NOZOMI_STATE_ALLOCATED) {
963 * After card initialization the flow control
964 * received for APP2 is always the last
966 dc->state = NOZOMI_STATE_READY;
967 dev_info(&dc->pdev->dev, "Device READY!\n");
971 dev_err(&dc->pdev->dev,
972 "ERROR: flow control received for non-existing port\n");
976 DBG1("0x%04X->0x%04X", *((u16 *)&dc->port[port].ctrl_dl),
979 old_ctrl = dc->port[port].ctrl_dl;
980 dc->port[port].ctrl_dl = ctrl_dl;
982 if (old_ctrl.CTS == 1 && ctrl_dl.CTS == 0) {
983 DBG1("Disable interrupt (0x%04X) on port: %d",
985 disable_transmit_ul(port, dc);
987 } else if (old_ctrl.CTS == 0 && ctrl_dl.CTS == 1) {
989 if (kfifo_len(&dc->port[port].fifo_ul)) {
990 DBG1("Enable interrupt (0x%04X) on port: %d",
992 DBG1("Data in buffer [%d], enable transmit! ",
993 kfifo_len(&dc->port[port].fifo_ul));
994 enable_transmit_ul(port, dc);
996 DBG1("No data in buffer...");
1000 if (*(u16 *)&old_ctrl == *(u16 *)&ctrl_dl) {
1001 DBG1(" No change in mctrl");
1004 /* Update statistics */
1005 if (old_ctrl.CTS != ctrl_dl.CTS)
1006 dc->port[port].tty_icount.cts++;
1007 if (old_ctrl.DSR != ctrl_dl.DSR)
1008 dc->port[port].tty_icount.dsr++;
1009 if (old_ctrl.RI != ctrl_dl.RI)
1010 dc->port[port].tty_icount.rng++;
1011 if (old_ctrl.DCD != ctrl_dl.DCD)
1012 dc->port[port].tty_icount.dcd++;
1014 wake_up_interruptible(&dc->port[port].tty_wait);
1016 DBG1("port: %d DCD(%d), CTS(%d), RI(%d), DSR(%d)",
1018 dc->port[port].tty_icount.dcd, dc->port[port].tty_icount.cts,
1019 dc->port[port].tty_icount.rng, dc->port[port].tty_icount.dsr);
1024 static enum ctrl_port_type port2ctrl(enum port_type port,
1025 const struct nozomi *dc)
1037 dev_err(&dc->pdev->dev,
1038 "ERROR: send flow control " \
1039 "received for non-existing port\n");
1045 * Send flow control, can only update one channel at a time
1046 * Return 0 - If we have updated all flow control
1047 * Return 1 - If we need to update more flow control, ack current enable more
1049 static int send_flow_control(struct nozomi *dc)
1051 u32 i, more_flow_control_to_be_updated = 0;
1054 for (i = PORT_MDM; i < MAX_PORT; i++) {
1055 if (dc->port[i].update_flow_control) {
1056 if (more_flow_control_to_be_updated) {
1057 /* We have more flow control to be updated */
1060 dc->port[i].ctrl_ul.port = port2ctrl(i, dc);
1061 ctrl = (u16 *)&dc->port[i].ctrl_ul;
1062 write_mem32(dc->port[PORT_CTRL].ul_addr[0], \
1064 dc->port[i].update_flow_control = 0;
1065 more_flow_control_to_be_updated = 1;
1072 * Handle downlink data, ports that are handled are modem and diagnostics
1074 * Return 0 - toggle fields are out of sync
1076 static int handle_data_dl(struct nozomi *dc, enum port_type port, u8 *toggle,
1077 u16 read_iir, u16 mask1, u16 mask2)
1079 if (*toggle == 0 && read_iir & mask1) {
1080 if (receive_data(port, dc)) {
1081 writew(mask1, dc->reg_fcr);
1082 *toggle = !(*toggle);
1085 if (read_iir & mask2) {
1086 if (receive_data(port, dc)) {
1087 writew(mask2, dc->reg_fcr);
1088 *toggle = !(*toggle);
1091 } else if (*toggle == 1 && read_iir & mask2) {
1092 if (receive_data(port, dc)) {
1093 writew(mask2, dc->reg_fcr);
1094 *toggle = !(*toggle);
1097 if (read_iir & mask1) {
1098 if (receive_data(port, dc)) {
1099 writew(mask1, dc->reg_fcr);
1100 *toggle = !(*toggle);
1104 dev_err(&dc->pdev->dev, "port out of sync!, toggle:%d\n",
1112 * Handle uplink data, this is currently for the modem port
1114 * Return 0 - toggle field are out of sync
1116 static int handle_data_ul(struct nozomi *dc, enum port_type port, u16 read_iir)
1118 u8 *toggle = &(dc->port[port].toggle_ul);
1120 if (*toggle == 0 && read_iir & MDM_UL1) {
1121 dc->last_ier &= ~MDM_UL;
1122 writew(dc->last_ier, dc->reg_ier);
1123 if (send_data(port, dc)) {
1124 writew(MDM_UL1, dc->reg_fcr);
1125 dc->last_ier = dc->last_ier | MDM_UL;
1126 writew(dc->last_ier, dc->reg_ier);
1130 if (read_iir & MDM_UL2) {
1131 dc->last_ier &= ~MDM_UL;
1132 writew(dc->last_ier, dc->reg_ier);
1133 if (send_data(port, dc)) {
1134 writew(MDM_UL2, dc->reg_fcr);
1135 dc->last_ier = dc->last_ier | MDM_UL;
1136 writew(dc->last_ier, dc->reg_ier);
1141 } else if (*toggle == 1 && read_iir & MDM_UL2) {
1142 dc->last_ier &= ~MDM_UL;
1143 writew(dc->last_ier, dc->reg_ier);
1144 if (send_data(port, dc)) {
1145 writew(MDM_UL2, dc->reg_fcr);
1146 dc->last_ier = dc->last_ier | MDM_UL;
1147 writew(dc->last_ier, dc->reg_ier);
1151 if (read_iir & MDM_UL1) {
1152 dc->last_ier &= ~MDM_UL;
1153 writew(dc->last_ier, dc->reg_ier);
1154 if (send_data(port, dc)) {
1155 writew(MDM_UL1, dc->reg_fcr);
1156 dc->last_ier = dc->last_ier | MDM_UL;
1157 writew(dc->last_ier, dc->reg_ier);
1162 writew(read_iir & MDM_UL, dc->reg_fcr);
1163 dev_err(&dc->pdev->dev, "port out of sync!\n");
1169 static irqreturn_t interrupt_handler(int irq, void *dev_id)
1171 struct nozomi *dc = dev_id;
1178 spin_lock(&dc->spin_mutex);
1179 read_iir = readw(dc->reg_iir);
1182 if (read_iir == (u16)-1)
1185 * Just handle interrupt enabled in IER
1186 * (by masking with dc->last_ier)
1188 read_iir &= dc->last_ier;
1194 DBG4("%s irq:0x%04X, prev:0x%04X", interrupt2str(read_iir), read_iir,
1197 if (read_iir & RESET) {
1198 if (unlikely(!nozomi_read_config_table(dc))) {
1200 writew(dc->last_ier, dc->reg_ier);
1201 dev_err(&dc->pdev->dev, "Could not read status from "
1202 "card, we should disable interface\n");
1204 writew(RESET, dc->reg_fcr);
1206 /* No more useful info if this was the reset interrupt. */
1209 if (read_iir & CTRL_UL) {
1211 dc->last_ier &= ~CTRL_UL;
1212 writew(dc->last_ier, dc->reg_ier);
1213 if (send_flow_control(dc)) {
1214 writew(CTRL_UL, dc->reg_fcr);
1215 dc->last_ier = dc->last_ier | CTRL_UL;
1216 writew(dc->last_ier, dc->reg_ier);
1219 if (read_iir & CTRL_DL) {
1220 receive_flow_control(dc);
1221 writew(CTRL_DL, dc->reg_fcr);
1223 if (read_iir & MDM_DL) {
1224 if (!handle_data_dl(dc, PORT_MDM,
1225 &(dc->port[PORT_MDM].toggle_dl), read_iir,
1226 MDM_DL1, MDM_DL2)) {
1227 dev_err(&dc->pdev->dev, "MDM_DL out of sync!\n");
1231 if (read_iir & MDM_UL) {
1232 if (!handle_data_ul(dc, PORT_MDM, read_iir)) {
1233 dev_err(&dc->pdev->dev, "MDM_UL out of sync!\n");
1237 if (read_iir & DIAG_DL) {
1238 if (!handle_data_dl(dc, PORT_DIAG,
1239 &(dc->port[PORT_DIAG].toggle_dl), read_iir,
1240 DIAG_DL1, DIAG_DL2)) {
1241 dev_err(&dc->pdev->dev, "DIAG_DL out of sync!\n");
1245 if (read_iir & DIAG_UL) {
1246 dc->last_ier &= ~DIAG_UL;
1247 writew(dc->last_ier, dc->reg_ier);
1248 if (send_data(PORT_DIAG, dc)) {
1249 writew(DIAG_UL, dc->reg_fcr);
1250 dc->last_ier = dc->last_ier | DIAG_UL;
1251 writew(dc->last_ier, dc->reg_ier);
1254 if (read_iir & APP1_DL) {
1255 if (receive_data(PORT_APP1, dc))
1256 writew(APP1_DL, dc->reg_fcr);
1258 if (read_iir & APP1_UL) {
1259 dc->last_ier &= ~APP1_UL;
1260 writew(dc->last_ier, dc->reg_ier);
1261 if (send_data(PORT_APP1, dc)) {
1262 writew(APP1_UL, dc->reg_fcr);
1263 dc->last_ier = dc->last_ier | APP1_UL;
1264 writew(dc->last_ier, dc->reg_ier);
1267 if (read_iir & APP2_DL) {
1268 if (receive_data(PORT_APP2, dc))
1269 writew(APP2_DL, dc->reg_fcr);
1271 if (read_iir & APP2_UL) {
1272 dc->last_ier &= ~APP2_UL;
1273 writew(dc->last_ier, dc->reg_ier);
1274 if (send_data(PORT_APP2, dc)) {
1275 writew(APP2_UL, dc->reg_fcr);
1276 dc->last_ier = dc->last_ier | APP2_UL;
1277 writew(dc->last_ier, dc->reg_ier);
1282 spin_unlock(&dc->spin_mutex);
1283 for (a = 0; a < NOZOMI_MAX_PORTS; a++) {
1284 struct tty_struct *tty;
1285 if (test_and_clear_bit(a, &dc->flip)) {
1286 tty = tty_port_tty_get(&dc->port[a].port);
1288 tty_flip_buffer_push(tty);
1294 spin_unlock(&dc->spin_mutex);
1298 static void nozomi_get_card_type(struct nozomi *dc)
1303 for (i = 0; i < 6; i++)
1304 size += pci_resource_len(dc->pdev, i);
1306 /* Assume card type F32_8 if no match */
1307 dc->card_type = size == 2048 ? F32_2 : F32_8;
1309 dev_info(&dc->pdev->dev, "Card type is: %d\n", dc->card_type);
1312 static void nozomi_setup_private_data(struct nozomi *dc)
1314 void __iomem *offset = dc->base_addr + dc->card_type / 2;
1317 dc->reg_fcr = (void __iomem *)(offset + R_FCR);
1318 dc->reg_iir = (void __iomem *)(offset + R_IIR);
1319 dc->reg_ier = (void __iomem *)(offset + R_IER);
1323 dc->port[PORT_MDM].token_dl = MDM_DL;
1324 dc->port[PORT_DIAG].token_dl = DIAG_DL;
1325 dc->port[PORT_APP1].token_dl = APP1_DL;
1326 dc->port[PORT_APP2].token_dl = APP2_DL;
1328 for (i = 0; i < MAX_PORT; i++)
1329 init_waitqueue_head(&dc->port[i].tty_wait);
1332 static ssize_t card_type_show(struct device *dev, struct device_attribute *attr,
1335 const struct nozomi *dc = pci_get_drvdata(to_pci_dev(dev));
1337 return sprintf(buf, "%d\n", dc->card_type);
1339 static DEVICE_ATTR(card_type, S_IRUGO, card_type_show, NULL);
1341 static ssize_t open_ttys_show(struct device *dev, struct device_attribute *attr,
1344 const struct nozomi *dc = pci_get_drvdata(to_pci_dev(dev));
1346 return sprintf(buf, "%u\n", dc->open_ttys);
1348 static DEVICE_ATTR(open_ttys, S_IRUGO, open_ttys_show, NULL);
1350 static void make_sysfs_files(struct nozomi *dc)
1352 if (device_create_file(&dc->pdev->dev, &dev_attr_card_type))
1353 dev_err(&dc->pdev->dev,
1354 "Could not create sysfs file for card_type\n");
1355 if (device_create_file(&dc->pdev->dev, &dev_attr_open_ttys))
1356 dev_err(&dc->pdev->dev,
1357 "Could not create sysfs file for open_ttys\n");
1360 static void remove_sysfs_files(struct nozomi *dc)
1362 device_remove_file(&dc->pdev->dev, &dev_attr_card_type);
1363 device_remove_file(&dc->pdev->dev, &dev_attr_open_ttys);
1366 /* Allocate memory for one device */
1367 static int __devinit nozomi_card_init(struct pci_dev *pdev,
1368 const struct pci_device_id *ent)
1370 resource_size_t start;
1372 struct nozomi *dc = NULL;
1376 dev_dbg(&pdev->dev, "Init, new card found\n");
1378 for (ndev_idx = 0; ndev_idx < ARRAY_SIZE(ndevs); ndev_idx++)
1379 if (!ndevs[ndev_idx])
1382 if (ndev_idx >= ARRAY_SIZE(ndevs)) {
1383 dev_err(&pdev->dev, "no free tty range for this card left\n");
1388 dc = kzalloc(sizeof(struct nozomi), GFP_KERNEL);
1389 if (unlikely(!dc)) {
1390 dev_err(&pdev->dev, "Could not allocate memory\n");
1397 ret = pci_enable_device(dc->pdev);
1399 dev_err(&pdev->dev, "Failed to enable PCI Device\n");
1403 ret = pci_request_regions(dc->pdev, NOZOMI_NAME);
1405 dev_err(&pdev->dev, "I/O address 0x%04x already in use\n",
1406 (int) /* nozomi_private.io_addr */ 0);
1407 goto err_disable_device;
1410 start = pci_resource_start(dc->pdev, 0);
1412 dev_err(&pdev->dev, "No I/O address for card detected\n");
1417 /* Find out what card type it is */
1418 nozomi_get_card_type(dc);
1420 dc->base_addr = ioremap_nocache(start, dc->card_type);
1421 if (!dc->base_addr) {
1422 dev_err(&pdev->dev, "Unable to map card MMIO\n");
1427 dc->send_buf = kmalloc(SEND_BUF_MAX, GFP_KERNEL);
1428 if (!dc->send_buf) {
1429 dev_err(&pdev->dev, "Could not allocate send buffer?\n");
1434 for (i = PORT_MDM; i < MAX_PORT; i++) {
1435 if (kfifo_alloc(&dc->port[i].fifo_ul,
1436 FIFO_BUFFER_SIZE_UL, GFP_ATOMIC)) {
1438 "Could not allocate kfifo buffer\n");
1440 goto err_free_kfifo;
1444 spin_lock_init(&dc->spin_mutex);
1446 nozomi_setup_private_data(dc);
1448 /* Disable all interrupts */
1450 writew(dc->last_ier, dc->reg_ier);
1452 ret = request_irq(pdev->irq, &interrupt_handler, IRQF_SHARED,
1454 if (unlikely(ret)) {
1455 dev_err(&pdev->dev, "can't request irq %d\n", pdev->irq);
1456 goto err_free_kfifo;
1459 DBG1("base_addr: %p", dc->base_addr);
1461 make_sysfs_files(dc);
1463 dc->index_start = ndev_idx * MAX_PORT;
1464 ndevs[ndev_idx] = dc;
1466 pci_set_drvdata(pdev, dc);
1468 /* Enable RESET interrupt */
1469 dc->last_ier = RESET;
1470 iowrite16(dc->last_ier, dc->reg_ier);
1472 dc->state = NOZOMI_STATE_ENABLED;
1474 for (i = 0; i < MAX_PORT; i++) {
1475 struct device *tty_dev;
1477 mutex_init(&dc->port[i].tty_sem);
1478 tty_port_init(&dc->port[i].port);
1479 tty_dev = tty_register_device(ntty_driver, dc->index_start + i,
1482 if (IS_ERR(tty_dev)) {
1483 ret = PTR_ERR(tty_dev);
1484 dev_err(&pdev->dev, "Could not allocate tty?\n");
1492 for (i = dc->index_start; i < dc->index_start + MAX_PORT; ++i)
1493 tty_unregister_device(ntty_driver, i);
1495 for (i = 0; i < MAX_PORT; i++)
1496 kfifo_free(&dc->port[i].fifo_ul);
1498 kfree(dc->send_buf);
1499 iounmap(dc->base_addr);
1501 pci_release_regions(pdev);
1503 pci_disable_device(pdev);
1510 static void __devexit tty_exit(struct nozomi *dc)
1516 flush_scheduled_work();
1518 for (i = 0; i < MAX_PORT; ++i) {
1519 struct tty_struct *tty = tty_port_tty_get(&dc->port[i].port);
1520 if (tty && list_empty(&tty->hangup_work.entry))
1524 /* Racy below - surely should wait for scheduled work to be done or
1525 complete off a hangup method ? */
1526 while (dc->open_ttys)
1528 for (i = dc->index_start; i < dc->index_start + MAX_PORT; ++i)
1529 tty_unregister_device(ntty_driver, i);
1532 /* Deallocate memory for one device */
1533 static void __devexit nozomi_card_exit(struct pci_dev *pdev)
1536 struct ctrl_ul ctrl;
1537 struct nozomi *dc = pci_get_drvdata(pdev);
1539 /* Disable all interrupts */
1541 writew(dc->last_ier, dc->reg_ier);
1545 /* Send 0x0001, command card to resend the reset token. */
1546 /* This is to get the reset when the module is reloaded. */
1551 DBG1("sending flow control 0x%04X", *((u16 *)&ctrl));
1553 /* Setup dc->reg addresses to we can use defines here */
1554 write_mem32(dc->port[PORT_CTRL].ul_addr[0], (u32 *)&ctrl, 2);
1555 writew(CTRL_UL, dc->reg_fcr); /* push the token to the card. */
1557 remove_sysfs_files(dc);
1559 free_irq(pdev->irq, dc);
1561 for (i = 0; i < MAX_PORT; i++)
1562 kfifo_free(&dc->port[i].fifo_ul);
1564 kfree(dc->send_buf);
1566 iounmap(dc->base_addr);
1568 pci_release_regions(pdev);
1570 pci_disable_device(pdev);
1572 ndevs[dc->index_start / MAX_PORT] = NULL;
1577 static void set_rts(const struct tty_struct *tty, int rts)
1579 struct port *port = get_port_by_tty(tty);
1581 port->ctrl_ul.RTS = rts;
1582 port->update_flow_control = 1;
1583 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1586 static void set_dtr(const struct tty_struct *tty, int dtr)
1588 struct port *port = get_port_by_tty(tty);
1590 DBG1("SETTING DTR index: %d, dtr: %d", tty->index, dtr);
1592 port->ctrl_ul.DTR = dtr;
1593 port->update_flow_control = 1;
1594 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1598 * ----------------------------------------------------------------------------
1600 * ----------------------------------------------------------------------------
1603 /* Called when the userspace process opens the tty, /dev/noz*. */
1604 static int ntty_open(struct tty_struct *tty, struct file *file)
1606 struct port *port = get_port_by_tty(tty);
1607 struct nozomi *dc = get_dc_by_tty(tty);
1608 unsigned long flags;
1610 if (!port || !dc || dc->state != NOZOMI_STATE_READY)
1613 if (mutex_lock_interruptible(&port->tty_sem))
1614 return -ERESTARTSYS;
1619 /* Enable interrupt downlink for channel */
1620 if (port->port.count == 1) {
1621 tty->driver_data = port;
1622 tty_port_tty_set(&port->port, tty);
1623 DBG1("open: %d", port->token_dl);
1624 spin_lock_irqsave(&dc->spin_mutex, flags);
1625 dc->last_ier = dc->last_ier | port->token_dl;
1626 writew(dc->last_ier, dc->reg_ier);
1627 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1629 mutex_unlock(&port->tty_sem);
1633 /* Called when the userspace process close the tty, /dev/noz*. Also
1634 called immediately if ntty_open fails in which case tty->driver_data
1635 will be NULL an we exit by the first return */
1637 static void ntty_close(struct tty_struct *tty, struct file *file)
1639 struct nozomi *dc = get_dc_by_tty(tty);
1640 struct port *nport = tty->driver_data;
1641 struct tty_port *port = &nport->port;
1642 unsigned long flags;
1647 /* Users cannot interrupt a close */
1648 mutex_lock(&nport->tty_sem);
1650 WARN_ON(!port->count);
1655 if (port->count == 0) {
1656 DBG1("close: %d", nport->token_dl);
1657 tty_port_tty_set(port, NULL);
1658 spin_lock_irqsave(&dc->spin_mutex, flags);
1659 dc->last_ier &= ~(nport->token_dl);
1660 writew(dc->last_ier, dc->reg_ier);
1661 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1663 mutex_unlock(&nport->tty_sem);
1667 * called when the userspace process writes to the tty (/dev/noz*).
1668 * Data is inserted into a fifo, which is then read and transfered to the modem.
1670 static int ntty_write(struct tty_struct *tty, const unsigned char *buffer,
1674 struct nozomi *dc = get_dc_by_tty(tty);
1675 struct port *port = tty->driver_data;
1676 unsigned long flags;
1678 /* DBG1( "WRITEx: %d, index = %d", count, index); */
1683 if (unlikely(!mutex_trylock(&port->tty_sem))) {
1685 * must test lock as tty layer wraps calls
1686 * to this function with BKL
1688 dev_err(&dc->pdev->dev, "Would have deadlocked - "
1693 if (unlikely(!port->port.count)) {
1698 rval = kfifo_in(&port->fifo_ul, (unsigned char *)buffer, count);
1701 if (unlikely(dc == NULL)) {
1702 DBG1("No device context?");
1706 spin_lock_irqsave(&dc->spin_mutex, flags);
1707 /* CTS is only valid on the modem channel */
1708 if (port == &(dc->port[PORT_MDM])) {
1709 if (port->ctrl_dl.CTS) {
1710 DBG4("Enable interrupt");
1711 enable_transmit_ul(tty->index % MAX_PORT, dc);
1713 dev_err(&dc->pdev->dev,
1714 "CTS not active on modem port?\n");
1717 enable_transmit_ul(tty->index % MAX_PORT, dc);
1719 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1722 mutex_unlock(&port->tty_sem);
1727 * Calculate how much is left in device
1728 * This method is called by the upper tty layer.
1729 * #according to sources N_TTY.c it expects a value >= 0 and
1730 * does not check for negative values.
1732 static int ntty_write_room(struct tty_struct *tty)
1734 struct port *port = tty->driver_data;
1736 const struct nozomi *dc = get_dc_by_tty(tty);
1740 if (!mutex_trylock(&port->tty_sem))
1743 if (!port->port.count)
1746 room = port->fifo_ul.size - kfifo_len(&port->fifo_ul);
1749 mutex_unlock(&port->tty_sem);
1753 /* Gets io control parameters */
1754 static int ntty_tiocmget(struct tty_struct *tty, struct file *file)
1756 const struct port *port = tty->driver_data;
1757 const struct ctrl_dl *ctrl_dl = &port->ctrl_dl;
1758 const struct ctrl_ul *ctrl_ul = &port->ctrl_ul;
1760 /* Note: these could change under us but it is not clear this
1762 return (ctrl_ul->RTS ? TIOCM_RTS : 0) |
1763 (ctrl_ul->DTR ? TIOCM_DTR : 0) |
1764 (ctrl_dl->DCD ? TIOCM_CAR : 0) |
1765 (ctrl_dl->RI ? TIOCM_RNG : 0) |
1766 (ctrl_dl->DSR ? TIOCM_DSR : 0) |
1767 (ctrl_dl->CTS ? TIOCM_CTS : 0);
1770 /* Sets io controls parameters */
1771 static int ntty_tiocmset(struct tty_struct *tty, struct file *file,
1772 unsigned int set, unsigned int clear)
1774 struct nozomi *dc = get_dc_by_tty(tty);
1775 unsigned long flags;
1777 spin_lock_irqsave(&dc->spin_mutex, flags);
1778 if (set & TIOCM_RTS)
1780 else if (clear & TIOCM_RTS)
1783 if (set & TIOCM_DTR)
1785 else if (clear & TIOCM_DTR)
1787 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1792 static int ntty_cflags_changed(struct port *port, unsigned long flags,
1793 struct async_icount *cprev)
1795 const struct async_icount cnow = port->tty_icount;
1798 ret = ((flags & TIOCM_RNG) && (cnow.rng != cprev->rng)) ||
1799 ((flags & TIOCM_DSR) && (cnow.dsr != cprev->dsr)) ||
1800 ((flags & TIOCM_CD) && (cnow.dcd != cprev->dcd)) ||
1801 ((flags & TIOCM_CTS) && (cnow.cts != cprev->cts));
1808 static int ntty_ioctl_tiocgicount(struct port *port, void __user *argp)
1810 const struct async_icount cnow = port->tty_icount;
1811 struct serial_icounter_struct icount;
1813 icount.cts = cnow.cts;
1814 icount.dsr = cnow.dsr;
1815 icount.rng = cnow.rng;
1816 icount.dcd = cnow.dcd;
1817 icount.rx = cnow.rx;
1818 icount.tx = cnow.tx;
1819 icount.frame = cnow.frame;
1820 icount.overrun = cnow.overrun;
1821 icount.parity = cnow.parity;
1822 icount.brk = cnow.brk;
1823 icount.buf_overrun = cnow.buf_overrun;
1825 return copy_to_user(argp, &icount, sizeof(icount)) ? -EFAULT : 0;
1828 static int ntty_ioctl(struct tty_struct *tty, struct file *file,
1829 unsigned int cmd, unsigned long arg)
1831 struct port *port = tty->driver_data;
1832 void __user *argp = (void __user *)arg;
1833 int rval = -ENOIOCTLCMD;
1835 DBG1("******** IOCTL, cmd: %d", cmd);
1839 struct async_icount cprev = port->tty_icount;
1841 rval = wait_event_interruptible(port->tty_wait,
1842 ntty_cflags_changed(port, arg, &cprev));
1845 rval = ntty_ioctl_tiocgicount(port, argp);
1848 DBG1("ERR: 0x%08X, %d", cmd, cmd);
1856 * Called by the upper tty layer when tty buffers are ready
1857 * to receive data again after a call to throttle.
1859 static void ntty_unthrottle(struct tty_struct *tty)
1861 struct nozomi *dc = get_dc_by_tty(tty);
1862 unsigned long flags;
1865 spin_lock_irqsave(&dc->spin_mutex, flags);
1866 enable_transmit_dl(tty->index % MAX_PORT, dc);
1869 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1873 * Called by the upper tty layer when the tty buffers are almost full.
1874 * The driver should stop send more data.
1876 static void ntty_throttle(struct tty_struct *tty)
1878 struct nozomi *dc = get_dc_by_tty(tty);
1879 unsigned long flags;
1882 spin_lock_irqsave(&dc->spin_mutex, flags);
1884 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1887 /* Returns number of chars in buffer, called by tty layer */
1888 static s32 ntty_chars_in_buffer(struct tty_struct *tty)
1890 struct port *port = tty->driver_data;
1891 struct nozomi *dc = get_dc_by_tty(tty);
1894 if (unlikely(!dc || !port)) {
1895 goto exit_in_buffer;
1898 if (unlikely(!port->port.count)) {
1899 dev_err(&dc->pdev->dev, "No tty open?\n");
1900 goto exit_in_buffer;
1903 rval = kfifo_len(&port->fifo_ul);
1909 static const struct tty_operations tty_ops = {
1910 .ioctl = ntty_ioctl,
1912 .close = ntty_close,
1913 .write = ntty_write,
1914 .write_room = ntty_write_room,
1915 .unthrottle = ntty_unthrottle,
1916 .throttle = ntty_throttle,
1917 .chars_in_buffer = ntty_chars_in_buffer,
1918 .tiocmget = ntty_tiocmget,
1919 .tiocmset = ntty_tiocmset,
1922 /* Module initialization */
1923 static struct pci_driver nozomi_driver = {
1924 .name = NOZOMI_NAME,
1925 .id_table = nozomi_pci_tbl,
1926 .probe = nozomi_card_init,
1927 .remove = __devexit_p(nozomi_card_exit),
1930 static __init int nozomi_init(void)
1934 printk(KERN_INFO "Initializing %s\n", VERSION_STRING);
1936 ntty_driver = alloc_tty_driver(NTTY_TTY_MAXMINORS);
1940 ntty_driver->owner = THIS_MODULE;
1941 ntty_driver->driver_name = NOZOMI_NAME_TTY;
1942 ntty_driver->name = "noz";
1943 ntty_driver->major = 0;
1944 ntty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1945 ntty_driver->subtype = SERIAL_TYPE_NORMAL;
1946 ntty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1947 ntty_driver->init_termios = tty_std_termios;
1948 ntty_driver->init_termios.c_cflag = B115200 | CS8 | CREAD | \
1950 ntty_driver->init_termios.c_ispeed = 115200;
1951 ntty_driver->init_termios.c_ospeed = 115200;
1952 tty_set_operations(ntty_driver, &tty_ops);
1954 ret = tty_register_driver(ntty_driver);
1956 printk(KERN_ERR "Nozomi: failed to register ntty driver\n");
1960 ret = pci_register_driver(&nozomi_driver);
1962 printk(KERN_ERR "Nozomi: can't register pci driver\n");
1968 tty_unregister_driver(ntty_driver);
1970 put_tty_driver(ntty_driver);
1974 static __exit void nozomi_exit(void)
1976 printk(KERN_INFO "Unloading %s\n", DRIVER_DESC);
1977 pci_unregister_driver(&nozomi_driver);
1978 tty_unregister_driver(ntty_driver);
1979 put_tty_driver(ntty_driver);
1982 module_init(nozomi_init);
1983 module_exit(nozomi_exit);
1985 module_param(debug, int, S_IRUGO | S_IWUSR);
1987 MODULE_LICENSE("Dual BSD/GPL");
1988 MODULE_DESCRIPTION(DRIVER_DESC);