1 /* This is the serial hardware link layer (HLL) for the Gigaset 307x isdn
2 * DECT base (aka Sinus 45 isdn) using the RS232 DECT data module M101,
3 * written as a line discipline.
5 * =====================================================================
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
10 * =====================================================================
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/platform_device.h>
18 #include <linux/tty.h>
19 #include <linux/poll.h>
20 #include <linux/completion.h>
22 /* Version Information */
23 #define DRIVER_AUTHOR "Tilman Schmidt"
24 #define DRIVER_DESC "Serial Driver for Gigaset 307x using Siemens M101"
26 #define GIGASET_MINORS 1
27 #define GIGASET_MINOR 0
28 #define GIGASET_MODULENAME "ser_gigaset"
29 #define GIGASET_DEVNAME "ttyGS"
31 /* length limit according to Siemens 3070usb-protokoll.doc ch. 2.1 */
32 #define IF_WRITEBUF 264
34 MODULE_AUTHOR(DRIVER_AUTHOR);
35 MODULE_DESCRIPTION(DRIVER_DESC);
36 MODULE_LICENSE("GPL");
37 MODULE_ALIAS_LDISC(N_GIGASET_M101);
39 static int startmode = SM_ISDN;
40 module_param(startmode, int, S_IRUGO);
41 MODULE_PARM_DESC(startmode, "initial operation mode");
42 static int cidmode = 1;
43 module_param(cidmode, int, S_IRUGO);
44 MODULE_PARM_DESC(cidmode, "stay in CID mode when idle");
46 static struct gigaset_driver *driver;
48 struct ser_cardstate {
49 struct platform_device dev;
50 struct tty_struct *tty;
52 struct completion dead_cmp;
55 static struct platform_driver device_driver = {
57 .name = GIGASET_MODULENAME,
61 static void flush_send_queue(struct cardstate *);
63 /* transmit data from current open skb
64 * result: number of bytes sent or error code < 0
66 static int write_modem(struct cardstate *cs)
68 struct tty_struct *tty = cs->hw.ser->tty;
69 struct bc_state *bcs = &cs->bcs[0]; /* only one channel */
70 struct sk_buff *skb = bcs->tx_skb;
71 int sent = -EOPNOTSUPP;
73 if (!tty || !tty->driver || !skb)
77 dev_kfree_skb_any(skb);
82 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
84 sent = tty->ops->write(tty, skb->data, skb->len);
85 gig_dbg(DEBUG_OUTPUT, "write_modem: sent %d", sent);
93 /* skb sent completely */
94 gigaset_skb_sent(bcs, skb);
96 gig_dbg(DEBUG_INTR, "kfree skb (Adr: %lx)!",
98 dev_kfree_skb_any(skb);
105 * transmit first queued command buffer
106 * result: number of bytes sent or error code < 0
108 static int send_cb(struct cardstate *cs)
110 struct tty_struct *tty = cs->hw.ser->tty;
111 struct cmdbuf_t *cb, *tcb;
115 if (!tty || !tty->driver)
120 return 0; /* nothing to do */
123 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
124 sent = tty->ops->write(tty, cb->buf + cb->offset, cb->len);
127 gig_dbg(DEBUG_OUTPUT, "send_cb: write error %d", sent);
128 flush_send_queue(cs);
133 gig_dbg(DEBUG_OUTPUT, "send_cb: sent %d, left %u, queued %u",
134 sent, cb->len, cs->cmdbytes);
137 while (cb && !cb->len) {
138 spin_lock_irqsave(&cs->cmdlock, flags);
139 cs->cmdbytes -= cs->curlen;
141 cs->cmdbuf = cb = cb->next;
144 cs->curlen = cb->len;
146 cs->lastcmdbuf = NULL;
149 spin_unlock_irqrestore(&cs->cmdlock, flags);
151 if (tcb->wake_tasklet)
152 tasklet_schedule(tcb->wake_tasklet);
160 * If there is already a skb opened, put data to the transfer buffer
161 * by calling "write_modem".
162 * Otherwise take a new skb out of the queue.
164 static void gigaset_modem_fill(unsigned long data)
166 struct cardstate *cs = (struct cardstate *) data;
167 struct bc_state *bcs;
170 if (!cs || !(bcs = cs->bcs)) {
171 gig_dbg(DEBUG_OUTPUT, "%s: no cardstate", __func__);
175 /* no skb is being sent; send command if any */
177 gig_dbg(DEBUG_OUTPUT, "%s: send_cb -> %d", __func__, sent);
179 /* something sent or error */
182 /* no command to send; get skb */
183 if (!(bcs->tx_skb = skb_dequeue(&bcs->squeue)))
184 /* no skb either, nothing to do */
187 gig_dbg(DEBUG_INTR, "Dequeued skb (Adr: %lx)",
188 (unsigned long) bcs->tx_skb);
192 gig_dbg(DEBUG_OUTPUT, "%s: tx_skb", __func__);
193 if (write_modem(cs) < 0)
194 gig_dbg(DEBUG_OUTPUT, "%s: write_modem failed", __func__);
198 * throw away all data queued for sending
200 static void flush_send_queue(struct cardstate *cs)
207 spin_lock_irqsave(&cs->cmdlock, flags);
208 while ((cb = cs->cmdbuf) != NULL) {
209 cs->cmdbuf = cb->next;
210 if (cb->wake_tasklet)
211 tasklet_schedule(cb->wake_tasklet);
214 cs->cmdbuf = cs->lastcmdbuf = NULL;
215 cs->cmdbytes = cs->curlen = 0;
216 spin_unlock_irqrestore(&cs->cmdlock, flags);
220 dev_kfree_skb_any(cs->bcs->tx_skb);
221 while ((skb = skb_dequeue(&cs->bcs->squeue)) != NULL)
222 dev_kfree_skb_any(skb);
226 /* Gigaset Driver Interface */
227 /* ======================== */
230 * queue an AT command string for transmission to the Gigaset device
232 * cs controller state structure
233 * buf buffer containing the string to send
234 * len number of characters to send
235 * wake_tasklet tasklet to run when transmission is complete, or NULL
237 * number of bytes queued, or error code < 0
239 static int gigaset_write_cmd(struct cardstate *cs, const unsigned char *buf,
240 int len, struct tasklet_struct *wake_tasklet)
245 gigaset_dbg_buffer(cs->mstate != MS_LOCKED ?
246 DEBUG_TRANSCMD : DEBUG_LOCKCMD,
247 "CMD Transmit", len, buf);
252 if (!(cb = kmalloc(sizeof(struct cmdbuf_t) + len, GFP_ATOMIC))) {
253 dev_err(cs->dev, "%s: out of memory!\n", __func__);
257 memcpy(cb->buf, buf, len);
261 cb->wake_tasklet = wake_tasklet;
263 spin_lock_irqsave(&cs->cmdlock, flags);
264 cb->prev = cs->lastcmdbuf;
266 cs->lastcmdbuf->next = cb;
273 spin_unlock_irqrestore(&cs->cmdlock, flags);
275 spin_lock_irqsave(&cs->lock, flags);
277 tasklet_schedule(&cs->write_tasklet);
278 spin_unlock_irqrestore(&cs->lock, flags);
283 * tty_driver.write_room interface routine
284 * return number of characters the driver will accept to be written
286 * controller state structure
288 * number of characters
290 static int gigaset_write_room(struct cardstate *cs)
294 bytes = cs->cmdbytes;
295 return bytes < IF_WRITEBUF ? IF_WRITEBUF - bytes : 0;
299 * tty_driver.chars_in_buffer interface routine
300 * return number of characters waiting to be sent
302 * controller state structure
304 * number of characters
306 static int gigaset_chars_in_buffer(struct cardstate *cs)
312 * implementation of ioctl(GIGASET_BRKCHARS)
314 * controller state structure
316 * -EINVAL (unimplemented function)
318 static int gigaset_brkchars(struct cardstate *cs, const unsigned char buf[6])
320 /* not implemented */
326 * Called by "do_action" in ev-layer.c
328 static int gigaset_init_bchannel(struct bc_state *bcs)
330 /* nothing to do for M10x */
331 gigaset_bchannel_up(bcs);
337 * Called by "do_action" in ev-layer.c
339 static int gigaset_close_bchannel(struct bc_state *bcs)
341 /* nothing to do for M10x */
342 gigaset_bchannel_down(bcs);
347 * Set up B channel structure
348 * This is called by "gigaset_initcs" in common.c
350 static int gigaset_initbcshw(struct bc_state *bcs)
358 * Free B channel structure
359 * Called by "gigaset_freebcs" in common.c
361 static int gigaset_freebcshw(struct bc_state *bcs)
368 * Reinitialize B channel structure
369 * This is called by "bcs_reinit" in common.c
371 static void gigaset_reinitbcshw(struct bc_state *bcs)
373 /* nothing to do for M10x */
377 * Free hardware specific device data
378 * This will be called by "gigaset_freecs" in common.c
380 static void gigaset_freecshw(struct cardstate *cs)
382 tasklet_kill(&cs->write_tasklet);
385 dev_set_drvdata(&cs->hw.ser->dev.dev, NULL);
386 platform_device_unregister(&cs->hw.ser->dev);
391 static void gigaset_device_release(struct device *dev)
393 struct platform_device *pdev =
394 container_of(dev, struct platform_device, dev);
396 /* adapted from platform_device_release() in drivers/base/platform.c */
397 //FIXME is this actually necessary?
398 kfree(dev->platform_data);
399 kfree(pdev->resource);
403 * Set up hardware specific device data
404 * This is called by "gigaset_initcs" in common.c
406 static int gigaset_initcshw(struct cardstate *cs)
410 if (!(cs->hw.ser = kzalloc(sizeof(struct ser_cardstate), GFP_KERNEL))) {
411 err("%s: out of memory!", __func__);
415 cs->hw.ser->dev.name = GIGASET_MODULENAME;
416 cs->hw.ser->dev.id = cs->minor_index;
417 cs->hw.ser->dev.dev.release = gigaset_device_release;
418 if ((rc = platform_device_register(&cs->hw.ser->dev)) != 0) {
419 err("error %d registering platform device", rc);
424 dev_set_drvdata(&cs->hw.ser->dev.dev, cs);
426 tasklet_init(&cs->write_tasklet,
427 &gigaset_modem_fill, (unsigned long) cs);
432 * set modem control lines
434 * card state structure
435 * modem control line state ([TIOCM_DTR]|[TIOCM_RTS])
436 * Called by "gigaset_start" and "gigaset_enterconfigmode" in common.c
437 * and by "if_lock" and "if_termios" in interface.c
439 static int gigaset_set_modem_ctrl(struct cardstate *cs, unsigned old_state, unsigned new_state)
441 struct tty_struct *tty = cs->hw.ser->tty;
442 unsigned int set, clear;
444 if (!tty || !tty->driver || !tty->ops->tiocmset)
446 set = new_state & ~old_state;
447 clear = old_state & ~new_state;
450 gig_dbg(DEBUG_IF, "tiocmset set %x clear %x", set, clear);
451 return tty->ops->tiocmset(tty, NULL, set, clear);
454 static int gigaset_baud_rate(struct cardstate *cs, unsigned cflag)
459 static int gigaset_set_line_ctrl(struct cardstate *cs, unsigned cflag)
464 static const struct gigaset_ops ops = {
467 gigaset_chars_in_buffer,
469 gigaset_init_bchannel,
470 gigaset_close_bchannel,
476 gigaset_set_modem_ctrl,
478 gigaset_set_line_ctrl,
479 gigaset_m10x_send_skb, /* asyncdata.c */
480 gigaset_m10x_input, /* asyncdata.c */
484 /* Line Discipline Interface */
485 /* ========================= */
487 /* helper functions for cardstate refcounting */
488 static struct cardstate *cs_get(struct tty_struct *tty)
490 struct cardstate *cs = tty->disc_data;
492 if (!cs || !cs->hw.ser) {
493 gig_dbg(DEBUG_ANY, "%s: no cardstate", __func__);
496 atomic_inc(&cs->hw.ser->refcnt);
500 static void cs_put(struct cardstate *cs)
502 if (atomic_dec_and_test(&cs->hw.ser->refcnt))
503 complete(&cs->hw.ser->dead_cmp);
507 * Called by the tty driver when the line discipline is pushed onto the tty.
508 * Called in process context.
511 gigaset_tty_open(struct tty_struct *tty)
513 struct cardstate *cs;
515 gig_dbg(DEBUG_INIT, "Starting HLL for Gigaset M101");
521 err("%s: no driver structure", __func__);
525 /* allocate memory for our device state and intialize it */
526 if (!(cs = gigaset_initcs(driver, 1, 1, 0, cidmode,
527 GIGASET_MODULENAME)))
530 cs->dev = &cs->hw.ser->dev.dev;
531 cs->hw.ser->tty = tty;
532 atomic_set(&cs->hw.ser->refcnt, 1);
533 init_completion(&cs->hw.ser->dead_cmp);
537 /* OK.. Initialization of the datastructures and the HW is done.. Now
538 * startup system and notify the LL that we are ready to run
540 if (startmode == SM_LOCKED)
541 cs->mstate = MS_LOCKED;
542 if (!gigaset_start(cs)) {
543 tasklet_kill(&cs->write_tasklet);
547 gig_dbg(DEBUG_INIT, "Startup of HLL done");
551 gig_dbg(DEBUG_INIT, "Startup of HLL failed");
552 tty->disc_data = NULL;
558 * Called by the tty driver when the line discipline is removed.
559 * Called from process context.
562 gigaset_tty_close(struct tty_struct *tty)
564 struct cardstate *cs = tty->disc_data;
566 gig_dbg(DEBUG_INIT, "Stopping HLL for Gigaset M101");
569 gig_dbg(DEBUG_INIT, "%s: no cardstate", __func__);
573 /* prevent other callers from entering ldisc methods */
574 tty->disc_data = NULL;
577 err("%s: no hw cardstate", __func__);
579 /* wait for running methods to finish */
580 if (!atomic_dec_and_test(&cs->hw.ser->refcnt))
581 wait_for_completion(&cs->hw.ser->dead_cmp);
584 /* stop operations */
586 tasklet_kill(&cs->write_tasklet);
587 flush_send_queue(cs);
591 gig_dbg(DEBUG_INIT, "Shutdown of HLL done");
595 * Called by the tty driver when the tty line is hung up.
596 * Wait for I/O to driver to complete and unregister ISDN device.
597 * This is already done by the close routine, so just call that.
598 * Called from process context.
600 static int gigaset_tty_hangup(struct tty_struct *tty)
602 gigaset_tty_close(tty);
608 * Unused, received data goes only to the Gigaset driver.
611 gigaset_tty_read(struct tty_struct *tty, struct file *file,
612 unsigned char __user *buf, size_t count)
619 * Unused, transmit data comes only from the Gigaset driver.
622 gigaset_tty_write(struct tty_struct *tty, struct file *file,
623 const unsigned char *buf, size_t count)
630 * Called in process context only.
631 * May be re-entered by multiple ioctl calling threads.
634 gigaset_tty_ioctl(struct tty_struct *tty, struct file *file,
635 unsigned int cmd, unsigned long arg)
637 struct cardstate *cs = cs_get(tty);
639 int __user *p = (int __user *)arg;
647 /* pass through to underlying serial device */
648 rc = n_tty_ioctl(tty, file, cmd, arg);
652 /* flush our buffers and the serial port's buffer */
655 /* no own input buffer to flush */
659 flush_send_queue(cs);
662 /* flush the serial port's buffer */
663 rc = n_tty_ioctl(tty, file, cmd, arg);
667 /* unused, always return zero */
669 rc = put_user(val, p);
682 * Unused, always return zero.
685 gigaset_tty_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
691 * Called by the tty driver when a block of data has been received.
692 * Will not be re-entered while running but other ldisc functions
693 * may be called in parallel.
694 * Can be called from hard interrupt level as well as soft interrupt
698 * buf buffer containing received characters
699 * cflags buffer containing error flags for received characters (ignored)
700 * count number of received characters
703 gigaset_tty_receive(struct tty_struct *tty, const unsigned char *buf,
704 char *cflags, int count)
706 struct cardstate *cs = cs_get(tty);
707 unsigned tail, head, n;
708 struct inbuf_t *inbuf;
712 if (!(inbuf = cs->inbuf)) {
713 dev_err(cs->dev, "%s: no inbuf\n", __func__);
720 gig_dbg(DEBUG_INTR, "buffer state: %u -> %u, receive %u bytes",
724 /* possible buffer wraparound */
725 n = min_t(unsigned, count, RBUFSIZE - tail);
726 memcpy(inbuf->data + tail, buf, n);
727 tail = (tail + n) % RBUFSIZE;
733 /* tail < head and some data left */
737 "inbuf overflow, discarding %d bytes\n",
741 memcpy(inbuf->data + tail, buf, count);
745 gig_dbg(DEBUG_INTR, "setting tail to %u", tail);
748 /* Everything was received .. Push data into handler */
749 gig_dbg(DEBUG_INTR, "%s-->BH", __func__);
750 gigaset_schedule_event(cs);
755 * Called by the tty driver when there's room for more data to send.
758 gigaset_tty_wakeup(struct tty_struct *tty)
760 struct cardstate *cs = cs_get(tty);
762 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
765 tasklet_schedule(&cs->write_tasklet);
769 static struct tty_ldisc gigaset_ldisc = {
770 .owner = THIS_MODULE,
771 .magic = TTY_LDISC_MAGIC,
772 .name = "ser_gigaset",
773 .open = gigaset_tty_open,
774 .close = gigaset_tty_close,
775 .hangup = gigaset_tty_hangup,
776 .read = gigaset_tty_read,
777 .write = gigaset_tty_write,
778 .ioctl = gigaset_tty_ioctl,
779 .poll = gigaset_tty_poll,
780 .receive_buf = gigaset_tty_receive,
781 .write_wakeup = gigaset_tty_wakeup,
785 /* Initialization / Shutdown */
786 /* ========================= */
788 static int __init ser_gigaset_init(void)
792 gig_dbg(DEBUG_INIT, "%s", __func__);
793 if ((rc = platform_driver_register(&device_driver)) != 0) {
794 err("error %d registering platform driver", rc);
798 /* allocate memory for our driver state and intialize it */
799 if (!(driver = gigaset_initdriver(GIGASET_MINOR, GIGASET_MINORS,
800 GIGASET_MODULENAME, GIGASET_DEVNAME,
804 if ((rc = tty_register_ldisc(N_GIGASET_M101, &gigaset_ldisc)) != 0) {
805 err("error %d registering line discipline", rc);
813 gigaset_freedriver(driver);
816 platform_driver_unregister(&device_driver);
820 static void __exit ser_gigaset_exit(void)
824 gig_dbg(DEBUG_INIT, "%s", __func__);
827 gigaset_freedriver(driver);
831 if ((rc = tty_unregister_ldisc(N_GIGASET_M101)) != 0)
832 err("error %d unregistering line discipline", rc);
834 platform_driver_unregister(&device_driver);
837 module_init(ser_gigaset_init);
838 module_exit(ser_gigaset_exit);