Loading...
1/*
2 * nozomi.c -- HSDPA driver Broadband Wireless Data Card - Globe Trotter
3 *
4 * Written by: Ulf Jakobsson,
5 * Jan Åkerfeldt,
6 * Stefan Thomasson,
7 *
8 * Maintained by: Paul Hardwick (p.hardwick@option.com)
9 *
10 * Patches:
11 * Locking code changes for Vodafone by Sphere Systems Ltd,
12 * Andrew Bird (ajb@spheresystems.co.uk )
13 * & Phil Sanderson
14 *
15 * Source has been ported from an implementation made by Filip Aben @ Option
16 *
17 * --------------------------------------------------------------------------
18 *
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.
23 *
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.
28 *
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.
33 *
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
37 *
38 * --------------------------------------------------------------------------
39 */
40
41/* Enable this to have a lot of debug printouts */
42#define DEBUG
43
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 <linux/slab.h>
59#include <asm/byteorder.h>
60
61#include <linux/delay.h>
62
63
64#define VERSION_STRING DRIVER_DESC " 2.1d"
65
66/* Macros definitions */
67
68/* Default debug printout level */
69#define NOZOMI_DEBUG_LEVEL 0x00
70
71#define P_BUF_SIZE 128
72#define NFO(_err_flag_, args...) \
73do { \
74 char tmp[P_BUF_SIZE]; \
75 snprintf(tmp, sizeof(tmp), ##args); \
76 printk(_err_flag_ "[%d] %s(): %s\n", __LINE__, \
77 __func__, tmp); \
78} while (0)
79
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)
88
89#ifdef DEBUG
90/* Do we need this settable at runtime? */
91static int debug = NOZOMI_DEBUG_LEVEL;
92
93#define D(lvl, args...) do \
94 {if (lvl & debug) NFO(KERN_DEBUG, ##args); } \
95 while (0)
96#define D_(lvl, args...) D(lvl, ##args)
97
98/* These printouts are always printed */
99
100#else
101static int debug;
102#define D_(lvl, args...)
103#endif
104
105/* TODO: rewrite to optimize macros... */
106
107#define TMP_BUF_MAX 256
108
109#define DUMP(buf__,len__) \
110 do { \
111 char tbuf[TMP_BUF_MAX] = {0};\
112 if (len__ > 1) {\
113 snprintf(tbuf, len__ > TMP_BUF_MAX ? TMP_BUF_MAX : len__, "%s", buf__);\
114 if (tbuf[len__-2] == '\r') {\
115 tbuf[len__-2] = 'r';\
116 } \
117 DBG1("SENDING: '%s' (%d+n)", tbuf, len__);\
118 } else {\
119 DBG1("SENDING: '%s' (%d)", tbuf, len__);\
120 } \
121} while (0)
122
123/* Defines */
124#define NOZOMI_NAME "nozomi"
125#define NOZOMI_NAME_TTY "nozomi_tty"
126#define DRIVER_DESC "Nozomi driver"
127
128#define NTTY_TTY_MAXMINORS 256
129#define NTTY_FIFO_BUFFER_SIZE 8192
130
131/* Must be power of 2 */
132#define FIFO_BUFFER_SIZE_UL 8192
133
134/* Size of tmp send buffer to card */
135#define SEND_BUF_MAX 1024
136#define RECEIVE_BUF_MAX 4
137
138
139#define R_IIR 0x0000 /* Interrupt Identity Register */
140#define R_FCR 0x0000 /* Flow Control Register */
141#define R_IER 0x0004 /* Interrupt Enable Register */
142
143#define CONFIG_MAGIC 0xEFEFFEFE
144#define TOGGLE_VALID 0x0000
145
146/* Definition of interrupt tokens */
147#define MDM_DL1 0x0001
148#define MDM_UL1 0x0002
149#define MDM_DL2 0x0004
150#define MDM_UL2 0x0008
151#define DIAG_DL1 0x0010
152#define DIAG_DL2 0x0020
153#define DIAG_UL 0x0040
154#define APP1_DL 0x0080
155#define APP1_UL 0x0100
156#define APP2_DL 0x0200
157#define APP2_UL 0x0400
158#define CTRL_DL 0x0800
159#define CTRL_UL 0x1000
160#define RESET 0x8000
161
162#define MDM_DL (MDM_DL1 | MDM_DL2)
163#define MDM_UL (MDM_UL1 | MDM_UL2)
164#define DIAG_DL (DIAG_DL1 | DIAG_DL2)
165
166/* modem signal definition */
167#define CTRL_DSR 0x0001
168#define CTRL_DCD 0x0002
169#define CTRL_RI 0x0004
170#define CTRL_CTS 0x0008
171
172#define CTRL_DTR 0x0001
173#define CTRL_RTS 0x0002
174
175#define MAX_PORT 4
176#define NOZOMI_MAX_PORTS 5
177#define NOZOMI_MAX_CARDS (NTTY_TTY_MAXMINORS / MAX_PORT)
178
179/* Type definitions */
180
181/*
182 * There are two types of nozomi cards,
183 * one with 2048 memory and with 8192 memory
184 */
185enum card_type {
186 F32_2 = 2048, /* 512 bytes downlink + uplink * 2 -> 2048 */
187 F32_8 = 8192, /* 3072 bytes downl. + 1024 bytes uplink * 2 -> 8192 */
188};
189
190/* Initialization states a card can be in */
191enum card_state {
192 NOZOMI_STATE_UKNOWN = 0,
193 NOZOMI_STATE_ENABLED = 1, /* pci device enabled */
194 NOZOMI_STATE_ALLOCATED = 2, /* config setup done */
195 NOZOMI_STATE_READY = 3, /* flowcontrols received */
196};
197
198/* Two different toggle channels exist */
199enum channel_type {
200 CH_A = 0,
201 CH_B = 1,
202};
203
204/* Port definition for the card regarding flow control */
205enum ctrl_port_type {
206 CTRL_CMD = 0,
207 CTRL_MDM = 1,
208 CTRL_DIAG = 2,
209 CTRL_APP1 = 3,
210 CTRL_APP2 = 4,
211 CTRL_ERROR = -1,
212};
213
214/* Ports that the nozomi has */
215enum port_type {
216 PORT_MDM = 0,
217 PORT_DIAG = 1,
218 PORT_APP1 = 2,
219 PORT_APP2 = 3,
220 PORT_CTRL = 4,
221 PORT_ERROR = -1,
222};
223
224#ifdef __BIG_ENDIAN
225/* Big endian */
226
227struct toggles {
228 unsigned int enabled:5; /*
229 * Toggle fields are valid if enabled is 0,
230 * else A-channels must always be used.
231 */
232 unsigned int diag_dl:1;
233 unsigned int mdm_dl:1;
234 unsigned int mdm_ul:1;
235} __attribute__ ((packed));
236
237/* Configuration table to read at startup of card */
238/* Is for now only needed during initialization phase */
239struct config_table {
240 u32 signature;
241 u16 product_information;
242 u16 version;
243 u8 pad3[3];
244 struct toggles toggle;
245 u8 pad1[4];
246 u16 dl_mdm_len1; /*
247 * If this is 64, it can hold
248 * 60 bytes + 4 that is length field
249 */
250 u16 dl_start;
251
252 u16 dl_diag_len1;
253 u16 dl_mdm_len2; /*
254 * If this is 64, it can hold
255 * 60 bytes + 4 that is length field
256 */
257 u16 dl_app1_len;
258
259 u16 dl_diag_len2;
260 u16 dl_ctrl_len;
261 u16 dl_app2_len;
262 u8 pad2[16];
263 u16 ul_mdm_len1;
264 u16 ul_start;
265 u16 ul_diag_len;
266 u16 ul_mdm_len2;
267 u16 ul_app1_len;
268 u16 ul_app2_len;
269 u16 ul_ctrl_len;
270} __attribute__ ((packed));
271
272/* This stores all control downlink flags */
273struct ctrl_dl {
274 u8 port;
275 unsigned int reserved:4;
276 unsigned int CTS:1;
277 unsigned int RI:1;
278 unsigned int DCD:1;
279 unsigned int DSR:1;
280} __attribute__ ((packed));
281
282/* This stores all control uplink flags */
283struct ctrl_ul {
284 u8 port;
285 unsigned int reserved:6;
286 unsigned int RTS:1;
287 unsigned int DTR:1;
288} __attribute__ ((packed));
289
290#else
291/* Little endian */
292
293/* This represents the toggle information */
294struct toggles {
295 unsigned int mdm_ul:1;
296 unsigned int mdm_dl:1;
297 unsigned int diag_dl:1;
298 unsigned int enabled:5; /*
299 * Toggle fields are valid if enabled is 0,
300 * else A-channels must always be used.
301 */
302} __attribute__ ((packed));
303
304/* Configuration table to read at startup of card */
305struct config_table {
306 u32 signature;
307 u16 version;
308 u16 product_information;
309 struct toggles toggle;
310 u8 pad1[7];
311 u16 dl_start;
312 u16 dl_mdm_len1; /*
313 * If this is 64, it can hold
314 * 60 bytes + 4 that is length field
315 */
316 u16 dl_mdm_len2;
317 u16 dl_diag_len1;
318 u16 dl_diag_len2;
319 u16 dl_app1_len;
320 u16 dl_app2_len;
321 u16 dl_ctrl_len;
322 u8 pad2[16];
323 u16 ul_start;
324 u16 ul_mdm_len2;
325 u16 ul_mdm_len1;
326 u16 ul_diag_len;
327 u16 ul_app1_len;
328 u16 ul_app2_len;
329 u16 ul_ctrl_len;
330} __attribute__ ((packed));
331
332/* This stores all control downlink flags */
333struct ctrl_dl {
334 unsigned int DSR:1;
335 unsigned int DCD:1;
336 unsigned int RI:1;
337 unsigned int CTS:1;
338 unsigned int reserverd:4;
339 u8 port;
340} __attribute__ ((packed));
341
342/* This stores all control uplink flags */
343struct ctrl_ul {
344 unsigned int DTR:1;
345 unsigned int RTS:1;
346 unsigned int reserved:6;
347 u8 port;
348} __attribute__ ((packed));
349#endif
350
351/* This holds all information that is needed regarding a port */
352struct port {
353 struct tty_port port;
354 u8 update_flow_control;
355 struct ctrl_ul ctrl_ul;
356 struct ctrl_dl ctrl_dl;
357 struct kfifo fifo_ul;
358 void __iomem *dl_addr[2];
359 u32 dl_size[2];
360 u8 toggle_dl;
361 void __iomem *ul_addr[2];
362 u32 ul_size[2];
363 u8 toggle_ul;
364 u16 token_dl;
365
366 wait_queue_head_t tty_wait;
367 struct async_icount tty_icount;
368
369 struct nozomi *dc;
370};
371
372/* Private data one for each card in the system */
373struct nozomi {
374 void __iomem *base_addr;
375 unsigned long flip;
376
377 /* Pointers to registers */
378 void __iomem *reg_iir;
379 void __iomem *reg_fcr;
380 void __iomem *reg_ier;
381
382 u16 last_ier;
383 enum card_type card_type;
384 struct config_table config_table; /* Configuration table */
385 struct pci_dev *pdev;
386 struct port port[NOZOMI_MAX_PORTS];
387 u8 *send_buf;
388
389 spinlock_t spin_mutex; /* secures access to registers and tty */
390
391 unsigned int index_start;
392 enum card_state state;
393 u32 open_ttys;
394};
395
396/* This is a data packet that is read or written to/from card */
397struct buffer {
398 u32 size; /* size is the length of the data buffer */
399 u8 *data;
400} __attribute__ ((packed));
401
402/* Global variables */
403static const struct pci_device_id nozomi_pci_tbl[] __devinitconst = {
404 {PCI_DEVICE(0x1931, 0x000c)}, /* Nozomi HSDPA */
405 {},
406};
407
408MODULE_DEVICE_TABLE(pci, nozomi_pci_tbl);
409
410static struct nozomi *ndevs[NOZOMI_MAX_CARDS];
411static struct tty_driver *ntty_driver;
412
413static const struct tty_port_operations noz_tty_port_ops;
414
415/*
416 * find card by tty_index
417 */
418static inline struct nozomi *get_dc_by_tty(const struct tty_struct *tty)
419{
420 return tty ? ndevs[tty->index / MAX_PORT] : NULL;
421}
422
423static inline struct port *get_port_by_tty(const struct tty_struct *tty)
424{
425 struct nozomi *ndev = get_dc_by_tty(tty);
426 return ndev ? &ndev->port[tty->index % MAX_PORT] : NULL;
427}
428
429/*
430 * TODO:
431 * -Optimize
432 * -Rewrite cleaner
433 */
434
435static void read_mem32(u32 *buf, const void __iomem *mem_addr_start,
436 u32 size_bytes)
437{
438 u32 i = 0;
439 const u32 __iomem *ptr = mem_addr_start;
440 u16 *buf16;
441
442 if (unlikely(!ptr || !buf))
443 goto out;
444
445 /* shortcut for extremely often used cases */
446 switch (size_bytes) {
447 case 2: /* 2 bytes */
448 buf16 = (u16 *) buf;
449 *buf16 = __le16_to_cpu(readw(ptr));
450 goto out;
451 break;
452 case 4: /* 4 bytes */
453 *(buf) = __le32_to_cpu(readl(ptr));
454 goto out;
455 break;
456 }
457
458 while (i < size_bytes) {
459 if (size_bytes - i == 2) {
460 /* Handle 2 bytes in the end */
461 buf16 = (u16 *) buf;
462 *(buf16) = __le16_to_cpu(readw(ptr));
463 i += 2;
464 } else {
465 /* Read 4 bytes */
466 *(buf) = __le32_to_cpu(readl(ptr));
467 i += 4;
468 }
469 buf++;
470 ptr++;
471 }
472out:
473 return;
474}
475
476/*
477 * TODO:
478 * -Optimize
479 * -Rewrite cleaner
480 */
481static u32 write_mem32(void __iomem *mem_addr_start, const u32 *buf,
482 u32 size_bytes)
483{
484 u32 i = 0;
485 u32 __iomem *ptr = mem_addr_start;
486 const u16 *buf16;
487
488 if (unlikely(!ptr || !buf))
489 return 0;
490
491 /* shortcut for extremely often used cases */
492 switch (size_bytes) {
493 case 2: /* 2 bytes */
494 buf16 = (const u16 *)buf;
495 writew(__cpu_to_le16(*buf16), ptr);
496 return 2;
497 break;
498 case 1: /*
499 * also needs to write 4 bytes in this case
500 * so falling through..
501 */
502 case 4: /* 4 bytes */
503 writel(__cpu_to_le32(*buf), ptr);
504 return 4;
505 break;
506 }
507
508 while (i < size_bytes) {
509 if (size_bytes - i == 2) {
510 /* 2 bytes */
511 buf16 = (const u16 *)buf;
512 writew(__cpu_to_le16(*buf16), ptr);
513 i += 2;
514 } else {
515 /* 4 bytes */
516 writel(__cpu_to_le32(*buf), ptr);
517 i += 4;
518 }
519 buf++;
520 ptr++;
521 }
522 return i;
523}
524
525/* Setup pointers to different channels and also setup buffer sizes. */
526static void setup_memory(struct nozomi *dc)
527{
528 void __iomem *offset = dc->base_addr + dc->config_table.dl_start;
529 /* The length reported is including the length field of 4 bytes,
530 * hence subtract with 4.
531 */
532 const u16 buff_offset = 4;
533
534 /* Modem port dl configuration */
535 dc->port[PORT_MDM].dl_addr[CH_A] = offset;
536 dc->port[PORT_MDM].dl_addr[CH_B] =
537 (offset += dc->config_table.dl_mdm_len1);
538 dc->port[PORT_MDM].dl_size[CH_A] =
539 dc->config_table.dl_mdm_len1 - buff_offset;
540 dc->port[PORT_MDM].dl_size[CH_B] =
541 dc->config_table.dl_mdm_len2 - buff_offset;
542
543 /* Diag port dl configuration */
544 dc->port[PORT_DIAG].dl_addr[CH_A] =
545 (offset += dc->config_table.dl_mdm_len2);
546 dc->port[PORT_DIAG].dl_size[CH_A] =
547 dc->config_table.dl_diag_len1 - buff_offset;
548 dc->port[PORT_DIAG].dl_addr[CH_B] =
549 (offset += dc->config_table.dl_diag_len1);
550 dc->port[PORT_DIAG].dl_size[CH_B] =
551 dc->config_table.dl_diag_len2 - buff_offset;
552
553 /* App1 port dl configuration */
554 dc->port[PORT_APP1].dl_addr[CH_A] =
555 (offset += dc->config_table.dl_diag_len2);
556 dc->port[PORT_APP1].dl_size[CH_A] =
557 dc->config_table.dl_app1_len - buff_offset;
558
559 /* App2 port dl configuration */
560 dc->port[PORT_APP2].dl_addr[CH_A] =
561 (offset += dc->config_table.dl_app1_len);
562 dc->port[PORT_APP2].dl_size[CH_A] =
563 dc->config_table.dl_app2_len - buff_offset;
564
565 /* Ctrl dl configuration */
566 dc->port[PORT_CTRL].dl_addr[CH_A] =
567 (offset += dc->config_table.dl_app2_len);
568 dc->port[PORT_CTRL].dl_size[CH_A] =
569 dc->config_table.dl_ctrl_len - buff_offset;
570
571 offset = dc->base_addr + dc->config_table.ul_start;
572
573 /* Modem Port ul configuration */
574 dc->port[PORT_MDM].ul_addr[CH_A] = offset;
575 dc->port[PORT_MDM].ul_size[CH_A] =
576 dc->config_table.ul_mdm_len1 - buff_offset;
577 dc->port[PORT_MDM].ul_addr[CH_B] =
578 (offset += dc->config_table.ul_mdm_len1);
579 dc->port[PORT_MDM].ul_size[CH_B] =
580 dc->config_table.ul_mdm_len2 - buff_offset;
581
582 /* Diag port ul configuration */
583 dc->port[PORT_DIAG].ul_addr[CH_A] =
584 (offset += dc->config_table.ul_mdm_len2);
585 dc->port[PORT_DIAG].ul_size[CH_A] =
586 dc->config_table.ul_diag_len - buff_offset;
587
588 /* App1 port ul configuration */
589 dc->port[PORT_APP1].ul_addr[CH_A] =
590 (offset += dc->config_table.ul_diag_len);
591 dc->port[PORT_APP1].ul_size[CH_A] =
592 dc->config_table.ul_app1_len - buff_offset;
593
594 /* App2 port ul configuration */
595 dc->port[PORT_APP2].ul_addr[CH_A] =
596 (offset += dc->config_table.ul_app1_len);
597 dc->port[PORT_APP2].ul_size[CH_A] =
598 dc->config_table.ul_app2_len - buff_offset;
599
600 /* Ctrl ul configuration */
601 dc->port[PORT_CTRL].ul_addr[CH_A] =
602 (offset += dc->config_table.ul_app2_len);
603 dc->port[PORT_CTRL].ul_size[CH_A] =
604 dc->config_table.ul_ctrl_len - buff_offset;
605}
606
607/* Dump config table under initalization phase */
608#ifdef DEBUG
609static void dump_table(const struct nozomi *dc)
610{
611 DBG3("signature: 0x%08X", dc->config_table.signature);
612 DBG3("version: 0x%04X", dc->config_table.version);
613 DBG3("product_information: 0x%04X", \
614 dc->config_table.product_information);
615 DBG3("toggle enabled: %d", dc->config_table.toggle.enabled);
616 DBG3("toggle up_mdm: %d", dc->config_table.toggle.mdm_ul);
617 DBG3("toggle dl_mdm: %d", dc->config_table.toggle.mdm_dl);
618 DBG3("toggle dl_dbg: %d", dc->config_table.toggle.diag_dl);
619
620 DBG3("dl_start: 0x%04X", dc->config_table.dl_start);
621 DBG3("dl_mdm_len0: 0x%04X, %d", dc->config_table.dl_mdm_len1,
622 dc->config_table.dl_mdm_len1);
623 DBG3("dl_mdm_len1: 0x%04X, %d", dc->config_table.dl_mdm_len2,
624 dc->config_table.dl_mdm_len2);
625 DBG3("dl_diag_len0: 0x%04X, %d", dc->config_table.dl_diag_len1,
626 dc->config_table.dl_diag_len1);
627 DBG3("dl_diag_len1: 0x%04X, %d", dc->config_table.dl_diag_len2,
628 dc->config_table.dl_diag_len2);
629 DBG3("dl_app1_len: 0x%04X, %d", dc->config_table.dl_app1_len,
630 dc->config_table.dl_app1_len);
631 DBG3("dl_app2_len: 0x%04X, %d", dc->config_table.dl_app2_len,
632 dc->config_table.dl_app2_len);
633 DBG3("dl_ctrl_len: 0x%04X, %d", dc->config_table.dl_ctrl_len,
634 dc->config_table.dl_ctrl_len);
635 DBG3("ul_start: 0x%04X, %d", dc->config_table.ul_start,
636 dc->config_table.ul_start);
637 DBG3("ul_mdm_len[0]: 0x%04X, %d", dc->config_table.ul_mdm_len1,
638 dc->config_table.ul_mdm_len1);
639 DBG3("ul_mdm_len[1]: 0x%04X, %d", dc->config_table.ul_mdm_len2,
640 dc->config_table.ul_mdm_len2);
641 DBG3("ul_diag_len: 0x%04X, %d", dc->config_table.ul_diag_len,
642 dc->config_table.ul_diag_len);
643 DBG3("ul_app1_len: 0x%04X, %d", dc->config_table.ul_app1_len,
644 dc->config_table.ul_app1_len);
645 DBG3("ul_app2_len: 0x%04X, %d", dc->config_table.ul_app2_len,
646 dc->config_table.ul_app2_len);
647 DBG3("ul_ctrl_len: 0x%04X, %d", dc->config_table.ul_ctrl_len,
648 dc->config_table.ul_ctrl_len);
649}
650#else
651static inline void dump_table(const struct nozomi *dc) { }
652#endif
653
654/*
655 * Read configuration table from card under intalization phase
656 * Returns 1 if ok, else 0
657 */
658static int nozomi_read_config_table(struct nozomi *dc)
659{
660 read_mem32((u32 *) &dc->config_table, dc->base_addr + 0,
661 sizeof(struct config_table));
662
663 if (dc->config_table.signature != CONFIG_MAGIC) {
664 dev_err(&dc->pdev->dev, "ConfigTable Bad! 0x%08X != 0x%08X\n",
665 dc->config_table.signature, CONFIG_MAGIC);
666 return 0;
667 }
668
669 if ((dc->config_table.version == 0)
670 || (dc->config_table.toggle.enabled == TOGGLE_VALID)) {
671 int i;
672 DBG1("Second phase, configuring card");
673
674 setup_memory(dc);
675
676 dc->port[PORT_MDM].toggle_ul = dc->config_table.toggle.mdm_ul;
677 dc->port[PORT_MDM].toggle_dl = dc->config_table.toggle.mdm_dl;
678 dc->port[PORT_DIAG].toggle_dl = dc->config_table.toggle.diag_dl;
679 DBG1("toggle ports: MDM UL:%d MDM DL:%d, DIAG DL:%d",
680 dc->port[PORT_MDM].toggle_ul,
681 dc->port[PORT_MDM].toggle_dl, dc->port[PORT_DIAG].toggle_dl);
682
683 dump_table(dc);
684
685 for (i = PORT_MDM; i < MAX_PORT; i++) {
686 memset(&dc->port[i].ctrl_dl, 0, sizeof(struct ctrl_dl));
687 memset(&dc->port[i].ctrl_ul, 0, sizeof(struct ctrl_ul));
688 }
689
690 /* Enable control channel */
691 dc->last_ier = dc->last_ier | CTRL_DL;
692 writew(dc->last_ier, dc->reg_ier);
693
694 dc->state = NOZOMI_STATE_ALLOCATED;
695 dev_info(&dc->pdev->dev, "Initialization OK!\n");
696 return 1;
697 }
698
699 if ((dc->config_table.version > 0)
700 && (dc->config_table.toggle.enabled != TOGGLE_VALID)) {
701 u32 offset = 0;
702 DBG1("First phase: pushing upload buffers, clearing download");
703
704 dev_info(&dc->pdev->dev, "Version of card: %d\n",
705 dc->config_table.version);
706
707 /* Here we should disable all I/O over F32. */
708 setup_memory(dc);
709
710 /*
711 * We should send ALL channel pair tokens back along
712 * with reset token
713 */
714
715 /* push upload modem buffers */
716 write_mem32(dc->port[PORT_MDM].ul_addr[CH_A],
717 (u32 *) &offset, 4);
718 write_mem32(dc->port[PORT_MDM].ul_addr[CH_B],
719 (u32 *) &offset, 4);
720
721 writew(MDM_UL | DIAG_DL | MDM_DL, dc->reg_fcr);
722
723 DBG1("First phase done");
724 }
725
726 return 1;
727}
728
729/* Enable uplink interrupts */
730static void enable_transmit_ul(enum port_type port, struct nozomi *dc)
731{
732 static const u16 mask[] = {MDM_UL, DIAG_UL, APP1_UL, APP2_UL, CTRL_UL};
733
734 if (port < NOZOMI_MAX_PORTS) {
735 dc->last_ier |= mask[port];
736 writew(dc->last_ier, dc->reg_ier);
737 } else {
738 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
739 }
740}
741
742/* Disable uplink interrupts */
743static void disable_transmit_ul(enum port_type port, struct nozomi *dc)
744{
745 static const u16 mask[] =
746 {~MDM_UL, ~DIAG_UL, ~APP1_UL, ~APP2_UL, ~CTRL_UL};
747
748 if (port < NOZOMI_MAX_PORTS) {
749 dc->last_ier &= mask[port];
750 writew(dc->last_ier, dc->reg_ier);
751 } else {
752 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
753 }
754}
755
756/* Enable downlink interrupts */
757static void enable_transmit_dl(enum port_type port, struct nozomi *dc)
758{
759 static const u16 mask[] = {MDM_DL, DIAG_DL, APP1_DL, APP2_DL, CTRL_DL};
760
761 if (port < NOZOMI_MAX_PORTS) {
762 dc->last_ier |= mask[port];
763 writew(dc->last_ier, dc->reg_ier);
764 } else {
765 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
766 }
767}
768
769/* Disable downlink interrupts */
770static void disable_transmit_dl(enum port_type port, struct nozomi *dc)
771{
772 static const u16 mask[] =
773 {~MDM_DL, ~DIAG_DL, ~APP1_DL, ~APP2_DL, ~CTRL_DL};
774
775 if (port < NOZOMI_MAX_PORTS) {
776 dc->last_ier &= mask[port];
777 writew(dc->last_ier, dc->reg_ier);
778 } else {
779 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
780 }
781}
782
783/*
784 * Return 1 - send buffer to card and ack.
785 * Return 0 - don't ack, don't send buffer to card.
786 */
787static int send_data(enum port_type index, struct nozomi *dc)
788{
789 u32 size = 0;
790 struct port *port = &dc->port[index];
791 const u8 toggle = port->toggle_ul;
792 void __iomem *addr = port->ul_addr[toggle];
793 const u32 ul_size = port->ul_size[toggle];
794 struct tty_struct *tty = tty_port_tty_get(&port->port);
795
796 /* Get data from tty and place in buf for now */
797 size = kfifo_out(&port->fifo_ul, dc->send_buf,
798 ul_size < SEND_BUF_MAX ? ul_size : SEND_BUF_MAX);
799
800 if (size == 0) {
801 DBG4("No more data to send, disable link:");
802 tty_kref_put(tty);
803 return 0;
804 }
805
806 /* DUMP(buf, size); */
807
808 /* Write length + data */
809 write_mem32(addr, (u32 *) &size, 4);
810 write_mem32(addr + 4, (u32 *) dc->send_buf, size);
811
812 if (tty)
813 tty_wakeup(tty);
814
815 tty_kref_put(tty);
816 return 1;
817}
818
819/* If all data has been read, return 1, else 0 */
820static int receive_data(enum port_type index, struct nozomi *dc)
821{
822 u8 buf[RECEIVE_BUF_MAX] = { 0 };
823 int size;
824 u32 offset = 4;
825 struct port *port = &dc->port[index];
826 void __iomem *addr = port->dl_addr[port->toggle_dl];
827 struct tty_struct *tty = tty_port_tty_get(&port->port);
828 int i, ret;
829
830 if (unlikely(!tty)) {
831 DBG1("tty not open for port: %d?", index);
832 return 1;
833 }
834
835 read_mem32((u32 *) &size, addr, 4);
836 /* DBG1( "%d bytes port: %d", size, index); */
837
838 if (test_bit(TTY_THROTTLED, &tty->flags)) {
839 DBG1("No room in tty, don't read data, don't ack interrupt, "
840 "disable interrupt");
841
842 /* disable interrupt in downlink... */
843 disable_transmit_dl(index, dc);
844 ret = 0;
845 goto put;
846 }
847
848 if (unlikely(size == 0)) {
849 dev_err(&dc->pdev->dev, "size == 0?\n");
850 ret = 1;
851 goto put;
852 }
853
854 while (size > 0) {
855 read_mem32((u32 *) buf, addr + offset, RECEIVE_BUF_MAX);
856
857 if (size == 1) {
858 tty_insert_flip_char(tty, buf[0], TTY_NORMAL);
859 size = 0;
860 } else if (size < RECEIVE_BUF_MAX) {
861 size -= tty_insert_flip_string(tty, (char *) buf, size);
862 } else {
863 i = tty_insert_flip_string(tty, \
864 (char *) buf, RECEIVE_BUF_MAX);
865 size -= i;
866 offset += i;
867 }
868 }
869
870 set_bit(index, &dc->flip);
871 ret = 1;
872put:
873 tty_kref_put(tty);
874 return ret;
875}
876
877/* Debug for interrupts */
878#ifdef DEBUG
879static char *interrupt2str(u16 interrupt)
880{
881 static char buf[TMP_BUF_MAX];
882 char *p = buf;
883
884 interrupt & MDM_DL1 ? p += snprintf(p, TMP_BUF_MAX, "MDM_DL1 ") : NULL;
885 interrupt & MDM_DL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
886 "MDM_DL2 ") : NULL;
887
888 interrupt & MDM_UL1 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
889 "MDM_UL1 ") : NULL;
890 interrupt & MDM_UL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
891 "MDM_UL2 ") : NULL;
892
893 interrupt & DIAG_DL1 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
894 "DIAG_DL1 ") : NULL;
895 interrupt & DIAG_DL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
896 "DIAG_DL2 ") : NULL;
897
898 interrupt & DIAG_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
899 "DIAG_UL ") : NULL;
900
901 interrupt & APP1_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
902 "APP1_DL ") : NULL;
903 interrupt & APP2_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
904 "APP2_DL ") : NULL;
905
906 interrupt & APP1_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
907 "APP1_UL ") : NULL;
908 interrupt & APP2_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
909 "APP2_UL ") : NULL;
910
911 interrupt & CTRL_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
912 "CTRL_DL ") : NULL;
913 interrupt & CTRL_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
914 "CTRL_UL ") : NULL;
915
916 interrupt & RESET ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
917 "RESET ") : NULL;
918
919 return buf;
920}
921#endif
922
923/*
924 * Receive flow control
925 * Return 1 - If ok, else 0
926 */
927static int receive_flow_control(struct nozomi *dc)
928{
929 enum port_type port = PORT_MDM;
930 struct ctrl_dl ctrl_dl;
931 struct ctrl_dl old_ctrl;
932 u16 enable_ier = 0;
933
934 read_mem32((u32 *) &ctrl_dl, dc->port[PORT_CTRL].dl_addr[CH_A], 2);
935
936 switch (ctrl_dl.port) {
937 case CTRL_CMD:
938 DBG1("The Base Band sends this value as a response to a "
939 "request for IMSI detach sent over the control "
940 "channel uplink (see section 7.6.1).");
941 break;
942 case CTRL_MDM:
943 port = PORT_MDM;
944 enable_ier = MDM_DL;
945 break;
946 case CTRL_DIAG:
947 port = PORT_DIAG;
948 enable_ier = DIAG_DL;
949 break;
950 case CTRL_APP1:
951 port = PORT_APP1;
952 enable_ier = APP1_DL;
953 break;
954 case CTRL_APP2:
955 port = PORT_APP2;
956 enable_ier = APP2_DL;
957 if (dc->state == NOZOMI_STATE_ALLOCATED) {
958 /*
959 * After card initialization the flow control
960 * received for APP2 is always the last
961 */
962 dc->state = NOZOMI_STATE_READY;
963 dev_info(&dc->pdev->dev, "Device READY!\n");
964 }
965 break;
966 default:
967 dev_err(&dc->pdev->dev,
968 "ERROR: flow control received for non-existing port\n");
969 return 0;
970 };
971
972 DBG1("0x%04X->0x%04X", *((u16 *)&dc->port[port].ctrl_dl),
973 *((u16 *)&ctrl_dl));
974
975 old_ctrl = dc->port[port].ctrl_dl;
976 dc->port[port].ctrl_dl = ctrl_dl;
977
978 if (old_ctrl.CTS == 1 && ctrl_dl.CTS == 0) {
979 DBG1("Disable interrupt (0x%04X) on port: %d",
980 enable_ier, port);
981 disable_transmit_ul(port, dc);
982
983 } else if (old_ctrl.CTS == 0 && ctrl_dl.CTS == 1) {
984
985 if (kfifo_len(&dc->port[port].fifo_ul)) {
986 DBG1("Enable interrupt (0x%04X) on port: %d",
987 enable_ier, port);
988 DBG1("Data in buffer [%d], enable transmit! ",
989 kfifo_len(&dc->port[port].fifo_ul));
990 enable_transmit_ul(port, dc);
991 } else {
992 DBG1("No data in buffer...");
993 }
994 }
995
996 if (*(u16 *)&old_ctrl == *(u16 *)&ctrl_dl) {
997 DBG1(" No change in mctrl");
998 return 1;
999 }
1000 /* Update statistics */
1001 if (old_ctrl.CTS != ctrl_dl.CTS)
1002 dc->port[port].tty_icount.cts++;
1003 if (old_ctrl.DSR != ctrl_dl.DSR)
1004 dc->port[port].tty_icount.dsr++;
1005 if (old_ctrl.RI != ctrl_dl.RI)
1006 dc->port[port].tty_icount.rng++;
1007 if (old_ctrl.DCD != ctrl_dl.DCD)
1008 dc->port[port].tty_icount.dcd++;
1009
1010 wake_up_interruptible(&dc->port[port].tty_wait);
1011
1012 DBG1("port: %d DCD(%d), CTS(%d), RI(%d), DSR(%d)",
1013 port,
1014 dc->port[port].tty_icount.dcd, dc->port[port].tty_icount.cts,
1015 dc->port[port].tty_icount.rng, dc->port[port].tty_icount.dsr);
1016
1017 return 1;
1018}
1019
1020static enum ctrl_port_type port2ctrl(enum port_type port,
1021 const struct nozomi *dc)
1022{
1023 switch (port) {
1024 case PORT_MDM:
1025 return CTRL_MDM;
1026 case PORT_DIAG:
1027 return CTRL_DIAG;
1028 case PORT_APP1:
1029 return CTRL_APP1;
1030 case PORT_APP2:
1031 return CTRL_APP2;
1032 default:
1033 dev_err(&dc->pdev->dev,
1034 "ERROR: send flow control " \
1035 "received for non-existing port\n");
1036 };
1037 return CTRL_ERROR;
1038}
1039
1040/*
1041 * Send flow control, can only update one channel at a time
1042 * Return 0 - If we have updated all flow control
1043 * Return 1 - If we need to update more flow control, ack current enable more
1044 */
1045static int send_flow_control(struct nozomi *dc)
1046{
1047 u32 i, more_flow_control_to_be_updated = 0;
1048 u16 *ctrl;
1049
1050 for (i = PORT_MDM; i < MAX_PORT; i++) {
1051 if (dc->port[i].update_flow_control) {
1052 if (more_flow_control_to_be_updated) {
1053 /* We have more flow control to be updated */
1054 return 1;
1055 }
1056 dc->port[i].ctrl_ul.port = port2ctrl(i, dc);
1057 ctrl = (u16 *)&dc->port[i].ctrl_ul;
1058 write_mem32(dc->port[PORT_CTRL].ul_addr[0], \
1059 (u32 *) ctrl, 2);
1060 dc->port[i].update_flow_control = 0;
1061 more_flow_control_to_be_updated = 1;
1062 }
1063 }
1064 return 0;
1065}
1066
1067/*
1068 * Handle downlink data, ports that are handled are modem and diagnostics
1069 * Return 1 - ok
1070 * Return 0 - toggle fields are out of sync
1071 */
1072static int handle_data_dl(struct nozomi *dc, enum port_type port, u8 *toggle,
1073 u16 read_iir, u16 mask1, u16 mask2)
1074{
1075 if (*toggle == 0 && read_iir & mask1) {
1076 if (receive_data(port, dc)) {
1077 writew(mask1, dc->reg_fcr);
1078 *toggle = !(*toggle);
1079 }
1080
1081 if (read_iir & mask2) {
1082 if (receive_data(port, dc)) {
1083 writew(mask2, dc->reg_fcr);
1084 *toggle = !(*toggle);
1085 }
1086 }
1087 } else if (*toggle == 1 && read_iir & mask2) {
1088 if (receive_data(port, dc)) {
1089 writew(mask2, dc->reg_fcr);
1090 *toggle = !(*toggle);
1091 }
1092
1093 if (read_iir & mask1) {
1094 if (receive_data(port, dc)) {
1095 writew(mask1, dc->reg_fcr);
1096 *toggle = !(*toggle);
1097 }
1098 }
1099 } else {
1100 dev_err(&dc->pdev->dev, "port out of sync!, toggle:%d\n",
1101 *toggle);
1102 return 0;
1103 }
1104 return 1;
1105}
1106
1107/*
1108 * Handle uplink data, this is currently for the modem port
1109 * Return 1 - ok
1110 * Return 0 - toggle field are out of sync
1111 */
1112static int handle_data_ul(struct nozomi *dc, enum port_type port, u16 read_iir)
1113{
1114 u8 *toggle = &(dc->port[port].toggle_ul);
1115
1116 if (*toggle == 0 && read_iir & MDM_UL1) {
1117 dc->last_ier &= ~MDM_UL;
1118 writew(dc->last_ier, dc->reg_ier);
1119 if (send_data(port, dc)) {
1120 writew(MDM_UL1, dc->reg_fcr);
1121 dc->last_ier = dc->last_ier | MDM_UL;
1122 writew(dc->last_ier, dc->reg_ier);
1123 *toggle = !*toggle;
1124 }
1125
1126 if (read_iir & MDM_UL2) {
1127 dc->last_ier &= ~MDM_UL;
1128 writew(dc->last_ier, dc->reg_ier);
1129 if (send_data(port, dc)) {
1130 writew(MDM_UL2, dc->reg_fcr);
1131 dc->last_ier = dc->last_ier | MDM_UL;
1132 writew(dc->last_ier, dc->reg_ier);
1133 *toggle = !*toggle;
1134 }
1135 }
1136
1137 } else if (*toggle == 1 && read_iir & MDM_UL2) {
1138 dc->last_ier &= ~MDM_UL;
1139 writew(dc->last_ier, dc->reg_ier);
1140 if (send_data(port, dc)) {
1141 writew(MDM_UL2, dc->reg_fcr);
1142 dc->last_ier = dc->last_ier | MDM_UL;
1143 writew(dc->last_ier, dc->reg_ier);
1144 *toggle = !*toggle;
1145 }
1146
1147 if (read_iir & MDM_UL1) {
1148 dc->last_ier &= ~MDM_UL;
1149 writew(dc->last_ier, dc->reg_ier);
1150 if (send_data(port, dc)) {
1151 writew(MDM_UL1, dc->reg_fcr);
1152 dc->last_ier = dc->last_ier | MDM_UL;
1153 writew(dc->last_ier, dc->reg_ier);
1154 *toggle = !*toggle;
1155 }
1156 }
1157 } else {
1158 writew(read_iir & MDM_UL, dc->reg_fcr);
1159 dev_err(&dc->pdev->dev, "port out of sync!\n");
1160 return 0;
1161 }
1162 return 1;
1163}
1164
1165static irqreturn_t interrupt_handler(int irq, void *dev_id)
1166{
1167 struct nozomi *dc = dev_id;
1168 unsigned int a;
1169 u16 read_iir;
1170
1171 if (!dc)
1172 return IRQ_NONE;
1173
1174 spin_lock(&dc->spin_mutex);
1175 read_iir = readw(dc->reg_iir);
1176
1177 /* Card removed */
1178 if (read_iir == (u16)-1)
1179 goto none;
1180 /*
1181 * Just handle interrupt enabled in IER
1182 * (by masking with dc->last_ier)
1183 */
1184 read_iir &= dc->last_ier;
1185
1186 if (read_iir == 0)
1187 goto none;
1188
1189
1190 DBG4("%s irq:0x%04X, prev:0x%04X", interrupt2str(read_iir), read_iir,
1191 dc->last_ier);
1192
1193 if (read_iir & RESET) {
1194 if (unlikely(!nozomi_read_config_table(dc))) {
1195 dc->last_ier = 0x0;
1196 writew(dc->last_ier, dc->reg_ier);
1197 dev_err(&dc->pdev->dev, "Could not read status from "
1198 "card, we should disable interface\n");
1199 } else {
1200 writew(RESET, dc->reg_fcr);
1201 }
1202 /* No more useful info if this was the reset interrupt. */
1203 goto exit_handler;
1204 }
1205 if (read_iir & CTRL_UL) {
1206 DBG1("CTRL_UL");
1207 dc->last_ier &= ~CTRL_UL;
1208 writew(dc->last_ier, dc->reg_ier);
1209 if (send_flow_control(dc)) {
1210 writew(CTRL_UL, dc->reg_fcr);
1211 dc->last_ier = dc->last_ier | CTRL_UL;
1212 writew(dc->last_ier, dc->reg_ier);
1213 }
1214 }
1215 if (read_iir & CTRL_DL) {
1216 receive_flow_control(dc);
1217 writew(CTRL_DL, dc->reg_fcr);
1218 }
1219 if (read_iir & MDM_DL) {
1220 if (!handle_data_dl(dc, PORT_MDM,
1221 &(dc->port[PORT_MDM].toggle_dl), read_iir,
1222 MDM_DL1, MDM_DL2)) {
1223 dev_err(&dc->pdev->dev, "MDM_DL out of sync!\n");
1224 goto exit_handler;
1225 }
1226 }
1227 if (read_iir & MDM_UL) {
1228 if (!handle_data_ul(dc, PORT_MDM, read_iir)) {
1229 dev_err(&dc->pdev->dev, "MDM_UL out of sync!\n");
1230 goto exit_handler;
1231 }
1232 }
1233 if (read_iir & DIAG_DL) {
1234 if (!handle_data_dl(dc, PORT_DIAG,
1235 &(dc->port[PORT_DIAG].toggle_dl), read_iir,
1236 DIAG_DL1, DIAG_DL2)) {
1237 dev_err(&dc->pdev->dev, "DIAG_DL out of sync!\n");
1238 goto exit_handler;
1239 }
1240 }
1241 if (read_iir & DIAG_UL) {
1242 dc->last_ier &= ~DIAG_UL;
1243 writew(dc->last_ier, dc->reg_ier);
1244 if (send_data(PORT_DIAG, dc)) {
1245 writew(DIAG_UL, dc->reg_fcr);
1246 dc->last_ier = dc->last_ier | DIAG_UL;
1247 writew(dc->last_ier, dc->reg_ier);
1248 }
1249 }
1250 if (read_iir & APP1_DL) {
1251 if (receive_data(PORT_APP1, dc))
1252 writew(APP1_DL, dc->reg_fcr);
1253 }
1254 if (read_iir & APP1_UL) {
1255 dc->last_ier &= ~APP1_UL;
1256 writew(dc->last_ier, dc->reg_ier);
1257 if (send_data(PORT_APP1, dc)) {
1258 writew(APP1_UL, dc->reg_fcr);
1259 dc->last_ier = dc->last_ier | APP1_UL;
1260 writew(dc->last_ier, dc->reg_ier);
1261 }
1262 }
1263 if (read_iir & APP2_DL) {
1264 if (receive_data(PORT_APP2, dc))
1265 writew(APP2_DL, dc->reg_fcr);
1266 }
1267 if (read_iir & APP2_UL) {
1268 dc->last_ier &= ~APP2_UL;
1269 writew(dc->last_ier, dc->reg_ier);
1270 if (send_data(PORT_APP2, dc)) {
1271 writew(APP2_UL, dc->reg_fcr);
1272 dc->last_ier = dc->last_ier | APP2_UL;
1273 writew(dc->last_ier, dc->reg_ier);
1274 }
1275 }
1276
1277exit_handler:
1278 spin_unlock(&dc->spin_mutex);
1279 for (a = 0; a < NOZOMI_MAX_PORTS; a++) {
1280 struct tty_struct *tty;
1281 if (test_and_clear_bit(a, &dc->flip)) {
1282 tty = tty_port_tty_get(&dc->port[a].port);
1283 if (tty)
1284 tty_flip_buffer_push(tty);
1285 tty_kref_put(tty);
1286 }
1287 }
1288 return IRQ_HANDLED;
1289none:
1290 spin_unlock(&dc->spin_mutex);
1291 return IRQ_NONE;
1292}
1293
1294static void nozomi_get_card_type(struct nozomi *dc)
1295{
1296 int i;
1297 u32 size = 0;
1298
1299 for (i = 0; i < 6; i++)
1300 size += pci_resource_len(dc->pdev, i);
1301
1302 /* Assume card type F32_8 if no match */
1303 dc->card_type = size == 2048 ? F32_2 : F32_8;
1304
1305 dev_info(&dc->pdev->dev, "Card type is: %d\n", dc->card_type);
1306}
1307
1308static void nozomi_setup_private_data(struct nozomi *dc)
1309{
1310 void __iomem *offset = dc->base_addr + dc->card_type / 2;
1311 unsigned int i;
1312
1313 dc->reg_fcr = (void __iomem *)(offset + R_FCR);
1314 dc->reg_iir = (void __iomem *)(offset + R_IIR);
1315 dc->reg_ier = (void __iomem *)(offset + R_IER);
1316 dc->last_ier = 0;
1317 dc->flip = 0;
1318
1319 dc->port[PORT_MDM].token_dl = MDM_DL;
1320 dc->port[PORT_DIAG].token_dl = DIAG_DL;
1321 dc->port[PORT_APP1].token_dl = APP1_DL;
1322 dc->port[PORT_APP2].token_dl = APP2_DL;
1323
1324 for (i = 0; i < MAX_PORT; i++)
1325 init_waitqueue_head(&dc->port[i].tty_wait);
1326}
1327
1328static ssize_t card_type_show(struct device *dev, struct device_attribute *attr,
1329 char *buf)
1330{
1331 const struct nozomi *dc = pci_get_drvdata(to_pci_dev(dev));
1332
1333 return sprintf(buf, "%d\n", dc->card_type);
1334}
1335static DEVICE_ATTR(card_type, S_IRUGO, card_type_show, NULL);
1336
1337static ssize_t open_ttys_show(struct device *dev, struct device_attribute *attr,
1338 char *buf)
1339{
1340 const struct nozomi *dc = pci_get_drvdata(to_pci_dev(dev));
1341
1342 return sprintf(buf, "%u\n", dc->open_ttys);
1343}
1344static DEVICE_ATTR(open_ttys, S_IRUGO, open_ttys_show, NULL);
1345
1346static void make_sysfs_files(struct nozomi *dc)
1347{
1348 if (device_create_file(&dc->pdev->dev, &dev_attr_card_type))
1349 dev_err(&dc->pdev->dev,
1350 "Could not create sysfs file for card_type\n");
1351 if (device_create_file(&dc->pdev->dev, &dev_attr_open_ttys))
1352 dev_err(&dc->pdev->dev,
1353 "Could not create sysfs file for open_ttys\n");
1354}
1355
1356static void remove_sysfs_files(struct nozomi *dc)
1357{
1358 device_remove_file(&dc->pdev->dev, &dev_attr_card_type);
1359 device_remove_file(&dc->pdev->dev, &dev_attr_open_ttys);
1360}
1361
1362/* Allocate memory for one device */
1363static int __devinit nozomi_card_init(struct pci_dev *pdev,
1364 const struct pci_device_id *ent)
1365{
1366 resource_size_t start;
1367 int ret;
1368 struct nozomi *dc = NULL;
1369 int ndev_idx;
1370 int i;
1371
1372 dev_dbg(&pdev->dev, "Init, new card found\n");
1373
1374 for (ndev_idx = 0; ndev_idx < ARRAY_SIZE(ndevs); ndev_idx++)
1375 if (!ndevs[ndev_idx])
1376 break;
1377
1378 if (ndev_idx >= ARRAY_SIZE(ndevs)) {
1379 dev_err(&pdev->dev, "no free tty range for this card left\n");
1380 ret = -EIO;
1381 goto err;
1382 }
1383
1384 dc = kzalloc(sizeof(struct nozomi), GFP_KERNEL);
1385 if (unlikely(!dc)) {
1386 dev_err(&pdev->dev, "Could not allocate memory\n");
1387 ret = -ENOMEM;
1388 goto err_free;
1389 }
1390
1391 dc->pdev = pdev;
1392
1393 ret = pci_enable_device(dc->pdev);
1394 if (ret) {
1395 dev_err(&pdev->dev, "Failed to enable PCI Device\n");
1396 goto err_free;
1397 }
1398
1399 ret = pci_request_regions(dc->pdev, NOZOMI_NAME);
1400 if (ret) {
1401 dev_err(&pdev->dev, "I/O address 0x%04x already in use\n",
1402 (int) /* nozomi_private.io_addr */ 0);
1403 goto err_disable_device;
1404 }
1405
1406 start = pci_resource_start(dc->pdev, 0);
1407 if (start == 0) {
1408 dev_err(&pdev->dev, "No I/O address for card detected\n");
1409 ret = -ENODEV;
1410 goto err_rel_regs;
1411 }
1412
1413 /* Find out what card type it is */
1414 nozomi_get_card_type(dc);
1415
1416 dc->base_addr = ioremap_nocache(start, dc->card_type);
1417 if (!dc->base_addr) {
1418 dev_err(&pdev->dev, "Unable to map card MMIO\n");
1419 ret = -ENODEV;
1420 goto err_rel_regs;
1421 }
1422
1423 dc->send_buf = kmalloc(SEND_BUF_MAX, GFP_KERNEL);
1424 if (!dc->send_buf) {
1425 dev_err(&pdev->dev, "Could not allocate send buffer?\n");
1426 ret = -ENOMEM;
1427 goto err_free_sbuf;
1428 }
1429
1430 for (i = PORT_MDM; i < MAX_PORT; i++) {
1431 if (kfifo_alloc(&dc->port[i].fifo_ul, FIFO_BUFFER_SIZE_UL,
1432 GFP_KERNEL)) {
1433 dev_err(&pdev->dev,
1434 "Could not allocate kfifo buffer\n");
1435 ret = -ENOMEM;
1436 goto err_free_kfifo;
1437 }
1438 }
1439
1440 spin_lock_init(&dc->spin_mutex);
1441
1442 nozomi_setup_private_data(dc);
1443
1444 /* Disable all interrupts */
1445 dc->last_ier = 0;
1446 writew(dc->last_ier, dc->reg_ier);
1447
1448 ret = request_irq(pdev->irq, &interrupt_handler, IRQF_SHARED,
1449 NOZOMI_NAME, dc);
1450 if (unlikely(ret)) {
1451 dev_err(&pdev->dev, "can't request irq %d\n", pdev->irq);
1452 goto err_free_kfifo;
1453 }
1454
1455 DBG1("base_addr: %p", dc->base_addr);
1456
1457 make_sysfs_files(dc);
1458
1459 dc->index_start = ndev_idx * MAX_PORT;
1460 ndevs[ndev_idx] = dc;
1461
1462 pci_set_drvdata(pdev, dc);
1463
1464 /* Enable RESET interrupt */
1465 dc->last_ier = RESET;
1466 iowrite16(dc->last_ier, dc->reg_ier);
1467
1468 dc->state = NOZOMI_STATE_ENABLED;
1469
1470 for (i = 0; i < MAX_PORT; i++) {
1471 struct device *tty_dev;
1472 struct port *port = &dc->port[i];
1473 port->dc = dc;
1474 tty_port_init(&port->port);
1475 port->port.ops = &noz_tty_port_ops;
1476 tty_dev = tty_register_device(ntty_driver, dc->index_start + i,
1477 &pdev->dev);
1478
1479 if (IS_ERR(tty_dev)) {
1480 ret = PTR_ERR(tty_dev);
1481 dev_err(&pdev->dev, "Could not allocate tty?\n");
1482 goto err_free_tty;
1483 }
1484 }
1485
1486 return 0;
1487
1488err_free_tty:
1489 for (i = dc->index_start; i < dc->index_start + MAX_PORT; ++i)
1490 tty_unregister_device(ntty_driver, i);
1491err_free_kfifo:
1492 for (i = 0; i < MAX_PORT; i++)
1493 kfifo_free(&dc->port[i].fifo_ul);
1494err_free_sbuf:
1495 kfree(dc->send_buf);
1496 iounmap(dc->base_addr);
1497err_rel_regs:
1498 pci_release_regions(pdev);
1499err_disable_device:
1500 pci_disable_device(pdev);
1501err_free:
1502 kfree(dc);
1503err:
1504 return ret;
1505}
1506
1507static void __devexit tty_exit(struct nozomi *dc)
1508{
1509 unsigned int i;
1510
1511 DBG1(" ");
1512
1513 for (i = 0; i < MAX_PORT; ++i) {
1514 struct tty_struct *tty = tty_port_tty_get(&dc->port[i].port);
1515 if (tty && list_empty(&tty->hangup_work.entry))
1516 tty_hangup(tty);
1517 tty_kref_put(tty);
1518 }
1519 /* Racy below - surely should wait for scheduled work to be done or
1520 complete off a hangup method ? */
1521 while (dc->open_ttys)
1522 msleep(1);
1523 for (i = dc->index_start; i < dc->index_start + MAX_PORT; ++i)
1524 tty_unregister_device(ntty_driver, i);
1525}
1526
1527/* Deallocate memory for one device */
1528static void __devexit nozomi_card_exit(struct pci_dev *pdev)
1529{
1530 int i;
1531 struct ctrl_ul ctrl;
1532 struct nozomi *dc = pci_get_drvdata(pdev);
1533
1534 /* Disable all interrupts */
1535 dc->last_ier = 0;
1536 writew(dc->last_ier, dc->reg_ier);
1537
1538 tty_exit(dc);
1539
1540 /* Send 0x0001, command card to resend the reset token. */
1541 /* This is to get the reset when the module is reloaded. */
1542 ctrl.port = 0x00;
1543 ctrl.reserved = 0;
1544 ctrl.RTS = 0;
1545 ctrl.DTR = 1;
1546 DBG1("sending flow control 0x%04X", *((u16 *)&ctrl));
1547
1548 /* Setup dc->reg addresses to we can use defines here */
1549 write_mem32(dc->port[PORT_CTRL].ul_addr[0], (u32 *)&ctrl, 2);
1550 writew(CTRL_UL, dc->reg_fcr); /* push the token to the card. */
1551
1552 remove_sysfs_files(dc);
1553
1554 free_irq(pdev->irq, dc);
1555
1556 for (i = 0; i < MAX_PORT; i++)
1557 kfifo_free(&dc->port[i].fifo_ul);
1558
1559 kfree(dc->send_buf);
1560
1561 iounmap(dc->base_addr);
1562
1563 pci_release_regions(pdev);
1564
1565 pci_disable_device(pdev);
1566
1567 ndevs[dc->index_start / MAX_PORT] = NULL;
1568
1569 kfree(dc);
1570}
1571
1572static void set_rts(const struct tty_struct *tty, int rts)
1573{
1574 struct port *port = get_port_by_tty(tty);
1575
1576 port->ctrl_ul.RTS = rts;
1577 port->update_flow_control = 1;
1578 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1579}
1580
1581static void set_dtr(const struct tty_struct *tty, int dtr)
1582{
1583 struct port *port = get_port_by_tty(tty);
1584
1585 DBG1("SETTING DTR index: %d, dtr: %d", tty->index, dtr);
1586
1587 port->ctrl_ul.DTR = dtr;
1588 port->update_flow_control = 1;
1589 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1590}
1591
1592/*
1593 * ----------------------------------------------------------------------------
1594 * TTY code
1595 * ----------------------------------------------------------------------------
1596 */
1597
1598static int ntty_install(struct tty_driver *driver, struct tty_struct *tty)
1599{
1600 struct port *port = get_port_by_tty(tty);
1601 struct nozomi *dc = get_dc_by_tty(tty);
1602 int ret;
1603 if (!port || !dc || dc->state != NOZOMI_STATE_READY)
1604 return -ENODEV;
1605 ret = tty_init_termios(tty);
1606 if (ret == 0) {
1607 tty_driver_kref_get(driver);
1608 tty->count++;
1609 tty->driver_data = port;
1610 driver->ttys[tty->index] = tty;
1611 }
1612 return ret;
1613}
1614
1615static void ntty_cleanup(struct tty_struct *tty)
1616{
1617 tty->driver_data = NULL;
1618}
1619
1620static int ntty_activate(struct tty_port *tport, struct tty_struct *tty)
1621{
1622 struct port *port = container_of(tport, struct port, port);
1623 struct nozomi *dc = port->dc;
1624 unsigned long flags;
1625
1626 DBG1("open: %d", port->token_dl);
1627 spin_lock_irqsave(&dc->spin_mutex, flags);
1628 dc->last_ier = dc->last_ier | port->token_dl;
1629 writew(dc->last_ier, dc->reg_ier);
1630 dc->open_ttys++;
1631 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1632 printk("noz: activated %d: %p\n", tty->index, tport);
1633 return 0;
1634}
1635
1636static int ntty_open(struct tty_struct *tty, struct file *filp)
1637{
1638 struct port *port = tty->driver_data;
1639 return tty_port_open(&port->port, tty, filp);
1640}
1641
1642static void ntty_shutdown(struct tty_port *tport)
1643{
1644 struct port *port = container_of(tport, struct port, port);
1645 struct nozomi *dc = port->dc;
1646 unsigned long flags;
1647
1648 DBG1("close: %d", port->token_dl);
1649 spin_lock_irqsave(&dc->spin_mutex, flags);
1650 dc->last_ier &= ~(port->token_dl);
1651 writew(dc->last_ier, dc->reg_ier);
1652 dc->open_ttys--;
1653 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1654 printk("noz: shutdown %p\n", tport);
1655}
1656
1657static void ntty_close(struct tty_struct *tty, struct file *filp)
1658{
1659 struct port *port = tty->driver_data;
1660 if (port)
1661 tty_port_close(&port->port, tty, filp);
1662}
1663
1664static void ntty_hangup(struct tty_struct *tty)
1665{
1666 struct port *port = tty->driver_data;
1667 tty_port_hangup(&port->port);
1668}
1669
1670/*
1671 * called when the userspace process writes to the tty (/dev/noz*).
1672 * Data is inserted into a fifo, which is then read and transferred to the modem.
1673 */
1674static int ntty_write(struct tty_struct *tty, const unsigned char *buffer,
1675 int count)
1676{
1677 int rval = -EINVAL;
1678 struct nozomi *dc = get_dc_by_tty(tty);
1679 struct port *port = tty->driver_data;
1680 unsigned long flags;
1681
1682 /* DBG1( "WRITEx: %d, index = %d", count, index); */
1683
1684 if (!dc || !port)
1685 return -ENODEV;
1686
1687 rval = kfifo_in(&port->fifo_ul, (unsigned char *)buffer, count);
1688
1689 /* notify card */
1690 if (unlikely(dc == NULL)) {
1691 DBG1("No device context?");
1692 goto exit;
1693 }
1694
1695 spin_lock_irqsave(&dc->spin_mutex, flags);
1696 /* CTS is only valid on the modem channel */
1697 if (port == &(dc->port[PORT_MDM])) {
1698 if (port->ctrl_dl.CTS) {
1699 DBG4("Enable interrupt");
1700 enable_transmit_ul(tty->index % MAX_PORT, dc);
1701 } else {
1702 dev_err(&dc->pdev->dev,
1703 "CTS not active on modem port?\n");
1704 }
1705 } else {
1706 enable_transmit_ul(tty->index % MAX_PORT, dc);
1707 }
1708 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1709
1710exit:
1711 return rval;
1712}
1713
1714/*
1715 * Calculate how much is left in device
1716 * This method is called by the upper tty layer.
1717 * #according to sources N_TTY.c it expects a value >= 0 and
1718 * does not check for negative values.
1719 *
1720 * If the port is unplugged report lots of room and let the bits
1721 * dribble away so we don't block anything.
1722 */
1723static int ntty_write_room(struct tty_struct *tty)
1724{
1725 struct port *port = tty->driver_data;
1726 int room = 4096;
1727 const struct nozomi *dc = get_dc_by_tty(tty);
1728
1729 if (dc)
1730 room = kfifo_avail(&port->fifo_ul);
1731
1732 return room;
1733}
1734
1735/* Gets io control parameters */
1736static int ntty_tiocmget(struct tty_struct *tty)
1737{
1738 const struct port *port = tty->driver_data;
1739 const struct ctrl_dl *ctrl_dl = &port->ctrl_dl;
1740 const struct ctrl_ul *ctrl_ul = &port->ctrl_ul;
1741
1742 /* Note: these could change under us but it is not clear this
1743 matters if so */
1744 return (ctrl_ul->RTS ? TIOCM_RTS : 0) |
1745 (ctrl_ul->DTR ? TIOCM_DTR : 0) |
1746 (ctrl_dl->DCD ? TIOCM_CAR : 0) |
1747 (ctrl_dl->RI ? TIOCM_RNG : 0) |
1748 (ctrl_dl->DSR ? TIOCM_DSR : 0) |
1749 (ctrl_dl->CTS ? TIOCM_CTS : 0);
1750}
1751
1752/* Sets io controls parameters */
1753static int ntty_tiocmset(struct tty_struct *tty,
1754 unsigned int set, unsigned int clear)
1755{
1756 struct nozomi *dc = get_dc_by_tty(tty);
1757 unsigned long flags;
1758
1759 spin_lock_irqsave(&dc->spin_mutex, flags);
1760 if (set & TIOCM_RTS)
1761 set_rts(tty, 1);
1762 else if (clear & TIOCM_RTS)
1763 set_rts(tty, 0);
1764
1765 if (set & TIOCM_DTR)
1766 set_dtr(tty, 1);
1767 else if (clear & TIOCM_DTR)
1768 set_dtr(tty, 0);
1769 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1770
1771 return 0;
1772}
1773
1774static int ntty_cflags_changed(struct port *port, unsigned long flags,
1775 struct async_icount *cprev)
1776{
1777 const struct async_icount cnow = port->tty_icount;
1778 int ret;
1779
1780 ret = ((flags & TIOCM_RNG) && (cnow.rng != cprev->rng)) ||
1781 ((flags & TIOCM_DSR) && (cnow.dsr != cprev->dsr)) ||
1782 ((flags & TIOCM_CD) && (cnow.dcd != cprev->dcd)) ||
1783 ((flags & TIOCM_CTS) && (cnow.cts != cprev->cts));
1784
1785 *cprev = cnow;
1786
1787 return ret;
1788}
1789
1790static int ntty_tiocgicount(struct tty_struct *tty,
1791 struct serial_icounter_struct *icount)
1792{
1793 struct port *port = tty->driver_data;
1794 const struct async_icount cnow = port->tty_icount;
1795
1796 icount->cts = cnow.cts;
1797 icount->dsr = cnow.dsr;
1798 icount->rng = cnow.rng;
1799 icount->dcd = cnow.dcd;
1800 icount->rx = cnow.rx;
1801 icount->tx = cnow.tx;
1802 icount->frame = cnow.frame;
1803 icount->overrun = cnow.overrun;
1804 icount->parity = cnow.parity;
1805 icount->brk = cnow.brk;
1806 icount->buf_overrun = cnow.buf_overrun;
1807 return 0;
1808}
1809
1810static int ntty_ioctl(struct tty_struct *tty,
1811 unsigned int cmd, unsigned long arg)
1812{
1813 struct port *port = tty->driver_data;
1814 int rval = -ENOIOCTLCMD;
1815
1816 DBG1("******** IOCTL, cmd: %d", cmd);
1817
1818 switch (cmd) {
1819 case TIOCMIWAIT: {
1820 struct async_icount cprev = port->tty_icount;
1821
1822 rval = wait_event_interruptible(port->tty_wait,
1823 ntty_cflags_changed(port, arg, &cprev));
1824 break;
1825 }
1826 default:
1827 DBG1("ERR: 0x%08X, %d", cmd, cmd);
1828 break;
1829 };
1830
1831 return rval;
1832}
1833
1834/*
1835 * Called by the upper tty layer when tty buffers are ready
1836 * to receive data again after a call to throttle.
1837 */
1838static void ntty_unthrottle(struct tty_struct *tty)
1839{
1840 struct nozomi *dc = get_dc_by_tty(tty);
1841 unsigned long flags;
1842
1843 DBG1("UNTHROTTLE");
1844 spin_lock_irqsave(&dc->spin_mutex, flags);
1845 enable_transmit_dl(tty->index % MAX_PORT, dc);
1846 set_rts(tty, 1);
1847
1848 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1849}
1850
1851/*
1852 * Called by the upper tty layer when the tty buffers are almost full.
1853 * The driver should stop send more data.
1854 */
1855static void ntty_throttle(struct tty_struct *tty)
1856{
1857 struct nozomi *dc = get_dc_by_tty(tty);
1858 unsigned long flags;
1859
1860 DBG1("THROTTLE");
1861 spin_lock_irqsave(&dc->spin_mutex, flags);
1862 set_rts(tty, 0);
1863 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1864}
1865
1866/* Returns number of chars in buffer, called by tty layer */
1867static s32 ntty_chars_in_buffer(struct tty_struct *tty)
1868{
1869 struct port *port = tty->driver_data;
1870 struct nozomi *dc = get_dc_by_tty(tty);
1871 s32 rval = 0;
1872
1873 if (unlikely(!dc || !port)) {
1874 goto exit_in_buffer;
1875 }
1876
1877 rval = kfifo_len(&port->fifo_ul);
1878
1879exit_in_buffer:
1880 return rval;
1881}
1882
1883static const struct tty_port_operations noz_tty_port_ops = {
1884 .activate = ntty_activate,
1885 .shutdown = ntty_shutdown,
1886};
1887
1888static const struct tty_operations tty_ops = {
1889 .ioctl = ntty_ioctl,
1890 .open = ntty_open,
1891 .close = ntty_close,
1892 .hangup = ntty_hangup,
1893 .write = ntty_write,
1894 .write_room = ntty_write_room,
1895 .unthrottle = ntty_unthrottle,
1896 .throttle = ntty_throttle,
1897 .chars_in_buffer = ntty_chars_in_buffer,
1898 .tiocmget = ntty_tiocmget,
1899 .tiocmset = ntty_tiocmset,
1900 .get_icount = ntty_tiocgicount,
1901 .install = ntty_install,
1902 .cleanup = ntty_cleanup,
1903};
1904
1905/* Module initialization */
1906static struct pci_driver nozomi_driver = {
1907 .name = NOZOMI_NAME,
1908 .id_table = nozomi_pci_tbl,
1909 .probe = nozomi_card_init,
1910 .remove = __devexit_p(nozomi_card_exit),
1911};
1912
1913static __init int nozomi_init(void)
1914{
1915 int ret;
1916
1917 printk(KERN_INFO "Initializing %s\n", VERSION_STRING);
1918
1919 ntty_driver = alloc_tty_driver(NTTY_TTY_MAXMINORS);
1920 if (!ntty_driver)
1921 return -ENOMEM;
1922
1923 ntty_driver->owner = THIS_MODULE;
1924 ntty_driver->driver_name = NOZOMI_NAME_TTY;
1925 ntty_driver->name = "noz";
1926 ntty_driver->major = 0;
1927 ntty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1928 ntty_driver->subtype = SERIAL_TYPE_NORMAL;
1929 ntty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1930 ntty_driver->init_termios = tty_std_termios;
1931 ntty_driver->init_termios.c_cflag = B115200 | CS8 | CREAD | \
1932 HUPCL | CLOCAL;
1933 ntty_driver->init_termios.c_ispeed = 115200;
1934 ntty_driver->init_termios.c_ospeed = 115200;
1935 tty_set_operations(ntty_driver, &tty_ops);
1936
1937 ret = tty_register_driver(ntty_driver);
1938 if (ret) {
1939 printk(KERN_ERR "Nozomi: failed to register ntty driver\n");
1940 goto free_tty;
1941 }
1942
1943 ret = pci_register_driver(&nozomi_driver);
1944 if (ret) {
1945 printk(KERN_ERR "Nozomi: can't register pci driver\n");
1946 goto unr_tty;
1947 }
1948
1949 return 0;
1950unr_tty:
1951 tty_unregister_driver(ntty_driver);
1952free_tty:
1953 put_tty_driver(ntty_driver);
1954 return ret;
1955}
1956
1957static __exit void nozomi_exit(void)
1958{
1959 printk(KERN_INFO "Unloading %s\n", DRIVER_DESC);
1960 pci_unregister_driver(&nozomi_driver);
1961 tty_unregister_driver(ntty_driver);
1962 put_tty_driver(ntty_driver);
1963}
1964
1965module_init(nozomi_init);
1966module_exit(nozomi_exit);
1967
1968module_param(debug, int, S_IRUGO | S_IWUSR);
1969
1970MODULE_LICENSE("Dual BSD/GPL");
1971MODULE_DESCRIPTION(DRIVER_DESC);
1// SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
2/*
3 * nozomi.c -- HSDPA driver Broadband Wireless Data Card - Globe Trotter
4 *
5 * Written by: Ulf Jakobsson,
6 * Jan Åkerfeldt,
7 * Stefan Thomasson,
8 *
9 * Maintained by: Paul Hardwick (p.hardwick@option.com)
10 *
11 * Patches:
12 * Locking code changes for Vodafone by Sphere Systems Ltd,
13 * Andrew Bird (ajb@spheresystems.co.uk )
14 * & Phil Sanderson
15 *
16 * Source has been ported from an implementation made by Filip Aben @ Option
17 *
18 * --------------------------------------------------------------------------
19 *
20 * Copyright (c) 2005,2006 Option Wireless Sweden AB
21 * Copyright (c) 2006 Sphere Systems Ltd
22 * Copyright (c) 2006 Option Wireless n/v
23 * All rights Reserved.
24 *
25 * --------------------------------------------------------------------------
26 */
27
28/* Enable this to have a lot of debug printouts */
29#define DEBUG
30
31#include <linux/kernel.h>
32#include <linux/module.h>
33#include <linux/pci.h>
34#include <linux/ioport.h>
35#include <linux/tty.h>
36#include <linux/tty_driver.h>
37#include <linux/tty_flip.h>
38#include <linux/sched.h>
39#include <linux/serial.h>
40#include <linux/interrupt.h>
41#include <linux/kmod.h>
42#include <linux/init.h>
43#include <linux/kfifo.h>
44#include <linux/uaccess.h>
45#include <linux/slab.h>
46#include <asm/byteorder.h>
47
48#include <linux/delay.h>
49
50/* Default debug printout level */
51#define NOZOMI_DEBUG_LEVEL 0x00
52static int debug = NOZOMI_DEBUG_LEVEL;
53module_param(debug, int, S_IRUGO | S_IWUSR);
54
55/* Macros definitions */
56#define DBG_(lvl, fmt, args...) \
57do { \
58 if (lvl & debug) \
59 pr_debug("[%d] %s(): " fmt "\n", \
60 __LINE__, __func__, ##args); \
61} while (0)
62
63#define DBG1(args...) DBG_(0x01, ##args)
64#define DBG2(args...) DBG_(0x02, ##args)
65#define DBG3(args...) DBG_(0x04, ##args)
66#define DBG4(args...) DBG_(0x08, ##args)
67
68/* TODO: rewrite to optimize macros... */
69
70#define TMP_BUF_MAX 256
71
72#define DUMP(buf__, len__) \
73 do { \
74 char tbuf[TMP_BUF_MAX] = {0}; \
75 if (len__ > 1) { \
76 u32 data_len = min_t(u32, len__, TMP_BUF_MAX); \
77 strscpy(tbuf, buf__, data_len); \
78 if (tbuf[data_len - 2] == '\r') \
79 tbuf[data_len - 2] = 'r'; \
80 DBG1("SENDING: '%s' (%d+n)", tbuf, len__); \
81 } else { \
82 DBG1("SENDING: '%s' (%d)", tbuf, len__); \
83 } \
84 } while (0)
85
86/* Defines */
87#define NOZOMI_NAME "nozomi"
88#define NOZOMI_NAME_TTY "nozomi_tty"
89
90#define NTTY_TTY_MAXMINORS 256
91#define NTTY_FIFO_BUFFER_SIZE 8192
92
93/* Must be power of 2 */
94#define FIFO_BUFFER_SIZE_UL 8192
95
96/* Size of tmp send buffer to card */
97#define SEND_BUF_MAX 1024
98#define RECEIVE_BUF_MAX 4
99
100
101#define R_IIR 0x0000 /* Interrupt Identity Register */
102#define R_FCR 0x0000 /* Flow Control Register */
103#define R_IER 0x0004 /* Interrupt Enable Register */
104
105#define NOZOMI_CONFIG_MAGIC 0xEFEFFEFE
106#define TOGGLE_VALID 0x0000
107
108/* Definition of interrupt tokens */
109#define MDM_DL1 0x0001
110#define MDM_UL1 0x0002
111#define MDM_DL2 0x0004
112#define MDM_UL2 0x0008
113#define DIAG_DL1 0x0010
114#define DIAG_DL2 0x0020
115#define DIAG_UL 0x0040
116#define APP1_DL 0x0080
117#define APP1_UL 0x0100
118#define APP2_DL 0x0200
119#define APP2_UL 0x0400
120#define CTRL_DL 0x0800
121#define CTRL_UL 0x1000
122#define RESET 0x8000
123
124#define MDM_DL (MDM_DL1 | MDM_DL2)
125#define MDM_UL (MDM_UL1 | MDM_UL2)
126#define DIAG_DL (DIAG_DL1 | DIAG_DL2)
127
128/* modem signal definition */
129#define CTRL_DSR 0x0001
130#define CTRL_DCD 0x0002
131#define CTRL_RI 0x0004
132#define CTRL_CTS 0x0008
133
134#define CTRL_DTR 0x0001
135#define CTRL_RTS 0x0002
136
137#define MAX_PORT 4
138#define NOZOMI_MAX_PORTS 5
139#define NOZOMI_MAX_CARDS (NTTY_TTY_MAXMINORS / MAX_PORT)
140
141/* Type definitions */
142
143/*
144 * There are two types of nozomi cards,
145 * one with 2048 memory and with 8192 memory
146 */
147enum card_type {
148 F32_2 = 2048, /* 512 bytes downlink + uplink * 2 -> 2048 */
149 F32_8 = 8192, /* 3072 bytes downl. + 1024 bytes uplink * 2 -> 8192 */
150};
151
152/* Initialization states a card can be in */
153enum card_state {
154 NOZOMI_STATE_UNKNOWN = 0,
155 NOZOMI_STATE_ENABLED = 1, /* pci device enabled */
156 NOZOMI_STATE_ALLOCATED = 2, /* config setup done */
157 NOZOMI_STATE_READY = 3, /* flowcontrols received */
158};
159
160/* Two different toggle channels exist */
161enum channel_type {
162 CH_A = 0,
163 CH_B = 1,
164};
165
166/* Port definition for the card regarding flow control */
167enum ctrl_port_type {
168 CTRL_CMD = 0,
169 CTRL_MDM = 1,
170 CTRL_DIAG = 2,
171 CTRL_APP1 = 3,
172 CTRL_APP2 = 4,
173 CTRL_ERROR = -1,
174};
175
176/* Ports that the nozomi has */
177enum port_type {
178 PORT_MDM = 0,
179 PORT_DIAG = 1,
180 PORT_APP1 = 2,
181 PORT_APP2 = 3,
182 PORT_CTRL = 4,
183 PORT_ERROR = -1,
184};
185
186#ifdef __BIG_ENDIAN
187/* Big endian */
188
189struct toggles {
190 unsigned int enabled:5; /*
191 * Toggle fields are valid if enabled is 0,
192 * else A-channels must always be used.
193 */
194 unsigned int diag_dl:1;
195 unsigned int mdm_dl:1;
196 unsigned int mdm_ul:1;
197} __attribute__ ((packed));
198
199/* Configuration table to read at startup of card */
200/* Is for now only needed during initialization phase */
201struct config_table {
202 u32 signature;
203 u16 product_information;
204 u16 version;
205 u8 pad3[3];
206 struct toggles toggle;
207 u8 pad1[4];
208 u16 dl_mdm_len1; /*
209 * If this is 64, it can hold
210 * 60 bytes + 4 that is length field
211 */
212 u16 dl_start;
213
214 u16 dl_diag_len1;
215 u16 dl_mdm_len2; /*
216 * If this is 64, it can hold
217 * 60 bytes + 4 that is length field
218 */
219 u16 dl_app1_len;
220
221 u16 dl_diag_len2;
222 u16 dl_ctrl_len;
223 u16 dl_app2_len;
224 u8 pad2[16];
225 u16 ul_mdm_len1;
226 u16 ul_start;
227 u16 ul_diag_len;
228 u16 ul_mdm_len2;
229 u16 ul_app1_len;
230 u16 ul_app2_len;
231 u16 ul_ctrl_len;
232} __attribute__ ((packed));
233
234/* This stores all control downlink flags */
235struct ctrl_dl {
236 u8 port;
237 unsigned int reserved:4;
238 unsigned int CTS:1;
239 unsigned int RI:1;
240 unsigned int DCD:1;
241 unsigned int DSR:1;
242} __attribute__ ((packed));
243
244/* This stores all control uplink flags */
245struct ctrl_ul {
246 u8 port;
247 unsigned int reserved:6;
248 unsigned int RTS:1;
249 unsigned int DTR:1;
250} __attribute__ ((packed));
251
252#else
253/* Little endian */
254
255/* This represents the toggle information */
256struct toggles {
257 unsigned int mdm_ul:1;
258 unsigned int mdm_dl:1;
259 unsigned int diag_dl:1;
260 unsigned int enabled:5; /*
261 * Toggle fields are valid if enabled is 0,
262 * else A-channels must always be used.
263 */
264} __attribute__ ((packed));
265
266/* Configuration table to read at startup of card */
267struct config_table {
268 u32 signature;
269 u16 version;
270 u16 product_information;
271 struct toggles toggle;
272 u8 pad1[7];
273 u16 dl_start;
274 u16 dl_mdm_len1; /*
275 * If this is 64, it can hold
276 * 60 bytes + 4 that is length field
277 */
278 u16 dl_mdm_len2;
279 u16 dl_diag_len1;
280 u16 dl_diag_len2;
281 u16 dl_app1_len;
282 u16 dl_app2_len;
283 u16 dl_ctrl_len;
284 u8 pad2[16];
285 u16 ul_start;
286 u16 ul_mdm_len2;
287 u16 ul_mdm_len1;
288 u16 ul_diag_len;
289 u16 ul_app1_len;
290 u16 ul_app2_len;
291 u16 ul_ctrl_len;
292} __attribute__ ((packed));
293
294/* This stores all control downlink flags */
295struct ctrl_dl {
296 unsigned int DSR:1;
297 unsigned int DCD:1;
298 unsigned int RI:1;
299 unsigned int CTS:1;
300 unsigned int reserved:4;
301 u8 port;
302} __attribute__ ((packed));
303
304/* This stores all control uplink flags */
305struct ctrl_ul {
306 unsigned int DTR:1;
307 unsigned int RTS:1;
308 unsigned int reserved:6;
309 u8 port;
310} __attribute__ ((packed));
311#endif
312
313/* This holds all information that is needed regarding a port */
314struct port {
315 struct tty_port port;
316 u8 update_flow_control;
317 struct ctrl_ul ctrl_ul;
318 struct ctrl_dl ctrl_dl;
319 struct kfifo fifo_ul;
320 void __iomem *dl_addr[2];
321 u32 dl_size[2];
322 u8 toggle_dl;
323 void __iomem *ul_addr[2];
324 u32 ul_size[2];
325 u8 toggle_ul;
326 u16 token_dl;
327
328 wait_queue_head_t tty_wait;
329 struct async_icount tty_icount;
330
331 struct nozomi *dc;
332};
333
334/* Private data one for each card in the system */
335struct nozomi {
336 void __iomem *base_addr;
337 unsigned long flip;
338
339 /* Pointers to registers */
340 void __iomem *reg_iir;
341 void __iomem *reg_fcr;
342 void __iomem *reg_ier;
343
344 u16 last_ier;
345 enum card_type card_type;
346 struct config_table config_table; /* Configuration table */
347 struct pci_dev *pdev;
348 struct port port[NOZOMI_MAX_PORTS];
349 u8 *send_buf;
350
351 spinlock_t spin_mutex; /* secures access to registers and tty */
352
353 unsigned int index_start;
354 enum card_state state;
355 u32 open_ttys;
356};
357
358/* Global variables */
359static const struct pci_device_id nozomi_pci_tbl[] = {
360 {PCI_DEVICE(0x1931, 0x000c)}, /* Nozomi HSDPA */
361 {},
362};
363
364MODULE_DEVICE_TABLE(pci, nozomi_pci_tbl);
365
366static struct nozomi *ndevs[NOZOMI_MAX_CARDS];
367static struct tty_driver *ntty_driver;
368
369static const struct tty_port_operations noz_tty_port_ops;
370
371/*
372 * find card by tty_index
373 */
374static inline struct nozomi *get_dc_by_tty(const struct tty_struct *tty)
375{
376 return tty ? ndevs[tty->index / MAX_PORT] : NULL;
377}
378
379static inline struct port *get_port_by_tty(const struct tty_struct *tty)
380{
381 struct nozomi *ndev = get_dc_by_tty(tty);
382 return ndev ? &ndev->port[tty->index % MAX_PORT] : NULL;
383}
384
385/*
386 * TODO:
387 * -Optimize
388 * -Rewrite cleaner
389 */
390
391static void read_mem32(u32 *buf, const void __iomem *mem_addr_start,
392 u32 size_bytes)
393{
394 u32 i = 0;
395 const u32 __iomem *ptr = mem_addr_start;
396 u16 *buf16;
397
398 if (unlikely(!ptr || !buf))
399 goto out;
400
401 /* shortcut for extremely often used cases */
402 switch (size_bytes) {
403 case 2: /* 2 bytes */
404 buf16 = (u16 *) buf;
405 *buf16 = __le16_to_cpu(readw(ptr));
406 goto out;
407 case 4: /* 4 bytes */
408 *(buf) = __le32_to_cpu(readl(ptr));
409 goto out;
410 }
411
412 while (i < size_bytes) {
413 if (size_bytes - i == 2) {
414 /* Handle 2 bytes in the end */
415 buf16 = (u16 *) buf;
416 *(buf16) = __le16_to_cpu(readw(ptr));
417 i += 2;
418 } else {
419 /* Read 4 bytes */
420 *(buf) = __le32_to_cpu(readl(ptr));
421 i += 4;
422 }
423 buf++;
424 ptr++;
425 }
426out:
427 return;
428}
429
430/*
431 * TODO:
432 * -Optimize
433 * -Rewrite cleaner
434 */
435static u32 write_mem32(void __iomem *mem_addr_start, const u32 *buf,
436 u32 size_bytes)
437{
438 u32 i = 0;
439 u32 __iomem *ptr = mem_addr_start;
440 const u16 *buf16;
441
442 if (unlikely(!ptr || !buf))
443 return 0;
444
445 /* shortcut for extremely often used cases */
446 switch (size_bytes) {
447 case 2: /* 2 bytes */
448 buf16 = (const u16 *)buf;
449 writew(__cpu_to_le16(*buf16), ptr);
450 return 2;
451 case 1: /*
452 * also needs to write 4 bytes in this case
453 * so falling through..
454 */
455 fallthrough;
456 case 4: /* 4 bytes */
457 writel(__cpu_to_le32(*buf), ptr);
458 return 4;
459 }
460
461 while (i < size_bytes) {
462 if (size_bytes - i == 2) {
463 /* 2 bytes */
464 buf16 = (const u16 *)buf;
465 writew(__cpu_to_le16(*buf16), ptr);
466 i += 2;
467 } else {
468 /* 4 bytes */
469 writel(__cpu_to_le32(*buf), ptr);
470 i += 4;
471 }
472 buf++;
473 ptr++;
474 }
475 return i;
476}
477
478/* Setup pointers to different channels and also setup buffer sizes. */
479static void nozomi_setup_memory(struct nozomi *dc)
480{
481 void __iomem *offset = dc->base_addr + dc->config_table.dl_start;
482 /* The length reported is including the length field of 4 bytes,
483 * hence subtract with 4.
484 */
485 const u16 buff_offset = 4;
486
487 /* Modem port dl configuration */
488 dc->port[PORT_MDM].dl_addr[CH_A] = offset;
489 dc->port[PORT_MDM].dl_addr[CH_B] =
490 (offset += dc->config_table.dl_mdm_len1);
491 dc->port[PORT_MDM].dl_size[CH_A] =
492 dc->config_table.dl_mdm_len1 - buff_offset;
493 dc->port[PORT_MDM].dl_size[CH_B] =
494 dc->config_table.dl_mdm_len2 - buff_offset;
495
496 /* Diag port dl configuration */
497 dc->port[PORT_DIAG].dl_addr[CH_A] =
498 (offset += dc->config_table.dl_mdm_len2);
499 dc->port[PORT_DIAG].dl_size[CH_A] =
500 dc->config_table.dl_diag_len1 - buff_offset;
501 dc->port[PORT_DIAG].dl_addr[CH_B] =
502 (offset += dc->config_table.dl_diag_len1);
503 dc->port[PORT_DIAG].dl_size[CH_B] =
504 dc->config_table.dl_diag_len2 - buff_offset;
505
506 /* App1 port dl configuration */
507 dc->port[PORT_APP1].dl_addr[CH_A] =
508 (offset += dc->config_table.dl_diag_len2);
509 dc->port[PORT_APP1].dl_size[CH_A] =
510 dc->config_table.dl_app1_len - buff_offset;
511
512 /* App2 port dl configuration */
513 dc->port[PORT_APP2].dl_addr[CH_A] =
514 (offset += dc->config_table.dl_app1_len);
515 dc->port[PORT_APP2].dl_size[CH_A] =
516 dc->config_table.dl_app2_len - buff_offset;
517
518 /* Ctrl dl configuration */
519 dc->port[PORT_CTRL].dl_addr[CH_A] =
520 (offset += dc->config_table.dl_app2_len);
521 dc->port[PORT_CTRL].dl_size[CH_A] =
522 dc->config_table.dl_ctrl_len - buff_offset;
523
524 offset = dc->base_addr + dc->config_table.ul_start;
525
526 /* Modem Port ul configuration */
527 dc->port[PORT_MDM].ul_addr[CH_A] = offset;
528 dc->port[PORT_MDM].ul_size[CH_A] =
529 dc->config_table.ul_mdm_len1 - buff_offset;
530 dc->port[PORT_MDM].ul_addr[CH_B] =
531 (offset += dc->config_table.ul_mdm_len1);
532 dc->port[PORT_MDM].ul_size[CH_B] =
533 dc->config_table.ul_mdm_len2 - buff_offset;
534
535 /* Diag port ul configuration */
536 dc->port[PORT_DIAG].ul_addr[CH_A] =
537 (offset += dc->config_table.ul_mdm_len2);
538 dc->port[PORT_DIAG].ul_size[CH_A] =
539 dc->config_table.ul_diag_len - buff_offset;
540
541 /* App1 port ul configuration */
542 dc->port[PORT_APP1].ul_addr[CH_A] =
543 (offset += dc->config_table.ul_diag_len);
544 dc->port[PORT_APP1].ul_size[CH_A] =
545 dc->config_table.ul_app1_len - buff_offset;
546
547 /* App2 port ul configuration */
548 dc->port[PORT_APP2].ul_addr[CH_A] =
549 (offset += dc->config_table.ul_app1_len);
550 dc->port[PORT_APP2].ul_size[CH_A] =
551 dc->config_table.ul_app2_len - buff_offset;
552
553 /* Ctrl ul configuration */
554 dc->port[PORT_CTRL].ul_addr[CH_A] =
555 (offset += dc->config_table.ul_app2_len);
556 dc->port[PORT_CTRL].ul_size[CH_A] =
557 dc->config_table.ul_ctrl_len - buff_offset;
558}
559
560/* Dump config table under initalization phase */
561#ifdef DEBUG
562static void dump_table(const struct nozomi *dc)
563{
564 DBG3("signature: 0x%08X", dc->config_table.signature);
565 DBG3("version: 0x%04X", dc->config_table.version);
566 DBG3("product_information: 0x%04X", \
567 dc->config_table.product_information);
568 DBG3("toggle enabled: %d", dc->config_table.toggle.enabled);
569 DBG3("toggle up_mdm: %d", dc->config_table.toggle.mdm_ul);
570 DBG3("toggle dl_mdm: %d", dc->config_table.toggle.mdm_dl);
571 DBG3("toggle dl_dbg: %d", dc->config_table.toggle.diag_dl);
572
573 DBG3("dl_start: 0x%04X", dc->config_table.dl_start);
574 DBG3("dl_mdm_len0: 0x%04X, %d", dc->config_table.dl_mdm_len1,
575 dc->config_table.dl_mdm_len1);
576 DBG3("dl_mdm_len1: 0x%04X, %d", dc->config_table.dl_mdm_len2,
577 dc->config_table.dl_mdm_len2);
578 DBG3("dl_diag_len0: 0x%04X, %d", dc->config_table.dl_diag_len1,
579 dc->config_table.dl_diag_len1);
580 DBG3("dl_diag_len1: 0x%04X, %d", dc->config_table.dl_diag_len2,
581 dc->config_table.dl_diag_len2);
582 DBG3("dl_app1_len: 0x%04X, %d", dc->config_table.dl_app1_len,
583 dc->config_table.dl_app1_len);
584 DBG3("dl_app2_len: 0x%04X, %d", dc->config_table.dl_app2_len,
585 dc->config_table.dl_app2_len);
586 DBG3("dl_ctrl_len: 0x%04X, %d", dc->config_table.dl_ctrl_len,
587 dc->config_table.dl_ctrl_len);
588 DBG3("ul_start: 0x%04X, %d", dc->config_table.ul_start,
589 dc->config_table.ul_start);
590 DBG3("ul_mdm_len[0]: 0x%04X, %d", dc->config_table.ul_mdm_len1,
591 dc->config_table.ul_mdm_len1);
592 DBG3("ul_mdm_len[1]: 0x%04X, %d", dc->config_table.ul_mdm_len2,
593 dc->config_table.ul_mdm_len2);
594 DBG3("ul_diag_len: 0x%04X, %d", dc->config_table.ul_diag_len,
595 dc->config_table.ul_diag_len);
596 DBG3("ul_app1_len: 0x%04X, %d", dc->config_table.ul_app1_len,
597 dc->config_table.ul_app1_len);
598 DBG3("ul_app2_len: 0x%04X, %d", dc->config_table.ul_app2_len,
599 dc->config_table.ul_app2_len);
600 DBG3("ul_ctrl_len: 0x%04X, %d", dc->config_table.ul_ctrl_len,
601 dc->config_table.ul_ctrl_len);
602}
603#else
604static inline void dump_table(const struct nozomi *dc) { }
605#endif
606
607/*
608 * Read configuration table from card under intalization phase
609 * Returns 1 if ok, else 0
610 */
611static int nozomi_read_config_table(struct nozomi *dc)
612{
613 read_mem32((u32 *) &dc->config_table, dc->base_addr + 0,
614 sizeof(struct config_table));
615
616 if (dc->config_table.signature != NOZOMI_CONFIG_MAGIC) {
617 dev_err(&dc->pdev->dev, "ConfigTable Bad! 0x%08X != 0x%08X\n",
618 dc->config_table.signature, NOZOMI_CONFIG_MAGIC);
619 return 0;
620 }
621
622 if ((dc->config_table.version == 0)
623 || (dc->config_table.toggle.enabled == TOGGLE_VALID)) {
624 int i;
625 DBG1("Second phase, configuring card");
626
627 nozomi_setup_memory(dc);
628
629 dc->port[PORT_MDM].toggle_ul = dc->config_table.toggle.mdm_ul;
630 dc->port[PORT_MDM].toggle_dl = dc->config_table.toggle.mdm_dl;
631 dc->port[PORT_DIAG].toggle_dl = dc->config_table.toggle.diag_dl;
632 DBG1("toggle ports: MDM UL:%d MDM DL:%d, DIAG DL:%d",
633 dc->port[PORT_MDM].toggle_ul,
634 dc->port[PORT_MDM].toggle_dl, dc->port[PORT_DIAG].toggle_dl);
635
636 dump_table(dc);
637
638 for (i = PORT_MDM; i < MAX_PORT; i++) {
639 memset(&dc->port[i].ctrl_dl, 0, sizeof(struct ctrl_dl));
640 memset(&dc->port[i].ctrl_ul, 0, sizeof(struct ctrl_ul));
641 }
642
643 /* Enable control channel */
644 dc->last_ier = dc->last_ier | CTRL_DL;
645 writew(dc->last_ier, dc->reg_ier);
646
647 dc->state = NOZOMI_STATE_ALLOCATED;
648 dev_info(&dc->pdev->dev, "Initialization OK!\n");
649 return 1;
650 }
651
652 if ((dc->config_table.version > 0)
653 && (dc->config_table.toggle.enabled != TOGGLE_VALID)) {
654 u32 offset = 0;
655 DBG1("First phase: pushing upload buffers, clearing download");
656
657 dev_info(&dc->pdev->dev, "Version of card: %d\n",
658 dc->config_table.version);
659
660 /* Here we should disable all I/O over F32. */
661 nozomi_setup_memory(dc);
662
663 /*
664 * We should send ALL channel pair tokens back along
665 * with reset token
666 */
667
668 /* push upload modem buffers */
669 write_mem32(dc->port[PORT_MDM].ul_addr[CH_A],
670 (u32 *) &offset, 4);
671 write_mem32(dc->port[PORT_MDM].ul_addr[CH_B],
672 (u32 *) &offset, 4);
673
674 writew(MDM_UL | DIAG_DL | MDM_DL, dc->reg_fcr);
675
676 DBG1("First phase done");
677 }
678
679 return 1;
680}
681
682/* Enable uplink interrupts */
683static void enable_transmit_ul(enum port_type port, struct nozomi *dc)
684{
685 static const u16 mask[] = {MDM_UL, DIAG_UL, APP1_UL, APP2_UL, CTRL_UL};
686
687 if (port < NOZOMI_MAX_PORTS) {
688 dc->last_ier |= mask[port];
689 writew(dc->last_ier, dc->reg_ier);
690 } else {
691 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
692 }
693}
694
695/* Disable uplink interrupts */
696static void disable_transmit_ul(enum port_type port, struct nozomi *dc)
697{
698 static const u16 mask[] =
699 {~MDM_UL, ~DIAG_UL, ~APP1_UL, ~APP2_UL, ~CTRL_UL};
700
701 if (port < NOZOMI_MAX_PORTS) {
702 dc->last_ier &= mask[port];
703 writew(dc->last_ier, dc->reg_ier);
704 } else {
705 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
706 }
707}
708
709/* Enable downlink interrupts */
710static void enable_transmit_dl(enum port_type port, struct nozomi *dc)
711{
712 static const u16 mask[] = {MDM_DL, DIAG_DL, APP1_DL, APP2_DL, CTRL_DL};
713
714 if (port < NOZOMI_MAX_PORTS) {
715 dc->last_ier |= mask[port];
716 writew(dc->last_ier, dc->reg_ier);
717 } else {
718 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
719 }
720}
721
722/* Disable downlink interrupts */
723static void disable_transmit_dl(enum port_type port, struct nozomi *dc)
724{
725 static const u16 mask[] =
726 {~MDM_DL, ~DIAG_DL, ~APP1_DL, ~APP2_DL, ~CTRL_DL};
727
728 if (port < NOZOMI_MAX_PORTS) {
729 dc->last_ier &= mask[port];
730 writew(dc->last_ier, dc->reg_ier);
731 } else {
732 dev_err(&dc->pdev->dev, "Called with wrong port?\n");
733 }
734}
735
736/*
737 * Return 1 - send buffer to card and ack.
738 * Return 0 - don't ack, don't send buffer to card.
739 */
740static int send_data(enum port_type index, struct nozomi *dc)
741{
742 u32 size = 0;
743 struct port *port = &dc->port[index];
744 const u8 toggle = port->toggle_ul;
745 void __iomem *addr = port->ul_addr[toggle];
746 const u32 ul_size = port->ul_size[toggle];
747
748 /* Get data from tty and place in buf for now */
749 size = kfifo_out(&port->fifo_ul, dc->send_buf,
750 ul_size < SEND_BUF_MAX ? ul_size : SEND_BUF_MAX);
751
752 if (size == 0) {
753 DBG4("No more data to send, disable link:");
754 return 0;
755 }
756
757 /* DUMP(buf, size); */
758
759 /* Write length + data */
760 write_mem32(addr, (u32 *) &size, 4);
761 write_mem32(addr + 4, (u32 *) dc->send_buf, size);
762
763 tty_port_tty_wakeup(&port->port);
764
765 return 1;
766}
767
768/* If all data has been read, return 1, else 0 */
769static int receive_data(enum port_type index, struct nozomi *dc)
770{
771 u8 buf[RECEIVE_BUF_MAX] = { 0 };
772 int size;
773 u32 offset = 4;
774 struct port *port = &dc->port[index];
775 void __iomem *addr = port->dl_addr[port->toggle_dl];
776 struct tty_struct *tty = tty_port_tty_get(&port->port);
777 int i, ret;
778
779 size = __le32_to_cpu(readl(addr));
780
781 if (tty && tty_throttled(tty)) {
782 DBG1("No room in tty, don't read data, don't ack interrupt, "
783 "disable interrupt");
784
785 /* disable interrupt in downlink... */
786 disable_transmit_dl(index, dc);
787 ret = 0;
788 goto put;
789 }
790
791 if (unlikely(size == 0)) {
792 dev_err(&dc->pdev->dev, "size == 0?\n");
793 ret = 1;
794 goto put;
795 }
796
797 while (size > 0) {
798 read_mem32((u32 *) buf, addr + offset, RECEIVE_BUF_MAX);
799
800 if (size == 1) {
801 tty_insert_flip_char(&port->port, buf[0], TTY_NORMAL);
802 size = 0;
803 } else if (size < RECEIVE_BUF_MAX) {
804 size -= tty_insert_flip_string(&port->port,
805 (char *)buf, size);
806 } else {
807 i = tty_insert_flip_string(&port->port,
808 (char *)buf, RECEIVE_BUF_MAX);
809 size -= i;
810 offset += i;
811 }
812 }
813
814 set_bit(index, &dc->flip);
815 ret = 1;
816put:
817 tty_kref_put(tty);
818 return ret;
819}
820
821/* Debug for interrupts */
822#ifdef DEBUG
823static char *interrupt2str(u16 interrupt)
824{
825 static char buf[TMP_BUF_MAX];
826 char *p = buf;
827
828 if (interrupt & MDM_DL1)
829 p += scnprintf(p, TMP_BUF_MAX, "MDM_DL1 ");
830 if (interrupt & MDM_DL2)
831 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "MDM_DL2 ");
832 if (interrupt & MDM_UL1)
833 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "MDM_UL1 ");
834 if (interrupt & MDM_UL2)
835 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "MDM_UL2 ");
836 if (interrupt & DIAG_DL1)
837 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "DIAG_DL1 ");
838 if (interrupt & DIAG_DL2)
839 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "DIAG_DL2 ");
840
841 if (interrupt & DIAG_UL)
842 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "DIAG_UL ");
843
844 if (interrupt & APP1_DL)
845 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP1_DL ");
846 if (interrupt & APP2_DL)
847 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP2_DL ");
848
849 if (interrupt & APP1_UL)
850 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP1_UL ");
851 if (interrupt & APP2_UL)
852 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP2_UL ");
853
854 if (interrupt & CTRL_DL)
855 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "CTRL_DL ");
856 if (interrupt & CTRL_UL)
857 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "CTRL_UL ");
858
859 if (interrupt & RESET)
860 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "RESET ");
861
862 return buf;
863}
864#endif
865
866/*
867 * Receive flow control
868 * Return 1 - If ok, else 0
869 */
870static int receive_flow_control(struct nozomi *dc)
871{
872 enum port_type port = PORT_MDM;
873 struct ctrl_dl ctrl_dl;
874 struct ctrl_dl old_ctrl;
875 u16 enable_ier = 0;
876
877 read_mem32((u32 *) &ctrl_dl, dc->port[PORT_CTRL].dl_addr[CH_A], 2);
878
879 switch (ctrl_dl.port) {
880 case CTRL_CMD:
881 DBG1("The Base Band sends this value as a response to a "
882 "request for IMSI detach sent over the control "
883 "channel uplink (see section 7.6.1).");
884 break;
885 case CTRL_MDM:
886 port = PORT_MDM;
887 enable_ier = MDM_DL;
888 break;
889 case CTRL_DIAG:
890 port = PORT_DIAG;
891 enable_ier = DIAG_DL;
892 break;
893 case CTRL_APP1:
894 port = PORT_APP1;
895 enable_ier = APP1_DL;
896 break;
897 case CTRL_APP2:
898 port = PORT_APP2;
899 enable_ier = APP2_DL;
900 if (dc->state == NOZOMI_STATE_ALLOCATED) {
901 /*
902 * After card initialization the flow control
903 * received for APP2 is always the last
904 */
905 dc->state = NOZOMI_STATE_READY;
906 dev_info(&dc->pdev->dev, "Device READY!\n");
907 }
908 break;
909 default:
910 dev_err(&dc->pdev->dev,
911 "ERROR: flow control received for non-existing port\n");
912 return 0;
913 }
914
915 DBG1("0x%04X->0x%04X", *((u16 *)&dc->port[port].ctrl_dl),
916 *((u16 *)&ctrl_dl));
917
918 old_ctrl = dc->port[port].ctrl_dl;
919 dc->port[port].ctrl_dl = ctrl_dl;
920
921 if (old_ctrl.CTS == 1 && ctrl_dl.CTS == 0) {
922 DBG1("Disable interrupt (0x%04X) on port: %d",
923 enable_ier, port);
924 disable_transmit_ul(port, dc);
925
926 } else if (old_ctrl.CTS == 0 && ctrl_dl.CTS == 1) {
927
928 if (kfifo_len(&dc->port[port].fifo_ul)) {
929 DBG1("Enable interrupt (0x%04X) on port: %d",
930 enable_ier, port);
931 DBG1("Data in buffer [%d], enable transmit! ",
932 kfifo_len(&dc->port[port].fifo_ul));
933 enable_transmit_ul(port, dc);
934 } else {
935 DBG1("No data in buffer...");
936 }
937 }
938
939 if (*(u16 *)&old_ctrl == *(u16 *)&ctrl_dl) {
940 DBG1(" No change in mctrl");
941 return 1;
942 }
943 /* Update statistics */
944 if (old_ctrl.CTS != ctrl_dl.CTS)
945 dc->port[port].tty_icount.cts++;
946 if (old_ctrl.DSR != ctrl_dl.DSR)
947 dc->port[port].tty_icount.dsr++;
948 if (old_ctrl.RI != ctrl_dl.RI)
949 dc->port[port].tty_icount.rng++;
950 if (old_ctrl.DCD != ctrl_dl.DCD)
951 dc->port[port].tty_icount.dcd++;
952
953 wake_up_interruptible(&dc->port[port].tty_wait);
954
955 DBG1("port: %d DCD(%d), CTS(%d), RI(%d), DSR(%d)",
956 port,
957 dc->port[port].tty_icount.dcd, dc->port[port].tty_icount.cts,
958 dc->port[port].tty_icount.rng, dc->port[port].tty_icount.dsr);
959
960 return 1;
961}
962
963static enum ctrl_port_type port2ctrl(enum port_type port,
964 const struct nozomi *dc)
965{
966 switch (port) {
967 case PORT_MDM:
968 return CTRL_MDM;
969 case PORT_DIAG:
970 return CTRL_DIAG;
971 case PORT_APP1:
972 return CTRL_APP1;
973 case PORT_APP2:
974 return CTRL_APP2;
975 default:
976 dev_err(&dc->pdev->dev,
977 "ERROR: send flow control " \
978 "received for non-existing port\n");
979 }
980 return CTRL_ERROR;
981}
982
983/*
984 * Send flow control, can only update one channel at a time
985 * Return 0 - If we have updated all flow control
986 * Return 1 - If we need to update more flow control, ack current enable more
987 */
988static int send_flow_control(struct nozomi *dc)
989{
990 u32 i, more_flow_control_to_be_updated = 0;
991 u16 *ctrl;
992
993 for (i = PORT_MDM; i < MAX_PORT; i++) {
994 if (dc->port[i].update_flow_control) {
995 if (more_flow_control_to_be_updated) {
996 /* We have more flow control to be updated */
997 return 1;
998 }
999 dc->port[i].ctrl_ul.port = port2ctrl(i, dc);
1000 ctrl = (u16 *)&dc->port[i].ctrl_ul;
1001 write_mem32(dc->port[PORT_CTRL].ul_addr[0], \
1002 (u32 *) ctrl, 2);
1003 dc->port[i].update_flow_control = 0;
1004 more_flow_control_to_be_updated = 1;
1005 }
1006 }
1007 return 0;
1008}
1009
1010/*
1011 * Handle downlink data, ports that are handled are modem and diagnostics
1012 * Return 1 - ok
1013 * Return 0 - toggle fields are out of sync
1014 */
1015static int handle_data_dl(struct nozomi *dc, enum port_type port, u8 *toggle,
1016 u16 read_iir, u16 mask1, u16 mask2)
1017{
1018 if (*toggle == 0 && read_iir & mask1) {
1019 if (receive_data(port, dc)) {
1020 writew(mask1, dc->reg_fcr);
1021 *toggle = !(*toggle);
1022 }
1023
1024 if (read_iir & mask2) {
1025 if (receive_data(port, dc)) {
1026 writew(mask2, dc->reg_fcr);
1027 *toggle = !(*toggle);
1028 }
1029 }
1030 } else if (*toggle == 1 && read_iir & mask2) {
1031 if (receive_data(port, dc)) {
1032 writew(mask2, dc->reg_fcr);
1033 *toggle = !(*toggle);
1034 }
1035
1036 if (read_iir & mask1) {
1037 if (receive_data(port, dc)) {
1038 writew(mask1, dc->reg_fcr);
1039 *toggle = !(*toggle);
1040 }
1041 }
1042 } else {
1043 dev_err(&dc->pdev->dev, "port out of sync!, toggle:%d\n",
1044 *toggle);
1045 return 0;
1046 }
1047 return 1;
1048}
1049
1050/*
1051 * Handle uplink data, this is currently for the modem port
1052 * Return 1 - ok
1053 * Return 0 - toggle field are out of sync
1054 */
1055static int handle_data_ul(struct nozomi *dc, enum port_type port, u16 read_iir)
1056{
1057 u8 *toggle = &(dc->port[port].toggle_ul);
1058
1059 if (*toggle == 0 && read_iir & MDM_UL1) {
1060 dc->last_ier &= ~MDM_UL;
1061 writew(dc->last_ier, dc->reg_ier);
1062 if (send_data(port, dc)) {
1063 writew(MDM_UL1, dc->reg_fcr);
1064 dc->last_ier = dc->last_ier | MDM_UL;
1065 writew(dc->last_ier, dc->reg_ier);
1066 *toggle = !*toggle;
1067 }
1068
1069 if (read_iir & MDM_UL2) {
1070 dc->last_ier &= ~MDM_UL;
1071 writew(dc->last_ier, dc->reg_ier);
1072 if (send_data(port, dc)) {
1073 writew(MDM_UL2, dc->reg_fcr);
1074 dc->last_ier = dc->last_ier | MDM_UL;
1075 writew(dc->last_ier, dc->reg_ier);
1076 *toggle = !*toggle;
1077 }
1078 }
1079
1080 } else if (*toggle == 1 && read_iir & MDM_UL2) {
1081 dc->last_ier &= ~MDM_UL;
1082 writew(dc->last_ier, dc->reg_ier);
1083 if (send_data(port, dc)) {
1084 writew(MDM_UL2, dc->reg_fcr);
1085 dc->last_ier = dc->last_ier | MDM_UL;
1086 writew(dc->last_ier, dc->reg_ier);
1087 *toggle = !*toggle;
1088 }
1089
1090 if (read_iir & MDM_UL1) {
1091 dc->last_ier &= ~MDM_UL;
1092 writew(dc->last_ier, dc->reg_ier);
1093 if (send_data(port, dc)) {
1094 writew(MDM_UL1, dc->reg_fcr);
1095 dc->last_ier = dc->last_ier | MDM_UL;
1096 writew(dc->last_ier, dc->reg_ier);
1097 *toggle = !*toggle;
1098 }
1099 }
1100 } else {
1101 writew(read_iir & MDM_UL, dc->reg_fcr);
1102 dev_err(&dc->pdev->dev, "port out of sync!\n");
1103 return 0;
1104 }
1105 return 1;
1106}
1107
1108static irqreturn_t interrupt_handler(int irq, void *dev_id)
1109{
1110 struct nozomi *dc = dev_id;
1111 unsigned int a;
1112 u16 read_iir;
1113
1114 if (!dc)
1115 return IRQ_NONE;
1116
1117 spin_lock(&dc->spin_mutex);
1118 read_iir = readw(dc->reg_iir);
1119
1120 /* Card removed */
1121 if (read_iir == (u16)-1)
1122 goto none;
1123 /*
1124 * Just handle interrupt enabled in IER
1125 * (by masking with dc->last_ier)
1126 */
1127 read_iir &= dc->last_ier;
1128
1129 if (read_iir == 0)
1130 goto none;
1131
1132
1133 DBG4("%s irq:0x%04X, prev:0x%04X", interrupt2str(read_iir), read_iir,
1134 dc->last_ier);
1135
1136 if (read_iir & RESET) {
1137 if (unlikely(!nozomi_read_config_table(dc))) {
1138 dc->last_ier = 0x0;
1139 writew(dc->last_ier, dc->reg_ier);
1140 dev_err(&dc->pdev->dev, "Could not read status from "
1141 "card, we should disable interface\n");
1142 } else {
1143 writew(RESET, dc->reg_fcr);
1144 }
1145 /* No more useful info if this was the reset interrupt. */
1146 goto exit_handler;
1147 }
1148 if (read_iir & CTRL_UL) {
1149 DBG1("CTRL_UL");
1150 dc->last_ier &= ~CTRL_UL;
1151 writew(dc->last_ier, dc->reg_ier);
1152 if (send_flow_control(dc)) {
1153 writew(CTRL_UL, dc->reg_fcr);
1154 dc->last_ier = dc->last_ier | CTRL_UL;
1155 writew(dc->last_ier, dc->reg_ier);
1156 }
1157 }
1158 if (read_iir & CTRL_DL) {
1159 receive_flow_control(dc);
1160 writew(CTRL_DL, dc->reg_fcr);
1161 }
1162 if (read_iir & MDM_DL) {
1163 if (!handle_data_dl(dc, PORT_MDM,
1164 &(dc->port[PORT_MDM].toggle_dl), read_iir,
1165 MDM_DL1, MDM_DL2)) {
1166 dev_err(&dc->pdev->dev, "MDM_DL out of sync!\n");
1167 goto exit_handler;
1168 }
1169 }
1170 if (read_iir & MDM_UL) {
1171 if (!handle_data_ul(dc, PORT_MDM, read_iir)) {
1172 dev_err(&dc->pdev->dev, "MDM_UL out of sync!\n");
1173 goto exit_handler;
1174 }
1175 }
1176 if (read_iir & DIAG_DL) {
1177 if (!handle_data_dl(dc, PORT_DIAG,
1178 &(dc->port[PORT_DIAG].toggle_dl), read_iir,
1179 DIAG_DL1, DIAG_DL2)) {
1180 dev_err(&dc->pdev->dev, "DIAG_DL out of sync!\n");
1181 goto exit_handler;
1182 }
1183 }
1184 if (read_iir & DIAG_UL) {
1185 dc->last_ier &= ~DIAG_UL;
1186 writew(dc->last_ier, dc->reg_ier);
1187 if (send_data(PORT_DIAG, dc)) {
1188 writew(DIAG_UL, dc->reg_fcr);
1189 dc->last_ier = dc->last_ier | DIAG_UL;
1190 writew(dc->last_ier, dc->reg_ier);
1191 }
1192 }
1193 if (read_iir & APP1_DL) {
1194 if (receive_data(PORT_APP1, dc))
1195 writew(APP1_DL, dc->reg_fcr);
1196 }
1197 if (read_iir & APP1_UL) {
1198 dc->last_ier &= ~APP1_UL;
1199 writew(dc->last_ier, dc->reg_ier);
1200 if (send_data(PORT_APP1, dc)) {
1201 writew(APP1_UL, dc->reg_fcr);
1202 dc->last_ier = dc->last_ier | APP1_UL;
1203 writew(dc->last_ier, dc->reg_ier);
1204 }
1205 }
1206 if (read_iir & APP2_DL) {
1207 if (receive_data(PORT_APP2, dc))
1208 writew(APP2_DL, dc->reg_fcr);
1209 }
1210 if (read_iir & APP2_UL) {
1211 dc->last_ier &= ~APP2_UL;
1212 writew(dc->last_ier, dc->reg_ier);
1213 if (send_data(PORT_APP2, dc)) {
1214 writew(APP2_UL, dc->reg_fcr);
1215 dc->last_ier = dc->last_ier | APP2_UL;
1216 writew(dc->last_ier, dc->reg_ier);
1217 }
1218 }
1219
1220exit_handler:
1221 spin_unlock(&dc->spin_mutex);
1222
1223 for (a = 0; a < NOZOMI_MAX_PORTS; a++)
1224 if (test_and_clear_bit(a, &dc->flip))
1225 tty_flip_buffer_push(&dc->port[a].port);
1226
1227 return IRQ_HANDLED;
1228none:
1229 spin_unlock(&dc->spin_mutex);
1230 return IRQ_NONE;
1231}
1232
1233static void nozomi_get_card_type(struct nozomi *dc)
1234{
1235 int i;
1236 u32 size = 0;
1237
1238 for (i = 0; i < 6; i++)
1239 size += pci_resource_len(dc->pdev, i);
1240
1241 /* Assume card type F32_8 if no match */
1242 dc->card_type = size == 2048 ? F32_2 : F32_8;
1243
1244 dev_info(&dc->pdev->dev, "Card type is: %d\n", dc->card_type);
1245}
1246
1247static void nozomi_setup_private_data(struct nozomi *dc)
1248{
1249 void __iomem *offset = dc->base_addr + dc->card_type / 2;
1250 unsigned int i;
1251
1252 dc->reg_fcr = (void __iomem *)(offset + R_FCR);
1253 dc->reg_iir = (void __iomem *)(offset + R_IIR);
1254 dc->reg_ier = (void __iomem *)(offset + R_IER);
1255 dc->last_ier = 0;
1256 dc->flip = 0;
1257
1258 dc->port[PORT_MDM].token_dl = MDM_DL;
1259 dc->port[PORT_DIAG].token_dl = DIAG_DL;
1260 dc->port[PORT_APP1].token_dl = APP1_DL;
1261 dc->port[PORT_APP2].token_dl = APP2_DL;
1262
1263 for (i = 0; i < MAX_PORT; i++)
1264 init_waitqueue_head(&dc->port[i].tty_wait);
1265}
1266
1267static ssize_t card_type_show(struct device *dev, struct device_attribute *attr,
1268 char *buf)
1269{
1270 const struct nozomi *dc = dev_get_drvdata(dev);
1271
1272 return sprintf(buf, "%d\n", dc->card_type);
1273}
1274static DEVICE_ATTR_RO(card_type);
1275
1276static ssize_t open_ttys_show(struct device *dev, struct device_attribute *attr,
1277 char *buf)
1278{
1279 const struct nozomi *dc = dev_get_drvdata(dev);
1280
1281 return sprintf(buf, "%u\n", dc->open_ttys);
1282}
1283static DEVICE_ATTR_RO(open_ttys);
1284
1285static void make_sysfs_files(struct nozomi *dc)
1286{
1287 if (device_create_file(&dc->pdev->dev, &dev_attr_card_type))
1288 dev_err(&dc->pdev->dev,
1289 "Could not create sysfs file for card_type\n");
1290 if (device_create_file(&dc->pdev->dev, &dev_attr_open_ttys))
1291 dev_err(&dc->pdev->dev,
1292 "Could not create sysfs file for open_ttys\n");
1293}
1294
1295static void remove_sysfs_files(struct nozomi *dc)
1296{
1297 device_remove_file(&dc->pdev->dev, &dev_attr_card_type);
1298 device_remove_file(&dc->pdev->dev, &dev_attr_open_ttys);
1299}
1300
1301/* Allocate memory for one device */
1302static int nozomi_card_init(struct pci_dev *pdev,
1303 const struct pci_device_id *ent)
1304{
1305 int ret;
1306 struct nozomi *dc = NULL;
1307 int ndev_idx;
1308 int i;
1309
1310 for (ndev_idx = 0; ndev_idx < ARRAY_SIZE(ndevs); ndev_idx++)
1311 if (!ndevs[ndev_idx])
1312 break;
1313
1314 if (ndev_idx >= ARRAY_SIZE(ndevs)) {
1315 dev_err(&pdev->dev, "no free tty range for this card left\n");
1316 ret = -EIO;
1317 goto err;
1318 }
1319
1320 dc = kzalloc(sizeof(struct nozomi), GFP_KERNEL);
1321 if (unlikely(!dc)) {
1322 dev_err(&pdev->dev, "Could not allocate memory\n");
1323 ret = -ENOMEM;
1324 goto err_free;
1325 }
1326
1327 dc->pdev = pdev;
1328
1329 ret = pci_enable_device(dc->pdev);
1330 if (ret) {
1331 dev_err(&pdev->dev, "Failed to enable PCI Device\n");
1332 goto err_free;
1333 }
1334
1335 ret = pci_request_regions(dc->pdev, NOZOMI_NAME);
1336 if (ret) {
1337 dev_err(&pdev->dev, "I/O address 0x%04x already in use\n",
1338 (int) /* nozomi_private.io_addr */ 0);
1339 goto err_disable_device;
1340 }
1341
1342 /* Find out what card type it is */
1343 nozomi_get_card_type(dc);
1344
1345 dc->base_addr = pci_iomap(dc->pdev, 0, dc->card_type);
1346 if (!dc->base_addr) {
1347 dev_err(&pdev->dev, "Unable to map card MMIO\n");
1348 ret = -ENODEV;
1349 goto err_rel_regs;
1350 }
1351
1352 dc->send_buf = kmalloc(SEND_BUF_MAX, GFP_KERNEL);
1353 if (!dc->send_buf) {
1354 dev_err(&pdev->dev, "Could not allocate send buffer?\n");
1355 ret = -ENOMEM;
1356 goto err_free_sbuf;
1357 }
1358
1359 for (i = PORT_MDM; i < MAX_PORT; i++) {
1360 if (kfifo_alloc(&dc->port[i].fifo_ul, FIFO_BUFFER_SIZE_UL,
1361 GFP_KERNEL)) {
1362 dev_err(&pdev->dev,
1363 "Could not allocate kfifo buffer\n");
1364 ret = -ENOMEM;
1365 goto err_free_kfifo;
1366 }
1367 }
1368
1369 spin_lock_init(&dc->spin_mutex);
1370
1371 nozomi_setup_private_data(dc);
1372
1373 /* Disable all interrupts */
1374 dc->last_ier = 0;
1375 writew(dc->last_ier, dc->reg_ier);
1376
1377 ret = request_irq(pdev->irq, &interrupt_handler, IRQF_SHARED,
1378 NOZOMI_NAME, dc);
1379 if (unlikely(ret)) {
1380 dev_err(&pdev->dev, "can't request irq %d\n", pdev->irq);
1381 goto err_free_all_kfifo;
1382 }
1383
1384 DBG1("base_addr: %p", dc->base_addr);
1385
1386 make_sysfs_files(dc);
1387
1388 dc->index_start = ndev_idx * MAX_PORT;
1389 ndevs[ndev_idx] = dc;
1390
1391 pci_set_drvdata(pdev, dc);
1392
1393 /* Enable RESET interrupt */
1394 dc->last_ier = RESET;
1395 iowrite16(dc->last_ier, dc->reg_ier);
1396
1397 dc->state = NOZOMI_STATE_ENABLED;
1398
1399 for (i = 0; i < MAX_PORT; i++) {
1400 struct device *tty_dev;
1401 struct port *port = &dc->port[i];
1402 port->dc = dc;
1403 tty_port_init(&port->port);
1404 port->port.ops = &noz_tty_port_ops;
1405 tty_dev = tty_port_register_device(&port->port, ntty_driver,
1406 dc->index_start + i, &pdev->dev);
1407
1408 if (IS_ERR(tty_dev)) {
1409 ret = PTR_ERR(tty_dev);
1410 dev_err(&pdev->dev, "Could not allocate tty?\n");
1411 tty_port_destroy(&port->port);
1412 goto err_free_tty;
1413 }
1414 }
1415
1416 return 0;
1417
1418err_free_tty:
1419 for (i--; i >= 0; i--) {
1420 tty_unregister_device(ntty_driver, dc->index_start + i);
1421 tty_port_destroy(&dc->port[i].port);
1422 }
1423 free_irq(pdev->irq, dc);
1424err_free_all_kfifo:
1425 i = MAX_PORT;
1426err_free_kfifo:
1427 for (i--; i >= PORT_MDM; i--)
1428 kfifo_free(&dc->port[i].fifo_ul);
1429err_free_sbuf:
1430 kfree(dc->send_buf);
1431 iounmap(dc->base_addr);
1432err_rel_regs:
1433 pci_release_regions(pdev);
1434err_disable_device:
1435 pci_disable_device(pdev);
1436err_free:
1437 kfree(dc);
1438err:
1439 return ret;
1440}
1441
1442static void tty_exit(struct nozomi *dc)
1443{
1444 unsigned int i;
1445
1446 for (i = 0; i < MAX_PORT; ++i)
1447 tty_port_tty_hangup(&dc->port[i].port, false);
1448
1449 /* Racy below - surely should wait for scheduled work to be done or
1450 complete off a hangup method ? */
1451 while (dc->open_ttys)
1452 msleep(1);
1453 for (i = 0; i < MAX_PORT; ++i) {
1454 tty_unregister_device(ntty_driver, dc->index_start + i);
1455 tty_port_destroy(&dc->port[i].port);
1456 }
1457}
1458
1459/* Deallocate memory for one device */
1460static void nozomi_card_exit(struct pci_dev *pdev)
1461{
1462 int i;
1463 struct ctrl_ul ctrl;
1464 struct nozomi *dc = pci_get_drvdata(pdev);
1465
1466 /* Disable all interrupts */
1467 dc->last_ier = 0;
1468 writew(dc->last_ier, dc->reg_ier);
1469
1470 tty_exit(dc);
1471
1472 /* Send 0x0001, command card to resend the reset token. */
1473 /* This is to get the reset when the module is reloaded. */
1474 ctrl.port = 0x00;
1475 ctrl.reserved = 0;
1476 ctrl.RTS = 0;
1477 ctrl.DTR = 1;
1478 DBG1("sending flow control 0x%04X", *((u16 *)&ctrl));
1479
1480 /* Setup dc->reg addresses to we can use defines here */
1481 write_mem32(dc->port[PORT_CTRL].ul_addr[0], (u32 *)&ctrl, 2);
1482 writew(CTRL_UL, dc->reg_fcr); /* push the token to the card. */
1483
1484 remove_sysfs_files(dc);
1485
1486 free_irq(pdev->irq, dc);
1487
1488 for (i = 0; i < MAX_PORT; i++)
1489 kfifo_free(&dc->port[i].fifo_ul);
1490
1491 kfree(dc->send_buf);
1492
1493 iounmap(dc->base_addr);
1494
1495 pci_release_regions(pdev);
1496
1497 pci_disable_device(pdev);
1498
1499 ndevs[dc->index_start / MAX_PORT] = NULL;
1500
1501 kfree(dc);
1502}
1503
1504static void set_rts(const struct tty_struct *tty, int rts)
1505{
1506 struct port *port = get_port_by_tty(tty);
1507
1508 port->ctrl_ul.RTS = rts;
1509 port->update_flow_control = 1;
1510 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1511}
1512
1513static void set_dtr(const struct tty_struct *tty, int dtr)
1514{
1515 struct port *port = get_port_by_tty(tty);
1516
1517 DBG1("SETTING DTR index: %d, dtr: %d", tty->index, dtr);
1518
1519 port->ctrl_ul.DTR = dtr;
1520 port->update_flow_control = 1;
1521 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1522}
1523
1524/*
1525 * ----------------------------------------------------------------------------
1526 * TTY code
1527 * ----------------------------------------------------------------------------
1528 */
1529
1530static int ntty_install(struct tty_driver *driver, struct tty_struct *tty)
1531{
1532 struct port *port = get_port_by_tty(tty);
1533 struct nozomi *dc = get_dc_by_tty(tty);
1534 int ret;
1535 if (!port || !dc || dc->state != NOZOMI_STATE_READY)
1536 return -ENODEV;
1537 ret = tty_standard_install(driver, tty);
1538 if (ret == 0)
1539 tty->driver_data = port;
1540 return ret;
1541}
1542
1543static void ntty_cleanup(struct tty_struct *tty)
1544{
1545 tty->driver_data = NULL;
1546}
1547
1548static int ntty_activate(struct tty_port *tport, struct tty_struct *tty)
1549{
1550 struct port *port = container_of(tport, struct port, port);
1551 struct nozomi *dc = port->dc;
1552 unsigned long flags;
1553
1554 DBG1("open: %d", port->token_dl);
1555 spin_lock_irqsave(&dc->spin_mutex, flags);
1556 dc->last_ier = dc->last_ier | port->token_dl;
1557 writew(dc->last_ier, dc->reg_ier);
1558 dc->open_ttys++;
1559 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1560 printk("noz: activated %d: %p\n", tty->index, tport);
1561 return 0;
1562}
1563
1564static int ntty_open(struct tty_struct *tty, struct file *filp)
1565{
1566 struct port *port = tty->driver_data;
1567 return tty_port_open(&port->port, tty, filp);
1568}
1569
1570static void ntty_shutdown(struct tty_port *tport)
1571{
1572 struct port *port = container_of(tport, struct port, port);
1573 struct nozomi *dc = port->dc;
1574 unsigned long flags;
1575
1576 DBG1("close: %d", port->token_dl);
1577 spin_lock_irqsave(&dc->spin_mutex, flags);
1578 dc->last_ier &= ~(port->token_dl);
1579 writew(dc->last_ier, dc->reg_ier);
1580 dc->open_ttys--;
1581 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1582 printk("noz: shutdown %p\n", tport);
1583}
1584
1585static void ntty_close(struct tty_struct *tty, struct file *filp)
1586{
1587 struct port *port = tty->driver_data;
1588 if (port)
1589 tty_port_close(&port->port, tty, filp);
1590}
1591
1592static void ntty_hangup(struct tty_struct *tty)
1593{
1594 struct port *port = tty->driver_data;
1595 tty_port_hangup(&port->port);
1596}
1597
1598/*
1599 * called when the userspace process writes to the tty (/dev/noz*).
1600 * Data is inserted into a fifo, which is then read and transferred to the modem.
1601 */
1602static int ntty_write(struct tty_struct *tty, const unsigned char *buffer,
1603 int count)
1604{
1605 int rval = -EINVAL;
1606 struct nozomi *dc = get_dc_by_tty(tty);
1607 struct port *port = tty->driver_data;
1608 unsigned long flags;
1609
1610 if (!dc || !port)
1611 return -ENODEV;
1612
1613 rval = kfifo_in(&port->fifo_ul, (unsigned char *)buffer, count);
1614
1615 spin_lock_irqsave(&dc->spin_mutex, flags);
1616 /* CTS is only valid on the modem channel */
1617 if (port == &(dc->port[PORT_MDM])) {
1618 if (port->ctrl_dl.CTS) {
1619 DBG4("Enable interrupt");
1620 enable_transmit_ul(tty->index % MAX_PORT, dc);
1621 } else {
1622 dev_err(&dc->pdev->dev,
1623 "CTS not active on modem port?\n");
1624 }
1625 } else {
1626 enable_transmit_ul(tty->index % MAX_PORT, dc);
1627 }
1628 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1629
1630 return rval;
1631}
1632
1633/*
1634 * Calculate how much is left in device
1635 * This method is called by the upper tty layer.
1636 * #according to sources N_TTY.c it expects a value >= 0 and
1637 * does not check for negative values.
1638 *
1639 * If the port is unplugged report lots of room and let the bits
1640 * dribble away so we don't block anything.
1641 */
1642static unsigned int ntty_write_room(struct tty_struct *tty)
1643{
1644 struct port *port = tty->driver_data;
1645 unsigned int room = 4096;
1646 const struct nozomi *dc = get_dc_by_tty(tty);
1647
1648 if (dc)
1649 room = kfifo_avail(&port->fifo_ul);
1650
1651 return room;
1652}
1653
1654/* Gets io control parameters */
1655static int ntty_tiocmget(struct tty_struct *tty)
1656{
1657 const struct port *port = tty->driver_data;
1658 const struct ctrl_dl *ctrl_dl = &port->ctrl_dl;
1659 const struct ctrl_ul *ctrl_ul = &port->ctrl_ul;
1660
1661 /* Note: these could change under us but it is not clear this
1662 matters if so */
1663 return (ctrl_ul->RTS ? TIOCM_RTS : 0)
1664 | (ctrl_ul->DTR ? TIOCM_DTR : 0)
1665 | (ctrl_dl->DCD ? TIOCM_CAR : 0)
1666 | (ctrl_dl->RI ? TIOCM_RNG : 0)
1667 | (ctrl_dl->DSR ? TIOCM_DSR : 0)
1668 | (ctrl_dl->CTS ? TIOCM_CTS : 0);
1669}
1670
1671/* Sets io controls parameters */
1672static int ntty_tiocmset(struct tty_struct *tty,
1673 unsigned int set, unsigned int clear)
1674{
1675 struct nozomi *dc = get_dc_by_tty(tty);
1676 unsigned long flags;
1677
1678 spin_lock_irqsave(&dc->spin_mutex, flags);
1679 if (set & TIOCM_RTS)
1680 set_rts(tty, 1);
1681 else if (clear & TIOCM_RTS)
1682 set_rts(tty, 0);
1683
1684 if (set & TIOCM_DTR)
1685 set_dtr(tty, 1);
1686 else if (clear & TIOCM_DTR)
1687 set_dtr(tty, 0);
1688 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1689
1690 return 0;
1691}
1692
1693static int ntty_cflags_changed(struct port *port, unsigned long flags,
1694 struct async_icount *cprev)
1695{
1696 const struct async_icount cnow = port->tty_icount;
1697 int ret;
1698
1699 ret = ((flags & TIOCM_RNG) && (cnow.rng != cprev->rng))
1700 || ((flags & TIOCM_DSR) && (cnow.dsr != cprev->dsr))
1701 || ((flags & TIOCM_CD) && (cnow.dcd != cprev->dcd))
1702 || ((flags & TIOCM_CTS) && (cnow.cts != cprev->cts));
1703
1704 *cprev = cnow;
1705
1706 return ret;
1707}
1708
1709static int ntty_tiocgicount(struct tty_struct *tty,
1710 struct serial_icounter_struct *icount)
1711{
1712 struct port *port = tty->driver_data;
1713 const struct async_icount cnow = port->tty_icount;
1714
1715 icount->cts = cnow.cts;
1716 icount->dsr = cnow.dsr;
1717 icount->rng = cnow.rng;
1718 icount->dcd = cnow.dcd;
1719 icount->rx = cnow.rx;
1720 icount->tx = cnow.tx;
1721 icount->frame = cnow.frame;
1722 icount->overrun = cnow.overrun;
1723 icount->parity = cnow.parity;
1724 icount->brk = cnow.brk;
1725 icount->buf_overrun = cnow.buf_overrun;
1726 return 0;
1727}
1728
1729static int ntty_ioctl(struct tty_struct *tty,
1730 unsigned int cmd, unsigned long arg)
1731{
1732 struct port *port = tty->driver_data;
1733 int rval = -ENOIOCTLCMD;
1734
1735 switch (cmd) {
1736 case TIOCMIWAIT: {
1737 struct async_icount cprev = port->tty_icount;
1738
1739 rval = wait_event_interruptible(port->tty_wait,
1740 ntty_cflags_changed(port, arg, &cprev));
1741 break;
1742 }
1743 default:
1744 DBG1("ERR: 0x%08X, %d", cmd, cmd);
1745 break;
1746 }
1747
1748 return rval;
1749}
1750
1751/*
1752 * Called by the upper tty layer when tty buffers are ready
1753 * to receive data again after a call to throttle.
1754 */
1755static void ntty_unthrottle(struct tty_struct *tty)
1756{
1757 struct nozomi *dc = get_dc_by_tty(tty);
1758 unsigned long flags;
1759
1760 spin_lock_irqsave(&dc->spin_mutex, flags);
1761 enable_transmit_dl(tty->index % MAX_PORT, dc);
1762 set_rts(tty, 1);
1763
1764 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1765}
1766
1767/*
1768 * Called by the upper tty layer when the tty buffers are almost full.
1769 * The driver should stop send more data.
1770 */
1771static void ntty_throttle(struct tty_struct *tty)
1772{
1773 struct nozomi *dc = get_dc_by_tty(tty);
1774 unsigned long flags;
1775
1776 spin_lock_irqsave(&dc->spin_mutex, flags);
1777 set_rts(tty, 0);
1778 spin_unlock_irqrestore(&dc->spin_mutex, flags);
1779}
1780
1781/* Returns number of chars in buffer, called by tty layer */
1782static unsigned int ntty_chars_in_buffer(struct tty_struct *tty)
1783{
1784 struct port *port = tty->driver_data;
1785 struct nozomi *dc = get_dc_by_tty(tty);
1786
1787 if (unlikely(!dc || !port))
1788 return 0;
1789
1790 return kfifo_len(&port->fifo_ul);
1791}
1792
1793static const struct tty_port_operations noz_tty_port_ops = {
1794 .activate = ntty_activate,
1795 .shutdown = ntty_shutdown,
1796};
1797
1798static const struct tty_operations tty_ops = {
1799 .ioctl = ntty_ioctl,
1800 .open = ntty_open,
1801 .close = ntty_close,
1802 .hangup = ntty_hangup,
1803 .write = ntty_write,
1804 .write_room = ntty_write_room,
1805 .unthrottle = ntty_unthrottle,
1806 .throttle = ntty_throttle,
1807 .chars_in_buffer = ntty_chars_in_buffer,
1808 .tiocmget = ntty_tiocmget,
1809 .tiocmset = ntty_tiocmset,
1810 .get_icount = ntty_tiocgicount,
1811 .install = ntty_install,
1812 .cleanup = ntty_cleanup,
1813};
1814
1815/* Module initialization */
1816static struct pci_driver nozomi_driver = {
1817 .name = NOZOMI_NAME,
1818 .id_table = nozomi_pci_tbl,
1819 .probe = nozomi_card_init,
1820 .remove = nozomi_card_exit,
1821};
1822
1823static __init int nozomi_init(void)
1824{
1825 int ret;
1826
1827 ntty_driver = tty_alloc_driver(NTTY_TTY_MAXMINORS, TTY_DRIVER_REAL_RAW |
1828 TTY_DRIVER_DYNAMIC_DEV);
1829 if (IS_ERR(ntty_driver))
1830 return PTR_ERR(ntty_driver);
1831
1832 ntty_driver->driver_name = NOZOMI_NAME_TTY;
1833 ntty_driver->name = "noz";
1834 ntty_driver->major = 0;
1835 ntty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1836 ntty_driver->subtype = SERIAL_TYPE_NORMAL;
1837 ntty_driver->init_termios = tty_std_termios;
1838 ntty_driver->init_termios.c_cflag = B115200 | CS8 | CREAD | \
1839 HUPCL | CLOCAL;
1840 ntty_driver->init_termios.c_ispeed = 115200;
1841 ntty_driver->init_termios.c_ospeed = 115200;
1842 tty_set_operations(ntty_driver, &tty_ops);
1843
1844 ret = tty_register_driver(ntty_driver);
1845 if (ret) {
1846 printk(KERN_ERR "Nozomi: failed to register ntty driver\n");
1847 goto free_tty;
1848 }
1849
1850 ret = pci_register_driver(&nozomi_driver);
1851 if (ret) {
1852 printk(KERN_ERR "Nozomi: can't register pci driver\n");
1853 goto unr_tty;
1854 }
1855
1856 return 0;
1857unr_tty:
1858 tty_unregister_driver(ntty_driver);
1859free_tty:
1860 tty_driver_kref_put(ntty_driver);
1861 return ret;
1862}
1863
1864static __exit void nozomi_exit(void)
1865{
1866 pci_unregister_driver(&nozomi_driver);
1867 tty_unregister_driver(ntty_driver);
1868 tty_driver_kref_put(ntty_driver);
1869}
1870
1871module_init(nozomi_init);
1872module_exit(nozomi_exit);
1873
1874MODULE_LICENSE("Dual BSD/GPL");
1875MODULE_DESCRIPTION("Nozomi driver");