dm writecache: add cond_resched to loop in persistent_memory_claim()
[linux/fpc-iii.git] / drivers / tty / n_gsm.c
blobf189579db7c4cac3388e7d3aea34888e8679088f
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * n_gsm.c GSM 0710 tty multiplexor
4 * Copyright (c) 2009/10 Intel Corporation
6 * * THIS IS A DEVELOPMENT SNAPSHOT IT IS NOT A FINAL RELEASE *
8 * TO DO:
9 * Mostly done: ioctls for setting modes/timing
10 * Partly done: hooks so you can pull off frames to non tty devs
11 * Restart DLCI 0 when it closes ?
12 * Improve the tx engine
13 * Resolve tx side locking by adding a queue_head and routing
14 * all control traffic via it
15 * General tidy/document
16 * Review the locking/move to refcounts more (mux now moved to an
17 * alloc/free model ready)
18 * Use newest tty open/close port helpers and install hooks
19 * What to do about power functions ?
20 * Termios setting and negotiation
21 * Do we need a 'which mux are you' ioctl to correlate mux and tty sets
25 #include <linux/types.h>
26 #include <linux/major.h>
27 #include <linux/errno.h>
28 #include <linux/signal.h>
29 #include <linux/fcntl.h>
30 #include <linux/sched/signal.h>
31 #include <linux/interrupt.h>
32 #include <linux/tty.h>
33 #include <linux/ctype.h>
34 #include <linux/mm.h>
35 #include <linux/string.h>
36 #include <linux/slab.h>
37 #include <linux/poll.h>
38 #include <linux/bitops.h>
39 #include <linux/file.h>
40 #include <linux/uaccess.h>
41 #include <linux/module.h>
42 #include <linux/timer.h>
43 #include <linux/tty_flip.h>
44 #include <linux/tty_driver.h>
45 #include <linux/serial.h>
46 #include <linux/kfifo.h>
47 #include <linux/skbuff.h>
48 #include <net/arp.h>
49 #include <linux/ip.h>
50 #include <linux/netdevice.h>
51 #include <linux/etherdevice.h>
52 #include <linux/gsmmux.h>
54 static int debug;
55 module_param(debug, int, 0600);
57 /* Defaults: these are from the specification */
59 #define T1 10 /* 100mS */
60 #define T2 34 /* 333mS */
61 #define N2 3 /* Retry 3 times */
63 /* Use long timers for testing at low speed with debug on */
64 #ifdef DEBUG_TIMING
65 #define T1 100
66 #define T2 200
67 #endif
70 * Semi-arbitrary buffer size limits. 0710 is normally run with 32-64 byte
71 * limits so this is plenty
73 #define MAX_MRU 1500
74 #define MAX_MTU 1500
75 #define GSM_NET_TX_TIMEOUT (HZ*10)
77 /**
78 * struct gsm_mux_net - network interface
79 * @struct gsm_dlci* dlci
81 * Created when net interface is initialized.
82 **/
83 struct gsm_mux_net {
84 struct kref ref;
85 struct gsm_dlci *dlci;
89 * Each block of data we have queued to go out is in the form of
90 * a gsm_msg which holds everything we need in a link layer independent
91 * format
94 struct gsm_msg {
95 struct list_head list;
96 u8 addr; /* DLCI address + flags */
97 u8 ctrl; /* Control byte + flags */
98 unsigned int len; /* Length of data block (can be zero) */
99 unsigned char *data; /* Points into buffer but not at the start */
100 unsigned char buffer[];
103 enum gsm_dlci_state {
104 DLCI_CLOSED,
105 DLCI_OPENING, /* Sending SABM not seen UA */
106 DLCI_OPEN, /* SABM/UA complete */
107 DLCI_CLOSING, /* Sending DISC not seen UA/DM */
110 enum gsm_dlci_mode {
111 DLCI_MODE_ABM, /* Normal Asynchronous Balanced Mode */
112 DLCI_MODE_ADM, /* Asynchronous Disconnected Mode */
116 * Each active data link has a gsm_dlci structure associated which ties
117 * the link layer to an optional tty (if the tty side is open). To avoid
118 * complexity right now these are only ever freed up when the mux is
119 * shut down.
121 * At the moment we don't free DLCI objects until the mux is torn down
122 * this avoid object life time issues but might be worth review later.
125 struct gsm_dlci {
126 struct gsm_mux *gsm;
127 int addr;
128 enum gsm_dlci_state state;
129 struct mutex mutex;
131 /* Link layer */
132 enum gsm_dlci_mode mode;
133 spinlock_t lock; /* Protects the internal state */
134 struct timer_list t1; /* Retransmit timer for SABM and UA */
135 int retries;
136 /* Uplink tty if active */
137 struct tty_port port; /* The tty bound to this DLCI if there is one */
138 struct kfifo fifo; /* Queue fifo for the DLCI */
139 int adaption; /* Adaption layer in use */
140 int prev_adaption;
141 u32 modem_rx; /* Our incoming virtual modem lines */
142 u32 modem_tx; /* Our outgoing modem lines */
143 bool dead; /* Refuse re-open */
144 /* Flow control */
145 bool throttled; /* Private copy of throttle state */
146 bool constipated; /* Throttle status for outgoing */
147 /* Packetised I/O */
148 struct sk_buff *skb; /* Frame being sent */
149 struct sk_buff_head skb_list; /* Queued frames */
150 /* Data handling callback */
151 void (*data)(struct gsm_dlci *dlci, const u8 *data, int len);
152 void (*prev_data)(struct gsm_dlci *dlci, const u8 *data, int len);
153 struct net_device *net; /* network interface, if created */
156 /* DLCI 0, 62/63 are special or reserved see gsmtty_open */
158 #define NUM_DLCI 64
161 * DLCI 0 is used to pass control blocks out of band of the data
162 * flow (and with a higher link priority). One command can be outstanding
163 * at a time and we use this structure to manage them. They are created
164 * and destroyed by the user context, and updated by the receive paths
165 * and timers
168 struct gsm_control {
169 u8 cmd; /* Command we are issuing */
170 u8 *data; /* Data for the command in case we retransmit */
171 int len; /* Length of block for retransmission */
172 int done; /* Done flag */
173 int error; /* Error if any */
176 enum gsm_mux_state {
177 GSM_SEARCH,
178 GSM_START,
179 GSM_ADDRESS,
180 GSM_CONTROL,
181 GSM_LEN,
182 GSM_DATA,
183 GSM_FCS,
184 GSM_OVERRUN,
185 GSM_LEN0,
186 GSM_LEN1,
187 GSM_SSOF,
191 * Each GSM mux we have is represented by this structure. If we are
192 * operating as an ldisc then we use this structure as our ldisc
193 * state. We need to sort out lifetimes and locking with respect
194 * to the gsm mux array. For now we don't free DLCI objects that
195 * have been instantiated until the mux itself is terminated.
197 * To consider further: tty open versus mux shutdown.
200 struct gsm_mux {
201 struct tty_struct *tty; /* The tty our ldisc is bound to */
202 spinlock_t lock;
203 struct mutex mutex;
204 unsigned int num;
205 struct kref ref;
207 /* Events on the GSM channel */
208 wait_queue_head_t event;
210 /* Bits for GSM mode decoding */
212 /* Framing Layer */
213 unsigned char *buf;
214 enum gsm_mux_state state;
215 unsigned int len;
216 unsigned int address;
217 unsigned int count;
218 bool escape;
219 int encoding;
220 u8 control;
221 u8 fcs;
222 u8 received_fcs;
223 u8 *txframe; /* TX framing buffer */
225 /* Methods for the receiver side */
226 void (*receive)(struct gsm_mux *gsm, u8 ch);
227 void (*error)(struct gsm_mux *gsm, u8 ch, u8 flag);
228 /* And transmit side */
229 int (*output)(struct gsm_mux *mux, u8 *data, int len);
231 /* Link Layer */
232 unsigned int mru;
233 unsigned int mtu;
234 int initiator; /* Did we initiate connection */
235 bool dead; /* Has the mux been shut down */
236 struct gsm_dlci *dlci[NUM_DLCI];
237 bool constipated; /* Asked by remote to shut up */
239 spinlock_t tx_lock;
240 unsigned int tx_bytes; /* TX data outstanding */
241 #define TX_THRESH_HI 8192
242 #define TX_THRESH_LO 2048
243 struct list_head tx_list; /* Pending data packets */
245 /* Control messages */
246 struct timer_list t2_timer; /* Retransmit timer for commands */
247 int cretries; /* Command retry counter */
248 struct gsm_control *pending_cmd;/* Our current pending command */
249 spinlock_t control_lock; /* Protects the pending command */
251 /* Configuration */
252 int adaption; /* 1 or 2 supported */
253 u8 ftype; /* UI or UIH */
254 int t1, t2; /* Timers in 1/100th of a sec */
255 int n2; /* Retry count */
257 /* Statistics (not currently exposed) */
258 unsigned long bad_fcs;
259 unsigned long malformed;
260 unsigned long io_error;
261 unsigned long bad_size;
262 unsigned long unsupported;
267 * Mux objects - needed so that we can translate a tty index into the
268 * relevant mux and DLCI.
271 #define MAX_MUX 4 /* 256 minors */
272 static struct gsm_mux *gsm_mux[MAX_MUX]; /* GSM muxes */
273 static spinlock_t gsm_mux_lock;
275 static struct tty_driver *gsm_tty_driver;
278 * This section of the driver logic implements the GSM encodings
279 * both the basic and the 'advanced'. Reliable transport is not
280 * supported.
283 #define CR 0x02
284 #define EA 0x01
285 #define PF 0x10
287 /* I is special: the rest are ..*/
288 #define RR 0x01
289 #define UI 0x03
290 #define RNR 0x05
291 #define REJ 0x09
292 #define DM 0x0F
293 #define SABM 0x2F
294 #define DISC 0x43
295 #define UA 0x63
296 #define UIH 0xEF
298 /* Channel commands */
299 #define CMD_NSC 0x09
300 #define CMD_TEST 0x11
301 #define CMD_PSC 0x21
302 #define CMD_RLS 0x29
303 #define CMD_FCOFF 0x31
304 #define CMD_PN 0x41
305 #define CMD_RPN 0x49
306 #define CMD_FCON 0x51
307 #define CMD_CLD 0x61
308 #define CMD_SNC 0x69
309 #define CMD_MSC 0x71
311 /* Virtual modem bits */
312 #define MDM_FC 0x01
313 #define MDM_RTC 0x02
314 #define MDM_RTR 0x04
315 #define MDM_IC 0x20
316 #define MDM_DV 0x40
318 #define GSM0_SOF 0xF9
319 #define GSM1_SOF 0x7E
320 #define GSM1_ESCAPE 0x7D
321 #define GSM1_ESCAPE_BITS 0x20
322 #define XON 0x11
323 #define XOFF 0x13
325 static const struct tty_port_operations gsm_port_ops;
328 * CRC table for GSM 0710
331 static const u8 gsm_fcs8[256] = {
332 0x00, 0x91, 0xE3, 0x72, 0x07, 0x96, 0xE4, 0x75,
333 0x0E, 0x9F, 0xED, 0x7C, 0x09, 0x98, 0xEA, 0x7B,
334 0x1C, 0x8D, 0xFF, 0x6E, 0x1B, 0x8A, 0xF8, 0x69,
335 0x12, 0x83, 0xF1, 0x60, 0x15, 0x84, 0xF6, 0x67,
336 0x38, 0xA9, 0xDB, 0x4A, 0x3F, 0xAE, 0xDC, 0x4D,
337 0x36, 0xA7, 0xD5, 0x44, 0x31, 0xA0, 0xD2, 0x43,
338 0x24, 0xB5, 0xC7, 0x56, 0x23, 0xB2, 0xC0, 0x51,
339 0x2A, 0xBB, 0xC9, 0x58, 0x2D, 0xBC, 0xCE, 0x5F,
340 0x70, 0xE1, 0x93, 0x02, 0x77, 0xE6, 0x94, 0x05,
341 0x7E, 0xEF, 0x9D, 0x0C, 0x79, 0xE8, 0x9A, 0x0B,
342 0x6C, 0xFD, 0x8F, 0x1E, 0x6B, 0xFA, 0x88, 0x19,
343 0x62, 0xF3, 0x81, 0x10, 0x65, 0xF4, 0x86, 0x17,
344 0x48, 0xD9, 0xAB, 0x3A, 0x4F, 0xDE, 0xAC, 0x3D,
345 0x46, 0xD7, 0xA5, 0x34, 0x41, 0xD0, 0xA2, 0x33,
346 0x54, 0xC5, 0xB7, 0x26, 0x53, 0xC2, 0xB0, 0x21,
347 0x5A, 0xCB, 0xB9, 0x28, 0x5D, 0xCC, 0xBE, 0x2F,
348 0xE0, 0x71, 0x03, 0x92, 0xE7, 0x76, 0x04, 0x95,
349 0xEE, 0x7F, 0x0D, 0x9C, 0xE9, 0x78, 0x0A, 0x9B,
350 0xFC, 0x6D, 0x1F, 0x8E, 0xFB, 0x6A, 0x18, 0x89,
351 0xF2, 0x63, 0x11, 0x80, 0xF5, 0x64, 0x16, 0x87,
352 0xD8, 0x49, 0x3B, 0xAA, 0xDF, 0x4E, 0x3C, 0xAD,
353 0xD6, 0x47, 0x35, 0xA4, 0xD1, 0x40, 0x32, 0xA3,
354 0xC4, 0x55, 0x27, 0xB6, 0xC3, 0x52, 0x20, 0xB1,
355 0xCA, 0x5B, 0x29, 0xB8, 0xCD, 0x5C, 0x2E, 0xBF,
356 0x90, 0x01, 0x73, 0xE2, 0x97, 0x06, 0x74, 0xE5,
357 0x9E, 0x0F, 0x7D, 0xEC, 0x99, 0x08, 0x7A, 0xEB,
358 0x8C, 0x1D, 0x6F, 0xFE, 0x8B, 0x1A, 0x68, 0xF9,
359 0x82, 0x13, 0x61, 0xF0, 0x85, 0x14, 0x66, 0xF7,
360 0xA8, 0x39, 0x4B, 0xDA, 0xAF, 0x3E, 0x4C, 0xDD,
361 0xA6, 0x37, 0x45, 0xD4, 0xA1, 0x30, 0x42, 0xD3,
362 0xB4, 0x25, 0x57, 0xC6, 0xB3, 0x22, 0x50, 0xC1,
363 0xBA, 0x2B, 0x59, 0xC8, 0xBD, 0x2C, 0x5E, 0xCF
366 #define INIT_FCS 0xFF
367 #define GOOD_FCS 0xCF
370 * gsm_fcs_add - update FCS
371 * @fcs: Current FCS
372 * @c: Next data
374 * Update the FCS to include c. Uses the algorithm in the specification
375 * notes.
378 static inline u8 gsm_fcs_add(u8 fcs, u8 c)
380 return gsm_fcs8[fcs ^ c];
384 * gsm_fcs_add_block - update FCS for a block
385 * @fcs: Current FCS
386 * @c: buffer of data
387 * @len: length of buffer
389 * Update the FCS to include c. Uses the algorithm in the specification
390 * notes.
393 static inline u8 gsm_fcs_add_block(u8 fcs, u8 *c, int len)
395 while (len--)
396 fcs = gsm_fcs8[fcs ^ *c++];
397 return fcs;
401 * gsm_read_ea - read a byte into an EA
402 * @val: variable holding value
403 * c: byte going into the EA
405 * Processes one byte of an EA. Updates the passed variable
406 * and returns 1 if the EA is now completely read
409 static int gsm_read_ea(unsigned int *val, u8 c)
411 /* Add the next 7 bits into the value */
412 *val <<= 7;
413 *val |= c >> 1;
414 /* Was this the last byte of the EA 1 = yes*/
415 return c & EA;
419 * gsm_encode_modem - encode modem data bits
420 * @dlci: DLCI to encode from
422 * Returns the correct GSM encoded modem status bits (6 bit field) for
423 * the current status of the DLCI and attached tty object
426 static u8 gsm_encode_modem(const struct gsm_dlci *dlci)
428 u8 modembits = 0;
429 /* FC is true flow control not modem bits */
430 if (dlci->throttled)
431 modembits |= MDM_FC;
432 if (dlci->modem_tx & TIOCM_DTR)
433 modembits |= MDM_RTC;
434 if (dlci->modem_tx & TIOCM_RTS)
435 modembits |= MDM_RTR;
436 if (dlci->modem_tx & TIOCM_RI)
437 modembits |= MDM_IC;
438 if (dlci->modem_tx & TIOCM_CD)
439 modembits |= MDM_DV;
440 return modembits;
444 * gsm_print_packet - display a frame for debug
445 * @hdr: header to print before decode
446 * @addr: address EA from the frame
447 * @cr: C/R bit from the frame
448 * @control: control including PF bit
449 * @data: following data bytes
450 * @dlen: length of data
452 * Displays a packet in human readable format for debugging purposes. The
453 * style is based on amateur radio LAP-B dump display.
456 static void gsm_print_packet(const char *hdr, int addr, int cr,
457 u8 control, const u8 *data, int dlen)
459 if (!(debug & 1))
460 return;
462 pr_info("%s %d) %c: ", hdr, addr, "RC"[cr]);
464 switch (control & ~PF) {
465 case SABM:
466 pr_cont("SABM");
467 break;
468 case UA:
469 pr_cont("UA");
470 break;
471 case DISC:
472 pr_cont("DISC");
473 break;
474 case DM:
475 pr_cont("DM");
476 break;
477 case UI:
478 pr_cont("UI");
479 break;
480 case UIH:
481 pr_cont("UIH");
482 break;
483 default:
484 if (!(control & 0x01)) {
485 pr_cont("I N(S)%d N(R)%d",
486 (control & 0x0E) >> 1, (control & 0xE0) >> 5);
487 } else switch (control & 0x0F) {
488 case RR:
489 pr_cont("RR(%d)", (control & 0xE0) >> 5);
490 break;
491 case RNR:
492 pr_cont("RNR(%d)", (control & 0xE0) >> 5);
493 break;
494 case REJ:
495 pr_cont("REJ(%d)", (control & 0xE0) >> 5);
496 break;
497 default:
498 pr_cont("[%02X]", control);
502 if (control & PF)
503 pr_cont("(P)");
504 else
505 pr_cont("(F)");
507 if (dlen) {
508 int ct = 0;
509 while (dlen--) {
510 if (ct % 8 == 0) {
511 pr_cont("\n");
512 pr_debug(" ");
514 pr_cont("%02X ", *data++);
515 ct++;
518 pr_cont("\n");
523 * Link level transmission side
527 * gsm_stuff_packet - bytestuff a packet
528 * @ibuf: input
529 * @obuf: output
530 * @len: length of input
532 * Expand a buffer by bytestuffing it. The worst case size change
533 * is doubling and the caller is responsible for handing out
534 * suitable sized buffers.
537 static int gsm_stuff_frame(const u8 *input, u8 *output, int len)
539 int olen = 0;
540 while (len--) {
541 if (*input == GSM1_SOF || *input == GSM1_ESCAPE
542 || *input == XON || *input == XOFF) {
543 *output++ = GSM1_ESCAPE;
544 *output++ = *input++ ^ GSM1_ESCAPE_BITS;
545 olen++;
546 } else
547 *output++ = *input++;
548 olen++;
550 return olen;
554 * gsm_send - send a control frame
555 * @gsm: our GSM mux
556 * @addr: address for control frame
557 * @cr: command/response bit
558 * @control: control byte including PF bit
560 * Format up and transmit a control frame. These do not go via the
561 * queueing logic as they should be transmitted ahead of data when
562 * they are needed.
564 * FIXME: Lock versus data TX path
567 static void gsm_send(struct gsm_mux *gsm, int addr, int cr, int control)
569 int len;
570 u8 cbuf[10];
571 u8 ibuf[3];
573 switch (gsm->encoding) {
574 case 0:
575 cbuf[0] = GSM0_SOF;
576 cbuf[1] = (addr << 2) | (cr << 1) | EA;
577 cbuf[2] = control;
578 cbuf[3] = EA; /* Length of data = 0 */
579 cbuf[4] = 0xFF - gsm_fcs_add_block(INIT_FCS, cbuf + 1, 3);
580 cbuf[5] = GSM0_SOF;
581 len = 6;
582 break;
583 case 1:
584 case 2:
585 /* Control frame + packing (but not frame stuffing) in mode 1 */
586 ibuf[0] = (addr << 2) | (cr << 1) | EA;
587 ibuf[1] = control;
588 ibuf[2] = 0xFF - gsm_fcs_add_block(INIT_FCS, ibuf, 2);
589 /* Stuffing may double the size worst case */
590 len = gsm_stuff_frame(ibuf, cbuf + 1, 3);
591 /* Now add the SOF markers */
592 cbuf[0] = GSM1_SOF;
593 cbuf[len + 1] = GSM1_SOF;
594 /* FIXME: we can omit the lead one in many cases */
595 len += 2;
596 break;
597 default:
598 WARN_ON(1);
599 return;
601 gsm->output(gsm, cbuf, len);
602 gsm_print_packet("-->", addr, cr, control, NULL, 0);
606 * gsm_response - send a control response
607 * @gsm: our GSM mux
608 * @addr: address for control frame
609 * @control: control byte including PF bit
611 * Format up and transmit a link level response frame.
614 static inline void gsm_response(struct gsm_mux *gsm, int addr, int control)
616 gsm_send(gsm, addr, 0, control);
620 * gsm_command - send a control command
621 * @gsm: our GSM mux
622 * @addr: address for control frame
623 * @control: control byte including PF bit
625 * Format up and transmit a link level command frame.
628 static inline void gsm_command(struct gsm_mux *gsm, int addr, int control)
630 gsm_send(gsm, addr, 1, control);
633 /* Data transmission */
635 #define HDR_LEN 6 /* ADDR CTRL [LEN.2] DATA FCS */
638 * gsm_data_alloc - allocate data frame
639 * @gsm: GSM mux
640 * @addr: DLCI address
641 * @len: length excluding header and FCS
642 * @ctrl: control byte
644 * Allocate a new data buffer for sending frames with data. Space is left
645 * at the front for header bytes but that is treated as an implementation
646 * detail and not for the high level code to use
649 static struct gsm_msg *gsm_data_alloc(struct gsm_mux *gsm, u8 addr, int len,
650 u8 ctrl)
652 struct gsm_msg *m = kmalloc(sizeof(struct gsm_msg) + len + HDR_LEN,
653 GFP_ATOMIC);
654 if (m == NULL)
655 return NULL;
656 m->data = m->buffer + HDR_LEN - 1; /* Allow for FCS */
657 m->len = len;
658 m->addr = addr;
659 m->ctrl = ctrl;
660 INIT_LIST_HEAD(&m->list);
661 return m;
665 * gsm_data_kick - poke the queue
666 * @gsm: GSM Mux
668 * The tty device has called us to indicate that room has appeared in
669 * the transmit queue. Ram more data into the pipe if we have any
670 * If we have been flow-stopped by a CMD_FCOFF, then we can only
671 * send messages on DLCI0 until CMD_FCON
673 * FIXME: lock against link layer control transmissions
676 static void gsm_data_kick(struct gsm_mux *gsm, struct gsm_dlci *dlci)
678 struct gsm_msg *msg, *nmsg;
679 int len;
681 list_for_each_entry_safe(msg, nmsg, &gsm->tx_list, list) {
682 if (gsm->constipated && msg->addr)
683 continue;
684 if (gsm->encoding != 0) {
685 gsm->txframe[0] = GSM1_SOF;
686 len = gsm_stuff_frame(msg->data,
687 gsm->txframe + 1, msg->len);
688 gsm->txframe[len + 1] = GSM1_SOF;
689 len += 2;
690 } else {
691 gsm->txframe[0] = GSM0_SOF;
692 memcpy(gsm->txframe + 1 , msg->data, msg->len);
693 gsm->txframe[msg->len + 1] = GSM0_SOF;
694 len = msg->len + 2;
697 if (debug & 4)
698 print_hex_dump_bytes("gsm_data_kick: ",
699 DUMP_PREFIX_OFFSET,
700 gsm->txframe, len);
701 if (gsm->output(gsm, gsm->txframe, len) < 0)
702 break;
703 /* FIXME: Can eliminate one SOF in many more cases */
704 gsm->tx_bytes -= msg->len;
706 list_del(&msg->list);
707 kfree(msg);
709 if (dlci) {
710 tty_port_tty_wakeup(&dlci->port);
711 } else {
712 int i = 0;
714 for (i = 0; i < NUM_DLCI; i++)
715 if (gsm->dlci[i])
716 tty_port_tty_wakeup(&gsm->dlci[i]->port);
722 * __gsm_data_queue - queue a UI or UIH frame
723 * @dlci: DLCI sending the data
724 * @msg: message queued
726 * Add data to the transmit queue and try and get stuff moving
727 * out of the mux tty if not already doing so. The Caller must hold
728 * the gsm tx lock.
731 static void __gsm_data_queue(struct gsm_dlci *dlci, struct gsm_msg *msg)
733 struct gsm_mux *gsm = dlci->gsm;
734 u8 *dp = msg->data;
735 u8 *fcs = dp + msg->len;
737 /* Fill in the header */
738 if (gsm->encoding == 0) {
739 if (msg->len < 128)
740 *--dp = (msg->len << 1) | EA;
741 else {
742 *--dp = (msg->len >> 7); /* bits 7 - 15 */
743 *--dp = (msg->len & 127) << 1; /* bits 0 - 6 */
747 *--dp = msg->ctrl;
748 if (gsm->initiator)
749 *--dp = (msg->addr << 2) | 2 | EA;
750 else
751 *--dp = (msg->addr << 2) | EA;
752 *fcs = gsm_fcs_add_block(INIT_FCS, dp , msg->data - dp);
753 /* Ugly protocol layering violation */
754 if (msg->ctrl == UI || msg->ctrl == (UI|PF))
755 *fcs = gsm_fcs_add_block(*fcs, msg->data, msg->len);
756 *fcs = 0xFF - *fcs;
758 gsm_print_packet("Q> ", msg->addr, gsm->initiator, msg->ctrl,
759 msg->data, msg->len);
761 /* Move the header back and adjust the length, also allow for the FCS
762 now tacked on the end */
763 msg->len += (msg->data - dp) + 1;
764 msg->data = dp;
766 /* Add to the actual output queue */
767 list_add_tail(&msg->list, &gsm->tx_list);
768 gsm->tx_bytes += msg->len;
769 gsm_data_kick(gsm, dlci);
773 * gsm_data_queue - queue a UI or UIH frame
774 * @dlci: DLCI sending the data
775 * @msg: message queued
777 * Add data to the transmit queue and try and get stuff moving
778 * out of the mux tty if not already doing so. Take the
779 * the gsm tx lock and dlci lock.
782 static void gsm_data_queue(struct gsm_dlci *dlci, struct gsm_msg *msg)
784 unsigned long flags;
785 spin_lock_irqsave(&dlci->gsm->tx_lock, flags);
786 __gsm_data_queue(dlci, msg);
787 spin_unlock_irqrestore(&dlci->gsm->tx_lock, flags);
791 * gsm_dlci_data_output - try and push data out of a DLCI
792 * @gsm: mux
793 * @dlci: the DLCI to pull data from
795 * Pull data from a DLCI and send it into the transmit queue if there
796 * is data. Keep to the MRU of the mux. This path handles the usual tty
797 * interface which is a byte stream with optional modem data.
799 * Caller must hold the tx_lock of the mux.
802 static int gsm_dlci_data_output(struct gsm_mux *gsm, struct gsm_dlci *dlci)
804 struct gsm_msg *msg;
805 u8 *dp;
806 int len, total_size, size;
807 int h = dlci->adaption - 1;
809 total_size = 0;
810 while (1) {
811 len = kfifo_len(&dlci->fifo);
812 if (len == 0)
813 return total_size;
815 /* MTU/MRU count only the data bits */
816 if (len > gsm->mtu)
817 len = gsm->mtu;
819 size = len + h;
821 msg = gsm_data_alloc(gsm, dlci->addr, size, gsm->ftype);
822 /* FIXME: need a timer or something to kick this so it can't
823 get stuck with no work outstanding and no buffer free */
824 if (msg == NULL)
825 return -ENOMEM;
826 dp = msg->data;
827 switch (dlci->adaption) {
828 case 1: /* Unstructured */
829 break;
830 case 2: /* Unstructed with modem bits.
831 Always one byte as we never send inline break data */
832 *dp++ = gsm_encode_modem(dlci);
833 break;
835 WARN_ON(kfifo_out_locked(&dlci->fifo, dp , len, &dlci->lock) != len);
836 __gsm_data_queue(dlci, msg);
837 total_size += size;
839 /* Bytes of data we used up */
840 return total_size;
844 * gsm_dlci_data_output_framed - try and push data out of a DLCI
845 * @gsm: mux
846 * @dlci: the DLCI to pull data from
848 * Pull data from a DLCI and send it into the transmit queue if there
849 * is data. Keep to the MRU of the mux. This path handles framed data
850 * queued as skbuffs to the DLCI.
852 * Caller must hold the tx_lock of the mux.
855 static int gsm_dlci_data_output_framed(struct gsm_mux *gsm,
856 struct gsm_dlci *dlci)
858 struct gsm_msg *msg;
859 u8 *dp;
860 int len, size;
861 int last = 0, first = 0;
862 int overhead = 0;
864 /* One byte per frame is used for B/F flags */
865 if (dlci->adaption == 4)
866 overhead = 1;
868 /* dlci->skb is locked by tx_lock */
869 if (dlci->skb == NULL) {
870 dlci->skb = skb_dequeue_tail(&dlci->skb_list);
871 if (dlci->skb == NULL)
872 return 0;
873 first = 1;
875 len = dlci->skb->len + overhead;
877 /* MTU/MRU count only the data bits */
878 if (len > gsm->mtu) {
879 if (dlci->adaption == 3) {
880 /* Over long frame, bin it */
881 dev_kfree_skb_any(dlci->skb);
882 dlci->skb = NULL;
883 return 0;
885 len = gsm->mtu;
886 } else
887 last = 1;
889 size = len + overhead;
890 msg = gsm_data_alloc(gsm, dlci->addr, size, gsm->ftype);
892 /* FIXME: need a timer or something to kick this so it can't
893 get stuck with no work outstanding and no buffer free */
894 if (msg == NULL) {
895 skb_queue_tail(&dlci->skb_list, dlci->skb);
896 dlci->skb = NULL;
897 return -ENOMEM;
899 dp = msg->data;
901 if (dlci->adaption == 4) { /* Interruptible framed (Packetised Data) */
902 /* Flag byte to carry the start/end info */
903 *dp++ = last << 7 | first << 6 | 1; /* EA */
904 len--;
906 memcpy(dp, dlci->skb->data, len);
907 skb_pull(dlci->skb, len);
908 __gsm_data_queue(dlci, msg);
909 if (last) {
910 dev_kfree_skb_any(dlci->skb);
911 dlci->skb = NULL;
913 return size;
917 * gsm_dlci_data_sweep - look for data to send
918 * @gsm: the GSM mux
920 * Sweep the GSM mux channels in priority order looking for ones with
921 * data to send. We could do with optimising this scan a bit. We aim
922 * to fill the queue totally or up to TX_THRESH_HI bytes. Once we hit
923 * TX_THRESH_LO we get called again
925 * FIXME: We should round robin between groups and in theory you can
926 * renegotiate DLCI priorities with optional stuff. Needs optimising.
929 static void gsm_dlci_data_sweep(struct gsm_mux *gsm)
931 int len;
932 /* Priority ordering: We should do priority with RR of the groups */
933 int i = 1;
935 while (i < NUM_DLCI) {
936 struct gsm_dlci *dlci;
938 if (gsm->tx_bytes > TX_THRESH_HI)
939 break;
940 dlci = gsm->dlci[i];
941 if (dlci == NULL || dlci->constipated) {
942 i++;
943 continue;
945 if (dlci->adaption < 3 && !dlci->net)
946 len = gsm_dlci_data_output(gsm, dlci);
947 else
948 len = gsm_dlci_data_output_framed(gsm, dlci);
949 if (len < 0)
950 break;
951 /* DLCI empty - try the next */
952 if (len == 0)
953 i++;
958 * gsm_dlci_data_kick - transmit if possible
959 * @dlci: DLCI to kick
961 * Transmit data from this DLCI if the queue is empty. We can't rely on
962 * a tty wakeup except when we filled the pipe so we need to fire off
963 * new data ourselves in other cases.
966 static void gsm_dlci_data_kick(struct gsm_dlci *dlci)
968 unsigned long flags;
969 int sweep;
971 if (dlci->constipated)
972 return;
974 spin_lock_irqsave(&dlci->gsm->tx_lock, flags);
975 /* If we have nothing running then we need to fire up */
976 sweep = (dlci->gsm->tx_bytes < TX_THRESH_LO);
977 if (dlci->gsm->tx_bytes == 0) {
978 if (dlci->net)
979 gsm_dlci_data_output_framed(dlci->gsm, dlci);
980 else
981 gsm_dlci_data_output(dlci->gsm, dlci);
983 if (sweep)
984 gsm_dlci_data_sweep(dlci->gsm);
985 spin_unlock_irqrestore(&dlci->gsm->tx_lock, flags);
989 * Control message processing
994 * gsm_control_reply - send a response frame to a control
995 * @gsm: gsm channel
996 * @cmd: the command to use
997 * @data: data to follow encoded info
998 * @dlen: length of data
1000 * Encode up and queue a UI/UIH frame containing our response.
1003 static void gsm_control_reply(struct gsm_mux *gsm, int cmd, const u8 *data,
1004 int dlen)
1006 struct gsm_msg *msg;
1007 msg = gsm_data_alloc(gsm, 0, dlen + 2, gsm->ftype);
1008 if (msg == NULL)
1009 return;
1010 msg->data[0] = (cmd & 0xFE) << 1 | EA; /* Clear C/R */
1011 msg->data[1] = (dlen << 1) | EA;
1012 memcpy(msg->data + 2, data, dlen);
1013 gsm_data_queue(gsm->dlci[0], msg);
1017 * gsm_process_modem - process received modem status
1018 * @tty: virtual tty bound to the DLCI
1019 * @dlci: DLCI to affect
1020 * @modem: modem bits (full EA)
1022 * Used when a modem control message or line state inline in adaption
1023 * layer 2 is processed. Sort out the local modem state and throttles
1026 static void gsm_process_modem(struct tty_struct *tty, struct gsm_dlci *dlci,
1027 u32 modem, int clen)
1029 int mlines = 0;
1030 u8 brk = 0;
1031 int fc;
1033 /* The modem status command can either contain one octet (v.24 signals)
1034 or two octets (v.24 signals + break signals). The length field will
1035 either be 2 or 3 respectively. This is specified in section
1036 5.4.6.3.7 of the 27.010 mux spec. */
1038 if (clen == 2)
1039 modem = modem & 0x7f;
1040 else {
1041 brk = modem & 0x7f;
1042 modem = (modem >> 7) & 0x7f;
1045 /* Flow control/ready to communicate */
1046 fc = (modem & MDM_FC) || !(modem & MDM_RTR);
1047 if (fc && !dlci->constipated) {
1048 /* Need to throttle our output on this device */
1049 dlci->constipated = true;
1050 } else if (!fc && dlci->constipated) {
1051 dlci->constipated = false;
1052 gsm_dlci_data_kick(dlci);
1055 /* Map modem bits */
1056 if (modem & MDM_RTC)
1057 mlines |= TIOCM_DSR | TIOCM_DTR;
1058 if (modem & MDM_RTR)
1059 mlines |= TIOCM_RTS | TIOCM_CTS;
1060 if (modem & MDM_IC)
1061 mlines |= TIOCM_RI;
1062 if (modem & MDM_DV)
1063 mlines |= TIOCM_CD;
1065 /* Carrier drop -> hangup */
1066 if (tty) {
1067 if ((mlines & TIOCM_CD) == 0 && (dlci->modem_rx & TIOCM_CD))
1068 if (!C_CLOCAL(tty))
1069 tty_hangup(tty);
1071 if (brk & 0x01)
1072 tty_insert_flip_char(&dlci->port, 0, TTY_BREAK);
1073 dlci->modem_rx = mlines;
1077 * gsm_control_modem - modem status received
1078 * @gsm: GSM channel
1079 * @data: data following command
1080 * @clen: command length
1082 * We have received a modem status control message. This is used by
1083 * the GSM mux protocol to pass virtual modem line status and optionally
1084 * to indicate break signals. Unpack it, convert to Linux representation
1085 * and if need be stuff a break message down the tty.
1088 static void gsm_control_modem(struct gsm_mux *gsm, const u8 *data, int clen)
1090 unsigned int addr = 0;
1091 unsigned int modem = 0;
1092 unsigned int brk = 0;
1093 struct gsm_dlci *dlci;
1094 int len = clen;
1095 const u8 *dp = data;
1096 struct tty_struct *tty;
1098 while (gsm_read_ea(&addr, *dp++) == 0) {
1099 len--;
1100 if (len == 0)
1101 return;
1103 /* Must be at least one byte following the EA */
1104 len--;
1105 if (len <= 0)
1106 return;
1108 addr >>= 1;
1109 /* Closed port, or invalid ? */
1110 if (addr == 0 || addr >= NUM_DLCI || gsm->dlci[addr] == NULL)
1111 return;
1112 dlci = gsm->dlci[addr];
1114 while (gsm_read_ea(&modem, *dp++) == 0) {
1115 len--;
1116 if (len == 0)
1117 return;
1119 len--;
1120 if (len > 0) {
1121 while (gsm_read_ea(&brk, *dp++) == 0) {
1122 len--;
1123 if (len == 0)
1124 return;
1126 modem <<= 7;
1127 modem |= (brk & 0x7f);
1129 tty = tty_port_tty_get(&dlci->port);
1130 gsm_process_modem(tty, dlci, modem, clen);
1131 if (tty) {
1132 tty_wakeup(tty);
1133 tty_kref_put(tty);
1135 gsm_control_reply(gsm, CMD_MSC, data, clen);
1139 * gsm_control_rls - remote line status
1140 * @gsm: GSM channel
1141 * @data: data bytes
1142 * @clen: data length
1144 * The modem sends us a two byte message on the control channel whenever
1145 * it wishes to send us an error state from the virtual link. Stuff
1146 * this into the uplink tty if present
1149 static void gsm_control_rls(struct gsm_mux *gsm, const u8 *data, int clen)
1151 struct tty_port *port;
1152 unsigned int addr = 0;
1153 u8 bits;
1154 int len = clen;
1155 const u8 *dp = data;
1157 while (gsm_read_ea(&addr, *dp++) == 0) {
1158 len--;
1159 if (len == 0)
1160 return;
1162 /* Must be at least one byte following ea */
1163 len--;
1164 if (len <= 0)
1165 return;
1166 addr >>= 1;
1167 /* Closed port, or invalid ? */
1168 if (addr == 0 || addr >= NUM_DLCI || gsm->dlci[addr] == NULL)
1169 return;
1170 /* No error ? */
1171 bits = *dp;
1172 if ((bits & 1) == 0)
1173 return;
1175 port = &gsm->dlci[addr]->port;
1177 if (bits & 2)
1178 tty_insert_flip_char(port, 0, TTY_OVERRUN);
1179 if (bits & 4)
1180 tty_insert_flip_char(port, 0, TTY_PARITY);
1181 if (bits & 8)
1182 tty_insert_flip_char(port, 0, TTY_FRAME);
1184 tty_flip_buffer_push(port);
1186 gsm_control_reply(gsm, CMD_RLS, data, clen);
1189 static void gsm_dlci_begin_close(struct gsm_dlci *dlci);
1192 * gsm_control_message - DLCI 0 control processing
1193 * @gsm: our GSM mux
1194 * @command: the command EA
1195 * @data: data beyond the command/length EAs
1196 * @clen: length
1198 * Input processor for control messages from the other end of the link.
1199 * Processes the incoming request and queues a response frame or an
1200 * NSC response if not supported
1203 static void gsm_control_message(struct gsm_mux *gsm, unsigned int command,
1204 const u8 *data, int clen)
1206 u8 buf[1];
1207 unsigned long flags;
1209 switch (command) {
1210 case CMD_CLD: {
1211 struct gsm_dlci *dlci = gsm->dlci[0];
1212 /* Modem wishes to close down */
1213 if (dlci) {
1214 dlci->dead = true;
1215 gsm->dead = true;
1216 gsm_dlci_begin_close(dlci);
1219 break;
1220 case CMD_TEST:
1221 /* Modem wishes to test, reply with the data */
1222 gsm_control_reply(gsm, CMD_TEST, data, clen);
1223 break;
1224 case CMD_FCON:
1225 /* Modem can accept data again */
1226 gsm->constipated = false;
1227 gsm_control_reply(gsm, CMD_FCON, NULL, 0);
1228 /* Kick the link in case it is idling */
1229 spin_lock_irqsave(&gsm->tx_lock, flags);
1230 gsm_data_kick(gsm, NULL);
1231 spin_unlock_irqrestore(&gsm->tx_lock, flags);
1232 break;
1233 case CMD_FCOFF:
1234 /* Modem wants us to STFU */
1235 gsm->constipated = true;
1236 gsm_control_reply(gsm, CMD_FCOFF, NULL, 0);
1237 break;
1238 case CMD_MSC:
1239 /* Out of band modem line change indicator for a DLCI */
1240 gsm_control_modem(gsm, data, clen);
1241 break;
1242 case CMD_RLS:
1243 /* Out of band error reception for a DLCI */
1244 gsm_control_rls(gsm, data, clen);
1245 break;
1246 case CMD_PSC:
1247 /* Modem wishes to enter power saving state */
1248 gsm_control_reply(gsm, CMD_PSC, NULL, 0);
1249 break;
1250 /* Optional unsupported commands */
1251 case CMD_PN: /* Parameter negotiation */
1252 case CMD_RPN: /* Remote port negotiation */
1253 case CMD_SNC: /* Service negotiation command */
1254 default:
1255 /* Reply to bad commands with an NSC */
1256 buf[0] = command;
1257 gsm_control_reply(gsm, CMD_NSC, buf, 1);
1258 break;
1263 * gsm_control_response - process a response to our control
1264 * @gsm: our GSM mux
1265 * @command: the command (response) EA
1266 * @data: data beyond the command/length EA
1267 * @clen: length
1269 * Process a response to an outstanding command. We only allow a single
1270 * control message in flight so this is fairly easy. All the clean up
1271 * is done by the caller, we just update the fields, flag it as done
1272 * and return
1275 static void gsm_control_response(struct gsm_mux *gsm, unsigned int command,
1276 const u8 *data, int clen)
1278 struct gsm_control *ctrl;
1279 unsigned long flags;
1281 spin_lock_irqsave(&gsm->control_lock, flags);
1283 ctrl = gsm->pending_cmd;
1284 /* Does the reply match our command */
1285 command |= 1;
1286 if (ctrl != NULL && (command == ctrl->cmd || command == CMD_NSC)) {
1287 /* Our command was replied to, kill the retry timer */
1288 del_timer(&gsm->t2_timer);
1289 gsm->pending_cmd = NULL;
1290 /* Rejected by the other end */
1291 if (command == CMD_NSC)
1292 ctrl->error = -EOPNOTSUPP;
1293 ctrl->done = 1;
1294 wake_up(&gsm->event);
1296 spin_unlock_irqrestore(&gsm->control_lock, flags);
1300 * gsm_control_transmit - send control packet
1301 * @gsm: gsm mux
1302 * @ctrl: frame to send
1304 * Send out a pending control command (called under control lock)
1307 static void gsm_control_transmit(struct gsm_mux *gsm, struct gsm_control *ctrl)
1309 struct gsm_msg *msg = gsm_data_alloc(gsm, 0, ctrl->len + 1, gsm->ftype);
1310 if (msg == NULL)
1311 return;
1312 msg->data[0] = (ctrl->cmd << 1) | 2 | EA; /* command */
1313 memcpy(msg->data + 1, ctrl->data, ctrl->len);
1314 gsm_data_queue(gsm->dlci[0], msg);
1318 * gsm_control_retransmit - retransmit a control frame
1319 * @data: pointer to our gsm object
1321 * Called off the T2 timer expiry in order to retransmit control frames
1322 * that have been lost in the system somewhere. The control_lock protects
1323 * us from colliding with another sender or a receive completion event.
1324 * In that situation the timer may still occur in a small window but
1325 * gsm->pending_cmd will be NULL and we just let the timer expire.
1328 static void gsm_control_retransmit(struct timer_list *t)
1330 struct gsm_mux *gsm = from_timer(gsm, t, t2_timer);
1331 struct gsm_control *ctrl;
1332 unsigned long flags;
1333 spin_lock_irqsave(&gsm->control_lock, flags);
1334 ctrl = gsm->pending_cmd;
1335 if (ctrl) {
1336 gsm->cretries--;
1337 if (gsm->cretries == 0) {
1338 gsm->pending_cmd = NULL;
1339 ctrl->error = -ETIMEDOUT;
1340 ctrl->done = 1;
1341 spin_unlock_irqrestore(&gsm->control_lock, flags);
1342 wake_up(&gsm->event);
1343 return;
1345 gsm_control_transmit(gsm, ctrl);
1346 mod_timer(&gsm->t2_timer, jiffies + gsm->t2 * HZ / 100);
1348 spin_unlock_irqrestore(&gsm->control_lock, flags);
1352 * gsm_control_send - send a control frame on DLCI 0
1353 * @gsm: the GSM channel
1354 * @command: command to send including CR bit
1355 * @data: bytes of data (must be kmalloced)
1356 * @len: length of the block to send
1358 * Queue and dispatch a control command. Only one command can be
1359 * active at a time. In theory more can be outstanding but the matching
1360 * gets really complicated so for now stick to one outstanding.
1363 static struct gsm_control *gsm_control_send(struct gsm_mux *gsm,
1364 unsigned int command, u8 *data, int clen)
1366 struct gsm_control *ctrl = kzalloc(sizeof(struct gsm_control),
1367 GFP_KERNEL);
1368 unsigned long flags;
1369 if (ctrl == NULL)
1370 return NULL;
1371 retry:
1372 wait_event(gsm->event, gsm->pending_cmd == NULL);
1373 spin_lock_irqsave(&gsm->control_lock, flags);
1374 if (gsm->pending_cmd != NULL) {
1375 spin_unlock_irqrestore(&gsm->control_lock, flags);
1376 goto retry;
1378 ctrl->cmd = command;
1379 ctrl->data = data;
1380 ctrl->len = clen;
1381 gsm->pending_cmd = ctrl;
1383 /* If DLCI0 is in ADM mode skip retries, it won't respond */
1384 if (gsm->dlci[0]->mode == DLCI_MODE_ADM)
1385 gsm->cretries = 1;
1386 else
1387 gsm->cretries = gsm->n2;
1389 mod_timer(&gsm->t2_timer, jiffies + gsm->t2 * HZ / 100);
1390 gsm_control_transmit(gsm, ctrl);
1391 spin_unlock_irqrestore(&gsm->control_lock, flags);
1392 return ctrl;
1396 * gsm_control_wait - wait for a control to finish
1397 * @gsm: GSM mux
1398 * @control: control we are waiting on
1400 * Waits for the control to complete or time out. Frees any used
1401 * resources and returns 0 for success, or an error if the remote
1402 * rejected or ignored the request.
1405 static int gsm_control_wait(struct gsm_mux *gsm, struct gsm_control *control)
1407 int err;
1408 wait_event(gsm->event, control->done == 1);
1409 err = control->error;
1410 kfree(control);
1411 return err;
1416 * DLCI level handling: Needs krefs
1420 * State transitions and timers
1424 * gsm_dlci_close - a DLCI has closed
1425 * @dlci: DLCI that closed
1427 * Perform processing when moving a DLCI into closed state. If there
1428 * is an attached tty this is hung up
1431 static void gsm_dlci_close(struct gsm_dlci *dlci)
1433 del_timer(&dlci->t1);
1434 if (debug & 8)
1435 pr_debug("DLCI %d goes closed.\n", dlci->addr);
1436 dlci->state = DLCI_CLOSED;
1437 if (dlci->addr != 0) {
1438 tty_port_tty_hangup(&dlci->port, false);
1439 kfifo_reset(&dlci->fifo);
1440 } else
1441 dlci->gsm->dead = true;
1442 wake_up(&dlci->gsm->event);
1443 /* A DLCI 0 close is a MUX termination so we need to kick that
1444 back to userspace somehow */
1448 * gsm_dlci_open - a DLCI has opened
1449 * @dlci: DLCI that opened
1451 * Perform processing when moving a DLCI into open state.
1454 static void gsm_dlci_open(struct gsm_dlci *dlci)
1456 /* Note that SABM UA .. SABM UA first UA lost can mean that we go
1457 open -> open */
1458 del_timer(&dlci->t1);
1459 /* This will let a tty open continue */
1460 dlci->state = DLCI_OPEN;
1461 if (debug & 8)
1462 pr_debug("DLCI %d goes open.\n", dlci->addr);
1463 wake_up(&dlci->gsm->event);
1467 * gsm_dlci_t1 - T1 timer expiry
1468 * @dlci: DLCI that opened
1470 * The T1 timer handles retransmits of control frames (essentially of
1471 * SABM and DISC). We resend the command until the retry count runs out
1472 * in which case an opening port goes back to closed and a closing port
1473 * is simply put into closed state (any further frames from the other
1474 * end will get a DM response)
1476 * Some control dlci can stay in ADM mode with other dlci working just
1477 * fine. In that case we can just keep the control dlci open after the
1478 * DLCI_OPENING retries time out.
1481 static void gsm_dlci_t1(struct timer_list *t)
1483 struct gsm_dlci *dlci = from_timer(dlci, t, t1);
1484 struct gsm_mux *gsm = dlci->gsm;
1486 switch (dlci->state) {
1487 case DLCI_OPENING:
1488 dlci->retries--;
1489 if (dlci->retries) {
1490 gsm_command(dlci->gsm, dlci->addr, SABM|PF);
1491 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1492 } else if (!dlci->addr && gsm->control == (DM | PF)) {
1493 if (debug & 8)
1494 pr_info("DLCI %d opening in ADM mode.\n",
1495 dlci->addr);
1496 dlci->mode = DLCI_MODE_ADM;
1497 gsm_dlci_open(dlci);
1498 } else {
1499 gsm_dlci_close(dlci);
1502 break;
1503 case DLCI_CLOSING:
1504 dlci->retries--;
1505 if (dlci->retries) {
1506 gsm_command(dlci->gsm, dlci->addr, DISC|PF);
1507 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1508 } else
1509 gsm_dlci_close(dlci);
1510 break;
1511 default:
1512 pr_debug("%s: unhandled state: %d\n", __func__, dlci->state);
1513 break;
1518 * gsm_dlci_begin_open - start channel open procedure
1519 * @dlci: DLCI to open
1521 * Commence opening a DLCI from the Linux side. We issue SABM messages
1522 * to the modem which should then reply with a UA or ADM, at which point
1523 * we will move into open state. Opening is done asynchronously with retry
1524 * running off timers and the responses.
1527 static void gsm_dlci_begin_open(struct gsm_dlci *dlci)
1529 struct gsm_mux *gsm = dlci->gsm;
1530 if (dlci->state == DLCI_OPEN || dlci->state == DLCI_OPENING)
1531 return;
1532 dlci->retries = gsm->n2;
1533 dlci->state = DLCI_OPENING;
1534 gsm_command(dlci->gsm, dlci->addr, SABM|PF);
1535 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1539 * gsm_dlci_begin_close - start channel open procedure
1540 * @dlci: DLCI to open
1542 * Commence closing a DLCI from the Linux side. We issue DISC messages
1543 * to the modem which should then reply with a UA, at which point we
1544 * will move into closed state. Closing is done asynchronously with retry
1545 * off timers. We may also receive a DM reply from the other end which
1546 * indicates the channel was already closed.
1549 static void gsm_dlci_begin_close(struct gsm_dlci *dlci)
1551 struct gsm_mux *gsm = dlci->gsm;
1552 if (dlci->state == DLCI_CLOSED || dlci->state == DLCI_CLOSING)
1553 return;
1554 dlci->retries = gsm->n2;
1555 dlci->state = DLCI_CLOSING;
1556 gsm_command(dlci->gsm, dlci->addr, DISC|PF);
1557 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1561 * gsm_dlci_data - data arrived
1562 * @dlci: channel
1563 * @data: block of bytes received
1564 * @len: length of received block
1566 * A UI or UIH frame has arrived which contains data for a channel
1567 * other than the control channel. If the relevant virtual tty is
1568 * open we shovel the bits down it, if not we drop them.
1571 static void gsm_dlci_data(struct gsm_dlci *dlci, const u8 *data, int clen)
1573 /* krefs .. */
1574 struct tty_port *port = &dlci->port;
1575 struct tty_struct *tty;
1576 unsigned int modem = 0;
1577 int len = clen;
1579 if (debug & 16)
1580 pr_debug("%d bytes for tty\n", len);
1581 switch (dlci->adaption) {
1582 /* Unsupported types */
1583 case 4: /* Packetised interruptible data */
1584 break;
1585 case 3: /* Packetised uininterruptible voice/data */
1586 break;
1587 case 2: /* Asynchronous serial with line state in each frame */
1588 while (gsm_read_ea(&modem, *data++) == 0) {
1589 len--;
1590 if (len == 0)
1591 return;
1593 tty = tty_port_tty_get(port);
1594 if (tty) {
1595 gsm_process_modem(tty, dlci, modem, clen);
1596 tty_kref_put(tty);
1598 /* Fall through */
1599 case 1: /* Line state will go via DLCI 0 controls only */
1600 default:
1601 tty_insert_flip_string(port, data, len);
1602 tty_flip_buffer_push(port);
1607 * gsm_dlci_control - data arrived on control channel
1608 * @dlci: channel
1609 * @data: block of bytes received
1610 * @len: length of received block
1612 * A UI or UIH frame has arrived which contains data for DLCI 0 the
1613 * control channel. This should contain a command EA followed by
1614 * control data bytes. The command EA contains a command/response bit
1615 * and we divide up the work accordingly.
1618 static void gsm_dlci_command(struct gsm_dlci *dlci, const u8 *data, int len)
1620 /* See what command is involved */
1621 unsigned int command = 0;
1622 while (len-- > 0) {
1623 if (gsm_read_ea(&command, *data++) == 1) {
1624 int clen = *data++;
1625 len--;
1626 /* FIXME: this is properly an EA */
1627 clen >>= 1;
1628 /* Malformed command ? */
1629 if (clen > len)
1630 return;
1631 if (command & 1)
1632 gsm_control_message(dlci->gsm, command,
1633 data, clen);
1634 else
1635 gsm_control_response(dlci->gsm, command,
1636 data, clen);
1637 return;
1643 * Allocate/Free DLCI channels
1647 * gsm_dlci_alloc - allocate a DLCI
1648 * @gsm: GSM mux
1649 * @addr: address of the DLCI
1651 * Allocate and install a new DLCI object into the GSM mux.
1653 * FIXME: review locking races
1656 static struct gsm_dlci *gsm_dlci_alloc(struct gsm_mux *gsm, int addr)
1658 struct gsm_dlci *dlci = kzalloc(sizeof(struct gsm_dlci), GFP_ATOMIC);
1659 if (dlci == NULL)
1660 return NULL;
1661 spin_lock_init(&dlci->lock);
1662 mutex_init(&dlci->mutex);
1663 if (kfifo_alloc(&dlci->fifo, 4096, GFP_KERNEL) < 0) {
1664 kfree(dlci);
1665 return NULL;
1668 skb_queue_head_init(&dlci->skb_list);
1669 timer_setup(&dlci->t1, gsm_dlci_t1, 0);
1670 tty_port_init(&dlci->port);
1671 dlci->port.ops = &gsm_port_ops;
1672 dlci->gsm = gsm;
1673 dlci->addr = addr;
1674 dlci->adaption = gsm->adaption;
1675 dlci->state = DLCI_CLOSED;
1676 if (addr)
1677 dlci->data = gsm_dlci_data;
1678 else
1679 dlci->data = gsm_dlci_command;
1680 gsm->dlci[addr] = dlci;
1681 return dlci;
1685 * gsm_dlci_free - free DLCI
1686 * @dlci: DLCI to free
1688 * Free up a DLCI.
1690 * Can sleep.
1692 static void gsm_dlci_free(struct tty_port *port)
1694 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
1696 del_timer_sync(&dlci->t1);
1697 dlci->gsm->dlci[dlci->addr] = NULL;
1698 kfifo_free(&dlci->fifo);
1699 while ((dlci->skb = skb_dequeue(&dlci->skb_list)))
1700 dev_kfree_skb(dlci->skb);
1701 kfree(dlci);
1704 static inline void dlci_get(struct gsm_dlci *dlci)
1706 tty_port_get(&dlci->port);
1709 static inline void dlci_put(struct gsm_dlci *dlci)
1711 tty_port_put(&dlci->port);
1714 static void gsm_destroy_network(struct gsm_dlci *dlci);
1717 * gsm_dlci_release - release DLCI
1718 * @dlci: DLCI to destroy
1720 * Release a DLCI. Actual free is deferred until either
1721 * mux is closed or tty is closed - whichever is last.
1723 * Can sleep.
1725 static void gsm_dlci_release(struct gsm_dlci *dlci)
1727 struct tty_struct *tty = tty_port_tty_get(&dlci->port);
1728 if (tty) {
1729 mutex_lock(&dlci->mutex);
1730 gsm_destroy_network(dlci);
1731 mutex_unlock(&dlci->mutex);
1733 tty_hangup(tty);
1735 tty_port_tty_set(&dlci->port, NULL);
1736 tty_kref_put(tty);
1738 dlci->state = DLCI_CLOSED;
1739 dlci_put(dlci);
1743 * LAPBish link layer logic
1747 * gsm_queue - a GSM frame is ready to process
1748 * @gsm: pointer to our gsm mux
1750 * At this point in time a frame has arrived and been demangled from
1751 * the line encoding. All the differences between the encodings have
1752 * been handled below us and the frame is unpacked into the structures.
1753 * The fcs holds the header FCS but any data FCS must be added here.
1756 static void gsm_queue(struct gsm_mux *gsm)
1758 struct gsm_dlci *dlci;
1759 u8 cr;
1760 int address;
1761 /* We have to sneak a look at the packet body to do the FCS.
1762 A somewhat layering violation in the spec */
1764 if ((gsm->control & ~PF) == UI)
1765 gsm->fcs = gsm_fcs_add_block(gsm->fcs, gsm->buf, gsm->len);
1766 if (gsm->encoding == 0) {
1767 /* WARNING: gsm->received_fcs is used for
1768 gsm->encoding = 0 only.
1769 In this case it contain the last piece of data
1770 required to generate final CRC */
1771 gsm->fcs = gsm_fcs_add(gsm->fcs, gsm->received_fcs);
1773 if (gsm->fcs != GOOD_FCS) {
1774 gsm->bad_fcs++;
1775 if (debug & 4)
1776 pr_debug("BAD FCS %02x\n", gsm->fcs);
1777 return;
1779 address = gsm->address >> 1;
1780 if (address >= NUM_DLCI)
1781 goto invalid;
1783 cr = gsm->address & 1; /* C/R bit */
1785 gsm_print_packet("<--", address, cr, gsm->control, gsm->buf, gsm->len);
1787 cr ^= 1 - gsm->initiator; /* Flip so 1 always means command */
1788 dlci = gsm->dlci[address];
1790 switch (gsm->control) {
1791 case SABM|PF:
1792 if (cr == 0)
1793 goto invalid;
1794 if (dlci == NULL)
1795 dlci = gsm_dlci_alloc(gsm, address);
1796 if (dlci == NULL)
1797 return;
1798 if (dlci->dead)
1799 gsm_response(gsm, address, DM);
1800 else {
1801 gsm_response(gsm, address, UA);
1802 gsm_dlci_open(dlci);
1804 break;
1805 case DISC|PF:
1806 if (cr == 0)
1807 goto invalid;
1808 if (dlci == NULL || dlci->state == DLCI_CLOSED) {
1809 gsm_response(gsm, address, DM);
1810 return;
1812 /* Real close complete */
1813 gsm_response(gsm, address, UA);
1814 gsm_dlci_close(dlci);
1815 break;
1816 case UA:
1817 case UA|PF:
1818 if (cr == 0 || dlci == NULL)
1819 break;
1820 switch (dlci->state) {
1821 case DLCI_CLOSING:
1822 gsm_dlci_close(dlci);
1823 break;
1824 case DLCI_OPENING:
1825 gsm_dlci_open(dlci);
1826 break;
1827 default:
1828 pr_debug("%s: unhandled state: %d\n", __func__,
1829 dlci->state);
1830 break;
1832 break;
1833 case DM: /* DM can be valid unsolicited */
1834 case DM|PF:
1835 if (cr)
1836 goto invalid;
1837 if (dlci == NULL)
1838 return;
1839 gsm_dlci_close(dlci);
1840 break;
1841 case UI:
1842 case UI|PF:
1843 case UIH:
1844 case UIH|PF:
1845 #if 0
1846 if (cr)
1847 goto invalid;
1848 #endif
1849 if (dlci == NULL || dlci->state != DLCI_OPEN) {
1850 gsm_command(gsm, address, DM|PF);
1851 return;
1853 dlci->data(dlci, gsm->buf, gsm->len);
1854 break;
1855 default:
1856 goto invalid;
1858 return;
1859 invalid:
1860 gsm->malformed++;
1861 return;
1866 * gsm0_receive - perform processing for non-transparency
1867 * @gsm: gsm data for this ldisc instance
1868 * @c: character
1870 * Receive bytes in gsm mode 0
1873 static void gsm0_receive(struct gsm_mux *gsm, unsigned char c)
1875 unsigned int len;
1877 switch (gsm->state) {
1878 case GSM_SEARCH: /* SOF marker */
1879 if (c == GSM0_SOF) {
1880 gsm->state = GSM_ADDRESS;
1881 gsm->address = 0;
1882 gsm->len = 0;
1883 gsm->fcs = INIT_FCS;
1885 break;
1886 case GSM_ADDRESS: /* Address EA */
1887 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1888 if (gsm_read_ea(&gsm->address, c))
1889 gsm->state = GSM_CONTROL;
1890 break;
1891 case GSM_CONTROL: /* Control Byte */
1892 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1893 gsm->control = c;
1894 gsm->state = GSM_LEN0;
1895 break;
1896 case GSM_LEN0: /* Length EA */
1897 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1898 if (gsm_read_ea(&gsm->len, c)) {
1899 if (gsm->len > gsm->mru) {
1900 gsm->bad_size++;
1901 gsm->state = GSM_SEARCH;
1902 break;
1904 gsm->count = 0;
1905 if (!gsm->len)
1906 gsm->state = GSM_FCS;
1907 else
1908 gsm->state = GSM_DATA;
1909 break;
1911 gsm->state = GSM_LEN1;
1912 break;
1913 case GSM_LEN1:
1914 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1915 len = c;
1916 gsm->len |= len << 7;
1917 if (gsm->len > gsm->mru) {
1918 gsm->bad_size++;
1919 gsm->state = GSM_SEARCH;
1920 break;
1922 gsm->count = 0;
1923 if (!gsm->len)
1924 gsm->state = GSM_FCS;
1925 else
1926 gsm->state = GSM_DATA;
1927 break;
1928 case GSM_DATA: /* Data */
1929 gsm->buf[gsm->count++] = c;
1930 if (gsm->count == gsm->len)
1931 gsm->state = GSM_FCS;
1932 break;
1933 case GSM_FCS: /* FCS follows the packet */
1934 gsm->received_fcs = c;
1935 gsm_queue(gsm);
1936 gsm->state = GSM_SSOF;
1937 break;
1938 case GSM_SSOF:
1939 if (c == GSM0_SOF) {
1940 gsm->state = GSM_SEARCH;
1941 break;
1943 break;
1944 default:
1945 pr_debug("%s: unhandled state: %d\n", __func__, gsm->state);
1946 break;
1951 * gsm1_receive - perform processing for non-transparency
1952 * @gsm: gsm data for this ldisc instance
1953 * @c: character
1955 * Receive bytes in mode 1 (Advanced option)
1958 static void gsm1_receive(struct gsm_mux *gsm, unsigned char c)
1960 if (c == GSM1_SOF) {
1961 /* EOF is only valid in frame if we have got to the data state
1962 and received at least one byte (the FCS) */
1963 if (gsm->state == GSM_DATA && gsm->count) {
1964 /* Extract the FCS */
1965 gsm->count--;
1966 gsm->fcs = gsm_fcs_add(gsm->fcs, gsm->buf[gsm->count]);
1967 gsm->len = gsm->count;
1968 gsm_queue(gsm);
1969 gsm->state = GSM_START;
1970 return;
1972 /* Any partial frame was a runt so go back to start */
1973 if (gsm->state != GSM_START) {
1974 gsm->malformed++;
1975 gsm->state = GSM_START;
1977 /* A SOF in GSM_START means we are still reading idling or
1978 framing bytes */
1979 return;
1982 if (c == GSM1_ESCAPE) {
1983 gsm->escape = true;
1984 return;
1987 /* Only an unescaped SOF gets us out of GSM search */
1988 if (gsm->state == GSM_SEARCH)
1989 return;
1991 if (gsm->escape) {
1992 c ^= GSM1_ESCAPE_BITS;
1993 gsm->escape = false;
1995 switch (gsm->state) {
1996 case GSM_START: /* First byte after SOF */
1997 gsm->address = 0;
1998 gsm->state = GSM_ADDRESS;
1999 gsm->fcs = INIT_FCS;
2000 /* Fall through */
2001 case GSM_ADDRESS: /* Address continuation */
2002 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
2003 if (gsm_read_ea(&gsm->address, c))
2004 gsm->state = GSM_CONTROL;
2005 break;
2006 case GSM_CONTROL: /* Control Byte */
2007 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
2008 gsm->control = c;
2009 gsm->count = 0;
2010 gsm->state = GSM_DATA;
2011 break;
2012 case GSM_DATA: /* Data */
2013 if (gsm->count > gsm->mru) { /* Allow one for the FCS */
2014 gsm->state = GSM_OVERRUN;
2015 gsm->bad_size++;
2016 } else
2017 gsm->buf[gsm->count++] = c;
2018 break;
2019 case GSM_OVERRUN: /* Over-long - eg a dropped SOF */
2020 break;
2021 default:
2022 pr_debug("%s: unhandled state: %d\n", __func__, gsm->state);
2023 break;
2028 * gsm_error - handle tty error
2029 * @gsm: ldisc data
2030 * @data: byte received (may be invalid)
2031 * @flag: error received
2033 * Handle an error in the receipt of data for a frame. Currently we just
2034 * go back to hunting for a SOF.
2036 * FIXME: better diagnostics ?
2039 static void gsm_error(struct gsm_mux *gsm,
2040 unsigned char data, unsigned char flag)
2042 gsm->state = GSM_SEARCH;
2043 gsm->io_error++;
2046 static int gsm_disconnect(struct gsm_mux *gsm)
2048 struct gsm_dlci *dlci = gsm->dlci[0];
2049 struct gsm_control *gc;
2051 if (!dlci)
2052 return 0;
2054 /* In theory disconnecting DLCI 0 is sufficient but for some
2055 modems this is apparently not the case. */
2056 gc = gsm_control_send(gsm, CMD_CLD, NULL, 0);
2057 if (gc)
2058 gsm_control_wait(gsm, gc);
2060 del_timer_sync(&gsm->t2_timer);
2061 /* Now we are sure T2 has stopped */
2063 gsm_dlci_begin_close(dlci);
2064 wait_event_interruptible(gsm->event,
2065 dlci->state == DLCI_CLOSED);
2067 if (signal_pending(current))
2068 return -EINTR;
2070 return 0;
2074 * gsm_cleanup_mux - generic GSM protocol cleanup
2075 * @gsm: our mux
2077 * Clean up the bits of the mux which are the same for all framing
2078 * protocols. Remove the mux from the mux table, stop all the timers
2079 * and then shut down each device hanging up the channels as we go.
2082 static void gsm_cleanup_mux(struct gsm_mux *gsm)
2084 int i;
2085 struct gsm_dlci *dlci = gsm->dlci[0];
2086 struct gsm_msg *txq, *ntxq;
2088 gsm->dead = true;
2090 spin_lock(&gsm_mux_lock);
2091 for (i = 0; i < MAX_MUX; i++) {
2092 if (gsm_mux[i] == gsm) {
2093 gsm_mux[i] = NULL;
2094 break;
2097 spin_unlock(&gsm_mux_lock);
2098 /* open failed before registering => nothing to do */
2099 if (i == MAX_MUX)
2100 return;
2102 del_timer_sync(&gsm->t2_timer);
2103 /* Now we are sure T2 has stopped */
2104 if (dlci)
2105 dlci->dead = true;
2107 /* Free up any link layer users */
2108 mutex_lock(&gsm->mutex);
2109 for (i = 0; i < NUM_DLCI; i++)
2110 if (gsm->dlci[i])
2111 gsm_dlci_release(gsm->dlci[i]);
2112 mutex_unlock(&gsm->mutex);
2113 /* Now wipe the queues */
2114 list_for_each_entry_safe(txq, ntxq, &gsm->tx_list, list)
2115 kfree(txq);
2116 INIT_LIST_HEAD(&gsm->tx_list);
2120 * gsm_activate_mux - generic GSM setup
2121 * @gsm: our mux
2123 * Set up the bits of the mux which are the same for all framing
2124 * protocols. Add the mux to the mux table so it can be opened and
2125 * finally kick off connecting to DLCI 0 on the modem.
2128 static int gsm_activate_mux(struct gsm_mux *gsm)
2130 struct gsm_dlci *dlci;
2131 int i = 0;
2133 timer_setup(&gsm->t2_timer, gsm_control_retransmit, 0);
2134 init_waitqueue_head(&gsm->event);
2135 spin_lock_init(&gsm->control_lock);
2136 spin_lock_init(&gsm->tx_lock);
2138 if (gsm->encoding == 0)
2139 gsm->receive = gsm0_receive;
2140 else
2141 gsm->receive = gsm1_receive;
2142 gsm->error = gsm_error;
2144 spin_lock(&gsm_mux_lock);
2145 for (i = 0; i < MAX_MUX; i++) {
2146 if (gsm_mux[i] == NULL) {
2147 gsm->num = i;
2148 gsm_mux[i] = gsm;
2149 break;
2152 spin_unlock(&gsm_mux_lock);
2153 if (i == MAX_MUX)
2154 return -EBUSY;
2156 dlci = gsm_dlci_alloc(gsm, 0);
2157 if (dlci == NULL)
2158 return -ENOMEM;
2159 gsm->dead = false; /* Tty opens are now permissible */
2160 return 0;
2164 * gsm_free_mux - free up a mux
2165 * @mux: mux to free
2167 * Dispose of allocated resources for a dead mux
2169 static void gsm_free_mux(struct gsm_mux *gsm)
2171 kfree(gsm->txframe);
2172 kfree(gsm->buf);
2173 kfree(gsm);
2177 * gsm_free_muxr - free up a mux
2178 * @mux: mux to free
2180 * Dispose of allocated resources for a dead mux
2182 static void gsm_free_muxr(struct kref *ref)
2184 struct gsm_mux *gsm = container_of(ref, struct gsm_mux, ref);
2185 gsm_free_mux(gsm);
2188 static inline void mux_get(struct gsm_mux *gsm)
2190 kref_get(&gsm->ref);
2193 static inline void mux_put(struct gsm_mux *gsm)
2195 kref_put(&gsm->ref, gsm_free_muxr);
2198 static inline unsigned int mux_num_to_base(struct gsm_mux *gsm)
2200 return gsm->num * NUM_DLCI;
2203 static inline unsigned int mux_line_to_num(unsigned int line)
2205 return line / NUM_DLCI;
2209 * gsm_alloc_mux - allocate a mux
2211 * Creates a new mux ready for activation.
2214 static struct gsm_mux *gsm_alloc_mux(void)
2216 struct gsm_mux *gsm = kzalloc(sizeof(struct gsm_mux), GFP_KERNEL);
2217 if (gsm == NULL)
2218 return NULL;
2219 gsm->buf = kmalloc(MAX_MRU + 1, GFP_KERNEL);
2220 if (gsm->buf == NULL) {
2221 kfree(gsm);
2222 return NULL;
2224 gsm->txframe = kmalloc(2 * MAX_MRU + 2, GFP_KERNEL);
2225 if (gsm->txframe == NULL) {
2226 kfree(gsm->buf);
2227 kfree(gsm);
2228 return NULL;
2230 spin_lock_init(&gsm->lock);
2231 mutex_init(&gsm->mutex);
2232 kref_init(&gsm->ref);
2233 INIT_LIST_HEAD(&gsm->tx_list);
2235 gsm->t1 = T1;
2236 gsm->t2 = T2;
2237 gsm->n2 = N2;
2238 gsm->ftype = UIH;
2239 gsm->adaption = 1;
2240 gsm->encoding = 1;
2241 gsm->mru = 64; /* Default to encoding 1 so these should be 64 */
2242 gsm->mtu = 64;
2243 gsm->dead = true; /* Avoid early tty opens */
2245 return gsm;
2248 static void gsm_copy_config_values(struct gsm_mux *gsm,
2249 struct gsm_config *c)
2251 memset(c, 0, sizeof(*c));
2252 c->adaption = gsm->adaption;
2253 c->encapsulation = gsm->encoding;
2254 c->initiator = gsm->initiator;
2255 c->t1 = gsm->t1;
2256 c->t2 = gsm->t2;
2257 c->t3 = 0; /* Not supported */
2258 c->n2 = gsm->n2;
2259 if (gsm->ftype == UIH)
2260 c->i = 1;
2261 else
2262 c->i = 2;
2263 pr_debug("Ftype %d i %d\n", gsm->ftype, c->i);
2264 c->mru = gsm->mru;
2265 c->mtu = gsm->mtu;
2266 c->k = 0;
2269 static int gsm_config(struct gsm_mux *gsm, struct gsm_config *c)
2271 int need_close = 0;
2272 int need_restart = 0;
2274 /* Stuff we don't support yet - UI or I frame transport, windowing */
2275 if ((c->adaption != 1 && c->adaption != 2) || c->k)
2276 return -EOPNOTSUPP;
2277 /* Check the MRU/MTU range looks sane */
2278 if (c->mru > MAX_MRU || c->mtu > MAX_MTU || c->mru < 8 || c->mtu < 8)
2279 return -EINVAL;
2280 if (c->n2 < 3)
2281 return -EINVAL;
2282 if (c->encapsulation > 1) /* Basic, advanced, no I */
2283 return -EINVAL;
2284 if (c->initiator > 1)
2285 return -EINVAL;
2286 if (c->i == 0 || c->i > 2) /* UIH and UI only */
2287 return -EINVAL;
2289 * See what is needed for reconfiguration
2292 /* Timing fields */
2293 if (c->t1 != 0 && c->t1 != gsm->t1)
2294 need_restart = 1;
2295 if (c->t2 != 0 && c->t2 != gsm->t2)
2296 need_restart = 1;
2297 if (c->encapsulation != gsm->encoding)
2298 need_restart = 1;
2299 if (c->adaption != gsm->adaption)
2300 need_restart = 1;
2301 /* Requires care */
2302 if (c->initiator != gsm->initiator)
2303 need_close = 1;
2304 if (c->mru != gsm->mru)
2305 need_restart = 1;
2306 if (c->mtu != gsm->mtu)
2307 need_restart = 1;
2310 * Close down what is needed, restart and initiate the new
2311 * configuration
2314 if (need_close || need_restart) {
2315 int ret;
2317 ret = gsm_disconnect(gsm);
2319 if (ret)
2320 return ret;
2322 if (need_restart)
2323 gsm_cleanup_mux(gsm);
2325 gsm->initiator = c->initiator;
2326 gsm->mru = c->mru;
2327 gsm->mtu = c->mtu;
2328 gsm->encoding = c->encapsulation;
2329 gsm->adaption = c->adaption;
2330 gsm->n2 = c->n2;
2332 if (c->i == 1)
2333 gsm->ftype = UIH;
2334 else if (c->i == 2)
2335 gsm->ftype = UI;
2337 if (c->t1)
2338 gsm->t1 = c->t1;
2339 if (c->t2)
2340 gsm->t2 = c->t2;
2343 * FIXME: We need to separate activation/deactivation from adding
2344 * and removing from the mux array
2346 if (need_restart)
2347 gsm_activate_mux(gsm);
2348 if (gsm->initiator && need_close)
2349 gsm_dlci_begin_open(gsm->dlci[0]);
2350 return 0;
2354 * gsmld_output - write to link
2355 * @gsm: our mux
2356 * @data: bytes to output
2357 * @len: size
2359 * Write a block of data from the GSM mux to the data channel. This
2360 * will eventually be serialized from above but at the moment isn't.
2363 static int gsmld_output(struct gsm_mux *gsm, u8 *data, int len)
2365 if (tty_write_room(gsm->tty) < len) {
2366 set_bit(TTY_DO_WRITE_WAKEUP, &gsm->tty->flags);
2367 return -ENOSPC;
2369 if (debug & 4)
2370 print_hex_dump_bytes("gsmld_output: ", DUMP_PREFIX_OFFSET,
2371 data, len);
2372 gsm->tty->ops->write(gsm->tty, data, len);
2373 return len;
2377 * gsmld_attach_gsm - mode set up
2378 * @tty: our tty structure
2379 * @gsm: our mux
2381 * Set up the MUX for basic mode and commence connecting to the
2382 * modem. Currently called from the line discipline set up but
2383 * will need moving to an ioctl path.
2386 static int gsmld_attach_gsm(struct tty_struct *tty, struct gsm_mux *gsm)
2388 unsigned int base;
2389 int ret, i;
2391 gsm->tty = tty_kref_get(tty);
2392 gsm->output = gsmld_output;
2393 ret = gsm_activate_mux(gsm);
2394 if (ret != 0)
2395 tty_kref_put(gsm->tty);
2396 else {
2397 /* Don't register device 0 - this is the control channel and not
2398 a usable tty interface */
2399 base = mux_num_to_base(gsm); /* Base for this MUX */
2400 for (i = 1; i < NUM_DLCI; i++)
2401 tty_register_device(gsm_tty_driver, base + i, NULL);
2403 return ret;
2408 * gsmld_detach_gsm - stop doing 0710 mux
2409 * @tty: tty attached to the mux
2410 * @gsm: mux
2412 * Shutdown and then clean up the resources used by the line discipline
2415 static void gsmld_detach_gsm(struct tty_struct *tty, struct gsm_mux *gsm)
2417 unsigned int base = mux_num_to_base(gsm); /* Base for this MUX */
2418 int i;
2420 WARN_ON(tty != gsm->tty);
2421 for (i = 1; i < NUM_DLCI; i++)
2422 tty_unregister_device(gsm_tty_driver, base + i);
2423 gsm_cleanup_mux(gsm);
2424 tty_kref_put(gsm->tty);
2425 gsm->tty = NULL;
2428 static void gsmld_receive_buf(struct tty_struct *tty, const unsigned char *cp,
2429 char *fp, int count)
2431 struct gsm_mux *gsm = tty->disc_data;
2432 const unsigned char *dp;
2433 char *f;
2434 int i;
2435 char flags = TTY_NORMAL;
2437 if (debug & 4)
2438 print_hex_dump_bytes("gsmld_receive: ", DUMP_PREFIX_OFFSET,
2439 cp, count);
2441 for (i = count, dp = cp, f = fp; i; i--, dp++) {
2442 if (f)
2443 flags = *f++;
2444 switch (flags) {
2445 case TTY_NORMAL:
2446 gsm->receive(gsm, *dp);
2447 break;
2448 case TTY_OVERRUN:
2449 case TTY_BREAK:
2450 case TTY_PARITY:
2451 case TTY_FRAME:
2452 gsm->error(gsm, *dp, flags);
2453 break;
2454 default:
2455 WARN_ONCE(1, "%s: unknown flag %d\n",
2456 tty_name(tty), flags);
2457 break;
2460 /* FASYNC if needed ? */
2461 /* If clogged call tty_throttle(tty); */
2465 * gsmld_flush_buffer - clean input queue
2466 * @tty: terminal device
2468 * Flush the input buffer. Called when the line discipline is
2469 * being closed, when the tty layer wants the buffer flushed (eg
2470 * at hangup).
2473 static void gsmld_flush_buffer(struct tty_struct *tty)
2478 * gsmld_close - close the ldisc for this tty
2479 * @tty: device
2481 * Called from the terminal layer when this line discipline is
2482 * being shut down, either because of a close or becsuse of a
2483 * discipline change. The function will not be called while other
2484 * ldisc methods are in progress.
2487 static void gsmld_close(struct tty_struct *tty)
2489 struct gsm_mux *gsm = tty->disc_data;
2491 gsmld_detach_gsm(tty, gsm);
2493 gsmld_flush_buffer(tty);
2494 /* Do other clean up here */
2495 mux_put(gsm);
2499 * gsmld_open - open an ldisc
2500 * @tty: terminal to open
2502 * Called when this line discipline is being attached to the
2503 * terminal device. Can sleep. Called serialized so that no
2504 * other events will occur in parallel. No further open will occur
2505 * until a close.
2508 static int gsmld_open(struct tty_struct *tty)
2510 struct gsm_mux *gsm;
2511 int ret;
2513 if (tty->ops->write == NULL)
2514 return -EINVAL;
2516 /* Attach our ldisc data */
2517 gsm = gsm_alloc_mux();
2518 if (gsm == NULL)
2519 return -ENOMEM;
2521 tty->disc_data = gsm;
2522 tty->receive_room = 65536;
2524 /* Attach the initial passive connection */
2525 gsm->encoding = 1;
2527 ret = gsmld_attach_gsm(tty, gsm);
2528 if (ret != 0) {
2529 gsm_cleanup_mux(gsm);
2530 mux_put(gsm);
2532 return ret;
2536 * gsmld_write_wakeup - asynchronous I/O notifier
2537 * @tty: tty device
2539 * Required for the ptys, serial driver etc. since processes
2540 * that attach themselves to the master and rely on ASYNC
2541 * IO must be woken up
2544 static void gsmld_write_wakeup(struct tty_struct *tty)
2546 struct gsm_mux *gsm = tty->disc_data;
2547 unsigned long flags;
2549 /* Queue poll */
2550 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2551 spin_lock_irqsave(&gsm->tx_lock, flags);
2552 gsm_data_kick(gsm, NULL);
2553 if (gsm->tx_bytes < TX_THRESH_LO) {
2554 gsm_dlci_data_sweep(gsm);
2556 spin_unlock_irqrestore(&gsm->tx_lock, flags);
2560 * gsmld_read - read function for tty
2561 * @tty: tty device
2562 * @file: file object
2563 * @buf: userspace buffer pointer
2564 * @nr: size of I/O
2566 * Perform reads for the line discipline. We are guaranteed that the
2567 * line discipline will not be closed under us but we may get multiple
2568 * parallel readers and must handle this ourselves. We may also get
2569 * a hangup. Always called in user context, may sleep.
2571 * This code must be sure never to sleep through a hangup.
2574 static ssize_t gsmld_read(struct tty_struct *tty, struct file *file,
2575 unsigned char __user *buf, size_t nr)
2577 return -EOPNOTSUPP;
2581 * gsmld_write - write function for tty
2582 * @tty: tty device
2583 * @file: file object
2584 * @buf: userspace buffer pointer
2585 * @nr: size of I/O
2587 * Called when the owner of the device wants to send a frame
2588 * itself (or some other control data). The data is transferred
2589 * as-is and must be properly framed and checksummed as appropriate
2590 * by userspace. Frames are either sent whole or not at all as this
2591 * avoids pain user side.
2594 static ssize_t gsmld_write(struct tty_struct *tty, struct file *file,
2595 const unsigned char *buf, size_t nr)
2597 int space = tty_write_room(tty);
2598 if (space >= nr)
2599 return tty->ops->write(tty, buf, nr);
2600 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2601 return -ENOBUFS;
2605 * gsmld_poll - poll method for N_GSM0710
2606 * @tty: terminal device
2607 * @file: file accessing it
2608 * @wait: poll table
2610 * Called when the line discipline is asked to poll() for data or
2611 * for special events. This code is not serialized with respect to
2612 * other events save open/close.
2614 * This code must be sure never to sleep through a hangup.
2615 * Called without the kernel lock held - fine
2618 static __poll_t gsmld_poll(struct tty_struct *tty, struct file *file,
2619 poll_table *wait)
2621 __poll_t mask = 0;
2622 struct gsm_mux *gsm = tty->disc_data;
2624 poll_wait(file, &tty->read_wait, wait);
2625 poll_wait(file, &tty->write_wait, wait);
2626 if (tty_hung_up_p(file))
2627 mask |= EPOLLHUP;
2628 if (!tty_is_writelocked(tty) && tty_write_room(tty) > 0)
2629 mask |= EPOLLOUT | EPOLLWRNORM;
2630 if (gsm->dead)
2631 mask |= EPOLLHUP;
2632 return mask;
2635 static int gsmld_ioctl(struct tty_struct *tty, struct file *file,
2636 unsigned int cmd, unsigned long arg)
2638 struct gsm_config c;
2639 struct gsm_mux *gsm = tty->disc_data;
2640 unsigned int base;
2642 switch (cmd) {
2643 case GSMIOC_GETCONF:
2644 gsm_copy_config_values(gsm, &c);
2645 if (copy_to_user((void __user *)arg, &c, sizeof(c)))
2646 return -EFAULT;
2647 return 0;
2648 case GSMIOC_SETCONF:
2649 if (copy_from_user(&c, (void __user *)arg, sizeof(c)))
2650 return -EFAULT;
2651 return gsm_config(gsm, &c);
2652 case GSMIOC_GETFIRST:
2653 base = mux_num_to_base(gsm);
2654 return put_user(base + 1, (__u32 __user *)arg);
2655 default:
2656 return n_tty_ioctl_helper(tty, file, cmd, arg);
2661 * Network interface
2665 static int gsm_mux_net_open(struct net_device *net)
2667 pr_debug("%s called\n", __func__);
2668 netif_start_queue(net);
2669 return 0;
2672 static int gsm_mux_net_close(struct net_device *net)
2674 netif_stop_queue(net);
2675 return 0;
2678 static void dlci_net_free(struct gsm_dlci *dlci)
2680 if (!dlci->net) {
2681 WARN_ON(1);
2682 return;
2684 dlci->adaption = dlci->prev_adaption;
2685 dlci->data = dlci->prev_data;
2686 free_netdev(dlci->net);
2687 dlci->net = NULL;
2689 static void net_free(struct kref *ref)
2691 struct gsm_mux_net *mux_net;
2692 struct gsm_dlci *dlci;
2694 mux_net = container_of(ref, struct gsm_mux_net, ref);
2695 dlci = mux_net->dlci;
2697 if (dlci->net) {
2698 unregister_netdev(dlci->net);
2699 dlci_net_free(dlci);
2703 static inline void muxnet_get(struct gsm_mux_net *mux_net)
2705 kref_get(&mux_net->ref);
2708 static inline void muxnet_put(struct gsm_mux_net *mux_net)
2710 kref_put(&mux_net->ref, net_free);
2713 static netdev_tx_t gsm_mux_net_start_xmit(struct sk_buff *skb,
2714 struct net_device *net)
2716 struct gsm_mux_net *mux_net = netdev_priv(net);
2717 struct gsm_dlci *dlci = mux_net->dlci;
2718 muxnet_get(mux_net);
2720 skb_queue_head(&dlci->skb_list, skb);
2721 net->stats.tx_packets++;
2722 net->stats.tx_bytes += skb->len;
2723 gsm_dlci_data_kick(dlci);
2724 /* And tell the kernel when the last transmit started. */
2725 netif_trans_update(net);
2726 muxnet_put(mux_net);
2727 return NETDEV_TX_OK;
2730 /* called when a packet did not ack after watchdogtimeout */
2731 static void gsm_mux_net_tx_timeout(struct net_device *net, unsigned int txqueue)
2733 /* Tell syslog we are hosed. */
2734 dev_dbg(&net->dev, "Tx timed out.\n");
2736 /* Update statistics */
2737 net->stats.tx_errors++;
2740 static void gsm_mux_rx_netchar(struct gsm_dlci *dlci,
2741 const unsigned char *in_buf, int size)
2743 struct net_device *net = dlci->net;
2744 struct sk_buff *skb;
2745 struct gsm_mux_net *mux_net = netdev_priv(net);
2746 muxnet_get(mux_net);
2748 /* Allocate an sk_buff */
2749 skb = dev_alloc_skb(size + NET_IP_ALIGN);
2750 if (!skb) {
2751 /* We got no receive buffer. */
2752 net->stats.rx_dropped++;
2753 muxnet_put(mux_net);
2754 return;
2756 skb_reserve(skb, NET_IP_ALIGN);
2757 skb_put_data(skb, in_buf, size);
2759 skb->dev = net;
2760 skb->protocol = htons(ETH_P_IP);
2762 /* Ship it off to the kernel */
2763 netif_rx(skb);
2765 /* update out statistics */
2766 net->stats.rx_packets++;
2767 net->stats.rx_bytes += size;
2768 muxnet_put(mux_net);
2769 return;
2772 static void gsm_mux_net_init(struct net_device *net)
2774 static const struct net_device_ops gsm_netdev_ops = {
2775 .ndo_open = gsm_mux_net_open,
2776 .ndo_stop = gsm_mux_net_close,
2777 .ndo_start_xmit = gsm_mux_net_start_xmit,
2778 .ndo_tx_timeout = gsm_mux_net_tx_timeout,
2781 net->netdev_ops = &gsm_netdev_ops;
2783 /* fill in the other fields */
2784 net->watchdog_timeo = GSM_NET_TX_TIMEOUT;
2785 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2786 net->type = ARPHRD_NONE;
2787 net->tx_queue_len = 10;
2791 /* caller holds the dlci mutex */
2792 static void gsm_destroy_network(struct gsm_dlci *dlci)
2794 struct gsm_mux_net *mux_net;
2796 pr_debug("destroy network interface\n");
2797 if (!dlci->net)
2798 return;
2799 mux_net = netdev_priv(dlci->net);
2800 muxnet_put(mux_net);
2804 /* caller holds the dlci mutex */
2805 static int gsm_create_network(struct gsm_dlci *dlci, struct gsm_netconfig *nc)
2807 char *netname;
2808 int retval = 0;
2809 struct net_device *net;
2810 struct gsm_mux_net *mux_net;
2812 if (!capable(CAP_NET_ADMIN))
2813 return -EPERM;
2815 /* Already in a non tty mode */
2816 if (dlci->adaption > 2)
2817 return -EBUSY;
2819 if (nc->protocol != htons(ETH_P_IP))
2820 return -EPROTONOSUPPORT;
2822 if (nc->adaption != 3 && nc->adaption != 4)
2823 return -EPROTONOSUPPORT;
2825 pr_debug("create network interface\n");
2827 netname = "gsm%d";
2828 if (nc->if_name[0] != '\0')
2829 netname = nc->if_name;
2830 net = alloc_netdev(sizeof(struct gsm_mux_net), netname,
2831 NET_NAME_UNKNOWN, gsm_mux_net_init);
2832 if (!net) {
2833 pr_err("alloc_netdev failed\n");
2834 return -ENOMEM;
2836 net->mtu = dlci->gsm->mtu;
2837 net->min_mtu = 8;
2838 net->max_mtu = dlci->gsm->mtu;
2839 mux_net = netdev_priv(net);
2840 mux_net->dlci = dlci;
2841 kref_init(&mux_net->ref);
2842 strncpy(nc->if_name, net->name, IFNAMSIZ); /* return net name */
2844 /* reconfigure dlci for network */
2845 dlci->prev_adaption = dlci->adaption;
2846 dlci->prev_data = dlci->data;
2847 dlci->adaption = nc->adaption;
2848 dlci->data = gsm_mux_rx_netchar;
2849 dlci->net = net;
2851 pr_debug("register netdev\n");
2852 retval = register_netdev(net);
2853 if (retval) {
2854 pr_err("network register fail %d\n", retval);
2855 dlci_net_free(dlci);
2856 return retval;
2858 return net->ifindex; /* return network index */
2861 /* Line discipline for real tty */
2862 static struct tty_ldisc_ops tty_ldisc_packet = {
2863 .owner = THIS_MODULE,
2864 .magic = TTY_LDISC_MAGIC,
2865 .name = "n_gsm",
2866 .open = gsmld_open,
2867 .close = gsmld_close,
2868 .flush_buffer = gsmld_flush_buffer,
2869 .read = gsmld_read,
2870 .write = gsmld_write,
2871 .ioctl = gsmld_ioctl,
2872 .poll = gsmld_poll,
2873 .receive_buf = gsmld_receive_buf,
2874 .write_wakeup = gsmld_write_wakeup
2878 * Virtual tty side
2881 #define TX_SIZE 512
2883 static int gsmtty_modem_update(struct gsm_dlci *dlci, u8 brk)
2885 u8 modembits[5];
2886 struct gsm_control *ctrl;
2887 int len = 2;
2889 if (brk)
2890 len++;
2892 modembits[0] = len << 1 | EA; /* Data bytes */
2893 modembits[1] = dlci->addr << 2 | 3; /* DLCI, EA, 1 */
2894 modembits[2] = gsm_encode_modem(dlci) << 1 | EA;
2895 if (brk)
2896 modembits[3] = brk << 4 | 2 | EA; /* Valid, EA */
2897 ctrl = gsm_control_send(dlci->gsm, CMD_MSC, modembits, len + 1);
2898 if (ctrl == NULL)
2899 return -ENOMEM;
2900 return gsm_control_wait(dlci->gsm, ctrl);
2903 static int gsm_carrier_raised(struct tty_port *port)
2905 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
2906 struct gsm_mux *gsm = dlci->gsm;
2908 /* Not yet open so no carrier info */
2909 if (dlci->state != DLCI_OPEN)
2910 return 0;
2911 if (debug & 2)
2912 return 1;
2915 * Basic mode with control channel in ADM mode may not respond
2916 * to CMD_MSC at all and modem_rx is empty.
2918 if (gsm->encoding == 0 && gsm->dlci[0]->mode == DLCI_MODE_ADM &&
2919 !dlci->modem_rx)
2920 return 1;
2922 return dlci->modem_rx & TIOCM_CD;
2925 static void gsm_dtr_rts(struct tty_port *port, int onoff)
2927 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
2928 unsigned int modem_tx = dlci->modem_tx;
2929 if (onoff)
2930 modem_tx |= TIOCM_DTR | TIOCM_RTS;
2931 else
2932 modem_tx &= ~(TIOCM_DTR | TIOCM_RTS);
2933 if (modem_tx != dlci->modem_tx) {
2934 dlci->modem_tx = modem_tx;
2935 gsmtty_modem_update(dlci, 0);
2939 static const struct tty_port_operations gsm_port_ops = {
2940 .carrier_raised = gsm_carrier_raised,
2941 .dtr_rts = gsm_dtr_rts,
2942 .destruct = gsm_dlci_free,
2945 static int gsmtty_install(struct tty_driver *driver, struct tty_struct *tty)
2947 struct gsm_mux *gsm;
2948 struct gsm_dlci *dlci;
2949 unsigned int line = tty->index;
2950 unsigned int mux = mux_line_to_num(line);
2951 bool alloc = false;
2952 int ret;
2954 line = line & 0x3F;
2956 if (mux >= MAX_MUX)
2957 return -ENXIO;
2958 /* FIXME: we need to lock gsm_mux for lifetimes of ttys eventually */
2959 if (gsm_mux[mux] == NULL)
2960 return -EUNATCH;
2961 if (line == 0 || line > 61) /* 62/63 reserved */
2962 return -ECHRNG;
2963 gsm = gsm_mux[mux];
2964 if (gsm->dead)
2965 return -EL2HLT;
2966 /* If DLCI 0 is not yet fully open return an error.
2967 This is ok from a locking
2968 perspective as we don't have to worry about this
2969 if DLCI0 is lost */
2970 mutex_lock(&gsm->mutex);
2971 if (gsm->dlci[0] && gsm->dlci[0]->state != DLCI_OPEN) {
2972 mutex_unlock(&gsm->mutex);
2973 return -EL2NSYNC;
2975 dlci = gsm->dlci[line];
2976 if (dlci == NULL) {
2977 alloc = true;
2978 dlci = gsm_dlci_alloc(gsm, line);
2980 if (dlci == NULL) {
2981 mutex_unlock(&gsm->mutex);
2982 return -ENOMEM;
2984 ret = tty_port_install(&dlci->port, driver, tty);
2985 if (ret) {
2986 if (alloc)
2987 dlci_put(dlci);
2988 mutex_unlock(&gsm->mutex);
2989 return ret;
2992 dlci_get(dlci);
2993 dlci_get(gsm->dlci[0]);
2994 mux_get(gsm);
2995 tty->driver_data = dlci;
2996 mutex_unlock(&gsm->mutex);
2998 return 0;
3001 static int gsmtty_open(struct tty_struct *tty, struct file *filp)
3003 struct gsm_dlci *dlci = tty->driver_data;
3004 struct tty_port *port = &dlci->port;
3006 port->count++;
3007 tty_port_tty_set(port, tty);
3009 dlci->modem_rx = 0;
3010 /* We could in theory open and close before we wait - eg if we get
3011 a DM straight back. This is ok as that will have caused a hangup */
3012 tty_port_set_initialized(port, 1);
3013 /* Start sending off SABM messages */
3014 gsm_dlci_begin_open(dlci);
3015 /* And wait for virtual carrier */
3016 return tty_port_block_til_ready(port, tty, filp);
3019 static void gsmtty_close(struct tty_struct *tty, struct file *filp)
3021 struct gsm_dlci *dlci = tty->driver_data;
3023 if (dlci == NULL)
3024 return;
3025 if (dlci->state == DLCI_CLOSED)
3026 return;
3027 mutex_lock(&dlci->mutex);
3028 gsm_destroy_network(dlci);
3029 mutex_unlock(&dlci->mutex);
3030 if (tty_port_close_start(&dlci->port, tty, filp) == 0)
3031 return;
3032 gsm_dlci_begin_close(dlci);
3033 if (tty_port_initialized(&dlci->port) && C_HUPCL(tty))
3034 tty_port_lower_dtr_rts(&dlci->port);
3035 tty_port_close_end(&dlci->port, tty);
3036 tty_port_tty_set(&dlci->port, NULL);
3037 return;
3040 static void gsmtty_hangup(struct tty_struct *tty)
3042 struct gsm_dlci *dlci = tty->driver_data;
3043 if (dlci->state == DLCI_CLOSED)
3044 return;
3045 tty_port_hangup(&dlci->port);
3046 gsm_dlci_begin_close(dlci);
3049 static int gsmtty_write(struct tty_struct *tty, const unsigned char *buf,
3050 int len)
3052 int sent;
3053 struct gsm_dlci *dlci = tty->driver_data;
3054 if (dlci->state == DLCI_CLOSED)
3055 return -EINVAL;
3056 /* Stuff the bytes into the fifo queue */
3057 sent = kfifo_in_locked(&dlci->fifo, buf, len, &dlci->lock);
3058 /* Need to kick the channel */
3059 gsm_dlci_data_kick(dlci);
3060 return sent;
3063 static int gsmtty_write_room(struct tty_struct *tty)
3065 struct gsm_dlci *dlci = tty->driver_data;
3066 if (dlci->state == DLCI_CLOSED)
3067 return -EINVAL;
3068 return TX_SIZE - kfifo_len(&dlci->fifo);
3071 static int gsmtty_chars_in_buffer(struct tty_struct *tty)
3073 struct gsm_dlci *dlci = tty->driver_data;
3074 if (dlci->state == DLCI_CLOSED)
3075 return -EINVAL;
3076 return kfifo_len(&dlci->fifo);
3079 static void gsmtty_flush_buffer(struct tty_struct *tty)
3081 struct gsm_dlci *dlci = tty->driver_data;
3082 if (dlci->state == DLCI_CLOSED)
3083 return;
3084 /* Caution needed: If we implement reliable transport classes
3085 then the data being transmitted can't simply be junked once
3086 it has first hit the stack. Until then we can just blow it
3087 away */
3088 kfifo_reset(&dlci->fifo);
3089 /* Need to unhook this DLCI from the transmit queue logic */
3092 static void gsmtty_wait_until_sent(struct tty_struct *tty, int timeout)
3094 /* The FIFO handles the queue so the kernel will do the right
3095 thing waiting on chars_in_buffer before calling us. No work
3096 to do here */
3099 static int gsmtty_tiocmget(struct tty_struct *tty)
3101 struct gsm_dlci *dlci = tty->driver_data;
3102 if (dlci->state == DLCI_CLOSED)
3103 return -EINVAL;
3104 return dlci->modem_rx;
3107 static int gsmtty_tiocmset(struct tty_struct *tty,
3108 unsigned int set, unsigned int clear)
3110 struct gsm_dlci *dlci = tty->driver_data;
3111 unsigned int modem_tx = dlci->modem_tx;
3113 if (dlci->state == DLCI_CLOSED)
3114 return -EINVAL;
3115 modem_tx &= ~clear;
3116 modem_tx |= set;
3118 if (modem_tx != dlci->modem_tx) {
3119 dlci->modem_tx = modem_tx;
3120 return gsmtty_modem_update(dlci, 0);
3122 return 0;
3126 static int gsmtty_ioctl(struct tty_struct *tty,
3127 unsigned int cmd, unsigned long arg)
3129 struct gsm_dlci *dlci = tty->driver_data;
3130 struct gsm_netconfig nc;
3131 int index;
3133 if (dlci->state == DLCI_CLOSED)
3134 return -EINVAL;
3135 switch (cmd) {
3136 case GSMIOC_ENABLE_NET:
3137 if (copy_from_user(&nc, (void __user *)arg, sizeof(nc)))
3138 return -EFAULT;
3139 nc.if_name[IFNAMSIZ-1] = '\0';
3140 /* return net interface index or error code */
3141 mutex_lock(&dlci->mutex);
3142 index = gsm_create_network(dlci, &nc);
3143 mutex_unlock(&dlci->mutex);
3144 if (copy_to_user((void __user *)arg, &nc, sizeof(nc)))
3145 return -EFAULT;
3146 return index;
3147 case GSMIOC_DISABLE_NET:
3148 if (!capable(CAP_NET_ADMIN))
3149 return -EPERM;
3150 mutex_lock(&dlci->mutex);
3151 gsm_destroy_network(dlci);
3152 mutex_unlock(&dlci->mutex);
3153 return 0;
3154 default:
3155 return -ENOIOCTLCMD;
3159 static void gsmtty_set_termios(struct tty_struct *tty, struct ktermios *old)
3161 struct gsm_dlci *dlci = tty->driver_data;
3162 if (dlci->state == DLCI_CLOSED)
3163 return;
3164 /* For the moment its fixed. In actual fact the speed information
3165 for the virtual channel can be propogated in both directions by
3166 the RPN control message. This however rapidly gets nasty as we
3167 then have to remap modem signals each way according to whether
3168 our virtual cable is null modem etc .. */
3169 tty_termios_copy_hw(&tty->termios, old);
3172 static void gsmtty_throttle(struct tty_struct *tty)
3174 struct gsm_dlci *dlci = tty->driver_data;
3175 if (dlci->state == DLCI_CLOSED)
3176 return;
3177 if (C_CRTSCTS(tty))
3178 dlci->modem_tx &= ~TIOCM_DTR;
3179 dlci->throttled = true;
3180 /* Send an MSC with DTR cleared */
3181 gsmtty_modem_update(dlci, 0);
3184 static void gsmtty_unthrottle(struct tty_struct *tty)
3186 struct gsm_dlci *dlci = tty->driver_data;
3187 if (dlci->state == DLCI_CLOSED)
3188 return;
3189 if (C_CRTSCTS(tty))
3190 dlci->modem_tx |= TIOCM_DTR;
3191 dlci->throttled = false;
3192 /* Send an MSC with DTR set */
3193 gsmtty_modem_update(dlci, 0);
3196 static int gsmtty_break_ctl(struct tty_struct *tty, int state)
3198 struct gsm_dlci *dlci = tty->driver_data;
3199 int encode = 0; /* Off */
3200 if (dlci->state == DLCI_CLOSED)
3201 return -EINVAL;
3203 if (state == -1) /* "On indefinitely" - we can't encode this
3204 properly */
3205 encode = 0x0F;
3206 else if (state > 0) {
3207 encode = state / 200; /* mS to encoding */
3208 if (encode > 0x0F)
3209 encode = 0x0F; /* Best effort */
3211 return gsmtty_modem_update(dlci, encode);
3214 static void gsmtty_cleanup(struct tty_struct *tty)
3216 struct gsm_dlci *dlci = tty->driver_data;
3217 struct gsm_mux *gsm = dlci->gsm;
3219 dlci_put(dlci);
3220 dlci_put(gsm->dlci[0]);
3221 mux_put(gsm);
3224 /* Virtual ttys for the demux */
3225 static const struct tty_operations gsmtty_ops = {
3226 .install = gsmtty_install,
3227 .open = gsmtty_open,
3228 .close = gsmtty_close,
3229 .write = gsmtty_write,
3230 .write_room = gsmtty_write_room,
3231 .chars_in_buffer = gsmtty_chars_in_buffer,
3232 .flush_buffer = gsmtty_flush_buffer,
3233 .ioctl = gsmtty_ioctl,
3234 .throttle = gsmtty_throttle,
3235 .unthrottle = gsmtty_unthrottle,
3236 .set_termios = gsmtty_set_termios,
3237 .hangup = gsmtty_hangup,
3238 .wait_until_sent = gsmtty_wait_until_sent,
3239 .tiocmget = gsmtty_tiocmget,
3240 .tiocmset = gsmtty_tiocmset,
3241 .break_ctl = gsmtty_break_ctl,
3242 .cleanup = gsmtty_cleanup,
3247 static int __init gsm_init(void)
3249 /* Fill in our line protocol discipline, and register it */
3250 int status = tty_register_ldisc(N_GSM0710, &tty_ldisc_packet);
3251 if (status != 0) {
3252 pr_err("n_gsm: can't register line discipline (err = %d)\n",
3253 status);
3254 return status;
3257 gsm_tty_driver = alloc_tty_driver(256);
3258 if (!gsm_tty_driver) {
3259 tty_unregister_ldisc(N_GSM0710);
3260 pr_err("gsm_init: tty allocation failed.\n");
3261 return -EINVAL;
3263 gsm_tty_driver->driver_name = "gsmtty";
3264 gsm_tty_driver->name = "gsmtty";
3265 gsm_tty_driver->major = 0; /* Dynamic */
3266 gsm_tty_driver->minor_start = 0;
3267 gsm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
3268 gsm_tty_driver->subtype = SERIAL_TYPE_NORMAL;
3269 gsm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV
3270 | TTY_DRIVER_HARDWARE_BREAK;
3271 gsm_tty_driver->init_termios = tty_std_termios;
3272 /* Fixme */
3273 gsm_tty_driver->init_termios.c_lflag &= ~ECHO;
3274 tty_set_operations(gsm_tty_driver, &gsmtty_ops);
3276 spin_lock_init(&gsm_mux_lock);
3278 if (tty_register_driver(gsm_tty_driver)) {
3279 put_tty_driver(gsm_tty_driver);
3280 tty_unregister_ldisc(N_GSM0710);
3281 pr_err("gsm_init: tty registration failed.\n");
3282 return -EBUSY;
3284 pr_debug("gsm_init: loaded as %d,%d.\n",
3285 gsm_tty_driver->major, gsm_tty_driver->minor_start);
3286 return 0;
3289 static void __exit gsm_exit(void)
3291 int status = tty_unregister_ldisc(N_GSM0710);
3292 if (status != 0)
3293 pr_err("n_gsm: can't unregister line discipline (err = %d)\n",
3294 status);
3295 tty_unregister_driver(gsm_tty_driver);
3296 put_tty_driver(gsm_tty_driver);
3299 module_init(gsm_init);
3300 module_exit(gsm_exit);
3303 MODULE_LICENSE("GPL");
3304 MODULE_ALIAS_LDISC(N_GSM0710);