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[] = {
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 nozomi_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		nozomi_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		nozomi_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
795	/* Get data from tty and place in buf for now */
796	size = kfifo_out(&port->fifo_ul, dc->send_buf,
797			   ul_size < SEND_BUF_MAX ? ul_size : SEND_BUF_MAX);
798
799	if (size == 0) {
800		DBG4("No more data to send, disable link:");
801		return 0;
802	}
803
804	/* DUMP(buf, size); */
805
806	/* Write length + data */
807	write_mem32(addr, (u32 *) &size, 4);
808	write_mem32(addr + 4, (u32 *) dc->send_buf, size);
809
810	tty_port_tty_wakeup(&port->port);
811
812	return 1;
813}
814
815/* If all data has been read, return 1, else 0 */
816static int receive_data(enum port_type index, struct nozomi *dc)
817{
818	u8 buf[RECEIVE_BUF_MAX] = { 0 };
819	int size;
820	u32 offset = 4;
821	struct port *port = &dc->port[index];
822	void __iomem *addr = port->dl_addr[port->toggle_dl];
823	struct tty_struct *tty = tty_port_tty_get(&port->port);
824	int i, ret;
825
826	read_mem32((u32 *) &size, addr, 4);
827	/*  DBG1( "%d bytes port: %d", size, index); */
828
829	if (tty && test_bit(TTY_THROTTLED, &tty->flags)) {
830		DBG1("No room in tty, don't read data, don't ack interrupt, "
831			"disable interrupt");
832
833		/* disable interrupt in downlink... */
834		disable_transmit_dl(index, dc);
835		ret = 0;
836		goto put;
837	}
838
839	if (unlikely(size == 0)) {
840		dev_err(&dc->pdev->dev, "size == 0?\n");
841		ret = 1;
842		goto put;
843	}
844
845	while (size > 0) {
846		read_mem32((u32 *) buf, addr + offset, RECEIVE_BUF_MAX);
847
848		if (size == 1) {
849			tty_insert_flip_char(&port->port, buf[0], TTY_NORMAL);
850			size = 0;
851		} else if (size < RECEIVE_BUF_MAX) {
852			size -= tty_insert_flip_string(&port->port,
853					(char *)buf, size);
854		} else {
855			i = tty_insert_flip_string(&port->port,
856					(char *)buf, RECEIVE_BUF_MAX);
857			size -= i;
858			offset += i;
859		}
860	}
861
862	set_bit(index, &dc->flip);
863	ret = 1;
864put:
865	tty_kref_put(tty);
866	return ret;
867}
868
869/* Debug for interrupts */
870#ifdef DEBUG
871static char *interrupt2str(u16 interrupt)
872{
873	static char buf[TMP_BUF_MAX];
874	char *p = buf;
875
876	interrupt & MDM_DL1 ? p += snprintf(p, TMP_BUF_MAX, "MDM_DL1 ") : NULL;
877	interrupt & MDM_DL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
878					"MDM_DL2 ") : NULL;
879
880	interrupt & MDM_UL1 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
881					"MDM_UL1 ") : NULL;
882	interrupt & MDM_UL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
883					"MDM_UL2 ") : NULL;
884
885	interrupt & DIAG_DL1 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
886					"DIAG_DL1 ") : NULL;
887	interrupt & DIAG_DL2 ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
888					"DIAG_DL2 ") : NULL;
889
890	interrupt & DIAG_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
891					"DIAG_UL ") : NULL;
892
893	interrupt & APP1_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
894					"APP1_DL ") : NULL;
895	interrupt & APP2_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
896					"APP2_DL ") : NULL;
897
898	interrupt & APP1_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
899					"APP1_UL ") : NULL;
900	interrupt & APP2_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
901					"APP2_UL ") : NULL;
902
903	interrupt & CTRL_DL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
904					"CTRL_DL ") : NULL;
905	interrupt & CTRL_UL ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
906					"CTRL_UL ") : NULL;
907
908	interrupt & RESET ? p += snprintf(p, TMP_BUF_MAX - (p - buf),
909					"RESET ") : NULL;
910
911	return buf;
912}
913#endif
914
915/*
916 * Receive flow control
917 * Return 1 - If ok, else 0
918 */
919static int receive_flow_control(struct nozomi *dc)
920{
921	enum port_type port = PORT_MDM;
922	struct ctrl_dl ctrl_dl;
923	struct ctrl_dl old_ctrl;
924	u16 enable_ier = 0;
925
926	read_mem32((u32 *) &ctrl_dl, dc->port[PORT_CTRL].dl_addr[CH_A], 2);
927
928	switch (ctrl_dl.port) {
929	case CTRL_CMD:
930		DBG1("The Base Band sends this value as a response to a "
931			"request for IMSI detach sent over the control "
932			"channel uplink (see section 7.6.1).");
933		break;
934	case CTRL_MDM:
935		port = PORT_MDM;
936		enable_ier = MDM_DL;
937		break;
938	case CTRL_DIAG:
939		port = PORT_DIAG;
940		enable_ier = DIAG_DL;
941		break;
942	case CTRL_APP1:
943		port = PORT_APP1;
944		enable_ier = APP1_DL;
945		break;
946	case CTRL_APP2:
947		port = PORT_APP2;
948		enable_ier = APP2_DL;
949		if (dc->state == NOZOMI_STATE_ALLOCATED) {
950			/*
951			 * After card initialization the flow control
952			 * received for APP2 is always the last
953			 */
954			dc->state = NOZOMI_STATE_READY;
955			dev_info(&dc->pdev->dev, "Device READY!\n");
956		}
957		break;
958	default:
959		dev_err(&dc->pdev->dev,
960			"ERROR: flow control received for non-existing port\n");
961		return 0;
962	}
963
964	DBG1("0x%04X->0x%04X", *((u16 *)&dc->port[port].ctrl_dl),
965	   *((u16 *)&ctrl_dl));
966
967	old_ctrl = dc->port[port].ctrl_dl;
968	dc->port[port].ctrl_dl = ctrl_dl;
969
970	if (old_ctrl.CTS == 1 && ctrl_dl.CTS == 0) {
971		DBG1("Disable interrupt (0x%04X) on port: %d",
972			enable_ier, port);
973		disable_transmit_ul(port, dc);
974
975	} else if (old_ctrl.CTS == 0 && ctrl_dl.CTS == 1) {
976
977		if (kfifo_len(&dc->port[port].fifo_ul)) {
978			DBG1("Enable interrupt (0x%04X) on port: %d",
979				enable_ier, port);
980			DBG1("Data in buffer [%d], enable transmit! ",
981				kfifo_len(&dc->port[port].fifo_ul));
982			enable_transmit_ul(port, dc);
983		} else {
984			DBG1("No data in buffer...");
985		}
986	}
987
988	if (*(u16 *)&old_ctrl == *(u16 *)&ctrl_dl) {
989		DBG1(" No change in mctrl");
990		return 1;
991	}
992	/* Update statistics */
993	if (old_ctrl.CTS != ctrl_dl.CTS)
994		dc->port[port].tty_icount.cts++;
995	if (old_ctrl.DSR != ctrl_dl.DSR)
996		dc->port[port].tty_icount.dsr++;
997	if (old_ctrl.RI != ctrl_dl.RI)
998		dc->port[port].tty_icount.rng++;
999	if (old_ctrl.DCD != ctrl_dl.DCD)
1000		dc->port[port].tty_icount.dcd++;
1001
1002	wake_up_interruptible(&dc->port[port].tty_wait);
1003
1004	DBG1("port: %d DCD(%d), CTS(%d), RI(%d), DSR(%d)",
1005	   port,
1006	   dc->port[port].tty_icount.dcd, dc->port[port].tty_icount.cts,
1007	   dc->port[port].tty_icount.rng, dc->port[port].tty_icount.dsr);
1008
1009	return 1;
1010}
1011
1012static enum ctrl_port_type port2ctrl(enum port_type port,
1013					const struct nozomi *dc)
1014{
1015	switch (port) {
1016	case PORT_MDM:
1017		return CTRL_MDM;
1018	case PORT_DIAG:
1019		return CTRL_DIAG;
1020	case PORT_APP1:
1021		return CTRL_APP1;
1022	case PORT_APP2:
1023		return CTRL_APP2;
1024	default:
1025		dev_err(&dc->pdev->dev,
1026			"ERROR: send flow control " \
1027			"received for non-existing port\n");
1028	}
1029	return CTRL_ERROR;
1030}
1031
1032/*
1033 * Send flow control, can only update one channel at a time
1034 * Return 0 - If we have updated all flow control
1035 * Return 1 - If we need to update more flow control, ack current enable more
1036 */
1037static int send_flow_control(struct nozomi *dc)
1038{
1039	u32 i, more_flow_control_to_be_updated = 0;
1040	u16 *ctrl;
1041
1042	for (i = PORT_MDM; i < MAX_PORT; i++) {
1043		if (dc->port[i].update_flow_control) {
1044			if (more_flow_control_to_be_updated) {
1045				/* We have more flow control to be updated */
1046				return 1;
1047			}
1048			dc->port[i].ctrl_ul.port = port2ctrl(i, dc);
1049			ctrl = (u16 *)&dc->port[i].ctrl_ul;
1050			write_mem32(dc->port[PORT_CTRL].ul_addr[0], \
1051				(u32 *) ctrl, 2);
1052			dc->port[i].update_flow_control = 0;
1053			more_flow_control_to_be_updated = 1;
1054		}
1055	}
1056	return 0;
1057}
1058
1059/*
1060 * Handle downlink data, ports that are handled are modem and diagnostics
1061 * Return 1 - ok
1062 * Return 0 - toggle fields are out of sync
1063 */
1064static int handle_data_dl(struct nozomi *dc, enum port_type port, u8 *toggle,
1065			u16 read_iir, u16 mask1, u16 mask2)
1066{
1067	if (*toggle == 0 && read_iir & mask1) {
1068		if (receive_data(port, dc)) {
1069			writew(mask1, dc->reg_fcr);
1070			*toggle = !(*toggle);
1071		}
1072
1073		if (read_iir & mask2) {
1074			if (receive_data(port, dc)) {
1075				writew(mask2, dc->reg_fcr);
1076				*toggle = !(*toggle);
1077			}
1078		}
1079	} else if (*toggle == 1 && read_iir & mask2) {
1080		if (receive_data(port, dc)) {
1081			writew(mask2, dc->reg_fcr);
1082			*toggle = !(*toggle);
1083		}
1084
1085		if (read_iir & mask1) {
1086			if (receive_data(port, dc)) {
1087				writew(mask1, dc->reg_fcr);
1088				*toggle = !(*toggle);
1089			}
1090		}
1091	} else {
1092		dev_err(&dc->pdev->dev, "port out of sync!, toggle:%d\n",
1093			*toggle);
1094		return 0;
1095	}
1096	return 1;
1097}
1098
1099/*
1100 * Handle uplink data, this is currently for the modem port
1101 * Return 1 - ok
1102 * Return 0 - toggle field are out of sync
1103 */
1104static int handle_data_ul(struct nozomi *dc, enum port_type port, u16 read_iir)
1105{
1106	u8 *toggle = &(dc->port[port].toggle_ul);
1107
1108	if (*toggle == 0 && read_iir & MDM_UL1) {
1109		dc->last_ier &= ~MDM_UL;
1110		writew(dc->last_ier, dc->reg_ier);
1111		if (send_data(port, dc)) {
1112			writew(MDM_UL1, dc->reg_fcr);
1113			dc->last_ier = dc->last_ier | MDM_UL;
1114			writew(dc->last_ier, dc->reg_ier);
1115			*toggle = !*toggle;
1116		}
1117
1118		if (read_iir & MDM_UL2) {
1119			dc->last_ier &= ~MDM_UL;
1120			writew(dc->last_ier, dc->reg_ier);
1121			if (send_data(port, dc)) {
1122				writew(MDM_UL2, dc->reg_fcr);
1123				dc->last_ier = dc->last_ier | MDM_UL;
1124				writew(dc->last_ier, dc->reg_ier);
1125				*toggle = !*toggle;
1126			}
1127		}
1128
1129	} else if (*toggle == 1 && read_iir & MDM_UL2) {
1130		dc->last_ier &= ~MDM_UL;
1131		writew(dc->last_ier, dc->reg_ier);
1132		if (send_data(port, dc)) {
1133			writew(MDM_UL2, dc->reg_fcr);
1134			dc->last_ier = dc->last_ier | MDM_UL;
1135			writew(dc->last_ier, dc->reg_ier);
1136			*toggle = !*toggle;
1137		}
1138
1139		if (read_iir & MDM_UL1) {
1140			dc->last_ier &= ~MDM_UL;
1141			writew(dc->last_ier, dc->reg_ier);
1142			if (send_data(port, dc)) {
1143				writew(MDM_UL1, dc->reg_fcr);
1144				dc->last_ier = dc->last_ier | MDM_UL;
1145				writew(dc->last_ier, dc->reg_ier);
1146				*toggle = !*toggle;
1147			}
1148		}
1149	} else {
1150		writew(read_iir & MDM_UL, dc->reg_fcr);
1151		dev_err(&dc->pdev->dev, "port out of sync!\n");
1152		return 0;
1153	}
1154	return 1;
1155}
1156
1157static irqreturn_t interrupt_handler(int irq, void *dev_id)
1158{
1159	struct nozomi *dc = dev_id;
1160	unsigned int a;
1161	u16 read_iir;
1162
1163	if (!dc)
1164		return IRQ_NONE;
1165
1166	spin_lock(&dc->spin_mutex);
1167	read_iir = readw(dc->reg_iir);
1168
1169	/* Card removed */
1170	if (read_iir == (u16)-1)
1171		goto none;
1172	/*
1173	 * Just handle interrupt enabled in IER
1174	 * (by masking with dc->last_ier)
1175	 */
1176	read_iir &= dc->last_ier;
1177
1178	if (read_iir == 0)
1179		goto none;
1180
1181
1182	DBG4("%s irq:0x%04X, prev:0x%04X", interrupt2str(read_iir), read_iir,
1183		dc->last_ier);
1184
1185	if (read_iir & RESET) {
1186		if (unlikely(!nozomi_read_config_table(dc))) {
1187			dc->last_ier = 0x0;
1188			writew(dc->last_ier, dc->reg_ier);
1189			dev_err(&dc->pdev->dev, "Could not read status from "
1190				"card, we should disable interface\n");
1191		} else {
1192			writew(RESET, dc->reg_fcr);
1193		}
1194		/* No more useful info if this was the reset interrupt. */
1195		goto exit_handler;
1196	}
1197	if (read_iir & CTRL_UL) {
1198		DBG1("CTRL_UL");
1199		dc->last_ier &= ~CTRL_UL;
1200		writew(dc->last_ier, dc->reg_ier);
1201		if (send_flow_control(dc)) {
1202			writew(CTRL_UL, dc->reg_fcr);
1203			dc->last_ier = dc->last_ier | CTRL_UL;
1204			writew(dc->last_ier, dc->reg_ier);
1205		}
1206	}
1207	if (read_iir & CTRL_DL) {
1208		receive_flow_control(dc);
1209		writew(CTRL_DL, dc->reg_fcr);
1210	}
1211	if (read_iir & MDM_DL) {
1212		if (!handle_data_dl(dc, PORT_MDM,
1213				&(dc->port[PORT_MDM].toggle_dl), read_iir,
1214				MDM_DL1, MDM_DL2)) {
1215			dev_err(&dc->pdev->dev, "MDM_DL out of sync!\n");
1216			goto exit_handler;
1217		}
1218	}
1219	if (read_iir & MDM_UL) {
1220		if (!handle_data_ul(dc, PORT_MDM, read_iir)) {
1221			dev_err(&dc->pdev->dev, "MDM_UL out of sync!\n");
1222			goto exit_handler;
1223		}
1224	}
1225	if (read_iir & DIAG_DL) {
1226		if (!handle_data_dl(dc, PORT_DIAG,
1227				&(dc->port[PORT_DIAG].toggle_dl), read_iir,
1228				DIAG_DL1, DIAG_DL2)) {
1229			dev_err(&dc->pdev->dev, "DIAG_DL out of sync!\n");
1230			goto exit_handler;
1231		}
1232	}
1233	if (read_iir & DIAG_UL) {
1234		dc->last_ier &= ~DIAG_UL;
1235		writew(dc->last_ier, dc->reg_ier);
1236		if (send_data(PORT_DIAG, dc)) {
1237			writew(DIAG_UL, dc->reg_fcr);
1238			dc->last_ier = dc->last_ier | DIAG_UL;
1239			writew(dc->last_ier, dc->reg_ier);
1240		}
1241	}
1242	if (read_iir & APP1_DL) {
1243		if (receive_data(PORT_APP1, dc))
1244			writew(APP1_DL, dc->reg_fcr);
1245	}
1246	if (read_iir & APP1_UL) {
1247		dc->last_ier &= ~APP1_UL;
1248		writew(dc->last_ier, dc->reg_ier);
1249		if (send_data(PORT_APP1, dc)) {
1250			writew(APP1_UL, dc->reg_fcr);
1251			dc->last_ier = dc->last_ier | APP1_UL;
1252			writew(dc->last_ier, dc->reg_ier);
1253		}
1254	}
1255	if (read_iir & APP2_DL) {
1256		if (receive_data(PORT_APP2, dc))
1257			writew(APP2_DL, dc->reg_fcr);
1258	}
1259	if (read_iir & APP2_UL) {
1260		dc->last_ier &= ~APP2_UL;
1261		writew(dc->last_ier, dc->reg_ier);
1262		if (send_data(PORT_APP2, dc)) {
1263			writew(APP2_UL, dc->reg_fcr);
1264			dc->last_ier = dc->last_ier | APP2_UL;
1265			writew(dc->last_ier, dc->reg_ier);
1266		}
1267	}
1268
1269exit_handler:
1270	spin_unlock(&dc->spin_mutex);
1271
1272	for (a = 0; a < NOZOMI_MAX_PORTS; a++)
1273		if (test_and_clear_bit(a, &dc->flip))
1274			tty_flip_buffer_push(&dc->port[a].port);
1275
1276	return IRQ_HANDLED;
1277none:
1278	spin_unlock(&dc->spin_mutex);
1279	return IRQ_NONE;
1280}
1281
1282static void nozomi_get_card_type(struct nozomi *dc)
1283{
1284	int i;
1285	u32 size = 0;
1286
1287	for (i = 0; i < 6; i++)
1288		size += pci_resource_len(dc->pdev, i);
1289
1290	/* Assume card type F32_8 if no match */
1291	dc->card_type = size == 2048 ? F32_2 : F32_8;
1292
1293	dev_info(&dc->pdev->dev, "Card type is: %d\n", dc->card_type);
1294}
1295
1296static void nozomi_setup_private_data(struct nozomi *dc)
1297{
1298	void __iomem *offset = dc->base_addr + dc->card_type / 2;
1299	unsigned int i;
1300
1301	dc->reg_fcr = (void __iomem *)(offset + R_FCR);
1302	dc->reg_iir = (void __iomem *)(offset + R_IIR);
1303	dc->reg_ier = (void __iomem *)(offset + R_IER);
1304	dc->last_ier = 0;
1305	dc->flip = 0;
1306
1307	dc->port[PORT_MDM].token_dl = MDM_DL;
1308	dc->port[PORT_DIAG].token_dl = DIAG_DL;
1309	dc->port[PORT_APP1].token_dl = APP1_DL;
1310	dc->port[PORT_APP2].token_dl = APP2_DL;
1311
1312	for (i = 0; i < MAX_PORT; i++)
1313		init_waitqueue_head(&dc->port[i].tty_wait);
1314}
1315
1316static ssize_t card_type_show(struct device *dev, struct device_attribute *attr,
1317			  char *buf)
1318{
1319	const struct nozomi *dc = pci_get_drvdata(to_pci_dev(dev));
1320
1321	return sprintf(buf, "%d\n", dc->card_type);
1322}
1323static DEVICE_ATTR(card_type, S_IRUGO, card_type_show, NULL);
1324
1325static ssize_t open_ttys_show(struct device *dev, struct device_attribute *attr,
1326			  char *buf)
1327{
1328	const struct nozomi *dc = pci_get_drvdata(to_pci_dev(dev));
1329
1330	return sprintf(buf, "%u\n", dc->open_ttys);
1331}
1332static DEVICE_ATTR(open_ttys, S_IRUGO, open_ttys_show, NULL);
1333
1334static void make_sysfs_files(struct nozomi *dc)
1335{
1336	if (device_create_file(&dc->pdev->dev, &dev_attr_card_type))
1337		dev_err(&dc->pdev->dev,
1338			"Could not create sysfs file for card_type\n");
1339	if (device_create_file(&dc->pdev->dev, &dev_attr_open_ttys))
1340		dev_err(&dc->pdev->dev,
1341			"Could not create sysfs file for open_ttys\n");
1342}
1343
1344static void remove_sysfs_files(struct nozomi *dc)
1345{
1346	device_remove_file(&dc->pdev->dev, &dev_attr_card_type);
1347	device_remove_file(&dc->pdev->dev, &dev_attr_open_ttys);
1348}
1349
1350/* Allocate memory for one device */
1351static int nozomi_card_init(struct pci_dev *pdev,
1352				      const struct pci_device_id *ent)
1353{
1354	resource_size_t start;
1355	int ret;
1356	struct nozomi *dc = NULL;
1357	int ndev_idx;
1358	int i;
1359
1360	dev_dbg(&pdev->dev, "Init, new card found\n");
1361
1362	for (ndev_idx = 0; ndev_idx < ARRAY_SIZE(ndevs); ndev_idx++)
1363		if (!ndevs[ndev_idx])
1364			break;
1365
1366	if (ndev_idx >= ARRAY_SIZE(ndevs)) {
1367		dev_err(&pdev->dev, "no free tty range for this card left\n");
1368		ret = -EIO;
1369		goto err;
1370	}
1371
1372	dc = kzalloc(sizeof(struct nozomi), GFP_KERNEL);
1373	if (unlikely(!dc)) {
1374		dev_err(&pdev->dev, "Could not allocate memory\n");
1375		ret = -ENOMEM;
1376		goto err_free;
1377	}
1378
1379	dc->pdev = pdev;
1380
1381	ret = pci_enable_device(dc->pdev);
1382	if (ret) {
1383		dev_err(&pdev->dev, "Failed to enable PCI Device\n");
1384		goto err_free;
1385	}
1386
1387	ret = pci_request_regions(dc->pdev, NOZOMI_NAME);
1388	if (ret) {
1389		dev_err(&pdev->dev, "I/O address 0x%04x already in use\n",
1390			(int) /* nozomi_private.io_addr */ 0);
1391		goto err_disable_device;
1392	}
1393
1394	start = pci_resource_start(dc->pdev, 0);
1395	if (start == 0) {
1396		dev_err(&pdev->dev, "No I/O address for card detected\n");
1397		ret = -ENODEV;
1398		goto err_rel_regs;
1399	}
1400
1401	/* Find out what card type it is */
1402	nozomi_get_card_type(dc);
1403
1404	dc->base_addr = ioremap_nocache(start, dc->card_type);
1405	if (!dc->base_addr) {
1406		dev_err(&pdev->dev, "Unable to map card MMIO\n");
1407		ret = -ENODEV;
1408		goto err_rel_regs;
1409	}
1410
1411	dc->send_buf = kmalloc(SEND_BUF_MAX, GFP_KERNEL);
1412	if (!dc->send_buf) {
1413		dev_err(&pdev->dev, "Could not allocate send buffer?\n");
1414		ret = -ENOMEM;
1415		goto err_free_sbuf;
1416	}
1417
1418	for (i = PORT_MDM; i < MAX_PORT; i++) {
1419		if (kfifo_alloc(&dc->port[i].fifo_ul, FIFO_BUFFER_SIZE_UL,
1420					GFP_KERNEL)) {
1421			dev_err(&pdev->dev,
1422					"Could not allocate kfifo buffer\n");
1423			ret = -ENOMEM;
1424			goto err_free_kfifo;
1425		}
1426	}
1427
1428	spin_lock_init(&dc->spin_mutex);
1429
1430	nozomi_setup_private_data(dc);
1431
1432	/* Disable all interrupts */
1433	dc->last_ier = 0;
1434	writew(dc->last_ier, dc->reg_ier);
1435
1436	ret = request_irq(pdev->irq, &interrupt_handler, IRQF_SHARED,
1437			NOZOMI_NAME, dc);
1438	if (unlikely(ret)) {
1439		dev_err(&pdev->dev, "can't request irq %d\n", pdev->irq);
1440		goto err_free_kfifo;
1441	}
1442
1443	DBG1("base_addr: %p", dc->base_addr);
1444
1445	make_sysfs_files(dc);
1446
1447	dc->index_start = ndev_idx * MAX_PORT;
1448	ndevs[ndev_idx] = dc;
1449
1450	pci_set_drvdata(pdev, dc);
1451
1452	/* Enable RESET interrupt */
1453	dc->last_ier = RESET;
1454	iowrite16(dc->last_ier, dc->reg_ier);
1455
1456	dc->state = NOZOMI_STATE_ENABLED;
1457
1458	for (i = 0; i < MAX_PORT; i++) {
1459		struct device *tty_dev;
1460		struct port *port = &dc->port[i];
1461		port->dc = dc;
1462		tty_port_init(&port->port);
1463		port->port.ops = &noz_tty_port_ops;
1464		tty_dev = tty_port_register_device(&port->port, ntty_driver,
1465				dc->index_start + i, &pdev->dev);
1466
1467		if (IS_ERR(tty_dev)) {
1468			ret = PTR_ERR(tty_dev);
1469			dev_err(&pdev->dev, "Could not allocate tty?\n");
1470			tty_port_destroy(&port->port);
1471			goto err_free_tty;
1472		}
1473	}
1474
1475	return 0;
1476
1477err_free_tty:
1478	for (i = 0; i < MAX_PORT; ++i) {
1479		tty_unregister_device(ntty_driver, dc->index_start + i);
1480		tty_port_destroy(&dc->port[i].port);
1481	}
1482err_free_kfifo:
1483	for (i = 0; i < MAX_PORT; i++)
1484		kfifo_free(&dc->port[i].fifo_ul);
1485err_free_sbuf:
1486	kfree(dc->send_buf);
1487	iounmap(dc->base_addr);
1488err_rel_regs:
1489	pci_release_regions(pdev);
1490err_disable_device:
1491	pci_disable_device(pdev);
1492err_free:
1493	kfree(dc);
1494err:
1495	return ret;
1496}
1497
1498static void tty_exit(struct nozomi *dc)
1499{
1500	unsigned int i;
1501
1502	DBG1(" ");
1503
1504	for (i = 0; i < MAX_PORT; ++i)
1505		tty_port_tty_hangup(&dc->port[i].port, false);
1506
1507	/* Racy below - surely should wait for scheduled work to be done or
1508	   complete off a hangup method ? */
1509	while (dc->open_ttys)
1510		msleep(1);
1511	for (i = 0; i < MAX_PORT; ++i) {
1512		tty_unregister_device(ntty_driver, dc->index_start + i);
1513		tty_port_destroy(&dc->port[i].port);
1514	}
1515}
1516
1517/* Deallocate memory for one device */
1518static void nozomi_card_exit(struct pci_dev *pdev)
1519{
1520	int i;
1521	struct ctrl_ul ctrl;
1522	struct nozomi *dc = pci_get_drvdata(pdev);
1523
1524	/* Disable all interrupts */
1525	dc->last_ier = 0;
1526	writew(dc->last_ier, dc->reg_ier);
1527
1528	tty_exit(dc);
1529
1530	/* Send 0x0001, command card to resend the reset token.  */
1531	/* This is to get the reset when the module is reloaded. */
1532	ctrl.port = 0x00;
1533	ctrl.reserved = 0;
1534	ctrl.RTS = 0;
1535	ctrl.DTR = 1;
1536	DBG1("sending flow control 0x%04X", *((u16 *)&ctrl));
1537
1538	/* Setup dc->reg addresses to we can use defines here */
1539	write_mem32(dc->port[PORT_CTRL].ul_addr[0], (u32 *)&ctrl, 2);
1540	writew(CTRL_UL, dc->reg_fcr);	/* push the token to the card. */
1541
1542	remove_sysfs_files(dc);
1543
1544	free_irq(pdev->irq, dc);
1545
1546	for (i = 0; i < MAX_PORT; i++)
1547		kfifo_free(&dc->port[i].fifo_ul);
1548
1549	kfree(dc->send_buf);
1550
1551	iounmap(dc->base_addr);
1552
1553	pci_release_regions(pdev);
1554
1555	pci_disable_device(pdev);
1556
1557	ndevs[dc->index_start / MAX_PORT] = NULL;
1558
1559	kfree(dc);
1560}
1561
1562static void set_rts(const struct tty_struct *tty, int rts)
1563{
1564	struct port *port = get_port_by_tty(tty);
1565
1566	port->ctrl_ul.RTS = rts;
1567	port->update_flow_control = 1;
1568	enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1569}
1570
1571static void set_dtr(const struct tty_struct *tty, int dtr)
1572{
1573	struct port *port = get_port_by_tty(tty);
1574
1575	DBG1("SETTING DTR index: %d, dtr: %d", tty->index, dtr);
1576
1577	port->ctrl_ul.DTR = dtr;
1578	port->update_flow_control = 1;
1579	enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty));
1580}
1581
1582/*
1583 * ----------------------------------------------------------------------------
1584 * TTY code
1585 * ----------------------------------------------------------------------------
1586 */
1587
1588static int ntty_install(struct tty_driver *driver, struct tty_struct *tty)
1589{
1590	struct port *port = get_port_by_tty(tty);
1591	struct nozomi *dc = get_dc_by_tty(tty);
1592	int ret;
1593	if (!port || !dc || dc->state != NOZOMI_STATE_READY)
1594		return -ENODEV;
1595	ret = tty_standard_install(driver, tty);
1596	if (ret == 0)
1597		tty->driver_data = port;
1598	return ret;
1599}
1600
1601static void ntty_cleanup(struct tty_struct *tty)
1602{
1603	tty->driver_data = NULL;
1604}
1605
1606static int ntty_activate(struct tty_port *tport, struct tty_struct *tty)
1607{
1608	struct port *port = container_of(tport, struct port, port);
1609	struct nozomi *dc = port->dc;
1610	unsigned long flags;
1611
1612	DBG1("open: %d", port->token_dl);
1613	spin_lock_irqsave(&dc->spin_mutex, flags);
1614	dc->last_ier = dc->last_ier | port->token_dl;
1615	writew(dc->last_ier, dc->reg_ier);
1616	dc->open_ttys++;
1617	spin_unlock_irqrestore(&dc->spin_mutex, flags);
1618	printk("noz: activated %d: %p\n", tty->index, tport);
1619	return 0;
1620}
1621
1622static int ntty_open(struct tty_struct *tty, struct file *filp)
1623{
1624	struct port *port = tty->driver_data;
1625	return tty_port_open(&port->port, tty, filp);
1626}
1627
1628static void ntty_shutdown(struct tty_port *tport)
1629{
1630	struct port *port = container_of(tport, struct port, port);
1631	struct nozomi *dc = port->dc;
1632	unsigned long flags;
1633
1634	DBG1("close: %d", port->token_dl);
1635	spin_lock_irqsave(&dc->spin_mutex, flags);
1636	dc->last_ier &= ~(port->token_dl);
1637	writew(dc->last_ier, dc->reg_ier);
1638	dc->open_ttys--;
1639	spin_unlock_irqrestore(&dc->spin_mutex, flags);
1640	printk("noz: shutdown %p\n", tport);
1641}
1642
1643static void ntty_close(struct tty_struct *tty, struct file *filp)
1644{
1645	struct port *port = tty->driver_data;
1646	if (port)
1647		tty_port_close(&port->port, tty, filp);
1648}
1649
1650static void ntty_hangup(struct tty_struct *tty)
1651{
1652	struct port *port = tty->driver_data;
1653	tty_port_hangup(&port->port);
1654}
1655
1656/*
1657 * called when the userspace process writes to the tty (/dev/noz*).
1658 * Data is inserted into a fifo, which is then read and transferred to the modem.
1659 */
1660static int ntty_write(struct tty_struct *tty, const unsigned char *buffer,
1661		      int count)
1662{
1663	int rval = -EINVAL;
1664	struct nozomi *dc = get_dc_by_tty(tty);
1665	struct port *port = tty->driver_data;
1666	unsigned long flags;
1667
1668	/* DBG1( "WRITEx: %d, index = %d", count, index); */
1669
1670	if (!dc || !port)
1671		return -ENODEV;
1672
1673	rval = kfifo_in(&port->fifo_ul, (unsigned char *)buffer, count);
1674
1675	spin_lock_irqsave(&dc->spin_mutex, flags);
1676	/* CTS is only valid on the modem channel */
1677	if (port == &(dc->port[PORT_MDM])) {
1678		if (port->ctrl_dl.CTS) {
1679			DBG4("Enable interrupt");
1680			enable_transmit_ul(tty->index % MAX_PORT, dc);
1681		} else {
1682			dev_err(&dc->pdev->dev,
1683				"CTS not active on modem port?\n");
1684		}
1685	} else {
1686		enable_transmit_ul(tty->index % MAX_PORT, dc);
1687	}
1688	spin_unlock_irqrestore(&dc->spin_mutex, flags);
1689
1690	return rval;
1691}
1692
1693/*
1694 * Calculate how much is left in device
1695 * This method is called by the upper tty layer.
1696 *   #according to sources N_TTY.c it expects a value >= 0 and
1697 *    does not check for negative values.
1698 *
1699 * If the port is unplugged report lots of room and let the bits
1700 * dribble away so we don't block anything.
1701 */
1702static int ntty_write_room(struct tty_struct *tty)
1703{
1704	struct port *port = tty->driver_data;
1705	int room = 4096;
1706	const struct nozomi *dc = get_dc_by_tty(tty);
1707
1708	if (dc)
1709		room = kfifo_avail(&port->fifo_ul);
1710
1711	return room;
1712}
1713
1714/* Gets io control parameters */
1715static int ntty_tiocmget(struct tty_struct *tty)
1716{
1717	const struct port *port = tty->driver_data;
1718	const struct ctrl_dl *ctrl_dl = &port->ctrl_dl;
1719	const struct ctrl_ul *ctrl_ul = &port->ctrl_ul;
1720
1721	/* Note: these could change under us but it is not clear this
1722	   matters if so */
1723	return	(ctrl_ul->RTS ? TIOCM_RTS : 0) |
1724		(ctrl_ul->DTR ? TIOCM_DTR : 0) |
1725		(ctrl_dl->DCD ? TIOCM_CAR : 0) |
1726		(ctrl_dl->RI  ? TIOCM_RNG : 0) |
1727		(ctrl_dl->DSR ? TIOCM_DSR : 0) |
1728		(ctrl_dl->CTS ? TIOCM_CTS : 0);
1729}
1730
1731/* Sets io controls parameters */
1732static int ntty_tiocmset(struct tty_struct *tty,
1733					unsigned int set, unsigned int clear)
1734{
1735	struct nozomi *dc = get_dc_by_tty(tty);
1736	unsigned long flags;
1737
1738	spin_lock_irqsave(&dc->spin_mutex, flags);
1739	if (set & TIOCM_RTS)
1740		set_rts(tty, 1);
1741	else if (clear & TIOCM_RTS)
1742		set_rts(tty, 0);
1743
1744	if (set & TIOCM_DTR)
1745		set_dtr(tty, 1);
1746	else if (clear & TIOCM_DTR)
1747		set_dtr(tty, 0);
1748	spin_unlock_irqrestore(&dc->spin_mutex, flags);
1749
1750	return 0;
1751}
1752
1753static int ntty_cflags_changed(struct port *port, unsigned long flags,
1754		struct async_icount *cprev)
1755{
1756	const struct async_icount cnow = port->tty_icount;
1757	int ret;
1758
1759	ret =	((flags & TIOCM_RNG) && (cnow.rng != cprev->rng)) ||
1760		((flags & TIOCM_DSR) && (cnow.dsr != cprev->dsr)) ||
1761		((flags & TIOCM_CD)  && (cnow.dcd != cprev->dcd)) ||
1762		((flags & TIOCM_CTS) && (cnow.cts != cprev->cts));
1763
1764	*cprev = cnow;
1765
1766	return ret;
1767}
1768
1769static int ntty_tiocgicount(struct tty_struct *tty,
1770				struct serial_icounter_struct *icount)
1771{
1772	struct port *port = tty->driver_data;
1773	const struct async_icount cnow = port->tty_icount;
1774
1775	icount->cts = cnow.cts;
1776	icount->dsr = cnow.dsr;
1777	icount->rng = cnow.rng;
1778	icount->dcd = cnow.dcd;
1779	icount->rx = cnow.rx;
1780	icount->tx = cnow.tx;
1781	icount->frame = cnow.frame;
1782	icount->overrun = cnow.overrun;
1783	icount->parity = cnow.parity;
1784	icount->brk = cnow.brk;
1785	icount->buf_overrun = cnow.buf_overrun;
1786	return 0;
1787}
1788
1789static int ntty_ioctl(struct tty_struct *tty,
1790		      unsigned int cmd, unsigned long arg)
1791{
1792	struct port *port = tty->driver_data;
1793	int rval = -ENOIOCTLCMD;
1794
1795	DBG1("******** IOCTL, cmd: %d", cmd);
1796
1797	switch (cmd) {
1798	case TIOCMIWAIT: {
1799		struct async_icount cprev = port->tty_icount;
1800
1801		rval = wait_event_interruptible(port->tty_wait,
1802				ntty_cflags_changed(port, arg, &cprev));
1803		break;
1804	}
1805	default:
1806		DBG1("ERR: 0x%08X, %d", cmd, cmd);
1807		break;
1808	}
1809
1810	return rval;
1811}
1812
1813/*
1814 * Called by the upper tty layer when tty buffers are ready
1815 * to receive data again after a call to throttle.
1816 */
1817static void ntty_unthrottle(struct tty_struct *tty)
1818{
1819	struct nozomi *dc = get_dc_by_tty(tty);
1820	unsigned long flags;
1821
1822	DBG1("UNTHROTTLE");
1823	spin_lock_irqsave(&dc->spin_mutex, flags);
1824	enable_transmit_dl(tty->index % MAX_PORT, dc);
1825	set_rts(tty, 1);
1826
1827	spin_unlock_irqrestore(&dc->spin_mutex, flags);
1828}
1829
1830/*
1831 * Called by the upper tty layer when the tty buffers are almost full.
1832 * The driver should stop send more data.
1833 */
1834static void ntty_throttle(struct tty_struct *tty)
1835{
1836	struct nozomi *dc = get_dc_by_tty(tty);
1837	unsigned long flags;
1838
1839	DBG1("THROTTLE");
1840	spin_lock_irqsave(&dc->spin_mutex, flags);
1841	set_rts(tty, 0);
1842	spin_unlock_irqrestore(&dc->spin_mutex, flags);
1843}
1844
1845/* Returns number of chars in buffer, called by tty layer */
1846static s32 ntty_chars_in_buffer(struct tty_struct *tty)
1847{
1848	struct port *port = tty->driver_data;
1849	struct nozomi *dc = get_dc_by_tty(tty);
1850	s32 rval = 0;
1851
1852	if (unlikely(!dc || !port)) {
1853		goto exit_in_buffer;
1854	}
1855
1856	rval = kfifo_len(&port->fifo_ul);
1857
1858exit_in_buffer:
1859	return rval;
1860}
1861
1862static const struct tty_port_operations noz_tty_port_ops = {
1863	.activate = ntty_activate,
1864	.shutdown = ntty_shutdown,
1865};
1866
1867static const struct tty_operations tty_ops = {
1868	.ioctl = ntty_ioctl,
1869	.open = ntty_open,
1870	.close = ntty_close,
1871	.hangup = ntty_hangup,
1872	.write = ntty_write,
1873	.write_room = ntty_write_room,
1874	.unthrottle = ntty_unthrottle,
1875	.throttle = ntty_throttle,
1876	.chars_in_buffer = ntty_chars_in_buffer,
1877	.tiocmget = ntty_tiocmget,
1878	.tiocmset = ntty_tiocmset,
1879	.get_icount = ntty_tiocgicount,
1880	.install = ntty_install,
1881	.cleanup = ntty_cleanup,
1882};
1883
1884/* Module initialization */
1885static struct pci_driver nozomi_driver = {
1886	.name = NOZOMI_NAME,
1887	.id_table = nozomi_pci_tbl,
1888	.probe = nozomi_card_init,
1889	.remove = nozomi_card_exit,
1890};
1891
1892static __init int nozomi_init(void)
1893{
1894	int ret;
1895
1896	printk(KERN_INFO "Initializing %s\n", VERSION_STRING);
1897
1898	ntty_driver = alloc_tty_driver(NTTY_TTY_MAXMINORS);
1899	if (!ntty_driver)
1900		return -ENOMEM;
1901
1902	ntty_driver->driver_name = NOZOMI_NAME_TTY;
1903	ntty_driver->name = "noz";
1904	ntty_driver->major = 0;
1905	ntty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1906	ntty_driver->subtype = SERIAL_TYPE_NORMAL;
1907	ntty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1908	ntty_driver->init_termios = tty_std_termios;
1909	ntty_driver->init_termios.c_cflag = B115200 | CS8 | CREAD | \
1910						HUPCL | CLOCAL;
1911	ntty_driver->init_termios.c_ispeed = 115200;
1912	ntty_driver->init_termios.c_ospeed = 115200;
1913	tty_set_operations(ntty_driver, &tty_ops);
1914
1915	ret = tty_register_driver(ntty_driver);
1916	if (ret) {
1917		printk(KERN_ERR "Nozomi: failed to register ntty driver\n");
1918		goto free_tty;
1919	}
1920
1921	ret = pci_register_driver(&nozomi_driver);
1922	if (ret) {
1923		printk(KERN_ERR "Nozomi: can't register pci driver\n");
1924		goto unr_tty;
1925	}
1926
1927	return 0;
1928unr_tty:
1929	tty_unregister_driver(ntty_driver);
1930free_tty:
1931	put_tty_driver(ntty_driver);
1932	return ret;
1933}
1934
1935static __exit void nozomi_exit(void)
1936{
1937	printk(KERN_INFO "Unloading %s\n", DRIVER_DESC);
1938	pci_unregister_driver(&nozomi_driver);
1939	tty_unregister_driver(ntty_driver);
1940	put_tty_driver(ntty_driver);
1941}
1942
1943module_init(nozomi_init);
1944module_exit(nozomi_exit);
1945
1946module_param(debug, int, S_IRUGO | S_IWUSR);
1947
1948MODULE_LICENSE("Dual BSD/GPL");
1949MODULE_DESCRIPTION(DRIVER_DESC);
1950