Linux 4.9.237
[linux/fpc-iii.git] / drivers / tty / n_gsm.c
blob1ab9bd4335421227dbb0795b36ff4803c6b780b8
1 /*
2 * n_gsm.c GSM 0710 tty multiplexor
3 * Copyright (c) 2009/10 Intel Corporation
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 * * THIS IS A DEVELOPMENT SNAPSHOT IT IS NOT A FINAL RELEASE *
20 * TO DO:
21 * Mostly done: ioctls for setting modes/timing
22 * Partly done: hooks so you can pull off frames to non tty devs
23 * Restart DLCI 0 when it closes ?
24 * Improve the tx engine
25 * Resolve tx side locking by adding a queue_head and routing
26 * all control traffic via it
27 * General tidy/document
28 * Review the locking/move to refcounts more (mux now moved to an
29 * alloc/free model ready)
30 * Use newest tty open/close port helpers and install hooks
31 * What to do about power functions ?
32 * Termios setting and negotiation
33 * Do we need a 'which mux are you' ioctl to correlate mux and tty sets
37 #include <linux/types.h>
38 #include <linux/major.h>
39 #include <linux/errno.h>
40 #include <linux/signal.h>
41 #include <linux/fcntl.h>
42 #include <linux/sched.h>
43 #include <linux/interrupt.h>
44 #include <linux/tty.h>
45 #include <linux/ctype.h>
46 #include <linux/mm.h>
47 #include <linux/string.h>
48 #include <linux/slab.h>
49 #include <linux/poll.h>
50 #include <linux/bitops.h>
51 #include <linux/file.h>
52 #include <linux/uaccess.h>
53 #include <linux/module.h>
54 #include <linux/timer.h>
55 #include <linux/tty_flip.h>
56 #include <linux/tty_driver.h>
57 #include <linux/serial.h>
58 #include <linux/kfifo.h>
59 #include <linux/skbuff.h>
60 #include <net/arp.h>
61 #include <linux/ip.h>
62 #include <linux/netdevice.h>
63 #include <linux/etherdevice.h>
64 #include <linux/gsmmux.h>
66 static int debug;
67 module_param(debug, int, 0600);
69 /* Defaults: these are from the specification */
71 #define T1 10 /* 100mS */
72 #define T2 34 /* 333mS */
73 #define N2 3 /* Retry 3 times */
75 /* Use long timers for testing at low speed with debug on */
76 #ifdef DEBUG_TIMING
77 #define T1 100
78 #define T2 200
79 #endif
82 * Semi-arbitrary buffer size limits. 0710 is normally run with 32-64 byte
83 * limits so this is plenty
85 #define MAX_MRU 1500
86 #define MAX_MTU 1500
87 #define GSM_NET_TX_TIMEOUT (HZ*10)
89 /**
90 * struct gsm_mux_net - network interface
91 * @struct gsm_dlci* dlci
92 * @struct net_device_stats stats;
94 * Created when net interface is initialized.
95 **/
96 struct gsm_mux_net {
97 struct kref ref;
98 struct gsm_dlci *dlci;
99 struct net_device_stats stats;
102 #define STATS(net) (((struct gsm_mux_net *)netdev_priv(net))->stats)
105 * Each block of data we have queued to go out is in the form of
106 * a gsm_msg which holds everything we need in a link layer independent
107 * format
110 struct gsm_msg {
111 struct list_head list;
112 u8 addr; /* DLCI address + flags */
113 u8 ctrl; /* Control byte + flags */
114 unsigned int len; /* Length of data block (can be zero) */
115 unsigned char *data; /* Points into buffer but not at the start */
116 unsigned char buffer[0];
120 * Each active data link has a gsm_dlci structure associated which ties
121 * the link layer to an optional tty (if the tty side is open). To avoid
122 * complexity right now these are only ever freed up when the mux is
123 * shut down.
125 * At the moment we don't free DLCI objects until the mux is torn down
126 * this avoid object life time issues but might be worth review later.
129 struct gsm_dlci {
130 struct gsm_mux *gsm;
131 int addr;
132 int state;
133 #define DLCI_CLOSED 0
134 #define DLCI_OPENING 1 /* Sending SABM not seen UA */
135 #define DLCI_OPEN 2 /* SABM/UA complete */
136 #define DLCI_CLOSING 3 /* Sending DISC not seen UA/DM */
137 struct mutex mutex;
139 /* Link layer */
140 int mode;
141 #define DLCI_MODE_ABM 0 /* Normal Asynchronous Balanced Mode */
142 #define DLCI_MODE_ADM 1 /* Asynchronous Disconnected Mode */
143 spinlock_t lock; /* Protects the internal state */
144 struct timer_list t1; /* Retransmit timer for SABM and UA */
145 int retries;
146 /* Uplink tty if active */
147 struct tty_port port; /* The tty bound to this DLCI if there is one */
148 struct kfifo *fifo; /* Queue fifo for the DLCI */
149 struct kfifo _fifo; /* For new fifo API porting only */
150 int adaption; /* Adaption layer in use */
151 int prev_adaption;
152 u32 modem_rx; /* Our incoming virtual modem lines */
153 u32 modem_tx; /* Our outgoing modem lines */
154 int dead; /* Refuse re-open */
155 /* Flow control */
156 int throttled; /* Private copy of throttle state */
157 int constipated; /* Throttle status for outgoing */
158 /* Packetised I/O */
159 struct sk_buff *skb; /* Frame being sent */
160 struct sk_buff_head skb_list; /* Queued frames */
161 /* Data handling callback */
162 void (*data)(struct gsm_dlci *dlci, u8 *data, int len);
163 void (*prev_data)(struct gsm_dlci *dlci, u8 *data, int len);
164 struct net_device *net; /* network interface, if created */
167 /* DLCI 0, 62/63 are special or reserved see gsmtty_open */
169 #define NUM_DLCI 64
172 * DLCI 0 is used to pass control blocks out of band of the data
173 * flow (and with a higher link priority). One command can be outstanding
174 * at a time and we use this structure to manage them. They are created
175 * and destroyed by the user context, and updated by the receive paths
176 * and timers
179 struct gsm_control {
180 u8 cmd; /* Command we are issuing */
181 u8 *data; /* Data for the command in case we retransmit */
182 int len; /* Length of block for retransmission */
183 int done; /* Done flag */
184 int error; /* Error if any */
188 * Each GSM mux we have is represented by this structure. If we are
189 * operating as an ldisc then we use this structure as our ldisc
190 * state. We need to sort out lifetimes and locking with respect
191 * to the gsm mux array. For now we don't free DLCI objects that
192 * have been instantiated until the mux itself is terminated.
194 * To consider further: tty open versus mux shutdown.
197 struct gsm_mux {
198 struct tty_struct *tty; /* The tty our ldisc is bound to */
199 spinlock_t lock;
200 struct mutex mutex;
201 unsigned int num;
202 struct kref ref;
204 /* Events on the GSM channel */
205 wait_queue_head_t event;
207 /* Bits for GSM mode decoding */
209 /* Framing Layer */
210 unsigned char *buf;
211 int state;
212 #define GSM_SEARCH 0
213 #define GSM_START 1
214 #define GSM_ADDRESS 2
215 #define GSM_CONTROL 3
216 #define GSM_LEN 4
217 #define GSM_DATA 5
218 #define GSM_FCS 6
219 #define GSM_OVERRUN 7
220 #define GSM_LEN0 8
221 #define GSM_LEN1 9
222 #define GSM_SSOF 10
223 unsigned int len;
224 unsigned int address;
225 unsigned int count;
226 int escape;
227 int encoding;
228 u8 control;
229 u8 fcs;
230 u8 received_fcs;
231 u8 *txframe; /* TX framing buffer */
233 /* Methods for the receiver side */
234 void (*receive)(struct gsm_mux *gsm, u8 ch);
235 void (*error)(struct gsm_mux *gsm, u8 ch, u8 flag);
236 /* And transmit side */
237 int (*output)(struct gsm_mux *mux, u8 *data, int len);
239 /* Link Layer */
240 unsigned int mru;
241 unsigned int mtu;
242 int initiator; /* Did we initiate connection */
243 int dead; /* Has the mux been shut down */
244 struct gsm_dlci *dlci[NUM_DLCI];
245 int constipated; /* Asked by remote to shut up */
247 spinlock_t tx_lock;
248 unsigned int tx_bytes; /* TX data outstanding */
249 #define TX_THRESH_HI 8192
250 #define TX_THRESH_LO 2048
251 struct list_head tx_list; /* Pending data packets */
253 /* Control messages */
254 struct timer_list t2_timer; /* Retransmit timer for commands */
255 int cretries; /* Command retry counter */
256 struct gsm_control *pending_cmd;/* Our current pending command */
257 spinlock_t control_lock; /* Protects the pending command */
259 /* Configuration */
260 int adaption; /* 1 or 2 supported */
261 u8 ftype; /* UI or UIH */
262 int t1, t2; /* Timers in 1/100th of a sec */
263 int n2; /* Retry count */
265 /* Statistics (not currently exposed) */
266 unsigned long bad_fcs;
267 unsigned long malformed;
268 unsigned long io_error;
269 unsigned long bad_size;
270 unsigned long unsupported;
275 * Mux objects - needed so that we can translate a tty index into the
276 * relevant mux and DLCI.
279 #define MAX_MUX 4 /* 256 minors */
280 static struct gsm_mux *gsm_mux[MAX_MUX]; /* GSM muxes */
281 static spinlock_t gsm_mux_lock;
283 static struct tty_driver *gsm_tty_driver;
286 * This section of the driver logic implements the GSM encodings
287 * both the basic and the 'advanced'. Reliable transport is not
288 * supported.
291 #define CR 0x02
292 #define EA 0x01
293 #define PF 0x10
295 /* I is special: the rest are ..*/
296 #define RR 0x01
297 #define UI 0x03
298 #define RNR 0x05
299 #define REJ 0x09
300 #define DM 0x0F
301 #define SABM 0x2F
302 #define DISC 0x43
303 #define UA 0x63
304 #define UIH 0xEF
306 /* Channel commands */
307 #define CMD_NSC 0x09
308 #define CMD_TEST 0x11
309 #define CMD_PSC 0x21
310 #define CMD_RLS 0x29
311 #define CMD_FCOFF 0x31
312 #define CMD_PN 0x41
313 #define CMD_RPN 0x49
314 #define CMD_FCON 0x51
315 #define CMD_CLD 0x61
316 #define CMD_SNC 0x69
317 #define CMD_MSC 0x71
319 /* Virtual modem bits */
320 #define MDM_FC 0x01
321 #define MDM_RTC 0x02
322 #define MDM_RTR 0x04
323 #define MDM_IC 0x20
324 #define MDM_DV 0x40
326 #define GSM0_SOF 0xF9
327 #define GSM1_SOF 0x7E
328 #define GSM1_ESCAPE 0x7D
329 #define GSM1_ESCAPE_BITS 0x20
330 #define XON 0x11
331 #define XOFF 0x13
333 static const struct tty_port_operations gsm_port_ops;
336 * CRC table for GSM 0710
339 static const u8 gsm_fcs8[256] = {
340 0x00, 0x91, 0xE3, 0x72, 0x07, 0x96, 0xE4, 0x75,
341 0x0E, 0x9F, 0xED, 0x7C, 0x09, 0x98, 0xEA, 0x7B,
342 0x1C, 0x8D, 0xFF, 0x6E, 0x1B, 0x8A, 0xF8, 0x69,
343 0x12, 0x83, 0xF1, 0x60, 0x15, 0x84, 0xF6, 0x67,
344 0x38, 0xA9, 0xDB, 0x4A, 0x3F, 0xAE, 0xDC, 0x4D,
345 0x36, 0xA7, 0xD5, 0x44, 0x31, 0xA0, 0xD2, 0x43,
346 0x24, 0xB5, 0xC7, 0x56, 0x23, 0xB2, 0xC0, 0x51,
347 0x2A, 0xBB, 0xC9, 0x58, 0x2D, 0xBC, 0xCE, 0x5F,
348 0x70, 0xE1, 0x93, 0x02, 0x77, 0xE6, 0x94, 0x05,
349 0x7E, 0xEF, 0x9D, 0x0C, 0x79, 0xE8, 0x9A, 0x0B,
350 0x6C, 0xFD, 0x8F, 0x1E, 0x6B, 0xFA, 0x88, 0x19,
351 0x62, 0xF3, 0x81, 0x10, 0x65, 0xF4, 0x86, 0x17,
352 0x48, 0xD9, 0xAB, 0x3A, 0x4F, 0xDE, 0xAC, 0x3D,
353 0x46, 0xD7, 0xA5, 0x34, 0x41, 0xD0, 0xA2, 0x33,
354 0x54, 0xC5, 0xB7, 0x26, 0x53, 0xC2, 0xB0, 0x21,
355 0x5A, 0xCB, 0xB9, 0x28, 0x5D, 0xCC, 0xBE, 0x2F,
356 0xE0, 0x71, 0x03, 0x92, 0xE7, 0x76, 0x04, 0x95,
357 0xEE, 0x7F, 0x0D, 0x9C, 0xE9, 0x78, 0x0A, 0x9B,
358 0xFC, 0x6D, 0x1F, 0x8E, 0xFB, 0x6A, 0x18, 0x89,
359 0xF2, 0x63, 0x11, 0x80, 0xF5, 0x64, 0x16, 0x87,
360 0xD8, 0x49, 0x3B, 0xAA, 0xDF, 0x4E, 0x3C, 0xAD,
361 0xD6, 0x47, 0x35, 0xA4, 0xD1, 0x40, 0x32, 0xA3,
362 0xC4, 0x55, 0x27, 0xB6, 0xC3, 0x52, 0x20, 0xB1,
363 0xCA, 0x5B, 0x29, 0xB8, 0xCD, 0x5C, 0x2E, 0xBF,
364 0x90, 0x01, 0x73, 0xE2, 0x97, 0x06, 0x74, 0xE5,
365 0x9E, 0x0F, 0x7D, 0xEC, 0x99, 0x08, 0x7A, 0xEB,
366 0x8C, 0x1D, 0x6F, 0xFE, 0x8B, 0x1A, 0x68, 0xF9,
367 0x82, 0x13, 0x61, 0xF0, 0x85, 0x14, 0x66, 0xF7,
368 0xA8, 0x39, 0x4B, 0xDA, 0xAF, 0x3E, 0x4C, 0xDD,
369 0xA6, 0x37, 0x45, 0xD4, 0xA1, 0x30, 0x42, 0xD3,
370 0xB4, 0x25, 0x57, 0xC6, 0xB3, 0x22, 0x50, 0xC1,
371 0xBA, 0x2B, 0x59, 0xC8, 0xBD, 0x2C, 0x5E, 0xCF
374 #define INIT_FCS 0xFF
375 #define GOOD_FCS 0xCF
378 * gsm_fcs_add - update FCS
379 * @fcs: Current FCS
380 * @c: Next data
382 * Update the FCS to include c. Uses the algorithm in the specification
383 * notes.
386 static inline u8 gsm_fcs_add(u8 fcs, u8 c)
388 return gsm_fcs8[fcs ^ c];
392 * gsm_fcs_add_block - update FCS for a block
393 * @fcs: Current FCS
394 * @c: buffer of data
395 * @len: length of buffer
397 * Update the FCS to include c. Uses the algorithm in the specification
398 * notes.
401 static inline u8 gsm_fcs_add_block(u8 fcs, u8 *c, int len)
403 while (len--)
404 fcs = gsm_fcs8[fcs ^ *c++];
405 return fcs;
409 * gsm_read_ea - read a byte into an EA
410 * @val: variable holding value
411 * c: byte going into the EA
413 * Processes one byte of an EA. Updates the passed variable
414 * and returns 1 if the EA is now completely read
417 static int gsm_read_ea(unsigned int *val, u8 c)
419 /* Add the next 7 bits into the value */
420 *val <<= 7;
421 *val |= c >> 1;
422 /* Was this the last byte of the EA 1 = yes*/
423 return c & EA;
427 * gsm_encode_modem - encode modem data bits
428 * @dlci: DLCI to encode from
430 * Returns the correct GSM encoded modem status bits (6 bit field) for
431 * the current status of the DLCI and attached tty object
434 static u8 gsm_encode_modem(const struct gsm_dlci *dlci)
436 u8 modembits = 0;
437 /* FC is true flow control not modem bits */
438 if (dlci->throttled)
439 modembits |= MDM_FC;
440 if (dlci->modem_tx & TIOCM_DTR)
441 modembits |= MDM_RTC;
442 if (dlci->modem_tx & TIOCM_RTS)
443 modembits |= MDM_RTR;
444 if (dlci->modem_tx & TIOCM_RI)
445 modembits |= MDM_IC;
446 if (dlci->modem_tx & TIOCM_CD)
447 modembits |= MDM_DV;
448 return modembits;
452 * gsm_print_packet - display a frame for debug
453 * @hdr: header to print before decode
454 * @addr: address EA from the frame
455 * @cr: C/R bit from the frame
456 * @control: control including PF bit
457 * @data: following data bytes
458 * @dlen: length of data
460 * Displays a packet in human readable format for debugging purposes. The
461 * style is based on amateur radio LAP-B dump display.
464 static void gsm_print_packet(const char *hdr, int addr, int cr,
465 u8 control, const u8 *data, int dlen)
467 if (!(debug & 1))
468 return;
470 pr_info("%s %d) %c: ", hdr, addr, "RC"[cr]);
472 switch (control & ~PF) {
473 case SABM:
474 pr_cont("SABM");
475 break;
476 case UA:
477 pr_cont("UA");
478 break;
479 case DISC:
480 pr_cont("DISC");
481 break;
482 case DM:
483 pr_cont("DM");
484 break;
485 case UI:
486 pr_cont("UI");
487 break;
488 case UIH:
489 pr_cont("UIH");
490 break;
491 default:
492 if (!(control & 0x01)) {
493 pr_cont("I N(S)%d N(R)%d",
494 (control & 0x0E) >> 1, (control & 0xE0) >> 5);
495 } else switch (control & 0x0F) {
496 case RR:
497 pr_cont("RR(%d)", (control & 0xE0) >> 5);
498 break;
499 case RNR:
500 pr_cont("RNR(%d)", (control & 0xE0) >> 5);
501 break;
502 case REJ:
503 pr_cont("REJ(%d)", (control & 0xE0) >> 5);
504 break;
505 default:
506 pr_cont("[%02X]", control);
510 if (control & PF)
511 pr_cont("(P)");
512 else
513 pr_cont("(F)");
515 if (dlen) {
516 int ct = 0;
517 while (dlen--) {
518 if (ct % 8 == 0) {
519 pr_cont("\n");
520 pr_debug(" ");
522 pr_cont("%02X ", *data++);
523 ct++;
526 pr_cont("\n");
531 * Link level transmission side
535 * gsm_stuff_packet - bytestuff a packet
536 * @ibuf: input
537 * @obuf: output
538 * @len: length of input
540 * Expand a buffer by bytestuffing it. The worst case size change
541 * is doubling and the caller is responsible for handing out
542 * suitable sized buffers.
545 static int gsm_stuff_frame(const u8 *input, u8 *output, int len)
547 int olen = 0;
548 while (len--) {
549 if (*input == GSM1_SOF || *input == GSM1_ESCAPE
550 || *input == XON || *input == XOFF) {
551 *output++ = GSM1_ESCAPE;
552 *output++ = *input++ ^ GSM1_ESCAPE_BITS;
553 olen++;
554 } else
555 *output++ = *input++;
556 olen++;
558 return olen;
562 * gsm_send - send a control frame
563 * @gsm: our GSM mux
564 * @addr: address for control frame
565 * @cr: command/response bit
566 * @control: control byte including PF bit
568 * Format up and transmit a control frame. These do not go via the
569 * queueing logic as they should be transmitted ahead of data when
570 * they are needed.
572 * FIXME: Lock versus data TX path
575 static void gsm_send(struct gsm_mux *gsm, int addr, int cr, int control)
577 int len;
578 u8 cbuf[10];
579 u8 ibuf[3];
581 switch (gsm->encoding) {
582 case 0:
583 cbuf[0] = GSM0_SOF;
584 cbuf[1] = (addr << 2) | (cr << 1) | EA;
585 cbuf[2] = control;
586 cbuf[3] = EA; /* Length of data = 0 */
587 cbuf[4] = 0xFF - gsm_fcs_add_block(INIT_FCS, cbuf + 1, 3);
588 cbuf[5] = GSM0_SOF;
589 len = 6;
590 break;
591 case 1:
592 case 2:
593 /* Control frame + packing (but not frame stuffing) in mode 1 */
594 ibuf[0] = (addr << 2) | (cr << 1) | EA;
595 ibuf[1] = control;
596 ibuf[2] = 0xFF - gsm_fcs_add_block(INIT_FCS, ibuf, 2);
597 /* Stuffing may double the size worst case */
598 len = gsm_stuff_frame(ibuf, cbuf + 1, 3);
599 /* Now add the SOF markers */
600 cbuf[0] = GSM1_SOF;
601 cbuf[len + 1] = GSM1_SOF;
602 /* FIXME: we can omit the lead one in many cases */
603 len += 2;
604 break;
605 default:
606 WARN_ON(1);
607 return;
609 gsm->output(gsm, cbuf, len);
610 gsm_print_packet("-->", addr, cr, control, NULL, 0);
614 * gsm_response - send a control response
615 * @gsm: our GSM mux
616 * @addr: address for control frame
617 * @control: control byte including PF bit
619 * Format up and transmit a link level response frame.
622 static inline void gsm_response(struct gsm_mux *gsm, int addr, int control)
624 gsm_send(gsm, addr, 0, control);
628 * gsm_command - send a control command
629 * @gsm: our GSM mux
630 * @addr: address for control frame
631 * @control: control byte including PF bit
633 * Format up and transmit a link level command frame.
636 static inline void gsm_command(struct gsm_mux *gsm, int addr, int control)
638 gsm_send(gsm, addr, 1, control);
641 /* Data transmission */
643 #define HDR_LEN 6 /* ADDR CTRL [LEN.2] DATA FCS */
646 * gsm_data_alloc - allocate data frame
647 * @gsm: GSM mux
648 * @addr: DLCI address
649 * @len: length excluding header and FCS
650 * @ctrl: control byte
652 * Allocate a new data buffer for sending frames with data. Space is left
653 * at the front for header bytes but that is treated as an implementation
654 * detail and not for the high level code to use
657 static struct gsm_msg *gsm_data_alloc(struct gsm_mux *gsm, u8 addr, int len,
658 u8 ctrl)
660 struct gsm_msg *m = kmalloc(sizeof(struct gsm_msg) + len + HDR_LEN,
661 GFP_ATOMIC);
662 if (m == NULL)
663 return NULL;
664 m->data = m->buffer + HDR_LEN - 1; /* Allow for FCS */
665 m->len = len;
666 m->addr = addr;
667 m->ctrl = ctrl;
668 INIT_LIST_HEAD(&m->list);
669 return m;
673 * gsm_data_kick - poke the queue
674 * @gsm: GSM Mux
676 * The tty device has called us to indicate that room has appeared in
677 * the transmit queue. Ram more data into the pipe if we have any
678 * If we have been flow-stopped by a CMD_FCOFF, then we can only
679 * send messages on DLCI0 until CMD_FCON
681 * FIXME: lock against link layer control transmissions
684 static void gsm_data_kick(struct gsm_mux *gsm, struct gsm_dlci *dlci)
686 struct gsm_msg *msg, *nmsg;
687 int len;
689 list_for_each_entry_safe(msg, nmsg, &gsm->tx_list, list) {
690 if (gsm->constipated && msg->addr)
691 continue;
692 if (gsm->encoding != 0) {
693 gsm->txframe[0] = GSM1_SOF;
694 len = gsm_stuff_frame(msg->data,
695 gsm->txframe + 1, msg->len);
696 gsm->txframe[len + 1] = GSM1_SOF;
697 len += 2;
698 } else {
699 gsm->txframe[0] = GSM0_SOF;
700 memcpy(gsm->txframe + 1 , msg->data, msg->len);
701 gsm->txframe[msg->len + 1] = GSM0_SOF;
702 len = msg->len + 2;
705 if (debug & 4)
706 print_hex_dump_bytes("gsm_data_kick: ",
707 DUMP_PREFIX_OFFSET,
708 gsm->txframe, len);
709 if (gsm->output(gsm, gsm->txframe, len) < 0)
710 break;
711 /* FIXME: Can eliminate one SOF in many more cases */
712 gsm->tx_bytes -= msg->len;
714 list_del(&msg->list);
715 kfree(msg);
717 if (dlci) {
718 tty_port_tty_wakeup(&dlci->port);
719 } else {
720 int i = 0;
722 for (i = 0; i < NUM_DLCI; i++)
723 if (gsm->dlci[i])
724 tty_port_tty_wakeup(&gsm->dlci[i]->port);
730 * __gsm_data_queue - queue a UI or UIH frame
731 * @dlci: DLCI sending the data
732 * @msg: message queued
734 * Add data to the transmit queue and try and get stuff moving
735 * out of the mux tty if not already doing so. The Caller must hold
736 * the gsm tx lock.
739 static void __gsm_data_queue(struct gsm_dlci *dlci, struct gsm_msg *msg)
741 struct gsm_mux *gsm = dlci->gsm;
742 u8 *dp = msg->data;
743 u8 *fcs = dp + msg->len;
745 /* Fill in the header */
746 if (gsm->encoding == 0) {
747 if (msg->len < 128)
748 *--dp = (msg->len << 1) | EA;
749 else {
750 *--dp = (msg->len >> 7); /* bits 7 - 15 */
751 *--dp = (msg->len & 127) << 1; /* bits 0 - 6 */
755 *--dp = msg->ctrl;
756 if (gsm->initiator)
757 *--dp = (msg->addr << 2) | 2 | EA;
758 else
759 *--dp = (msg->addr << 2) | EA;
760 *fcs = gsm_fcs_add_block(INIT_FCS, dp , msg->data - dp);
761 /* Ugly protocol layering violation */
762 if (msg->ctrl == UI || msg->ctrl == (UI|PF))
763 *fcs = gsm_fcs_add_block(*fcs, msg->data, msg->len);
764 *fcs = 0xFF - *fcs;
766 gsm_print_packet("Q> ", msg->addr, gsm->initiator, msg->ctrl,
767 msg->data, msg->len);
769 /* Move the header back and adjust the length, also allow for the FCS
770 now tacked on the end */
771 msg->len += (msg->data - dp) + 1;
772 msg->data = dp;
774 /* Add to the actual output queue */
775 list_add_tail(&msg->list, &gsm->tx_list);
776 gsm->tx_bytes += msg->len;
777 gsm_data_kick(gsm, dlci);
781 * gsm_data_queue - queue a UI or UIH frame
782 * @dlci: DLCI sending the data
783 * @msg: message queued
785 * Add data to the transmit queue and try and get stuff moving
786 * out of the mux tty if not already doing so. Take the
787 * the gsm tx lock and dlci lock.
790 static void gsm_data_queue(struct gsm_dlci *dlci, struct gsm_msg *msg)
792 unsigned long flags;
793 spin_lock_irqsave(&dlci->gsm->tx_lock, flags);
794 __gsm_data_queue(dlci, msg);
795 spin_unlock_irqrestore(&dlci->gsm->tx_lock, flags);
799 * gsm_dlci_data_output - try and push data out of a DLCI
800 * @gsm: mux
801 * @dlci: the DLCI to pull data from
803 * Pull data from a DLCI and send it into the transmit queue if there
804 * is data. Keep to the MRU of the mux. This path handles the usual tty
805 * interface which is a byte stream with optional modem data.
807 * Caller must hold the tx_lock of the mux.
810 static int gsm_dlci_data_output(struct gsm_mux *gsm, struct gsm_dlci *dlci)
812 struct gsm_msg *msg;
813 u8 *dp;
814 int len, total_size, size;
815 int h = dlci->adaption - 1;
817 total_size = 0;
818 while (1) {
819 len = kfifo_len(dlci->fifo);
820 if (len == 0)
821 return total_size;
823 /* MTU/MRU count only the data bits */
824 if (len > gsm->mtu)
825 len = gsm->mtu;
827 size = len + h;
829 msg = gsm_data_alloc(gsm, dlci->addr, size, gsm->ftype);
830 /* FIXME: need a timer or something to kick this so it can't
831 get stuck with no work outstanding and no buffer free */
832 if (msg == NULL)
833 return -ENOMEM;
834 dp = msg->data;
835 switch (dlci->adaption) {
836 case 1: /* Unstructured */
837 break;
838 case 2: /* Unstructed with modem bits.
839 Always one byte as we never send inline break data */
840 *dp++ = gsm_encode_modem(dlci);
841 break;
843 WARN_ON(kfifo_out_locked(dlci->fifo, dp , len, &dlci->lock) != len);
844 __gsm_data_queue(dlci, msg);
845 total_size += size;
847 /* Bytes of data we used up */
848 return total_size;
852 * gsm_dlci_data_output_framed - try and push data out of a DLCI
853 * @gsm: mux
854 * @dlci: the DLCI to pull data from
856 * Pull data from a DLCI and send it into the transmit queue if there
857 * is data. Keep to the MRU of the mux. This path handles framed data
858 * queued as skbuffs to the DLCI.
860 * Caller must hold the tx_lock of the mux.
863 static int gsm_dlci_data_output_framed(struct gsm_mux *gsm,
864 struct gsm_dlci *dlci)
866 struct gsm_msg *msg;
867 u8 *dp;
868 int len, size;
869 int last = 0, first = 0;
870 int overhead = 0;
872 /* One byte per frame is used for B/F flags */
873 if (dlci->adaption == 4)
874 overhead = 1;
876 /* dlci->skb is locked by tx_lock */
877 if (dlci->skb == NULL) {
878 dlci->skb = skb_dequeue_tail(&dlci->skb_list);
879 if (dlci->skb == NULL)
880 return 0;
881 first = 1;
883 len = dlci->skb->len + overhead;
885 /* MTU/MRU count only the data bits */
886 if (len > gsm->mtu) {
887 if (dlci->adaption == 3) {
888 /* Over long frame, bin it */
889 dev_kfree_skb_any(dlci->skb);
890 dlci->skb = NULL;
891 return 0;
893 len = gsm->mtu;
894 } else
895 last = 1;
897 size = len + overhead;
898 msg = gsm_data_alloc(gsm, dlci->addr, size, gsm->ftype);
900 /* FIXME: need a timer or something to kick this so it can't
901 get stuck with no work outstanding and no buffer free */
902 if (msg == NULL) {
903 skb_queue_tail(&dlci->skb_list, dlci->skb);
904 dlci->skb = NULL;
905 return -ENOMEM;
907 dp = msg->data;
909 if (dlci->adaption == 4) { /* Interruptible framed (Packetised Data) */
910 /* Flag byte to carry the start/end info */
911 *dp++ = last << 7 | first << 6 | 1; /* EA */
912 len--;
914 memcpy(dp, dlci->skb->data, len);
915 skb_pull(dlci->skb, len);
916 __gsm_data_queue(dlci, msg);
917 if (last) {
918 dev_kfree_skb_any(dlci->skb);
919 dlci->skb = NULL;
921 return size;
925 * gsm_dlci_data_sweep - look for data to send
926 * @gsm: the GSM mux
928 * Sweep the GSM mux channels in priority order looking for ones with
929 * data to send. We could do with optimising this scan a bit. We aim
930 * to fill the queue totally or up to TX_THRESH_HI bytes. Once we hit
931 * TX_THRESH_LO we get called again
933 * FIXME: We should round robin between groups and in theory you can
934 * renegotiate DLCI priorities with optional stuff. Needs optimising.
937 static void gsm_dlci_data_sweep(struct gsm_mux *gsm)
939 int len;
940 /* Priority ordering: We should do priority with RR of the groups */
941 int i = 1;
943 while (i < NUM_DLCI) {
944 struct gsm_dlci *dlci;
946 if (gsm->tx_bytes > TX_THRESH_HI)
947 break;
948 dlci = gsm->dlci[i];
949 if (dlci == NULL || dlci->constipated) {
950 i++;
951 continue;
953 if (dlci->adaption < 3 && !dlci->net)
954 len = gsm_dlci_data_output(gsm, dlci);
955 else
956 len = gsm_dlci_data_output_framed(gsm, dlci);
957 if (len < 0)
958 break;
959 /* DLCI empty - try the next */
960 if (len == 0)
961 i++;
966 * gsm_dlci_data_kick - transmit if possible
967 * @dlci: DLCI to kick
969 * Transmit data from this DLCI if the queue is empty. We can't rely on
970 * a tty wakeup except when we filled the pipe so we need to fire off
971 * new data ourselves in other cases.
974 static void gsm_dlci_data_kick(struct gsm_dlci *dlci)
976 unsigned long flags;
977 int sweep;
979 if (dlci->constipated)
980 return;
982 spin_lock_irqsave(&dlci->gsm->tx_lock, flags);
983 /* If we have nothing running then we need to fire up */
984 sweep = (dlci->gsm->tx_bytes < TX_THRESH_LO);
985 if (dlci->gsm->tx_bytes == 0) {
986 if (dlci->net)
987 gsm_dlci_data_output_framed(dlci->gsm, dlci);
988 else
989 gsm_dlci_data_output(dlci->gsm, dlci);
991 if (sweep)
992 gsm_dlci_data_sweep(dlci->gsm);
993 spin_unlock_irqrestore(&dlci->gsm->tx_lock, flags);
997 * Control message processing
1002 * gsm_control_reply - send a response frame to a control
1003 * @gsm: gsm channel
1004 * @cmd: the command to use
1005 * @data: data to follow encoded info
1006 * @dlen: length of data
1008 * Encode up and queue a UI/UIH frame containing our response.
1011 static void gsm_control_reply(struct gsm_mux *gsm, int cmd, u8 *data,
1012 int dlen)
1014 struct gsm_msg *msg;
1015 msg = gsm_data_alloc(gsm, 0, dlen + 2, gsm->ftype);
1016 if (msg == NULL)
1017 return;
1018 msg->data[0] = (cmd & 0xFE) << 1 | EA; /* Clear C/R */
1019 msg->data[1] = (dlen << 1) | EA;
1020 memcpy(msg->data + 2, data, dlen);
1021 gsm_data_queue(gsm->dlci[0], msg);
1025 * gsm_process_modem - process received modem status
1026 * @tty: virtual tty bound to the DLCI
1027 * @dlci: DLCI to affect
1028 * @modem: modem bits (full EA)
1030 * Used when a modem control message or line state inline in adaption
1031 * layer 2 is processed. Sort out the local modem state and throttles
1034 static void gsm_process_modem(struct tty_struct *tty, struct gsm_dlci *dlci,
1035 u32 modem, int clen)
1037 int mlines = 0;
1038 u8 brk = 0;
1039 int fc;
1041 /* The modem status command can either contain one octet (v.24 signals)
1042 or two octets (v.24 signals + break signals). The length field will
1043 either be 2 or 3 respectively. This is specified in section
1044 5.4.6.3.7 of the 27.010 mux spec. */
1046 if (clen == 2)
1047 modem = modem & 0x7f;
1048 else {
1049 brk = modem & 0x7f;
1050 modem = (modem >> 7) & 0x7f;
1053 /* Flow control/ready to communicate */
1054 fc = (modem & MDM_FC) || !(modem & MDM_RTR);
1055 if (fc && !dlci->constipated) {
1056 /* Need to throttle our output on this device */
1057 dlci->constipated = 1;
1058 } else if (!fc && dlci->constipated) {
1059 dlci->constipated = 0;
1060 gsm_dlci_data_kick(dlci);
1063 /* Map modem bits */
1064 if (modem & MDM_RTC)
1065 mlines |= TIOCM_DSR | TIOCM_DTR;
1066 if (modem & MDM_RTR)
1067 mlines |= TIOCM_RTS | TIOCM_CTS;
1068 if (modem & MDM_IC)
1069 mlines |= TIOCM_RI;
1070 if (modem & MDM_DV)
1071 mlines |= TIOCM_CD;
1073 /* Carrier drop -> hangup */
1074 if (tty) {
1075 if ((mlines & TIOCM_CD) == 0 && (dlci->modem_rx & TIOCM_CD))
1076 if (!C_CLOCAL(tty))
1077 tty_hangup(tty);
1079 if (brk & 0x01)
1080 tty_insert_flip_char(&dlci->port, 0, TTY_BREAK);
1081 dlci->modem_rx = mlines;
1085 * gsm_control_modem - modem status received
1086 * @gsm: GSM channel
1087 * @data: data following command
1088 * @clen: command length
1090 * We have received a modem status control message. This is used by
1091 * the GSM mux protocol to pass virtual modem line status and optionally
1092 * to indicate break signals. Unpack it, convert to Linux representation
1093 * and if need be stuff a break message down the tty.
1096 static void gsm_control_modem(struct gsm_mux *gsm, u8 *data, int clen)
1098 unsigned int addr = 0;
1099 unsigned int modem = 0;
1100 unsigned int brk = 0;
1101 struct gsm_dlci *dlci;
1102 int len = clen;
1103 u8 *dp = data;
1104 struct tty_struct *tty;
1106 while (gsm_read_ea(&addr, *dp++) == 0) {
1107 len--;
1108 if (len == 0)
1109 return;
1111 /* Must be at least one byte following the EA */
1112 len--;
1113 if (len <= 0)
1114 return;
1116 addr >>= 1;
1117 /* Closed port, or invalid ? */
1118 if (addr == 0 || addr >= NUM_DLCI || gsm->dlci[addr] == NULL)
1119 return;
1120 dlci = gsm->dlci[addr];
1122 while (gsm_read_ea(&modem, *dp++) == 0) {
1123 len--;
1124 if (len == 0)
1125 return;
1127 len--;
1128 if (len > 0) {
1129 while (gsm_read_ea(&brk, *dp++) == 0) {
1130 len--;
1131 if (len == 0)
1132 return;
1134 modem <<= 7;
1135 modem |= (brk & 0x7f);
1137 tty = tty_port_tty_get(&dlci->port);
1138 gsm_process_modem(tty, dlci, modem, clen);
1139 if (tty) {
1140 tty_wakeup(tty);
1141 tty_kref_put(tty);
1143 gsm_control_reply(gsm, CMD_MSC, data, clen);
1147 * gsm_control_rls - remote line status
1148 * @gsm: GSM channel
1149 * @data: data bytes
1150 * @clen: data length
1152 * The modem sends us a two byte message on the control channel whenever
1153 * it wishes to send us an error state from the virtual link. Stuff
1154 * this into the uplink tty if present
1157 static void gsm_control_rls(struct gsm_mux *gsm, u8 *data, int clen)
1159 struct tty_port *port;
1160 unsigned int addr = 0;
1161 u8 bits;
1162 int len = clen;
1163 u8 *dp = data;
1165 while (gsm_read_ea(&addr, *dp++) == 0) {
1166 len--;
1167 if (len == 0)
1168 return;
1170 /* Must be at least one byte following ea */
1171 len--;
1172 if (len <= 0)
1173 return;
1174 addr >>= 1;
1175 /* Closed port, or invalid ? */
1176 if (addr == 0 || addr >= NUM_DLCI || gsm->dlci[addr] == NULL)
1177 return;
1178 /* No error ? */
1179 bits = *dp;
1180 if ((bits & 1) == 0)
1181 return;
1183 port = &gsm->dlci[addr]->port;
1185 if (bits & 2)
1186 tty_insert_flip_char(port, 0, TTY_OVERRUN);
1187 if (bits & 4)
1188 tty_insert_flip_char(port, 0, TTY_PARITY);
1189 if (bits & 8)
1190 tty_insert_flip_char(port, 0, TTY_FRAME);
1192 tty_flip_buffer_push(port);
1194 gsm_control_reply(gsm, CMD_RLS, data, clen);
1197 static void gsm_dlci_begin_close(struct gsm_dlci *dlci);
1200 * gsm_control_message - DLCI 0 control processing
1201 * @gsm: our GSM mux
1202 * @command: the command EA
1203 * @data: data beyond the command/length EAs
1204 * @clen: length
1206 * Input processor for control messages from the other end of the link.
1207 * Processes the incoming request and queues a response frame or an
1208 * NSC response if not supported
1211 static void gsm_control_message(struct gsm_mux *gsm, unsigned int command,
1212 u8 *data, int clen)
1214 u8 buf[1];
1215 unsigned long flags;
1217 switch (command) {
1218 case CMD_CLD: {
1219 struct gsm_dlci *dlci = gsm->dlci[0];
1220 /* Modem wishes to close down */
1221 if (dlci) {
1222 dlci->dead = 1;
1223 gsm->dead = 1;
1224 gsm_dlci_begin_close(dlci);
1227 break;
1228 case CMD_TEST:
1229 /* Modem wishes to test, reply with the data */
1230 gsm_control_reply(gsm, CMD_TEST, data, clen);
1231 break;
1232 case CMD_FCON:
1233 /* Modem can accept data again */
1234 gsm->constipated = 0;
1235 gsm_control_reply(gsm, CMD_FCON, NULL, 0);
1236 /* Kick the link in case it is idling */
1237 spin_lock_irqsave(&gsm->tx_lock, flags);
1238 gsm_data_kick(gsm, NULL);
1239 spin_unlock_irqrestore(&gsm->tx_lock, flags);
1240 break;
1241 case CMD_FCOFF:
1242 /* Modem wants us to STFU */
1243 gsm->constipated = 1;
1244 gsm_control_reply(gsm, CMD_FCOFF, NULL, 0);
1245 break;
1246 case CMD_MSC:
1247 /* Out of band modem line change indicator for a DLCI */
1248 gsm_control_modem(gsm, data, clen);
1249 break;
1250 case CMD_RLS:
1251 /* Out of band error reception for a DLCI */
1252 gsm_control_rls(gsm, data, clen);
1253 break;
1254 case CMD_PSC:
1255 /* Modem wishes to enter power saving state */
1256 gsm_control_reply(gsm, CMD_PSC, NULL, 0);
1257 break;
1258 /* Optional unsupported commands */
1259 case CMD_PN: /* Parameter negotiation */
1260 case CMD_RPN: /* Remote port negotiation */
1261 case CMD_SNC: /* Service negotiation command */
1262 default:
1263 /* Reply to bad commands with an NSC */
1264 buf[0] = command;
1265 gsm_control_reply(gsm, CMD_NSC, buf, 1);
1266 break;
1271 * gsm_control_response - process a response to our control
1272 * @gsm: our GSM mux
1273 * @command: the command (response) EA
1274 * @data: data beyond the command/length EA
1275 * @clen: length
1277 * Process a response to an outstanding command. We only allow a single
1278 * control message in flight so this is fairly easy. All the clean up
1279 * is done by the caller, we just update the fields, flag it as done
1280 * and return
1283 static void gsm_control_response(struct gsm_mux *gsm, unsigned int command,
1284 u8 *data, int clen)
1286 struct gsm_control *ctrl;
1287 unsigned long flags;
1289 spin_lock_irqsave(&gsm->control_lock, flags);
1291 ctrl = gsm->pending_cmd;
1292 /* Does the reply match our command */
1293 command |= 1;
1294 if (ctrl != NULL && (command == ctrl->cmd || command == CMD_NSC)) {
1295 /* Our command was replied to, kill the retry timer */
1296 del_timer(&gsm->t2_timer);
1297 gsm->pending_cmd = NULL;
1298 /* Rejected by the other end */
1299 if (command == CMD_NSC)
1300 ctrl->error = -EOPNOTSUPP;
1301 ctrl->done = 1;
1302 wake_up(&gsm->event);
1304 spin_unlock_irqrestore(&gsm->control_lock, flags);
1308 * gsm_control_transmit - send control packet
1309 * @gsm: gsm mux
1310 * @ctrl: frame to send
1312 * Send out a pending control command (called under control lock)
1315 static void gsm_control_transmit(struct gsm_mux *gsm, struct gsm_control *ctrl)
1317 struct gsm_msg *msg = gsm_data_alloc(gsm, 0, ctrl->len + 1, gsm->ftype);
1318 if (msg == NULL)
1319 return;
1320 msg->data[0] = (ctrl->cmd << 1) | 2 | EA; /* command */
1321 memcpy(msg->data + 1, ctrl->data, ctrl->len);
1322 gsm_data_queue(gsm->dlci[0], msg);
1326 * gsm_control_retransmit - retransmit a control frame
1327 * @data: pointer to our gsm object
1329 * Called off the T2 timer expiry in order to retransmit control frames
1330 * that have been lost in the system somewhere. The control_lock protects
1331 * us from colliding with another sender or a receive completion event.
1332 * In that situation the timer may still occur in a small window but
1333 * gsm->pending_cmd will be NULL and we just let the timer expire.
1336 static void gsm_control_retransmit(unsigned long data)
1338 struct gsm_mux *gsm = (struct gsm_mux *)data;
1339 struct gsm_control *ctrl;
1340 unsigned long flags;
1341 spin_lock_irqsave(&gsm->control_lock, flags);
1342 ctrl = gsm->pending_cmd;
1343 if (ctrl) {
1344 gsm->cretries--;
1345 if (gsm->cretries == 0) {
1346 gsm->pending_cmd = NULL;
1347 ctrl->error = -ETIMEDOUT;
1348 ctrl->done = 1;
1349 spin_unlock_irqrestore(&gsm->control_lock, flags);
1350 wake_up(&gsm->event);
1351 return;
1353 gsm_control_transmit(gsm, ctrl);
1354 mod_timer(&gsm->t2_timer, jiffies + gsm->t2 * HZ / 100);
1356 spin_unlock_irqrestore(&gsm->control_lock, flags);
1360 * gsm_control_send - send a control frame on DLCI 0
1361 * @gsm: the GSM channel
1362 * @command: command to send including CR bit
1363 * @data: bytes of data (must be kmalloced)
1364 * @len: length of the block to send
1366 * Queue and dispatch a control command. Only one command can be
1367 * active at a time. In theory more can be outstanding but the matching
1368 * gets really complicated so for now stick to one outstanding.
1371 static struct gsm_control *gsm_control_send(struct gsm_mux *gsm,
1372 unsigned int command, u8 *data, int clen)
1374 struct gsm_control *ctrl = kzalloc(sizeof(struct gsm_control),
1375 GFP_KERNEL);
1376 unsigned long flags;
1377 if (ctrl == NULL)
1378 return NULL;
1379 retry:
1380 wait_event(gsm->event, gsm->pending_cmd == NULL);
1381 spin_lock_irqsave(&gsm->control_lock, flags);
1382 if (gsm->pending_cmd != NULL) {
1383 spin_unlock_irqrestore(&gsm->control_lock, flags);
1384 goto retry;
1386 ctrl->cmd = command;
1387 ctrl->data = data;
1388 ctrl->len = clen;
1389 gsm->pending_cmd = ctrl;
1391 /* If DLCI0 is in ADM mode skip retries, it won't respond */
1392 if (gsm->dlci[0]->mode == DLCI_MODE_ADM)
1393 gsm->cretries = 1;
1394 else
1395 gsm->cretries = gsm->n2;
1397 mod_timer(&gsm->t2_timer, jiffies + gsm->t2 * HZ / 100);
1398 gsm_control_transmit(gsm, ctrl);
1399 spin_unlock_irqrestore(&gsm->control_lock, flags);
1400 return ctrl;
1404 * gsm_control_wait - wait for a control to finish
1405 * @gsm: GSM mux
1406 * @control: control we are waiting on
1408 * Waits for the control to complete or time out. Frees any used
1409 * resources and returns 0 for success, or an error if the remote
1410 * rejected or ignored the request.
1413 static int gsm_control_wait(struct gsm_mux *gsm, struct gsm_control *control)
1415 int err;
1416 wait_event(gsm->event, control->done == 1);
1417 err = control->error;
1418 kfree(control);
1419 return err;
1424 * DLCI level handling: Needs krefs
1428 * State transitions and timers
1432 * gsm_dlci_close - a DLCI has closed
1433 * @dlci: DLCI that closed
1435 * Perform processing when moving a DLCI into closed state. If there
1436 * is an attached tty this is hung up
1439 static void gsm_dlci_close(struct gsm_dlci *dlci)
1441 del_timer(&dlci->t1);
1442 if (debug & 8)
1443 pr_debug("DLCI %d goes closed.\n", dlci->addr);
1444 dlci->state = DLCI_CLOSED;
1445 if (dlci->addr != 0) {
1446 tty_port_tty_hangup(&dlci->port, false);
1447 kfifo_reset(dlci->fifo);
1448 } else
1449 dlci->gsm->dead = 1;
1450 wake_up(&dlci->gsm->event);
1451 /* A DLCI 0 close is a MUX termination so we need to kick that
1452 back to userspace somehow */
1456 * gsm_dlci_open - a DLCI has opened
1457 * @dlci: DLCI that opened
1459 * Perform processing when moving a DLCI into open state.
1462 static void gsm_dlci_open(struct gsm_dlci *dlci)
1464 /* Note that SABM UA .. SABM UA first UA lost can mean that we go
1465 open -> open */
1466 del_timer(&dlci->t1);
1467 /* This will let a tty open continue */
1468 dlci->state = DLCI_OPEN;
1469 if (debug & 8)
1470 pr_debug("DLCI %d goes open.\n", dlci->addr);
1471 wake_up(&dlci->gsm->event);
1475 * gsm_dlci_t1 - T1 timer expiry
1476 * @dlci: DLCI that opened
1478 * The T1 timer handles retransmits of control frames (essentially of
1479 * SABM and DISC). We resend the command until the retry count runs out
1480 * in which case an opening port goes back to closed and a closing port
1481 * is simply put into closed state (any further frames from the other
1482 * end will get a DM response)
1484 * Some control dlci can stay in ADM mode with other dlci working just
1485 * fine. In that case we can just keep the control dlci open after the
1486 * DLCI_OPENING retries time out.
1489 static void gsm_dlci_t1(unsigned long data)
1491 struct gsm_dlci *dlci = (struct gsm_dlci *)data;
1492 struct gsm_mux *gsm = dlci->gsm;
1494 switch (dlci->state) {
1495 case DLCI_OPENING:
1496 dlci->retries--;
1497 if (dlci->retries) {
1498 gsm_command(dlci->gsm, dlci->addr, SABM|PF);
1499 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1500 } else if (!dlci->addr && gsm->control == (DM | PF)) {
1501 if (debug & 8)
1502 pr_info("DLCI %d opening in ADM mode.\n",
1503 dlci->addr);
1504 dlci->mode = DLCI_MODE_ADM;
1505 gsm_dlci_open(dlci);
1506 } else {
1507 gsm_dlci_close(dlci);
1510 break;
1511 case DLCI_CLOSING:
1512 dlci->retries--;
1513 if (dlci->retries) {
1514 gsm_command(dlci->gsm, dlci->addr, DISC|PF);
1515 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1516 } else
1517 gsm_dlci_close(dlci);
1518 break;
1523 * gsm_dlci_begin_open - start channel open procedure
1524 * @dlci: DLCI to open
1526 * Commence opening a DLCI from the Linux side. We issue SABM messages
1527 * to the modem which should then reply with a UA or ADM, at which point
1528 * we will move into open state. Opening is done asynchronously with retry
1529 * running off timers and the responses.
1532 static void gsm_dlci_begin_open(struct gsm_dlci *dlci)
1534 struct gsm_mux *gsm = dlci->gsm;
1535 if (dlci->state == DLCI_OPEN || dlci->state == DLCI_OPENING)
1536 return;
1537 dlci->retries = gsm->n2;
1538 dlci->state = DLCI_OPENING;
1539 gsm_command(dlci->gsm, dlci->addr, SABM|PF);
1540 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1544 * gsm_dlci_begin_close - start channel open procedure
1545 * @dlci: DLCI to open
1547 * Commence closing a DLCI from the Linux side. We issue DISC messages
1548 * to the modem which should then reply with a UA, at which point we
1549 * will move into closed state. Closing is done asynchronously with retry
1550 * off timers. We may also receive a DM reply from the other end which
1551 * indicates the channel was already closed.
1554 static void gsm_dlci_begin_close(struct gsm_dlci *dlci)
1556 struct gsm_mux *gsm = dlci->gsm;
1557 if (dlci->state == DLCI_CLOSED || dlci->state == DLCI_CLOSING)
1558 return;
1559 dlci->retries = gsm->n2;
1560 dlci->state = DLCI_CLOSING;
1561 gsm_command(dlci->gsm, dlci->addr, DISC|PF);
1562 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1566 * gsm_dlci_data - data arrived
1567 * @dlci: channel
1568 * @data: block of bytes received
1569 * @len: length of received block
1571 * A UI or UIH frame has arrived which contains data for a channel
1572 * other than the control channel. If the relevant virtual tty is
1573 * open we shovel the bits down it, if not we drop them.
1576 static void gsm_dlci_data(struct gsm_dlci *dlci, u8 *data, int clen)
1578 /* krefs .. */
1579 struct tty_port *port = &dlci->port;
1580 struct tty_struct *tty;
1581 unsigned int modem = 0;
1582 int len = clen;
1584 if (debug & 16)
1585 pr_debug("%d bytes for tty\n", len);
1586 switch (dlci->adaption) {
1587 /* Unsupported types */
1588 /* Packetised interruptible data */
1589 case 4:
1590 break;
1591 /* Packetised uininterruptible voice/data */
1592 case 3:
1593 break;
1594 /* Asynchronous serial with line state in each frame */
1595 case 2:
1596 while (gsm_read_ea(&modem, *data++) == 0) {
1597 len--;
1598 if (len == 0)
1599 return;
1601 tty = tty_port_tty_get(port);
1602 if (tty) {
1603 gsm_process_modem(tty, dlci, modem, clen);
1604 tty_kref_put(tty);
1606 /* Line state will go via DLCI 0 controls only */
1607 case 1:
1608 default:
1609 tty_insert_flip_string(port, data, len);
1610 tty_flip_buffer_push(port);
1615 * gsm_dlci_control - data arrived on control channel
1616 * @dlci: channel
1617 * @data: block of bytes received
1618 * @len: length of received block
1620 * A UI or UIH frame has arrived which contains data for DLCI 0 the
1621 * control channel. This should contain a command EA followed by
1622 * control data bytes. The command EA contains a command/response bit
1623 * and we divide up the work accordingly.
1626 static void gsm_dlci_command(struct gsm_dlci *dlci, u8 *data, int len)
1628 /* See what command is involved */
1629 unsigned int command = 0;
1630 while (len-- > 0) {
1631 if (gsm_read_ea(&command, *data++) == 1) {
1632 int clen = *data++;
1633 len--;
1634 /* FIXME: this is properly an EA */
1635 clen >>= 1;
1636 /* Malformed command ? */
1637 if (clen > len)
1638 return;
1639 if (command & 1)
1640 gsm_control_message(dlci->gsm, command,
1641 data, clen);
1642 else
1643 gsm_control_response(dlci->gsm, command,
1644 data, clen);
1645 return;
1651 * Allocate/Free DLCI channels
1655 * gsm_dlci_alloc - allocate a DLCI
1656 * @gsm: GSM mux
1657 * @addr: address of the DLCI
1659 * Allocate and install a new DLCI object into the GSM mux.
1661 * FIXME: review locking races
1664 static struct gsm_dlci *gsm_dlci_alloc(struct gsm_mux *gsm, int addr)
1666 struct gsm_dlci *dlci = kzalloc(sizeof(struct gsm_dlci), GFP_ATOMIC);
1667 if (dlci == NULL)
1668 return NULL;
1669 spin_lock_init(&dlci->lock);
1670 mutex_init(&dlci->mutex);
1671 dlci->fifo = &dlci->_fifo;
1672 if (kfifo_alloc(&dlci->_fifo, 4096, GFP_KERNEL) < 0) {
1673 kfree(dlci);
1674 return NULL;
1677 skb_queue_head_init(&dlci->skb_list);
1678 init_timer(&dlci->t1);
1679 dlci->t1.function = gsm_dlci_t1;
1680 dlci->t1.data = (unsigned long)dlci;
1681 tty_port_init(&dlci->port);
1682 dlci->port.ops = &gsm_port_ops;
1683 dlci->gsm = gsm;
1684 dlci->addr = addr;
1685 dlci->adaption = gsm->adaption;
1686 dlci->state = DLCI_CLOSED;
1687 if (addr)
1688 dlci->data = gsm_dlci_data;
1689 else
1690 dlci->data = gsm_dlci_command;
1691 gsm->dlci[addr] = dlci;
1692 return dlci;
1696 * gsm_dlci_free - free DLCI
1697 * @dlci: DLCI to free
1699 * Free up a DLCI.
1701 * Can sleep.
1703 static void gsm_dlci_free(struct tty_port *port)
1705 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
1707 del_timer_sync(&dlci->t1);
1708 dlci->gsm->dlci[dlci->addr] = NULL;
1709 kfifo_free(dlci->fifo);
1710 while ((dlci->skb = skb_dequeue(&dlci->skb_list)))
1711 dev_kfree_skb(dlci->skb);
1712 kfree(dlci);
1715 static inline void dlci_get(struct gsm_dlci *dlci)
1717 tty_port_get(&dlci->port);
1720 static inline void dlci_put(struct gsm_dlci *dlci)
1722 tty_port_put(&dlci->port);
1725 static void gsm_destroy_network(struct gsm_dlci *dlci);
1728 * gsm_dlci_release - release DLCI
1729 * @dlci: DLCI to destroy
1731 * Release a DLCI. Actual free is deferred until either
1732 * mux is closed or tty is closed - whichever is last.
1734 * Can sleep.
1736 static void gsm_dlci_release(struct gsm_dlci *dlci)
1738 struct tty_struct *tty = tty_port_tty_get(&dlci->port);
1739 if (tty) {
1740 mutex_lock(&dlci->mutex);
1741 gsm_destroy_network(dlci);
1742 mutex_unlock(&dlci->mutex);
1744 tty_vhangup(tty);
1746 tty_port_tty_set(&dlci->port, NULL);
1747 tty_kref_put(tty);
1749 dlci->state = DLCI_CLOSED;
1750 dlci_put(dlci);
1754 * LAPBish link layer logic
1758 * gsm_queue - a GSM frame is ready to process
1759 * @gsm: pointer to our gsm mux
1761 * At this point in time a frame has arrived and been demangled from
1762 * the line encoding. All the differences between the encodings have
1763 * been handled below us and the frame is unpacked into the structures.
1764 * The fcs holds the header FCS but any data FCS must be added here.
1767 static void gsm_queue(struct gsm_mux *gsm)
1769 struct gsm_dlci *dlci;
1770 u8 cr;
1771 int address;
1772 /* We have to sneak a look at the packet body to do the FCS.
1773 A somewhat layering violation in the spec */
1775 if ((gsm->control & ~PF) == UI)
1776 gsm->fcs = gsm_fcs_add_block(gsm->fcs, gsm->buf, gsm->len);
1777 if (gsm->encoding == 0) {
1778 /* WARNING: gsm->received_fcs is used for
1779 gsm->encoding = 0 only.
1780 In this case it contain the last piece of data
1781 required to generate final CRC */
1782 gsm->fcs = gsm_fcs_add(gsm->fcs, gsm->received_fcs);
1784 if (gsm->fcs != GOOD_FCS) {
1785 gsm->bad_fcs++;
1786 if (debug & 4)
1787 pr_debug("BAD FCS %02x\n", gsm->fcs);
1788 return;
1790 address = gsm->address >> 1;
1791 if (address >= NUM_DLCI)
1792 goto invalid;
1794 cr = gsm->address & 1; /* C/R bit */
1796 gsm_print_packet("<--", address, cr, gsm->control, gsm->buf, gsm->len);
1798 cr ^= 1 - gsm->initiator; /* Flip so 1 always means command */
1799 dlci = gsm->dlci[address];
1801 switch (gsm->control) {
1802 case SABM|PF:
1803 if (cr == 0)
1804 goto invalid;
1805 if (dlci == NULL)
1806 dlci = gsm_dlci_alloc(gsm, address);
1807 if (dlci == NULL)
1808 return;
1809 if (dlci->dead)
1810 gsm_response(gsm, address, DM);
1811 else {
1812 gsm_response(gsm, address, UA);
1813 gsm_dlci_open(dlci);
1815 break;
1816 case DISC|PF:
1817 if (cr == 0)
1818 goto invalid;
1819 if (dlci == NULL || dlci->state == DLCI_CLOSED) {
1820 gsm_response(gsm, address, DM);
1821 return;
1823 /* Real close complete */
1824 gsm_response(gsm, address, UA);
1825 gsm_dlci_close(dlci);
1826 break;
1827 case UA:
1828 case UA|PF:
1829 if (cr == 0 || dlci == NULL)
1830 break;
1831 switch (dlci->state) {
1832 case DLCI_CLOSING:
1833 gsm_dlci_close(dlci);
1834 break;
1835 case DLCI_OPENING:
1836 gsm_dlci_open(dlci);
1837 break;
1839 break;
1840 case DM: /* DM can be valid unsolicited */
1841 case DM|PF:
1842 if (cr)
1843 goto invalid;
1844 if (dlci == NULL)
1845 return;
1846 gsm_dlci_close(dlci);
1847 break;
1848 case UI:
1849 case UI|PF:
1850 case UIH:
1851 case UIH|PF:
1852 #if 0
1853 if (cr)
1854 goto invalid;
1855 #endif
1856 if (dlci == NULL || dlci->state != DLCI_OPEN) {
1857 gsm_command(gsm, address, DM|PF);
1858 return;
1860 dlci->data(dlci, gsm->buf, gsm->len);
1861 break;
1862 default:
1863 goto invalid;
1865 return;
1866 invalid:
1867 gsm->malformed++;
1868 return;
1873 * gsm0_receive - perform processing for non-transparency
1874 * @gsm: gsm data for this ldisc instance
1875 * @c: character
1877 * Receive bytes in gsm mode 0
1880 static void gsm0_receive(struct gsm_mux *gsm, unsigned char c)
1882 unsigned int len;
1884 switch (gsm->state) {
1885 case GSM_SEARCH: /* SOF marker */
1886 if (c == GSM0_SOF) {
1887 gsm->state = GSM_ADDRESS;
1888 gsm->address = 0;
1889 gsm->len = 0;
1890 gsm->fcs = INIT_FCS;
1892 break;
1893 case GSM_ADDRESS: /* Address EA */
1894 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1895 if (gsm_read_ea(&gsm->address, c))
1896 gsm->state = GSM_CONTROL;
1897 break;
1898 case GSM_CONTROL: /* Control Byte */
1899 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1900 gsm->control = c;
1901 gsm->state = GSM_LEN0;
1902 break;
1903 case GSM_LEN0: /* Length EA */
1904 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1905 if (gsm_read_ea(&gsm->len, c)) {
1906 if (gsm->len > gsm->mru) {
1907 gsm->bad_size++;
1908 gsm->state = GSM_SEARCH;
1909 break;
1911 gsm->count = 0;
1912 if (!gsm->len)
1913 gsm->state = GSM_FCS;
1914 else
1915 gsm->state = GSM_DATA;
1916 break;
1918 gsm->state = GSM_LEN1;
1919 break;
1920 case GSM_LEN1:
1921 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1922 len = c;
1923 gsm->len |= len << 7;
1924 if (gsm->len > gsm->mru) {
1925 gsm->bad_size++;
1926 gsm->state = GSM_SEARCH;
1927 break;
1929 gsm->count = 0;
1930 if (!gsm->len)
1931 gsm->state = GSM_FCS;
1932 else
1933 gsm->state = GSM_DATA;
1934 break;
1935 case GSM_DATA: /* Data */
1936 gsm->buf[gsm->count++] = c;
1937 if (gsm->count == gsm->len)
1938 gsm->state = GSM_FCS;
1939 break;
1940 case GSM_FCS: /* FCS follows the packet */
1941 gsm->received_fcs = c;
1942 gsm_queue(gsm);
1943 gsm->state = GSM_SSOF;
1944 break;
1945 case GSM_SSOF:
1946 if (c == GSM0_SOF) {
1947 gsm->state = GSM_SEARCH;
1948 break;
1950 break;
1955 * gsm1_receive - perform processing for non-transparency
1956 * @gsm: gsm data for this ldisc instance
1957 * @c: character
1959 * Receive bytes in mode 1 (Advanced option)
1962 static void gsm1_receive(struct gsm_mux *gsm, unsigned char c)
1964 if (c == GSM1_SOF) {
1965 /* EOF is only valid in frame if we have got to the data state
1966 and received at least one byte (the FCS) */
1967 if (gsm->state == GSM_DATA && gsm->count) {
1968 /* Extract the FCS */
1969 gsm->count--;
1970 gsm->fcs = gsm_fcs_add(gsm->fcs, gsm->buf[gsm->count]);
1971 gsm->len = gsm->count;
1972 gsm_queue(gsm);
1973 gsm->state = GSM_START;
1974 return;
1976 /* Any partial frame was a runt so go back to start */
1977 if (gsm->state != GSM_START) {
1978 gsm->malformed++;
1979 gsm->state = GSM_START;
1981 /* A SOF in GSM_START means we are still reading idling or
1982 framing bytes */
1983 return;
1986 if (c == GSM1_ESCAPE) {
1987 gsm->escape = 1;
1988 return;
1991 /* Only an unescaped SOF gets us out of GSM search */
1992 if (gsm->state == GSM_SEARCH)
1993 return;
1995 if (gsm->escape) {
1996 c ^= GSM1_ESCAPE_BITS;
1997 gsm->escape = 0;
1999 switch (gsm->state) {
2000 case GSM_START: /* First byte after SOF */
2001 gsm->address = 0;
2002 gsm->state = GSM_ADDRESS;
2003 gsm->fcs = INIT_FCS;
2004 /* Drop through */
2005 case GSM_ADDRESS: /* Address continuation */
2006 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
2007 if (gsm_read_ea(&gsm->address, c))
2008 gsm->state = GSM_CONTROL;
2009 break;
2010 case GSM_CONTROL: /* Control Byte */
2011 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
2012 gsm->control = c;
2013 gsm->count = 0;
2014 gsm->state = GSM_DATA;
2015 break;
2016 case GSM_DATA: /* Data */
2017 if (gsm->count > gsm->mru) { /* Allow one for the FCS */
2018 gsm->state = GSM_OVERRUN;
2019 gsm->bad_size++;
2020 } else
2021 gsm->buf[gsm->count++] = c;
2022 break;
2023 case GSM_OVERRUN: /* Over-long - eg a dropped SOF */
2024 break;
2029 * gsm_error - handle tty error
2030 * @gsm: ldisc data
2031 * @data: byte received (may be invalid)
2032 * @flag: error received
2034 * Handle an error in the receipt of data for a frame. Currently we just
2035 * go back to hunting for a SOF.
2037 * FIXME: better diagnostics ?
2040 static void gsm_error(struct gsm_mux *gsm,
2041 unsigned char data, unsigned char flag)
2043 gsm->state = GSM_SEARCH;
2044 gsm->io_error++;
2048 * gsm_cleanup_mux - generic GSM protocol cleanup
2049 * @gsm: our mux
2051 * Clean up the bits of the mux which are the same for all framing
2052 * protocols. Remove the mux from the mux table, stop all the timers
2053 * and then shut down each device hanging up the channels as we go.
2056 static void gsm_cleanup_mux(struct gsm_mux *gsm)
2058 int i;
2059 struct gsm_dlci *dlci = gsm->dlci[0];
2060 struct gsm_msg *txq, *ntxq;
2061 struct gsm_control *gc;
2063 gsm->dead = 1;
2065 spin_lock(&gsm_mux_lock);
2066 for (i = 0; i < MAX_MUX; i++) {
2067 if (gsm_mux[i] == gsm) {
2068 gsm_mux[i] = NULL;
2069 break;
2072 spin_unlock(&gsm_mux_lock);
2073 /* open failed before registering => nothing to do */
2074 if (i == MAX_MUX)
2075 return;
2077 /* In theory disconnecting DLCI 0 is sufficient but for some
2078 modems this is apparently not the case. */
2079 if (dlci) {
2080 gc = gsm_control_send(gsm, CMD_CLD, NULL, 0);
2081 if (gc)
2082 gsm_control_wait(gsm, gc);
2084 del_timer_sync(&gsm->t2_timer);
2085 /* Now we are sure T2 has stopped */
2086 if (dlci) {
2087 dlci->dead = 1;
2088 gsm_dlci_begin_close(dlci);
2089 wait_event_interruptible(gsm->event,
2090 dlci->state == DLCI_CLOSED);
2092 /* Free up any link layer users */
2093 mutex_lock(&gsm->mutex);
2094 for (i = 0; i < NUM_DLCI; i++)
2095 if (gsm->dlci[i])
2096 gsm_dlci_release(gsm->dlci[i]);
2097 mutex_unlock(&gsm->mutex);
2098 /* Now wipe the queues */
2099 list_for_each_entry_safe(txq, ntxq, &gsm->tx_list, list)
2100 kfree(txq);
2101 INIT_LIST_HEAD(&gsm->tx_list);
2105 * gsm_activate_mux - generic GSM setup
2106 * @gsm: our mux
2108 * Set up the bits of the mux which are the same for all framing
2109 * protocols. Add the mux to the mux table so it can be opened and
2110 * finally kick off connecting to DLCI 0 on the modem.
2113 static int gsm_activate_mux(struct gsm_mux *gsm)
2115 struct gsm_dlci *dlci;
2116 int i = 0;
2118 setup_timer(&gsm->t2_timer, gsm_control_retransmit, (unsigned long)gsm);
2119 init_waitqueue_head(&gsm->event);
2120 spin_lock_init(&gsm->control_lock);
2121 spin_lock_init(&gsm->tx_lock);
2123 if (gsm->encoding == 0)
2124 gsm->receive = gsm0_receive;
2125 else
2126 gsm->receive = gsm1_receive;
2127 gsm->error = gsm_error;
2129 spin_lock(&gsm_mux_lock);
2130 for (i = 0; i < MAX_MUX; i++) {
2131 if (gsm_mux[i] == NULL) {
2132 gsm->num = i;
2133 gsm_mux[i] = gsm;
2134 break;
2137 spin_unlock(&gsm_mux_lock);
2138 if (i == MAX_MUX)
2139 return -EBUSY;
2141 dlci = gsm_dlci_alloc(gsm, 0);
2142 if (dlci == NULL)
2143 return -ENOMEM;
2144 gsm->dead = 0; /* Tty opens are now permissible */
2145 return 0;
2149 * gsm_free_mux - free up a mux
2150 * @mux: mux to free
2152 * Dispose of allocated resources for a dead mux
2154 static void gsm_free_mux(struct gsm_mux *gsm)
2156 kfree(gsm->txframe);
2157 kfree(gsm->buf);
2158 kfree(gsm);
2162 * gsm_free_muxr - free up a mux
2163 * @mux: mux to free
2165 * Dispose of allocated resources for a dead mux
2167 static void gsm_free_muxr(struct kref *ref)
2169 struct gsm_mux *gsm = container_of(ref, struct gsm_mux, ref);
2170 gsm_free_mux(gsm);
2173 static inline void mux_get(struct gsm_mux *gsm)
2175 kref_get(&gsm->ref);
2178 static inline void mux_put(struct gsm_mux *gsm)
2180 kref_put(&gsm->ref, gsm_free_muxr);
2184 * gsm_alloc_mux - allocate a mux
2186 * Creates a new mux ready for activation.
2189 static struct gsm_mux *gsm_alloc_mux(void)
2191 struct gsm_mux *gsm = kzalloc(sizeof(struct gsm_mux), GFP_KERNEL);
2192 if (gsm == NULL)
2193 return NULL;
2194 gsm->buf = kmalloc(MAX_MRU + 1, GFP_KERNEL);
2195 if (gsm->buf == NULL) {
2196 kfree(gsm);
2197 return NULL;
2199 gsm->txframe = kmalloc(2 * MAX_MRU + 2, GFP_KERNEL);
2200 if (gsm->txframe == NULL) {
2201 kfree(gsm->buf);
2202 kfree(gsm);
2203 return NULL;
2205 spin_lock_init(&gsm->lock);
2206 mutex_init(&gsm->mutex);
2207 kref_init(&gsm->ref);
2208 INIT_LIST_HEAD(&gsm->tx_list);
2210 gsm->t1 = T1;
2211 gsm->t2 = T2;
2212 gsm->n2 = N2;
2213 gsm->ftype = UIH;
2214 gsm->adaption = 1;
2215 gsm->encoding = 1;
2216 gsm->mru = 64; /* Default to encoding 1 so these should be 64 */
2217 gsm->mtu = 64;
2218 gsm->dead = 1; /* Avoid early tty opens */
2220 return gsm;
2224 * gsmld_output - write to link
2225 * @gsm: our mux
2226 * @data: bytes to output
2227 * @len: size
2229 * Write a block of data from the GSM mux to the data channel. This
2230 * will eventually be serialized from above but at the moment isn't.
2233 static int gsmld_output(struct gsm_mux *gsm, u8 *data, int len)
2235 if (tty_write_room(gsm->tty) < len) {
2236 set_bit(TTY_DO_WRITE_WAKEUP, &gsm->tty->flags);
2237 return -ENOSPC;
2239 if (debug & 4)
2240 print_hex_dump_bytes("gsmld_output: ", DUMP_PREFIX_OFFSET,
2241 data, len);
2242 gsm->tty->ops->write(gsm->tty, data, len);
2243 return len;
2247 * gsmld_attach_gsm - mode set up
2248 * @tty: our tty structure
2249 * @gsm: our mux
2251 * Set up the MUX for basic mode and commence connecting to the
2252 * modem. Currently called from the line discipline set up but
2253 * will need moving to an ioctl path.
2256 static int gsmld_attach_gsm(struct tty_struct *tty, struct gsm_mux *gsm)
2258 int ret, i, base;
2260 gsm->tty = tty_kref_get(tty);
2261 gsm->output = gsmld_output;
2262 ret = gsm_activate_mux(gsm);
2263 if (ret != 0)
2264 tty_kref_put(gsm->tty);
2265 else {
2266 /* Don't register device 0 - this is the control channel and not
2267 a usable tty interface */
2268 base = gsm->num << 6; /* Base for this MUX */
2269 for (i = 1; i < NUM_DLCI; i++)
2270 tty_register_device(gsm_tty_driver, base + i, NULL);
2272 return ret;
2277 * gsmld_detach_gsm - stop doing 0710 mux
2278 * @tty: tty attached to the mux
2279 * @gsm: mux
2281 * Shutdown and then clean up the resources used by the line discipline
2284 static void gsmld_detach_gsm(struct tty_struct *tty, struct gsm_mux *gsm)
2286 int i;
2287 int base = gsm->num << 6; /* Base for this MUX */
2289 WARN_ON(tty != gsm->tty);
2290 for (i = 1; i < NUM_DLCI; i++)
2291 tty_unregister_device(gsm_tty_driver, base + i);
2292 gsm_cleanup_mux(gsm);
2293 tty_kref_put(gsm->tty);
2294 gsm->tty = NULL;
2297 static void gsmld_receive_buf(struct tty_struct *tty, const unsigned char *cp,
2298 char *fp, int count)
2300 struct gsm_mux *gsm = tty->disc_data;
2301 const unsigned char *dp;
2302 char *f;
2303 int i;
2304 char flags = TTY_NORMAL;
2306 if (debug & 4)
2307 print_hex_dump_bytes("gsmld_receive: ", DUMP_PREFIX_OFFSET,
2308 cp, count);
2310 for (i = count, dp = cp, f = fp; i; i--, dp++) {
2311 if (f)
2312 flags = *f++;
2313 switch (flags) {
2314 case TTY_NORMAL:
2315 gsm->receive(gsm, *dp);
2316 break;
2317 case TTY_OVERRUN:
2318 case TTY_BREAK:
2319 case TTY_PARITY:
2320 case TTY_FRAME:
2321 gsm->error(gsm, *dp, flags);
2322 break;
2323 default:
2324 WARN_ONCE(1, "%s: unknown flag %d\n",
2325 tty_name(tty), flags);
2326 break;
2329 /* FASYNC if needed ? */
2330 /* If clogged call tty_throttle(tty); */
2334 * gsmld_flush_buffer - clean input queue
2335 * @tty: terminal device
2337 * Flush the input buffer. Called when the line discipline is
2338 * being closed, when the tty layer wants the buffer flushed (eg
2339 * at hangup).
2342 static void gsmld_flush_buffer(struct tty_struct *tty)
2347 * gsmld_close - close the ldisc for this tty
2348 * @tty: device
2350 * Called from the terminal layer when this line discipline is
2351 * being shut down, either because of a close or becsuse of a
2352 * discipline change. The function will not be called while other
2353 * ldisc methods are in progress.
2356 static void gsmld_close(struct tty_struct *tty)
2358 struct gsm_mux *gsm = tty->disc_data;
2360 gsmld_detach_gsm(tty, gsm);
2362 gsmld_flush_buffer(tty);
2363 /* Do other clean up here */
2364 mux_put(gsm);
2368 * gsmld_open - open an ldisc
2369 * @tty: terminal to open
2371 * Called when this line discipline is being attached to the
2372 * terminal device. Can sleep. Called serialized so that no
2373 * other events will occur in parallel. No further open will occur
2374 * until a close.
2377 static int gsmld_open(struct tty_struct *tty)
2379 struct gsm_mux *gsm;
2380 int ret;
2382 if (tty->ops->write == NULL)
2383 return -EINVAL;
2385 /* Attach our ldisc data */
2386 gsm = gsm_alloc_mux();
2387 if (gsm == NULL)
2388 return -ENOMEM;
2390 tty->disc_data = gsm;
2391 tty->receive_room = 65536;
2393 /* Attach the initial passive connection */
2394 gsm->encoding = 1;
2396 ret = gsmld_attach_gsm(tty, gsm);
2397 if (ret != 0) {
2398 gsm_cleanup_mux(gsm);
2399 mux_put(gsm);
2401 return ret;
2405 * gsmld_write_wakeup - asynchronous I/O notifier
2406 * @tty: tty device
2408 * Required for the ptys, serial driver etc. since processes
2409 * that attach themselves to the master and rely on ASYNC
2410 * IO must be woken up
2413 static void gsmld_write_wakeup(struct tty_struct *tty)
2415 struct gsm_mux *gsm = tty->disc_data;
2416 unsigned long flags;
2418 /* Queue poll */
2419 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2420 spin_lock_irqsave(&gsm->tx_lock, flags);
2421 gsm_data_kick(gsm, NULL);
2422 if (gsm->tx_bytes < TX_THRESH_LO) {
2423 gsm_dlci_data_sweep(gsm);
2425 spin_unlock_irqrestore(&gsm->tx_lock, flags);
2429 * gsmld_read - read function for tty
2430 * @tty: tty device
2431 * @file: file object
2432 * @buf: userspace buffer pointer
2433 * @nr: size of I/O
2435 * Perform reads for the line discipline. We are guaranteed that the
2436 * line discipline will not be closed under us but we may get multiple
2437 * parallel readers and must handle this ourselves. We may also get
2438 * a hangup. Always called in user context, may sleep.
2440 * This code must be sure never to sleep through a hangup.
2443 static ssize_t gsmld_read(struct tty_struct *tty, struct file *file,
2444 unsigned char __user *buf, size_t nr)
2446 return -EOPNOTSUPP;
2450 * gsmld_write - write function for tty
2451 * @tty: tty device
2452 * @file: file object
2453 * @buf: userspace buffer pointer
2454 * @nr: size of I/O
2456 * Called when the owner of the device wants to send a frame
2457 * itself (or some other control data). The data is transferred
2458 * as-is and must be properly framed and checksummed as appropriate
2459 * by userspace. Frames are either sent whole or not at all as this
2460 * avoids pain user side.
2463 static ssize_t gsmld_write(struct tty_struct *tty, struct file *file,
2464 const unsigned char *buf, size_t nr)
2466 int space = tty_write_room(tty);
2467 if (space >= nr)
2468 return tty->ops->write(tty, buf, nr);
2469 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2470 return -ENOBUFS;
2474 * gsmld_poll - poll method for N_GSM0710
2475 * @tty: terminal device
2476 * @file: file accessing it
2477 * @wait: poll table
2479 * Called when the line discipline is asked to poll() for data or
2480 * for special events. This code is not serialized with respect to
2481 * other events save open/close.
2483 * This code must be sure never to sleep through a hangup.
2484 * Called without the kernel lock held - fine
2487 static unsigned int gsmld_poll(struct tty_struct *tty, struct file *file,
2488 poll_table *wait)
2490 unsigned int mask = 0;
2491 struct gsm_mux *gsm = tty->disc_data;
2493 poll_wait(file, &tty->read_wait, wait);
2494 poll_wait(file, &tty->write_wait, wait);
2495 if (tty_hung_up_p(file))
2496 mask |= POLLHUP;
2497 if (!tty_is_writelocked(tty) && tty_write_room(tty) > 0)
2498 mask |= POLLOUT | POLLWRNORM;
2499 if (gsm->dead)
2500 mask |= POLLHUP;
2501 return mask;
2504 static int gsmld_config(struct tty_struct *tty, struct gsm_mux *gsm,
2505 struct gsm_config *c)
2507 int need_close = 0;
2508 int need_restart = 0;
2510 /* Stuff we don't support yet - UI or I frame transport, windowing */
2511 if ((c->adaption != 1 && c->adaption != 2) || c->k)
2512 return -EOPNOTSUPP;
2513 /* Check the MRU/MTU range looks sane */
2514 if (c->mru > MAX_MRU || c->mtu > MAX_MTU || c->mru < 8 || c->mtu < 8)
2515 return -EINVAL;
2516 if (c->n2 < 3)
2517 return -EINVAL;
2518 if (c->encapsulation > 1) /* Basic, advanced, no I */
2519 return -EINVAL;
2520 if (c->initiator > 1)
2521 return -EINVAL;
2522 if (c->i == 0 || c->i > 2) /* UIH and UI only */
2523 return -EINVAL;
2525 * See what is needed for reconfiguration
2528 /* Timing fields */
2529 if (c->t1 != 0 && c->t1 != gsm->t1)
2530 need_restart = 1;
2531 if (c->t2 != 0 && c->t2 != gsm->t2)
2532 need_restart = 1;
2533 if (c->encapsulation != gsm->encoding)
2534 need_restart = 1;
2535 if (c->adaption != gsm->adaption)
2536 need_restart = 1;
2537 /* Requires care */
2538 if (c->initiator != gsm->initiator)
2539 need_close = 1;
2540 if (c->mru != gsm->mru)
2541 need_restart = 1;
2542 if (c->mtu != gsm->mtu)
2543 need_restart = 1;
2546 * Close down what is needed, restart and initiate the new
2547 * configuration
2550 if (need_close || need_restart) {
2551 gsm_dlci_begin_close(gsm->dlci[0]);
2552 /* This will timeout if the link is down due to N2 expiring */
2553 wait_event_interruptible(gsm->event,
2554 gsm->dlci[0]->state == DLCI_CLOSED);
2555 if (signal_pending(current))
2556 return -EINTR;
2558 if (need_restart)
2559 gsm_cleanup_mux(gsm);
2561 gsm->initiator = c->initiator;
2562 gsm->mru = c->mru;
2563 gsm->mtu = c->mtu;
2564 gsm->encoding = c->encapsulation;
2565 gsm->adaption = c->adaption;
2566 gsm->n2 = c->n2;
2568 if (c->i == 1)
2569 gsm->ftype = UIH;
2570 else if (c->i == 2)
2571 gsm->ftype = UI;
2573 if (c->t1)
2574 gsm->t1 = c->t1;
2575 if (c->t2)
2576 gsm->t2 = c->t2;
2578 /* FIXME: We need to separate activation/deactivation from adding
2579 and removing from the mux array */
2580 if (need_restart)
2581 gsm_activate_mux(gsm);
2582 if (gsm->initiator && need_close)
2583 gsm_dlci_begin_open(gsm->dlci[0]);
2584 return 0;
2587 static int gsmld_ioctl(struct tty_struct *tty, struct file *file,
2588 unsigned int cmd, unsigned long arg)
2590 struct gsm_config c;
2591 struct gsm_mux *gsm = tty->disc_data;
2593 switch (cmd) {
2594 case GSMIOC_GETCONF:
2595 memset(&c, 0, sizeof(c));
2596 c.adaption = gsm->adaption;
2597 c.encapsulation = gsm->encoding;
2598 c.initiator = gsm->initiator;
2599 c.t1 = gsm->t1;
2600 c.t2 = gsm->t2;
2601 c.t3 = 0; /* Not supported */
2602 c.n2 = gsm->n2;
2603 if (gsm->ftype == UIH)
2604 c.i = 1;
2605 else
2606 c.i = 2;
2607 pr_debug("Ftype %d i %d\n", gsm->ftype, c.i);
2608 c.mru = gsm->mru;
2609 c.mtu = gsm->mtu;
2610 c.k = 0;
2611 if (copy_to_user((void *)arg, &c, sizeof(c)))
2612 return -EFAULT;
2613 return 0;
2614 case GSMIOC_SETCONF:
2615 if (copy_from_user(&c, (void *)arg, sizeof(c)))
2616 return -EFAULT;
2617 return gsmld_config(tty, gsm, &c);
2618 default:
2619 return n_tty_ioctl_helper(tty, file, cmd, arg);
2624 * Network interface
2628 static int gsm_mux_net_open(struct net_device *net)
2630 pr_debug("%s called\n", __func__);
2631 netif_start_queue(net);
2632 return 0;
2635 static int gsm_mux_net_close(struct net_device *net)
2637 netif_stop_queue(net);
2638 return 0;
2641 static struct net_device_stats *gsm_mux_net_get_stats(struct net_device *net)
2643 return &((struct gsm_mux_net *)netdev_priv(net))->stats;
2645 static void dlci_net_free(struct gsm_dlci *dlci)
2647 if (!dlci->net) {
2648 WARN_ON(1);
2649 return;
2651 dlci->adaption = dlci->prev_adaption;
2652 dlci->data = dlci->prev_data;
2653 free_netdev(dlci->net);
2654 dlci->net = NULL;
2656 static void net_free(struct kref *ref)
2658 struct gsm_mux_net *mux_net;
2659 struct gsm_dlci *dlci;
2661 mux_net = container_of(ref, struct gsm_mux_net, ref);
2662 dlci = mux_net->dlci;
2664 if (dlci->net) {
2665 unregister_netdev(dlci->net);
2666 dlci_net_free(dlci);
2670 static inline void muxnet_get(struct gsm_mux_net *mux_net)
2672 kref_get(&mux_net->ref);
2675 static inline void muxnet_put(struct gsm_mux_net *mux_net)
2677 kref_put(&mux_net->ref, net_free);
2680 static int gsm_mux_net_start_xmit(struct sk_buff *skb,
2681 struct net_device *net)
2683 struct gsm_mux_net *mux_net = netdev_priv(net);
2684 struct gsm_dlci *dlci = mux_net->dlci;
2685 muxnet_get(mux_net);
2687 skb_queue_head(&dlci->skb_list, skb);
2688 STATS(net).tx_packets++;
2689 STATS(net).tx_bytes += skb->len;
2690 gsm_dlci_data_kick(dlci);
2691 /* And tell the kernel when the last transmit started. */
2692 netif_trans_update(net);
2693 muxnet_put(mux_net);
2694 return NETDEV_TX_OK;
2697 /* called when a packet did not ack after watchdogtimeout */
2698 static void gsm_mux_net_tx_timeout(struct net_device *net)
2700 /* Tell syslog we are hosed. */
2701 dev_dbg(&net->dev, "Tx timed out.\n");
2703 /* Update statistics */
2704 STATS(net).tx_errors++;
2707 static void gsm_mux_rx_netchar(struct gsm_dlci *dlci,
2708 unsigned char *in_buf, int size)
2710 struct net_device *net = dlci->net;
2711 struct sk_buff *skb;
2712 struct gsm_mux_net *mux_net = netdev_priv(net);
2713 muxnet_get(mux_net);
2715 /* Allocate an sk_buff */
2716 skb = dev_alloc_skb(size + NET_IP_ALIGN);
2717 if (!skb) {
2718 /* We got no receive buffer. */
2719 STATS(net).rx_dropped++;
2720 muxnet_put(mux_net);
2721 return;
2723 skb_reserve(skb, NET_IP_ALIGN);
2724 memcpy(skb_put(skb, size), in_buf, size);
2726 skb->dev = net;
2727 skb->protocol = htons(ETH_P_IP);
2729 /* Ship it off to the kernel */
2730 netif_rx(skb);
2732 /* update out statistics */
2733 STATS(net).rx_packets++;
2734 STATS(net).rx_bytes += size;
2735 muxnet_put(mux_net);
2736 return;
2739 static int gsm_change_mtu(struct net_device *net, int new_mtu)
2741 struct gsm_mux_net *mux_net = netdev_priv(net);
2742 if ((new_mtu < 8) || (new_mtu > mux_net->dlci->gsm->mtu))
2743 return -EINVAL;
2744 net->mtu = new_mtu;
2745 return 0;
2748 static void gsm_mux_net_init(struct net_device *net)
2750 static const struct net_device_ops gsm_netdev_ops = {
2751 .ndo_open = gsm_mux_net_open,
2752 .ndo_stop = gsm_mux_net_close,
2753 .ndo_start_xmit = gsm_mux_net_start_xmit,
2754 .ndo_tx_timeout = gsm_mux_net_tx_timeout,
2755 .ndo_get_stats = gsm_mux_net_get_stats,
2756 .ndo_change_mtu = gsm_change_mtu,
2759 net->netdev_ops = &gsm_netdev_ops;
2761 /* fill in the other fields */
2762 net->watchdog_timeo = GSM_NET_TX_TIMEOUT;
2763 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2764 net->type = ARPHRD_NONE;
2765 net->tx_queue_len = 10;
2769 /* caller holds the dlci mutex */
2770 static void gsm_destroy_network(struct gsm_dlci *dlci)
2772 struct gsm_mux_net *mux_net;
2774 pr_debug("destroy network interface");
2775 if (!dlci->net)
2776 return;
2777 mux_net = netdev_priv(dlci->net);
2778 muxnet_put(mux_net);
2782 /* caller holds the dlci mutex */
2783 static int gsm_create_network(struct gsm_dlci *dlci, struct gsm_netconfig *nc)
2785 char *netname;
2786 int retval = 0;
2787 struct net_device *net;
2788 struct gsm_mux_net *mux_net;
2790 if (!capable(CAP_NET_ADMIN))
2791 return -EPERM;
2793 /* Already in a non tty mode */
2794 if (dlci->adaption > 2)
2795 return -EBUSY;
2797 if (nc->protocol != htons(ETH_P_IP))
2798 return -EPROTONOSUPPORT;
2800 if (nc->adaption != 3 && nc->adaption != 4)
2801 return -EPROTONOSUPPORT;
2803 pr_debug("create network interface");
2805 netname = "gsm%d";
2806 if (nc->if_name[0] != '\0')
2807 netname = nc->if_name;
2808 net = alloc_netdev(sizeof(struct gsm_mux_net), netname,
2809 NET_NAME_UNKNOWN, gsm_mux_net_init);
2810 if (!net) {
2811 pr_err("alloc_netdev failed");
2812 return -ENOMEM;
2814 net->mtu = dlci->gsm->mtu;
2815 mux_net = netdev_priv(net);
2816 mux_net->dlci = dlci;
2817 kref_init(&mux_net->ref);
2818 strncpy(nc->if_name, net->name, IFNAMSIZ); /* return net name */
2820 /* reconfigure dlci for network */
2821 dlci->prev_adaption = dlci->adaption;
2822 dlci->prev_data = dlci->data;
2823 dlci->adaption = nc->adaption;
2824 dlci->data = gsm_mux_rx_netchar;
2825 dlci->net = net;
2827 pr_debug("register netdev");
2828 retval = register_netdev(net);
2829 if (retval) {
2830 pr_err("network register fail %d\n", retval);
2831 dlci_net_free(dlci);
2832 return retval;
2834 return net->ifindex; /* return network index */
2837 /* Line discipline for real tty */
2838 static struct tty_ldisc_ops tty_ldisc_packet = {
2839 .owner = THIS_MODULE,
2840 .magic = TTY_LDISC_MAGIC,
2841 .name = "n_gsm",
2842 .open = gsmld_open,
2843 .close = gsmld_close,
2844 .flush_buffer = gsmld_flush_buffer,
2845 .read = gsmld_read,
2846 .write = gsmld_write,
2847 .ioctl = gsmld_ioctl,
2848 .poll = gsmld_poll,
2849 .receive_buf = gsmld_receive_buf,
2850 .write_wakeup = gsmld_write_wakeup
2854 * Virtual tty side
2857 #define TX_SIZE 512
2859 static int gsmtty_modem_update(struct gsm_dlci *dlci, u8 brk)
2861 u8 modembits[5];
2862 struct gsm_control *ctrl;
2863 int len = 2;
2865 if (brk)
2866 len++;
2868 modembits[0] = len << 1 | EA; /* Data bytes */
2869 modembits[1] = dlci->addr << 2 | 3; /* DLCI, EA, 1 */
2870 modembits[2] = gsm_encode_modem(dlci) << 1 | EA;
2871 if (brk)
2872 modembits[3] = brk << 4 | 2 | EA; /* Valid, EA */
2873 ctrl = gsm_control_send(dlci->gsm, CMD_MSC, modembits, len + 1);
2874 if (ctrl == NULL)
2875 return -ENOMEM;
2876 return gsm_control_wait(dlci->gsm, ctrl);
2879 static int gsm_carrier_raised(struct tty_port *port)
2881 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
2882 struct gsm_mux *gsm = dlci->gsm;
2884 /* Not yet open so no carrier info */
2885 if (dlci->state != DLCI_OPEN)
2886 return 0;
2887 if (debug & 2)
2888 return 1;
2891 * Basic mode with control channel in ADM mode may not respond
2892 * to CMD_MSC at all and modem_rx is empty.
2894 if (gsm->encoding == 0 && gsm->dlci[0]->mode == DLCI_MODE_ADM &&
2895 !dlci->modem_rx)
2896 return 1;
2898 return dlci->modem_rx & TIOCM_CD;
2901 static void gsm_dtr_rts(struct tty_port *port, int onoff)
2903 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
2904 unsigned int modem_tx = dlci->modem_tx;
2905 if (onoff)
2906 modem_tx |= TIOCM_DTR | TIOCM_RTS;
2907 else
2908 modem_tx &= ~(TIOCM_DTR | TIOCM_RTS);
2909 if (modem_tx != dlci->modem_tx) {
2910 dlci->modem_tx = modem_tx;
2911 gsmtty_modem_update(dlci, 0);
2915 static const struct tty_port_operations gsm_port_ops = {
2916 .carrier_raised = gsm_carrier_raised,
2917 .dtr_rts = gsm_dtr_rts,
2918 .destruct = gsm_dlci_free,
2921 static int gsmtty_install(struct tty_driver *driver, struct tty_struct *tty)
2923 struct gsm_mux *gsm;
2924 struct gsm_dlci *dlci;
2925 unsigned int line = tty->index;
2926 unsigned int mux = line >> 6;
2927 bool alloc = false;
2928 int ret;
2930 line = line & 0x3F;
2932 if (mux >= MAX_MUX)
2933 return -ENXIO;
2934 /* FIXME: we need to lock gsm_mux for lifetimes of ttys eventually */
2935 if (gsm_mux[mux] == NULL)
2936 return -EUNATCH;
2937 if (line == 0 || line > 61) /* 62/63 reserved */
2938 return -ECHRNG;
2939 gsm = gsm_mux[mux];
2940 if (gsm->dead)
2941 return -EL2HLT;
2942 /* If DLCI 0 is not yet fully open return an error.
2943 This is ok from a locking
2944 perspective as we don't have to worry about this
2945 if DLCI0 is lost */
2946 mutex_lock(&gsm->mutex);
2947 if (gsm->dlci[0] && gsm->dlci[0]->state != DLCI_OPEN) {
2948 mutex_unlock(&gsm->mutex);
2949 return -EL2NSYNC;
2951 dlci = gsm->dlci[line];
2952 if (dlci == NULL) {
2953 alloc = true;
2954 dlci = gsm_dlci_alloc(gsm, line);
2956 if (dlci == NULL) {
2957 mutex_unlock(&gsm->mutex);
2958 return -ENOMEM;
2960 ret = tty_port_install(&dlci->port, driver, tty);
2961 if (ret) {
2962 if (alloc)
2963 dlci_put(dlci);
2964 mutex_unlock(&gsm->mutex);
2965 return ret;
2968 dlci_get(dlci);
2969 dlci_get(gsm->dlci[0]);
2970 mux_get(gsm);
2971 tty->driver_data = dlci;
2972 mutex_unlock(&gsm->mutex);
2974 return 0;
2977 static int gsmtty_open(struct tty_struct *tty, struct file *filp)
2979 struct gsm_dlci *dlci = tty->driver_data;
2980 struct tty_port *port = &dlci->port;
2982 port->count++;
2983 tty_port_tty_set(port, tty);
2985 dlci->modem_rx = 0;
2986 /* We could in theory open and close before we wait - eg if we get
2987 a DM straight back. This is ok as that will have caused a hangup */
2988 tty_port_set_initialized(port, 1);
2989 /* Start sending off SABM messages */
2990 gsm_dlci_begin_open(dlci);
2991 /* And wait for virtual carrier */
2992 return tty_port_block_til_ready(port, tty, filp);
2995 static void gsmtty_close(struct tty_struct *tty, struct file *filp)
2997 struct gsm_dlci *dlci = tty->driver_data;
2998 struct gsm_mux *gsm;
3000 if (dlci == NULL)
3001 return;
3002 if (dlci->state == DLCI_CLOSED)
3003 return;
3004 mutex_lock(&dlci->mutex);
3005 gsm_destroy_network(dlci);
3006 mutex_unlock(&dlci->mutex);
3007 gsm = dlci->gsm;
3008 if (tty_port_close_start(&dlci->port, tty, filp) == 0)
3009 return;
3010 gsm_dlci_begin_close(dlci);
3011 if (tty_port_initialized(&dlci->port) && C_HUPCL(tty))
3012 tty_port_lower_dtr_rts(&dlci->port);
3013 tty_port_close_end(&dlci->port, tty);
3014 tty_port_tty_set(&dlci->port, NULL);
3015 return;
3018 static void gsmtty_hangup(struct tty_struct *tty)
3020 struct gsm_dlci *dlci = tty->driver_data;
3021 if (dlci->state == DLCI_CLOSED)
3022 return;
3023 tty_port_hangup(&dlci->port);
3024 gsm_dlci_begin_close(dlci);
3027 static int gsmtty_write(struct tty_struct *tty, const unsigned char *buf,
3028 int len)
3030 int sent;
3031 struct gsm_dlci *dlci = tty->driver_data;
3032 if (dlci->state == DLCI_CLOSED)
3033 return -EINVAL;
3034 /* Stuff the bytes into the fifo queue */
3035 sent = kfifo_in_locked(dlci->fifo, buf, len, &dlci->lock);
3036 /* Need to kick the channel */
3037 gsm_dlci_data_kick(dlci);
3038 return sent;
3041 static int gsmtty_write_room(struct tty_struct *tty)
3043 struct gsm_dlci *dlci = tty->driver_data;
3044 if (dlci->state == DLCI_CLOSED)
3045 return -EINVAL;
3046 return TX_SIZE - kfifo_len(dlci->fifo);
3049 static int gsmtty_chars_in_buffer(struct tty_struct *tty)
3051 struct gsm_dlci *dlci = tty->driver_data;
3052 if (dlci->state == DLCI_CLOSED)
3053 return -EINVAL;
3054 return kfifo_len(dlci->fifo);
3057 static void gsmtty_flush_buffer(struct tty_struct *tty)
3059 struct gsm_dlci *dlci = tty->driver_data;
3060 if (dlci->state == DLCI_CLOSED)
3061 return;
3062 /* Caution needed: If we implement reliable transport classes
3063 then the data being transmitted can't simply be junked once
3064 it has first hit the stack. Until then we can just blow it
3065 away */
3066 kfifo_reset(dlci->fifo);
3067 /* Need to unhook this DLCI from the transmit queue logic */
3070 static void gsmtty_wait_until_sent(struct tty_struct *tty, int timeout)
3072 /* The FIFO handles the queue so the kernel will do the right
3073 thing waiting on chars_in_buffer before calling us. No work
3074 to do here */
3077 static int gsmtty_tiocmget(struct tty_struct *tty)
3079 struct gsm_dlci *dlci = tty->driver_data;
3080 if (dlci->state == DLCI_CLOSED)
3081 return -EINVAL;
3082 return dlci->modem_rx;
3085 static int gsmtty_tiocmset(struct tty_struct *tty,
3086 unsigned int set, unsigned int clear)
3088 struct gsm_dlci *dlci = tty->driver_data;
3089 unsigned int modem_tx = dlci->modem_tx;
3091 if (dlci->state == DLCI_CLOSED)
3092 return -EINVAL;
3093 modem_tx &= ~clear;
3094 modem_tx |= set;
3096 if (modem_tx != dlci->modem_tx) {
3097 dlci->modem_tx = modem_tx;
3098 return gsmtty_modem_update(dlci, 0);
3100 return 0;
3104 static int gsmtty_ioctl(struct tty_struct *tty,
3105 unsigned int cmd, unsigned long arg)
3107 struct gsm_dlci *dlci = tty->driver_data;
3108 struct gsm_netconfig nc;
3109 int index;
3111 if (dlci->state == DLCI_CLOSED)
3112 return -EINVAL;
3113 switch (cmd) {
3114 case GSMIOC_ENABLE_NET:
3115 if (copy_from_user(&nc, (void __user *)arg, sizeof(nc)))
3116 return -EFAULT;
3117 nc.if_name[IFNAMSIZ-1] = '\0';
3118 /* return net interface index or error code */
3119 mutex_lock(&dlci->mutex);
3120 index = gsm_create_network(dlci, &nc);
3121 mutex_unlock(&dlci->mutex);
3122 if (copy_to_user((void __user *)arg, &nc, sizeof(nc)))
3123 return -EFAULT;
3124 return index;
3125 case GSMIOC_DISABLE_NET:
3126 if (!capable(CAP_NET_ADMIN))
3127 return -EPERM;
3128 mutex_lock(&dlci->mutex);
3129 gsm_destroy_network(dlci);
3130 mutex_unlock(&dlci->mutex);
3131 return 0;
3132 default:
3133 return -ENOIOCTLCMD;
3137 static void gsmtty_set_termios(struct tty_struct *tty, struct ktermios *old)
3139 struct gsm_dlci *dlci = tty->driver_data;
3140 if (dlci->state == DLCI_CLOSED)
3141 return;
3142 /* For the moment its fixed. In actual fact the speed information
3143 for the virtual channel can be propogated in both directions by
3144 the RPN control message. This however rapidly gets nasty as we
3145 then have to remap modem signals each way according to whether
3146 our virtual cable is null modem etc .. */
3147 tty_termios_copy_hw(&tty->termios, old);
3150 static void gsmtty_throttle(struct tty_struct *tty)
3152 struct gsm_dlci *dlci = tty->driver_data;
3153 if (dlci->state == DLCI_CLOSED)
3154 return;
3155 if (C_CRTSCTS(tty))
3156 dlci->modem_tx &= ~TIOCM_DTR;
3157 dlci->throttled = 1;
3158 /* Send an MSC with DTR cleared */
3159 gsmtty_modem_update(dlci, 0);
3162 static void gsmtty_unthrottle(struct tty_struct *tty)
3164 struct gsm_dlci *dlci = tty->driver_data;
3165 if (dlci->state == DLCI_CLOSED)
3166 return;
3167 if (C_CRTSCTS(tty))
3168 dlci->modem_tx |= TIOCM_DTR;
3169 dlci->throttled = 0;
3170 /* Send an MSC with DTR set */
3171 gsmtty_modem_update(dlci, 0);
3174 static int gsmtty_break_ctl(struct tty_struct *tty, int state)
3176 struct gsm_dlci *dlci = tty->driver_data;
3177 int encode = 0; /* Off */
3178 if (dlci->state == DLCI_CLOSED)
3179 return -EINVAL;
3181 if (state == -1) /* "On indefinitely" - we can't encode this
3182 properly */
3183 encode = 0x0F;
3184 else if (state > 0) {
3185 encode = state / 200; /* mS to encoding */
3186 if (encode > 0x0F)
3187 encode = 0x0F; /* Best effort */
3189 return gsmtty_modem_update(dlci, encode);
3192 static void gsmtty_cleanup(struct tty_struct *tty)
3194 struct gsm_dlci *dlci = tty->driver_data;
3195 struct gsm_mux *gsm = dlci->gsm;
3197 dlci_put(dlci);
3198 dlci_put(gsm->dlci[0]);
3199 mux_put(gsm);
3202 /* Virtual ttys for the demux */
3203 static const struct tty_operations gsmtty_ops = {
3204 .install = gsmtty_install,
3205 .open = gsmtty_open,
3206 .close = gsmtty_close,
3207 .write = gsmtty_write,
3208 .write_room = gsmtty_write_room,
3209 .chars_in_buffer = gsmtty_chars_in_buffer,
3210 .flush_buffer = gsmtty_flush_buffer,
3211 .ioctl = gsmtty_ioctl,
3212 .throttle = gsmtty_throttle,
3213 .unthrottle = gsmtty_unthrottle,
3214 .set_termios = gsmtty_set_termios,
3215 .hangup = gsmtty_hangup,
3216 .wait_until_sent = gsmtty_wait_until_sent,
3217 .tiocmget = gsmtty_tiocmget,
3218 .tiocmset = gsmtty_tiocmset,
3219 .break_ctl = gsmtty_break_ctl,
3220 .cleanup = gsmtty_cleanup,
3225 static int __init gsm_init(void)
3227 /* Fill in our line protocol discipline, and register it */
3228 int status = tty_register_ldisc(N_GSM0710, &tty_ldisc_packet);
3229 if (status != 0) {
3230 pr_err("n_gsm: can't register line discipline (err = %d)\n",
3231 status);
3232 return status;
3235 gsm_tty_driver = alloc_tty_driver(256);
3236 if (!gsm_tty_driver) {
3237 tty_unregister_ldisc(N_GSM0710);
3238 pr_err("gsm_init: tty allocation failed.\n");
3239 return -EINVAL;
3241 gsm_tty_driver->driver_name = "gsmtty";
3242 gsm_tty_driver->name = "gsmtty";
3243 gsm_tty_driver->major = 0; /* Dynamic */
3244 gsm_tty_driver->minor_start = 0;
3245 gsm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
3246 gsm_tty_driver->subtype = SERIAL_TYPE_NORMAL;
3247 gsm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV
3248 | TTY_DRIVER_HARDWARE_BREAK;
3249 gsm_tty_driver->init_termios = tty_std_termios;
3250 /* Fixme */
3251 gsm_tty_driver->init_termios.c_lflag &= ~ECHO;
3252 tty_set_operations(gsm_tty_driver, &gsmtty_ops);
3254 spin_lock_init(&gsm_mux_lock);
3256 if (tty_register_driver(gsm_tty_driver)) {
3257 put_tty_driver(gsm_tty_driver);
3258 tty_unregister_ldisc(N_GSM0710);
3259 pr_err("gsm_init: tty registration failed.\n");
3260 return -EBUSY;
3262 pr_debug("gsm_init: loaded as %d,%d.\n",
3263 gsm_tty_driver->major, gsm_tty_driver->minor_start);
3264 return 0;
3267 static void __exit gsm_exit(void)
3269 int status = tty_unregister_ldisc(N_GSM0710);
3270 if (status != 0)
3271 pr_err("n_gsm: can't unregister line discipline (err = %d)\n",
3272 status);
3273 tty_unregister_driver(gsm_tty_driver);
3274 put_tty_driver(gsm_tty_driver);
3277 module_init(gsm_init);
3278 module_exit(gsm_exit);
3281 MODULE_LICENSE("GPL");
3282 MODULE_ALIAS_LDISC(N_GSM0710);