dtl1_cs.c revision 66f4e0e43a0389a7f2814f0cc6df39019aead54f 
1/*
2 *
3 *  A driver for Nokia Connectivity Card DTL-1 devices
4 *
5 *  Copyright (C) 2001-2002  Marcel Holtmann <marcel@holtmann.org>
6 *
7 *
8 *  This program is free software; you can redistribute it and/or modify
9 *  it under the terms of the GNU General Public License version 2 as
10 *  published by the Free Software Foundation;
11 *
12 *  Software distributed under the License is distributed on an "AS
13 *  IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
14 *  implied. See the License for the specific language governing
15 *  rights and limitations under the License.
16 *
17 *  The initial developer of the original code is David A. Hinds
18 *  <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
19 *  are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
20 *
21 */
22
23#include <linux/module.h>
24
25#include <linux/kernel.h>
26#include <linux/init.h>
27#include <linux/slab.h>
28#include <linux/types.h>
29#include <linux/delay.h>
30#include <linux/errno.h>
31#include <linux/ptrace.h>
32#include <linux/ioport.h>
33#include <linux/spinlock.h>
34#include <linux/moduleparam.h>
35
36#include <linux/skbuff.h>
37#include <linux/string.h>
38#include <linux/serial.h>
39#include <linux/serial_reg.h>
40#include <linux/bitops.h>
41#include <asm/io.h>
42
43#include <pcmcia/cistpl.h>
44#include <pcmcia/ciscode.h>
45#include <pcmcia/ds.h>
46#include <pcmcia/cisreg.h>
47
48#include <net/bluetooth/bluetooth.h>
49#include <net/bluetooth/hci_core.h>
50
51
52
53/* ======================== Module parameters ======================== */
54
55
56MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
57MODULE_DESCRIPTION("Bluetooth driver for Nokia Connectivity Card DTL-1");
58MODULE_LICENSE("GPL");
59
60
61
62/* ======================== Local structures ======================== */
63
64
65struct dtl1_info {
66	struct pcmcia_device *p_dev;
67
68	struct hci_dev *hdev;
69
70	spinlock_t lock;		/* For serializing operations */
71
72	unsigned long flowmask;		/* HCI flow mask */
73	int ri_latch;
74
75	struct sk_buff_head txq;
76	unsigned long tx_state;
77
78	unsigned long rx_state;
79	unsigned long rx_count;
80	struct sk_buff *rx_skb;
81};
82
83
84static int dtl1_config(struct pcmcia_device *link);
85
86
87/* Transmit states  */
88#define XMIT_SENDING  1
89#define XMIT_WAKEUP   2
90#define XMIT_WAITING  8
91
92/* Receiver States */
93#define RECV_WAIT_NSH   0
94#define RECV_WAIT_DATA  1
95
96
97struct nsh {
98	u8 type;
99	u8 zero;
100	u16 len;
101} __packed;	/* Nokia Specific Header */
102
103#define NSHL  4				/* Nokia Specific Header Length */
104
105
106
107/* ======================== Interrupt handling ======================== */
108
109
110static int dtl1_write(unsigned int iobase, int fifo_size, __u8 *buf, int len)
111{
112	int actual = 0;
113
114	/* Tx FIFO should be empty */
115	if (!(inb(iobase + UART_LSR) & UART_LSR_THRE))
116		return 0;
117
118	/* Fill FIFO with current frame */
119	while ((fifo_size-- > 0) && (actual < len)) {
120		/* Transmit next byte */
121		outb(buf[actual], iobase + UART_TX);
122		actual++;
123	}
124
125	return actual;
126}
127
128
129static void dtl1_write_wakeup(struct dtl1_info *info)
130{
131	if (!info) {
132		BT_ERR("Unknown device");
133		return;
134	}
135
136	if (test_bit(XMIT_WAITING, &(info->tx_state))) {
137		set_bit(XMIT_WAKEUP, &(info->tx_state));
138		return;
139	}
140
141	if (test_and_set_bit(XMIT_SENDING, &(info->tx_state))) {
142		set_bit(XMIT_WAKEUP, &(info->tx_state));
143		return;
144	}
145
146	do {
147		unsigned int iobase = info->p_dev->resource[0]->start;
148		register struct sk_buff *skb;
149		int len;
150
151		clear_bit(XMIT_WAKEUP, &(info->tx_state));
152
153		if (!pcmcia_dev_present(info->p_dev))
154			return;
155
156		skb = skb_dequeue(&(info->txq));
157		if (!skb)
158			break;
159
160		/* Send frame */
161		len = dtl1_write(iobase, 32, skb->data, skb->len);
162
163		if (len == skb->len) {
164			set_bit(XMIT_WAITING, &(info->tx_state));
165			kfree_skb(skb);
166		} else {
167			skb_pull(skb, len);
168			skb_queue_head(&(info->txq), skb);
169		}
170
171		info->hdev->stat.byte_tx += len;
172
173	} while (test_bit(XMIT_WAKEUP, &(info->tx_state)));
174
175	clear_bit(XMIT_SENDING, &(info->tx_state));
176}
177
178
179static void dtl1_control(struct dtl1_info *info, struct sk_buff *skb)
180{
181	u8 flowmask = *(u8 *)skb->data;
182	int i;
183
184	printk(KERN_INFO "Bluetooth: Nokia control data =");
185	for (i = 0; i < skb->len; i++) {
186		printk(" %02x", skb->data[i]);
187	}
188	printk("\n");
189
190	/* transition to active state */
191	if (((info->flowmask & 0x07) == 0) && ((flowmask & 0x07) != 0)) {
192		clear_bit(XMIT_WAITING, &(info->tx_state));
193		dtl1_write_wakeup(info);
194	}
195
196	info->flowmask = flowmask;
197
198	kfree_skb(skb);
199}
200
201
202static void dtl1_receive(struct dtl1_info *info)
203{
204	unsigned int iobase;
205	struct nsh *nsh;
206	int boguscount = 0;
207
208	if (!info) {
209		BT_ERR("Unknown device");
210		return;
211	}
212
213	iobase = info->p_dev->resource[0]->start;
214
215	do {
216		info->hdev->stat.byte_rx++;
217
218		/* Allocate packet */
219		if (info->rx_skb == NULL) {
220			info->rx_skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
221			if (!info->rx_skb) {
222				BT_ERR("Can't allocate mem for new packet");
223				info->rx_state = RECV_WAIT_NSH;
224				info->rx_count = NSHL;
225				return;
226			}
227		}
228
229		*skb_put(info->rx_skb, 1) = inb(iobase + UART_RX);
230		nsh = (struct nsh *)info->rx_skb->data;
231
232		info->rx_count--;
233
234		if (info->rx_count == 0) {
235
236			switch (info->rx_state) {
237			case RECV_WAIT_NSH:
238				info->rx_state = RECV_WAIT_DATA;
239				info->rx_count = nsh->len + (nsh->len & 0x0001);
240				break;
241			case RECV_WAIT_DATA:
242				bt_cb(info->rx_skb)->pkt_type = nsh->type;
243
244				/* remove PAD byte if it exists */
245				if (nsh->len & 0x0001) {
246					info->rx_skb->tail--;
247					info->rx_skb->len--;
248				}
249
250				/* remove NSH */
251				skb_pull(info->rx_skb, NSHL);
252
253				switch (bt_cb(info->rx_skb)->pkt_type) {
254				case 0x80:
255					/* control data for the Nokia Card */
256					dtl1_control(info, info->rx_skb);
257					break;
258				case 0x82:
259				case 0x83:
260				case 0x84:
261					/* send frame to the HCI layer */
262					bt_cb(info->rx_skb)->pkt_type &= 0x0f;
263					hci_recv_frame(info->hdev, info->rx_skb);
264					break;
265				default:
266					/* unknown packet */
267					BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info->rx_skb)->pkt_type);
268					kfree_skb(info->rx_skb);
269					break;
270				}
271
272				info->rx_state = RECV_WAIT_NSH;
273				info->rx_count = NSHL;
274				info->rx_skb = NULL;
275				break;
276			}
277
278		}
279
280		/* Make sure we don't stay here too long */
281		if (boguscount++ > 32)
282			break;
283
284	} while (inb(iobase + UART_LSR) & UART_LSR_DR);
285}
286
287
288static irqreturn_t dtl1_interrupt(int irq, void *dev_inst)
289{
290	struct dtl1_info *info = dev_inst;
291	unsigned int iobase;
292	unsigned char msr;
293	int boguscount = 0;
294	int iir, lsr;
295	irqreturn_t r = IRQ_NONE;
296
297	if (!info || !info->hdev)
298		/* our irq handler is shared */
299		return IRQ_NONE;
300
301	iobase = info->p_dev->resource[0]->start;
302
303	spin_lock(&(info->lock));
304
305	iir = inb(iobase + UART_IIR) & UART_IIR_ID;
306	while (iir) {
307
308		r = IRQ_HANDLED;
309		/* Clear interrupt */
310		lsr = inb(iobase + UART_LSR);
311
312		switch (iir) {
313		case UART_IIR_RLSI:
314			BT_ERR("RLSI");
315			break;
316		case UART_IIR_RDI:
317			/* Receive interrupt */
318			dtl1_receive(info);
319			break;
320		case UART_IIR_THRI:
321			if (lsr & UART_LSR_THRE) {
322				/* Transmitter ready for data */
323				dtl1_write_wakeup(info);
324			}
325			break;
326		default:
327			BT_ERR("Unhandled IIR=%#x", iir);
328			break;
329		}
330
331		/* Make sure we don't stay here too long */
332		if (boguscount++ > 100)
333			break;
334
335		iir = inb(iobase + UART_IIR) & UART_IIR_ID;
336
337	}
338
339	msr = inb(iobase + UART_MSR);
340
341	if (info->ri_latch ^ (msr & UART_MSR_RI)) {
342		info->ri_latch = msr & UART_MSR_RI;
343		clear_bit(XMIT_WAITING, &(info->tx_state));
344		dtl1_write_wakeup(info);
345		r = IRQ_HANDLED;
346	}
347
348	spin_unlock(&(info->lock));
349
350	return r;
351}
352
353
354
355/* ======================== HCI interface ======================== */
356
357
358static int dtl1_hci_open(struct hci_dev *hdev)
359{
360	set_bit(HCI_RUNNING, &(hdev->flags));
361
362	return 0;
363}
364
365
366static int dtl1_hci_flush(struct hci_dev *hdev)
367{
368	struct dtl1_info *info = hci_get_drvdata(hdev);
369
370	/* Drop TX queue */
371	skb_queue_purge(&(info->txq));
372
373	return 0;
374}
375
376
377static int dtl1_hci_close(struct hci_dev *hdev)
378{
379	if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
380		return 0;
381
382	dtl1_hci_flush(hdev);
383
384	return 0;
385}
386
387
388static int dtl1_hci_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
389{
390	struct dtl1_info *info = hci_get_drvdata(hdev);
391	struct sk_buff *s;
392	struct nsh nsh;
393
394	switch (bt_cb(skb)->pkt_type) {
395	case HCI_COMMAND_PKT:
396		hdev->stat.cmd_tx++;
397		nsh.type = 0x81;
398		break;
399	case HCI_ACLDATA_PKT:
400		hdev->stat.acl_tx++;
401		nsh.type = 0x82;
402		break;
403	case HCI_SCODATA_PKT:
404		hdev->stat.sco_tx++;
405		nsh.type = 0x83;
406		break;
407	default:
408		return -EILSEQ;
409	};
410
411	nsh.zero = 0;
412	nsh.len = skb->len;
413
414	s = bt_skb_alloc(NSHL + skb->len + 1, GFP_ATOMIC);
415	if (!s)
416		return -ENOMEM;
417
418	skb_reserve(s, NSHL);
419	skb_copy_from_linear_data(skb, skb_put(s, skb->len), skb->len);
420	if (skb->len & 0x0001)
421		*skb_put(s, 1) = 0;	/* PAD */
422
423	/* Prepend skb with Nokia frame header and queue */
424	memcpy(skb_push(s, NSHL), &nsh, NSHL);
425	skb_queue_tail(&(info->txq), s);
426
427	dtl1_write_wakeup(info);
428
429	kfree_skb(skb);
430
431	return 0;
432}
433
434
435
436/* ======================== Card services HCI interaction ======================== */
437
438
439static int dtl1_open(struct dtl1_info *info)
440{
441	unsigned long flags;
442	unsigned int iobase = info->p_dev->resource[0]->start;
443	struct hci_dev *hdev;
444
445	spin_lock_init(&(info->lock));
446
447	skb_queue_head_init(&(info->txq));
448
449	info->rx_state = RECV_WAIT_NSH;
450	info->rx_count = NSHL;
451	info->rx_skb = NULL;
452
453	set_bit(XMIT_WAITING, &(info->tx_state));
454
455	/* Initialize HCI device */
456	hdev = hci_alloc_dev();
457	if (!hdev) {
458		BT_ERR("Can't allocate HCI device");
459		return -ENOMEM;
460	}
461
462	info->hdev = hdev;
463
464	hdev->bus = HCI_PCCARD;
465	hci_set_drvdata(hdev, info);
466	SET_HCIDEV_DEV(hdev, &info->p_dev->dev);
467
468	hdev->open  = dtl1_hci_open;
469	hdev->close = dtl1_hci_close;
470	hdev->flush = dtl1_hci_flush;
471	hdev->send  = dtl1_hci_send_frame;
472
473	spin_lock_irqsave(&(info->lock), flags);
474
475	/* Reset UART */
476	outb(0, iobase + UART_MCR);
477
478	/* Turn off interrupts */
479	outb(0, iobase + UART_IER);
480
481	/* Initialize UART */
482	outb(UART_LCR_WLEN8, iobase + UART_LCR);	/* Reset DLAB */
483	outb((UART_MCR_DTR | UART_MCR_RTS | UART_MCR_OUT2), iobase + UART_MCR);
484
485	info->ri_latch = inb(info->p_dev->resource[0]->start + UART_MSR)
486				& UART_MSR_RI;
487
488	/* Turn on interrupts */
489	outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
490
491	spin_unlock_irqrestore(&(info->lock), flags);
492
493	/* Timeout before it is safe to send the first HCI packet */
494	msleep(2000);
495
496	/* Register HCI device */
497	if (hci_register_dev(hdev) < 0) {
498		BT_ERR("Can't register HCI device");
499		info->hdev = NULL;
500		hci_free_dev(hdev);
501		return -ENODEV;
502	}
503
504	return 0;
505}
506
507
508static int dtl1_close(struct dtl1_info *info)
509{
510	unsigned long flags;
511	unsigned int iobase = info->p_dev->resource[0]->start;
512	struct hci_dev *hdev = info->hdev;
513
514	if (!hdev)
515		return -ENODEV;
516
517	dtl1_hci_close(hdev);
518
519	spin_lock_irqsave(&(info->lock), flags);
520
521	/* Reset UART */
522	outb(0, iobase + UART_MCR);
523
524	/* Turn off interrupts */
525	outb(0, iobase + UART_IER);
526
527	spin_unlock_irqrestore(&(info->lock), flags);
528
529	hci_unregister_dev(hdev);
530	hci_free_dev(hdev);
531
532	return 0;
533}
534
535static int dtl1_probe(struct pcmcia_device *link)
536{
537	struct dtl1_info *info;
538
539	/* Create new info device */
540	info = devm_kzalloc(&link->dev, sizeof(*info), GFP_KERNEL);
541	if (!info)
542		return -ENOMEM;
543
544	info->p_dev = link;
545	link->priv = info;
546
547	link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO;
548
549	return dtl1_config(link);
550}
551
552
553static void dtl1_detach(struct pcmcia_device *link)
554{
555	struct dtl1_info *info = link->priv;
556
557	dtl1_close(info);
558	pcmcia_disable_device(link);
559}
560
561static int dtl1_confcheck(struct pcmcia_device *p_dev, void *priv_data)
562{
563	if ((p_dev->resource[1]->end) || (p_dev->resource[1]->end < 8))
564		return -ENODEV;
565
566	p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
567	p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
568
569	return pcmcia_request_io(p_dev);
570}
571
572static int dtl1_config(struct pcmcia_device *link)
573{
574	struct dtl1_info *info = link->priv;
575	int ret;
576
577	/* Look for a generic full-sized window */
578	link->resource[0]->end = 8;
579	ret = pcmcia_loop_config(link, dtl1_confcheck, NULL);
580	if (ret)
581		goto failed;
582
583	ret = pcmcia_request_irq(link, dtl1_interrupt);
584	if (ret)
585		goto failed;
586
587	ret = pcmcia_enable_device(link);
588	if (ret)
589		goto failed;
590
591	ret = dtl1_open(info);
592	if (ret)
593		goto failed;
594
595	return 0;
596
597failed:
598	dtl1_detach(link);
599	return ret;
600}
601
602static const struct pcmcia_device_id dtl1_ids[] = {
603	PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-1", 0xe1bfdd64, 0xe168480d),
604	PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-4", 0xe1bfdd64, 0x9102bc82),
605	PCMCIA_DEVICE_PROD_ID12("Socket", "CF", 0xb38bcc2e, 0x44ebf863),
606	PCMCIA_DEVICE_PROD_ID12("Socket", "CF+ Personal Network Card", 0xb38bcc2e, 0xe732bae3),
607	PCMCIA_DEVICE_NULL
608};
609MODULE_DEVICE_TABLE(pcmcia, dtl1_ids);
610
611static struct pcmcia_driver dtl1_driver = {
612	.owner		= THIS_MODULE,
613	.name		= "dtl1_cs",
614	.probe		= dtl1_probe,
615	.remove		= dtl1_detach,
616	.id_table	= dtl1_ids,
617};
618module_pcmcia_driver(dtl1_driver);
619