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/completion.h>
21 /* Version Information */
22 #define DRIVER_AUTHOR "Tilman Schmidt"
23 #define DRIVER_DESC "Serial Driver for Gigaset 307x using Siemens M101"
25 #define GIGASET_MINORS 1
26 #define GIGASET_MINOR 0
27 #define GIGASET_MODULENAME "ser_gigaset"
28 #define GIGASET_DEVNAME "ttyGS"
30 /* length limit according to Siemens 3070usb-protokoll.doc ch. 2.1 */
31 #define IF_WRITEBUF 264
33 MODULE_AUTHOR(DRIVER_AUTHOR);
34 MODULE_DESCRIPTION(DRIVER_DESC);
35 MODULE_LICENSE("GPL");
36 MODULE_ALIAS_LDISC(N_GIGASET_M101);
38 static int startmode = SM_ISDN;
39 module_param(startmode, int, S_IRUGO);
40 MODULE_PARM_DESC(startmode, "initial operation mode");
41 static int cidmode = 1;
42 module_param(cidmode, int, S_IRUGO);
43 MODULE_PARM_DESC(cidmode, "stay in CID mode when idle");
45 static struct gigaset_driver *driver;
47 struct ser_cardstate {
48 struct platform_device dev;
49 struct tty_struct *tty;
51 struct completion dead_cmp;
54 static struct platform_driver device_driver = {
56 .name = GIGASET_MODULENAME,
60 static void flush_send_queue(struct cardstate *);
62 /* transmit data from current open skb
63 * result: number of bytes sent or error code < 0
65 static int write_modem(struct cardstate *cs)
67 struct tty_struct *tty = cs->hw.ser->tty;
68 struct bc_state *bcs = &cs->bcs[0]; /* only one channel */
69 struct sk_buff *skb = bcs->tx_skb;
70 int sent = -EOPNOTSUPP;
72 if (!tty || !tty->driver || !skb)
76 dev_kfree_skb_any(skb);
81 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
83 sent = tty->ops->write(tty, skb->data, skb->len);
84 gig_dbg(DEBUG_OUTPUT, "write_modem: sent %d", sent);
92 /* skb sent completely */
93 gigaset_skb_sent(bcs, skb);
95 gig_dbg(DEBUG_INTR, "kfree skb (Adr: %lx)!",
97 dev_kfree_skb_any(skb);
104 * transmit first queued command buffer
105 * result: number of bytes sent or error code < 0
107 static int send_cb(struct cardstate *cs)
109 struct tty_struct *tty = cs->hw.ser->tty;
110 struct cmdbuf_t *cb, *tcb;
114 if (!tty || !tty->driver)
119 return 0; /* nothing to do */
122 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
123 sent = tty->ops->write(tty, cb->buf + cb->offset, cb->len);
126 gig_dbg(DEBUG_OUTPUT, "send_cb: write error %d", sent);
127 flush_send_queue(cs);
132 gig_dbg(DEBUG_OUTPUT, "send_cb: sent %d, left %u, queued %u",
133 sent, cb->len, cs->cmdbytes);
136 while (cb && !cb->len) {
137 spin_lock_irqsave(&cs->cmdlock, flags);
138 cs->cmdbytes -= cs->curlen;
140 cs->cmdbuf = cb = cb->next;
143 cs->curlen = cb->len;
145 cs->lastcmdbuf = NULL;
148 spin_unlock_irqrestore(&cs->cmdlock, flags);
150 if (tcb->wake_tasklet)
151 tasklet_schedule(tcb->wake_tasklet);
159 * If there is already a skb opened, put data to the transfer buffer
160 * by calling "write_modem".
161 * Otherwise take a new skb out of the queue.
163 static void gigaset_modem_fill(unsigned long data)
165 struct cardstate *cs = (struct cardstate *) data;
166 struct bc_state *bcs;
169 if (!cs || !(bcs = cs->bcs)) {
170 gig_dbg(DEBUG_OUTPUT, "%s: no cardstate", __func__);
174 /* no skb is being sent; send command if any */
176 gig_dbg(DEBUG_OUTPUT, "%s: send_cb -> %d", __func__, sent);
178 /* something sent or error */
181 /* no command to send; get skb */
182 if (!(bcs->tx_skb = skb_dequeue(&bcs->squeue)))
183 /* no skb either, nothing to do */
186 gig_dbg(DEBUG_INTR, "Dequeued skb (Adr: %lx)",
187 (unsigned long) bcs->tx_skb);
191 gig_dbg(DEBUG_OUTPUT, "%s: tx_skb", __func__);
192 if (write_modem(cs) < 0)
193 gig_dbg(DEBUG_OUTPUT, "%s: write_modem failed", __func__);
197 * throw away all data queued for sending
199 static void flush_send_queue(struct cardstate *cs)
206 spin_lock_irqsave(&cs->cmdlock, flags);
207 while ((cb = cs->cmdbuf) != NULL) {
208 cs->cmdbuf = cb->next;
209 if (cb->wake_tasklet)
210 tasklet_schedule(cb->wake_tasklet);
213 cs->cmdbuf = cs->lastcmdbuf = NULL;
214 cs->cmdbytes = cs->curlen = 0;
215 spin_unlock_irqrestore(&cs->cmdlock, flags);
219 dev_kfree_skb_any(cs->bcs->tx_skb);
220 while ((skb = skb_dequeue(&cs->bcs->squeue)) != NULL)
221 dev_kfree_skb_any(skb);
225 /* Gigaset Driver Interface */
226 /* ======================== */
229 * queue an AT command string for transmission to the Gigaset device
231 * cs controller state structure
232 * buf buffer containing the string to send
233 * len number of characters to send
234 * wake_tasklet tasklet to run when transmission is complete, or NULL
236 * number of bytes queued, or error code < 0
238 static int gigaset_write_cmd(struct cardstate *cs, const unsigned char *buf,
239 int len, struct tasklet_struct *wake_tasklet)
244 gigaset_dbg_buffer(cs->mstate != MS_LOCKED ?
245 DEBUG_TRANSCMD : DEBUG_LOCKCMD,
246 "CMD Transmit", len, buf);
251 if (!(cb = kmalloc(sizeof(struct cmdbuf_t) + len, GFP_ATOMIC))) {
252 dev_err(cs->dev, "%s: out of memory!\n", __func__);
256 memcpy(cb->buf, buf, len);
260 cb->wake_tasklet = wake_tasklet;
262 spin_lock_irqsave(&cs->cmdlock, flags);
263 cb->prev = cs->lastcmdbuf;
265 cs->lastcmdbuf->next = cb;
272 spin_unlock_irqrestore(&cs->cmdlock, flags);
274 spin_lock_irqsave(&cs->lock, flags);
276 tasklet_schedule(&cs->write_tasklet);
277 spin_unlock_irqrestore(&cs->lock, flags);
282 * tty_driver.write_room interface routine
283 * return number of characters the driver will accept to be written
285 * controller state structure
287 * number of characters
289 static int gigaset_write_room(struct cardstate *cs)
293 bytes = cs->cmdbytes;
294 return bytes < IF_WRITEBUF ? IF_WRITEBUF - bytes : 0;
298 * tty_driver.chars_in_buffer interface routine
299 * return number of characters waiting to be sent
301 * controller state structure
303 * number of characters
305 static int gigaset_chars_in_buffer(struct cardstate *cs)
311 * implementation of ioctl(GIGASET_BRKCHARS)
313 * controller state structure
315 * -EINVAL (unimplemented function)
317 static int gigaset_brkchars(struct cardstate *cs, const unsigned char buf[6])
319 /* not implemented */
325 * Called by "do_action" in ev-layer.c
327 static int gigaset_init_bchannel(struct bc_state *bcs)
329 /* nothing to do for M10x */
330 gigaset_bchannel_up(bcs);
336 * Called by "do_action" in ev-layer.c
338 static int gigaset_close_bchannel(struct bc_state *bcs)
340 /* nothing to do for M10x */
341 gigaset_bchannel_down(bcs);
346 * Set up B channel structure
347 * This is called by "gigaset_initcs" in common.c
349 static int gigaset_initbcshw(struct bc_state *bcs)
357 * Free B channel structure
358 * Called by "gigaset_freebcs" in common.c
360 static int gigaset_freebcshw(struct bc_state *bcs)
367 * Reinitialize B channel structure
368 * This is called by "bcs_reinit" in common.c
370 static void gigaset_reinitbcshw(struct bc_state *bcs)
372 /* nothing to do for M10x */
376 * Free hardware specific device data
377 * This will be called by "gigaset_freecs" in common.c
379 static void gigaset_freecshw(struct cardstate *cs)
381 tasklet_kill(&cs->write_tasklet);
384 dev_set_drvdata(&cs->hw.ser->dev.dev, NULL);
385 platform_device_unregister(&cs->hw.ser->dev);
390 static void gigaset_device_release(struct device *dev)
392 struct platform_device *pdev = to_platform_device(dev);
394 /* adapted from platform_device_release() in drivers/base/platform.c */
395 //FIXME is this actually necessary?
396 kfree(dev->platform_data);
397 kfree(pdev->resource);
401 * Set up hardware specific device data
402 * This is called by "gigaset_initcs" in common.c
404 static int gigaset_initcshw(struct cardstate *cs)
408 if (!(cs->hw.ser = kzalloc(sizeof(struct ser_cardstate), GFP_KERNEL))) {
409 pr_err("out of memory\n");
413 cs->hw.ser->dev.name = GIGASET_MODULENAME;
414 cs->hw.ser->dev.id = cs->minor_index;
415 cs->hw.ser->dev.dev.release = gigaset_device_release;
416 if ((rc = platform_device_register(&cs->hw.ser->dev)) != 0) {
417 pr_err("error %d registering platform device\n", rc);
422 dev_set_drvdata(&cs->hw.ser->dev.dev, cs);
424 tasklet_init(&cs->write_tasklet,
425 &gigaset_modem_fill, (unsigned long) cs);
430 * set modem control lines
432 * card state structure
433 * modem control line state ([TIOCM_DTR]|[TIOCM_RTS])
434 * Called by "gigaset_start" and "gigaset_enterconfigmode" in common.c
435 * and by "if_lock" and "if_termios" in interface.c
437 static int gigaset_set_modem_ctrl(struct cardstate *cs, unsigned old_state, unsigned new_state)
439 struct tty_struct *tty = cs->hw.ser->tty;
440 unsigned int set, clear;
442 if (!tty || !tty->driver || !tty->ops->tiocmset)
444 set = new_state & ~old_state;
445 clear = old_state & ~new_state;
448 gig_dbg(DEBUG_IF, "tiocmset set %x clear %x", set, clear);
449 return tty->ops->tiocmset(tty, NULL, set, clear);
452 static int gigaset_baud_rate(struct cardstate *cs, unsigned cflag)
457 static int gigaset_set_line_ctrl(struct cardstate *cs, unsigned cflag)
462 static const struct gigaset_ops ops = {
465 gigaset_chars_in_buffer,
467 gigaset_init_bchannel,
468 gigaset_close_bchannel,
474 gigaset_set_modem_ctrl,
476 gigaset_set_line_ctrl,
477 gigaset_m10x_send_skb, /* asyncdata.c */
478 gigaset_m10x_input, /* asyncdata.c */
482 /* Line Discipline Interface */
483 /* ========================= */
485 /* helper functions for cardstate refcounting */
486 static struct cardstate *cs_get(struct tty_struct *tty)
488 struct cardstate *cs = tty->disc_data;
490 if (!cs || !cs->hw.ser) {
491 gig_dbg(DEBUG_ANY, "%s: no cardstate", __func__);
494 atomic_inc(&cs->hw.ser->refcnt);
498 static void cs_put(struct cardstate *cs)
500 if (atomic_dec_and_test(&cs->hw.ser->refcnt))
501 complete(&cs->hw.ser->dead_cmp);
505 * Called by the tty driver when the line discipline is pushed onto the tty.
506 * Called in process context.
509 gigaset_tty_open(struct tty_struct *tty)
511 struct cardstate *cs;
513 gig_dbg(DEBUG_INIT, "Starting HLL for Gigaset M101");
515 pr_info(DRIVER_DESC "\n");
518 pr_err("%s: no driver structure\n", __func__);
522 /* allocate memory for our device state and intialize it */
523 if (!(cs = gigaset_initcs(driver, 1, 1, 0, cidmode,
524 GIGASET_MODULENAME)))
527 cs->dev = &cs->hw.ser->dev.dev;
528 cs->hw.ser->tty = tty;
529 atomic_set(&cs->hw.ser->refcnt, 1);
530 init_completion(&cs->hw.ser->dead_cmp);
534 /* OK.. Initialization of the datastructures and the HW is done.. Now
535 * startup system and notify the LL that we are ready to run
537 if (startmode == SM_LOCKED)
538 cs->mstate = MS_LOCKED;
539 if (!gigaset_start(cs)) {
540 tasklet_kill(&cs->write_tasklet);
544 gig_dbg(DEBUG_INIT, "Startup of HLL done");
548 gig_dbg(DEBUG_INIT, "Startup of HLL failed");
549 tty->disc_data = NULL;
555 * Called by the tty driver when the line discipline is removed.
556 * Called from process context.
559 gigaset_tty_close(struct tty_struct *tty)
561 struct cardstate *cs = tty->disc_data;
563 gig_dbg(DEBUG_INIT, "Stopping HLL for Gigaset M101");
566 gig_dbg(DEBUG_INIT, "%s: no cardstate", __func__);
570 /* prevent other callers from entering ldisc methods */
571 tty->disc_data = NULL;
574 pr_err("%s: no hw cardstate\n", __func__);
576 /* wait for running methods to finish */
577 if (!atomic_dec_and_test(&cs->hw.ser->refcnt))
578 wait_for_completion(&cs->hw.ser->dead_cmp);
581 /* stop operations */
583 tasklet_kill(&cs->write_tasklet);
584 flush_send_queue(cs);
588 gig_dbg(DEBUG_INIT, "Shutdown of HLL done");
592 * Called by the tty driver when the tty line is hung up.
593 * Wait for I/O to driver to complete and unregister ISDN device.
594 * This is already done by the close routine, so just call that.
595 * Called from process context.
597 static int gigaset_tty_hangup(struct tty_struct *tty)
599 gigaset_tty_close(tty);
605 * Unused, received data goes only to the Gigaset driver.
608 gigaset_tty_read(struct tty_struct *tty, struct file *file,
609 unsigned char __user *buf, size_t count)
616 * Unused, transmit data comes only from the Gigaset driver.
619 gigaset_tty_write(struct tty_struct *tty, struct file *file,
620 const unsigned char *buf, size_t count)
627 * Called in process context only.
628 * May be re-entered by multiple ioctl calling threads.
631 gigaset_tty_ioctl(struct tty_struct *tty, struct file *file,
632 unsigned int cmd, unsigned long arg)
634 struct cardstate *cs = cs_get(tty);
636 int __user *p = (int __user *)arg;
644 /* unused, always return zero */
646 rc = put_user(val, p);
650 /* flush our buffers and the serial port's buffer */
653 /* no own input buffer to flush */
657 flush_send_queue(cs);
663 /* pass through to underlying serial device */
664 rc = n_tty_ioctl_helper(tty, file, cmd, arg);
672 * Called by the tty driver when a block of data has been received.
673 * Will not be re-entered while running but other ldisc functions
674 * may be called in parallel.
675 * Can be called from hard interrupt level as well as soft interrupt
679 * buf buffer containing received characters
680 * cflags buffer containing error flags for received characters (ignored)
681 * count number of received characters
684 gigaset_tty_receive(struct tty_struct *tty, const unsigned char *buf,
685 char *cflags, int count)
687 struct cardstate *cs = cs_get(tty);
688 unsigned tail, head, n;
689 struct inbuf_t *inbuf;
693 if (!(inbuf = cs->inbuf)) {
694 dev_err(cs->dev, "%s: no inbuf\n", __func__);
701 gig_dbg(DEBUG_INTR, "buffer state: %u -> %u, receive %u bytes",
705 /* possible buffer wraparound */
706 n = min_t(unsigned, count, RBUFSIZE - tail);
707 memcpy(inbuf->data + tail, buf, n);
708 tail = (tail + n) % RBUFSIZE;
714 /* tail < head and some data left */
718 "inbuf overflow, discarding %d bytes\n",
722 memcpy(inbuf->data + tail, buf, count);
726 gig_dbg(DEBUG_INTR, "setting tail to %u", tail);
729 /* Everything was received .. Push data into handler */
730 gig_dbg(DEBUG_INTR, "%s-->BH", __func__);
731 gigaset_schedule_event(cs);
736 * Called by the tty driver when there's room for more data to send.
739 gigaset_tty_wakeup(struct tty_struct *tty)
741 struct cardstate *cs = cs_get(tty);
743 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
746 tasklet_schedule(&cs->write_tasklet);
750 static struct tty_ldisc_ops gigaset_ldisc = {
751 .owner = THIS_MODULE,
752 .magic = TTY_LDISC_MAGIC,
753 .name = "ser_gigaset",
754 .open = gigaset_tty_open,
755 .close = gigaset_tty_close,
756 .hangup = gigaset_tty_hangup,
757 .read = gigaset_tty_read,
758 .write = gigaset_tty_write,
759 .ioctl = gigaset_tty_ioctl,
760 .receive_buf = gigaset_tty_receive,
761 .write_wakeup = gigaset_tty_wakeup,
765 /* Initialization / Shutdown */
766 /* ========================= */
768 static int __init ser_gigaset_init(void)
772 gig_dbg(DEBUG_INIT, "%s", __func__);
773 if ((rc = platform_driver_register(&device_driver)) != 0) {
774 pr_err("error %d registering platform driver\n", rc);
778 /* allocate memory for our driver state and intialize it */
779 if (!(driver = gigaset_initdriver(GIGASET_MINOR, GIGASET_MINORS,
780 GIGASET_MODULENAME, GIGASET_DEVNAME,
784 if ((rc = tty_register_ldisc(N_GIGASET_M101, &gigaset_ldisc)) != 0) {
785 pr_err("error %d registering line discipline\n", rc);
793 gigaset_freedriver(driver);
796 platform_driver_unregister(&device_driver);
800 static void __exit ser_gigaset_exit(void)
804 gig_dbg(DEBUG_INIT, "%s", __func__);
807 gigaset_freedriver(driver);
811 if ((rc = tty_unregister_ldisc(N_GIGASET_M101)) != 0)
812 pr_err("error %d unregistering line discipline\n", rc);
814 platform_driver_unregister(&device_driver);
817 module_init(ser_gigaset_init);
818 module_exit(ser_gigaset_exit);