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 * =====================================================================
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/platform_device.h>
17 #include <linux/completion.h>
19 /* Version Information */
20 #define DRIVER_AUTHOR "Tilman Schmidt"
21 #define DRIVER_DESC "Serial Driver for Gigaset 307x using Siemens M101"
23 #define GIGASET_MINORS 1
24 #define GIGASET_MINOR 0
25 #define GIGASET_MODULENAME "ser_gigaset"
26 #define GIGASET_DEVNAME "ttyGS"
28 /* length limit according to Siemens 3070usb-protokoll.doc ch. 2.1 */
29 #define IF_WRITEBUF 264
31 MODULE_AUTHOR(DRIVER_AUTHOR
);
32 MODULE_DESCRIPTION(DRIVER_DESC
);
33 MODULE_LICENSE("GPL");
34 MODULE_ALIAS_LDISC(N_GIGASET_M101
);
36 static int startmode
= SM_ISDN
;
37 module_param(startmode
, int, S_IRUGO
);
38 MODULE_PARM_DESC(startmode
, "initial operation mode");
39 static int cidmode
= 1;
40 module_param(cidmode
, int, S_IRUGO
);
41 MODULE_PARM_DESC(cidmode
, "stay in CID mode when idle");
43 static struct gigaset_driver
*driver
;
45 struct ser_cardstate
{
46 struct platform_device dev
;
47 struct tty_struct
*tty
;
49 struct completion dead_cmp
;
52 static struct platform_driver device_driver
= {
54 .name
= GIGASET_MODULENAME
,
58 static void flush_send_queue(struct cardstate
*);
60 /* transmit data from current open skb
61 * result: number of bytes sent or error code < 0
63 static int write_modem(struct cardstate
*cs
)
65 struct tty_struct
*tty
= cs
->hw
.ser
->tty
;
66 struct bc_state
*bcs
= &cs
->bcs
[0]; /* only one channel */
67 struct sk_buff
*skb
= bcs
->tx_skb
;
68 int sent
= -EOPNOTSUPP
;
70 if (!tty
|| !tty
->driver
|| !skb
)
74 dev_kfree_skb_any(skb
);
79 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
81 sent
= tty
->ops
->write(tty
, skb
->data
, skb
->len
);
82 gig_dbg(DEBUG_OUTPUT
, "write_modem: sent %d", sent
);
90 /* skb sent completely */
91 gigaset_skb_sent(bcs
, skb
);
93 gig_dbg(DEBUG_INTR
, "kfree skb (Adr: %lx)!",
95 dev_kfree_skb_any(skb
);
102 * transmit first queued command buffer
103 * result: number of bytes sent or error code < 0
105 static int send_cb(struct cardstate
*cs
)
107 struct tty_struct
*tty
= cs
->hw
.ser
->tty
;
108 struct cmdbuf_t
*cb
, *tcb
;
112 if (!tty
|| !tty
->driver
)
117 return 0; /* nothing to do */
120 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
121 sent
= tty
->ops
->write(tty
, cb
->buf
+ cb
->offset
, cb
->len
);
124 gig_dbg(DEBUG_OUTPUT
, "send_cb: write error %d", sent
);
125 flush_send_queue(cs
);
130 gig_dbg(DEBUG_OUTPUT
, "send_cb: sent %d, left %u, queued %u",
131 sent
, cb
->len
, cs
->cmdbytes
);
134 while (cb
&& !cb
->len
) {
135 spin_lock_irqsave(&cs
->cmdlock
, flags
);
136 cs
->cmdbytes
-= cs
->curlen
;
138 cs
->cmdbuf
= cb
= cb
->next
;
141 cs
->curlen
= cb
->len
;
143 cs
->lastcmdbuf
= NULL
;
146 spin_unlock_irqrestore(&cs
->cmdlock
, flags
);
148 if (tcb
->wake_tasklet
)
149 tasklet_schedule(tcb
->wake_tasklet
);
157 * If there is already a skb opened, put data to the transfer buffer
158 * by calling "write_modem".
159 * Otherwise take a new skb out of the queue.
161 static void gigaset_modem_fill(unsigned long data
)
163 struct cardstate
*cs
= (struct cardstate
*) data
;
164 struct bc_state
*bcs
;
165 struct sk_buff
*nextskb
;
169 gig_dbg(DEBUG_OUTPUT
, "%s: no cardstate", __func__
);
174 gig_dbg(DEBUG_OUTPUT
, "%s: no cardstate", __func__
);
178 /* no skb is being sent; send command if any */
180 gig_dbg(DEBUG_OUTPUT
, "%s: send_cb -> %d", __func__
, sent
);
182 /* something sent or error */
185 /* no command to send; get skb */
186 nextskb
= skb_dequeue(&bcs
->squeue
);
188 /* no skb either, nothing to do */
190 bcs
->tx_skb
= nextskb
;
192 gig_dbg(DEBUG_INTR
, "Dequeued skb (Adr: %lx)",
193 (unsigned long) bcs
->tx_skb
);
197 gig_dbg(DEBUG_OUTPUT
, "%s: tx_skb", __func__
);
198 if (write_modem(cs
) < 0)
199 gig_dbg(DEBUG_OUTPUT
, "%s: write_modem failed", __func__
);
203 * throw away all data queued for sending
205 static void flush_send_queue(struct cardstate
*cs
)
212 spin_lock_irqsave(&cs
->cmdlock
, flags
);
213 while ((cb
= cs
->cmdbuf
) != NULL
) {
214 cs
->cmdbuf
= cb
->next
;
215 if (cb
->wake_tasklet
)
216 tasklet_schedule(cb
->wake_tasklet
);
219 cs
->cmdbuf
= cs
->lastcmdbuf
= NULL
;
220 cs
->cmdbytes
= cs
->curlen
= 0;
221 spin_unlock_irqrestore(&cs
->cmdlock
, flags
);
225 dev_kfree_skb_any(cs
->bcs
->tx_skb
);
226 while ((skb
= skb_dequeue(&cs
->bcs
->squeue
)) != NULL
)
227 dev_kfree_skb_any(skb
);
231 /* Gigaset Driver Interface */
232 /* ======================== */
235 * queue an AT command string for transmission to the Gigaset device
237 * cs controller state structure
238 * buf buffer containing the string to send
239 * len number of characters to send
240 * wake_tasklet tasklet to run when transmission is complete, or NULL
242 * number of bytes queued, or error code < 0
244 static int gigaset_write_cmd(struct cardstate
*cs
, struct cmdbuf_t
*cb
)
248 gigaset_dbg_buffer(cs
->mstate
!= MS_LOCKED
?
249 DEBUG_TRANSCMD
: DEBUG_LOCKCMD
,
250 "CMD Transmit", cb
->len
, cb
->buf
);
252 spin_lock_irqsave(&cs
->cmdlock
, flags
);
253 cb
->prev
= cs
->lastcmdbuf
;
255 cs
->lastcmdbuf
->next
= cb
;
258 cs
->curlen
= cb
->len
;
260 cs
->cmdbytes
+= cb
->len
;
262 spin_unlock_irqrestore(&cs
->cmdlock
, flags
);
264 spin_lock_irqsave(&cs
->lock
, flags
);
266 tasklet_schedule(&cs
->write_tasklet
);
267 spin_unlock_irqrestore(&cs
->lock
, flags
);
272 * tty_driver.write_room interface routine
273 * return number of characters the driver will accept to be written
275 * controller state structure
277 * number of characters
279 static int gigaset_write_room(struct cardstate
*cs
)
283 bytes
= cs
->cmdbytes
;
284 return bytes
< IF_WRITEBUF
? IF_WRITEBUF
- bytes
: 0;
288 * tty_driver.chars_in_buffer interface routine
289 * return number of characters waiting to be sent
291 * controller state structure
293 * number of characters
295 static int gigaset_chars_in_buffer(struct cardstate
*cs
)
301 * implementation of ioctl(GIGASET_BRKCHARS)
303 * controller state structure
305 * -EINVAL (unimplemented function)
307 static int gigaset_brkchars(struct cardstate
*cs
, const unsigned char buf
[6])
309 /* not implemented */
315 * Called by "do_action" in ev-layer.c
317 static int gigaset_init_bchannel(struct bc_state
*bcs
)
319 /* nothing to do for M10x */
320 gigaset_bchannel_up(bcs
);
326 * Called by "do_action" in ev-layer.c
328 static int gigaset_close_bchannel(struct bc_state
*bcs
)
330 /* nothing to do for M10x */
331 gigaset_bchannel_down(bcs
);
336 * Set up B channel structure
337 * This is called by "gigaset_initcs" in common.c
339 static int gigaset_initbcshw(struct bc_state
*bcs
)
347 * Free B channel structure
348 * Called by "gigaset_freebcs" in common.c
350 static void gigaset_freebcshw(struct bc_state
*bcs
)
356 * Reinitialize B channel structure
357 * This is called by "bcs_reinit" in common.c
359 static void gigaset_reinitbcshw(struct bc_state
*bcs
)
361 /* nothing to do for M10x */
365 * Free hardware specific device data
366 * This will be called by "gigaset_freecs" in common.c
368 static void gigaset_freecshw(struct cardstate
*cs
)
370 tasklet_kill(&cs
->write_tasklet
);
373 dev_set_drvdata(&cs
->hw
.ser
->dev
.dev
, NULL
);
374 platform_device_unregister(&cs
->hw
.ser
->dev
);
379 static void gigaset_device_release(struct device
*dev
)
381 struct platform_device
*pdev
= to_platform_device(dev
);
383 /* adapted from platform_device_release() in drivers/base/platform.c */
384 kfree(dev
->platform_data
);
385 kfree(pdev
->resource
);
389 * Set up hardware specific device data
390 * This is called by "gigaset_initcs" in common.c
392 static int gigaset_initcshw(struct cardstate
*cs
)
395 struct ser_cardstate
*scs
;
397 scs
= kzalloc(sizeof(struct ser_cardstate
), GFP_KERNEL
);
399 pr_err("out of memory\n");
404 cs
->hw
.ser
->dev
.name
= GIGASET_MODULENAME
;
405 cs
->hw
.ser
->dev
.id
= cs
->minor_index
;
406 cs
->hw
.ser
->dev
.dev
.release
= gigaset_device_release
;
407 rc
= platform_device_register(&cs
->hw
.ser
->dev
);
409 pr_err("error %d registering platform device\n", rc
);
414 dev_set_drvdata(&cs
->hw
.ser
->dev
.dev
, cs
);
416 tasklet_init(&cs
->write_tasklet
,
417 gigaset_modem_fill
, (unsigned long) cs
);
422 * set modem control lines
424 * card state structure
425 * modem control line state ([TIOCM_DTR]|[TIOCM_RTS])
426 * Called by "gigaset_start" and "gigaset_enterconfigmode" in common.c
427 * and by "if_lock" and "if_termios" in interface.c
429 static int gigaset_set_modem_ctrl(struct cardstate
*cs
, unsigned old_state
,
432 struct tty_struct
*tty
= cs
->hw
.ser
->tty
;
433 unsigned int set
, clear
;
435 if (!tty
|| !tty
->driver
|| !tty
->ops
->tiocmset
)
437 set
= new_state
& ~old_state
;
438 clear
= old_state
& ~new_state
;
441 gig_dbg(DEBUG_IF
, "tiocmset set %x clear %x", set
, clear
);
442 return tty
->ops
->tiocmset(tty
, set
, clear
);
445 static int gigaset_baud_rate(struct cardstate
*cs
, unsigned cflag
)
450 static int gigaset_set_line_ctrl(struct cardstate
*cs
, unsigned cflag
)
455 static const struct gigaset_ops ops
= {
458 gigaset_chars_in_buffer
,
460 gigaset_init_bchannel
,
461 gigaset_close_bchannel
,
467 gigaset_set_modem_ctrl
,
469 gigaset_set_line_ctrl
,
470 gigaset_m10x_send_skb
, /* asyncdata.c */
471 gigaset_m10x_input
, /* asyncdata.c */
475 /* Line Discipline Interface */
476 /* ========================= */
478 /* helper functions for cardstate refcounting */
479 static struct cardstate
*cs_get(struct tty_struct
*tty
)
481 struct cardstate
*cs
= tty
->disc_data
;
483 if (!cs
|| !cs
->hw
.ser
) {
484 gig_dbg(DEBUG_ANY
, "%s: no cardstate", __func__
);
487 atomic_inc(&cs
->hw
.ser
->refcnt
);
491 static void cs_put(struct cardstate
*cs
)
493 if (atomic_dec_and_test(&cs
->hw
.ser
->refcnt
))
494 complete(&cs
->hw
.ser
->dead_cmp
);
498 * Called by the tty driver when the line discipline is pushed onto the tty.
499 * Called in process context.
502 gigaset_tty_open(struct tty_struct
*tty
)
504 struct cardstate
*cs
;
507 gig_dbg(DEBUG_INIT
, "Starting HLL for Gigaset M101");
509 pr_info(DRIVER_DESC
"\n");
512 pr_err("%s: no driver structure\n", __func__
);
516 /* allocate memory for our device state and initialize it */
517 cs
= gigaset_initcs(driver
, 1, 1, 0, cidmode
, GIGASET_MODULENAME
);
523 cs
->dev
= &cs
->hw
.ser
->dev
.dev
;
524 cs
->hw
.ser
->tty
= tty
;
525 atomic_set(&cs
->hw
.ser
->refcnt
, 1);
526 init_completion(&cs
->hw
.ser
->dead_cmp
);
530 /* OK.. Initialization of the datastructures and the HW is done.. Now
531 * startup system and notify the LL that we are ready to run
533 if (startmode
== SM_LOCKED
)
534 cs
->mstate
= MS_LOCKED
;
535 rc
= gigaset_start(cs
);
537 tasklet_kill(&cs
->write_tasklet
);
541 gig_dbg(DEBUG_INIT
, "Startup of HLL done");
545 gig_dbg(DEBUG_INIT
, "Startup of HLL failed");
546 tty
->disc_data
= NULL
;
552 * Called by the tty driver when the line discipline is removed.
553 * Called from process context.
556 gigaset_tty_close(struct tty_struct
*tty
)
558 struct cardstate
*cs
= tty
->disc_data
;
560 gig_dbg(DEBUG_INIT
, "Stopping HLL for Gigaset M101");
563 gig_dbg(DEBUG_INIT
, "%s: no cardstate", __func__
);
567 /* prevent other callers from entering ldisc methods */
568 tty
->disc_data
= NULL
;
571 pr_err("%s: no hw cardstate\n", __func__
);
573 /* wait for running methods to finish */
574 if (!atomic_dec_and_test(&cs
->hw
.ser
->refcnt
))
575 wait_for_completion(&cs
->hw
.ser
->dead_cmp
);
578 /* stop operations */
580 tasklet_kill(&cs
->write_tasklet
);
581 flush_send_queue(cs
);
585 gig_dbg(DEBUG_INIT
, "Shutdown of HLL done");
589 * Called by the tty driver when the tty line is hung up.
590 * Wait for I/O to driver to complete and unregister ISDN device.
591 * This is already done by the close routine, so just call that.
592 * Called from process context.
594 static int gigaset_tty_hangup(struct tty_struct
*tty
)
596 gigaset_tty_close(tty
);
602 * Unused, received data goes only to the Gigaset driver.
605 gigaset_tty_read(struct tty_struct
*tty
, struct file
*file
,
606 unsigned char __user
*buf
, size_t count
)
613 * Unused, transmit data comes only from the Gigaset driver.
616 gigaset_tty_write(struct tty_struct
*tty
, struct file
*file
,
617 const unsigned char *buf
, size_t count
)
624 * Called in process context only.
625 * May be re-entered by multiple ioctl calling threads.
628 gigaset_tty_ioctl(struct tty_struct
*tty
, struct file
*file
,
629 unsigned int cmd
, unsigned long arg
)
631 struct cardstate
*cs
= cs_get(tty
);
633 int __user
*p
= (int __user
*)arg
;
641 /* unused, always return zero */
643 rc
= put_user(val
, p
);
647 /* flush our buffers and the serial port's buffer */
650 /* no own input buffer to flush */
654 flush_send_queue(cs
);
660 /* pass through to underlying serial device */
661 rc
= n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
669 * Called by the tty driver when a block of data has been received.
670 * Will not be re-entered while running but other ldisc functions
671 * may be called in parallel.
672 * Can be called from hard interrupt level as well as soft interrupt
676 * buf buffer containing received characters
677 * cflags buffer containing error flags for received characters (ignored)
678 * count number of received characters
681 gigaset_tty_receive(struct tty_struct
*tty
, const unsigned char *buf
,
682 char *cflags
, int count
)
684 struct cardstate
*cs
= cs_get(tty
);
685 unsigned tail
, head
, n
;
686 struct inbuf_t
*inbuf
;
692 dev_err(cs
->dev
, "%s: no inbuf\n", __func__
);
699 gig_dbg(DEBUG_INTR
, "buffer state: %u -> %u, receive %u bytes",
703 /* possible buffer wraparound */
704 n
= min_t(unsigned, count
, RBUFSIZE
- tail
);
705 memcpy(inbuf
->data
+ tail
, buf
, n
);
706 tail
= (tail
+ n
) % RBUFSIZE
;
712 /* tail < head and some data left */
716 "inbuf overflow, discarding %d bytes\n",
720 memcpy(inbuf
->data
+ tail
, buf
, count
);
724 gig_dbg(DEBUG_INTR
, "setting tail to %u", tail
);
727 /* Everything was received .. Push data into handler */
728 gig_dbg(DEBUG_INTR
, "%s-->BH", __func__
);
729 gigaset_schedule_event(cs
);
734 * Called by the tty driver when there's room for more data to send.
737 gigaset_tty_wakeup(struct tty_struct
*tty
)
739 struct cardstate
*cs
= cs_get(tty
);
741 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
744 tasklet_schedule(&cs
->write_tasklet
);
748 static struct tty_ldisc_ops gigaset_ldisc
= {
749 .owner
= THIS_MODULE
,
750 .magic
= TTY_LDISC_MAGIC
,
751 .name
= "ser_gigaset",
752 .open
= gigaset_tty_open
,
753 .close
= gigaset_tty_close
,
754 .hangup
= gigaset_tty_hangup
,
755 .read
= gigaset_tty_read
,
756 .write
= gigaset_tty_write
,
757 .ioctl
= gigaset_tty_ioctl
,
758 .receive_buf
= gigaset_tty_receive
,
759 .write_wakeup
= gigaset_tty_wakeup
,
763 /* Initialization / Shutdown */
764 /* ========================= */
766 static int __init
ser_gigaset_init(void)
770 gig_dbg(DEBUG_INIT
, "%s", __func__
);
771 rc
= platform_driver_register(&device_driver
);
773 pr_err("error %d registering platform driver\n", rc
);
777 /* allocate memory for our driver state and initialize it */
778 driver
= gigaset_initdriver(GIGASET_MINOR
, GIGASET_MINORS
,
779 GIGASET_MODULENAME
, GIGASET_DEVNAME
,
784 rc
= tty_register_ldisc(N_GIGASET_M101
, &gigaset_ldisc
);
786 pr_err("error %d registering line discipline\n", rc
);
794 gigaset_freedriver(driver
);
797 platform_driver_unregister(&device_driver
);
801 static void __exit
ser_gigaset_exit(void)
805 gig_dbg(DEBUG_INIT
, "%s", __func__
);
808 gigaset_freedriver(driver
);
812 rc
= tty_unregister_ldisc(N_GIGASET_M101
);
814 pr_err("error %d unregistering line discipline\n", rc
);
816 platform_driver_unregister(&device_driver
);
819 module_init(ser_gigaset_init
);
820 module_exit(ser_gigaset_exit
);