blob: a38114b01fea7dc08dfd729c7c65f7985bcb9e09 [file] [log] [blame]
Alan Coxe1eaea42010-03-26 11:32:54 +00001/*
2 * n_gsm.c GSM 0710 tty multiplexor
3 * Copyright (c) 2009/10 Intel Corporation
4 *
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.
8 *
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.
13 *
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.
17 *
18 * * THIS IS A DEVELOPMENT SNAPSHOT IT IS NOT A FINAL RELEASE *
19 *
20 * TO DO:
21 * Mostly done: ioctls for setting modes/timing
Alan Cox5f9a31d2010-11-04 15:17:27 +000022 * Partly done: hooks so you can pull off frames to non tty devs
Alan Coxe1eaea42010-03-26 11:32:54 +000023 * Restart DLCI 0 when it closes ?
24 * Test basic encoding
25 * Improve the tx engine
26 * Resolve tx side locking by adding a queue_head and routing
27 * all control traffic via it
28 * General tidy/document
29 * Review the locking/move to refcounts more (mux now moved to an
30 * alloc/free model ready)
31 * Use newest tty open/close port helpers and install hooks
32 * What to do about power functions ?
33 * Termios setting and negotiation
34 * Do we need a 'which mux are you' ioctl to correlate mux and tty sets
35 *
36 */
37
38#include <linux/types.h>
39#include <linux/major.h>
40#include <linux/errno.h>
41#include <linux/signal.h>
42#include <linux/fcntl.h>
43#include <linux/sched.h>
44#include <linux/interrupt.h>
45#include <linux/tty.h>
Alan Coxe1eaea42010-03-26 11:32:54 +000046#include <linux/ctype.h>
47#include <linux/mm.h>
48#include <linux/string.h>
49#include <linux/slab.h>
50#include <linux/poll.h>
51#include <linux/bitops.h>
52#include <linux/file.h>
53#include <linux/uaccess.h>
54#include <linux/module.h>
55#include <linux/timer.h>
56#include <linux/tty_flip.h>
57#include <linux/tty_driver.h>
58#include <linux/serial.h>
59#include <linux/kfifo.h>
60#include <linux/skbuff.h>
Russ Gorbybcd5abe2011-06-16 14:20:12 -070061#include <net/arp.h>
62#include <linux/ip.h>
63#include <linux/netdevice.h>
64#include <linux/etherdevice.h>
Alan Coxe1eaea42010-03-26 11:32:54 +000065#include <linux/gsmmux.h>
66
67static int debug;
68module_param(debug, int, 0600);
69
70#define T1 (HZ/10)
71#define T2 (HZ/3)
72#define N2 3
73
74/* Use long timers for testing at low speed with debug on */
75#ifdef DEBUG_TIMING
76#define T1 HZ
77#define T2 (2 * HZ)
78#endif
79
Alan Cox5f9a31d2010-11-04 15:17:27 +000080/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -030081 * Semi-arbitrary buffer size limits. 0710 is normally run with 32-64 byte
Alan Cox5f9a31d2010-11-04 15:17:27 +000082 * limits so this is plenty
83 */
Russ Gorbybcd5abe2011-06-16 14:20:12 -070084#define MAX_MRU 1500
85#define MAX_MTU 1500
86#define GSM_NET_TX_TIMEOUT (HZ*10)
87
88/**
89 * struct gsm_mux_net - network interface
90 * @struct gsm_dlci* dlci
91 * @struct net_device_stats stats;
92 *
93 * Created when net interface is initialized.
94 **/
95struct gsm_mux_net {
96 struct kref ref;
97 struct gsm_dlci *dlci;
98 struct net_device_stats stats;
99};
100
101#define STATS(net) (((struct gsm_mux_net *)netdev_priv(net))->stats)
Alan Coxe1eaea42010-03-26 11:32:54 +0000102
103/*
104 * Each block of data we have queued to go out is in the form of
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300105 * a gsm_msg which holds everything we need in a link layer independent
Alan Coxe1eaea42010-03-26 11:32:54 +0000106 * format
107 */
108
109struct gsm_msg {
110 struct gsm_msg *next;
111 u8 addr; /* DLCI address + flags */
112 u8 ctrl; /* Control byte + flags */
113 unsigned int len; /* Length of data block (can be zero) */
114 unsigned char *data; /* Points into buffer but not at the start */
115 unsigned char buffer[0];
116};
117
118/*
119 * Each active data link has a gsm_dlci structure associated which ties
120 * the link layer to an optional tty (if the tty side is open). To avoid
121 * complexity right now these are only ever freed up when the mux is
122 * shut down.
123 *
124 * At the moment we don't free DLCI objects until the mux is torn down
125 * this avoid object life time issues but might be worth review later.
126 */
127
128struct gsm_dlci {
129 struct gsm_mux *gsm;
130 int addr;
131 int state;
132#define DLCI_CLOSED 0
133#define DLCI_OPENING 1 /* Sending SABM not seen UA */
134#define DLCI_OPEN 2 /* SABM/UA complete */
135#define DLCI_CLOSING 3 /* Sending DISC not seen UA/DM */
Russ Gorby6ab8fba2011-06-16 14:20:13 -0700136 struct kref ref; /* freed from port or mux close */
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700137 struct mutex mutex;
Alan Coxe1eaea42010-03-26 11:32:54 +0000138
139 /* Link layer */
140 spinlock_t lock; /* Protects the internal state */
141 struct timer_list t1; /* Retransmit timer for SABM and UA */
142 int retries;
143 /* Uplink tty if active */
144 struct tty_port port; /* The tty bound to this DLCI if there is one */
145 struct kfifo *fifo; /* Queue fifo for the DLCI */
146 struct kfifo _fifo; /* For new fifo API porting only */
147 int adaption; /* Adaption layer in use */
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700148 int prev_adaption;
Alan Coxe1eaea42010-03-26 11:32:54 +0000149 u32 modem_rx; /* Our incoming virtual modem lines */
150 u32 modem_tx; /* Our outgoing modem lines */
151 int dead; /* Refuse re-open */
152 /* Flow control */
153 int throttled; /* Private copy of throttle state */
154 int constipated; /* Throttle status for outgoing */
155 /* Packetised I/O */
156 struct sk_buff *skb; /* Frame being sent */
157 struct sk_buff_head skb_list; /* Queued frames */
158 /* Data handling callback */
159 void (*data)(struct gsm_dlci *dlci, u8 *data, int len);
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700160 void (*prev_data)(struct gsm_dlci *dlci, u8 *data, int len);
161 struct net_device *net; /* network interface, if created */
Alan Coxe1eaea42010-03-26 11:32:54 +0000162};
163
164/* DLCI 0, 62/63 are special or reseved see gsmtty_open */
165
166#define NUM_DLCI 64
167
168/*
169 * DLCI 0 is used to pass control blocks out of band of the data
170 * flow (and with a higher link priority). One command can be outstanding
171 * at a time and we use this structure to manage them. They are created
172 * and destroyed by the user context, and updated by the receive paths
173 * and timers
174 */
175
176struct gsm_control {
177 u8 cmd; /* Command we are issuing */
178 u8 *data; /* Data for the command in case we retransmit */
179 int len; /* Length of block for retransmission */
180 int done; /* Done flag */
181 int error; /* Error if any */
182};
183
184/*
185 * Each GSM mux we have is represented by this structure. If we are
186 * operating as an ldisc then we use this structure as our ldisc
187 * state. We need to sort out lifetimes and locking with respect
188 * to the gsm mux array. For now we don't free DLCI objects that
189 * have been instantiated until the mux itself is terminated.
190 *
191 * To consider further: tty open versus mux shutdown.
192 */
193
194struct gsm_mux {
195 struct tty_struct *tty; /* The tty our ldisc is bound to */
196 spinlock_t lock;
Russ Gorbyd50f6dc2011-06-14 13:35:32 -0700197 unsigned int num;
Russ Gorby6ab8fba2011-06-16 14:20:13 -0700198 struct kref ref;
Alan Coxe1eaea42010-03-26 11:32:54 +0000199
200 /* Events on the GSM channel */
201 wait_queue_head_t event;
202
203 /* Bits for GSM mode decoding */
204
205 /* Framing Layer */
206 unsigned char *buf;
207 int state;
208#define GSM_SEARCH 0
209#define GSM_START 1
210#define GSM_ADDRESS 2
211#define GSM_CONTROL 3
212#define GSM_LEN 4
213#define GSM_DATA 5
214#define GSM_FCS 6
215#define GSM_OVERRUN 7
Alan Coxc2f2f002010-11-04 15:17:03 +0000216#define GSM_LEN0 8
217#define GSM_LEN1 9
218#define GSM_SSOF 10
Alan Coxe1eaea42010-03-26 11:32:54 +0000219 unsigned int len;
220 unsigned int address;
221 unsigned int count;
222 int escape;
223 int encoding;
224 u8 control;
225 u8 fcs;
Alan Coxc2f2f002010-11-04 15:17:03 +0000226 u8 received_fcs;
Alan Coxe1eaea42010-03-26 11:32:54 +0000227 u8 *txframe; /* TX framing buffer */
228
229 /* Methods for the receiver side */
230 void (*receive)(struct gsm_mux *gsm, u8 ch);
231 void (*error)(struct gsm_mux *gsm, u8 ch, u8 flag);
232 /* And transmit side */
233 int (*output)(struct gsm_mux *mux, u8 *data, int len);
234
235 /* Link Layer */
236 unsigned int mru;
237 unsigned int mtu;
238 int initiator; /* Did we initiate connection */
239 int dead; /* Has the mux been shut down */
240 struct gsm_dlci *dlci[NUM_DLCI];
241 int constipated; /* Asked by remote to shut up */
242
243 spinlock_t tx_lock;
244 unsigned int tx_bytes; /* TX data outstanding */
245#define TX_THRESH_HI 8192
246#define TX_THRESH_LO 2048
247 struct gsm_msg *tx_head; /* Pending data packets */
248 struct gsm_msg *tx_tail;
249
250 /* Control messages */
251 struct timer_list t2_timer; /* Retransmit timer for commands */
252 int cretries; /* Command retry counter */
253 struct gsm_control *pending_cmd;/* Our current pending command */
254 spinlock_t control_lock; /* Protects the pending command */
255
256 /* Configuration */
257 int adaption; /* 1 or 2 supported */
258 u8 ftype; /* UI or UIH */
259 int t1, t2; /* Timers in 1/100th of a sec */
260 int n2; /* Retry count */
261
262 /* Statistics (not currently exposed) */
263 unsigned long bad_fcs;
264 unsigned long malformed;
265 unsigned long io_error;
266 unsigned long bad_size;
267 unsigned long unsupported;
268};
269
270
271/*
272 * Mux objects - needed so that we can translate a tty index into the
273 * relevant mux and DLCI.
274 */
275
276#define MAX_MUX 4 /* 256 minors */
277static struct gsm_mux *gsm_mux[MAX_MUX]; /* GSM muxes */
278static spinlock_t gsm_mux_lock;
279
Russ Gorbyd50f6dc2011-06-14 13:35:32 -0700280static struct tty_driver *gsm_tty_driver;
281
Alan Coxe1eaea42010-03-26 11:32:54 +0000282/*
283 * This section of the driver logic implements the GSM encodings
284 * both the basic and the 'advanced'. Reliable transport is not
285 * supported.
286 */
287
288#define CR 0x02
289#define EA 0x01
290#define PF 0x10
291
292/* I is special: the rest are ..*/
293#define RR 0x01
294#define UI 0x03
295#define RNR 0x05
296#define REJ 0x09
297#define DM 0x0F
298#define SABM 0x2F
299#define DISC 0x43
300#define UA 0x63
301#define UIH 0xEF
302
303/* Channel commands */
304#define CMD_NSC 0x09
305#define CMD_TEST 0x11
306#define CMD_PSC 0x21
307#define CMD_RLS 0x29
308#define CMD_FCOFF 0x31
309#define CMD_PN 0x41
310#define CMD_RPN 0x49
311#define CMD_FCON 0x51
312#define CMD_CLD 0x61
313#define CMD_SNC 0x69
314#define CMD_MSC 0x71
315
316/* Virtual modem bits */
317#define MDM_FC 0x01
318#define MDM_RTC 0x02
319#define MDM_RTR 0x04
320#define MDM_IC 0x20
321#define MDM_DV 0x40
322
323#define GSM0_SOF 0xF9
Alan Cox5f9a31d2010-11-04 15:17:27 +0000324#define GSM1_SOF 0x7E
Alan Coxe1eaea42010-03-26 11:32:54 +0000325#define GSM1_ESCAPE 0x7D
326#define GSM1_ESCAPE_BITS 0x20
327#define XON 0x11
328#define XOFF 0x13
329
330static const struct tty_port_operations gsm_port_ops;
331
332/*
333 * CRC table for GSM 0710
334 */
335
336static const u8 gsm_fcs8[256] = {
337 0x00, 0x91, 0xE3, 0x72, 0x07, 0x96, 0xE4, 0x75,
338 0x0E, 0x9F, 0xED, 0x7C, 0x09, 0x98, 0xEA, 0x7B,
339 0x1C, 0x8D, 0xFF, 0x6E, 0x1B, 0x8A, 0xF8, 0x69,
340 0x12, 0x83, 0xF1, 0x60, 0x15, 0x84, 0xF6, 0x67,
341 0x38, 0xA9, 0xDB, 0x4A, 0x3F, 0xAE, 0xDC, 0x4D,
342 0x36, 0xA7, 0xD5, 0x44, 0x31, 0xA0, 0xD2, 0x43,
343 0x24, 0xB5, 0xC7, 0x56, 0x23, 0xB2, 0xC0, 0x51,
344 0x2A, 0xBB, 0xC9, 0x58, 0x2D, 0xBC, 0xCE, 0x5F,
345 0x70, 0xE1, 0x93, 0x02, 0x77, 0xE6, 0x94, 0x05,
346 0x7E, 0xEF, 0x9D, 0x0C, 0x79, 0xE8, 0x9A, 0x0B,
347 0x6C, 0xFD, 0x8F, 0x1E, 0x6B, 0xFA, 0x88, 0x19,
348 0x62, 0xF3, 0x81, 0x10, 0x65, 0xF4, 0x86, 0x17,
349 0x48, 0xD9, 0xAB, 0x3A, 0x4F, 0xDE, 0xAC, 0x3D,
350 0x46, 0xD7, 0xA5, 0x34, 0x41, 0xD0, 0xA2, 0x33,
351 0x54, 0xC5, 0xB7, 0x26, 0x53, 0xC2, 0xB0, 0x21,
352 0x5A, 0xCB, 0xB9, 0x28, 0x5D, 0xCC, 0xBE, 0x2F,
353 0xE0, 0x71, 0x03, 0x92, 0xE7, 0x76, 0x04, 0x95,
354 0xEE, 0x7F, 0x0D, 0x9C, 0xE9, 0x78, 0x0A, 0x9B,
355 0xFC, 0x6D, 0x1F, 0x8E, 0xFB, 0x6A, 0x18, 0x89,
356 0xF2, 0x63, 0x11, 0x80, 0xF5, 0x64, 0x16, 0x87,
357 0xD8, 0x49, 0x3B, 0xAA, 0xDF, 0x4E, 0x3C, 0xAD,
358 0xD6, 0x47, 0x35, 0xA4, 0xD1, 0x40, 0x32, 0xA3,
359 0xC4, 0x55, 0x27, 0xB6, 0xC3, 0x52, 0x20, 0xB1,
360 0xCA, 0x5B, 0x29, 0xB8, 0xCD, 0x5C, 0x2E, 0xBF,
361 0x90, 0x01, 0x73, 0xE2, 0x97, 0x06, 0x74, 0xE5,
362 0x9E, 0x0F, 0x7D, 0xEC, 0x99, 0x08, 0x7A, 0xEB,
363 0x8C, 0x1D, 0x6F, 0xFE, 0x8B, 0x1A, 0x68, 0xF9,
364 0x82, 0x13, 0x61, 0xF0, 0x85, 0x14, 0x66, 0xF7,
365 0xA8, 0x39, 0x4B, 0xDA, 0xAF, 0x3E, 0x4C, 0xDD,
366 0xA6, 0x37, 0x45, 0xD4, 0xA1, 0x30, 0x42, 0xD3,
367 0xB4, 0x25, 0x57, 0xC6, 0xB3, 0x22, 0x50, 0xC1,
368 0xBA, 0x2B, 0x59, 0xC8, 0xBD, 0x2C, 0x5E, 0xCF
369};
370
371#define INIT_FCS 0xFF
372#define GOOD_FCS 0xCF
373
374/**
375 * gsm_fcs_add - update FCS
376 * @fcs: Current FCS
377 * @c: Next data
378 *
379 * Update the FCS to include c. Uses the algorithm in the specification
380 * notes.
381 */
382
383static inline u8 gsm_fcs_add(u8 fcs, u8 c)
384{
385 return gsm_fcs8[fcs ^ c];
386}
387
388/**
389 * gsm_fcs_add_block - update FCS for a block
390 * @fcs: Current FCS
391 * @c: buffer of data
392 * @len: length of buffer
393 *
394 * Update the FCS to include c. Uses the algorithm in the specification
395 * notes.
396 */
397
398static inline u8 gsm_fcs_add_block(u8 fcs, u8 *c, int len)
399{
400 while (len--)
401 fcs = gsm_fcs8[fcs ^ *c++];
402 return fcs;
403}
404
405/**
406 * gsm_read_ea - read a byte into an EA
407 * @val: variable holding value
408 * c: byte going into the EA
409 *
410 * Processes one byte of an EA. Updates the passed variable
411 * and returns 1 if the EA is now completely read
412 */
413
414static int gsm_read_ea(unsigned int *val, u8 c)
415{
416 /* Add the next 7 bits into the value */
417 *val <<= 7;
418 *val |= c >> 1;
419 /* Was this the last byte of the EA 1 = yes*/
420 return c & EA;
421}
422
423/**
424 * gsm_encode_modem - encode modem data bits
425 * @dlci: DLCI to encode from
426 *
427 * Returns the correct GSM encoded modem status bits (6 bit field) for
428 * the current status of the DLCI and attached tty object
429 */
430
431static u8 gsm_encode_modem(const struct gsm_dlci *dlci)
432{
433 u8 modembits = 0;
434 /* FC is true flow control not modem bits */
435 if (dlci->throttled)
436 modembits |= MDM_FC;
437 if (dlci->modem_tx & TIOCM_DTR)
438 modembits |= MDM_RTC;
439 if (dlci->modem_tx & TIOCM_RTS)
440 modembits |= MDM_RTR;
441 if (dlci->modem_tx & TIOCM_RI)
442 modembits |= MDM_IC;
443 if (dlci->modem_tx & TIOCM_CD)
444 modembits |= MDM_DV;
445 return modembits;
446}
447
448/**
449 * gsm_print_packet - display a frame for debug
450 * @hdr: header to print before decode
451 * @addr: address EA from the frame
452 * @cr: C/R bit from the frame
453 * @control: control including PF bit
454 * @data: following data bytes
455 * @dlen: length of data
456 *
457 * Displays a packet in human readable format for debugging purposes. The
458 * style is based on amateur radio LAP-B dump display.
459 */
460
461static void gsm_print_packet(const char *hdr, int addr, int cr,
462 u8 control, const u8 *data, int dlen)
463{
464 if (!(debug & 1))
465 return;
466
Alan Cox5f9a31d2010-11-04 15:17:27 +0000467 pr_info("%s %d) %c: ", hdr, addr, "RC"[cr]);
Alan Coxe1eaea42010-03-26 11:32:54 +0000468
469 switch (control & ~PF) {
470 case SABM:
Alan Cox5f9a31d2010-11-04 15:17:27 +0000471 pr_cont("SABM");
Alan Coxe1eaea42010-03-26 11:32:54 +0000472 break;
473 case UA:
Alan Cox5f9a31d2010-11-04 15:17:27 +0000474 pr_cont("UA");
Alan Coxe1eaea42010-03-26 11:32:54 +0000475 break;
476 case DISC:
Alan Cox5f9a31d2010-11-04 15:17:27 +0000477 pr_cont("DISC");
Alan Coxe1eaea42010-03-26 11:32:54 +0000478 break;
479 case DM:
Alan Cox5f9a31d2010-11-04 15:17:27 +0000480 pr_cont("DM");
Alan Coxe1eaea42010-03-26 11:32:54 +0000481 break;
482 case UI:
Alan Cox5f9a31d2010-11-04 15:17:27 +0000483 pr_cont("UI");
Alan Coxe1eaea42010-03-26 11:32:54 +0000484 break;
485 case UIH:
Alan Cox5f9a31d2010-11-04 15:17:27 +0000486 pr_cont("UIH");
Alan Coxe1eaea42010-03-26 11:32:54 +0000487 break;
488 default:
489 if (!(control & 0x01)) {
Alan Cox5f9a31d2010-11-04 15:17:27 +0000490 pr_cont("I N(S)%d N(R)%d",
491 (control & 0x0E) >> 1, (control & 0xE) >> 5);
Alan Coxe1eaea42010-03-26 11:32:54 +0000492 } else switch (control & 0x0F) {
Alan Cox5f9a31d2010-11-04 15:17:27 +0000493 case RR:
494 pr_cont("RR(%d)", (control & 0xE0) >> 5);
495 break;
496 case RNR:
497 pr_cont("RNR(%d)", (control & 0xE0) >> 5);
498 break;
499 case REJ:
500 pr_cont("REJ(%d)", (control & 0xE0) >> 5);
501 break;
502 default:
503 pr_cont("[%02X]", control);
Alan Coxe1eaea42010-03-26 11:32:54 +0000504 }
505 }
506
507 if (control & PF)
Alan Cox5f9a31d2010-11-04 15:17:27 +0000508 pr_cont("(P)");
Alan Coxe1eaea42010-03-26 11:32:54 +0000509 else
Alan Cox5f9a31d2010-11-04 15:17:27 +0000510 pr_cont("(F)");
Alan Coxe1eaea42010-03-26 11:32:54 +0000511
512 if (dlen) {
513 int ct = 0;
514 while (dlen--) {
Alan Cox5f9a31d2010-11-04 15:17:27 +0000515 if (ct % 8 == 0) {
516 pr_cont("\n");
517 pr_debug(" ");
518 }
519 pr_cont("%02X ", *data++);
Alan Coxe1eaea42010-03-26 11:32:54 +0000520 ct++;
521 }
522 }
Alan Cox5f9a31d2010-11-04 15:17:27 +0000523 pr_cont("\n");
Alan Coxe1eaea42010-03-26 11:32:54 +0000524}
525
526
527/*
528 * Link level transmission side
529 */
530
531/**
532 * gsm_stuff_packet - bytestuff a packet
533 * @ibuf: input
534 * @obuf: output
535 * @len: length of input
536 *
537 * Expand a buffer by bytestuffing it. The worst case size change
538 * is doubling and the caller is responsible for handing out
539 * suitable sized buffers.
540 */
541
542static int gsm_stuff_frame(const u8 *input, u8 *output, int len)
543{
544 int olen = 0;
545 while (len--) {
546 if (*input == GSM1_SOF || *input == GSM1_ESCAPE
547 || *input == XON || *input == XOFF) {
548 *output++ = GSM1_ESCAPE;
549 *output++ = *input++ ^ GSM1_ESCAPE_BITS;
550 olen++;
551 } else
552 *output++ = *input++;
553 olen++;
554 }
555 return olen;
556}
557
Alan Coxe1eaea42010-03-26 11:32:54 +0000558/**
559 * gsm_send - send a control frame
560 * @gsm: our GSM mux
561 * @addr: address for control frame
562 * @cr: command/response bit
563 * @control: control byte including PF bit
564 *
565 * Format up and transmit a control frame. These do not go via the
566 * queueing logic as they should be transmitted ahead of data when
567 * they are needed.
568 *
569 * FIXME: Lock versus data TX path
570 */
571
572static void gsm_send(struct gsm_mux *gsm, int addr, int cr, int control)
573{
574 int len;
575 u8 cbuf[10];
576 u8 ibuf[3];
577
578 switch (gsm->encoding) {
579 case 0:
580 cbuf[0] = GSM0_SOF;
581 cbuf[1] = (addr << 2) | (cr << 1) | EA;
582 cbuf[2] = control;
583 cbuf[3] = EA; /* Length of data = 0 */
584 cbuf[4] = 0xFF - gsm_fcs_add_block(INIT_FCS, cbuf + 1, 3);
585 cbuf[5] = GSM0_SOF;
586 len = 6;
587 break;
588 case 1:
589 case 2:
590 /* Control frame + packing (but not frame stuffing) in mode 1 */
591 ibuf[0] = (addr << 2) | (cr << 1) | EA;
592 ibuf[1] = control;
593 ibuf[2] = 0xFF - gsm_fcs_add_block(INIT_FCS, ibuf, 2);
594 /* Stuffing may double the size worst case */
595 len = gsm_stuff_frame(ibuf, cbuf + 1, 3);
596 /* Now add the SOF markers */
597 cbuf[0] = GSM1_SOF;
598 cbuf[len + 1] = GSM1_SOF;
599 /* FIXME: we can omit the lead one in many cases */
600 len += 2;
601 break;
602 default:
603 WARN_ON(1);
604 return;
605 }
606 gsm->output(gsm, cbuf, len);
607 gsm_print_packet("-->", addr, cr, control, NULL, 0);
608}
609
610/**
611 * gsm_response - send a control response
612 * @gsm: our GSM mux
613 * @addr: address for control frame
614 * @control: control byte including PF bit
615 *
616 * Format up and transmit a link level response frame.
617 */
618
619static inline void gsm_response(struct gsm_mux *gsm, int addr, int control)
620{
621 gsm_send(gsm, addr, 0, control);
622}
623
624/**
625 * gsm_command - send a control command
626 * @gsm: our GSM mux
627 * @addr: address for control frame
628 * @control: control byte including PF bit
629 *
630 * Format up and transmit a link level command frame.
631 */
632
633static inline void gsm_command(struct gsm_mux *gsm, int addr, int control)
634{
635 gsm_send(gsm, addr, 1, control);
636}
637
638/* Data transmission */
639
640#define HDR_LEN 6 /* ADDR CTRL [LEN.2] DATA FCS */
641
642/**
643 * gsm_data_alloc - allocate data frame
644 * @gsm: GSM mux
645 * @addr: DLCI address
646 * @len: length excluding header and FCS
647 * @ctrl: control byte
648 *
649 * Allocate a new data buffer for sending frames with data. Space is left
650 * at the front for header bytes but that is treated as an implementation
651 * detail and not for the high level code to use
652 */
653
654static struct gsm_msg *gsm_data_alloc(struct gsm_mux *gsm, u8 addr, int len,
655 u8 ctrl)
656{
657 struct gsm_msg *m = kmalloc(sizeof(struct gsm_msg) + len + HDR_LEN,
658 GFP_ATOMIC);
659 if (m == NULL)
660 return NULL;
661 m->data = m->buffer + HDR_LEN - 1; /* Allow for FCS */
662 m->len = len;
663 m->addr = addr;
664 m->ctrl = ctrl;
665 m->next = NULL;
666 return m;
667}
668
669/**
670 * gsm_data_kick - poke the queue
671 * @gsm: GSM Mux
672 *
673 * The tty device has called us to indicate that room has appeared in
674 * the transmit queue. Ram more data into the pipe if we have any
675 *
676 * FIXME: lock against link layer control transmissions
677 */
678
679static void gsm_data_kick(struct gsm_mux *gsm)
680{
681 struct gsm_msg *msg = gsm->tx_head;
682 int len;
683 int skip_sof = 0;
684
685 /* FIXME: We need to apply this solely to data messages */
686 if (gsm->constipated)
687 return;
688
689 while (gsm->tx_head != NULL) {
690 msg = gsm->tx_head;
691 if (gsm->encoding != 0) {
692 gsm->txframe[0] = GSM1_SOF;
693 len = gsm_stuff_frame(msg->data,
694 gsm->txframe + 1, msg->len);
695 gsm->txframe[len + 1] = GSM1_SOF;
696 len += 2;
697 } else {
698 gsm->txframe[0] = GSM0_SOF;
699 memcpy(gsm->txframe + 1 , msg->data, msg->len);
700 gsm->txframe[msg->len + 1] = GSM0_SOF;
701 len = msg->len + 2;
702 }
703
Joe Perches0a77c4f2011-04-25 16:46:49 -0700704 if (debug & 4)
705 print_hex_dump_bytes("gsm_data_kick: ",
706 DUMP_PREFIX_OFFSET,
707 gsm->txframe, len);
Alan Coxe1eaea42010-03-26 11:32:54 +0000708
709 if (gsm->output(gsm, gsm->txframe + skip_sof,
710 len - skip_sof) < 0)
711 break;
712 /* FIXME: Can eliminate one SOF in many more cases */
713 gsm->tx_head = msg->next;
714 if (gsm->tx_head == NULL)
715 gsm->tx_tail = NULL;
716 gsm->tx_bytes -= msg->len;
717 kfree(msg);
718 /* For a burst of frames skip the extra SOF within the
719 burst */
720 skip_sof = 1;
721 }
722}
723
724/**
725 * __gsm_data_queue - queue a UI or UIH frame
726 * @dlci: DLCI sending the data
727 * @msg: message queued
728 *
729 * Add data to the transmit queue and try and get stuff moving
730 * out of the mux tty if not already doing so. The Caller must hold
731 * the gsm tx lock.
732 */
733
734static void __gsm_data_queue(struct gsm_dlci *dlci, struct gsm_msg *msg)
735{
736 struct gsm_mux *gsm = dlci->gsm;
737 u8 *dp = msg->data;
738 u8 *fcs = dp + msg->len;
739
740 /* Fill in the header */
741 if (gsm->encoding == 0) {
742 if (msg->len < 128)
743 *--dp = (msg->len << 1) | EA;
744 else {
Ken Millsbe7a7412010-12-13 15:27:27 +0000745 *--dp = (msg->len >> 7); /* bits 7 - 15 */
746 *--dp = (msg->len & 127) << 1; /* bits 0 - 6 */
Alan Coxe1eaea42010-03-26 11:32:54 +0000747 }
748 }
749
750 *--dp = msg->ctrl;
751 if (gsm->initiator)
752 *--dp = (msg->addr << 2) | 2 | EA;
753 else
754 *--dp = (msg->addr << 2) | EA;
755 *fcs = gsm_fcs_add_block(INIT_FCS, dp , msg->data - dp);
756 /* Ugly protocol layering violation */
757 if (msg->ctrl == UI || msg->ctrl == (UI|PF))
758 *fcs = gsm_fcs_add_block(*fcs, msg->data, msg->len);
759 *fcs = 0xFF - *fcs;
760
761 gsm_print_packet("Q> ", msg->addr, gsm->initiator, msg->ctrl,
762 msg->data, msg->len);
763
764 /* Move the header back and adjust the length, also allow for the FCS
765 now tacked on the end */
766 msg->len += (msg->data - dp) + 1;
767 msg->data = dp;
768
769 /* Add to the actual output queue */
770 if (gsm->tx_tail)
771 gsm->tx_tail->next = msg;
772 else
773 gsm->tx_head = msg;
774 gsm->tx_tail = msg;
775 gsm->tx_bytes += msg->len;
776 gsm_data_kick(gsm);
777}
778
779/**
780 * gsm_data_queue - queue a UI or UIH frame
781 * @dlci: DLCI sending the data
782 * @msg: message queued
783 *
784 * Add data to the transmit queue and try and get stuff moving
785 * out of the mux tty if not already doing so. Take the
786 * the gsm tx lock and dlci lock.
787 */
788
789static void gsm_data_queue(struct gsm_dlci *dlci, struct gsm_msg *msg)
790{
791 unsigned long flags;
792 spin_lock_irqsave(&dlci->gsm->tx_lock, flags);
793 __gsm_data_queue(dlci, msg);
794 spin_unlock_irqrestore(&dlci->gsm->tx_lock, flags);
795}
796
797/**
798 * gsm_dlci_data_output - try and push data out of a DLCI
799 * @gsm: mux
800 * @dlci: the DLCI to pull data from
801 *
802 * Pull data from a DLCI and send it into the transmit queue if there
803 * is data. Keep to the MRU of the mux. This path handles the usual tty
804 * interface which is a byte stream with optional modem data.
805 *
806 * Caller must hold the tx_lock of the mux.
807 */
808
809static int gsm_dlci_data_output(struct gsm_mux *gsm, struct gsm_dlci *dlci)
810{
811 struct gsm_msg *msg;
812 u8 *dp;
813 int len, size;
814 int h = dlci->adaption - 1;
815
816 len = kfifo_len(dlci->fifo);
817 if (len == 0)
818 return 0;
819
820 /* MTU/MRU count only the data bits */
821 if (len > gsm->mtu)
822 len = gsm->mtu;
823
824 size = len + h;
825
826 msg = gsm_data_alloc(gsm, dlci->addr, size, gsm->ftype);
827 /* FIXME: need a timer or something to kick this so it can't
828 get stuck with no work outstanding and no buffer free */
829 if (msg == NULL)
830 return -ENOMEM;
831 dp = msg->data;
832 switch (dlci->adaption) {
833 case 1: /* Unstructured */
834 break;
835 case 2: /* Unstructed with modem bits. Always one byte as we never
836 send inline break data */
837 *dp += gsm_encode_modem(dlci);
838 len--;
839 break;
840 }
841 WARN_ON(kfifo_out_locked(dlci->fifo, dp , len, &dlci->lock) != len);
842 __gsm_data_queue(dlci, msg);
843 /* Bytes of data we used up */
844 return size;
845}
846
847/**
848 * gsm_dlci_data_output_framed - try and push data out of a DLCI
849 * @gsm: mux
850 * @dlci: the DLCI to pull data from
851 *
852 * Pull data from a DLCI and send it into the transmit queue if there
853 * is data. Keep to the MRU of the mux. This path handles framed data
854 * queued as skbuffs to the DLCI.
855 *
856 * Caller must hold the tx_lock of the mux.
857 */
858
859static int gsm_dlci_data_output_framed(struct gsm_mux *gsm,
860 struct gsm_dlci *dlci)
861{
862 struct gsm_msg *msg;
863 u8 *dp;
864 int len, size;
865 int last = 0, first = 0;
866 int overhead = 0;
867
868 /* One byte per frame is used for B/F flags */
869 if (dlci->adaption == 4)
870 overhead = 1;
871
872 /* dlci->skb is locked by tx_lock */
873 if (dlci->skb == NULL) {
874 dlci->skb = skb_dequeue(&dlci->skb_list);
875 if (dlci->skb == NULL)
876 return 0;
877 first = 1;
878 }
879 len = dlci->skb->len + overhead;
880
881 /* MTU/MRU count only the data bits */
882 if (len > gsm->mtu) {
883 if (dlci->adaption == 3) {
884 /* Over long frame, bin it */
885 kfree_skb(dlci->skb);
886 dlci->skb = NULL;
887 return 0;
888 }
889 len = gsm->mtu;
890 } else
891 last = 1;
892
893 size = len + overhead;
894 msg = gsm_data_alloc(gsm, dlci->addr, size, gsm->ftype);
895
896 /* FIXME: need a timer or something to kick this so it can't
897 get stuck with no work outstanding and no buffer free */
898 if (msg == NULL)
899 return -ENOMEM;
900 dp = msg->data;
901
902 if (dlci->adaption == 4) { /* Interruptible framed (Packetised Data) */
903 /* Flag byte to carry the start/end info */
904 *dp++ = last << 7 | first << 6 | 1; /* EA */
905 len--;
906 }
907 memcpy(dp, skb_pull(dlci->skb, len), len);
908 __gsm_data_queue(dlci, msg);
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700909 if (last) {
910 kfree_skb(dlci->skb);
Alan Coxe1eaea42010-03-26 11:32:54 +0000911 dlci->skb = NULL;
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700912 }
Alan Coxe1eaea42010-03-26 11:32:54 +0000913 return size;
914}
915
916/**
917 * gsm_dlci_data_sweep - look for data to send
918 * @gsm: the GSM mux
919 *
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
924 *
925 * FIXME: We should round robin between groups and in theory you can
926 * renegotiate DLCI priorities with optional stuff. Needs optimising.
927 */
928
929static void gsm_dlci_data_sweep(struct gsm_mux *gsm)
930{
931 int len;
932 /* Priority ordering: We should do priority with RR of the groups */
933 int i = 1;
Alan Coxe1eaea42010-03-26 11:32:54 +0000934
Alan Coxe1eaea42010-03-26 11:32:54 +0000935 while (i < NUM_DLCI) {
936 struct gsm_dlci *dlci;
937
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;
944 }
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700945 if (dlci->adaption < 3 && !dlci->net)
Alan Coxe1eaea42010-03-26 11:32:54 +0000946 len = gsm_dlci_data_output(gsm, dlci);
947 else
948 len = gsm_dlci_data_output_framed(gsm, dlci);
949 if (len < 0)
Julia Lawalle73790a2010-08-10 18:03:12 -0700950 break;
Alan Coxe1eaea42010-03-26 11:32:54 +0000951 /* DLCI empty - try the next */
952 if (len == 0)
953 i++;
954 }
Alan Coxe1eaea42010-03-26 11:32:54 +0000955}
956
957/**
958 * gsm_dlci_data_kick - transmit if possible
959 * @dlci: DLCI to kick
960 *
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.
964 */
965
966static void gsm_dlci_data_kick(struct gsm_dlci *dlci)
967{
968 unsigned long flags;
969
970 spin_lock_irqsave(&dlci->gsm->tx_lock, flags);
971 /* If we have nothing running then we need to fire up */
Russ Gorbybcd5abe2011-06-16 14:20:12 -0700972 if (dlci->gsm->tx_bytes == 0) {
973 if (dlci->net)
974 gsm_dlci_data_output_framed(dlci->gsm, dlci);
975 else
976 gsm_dlci_data_output(dlci->gsm, dlci);
977 } else if (dlci->gsm->tx_bytes < TX_THRESH_LO)
Alan Coxe1eaea42010-03-26 11:32:54 +0000978 gsm_dlci_data_sweep(dlci->gsm);
979 spin_unlock_irqrestore(&dlci->gsm->tx_lock, flags);
980}
981
982/*
983 * Control message processing
984 */
985
986
987/**
988 * gsm_control_reply - send a response frame to a control
989 * @gsm: gsm channel
990 * @cmd: the command to use
991 * @data: data to follow encoded info
992 * @dlen: length of data
993 *
994 * Encode up and queue a UI/UIH frame containing our response.
995 */
996
997static void gsm_control_reply(struct gsm_mux *gsm, int cmd, u8 *data,
998 int dlen)
999{
1000 struct gsm_msg *msg;
1001 msg = gsm_data_alloc(gsm, 0, dlen + 2, gsm->ftype);
Ken Mills093d8042010-12-13 15:28:03 +00001002 if (msg == NULL)
1003 return;
Alan Coxe1eaea42010-03-26 11:32:54 +00001004 msg->data[0] = (cmd & 0xFE) << 1 | EA; /* Clear C/R */
1005 msg->data[1] = (dlen << 1) | EA;
1006 memcpy(msg->data + 2, data, dlen);
1007 gsm_data_queue(gsm->dlci[0], msg);
1008}
1009
1010/**
1011 * gsm_process_modem - process received modem status
1012 * @tty: virtual tty bound to the DLCI
1013 * @dlci: DLCI to affect
1014 * @modem: modem bits (full EA)
1015 *
1016 * Used when a modem control message or line state inline in adaption
1017 * layer 2 is processed. Sort out the local modem state and throttles
1018 */
1019
1020static void gsm_process_modem(struct tty_struct *tty, struct gsm_dlci *dlci,
1021 u32 modem)
1022{
1023 int mlines = 0;
1024 u8 brk = modem >> 6;
1025
1026 /* Flow control/ready to communicate */
1027 if (modem & MDM_FC) {
1028 /* Need to throttle our output on this device */
1029 dlci->constipated = 1;
1030 }
1031 if (modem & MDM_RTC) {
1032 mlines |= TIOCM_DSR | TIOCM_DTR;
1033 dlci->constipated = 0;
1034 gsm_dlci_data_kick(dlci);
1035 }
1036 /* Map modem bits */
1037 if (modem & MDM_RTR)
1038 mlines |= TIOCM_RTS | TIOCM_CTS;
1039 if (modem & MDM_IC)
1040 mlines |= TIOCM_RI;
1041 if (modem & MDM_DV)
1042 mlines |= TIOCM_CD;
1043
1044 /* Carrier drop -> hangup */
1045 if (tty) {
1046 if ((mlines & TIOCM_CD) == 0 && (dlci->modem_rx & TIOCM_CD))
1047 if (!(tty->termios->c_cflag & CLOCAL))
1048 tty_hangup(tty);
1049 if (brk & 0x01)
1050 tty_insert_flip_char(tty, 0, TTY_BREAK);
1051 }
1052 dlci->modem_rx = mlines;
1053}
1054
1055/**
1056 * gsm_control_modem - modem status received
1057 * @gsm: GSM channel
1058 * @data: data following command
1059 * @clen: command length
1060 *
1061 * We have received a modem status control message. This is used by
1062 * the GSM mux protocol to pass virtual modem line status and optionally
1063 * to indicate break signals. Unpack it, convert to Linux representation
1064 * and if need be stuff a break message down the tty.
1065 */
1066
1067static void gsm_control_modem(struct gsm_mux *gsm, u8 *data, int clen)
1068{
1069 unsigned int addr = 0;
1070 unsigned int modem = 0;
1071 struct gsm_dlci *dlci;
1072 int len = clen;
1073 u8 *dp = data;
1074 struct tty_struct *tty;
1075
1076 while (gsm_read_ea(&addr, *dp++) == 0) {
1077 len--;
1078 if (len == 0)
1079 return;
1080 }
1081 /* Must be at least one byte following the EA */
1082 len--;
1083 if (len <= 0)
1084 return;
1085
1086 addr >>= 1;
1087 /* Closed port, or invalid ? */
1088 if (addr == 0 || addr >= NUM_DLCI || gsm->dlci[addr] == NULL)
1089 return;
1090 dlci = gsm->dlci[addr];
1091
1092 while (gsm_read_ea(&modem, *dp++) == 0) {
1093 len--;
1094 if (len == 0)
1095 return;
1096 }
1097 tty = tty_port_tty_get(&dlci->port);
1098 gsm_process_modem(tty, dlci, modem);
1099 if (tty) {
1100 tty_wakeup(tty);
1101 tty_kref_put(tty);
1102 }
1103 gsm_control_reply(gsm, CMD_MSC, data, clen);
1104}
1105
1106/**
1107 * gsm_control_rls - remote line status
1108 * @gsm: GSM channel
1109 * @data: data bytes
1110 * @clen: data length
1111 *
1112 * The modem sends us a two byte message on the control channel whenever
1113 * it wishes to send us an error state from the virtual link. Stuff
1114 * this into the uplink tty if present
1115 */
1116
1117static void gsm_control_rls(struct gsm_mux *gsm, u8 *data, int clen)
1118{
1119 struct tty_struct *tty;
1120 unsigned int addr = 0 ;
1121 u8 bits;
1122 int len = clen;
1123 u8 *dp = data;
1124
1125 while (gsm_read_ea(&addr, *dp++) == 0) {
1126 len--;
1127 if (len == 0)
1128 return;
1129 }
1130 /* Must be at least one byte following ea */
1131 len--;
1132 if (len <= 0)
1133 return;
1134 addr >>= 1;
1135 /* Closed port, or invalid ? */
1136 if (addr == 0 || addr >= NUM_DLCI || gsm->dlci[addr] == NULL)
1137 return;
1138 /* No error ? */
1139 bits = *dp;
1140 if ((bits & 1) == 0)
1141 return;
1142 /* See if we have an uplink tty */
1143 tty = tty_port_tty_get(&gsm->dlci[addr]->port);
1144
1145 if (tty) {
1146 if (bits & 2)
1147 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1148 if (bits & 4)
1149 tty_insert_flip_char(tty, 0, TTY_PARITY);
1150 if (bits & 8)
1151 tty_insert_flip_char(tty, 0, TTY_FRAME);
1152 tty_flip_buffer_push(tty);
1153 tty_kref_put(tty);
1154 }
1155 gsm_control_reply(gsm, CMD_RLS, data, clen);
1156}
1157
1158static void gsm_dlci_begin_close(struct gsm_dlci *dlci);
1159
1160/**
1161 * gsm_control_message - DLCI 0 control processing
1162 * @gsm: our GSM mux
1163 * @command: the command EA
1164 * @data: data beyond the command/length EAs
1165 * @clen: length
1166 *
1167 * Input processor for control messages from the other end of the link.
1168 * Processes the incoming request and queues a response frame or an
1169 * NSC response if not supported
1170 */
1171
1172static void gsm_control_message(struct gsm_mux *gsm, unsigned int command,
1173 u8 *data, int clen)
1174{
1175 u8 buf[1];
1176 switch (command) {
1177 case CMD_CLD: {
1178 struct gsm_dlci *dlci = gsm->dlci[0];
1179 /* Modem wishes to close down */
1180 if (dlci) {
1181 dlci->dead = 1;
1182 gsm->dead = 1;
1183 gsm_dlci_begin_close(dlci);
1184 }
1185 }
1186 break;
1187 case CMD_TEST:
1188 /* Modem wishes to test, reply with the data */
1189 gsm_control_reply(gsm, CMD_TEST, data, clen);
1190 break;
1191 case CMD_FCON:
1192 /* Modem wants us to STFU */
1193 gsm->constipated = 1;
1194 gsm_control_reply(gsm, CMD_FCON, NULL, 0);
1195 break;
1196 case CMD_FCOFF:
1197 /* Modem can accept data again */
1198 gsm->constipated = 0;
1199 gsm_control_reply(gsm, CMD_FCOFF, NULL, 0);
1200 /* Kick the link in case it is idling */
1201 gsm_data_kick(gsm);
1202 break;
1203 case CMD_MSC:
1204 /* Out of band modem line change indicator for a DLCI */
1205 gsm_control_modem(gsm, data, clen);
1206 break;
1207 case CMD_RLS:
1208 /* Out of band error reception for a DLCI */
1209 gsm_control_rls(gsm, data, clen);
1210 break;
1211 case CMD_PSC:
1212 /* Modem wishes to enter power saving state */
1213 gsm_control_reply(gsm, CMD_PSC, NULL, 0);
1214 break;
1215 /* Optional unsupported commands */
1216 case CMD_PN: /* Parameter negotiation */
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001217 case CMD_RPN: /* Remote port negotiation */
1218 case CMD_SNC: /* Service negotiation command */
Alan Coxe1eaea42010-03-26 11:32:54 +00001219 default:
1220 /* Reply to bad commands with an NSC */
1221 buf[0] = command;
1222 gsm_control_reply(gsm, CMD_NSC, buf, 1);
1223 break;
1224 }
1225}
1226
1227/**
1228 * gsm_control_response - process a response to our control
1229 * @gsm: our GSM mux
1230 * @command: the command (response) EA
1231 * @data: data beyond the command/length EA
1232 * @clen: length
1233 *
1234 * Process a response to an outstanding command. We only allow a single
1235 * control message in flight so this is fairly easy. All the clean up
1236 * is done by the caller, we just update the fields, flag it as done
1237 * and return
1238 */
1239
1240static void gsm_control_response(struct gsm_mux *gsm, unsigned int command,
1241 u8 *data, int clen)
1242{
1243 struct gsm_control *ctrl;
1244 unsigned long flags;
1245
1246 spin_lock_irqsave(&gsm->control_lock, flags);
1247
1248 ctrl = gsm->pending_cmd;
1249 /* Does the reply match our command */
1250 command |= 1;
1251 if (ctrl != NULL && (command == ctrl->cmd || command == CMD_NSC)) {
1252 /* Our command was replied to, kill the retry timer */
1253 del_timer(&gsm->t2_timer);
1254 gsm->pending_cmd = NULL;
1255 /* Rejected by the other end */
1256 if (command == CMD_NSC)
1257 ctrl->error = -EOPNOTSUPP;
1258 ctrl->done = 1;
1259 wake_up(&gsm->event);
1260 }
1261 spin_unlock_irqrestore(&gsm->control_lock, flags);
1262}
1263
1264/**
Alan Cox5f9a31d2010-11-04 15:17:27 +00001265 * gsm_control_transmit - send control packet
Alan Coxe1eaea42010-03-26 11:32:54 +00001266 * @gsm: gsm mux
1267 * @ctrl: frame to send
1268 *
1269 * Send out a pending control command (called under control lock)
1270 */
1271
1272static void gsm_control_transmit(struct gsm_mux *gsm, struct gsm_control *ctrl)
1273{
Eric Bénarded43b472011-03-09 19:24:49 +01001274 struct gsm_msg *msg = gsm_data_alloc(gsm, 0, ctrl->len + 1, gsm->ftype);
Alan Coxe1eaea42010-03-26 11:32:54 +00001275 if (msg == NULL)
1276 return;
1277 msg->data[0] = (ctrl->cmd << 1) | 2 | EA; /* command */
1278 memcpy(msg->data + 1, ctrl->data, ctrl->len);
1279 gsm_data_queue(gsm->dlci[0], msg);
1280}
1281
1282/**
1283 * gsm_control_retransmit - retransmit a control frame
1284 * @data: pointer to our gsm object
1285 *
1286 * Called off the T2 timer expiry in order to retransmit control frames
1287 * that have been lost in the system somewhere. The control_lock protects
1288 * us from colliding with another sender or a receive completion event.
1289 * In that situation the timer may still occur in a small window but
1290 * gsm->pending_cmd will be NULL and we just let the timer expire.
1291 */
1292
1293static void gsm_control_retransmit(unsigned long data)
1294{
1295 struct gsm_mux *gsm = (struct gsm_mux *)data;
1296 struct gsm_control *ctrl;
1297 unsigned long flags;
1298 spin_lock_irqsave(&gsm->control_lock, flags);
1299 ctrl = gsm->pending_cmd;
1300 if (ctrl) {
1301 gsm->cretries--;
1302 if (gsm->cretries == 0) {
1303 gsm->pending_cmd = NULL;
1304 ctrl->error = -ETIMEDOUT;
1305 ctrl->done = 1;
1306 spin_unlock_irqrestore(&gsm->control_lock, flags);
1307 wake_up(&gsm->event);
1308 return;
1309 }
1310 gsm_control_transmit(gsm, ctrl);
1311 mod_timer(&gsm->t2_timer, jiffies + gsm->t2 * HZ / 100);
1312 }
1313 spin_unlock_irqrestore(&gsm->control_lock, flags);
1314}
1315
1316/**
1317 * gsm_control_send - send a control frame on DLCI 0
1318 * @gsm: the GSM channel
1319 * @command: command to send including CR bit
1320 * @data: bytes of data (must be kmalloced)
1321 * @len: length of the block to send
1322 *
1323 * Queue and dispatch a control command. Only one command can be
1324 * active at a time. In theory more can be outstanding but the matching
1325 * gets really complicated so for now stick to one outstanding.
1326 */
1327
1328static struct gsm_control *gsm_control_send(struct gsm_mux *gsm,
1329 unsigned int command, u8 *data, int clen)
1330{
1331 struct gsm_control *ctrl = kzalloc(sizeof(struct gsm_control),
1332 GFP_KERNEL);
1333 unsigned long flags;
1334 if (ctrl == NULL)
1335 return NULL;
1336retry:
1337 wait_event(gsm->event, gsm->pending_cmd == NULL);
1338 spin_lock_irqsave(&gsm->control_lock, flags);
1339 if (gsm->pending_cmd != NULL) {
1340 spin_unlock_irqrestore(&gsm->control_lock, flags);
1341 goto retry;
1342 }
1343 ctrl->cmd = command;
1344 ctrl->data = data;
1345 ctrl->len = clen;
1346 gsm->pending_cmd = ctrl;
1347 gsm->cretries = gsm->n2;
1348 mod_timer(&gsm->t2_timer, jiffies + gsm->t2 * HZ / 100);
1349 gsm_control_transmit(gsm, ctrl);
1350 spin_unlock_irqrestore(&gsm->control_lock, flags);
1351 return ctrl;
1352}
1353
1354/**
1355 * gsm_control_wait - wait for a control to finish
1356 * @gsm: GSM mux
1357 * @control: control we are waiting on
1358 *
1359 * Waits for the control to complete or time out. Frees any used
1360 * resources and returns 0 for success, or an error if the remote
1361 * rejected or ignored the request.
1362 */
1363
1364static int gsm_control_wait(struct gsm_mux *gsm, struct gsm_control *control)
1365{
1366 int err;
1367 wait_event(gsm->event, control->done == 1);
1368 err = control->error;
1369 kfree(control);
1370 return err;
1371}
1372
1373
1374/*
1375 * DLCI level handling: Needs krefs
1376 */
1377
1378/*
1379 * State transitions and timers
1380 */
1381
1382/**
1383 * gsm_dlci_close - a DLCI has closed
1384 * @dlci: DLCI that closed
1385 *
1386 * Perform processing when moving a DLCI into closed state. If there
1387 * is an attached tty this is hung up
1388 */
1389
1390static void gsm_dlci_close(struct gsm_dlci *dlci)
1391{
1392 del_timer(&dlci->t1);
1393 if (debug & 8)
Alan Cox5f9a31d2010-11-04 15:17:27 +00001394 pr_debug("DLCI %d goes closed.\n", dlci->addr);
Alan Coxe1eaea42010-03-26 11:32:54 +00001395 dlci->state = DLCI_CLOSED;
1396 if (dlci->addr != 0) {
1397 struct tty_struct *tty = tty_port_tty_get(&dlci->port);
1398 if (tty) {
1399 tty_hangup(tty);
1400 tty_kref_put(tty);
1401 }
1402 kfifo_reset(dlci->fifo);
1403 } else
1404 dlci->gsm->dead = 1;
1405 wake_up(&dlci->gsm->event);
1406 /* A DLCI 0 close is a MUX termination so we need to kick that
1407 back to userspace somehow */
1408}
1409
1410/**
1411 * gsm_dlci_open - a DLCI has opened
1412 * @dlci: DLCI that opened
1413 *
1414 * Perform processing when moving a DLCI into open state.
1415 */
1416
1417static void gsm_dlci_open(struct gsm_dlci *dlci)
1418{
1419 /* Note that SABM UA .. SABM UA first UA lost can mean that we go
1420 open -> open */
1421 del_timer(&dlci->t1);
1422 /* This will let a tty open continue */
1423 dlci->state = DLCI_OPEN;
1424 if (debug & 8)
Alan Cox5f9a31d2010-11-04 15:17:27 +00001425 pr_debug("DLCI %d goes open.\n", dlci->addr);
Alan Coxe1eaea42010-03-26 11:32:54 +00001426 wake_up(&dlci->gsm->event);
1427}
1428
1429/**
1430 * gsm_dlci_t1 - T1 timer expiry
1431 * @dlci: DLCI that opened
1432 *
1433 * The T1 timer handles retransmits of control frames (essentially of
1434 * SABM and DISC). We resend the command until the retry count runs out
1435 * in which case an opening port goes back to closed and a closing port
1436 * is simply put into closed state (any further frames from the other
1437 * end will get a DM response)
1438 */
1439
1440static void gsm_dlci_t1(unsigned long data)
1441{
1442 struct gsm_dlci *dlci = (struct gsm_dlci *)data;
1443 struct gsm_mux *gsm = dlci->gsm;
1444
1445 switch (dlci->state) {
1446 case DLCI_OPENING:
1447 dlci->retries--;
1448 if (dlci->retries) {
1449 gsm_command(dlci->gsm, dlci->addr, SABM|PF);
1450 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1451 } else
1452 gsm_dlci_close(dlci);
1453 break;
1454 case DLCI_CLOSING:
1455 dlci->retries--;
1456 if (dlci->retries) {
1457 gsm_command(dlci->gsm, dlci->addr, DISC|PF);
1458 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1459 } else
1460 gsm_dlci_close(dlci);
1461 break;
1462 }
1463}
1464
1465/**
1466 * gsm_dlci_begin_open - start channel open procedure
1467 * @dlci: DLCI to open
1468 *
1469 * Commence opening a DLCI from the Linux side. We issue SABM messages
1470 * to the modem which should then reply with a UA, at which point we
1471 * will move into open state. Opening is done asynchronously with retry
1472 * running off timers and the responses.
1473 */
1474
1475static void gsm_dlci_begin_open(struct gsm_dlci *dlci)
1476{
1477 struct gsm_mux *gsm = dlci->gsm;
1478 if (dlci->state == DLCI_OPEN || dlci->state == DLCI_OPENING)
1479 return;
1480 dlci->retries = gsm->n2;
1481 dlci->state = DLCI_OPENING;
1482 gsm_command(dlci->gsm, dlci->addr, SABM|PF);
1483 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1484}
1485
1486/**
1487 * gsm_dlci_begin_close - start channel open procedure
1488 * @dlci: DLCI to open
1489 *
1490 * Commence closing a DLCI from the Linux side. We issue DISC messages
1491 * to the modem which should then reply with a UA, at which point we
1492 * will move into closed state. Closing is done asynchronously with retry
1493 * off timers. We may also receive a DM reply from the other end which
1494 * indicates the channel was already closed.
1495 */
1496
1497static void gsm_dlci_begin_close(struct gsm_dlci *dlci)
1498{
1499 struct gsm_mux *gsm = dlci->gsm;
1500 if (dlci->state == DLCI_CLOSED || dlci->state == DLCI_CLOSING)
1501 return;
1502 dlci->retries = gsm->n2;
1503 dlci->state = DLCI_CLOSING;
1504 gsm_command(dlci->gsm, dlci->addr, DISC|PF);
1505 mod_timer(&dlci->t1, jiffies + gsm->t1 * HZ / 100);
1506}
1507
1508/**
1509 * gsm_dlci_data - data arrived
1510 * @dlci: channel
1511 * @data: block of bytes received
1512 * @len: length of received block
1513 *
1514 * A UI or UIH frame has arrived which contains data for a channel
1515 * other than the control channel. If the relevant virtual tty is
1516 * open we shovel the bits down it, if not we drop them.
1517 */
1518
1519static void gsm_dlci_data(struct gsm_dlci *dlci, u8 *data, int len)
1520{
1521 /* krefs .. */
1522 struct tty_port *port = &dlci->port;
1523 struct tty_struct *tty = tty_port_tty_get(port);
1524 unsigned int modem = 0;
1525
1526 if (debug & 16)
Alan Cox5f9a31d2010-11-04 15:17:27 +00001527 pr_debug("%d bytes for tty %p\n", len, tty);
Alan Coxe1eaea42010-03-26 11:32:54 +00001528 if (tty) {
1529 switch (dlci->adaption) {
Alan Cox5f9a31d2010-11-04 15:17:27 +00001530 /* Unsupported types */
1531 /* Packetised interruptible data */
1532 case 4:
1533 break;
1534 /* Packetised uininterruptible voice/data */
1535 case 3:
1536 break;
1537 /* Asynchronous serial with line state in each frame */
1538 case 2:
1539 while (gsm_read_ea(&modem, *data++) == 0) {
1540 len--;
1541 if (len == 0)
1542 return;
1543 }
1544 gsm_process_modem(tty, dlci, modem);
1545 /* Line state will go via DLCI 0 controls only */
1546 case 1:
1547 default:
1548 tty_insert_flip_string(tty, data, len);
1549 tty_flip_buffer_push(tty);
Alan Coxe1eaea42010-03-26 11:32:54 +00001550 }
1551 tty_kref_put(tty);
1552 }
1553}
1554
1555/**
1556 * gsm_dlci_control - data arrived on control channel
1557 * @dlci: channel
1558 * @data: block of bytes received
1559 * @len: length of received block
1560 *
1561 * A UI or UIH frame has arrived which contains data for DLCI 0 the
1562 * control channel. This should contain a command EA followed by
1563 * control data bytes. The command EA contains a command/response bit
1564 * and we divide up the work accordingly.
1565 */
1566
1567static void gsm_dlci_command(struct gsm_dlci *dlci, u8 *data, int len)
1568{
1569 /* See what command is involved */
1570 unsigned int command = 0;
1571 while (len-- > 0) {
1572 if (gsm_read_ea(&command, *data++) == 1) {
1573 int clen = *data++;
1574 len--;
1575 /* FIXME: this is properly an EA */
1576 clen >>= 1;
1577 /* Malformed command ? */
1578 if (clen > len)
1579 return;
1580 if (command & 1)
1581 gsm_control_message(dlci->gsm, command,
1582 data, clen);
1583 else
1584 gsm_control_response(dlci->gsm, command,
1585 data, clen);
1586 return;
1587 }
1588 }
1589}
1590
1591/*
1592 * Allocate/Free DLCI channels
1593 */
1594
1595/**
1596 * gsm_dlci_alloc - allocate a DLCI
1597 * @gsm: GSM mux
1598 * @addr: address of the DLCI
1599 *
1600 * Allocate and install a new DLCI object into the GSM mux.
1601 *
1602 * FIXME: review locking races
1603 */
1604
1605static struct gsm_dlci *gsm_dlci_alloc(struct gsm_mux *gsm, int addr)
1606{
1607 struct gsm_dlci *dlci = kzalloc(sizeof(struct gsm_dlci), GFP_ATOMIC);
1608 if (dlci == NULL)
1609 return NULL;
1610 spin_lock_init(&dlci->lock);
Russ Gorby6ab8fba2011-06-16 14:20:13 -07001611 kref_init(&dlci->ref);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07001612 mutex_init(&dlci->mutex);
Alan Coxe1eaea42010-03-26 11:32:54 +00001613 dlci->fifo = &dlci->_fifo;
1614 if (kfifo_alloc(&dlci->_fifo, 4096, GFP_KERNEL) < 0) {
1615 kfree(dlci);
1616 return NULL;
1617 }
1618
1619 skb_queue_head_init(&dlci->skb_list);
1620 init_timer(&dlci->t1);
1621 dlci->t1.function = gsm_dlci_t1;
1622 dlci->t1.data = (unsigned long)dlci;
1623 tty_port_init(&dlci->port);
1624 dlci->port.ops = &gsm_port_ops;
1625 dlci->gsm = gsm;
1626 dlci->addr = addr;
1627 dlci->adaption = gsm->adaption;
1628 dlci->state = DLCI_CLOSED;
1629 if (addr)
1630 dlci->data = gsm_dlci_data;
1631 else
1632 dlci->data = gsm_dlci_command;
1633 gsm->dlci[addr] = dlci;
1634 return dlci;
1635}
1636
1637/**
Russ Gorby6ab8fba2011-06-16 14:20:13 -07001638 * gsm_dlci_free - free DLCI
1639 * @dlci: DLCI to free
Alan Coxe1eaea42010-03-26 11:32:54 +00001640 *
Russ Gorby6ab8fba2011-06-16 14:20:13 -07001641 * Free up a DLCI.
Alan Coxe1eaea42010-03-26 11:32:54 +00001642 *
1643 * Can sleep.
1644 */
Russ Gorby6ab8fba2011-06-16 14:20:13 -07001645static void gsm_dlci_free(struct kref *ref)
1646{
1647 struct gsm_dlci *dlci = container_of(ref, struct gsm_dlci, ref);
1648
1649 del_timer_sync(&dlci->t1);
1650 dlci->gsm->dlci[dlci->addr] = NULL;
1651 kfifo_free(dlci->fifo);
1652 while ((dlci->skb = skb_dequeue(&dlci->skb_list)))
1653 kfree_skb(dlci->skb);
1654 kfree(dlci);
1655}
1656
1657static inline void dlci_get(struct gsm_dlci *dlci)
1658{
1659 kref_get(&dlci->ref);
1660}
1661
1662static inline void dlci_put(struct gsm_dlci *dlci)
1663{
1664 kref_put(&dlci->ref, gsm_dlci_free);
1665}
1666
1667/**
1668 * gsm_dlci_release - release DLCI
1669 * @dlci: DLCI to destroy
1670 *
1671 * Release a DLCI. Actual free is deferred until either
1672 * mux is closed or tty is closed - whichever is last.
1673 *
1674 * Can sleep.
1675 */
1676static void gsm_dlci_release(struct gsm_dlci *dlci)
Alan Coxe1eaea42010-03-26 11:32:54 +00001677{
1678 struct tty_struct *tty = tty_port_tty_get(&dlci->port);
1679 if (tty) {
1680 tty_vhangup(tty);
1681 tty_kref_put(tty);
1682 }
Russ Gorby6ab8fba2011-06-16 14:20:13 -07001683 dlci_put(dlci);
Alan Coxe1eaea42010-03-26 11:32:54 +00001684}
1685
Alan Coxe1eaea42010-03-26 11:32:54 +00001686/*
1687 * LAPBish link layer logic
1688 */
1689
1690/**
1691 * gsm_queue - a GSM frame is ready to process
1692 * @gsm: pointer to our gsm mux
1693 *
1694 * At this point in time a frame has arrived and been demangled from
1695 * the line encoding. All the differences between the encodings have
1696 * been handled below us and the frame is unpacked into the structures.
1697 * The fcs holds the header FCS but any data FCS must be added here.
1698 */
1699
1700static void gsm_queue(struct gsm_mux *gsm)
1701{
1702 struct gsm_dlci *dlci;
1703 u8 cr;
1704 int address;
1705 /* We have to sneak a look at the packet body to do the FCS.
1706 A somewhat layering violation in the spec */
1707
1708 if ((gsm->control & ~PF) == UI)
1709 gsm->fcs = gsm_fcs_add_block(gsm->fcs, gsm->buf, gsm->len);
Mikhail Kshevetskiy9db4e432011-03-27 04:05:00 +04001710 if (gsm->encoding == 0){
1711 /* WARNING: gsm->received_fcs is used for gsm->encoding = 0 only.
1712 In this case it contain the last piece of data
1713 required to generate final CRC */
1714 gsm->fcs = gsm_fcs_add(gsm->fcs, gsm->received_fcs);
1715 }
Alan Coxe1eaea42010-03-26 11:32:54 +00001716 if (gsm->fcs != GOOD_FCS) {
1717 gsm->bad_fcs++;
1718 if (debug & 4)
Alan Cox5f9a31d2010-11-04 15:17:27 +00001719 pr_debug("BAD FCS %02x\n", gsm->fcs);
Alan Coxe1eaea42010-03-26 11:32:54 +00001720 return;
1721 }
1722 address = gsm->address >> 1;
1723 if (address >= NUM_DLCI)
1724 goto invalid;
1725
1726 cr = gsm->address & 1; /* C/R bit */
1727
1728 gsm_print_packet("<--", address, cr, gsm->control, gsm->buf, gsm->len);
1729
1730 cr ^= 1 - gsm->initiator; /* Flip so 1 always means command */
1731 dlci = gsm->dlci[address];
1732
1733 switch (gsm->control) {
1734 case SABM|PF:
1735 if (cr == 0)
1736 goto invalid;
1737 if (dlci == NULL)
1738 dlci = gsm_dlci_alloc(gsm, address);
1739 if (dlci == NULL)
1740 return;
1741 if (dlci->dead)
1742 gsm_response(gsm, address, DM);
1743 else {
1744 gsm_response(gsm, address, UA);
1745 gsm_dlci_open(dlci);
1746 }
1747 break;
1748 case DISC|PF:
1749 if (cr == 0)
1750 goto invalid;
1751 if (dlci == NULL || dlci->state == DLCI_CLOSED) {
1752 gsm_response(gsm, address, DM);
1753 return;
1754 }
1755 /* Real close complete */
1756 gsm_response(gsm, address, UA);
1757 gsm_dlci_close(dlci);
1758 break;
1759 case UA:
1760 case UA|PF:
1761 if (cr == 0 || dlci == NULL)
1762 break;
1763 switch (dlci->state) {
1764 case DLCI_CLOSING:
1765 gsm_dlci_close(dlci);
1766 break;
1767 case DLCI_OPENING:
1768 gsm_dlci_open(dlci);
1769 break;
1770 }
1771 break;
1772 case DM: /* DM can be valid unsolicited */
1773 case DM|PF:
1774 if (cr)
1775 goto invalid;
1776 if (dlci == NULL)
1777 return;
1778 gsm_dlci_close(dlci);
1779 break;
1780 case UI:
1781 case UI|PF:
1782 case UIH:
1783 case UIH|PF:
1784#if 0
1785 if (cr)
1786 goto invalid;
1787#endif
1788 if (dlci == NULL || dlci->state != DLCI_OPEN) {
1789 gsm_command(gsm, address, DM|PF);
1790 return;
1791 }
1792 dlci->data(dlci, gsm->buf, gsm->len);
1793 break;
1794 default:
1795 goto invalid;
1796 }
1797 return;
1798invalid:
1799 gsm->malformed++;
1800 return;
1801}
1802
1803
1804/**
1805 * gsm0_receive - perform processing for non-transparency
1806 * @gsm: gsm data for this ldisc instance
1807 * @c: character
1808 *
1809 * Receive bytes in gsm mode 0
1810 */
1811
1812static void gsm0_receive(struct gsm_mux *gsm, unsigned char c)
1813{
Alan Coxc2f2f002010-11-04 15:17:03 +00001814 unsigned int len;
1815
Alan Coxe1eaea42010-03-26 11:32:54 +00001816 switch (gsm->state) {
1817 case GSM_SEARCH: /* SOF marker */
1818 if (c == GSM0_SOF) {
1819 gsm->state = GSM_ADDRESS;
1820 gsm->address = 0;
1821 gsm->len = 0;
1822 gsm->fcs = INIT_FCS;
1823 }
Alan Coxc2f2f002010-11-04 15:17:03 +00001824 break;
1825 case GSM_ADDRESS: /* Address EA */
Alan Coxe1eaea42010-03-26 11:32:54 +00001826 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1827 if (gsm_read_ea(&gsm->address, c))
1828 gsm->state = GSM_CONTROL;
1829 break;
1830 case GSM_CONTROL: /* Control Byte */
1831 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1832 gsm->control = c;
Alan Coxc2f2f002010-11-04 15:17:03 +00001833 gsm->state = GSM_LEN0;
Alan Coxe1eaea42010-03-26 11:32:54 +00001834 break;
Alan Coxc2f2f002010-11-04 15:17:03 +00001835 case GSM_LEN0: /* Length EA */
Alan Coxe1eaea42010-03-26 11:32:54 +00001836 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1837 if (gsm_read_ea(&gsm->len, c)) {
1838 if (gsm->len > gsm->mru) {
1839 gsm->bad_size++;
1840 gsm->state = GSM_SEARCH;
1841 break;
1842 }
1843 gsm->count = 0;
Alan Coxc2f2f002010-11-04 15:17:03 +00001844 if (!gsm->len)
1845 gsm->state = GSM_FCS;
1846 else
1847 gsm->state = GSM_DATA;
1848 break;
Alan Coxe1eaea42010-03-26 11:32:54 +00001849 }
Alan Coxc2f2f002010-11-04 15:17:03 +00001850 gsm->state = GSM_LEN1;
1851 break;
1852 case GSM_LEN1:
1853 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1854 len = c;
1855 gsm->len |= len << 7;
1856 if (gsm->len > gsm->mru) {
1857 gsm->bad_size++;
1858 gsm->state = GSM_SEARCH;
1859 break;
1860 }
1861 gsm->count = 0;
1862 if (!gsm->len)
1863 gsm->state = GSM_FCS;
1864 else
1865 gsm->state = GSM_DATA;
Alan Coxe1eaea42010-03-26 11:32:54 +00001866 break;
1867 case GSM_DATA: /* Data */
1868 gsm->buf[gsm->count++] = c;
1869 if (gsm->count == gsm->len)
1870 gsm->state = GSM_FCS;
1871 break;
1872 case GSM_FCS: /* FCS follows the packet */
Alan Coxc2f2f002010-11-04 15:17:03 +00001873 gsm->received_fcs = c;
1874 if (c == GSM0_SOF) {
1875 gsm->state = GSM_SEARCH;
1876 break;
1877 }
Alan Coxe1eaea42010-03-26 11:32:54 +00001878 gsm_queue(gsm);
Alan Coxc2f2f002010-11-04 15:17:03 +00001879 gsm->state = GSM_SSOF;
1880 break;
1881 case GSM_SSOF:
1882 if (c == GSM0_SOF) {
1883 gsm->state = GSM_SEARCH;
1884 break;
1885 }
Alan Coxe1eaea42010-03-26 11:32:54 +00001886 break;
1887 }
1888}
1889
1890/**
Alan Coxc2f2f002010-11-04 15:17:03 +00001891 * gsm1_receive - perform processing for non-transparency
Alan Coxe1eaea42010-03-26 11:32:54 +00001892 * @gsm: gsm data for this ldisc instance
1893 * @c: character
1894 *
1895 * Receive bytes in mode 1 (Advanced option)
1896 */
1897
1898static void gsm1_receive(struct gsm_mux *gsm, unsigned char c)
1899{
1900 if (c == GSM1_SOF) {
1901 /* EOF is only valid in frame if we have got to the data state
1902 and received at least one byte (the FCS) */
1903 if (gsm->state == GSM_DATA && gsm->count) {
1904 /* Extract the FCS */
1905 gsm->count--;
1906 gsm->fcs = gsm_fcs_add(gsm->fcs, gsm->buf[gsm->count]);
1907 gsm->len = gsm->count;
1908 gsm_queue(gsm);
1909 gsm->state = GSM_START;
1910 return;
1911 }
1912 /* Any partial frame was a runt so go back to start */
1913 if (gsm->state != GSM_START) {
1914 gsm->malformed++;
1915 gsm->state = GSM_START;
1916 }
1917 /* A SOF in GSM_START means we are still reading idling or
1918 framing bytes */
1919 return;
1920 }
1921
1922 if (c == GSM1_ESCAPE) {
1923 gsm->escape = 1;
1924 return;
1925 }
1926
1927 /* Only an unescaped SOF gets us out of GSM search */
1928 if (gsm->state == GSM_SEARCH)
1929 return;
1930
1931 if (gsm->escape) {
1932 c ^= GSM1_ESCAPE_BITS;
1933 gsm->escape = 0;
1934 }
1935 switch (gsm->state) {
1936 case GSM_START: /* First byte after SOF */
1937 gsm->address = 0;
1938 gsm->state = GSM_ADDRESS;
1939 gsm->fcs = INIT_FCS;
1940 /* Drop through */
1941 case GSM_ADDRESS: /* Address continuation */
1942 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1943 if (gsm_read_ea(&gsm->address, c))
1944 gsm->state = GSM_CONTROL;
1945 break;
1946 case GSM_CONTROL: /* Control Byte */
1947 gsm->fcs = gsm_fcs_add(gsm->fcs, c);
1948 gsm->control = c;
1949 gsm->count = 0;
1950 gsm->state = GSM_DATA;
1951 break;
1952 case GSM_DATA: /* Data */
Alan Cox5f9a31d2010-11-04 15:17:27 +00001953 if (gsm->count > gsm->mru) { /* Allow one for the FCS */
Alan Coxe1eaea42010-03-26 11:32:54 +00001954 gsm->state = GSM_OVERRUN;
1955 gsm->bad_size++;
1956 } else
1957 gsm->buf[gsm->count++] = c;
1958 break;
1959 case GSM_OVERRUN: /* Over-long - eg a dropped SOF */
1960 break;
1961 }
1962}
1963
1964/**
1965 * gsm_error - handle tty error
1966 * @gsm: ldisc data
1967 * @data: byte received (may be invalid)
1968 * @flag: error received
1969 *
1970 * Handle an error in the receipt of data for a frame. Currently we just
1971 * go back to hunting for a SOF.
1972 *
1973 * FIXME: better diagnostics ?
1974 */
1975
1976static void gsm_error(struct gsm_mux *gsm,
1977 unsigned char data, unsigned char flag)
1978{
1979 gsm->state = GSM_SEARCH;
1980 gsm->io_error++;
1981}
1982
1983/**
1984 * gsm_cleanup_mux - generic GSM protocol cleanup
1985 * @gsm: our mux
1986 *
1987 * Clean up the bits of the mux which are the same for all framing
1988 * protocols. Remove the mux from the mux table, stop all the timers
1989 * and then shut down each device hanging up the channels as we go.
1990 */
1991
1992void gsm_cleanup_mux(struct gsm_mux *gsm)
1993{
1994 int i;
1995 struct gsm_dlci *dlci = gsm->dlci[0];
1996 struct gsm_msg *txq;
1997
1998 gsm->dead = 1;
1999
2000 spin_lock(&gsm_mux_lock);
2001 for (i = 0; i < MAX_MUX; i++) {
2002 if (gsm_mux[i] == gsm) {
2003 gsm_mux[i] = NULL;
2004 break;
2005 }
2006 }
2007 spin_unlock(&gsm_mux_lock);
2008 WARN_ON(i == MAX_MUX);
2009
2010 del_timer_sync(&gsm->t2_timer);
2011 /* Now we are sure T2 has stopped */
2012 if (dlci) {
2013 dlci->dead = 1;
2014 gsm_dlci_begin_close(dlci);
2015 wait_event_interruptible(gsm->event,
2016 dlci->state == DLCI_CLOSED);
2017 }
2018 /* Free up any link layer users */
2019 for (i = 0; i < NUM_DLCI; i++)
2020 if (gsm->dlci[i])
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002021 gsm_dlci_release(gsm->dlci[i]);
Alan Coxe1eaea42010-03-26 11:32:54 +00002022 /* Now wipe the queues */
2023 for (txq = gsm->tx_head; txq != NULL; txq = gsm->tx_head) {
2024 gsm->tx_head = txq->next;
2025 kfree(txq);
2026 }
2027 gsm->tx_tail = NULL;
2028}
2029EXPORT_SYMBOL_GPL(gsm_cleanup_mux);
2030
2031/**
2032 * gsm_activate_mux - generic GSM setup
2033 * @gsm: our mux
2034 *
2035 * Set up the bits of the mux which are the same for all framing
2036 * protocols. Add the mux to the mux table so it can be opened and
2037 * finally kick off connecting to DLCI 0 on the modem.
2038 */
2039
2040int gsm_activate_mux(struct gsm_mux *gsm)
2041{
2042 struct gsm_dlci *dlci;
2043 int i = 0;
2044
2045 init_timer(&gsm->t2_timer);
2046 gsm->t2_timer.function = gsm_control_retransmit;
2047 gsm->t2_timer.data = (unsigned long)gsm;
2048 init_waitqueue_head(&gsm->event);
2049 spin_lock_init(&gsm->control_lock);
2050 spin_lock_init(&gsm->tx_lock);
2051
2052 if (gsm->encoding == 0)
2053 gsm->receive = gsm0_receive;
2054 else
2055 gsm->receive = gsm1_receive;
2056 gsm->error = gsm_error;
2057
2058 spin_lock(&gsm_mux_lock);
2059 for (i = 0; i < MAX_MUX; i++) {
2060 if (gsm_mux[i] == NULL) {
Russ Gorbyd50f6dc2011-06-14 13:35:32 -07002061 gsm->num = i;
Alan Coxe1eaea42010-03-26 11:32:54 +00002062 gsm_mux[i] = gsm;
2063 break;
2064 }
2065 }
2066 spin_unlock(&gsm_mux_lock);
2067 if (i == MAX_MUX)
2068 return -EBUSY;
2069
2070 dlci = gsm_dlci_alloc(gsm, 0);
2071 if (dlci == NULL)
2072 return -ENOMEM;
2073 gsm->dead = 0; /* Tty opens are now permissible */
2074 return 0;
2075}
2076EXPORT_SYMBOL_GPL(gsm_activate_mux);
2077
2078/**
2079 * gsm_free_mux - free up a mux
2080 * @mux: mux to free
2081 *
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002082 * Dispose of allocated resources for a dead mux
Alan Coxe1eaea42010-03-26 11:32:54 +00002083 */
2084void gsm_free_mux(struct gsm_mux *gsm)
2085{
2086 kfree(gsm->txframe);
2087 kfree(gsm->buf);
2088 kfree(gsm);
2089}
2090EXPORT_SYMBOL_GPL(gsm_free_mux);
2091
2092/**
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002093 * gsm_free_muxr - free up a mux
2094 * @mux: mux to free
2095 *
2096 * Dispose of allocated resources for a dead mux
2097 */
2098static void gsm_free_muxr(struct kref *ref)
2099{
2100 struct gsm_mux *gsm = container_of(ref, struct gsm_mux, ref);
2101 gsm_free_mux(gsm);
2102}
2103
2104static inline void mux_get(struct gsm_mux *gsm)
2105{
2106 kref_get(&gsm->ref);
2107}
2108
2109static inline void mux_put(struct gsm_mux *gsm)
2110{
2111 kref_put(&gsm->ref, gsm_free_muxr);
2112}
2113
2114/**
Alan Coxe1eaea42010-03-26 11:32:54 +00002115 * gsm_alloc_mux - allocate a mux
2116 *
2117 * Creates a new mux ready for activation.
2118 */
2119
2120struct gsm_mux *gsm_alloc_mux(void)
2121{
2122 struct gsm_mux *gsm = kzalloc(sizeof(struct gsm_mux), GFP_KERNEL);
2123 if (gsm == NULL)
2124 return NULL;
2125 gsm->buf = kmalloc(MAX_MRU + 1, GFP_KERNEL);
2126 if (gsm->buf == NULL) {
2127 kfree(gsm);
2128 return NULL;
2129 }
2130 gsm->txframe = kmalloc(2 * MAX_MRU + 2, GFP_KERNEL);
2131 if (gsm->txframe == NULL) {
2132 kfree(gsm->buf);
2133 kfree(gsm);
2134 return NULL;
2135 }
2136 spin_lock_init(&gsm->lock);
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002137 kref_init(&gsm->ref);
Alan Coxe1eaea42010-03-26 11:32:54 +00002138
2139 gsm->t1 = T1;
2140 gsm->t2 = T2;
2141 gsm->n2 = N2;
2142 gsm->ftype = UIH;
Alan Coxe1eaea42010-03-26 11:32:54 +00002143 gsm->adaption = 1;
2144 gsm->encoding = 1;
2145 gsm->mru = 64; /* Default to encoding 1 so these should be 64 */
2146 gsm->mtu = 64;
2147 gsm->dead = 1; /* Avoid early tty opens */
2148
2149 return gsm;
2150}
2151EXPORT_SYMBOL_GPL(gsm_alloc_mux);
2152
Alan Coxe1eaea42010-03-26 11:32:54 +00002153/**
2154 * gsmld_output - write to link
2155 * @gsm: our mux
2156 * @data: bytes to output
2157 * @len: size
2158 *
2159 * Write a block of data from the GSM mux to the data channel. This
2160 * will eventually be serialized from above but at the moment isn't.
2161 */
2162
2163static int gsmld_output(struct gsm_mux *gsm, u8 *data, int len)
2164{
2165 if (tty_write_room(gsm->tty) < len) {
2166 set_bit(TTY_DO_WRITE_WAKEUP, &gsm->tty->flags);
2167 return -ENOSPC;
2168 }
Joe Perches0a77c4f2011-04-25 16:46:49 -07002169 if (debug & 4)
2170 print_hex_dump_bytes("gsmld_output: ", DUMP_PREFIX_OFFSET,
2171 data, len);
Alan Coxe1eaea42010-03-26 11:32:54 +00002172 gsm->tty->ops->write(gsm->tty, data, len);
2173 return len;
2174}
2175
2176/**
2177 * gsmld_attach_gsm - mode set up
2178 * @tty: our tty structure
2179 * @gsm: our mux
2180 *
2181 * Set up the MUX for basic mode and commence connecting to the
2182 * modem. Currently called from the line discipline set up but
2183 * will need moving to an ioctl path.
2184 */
2185
2186static int gsmld_attach_gsm(struct tty_struct *tty, struct gsm_mux *gsm)
2187{
Russ Gorbyd50f6dc2011-06-14 13:35:32 -07002188 int ret, i;
2189 int base = gsm->num << 6; /* Base for this MUX */
Alan Coxe1eaea42010-03-26 11:32:54 +00002190
2191 gsm->tty = tty_kref_get(tty);
2192 gsm->output = gsmld_output;
2193 ret = gsm_activate_mux(gsm);
2194 if (ret != 0)
2195 tty_kref_put(gsm->tty);
Russ Gorbyd50f6dc2011-06-14 13:35:32 -07002196 else {
2197 /* Don't register device 0 - this is the control channel and not
2198 a usable tty interface */
2199 for (i = 1; i < NUM_DLCI; i++)
2200 tty_register_device(gsm_tty_driver, base + i, NULL);
2201 }
Alan Coxe1eaea42010-03-26 11:32:54 +00002202 return ret;
2203}
2204
2205
2206/**
2207 * gsmld_detach_gsm - stop doing 0710 mux
Justin P. Mattock70f23fd2011-05-10 10:16:21 +02002208 * @tty: tty attached to the mux
Alan Coxe1eaea42010-03-26 11:32:54 +00002209 * @gsm: mux
2210 *
2211 * Shutdown and then clean up the resources used by the line discipline
2212 */
2213
2214static void gsmld_detach_gsm(struct tty_struct *tty, struct gsm_mux *gsm)
2215{
Russ Gorbyd50f6dc2011-06-14 13:35:32 -07002216 int i;
2217 int base = gsm->num << 6; /* Base for this MUX */
2218
Alan Coxe1eaea42010-03-26 11:32:54 +00002219 WARN_ON(tty != gsm->tty);
Russ Gorbyd50f6dc2011-06-14 13:35:32 -07002220 for (i = 1; i < NUM_DLCI; i++)
2221 tty_unregister_device(gsm_tty_driver, base + i);
Alan Coxe1eaea42010-03-26 11:32:54 +00002222 gsm_cleanup_mux(gsm);
2223 tty_kref_put(gsm->tty);
2224 gsm->tty = NULL;
2225}
2226
Linus Torvalds55db4c62011-06-04 06:33:24 +09002227static void gsmld_receive_buf(struct tty_struct *tty, const unsigned char *cp,
2228 char *fp, int count)
Alan Coxe1eaea42010-03-26 11:32:54 +00002229{
2230 struct gsm_mux *gsm = tty->disc_data;
2231 const unsigned char *dp;
2232 char *f;
2233 int i;
2234 char buf[64];
2235 char flags;
2236
Joe Perches0a77c4f2011-04-25 16:46:49 -07002237 if (debug & 4)
2238 print_hex_dump_bytes("gsmld_receive: ", DUMP_PREFIX_OFFSET,
2239 cp, count);
Alan Coxe1eaea42010-03-26 11:32:54 +00002240
2241 for (i = count, dp = cp, f = fp; i; i--, dp++) {
2242 flags = *f++;
2243 switch (flags) {
2244 case TTY_NORMAL:
2245 gsm->receive(gsm, *dp);
2246 break;
2247 case TTY_OVERRUN:
2248 case TTY_BREAK:
2249 case TTY_PARITY:
2250 case TTY_FRAME:
2251 gsm->error(gsm, *dp, flags);
2252 break;
2253 default:
Alan Cox5f9a31d2010-11-04 15:17:27 +00002254 WARN_ONCE("%s: unknown flag %d\n",
Alan Coxe1eaea42010-03-26 11:32:54 +00002255 tty_name(tty, buf), flags);
2256 break;
2257 }
2258 }
2259 /* FASYNC if needed ? */
2260 /* If clogged call tty_throttle(tty); */
2261}
2262
2263/**
2264 * gsmld_chars_in_buffer - report available bytes
2265 * @tty: tty device
2266 *
2267 * Report the number of characters buffered to be delivered to user
2268 * at this instant in time.
2269 *
2270 * Locking: gsm lock
2271 */
2272
2273static ssize_t gsmld_chars_in_buffer(struct tty_struct *tty)
2274{
2275 return 0;
2276}
2277
2278/**
2279 * gsmld_flush_buffer - clean input queue
2280 * @tty: terminal device
2281 *
2282 * Flush the input buffer. Called when the line discipline is
2283 * being closed, when the tty layer wants the buffer flushed (eg
2284 * at hangup).
2285 */
2286
2287static void gsmld_flush_buffer(struct tty_struct *tty)
2288{
2289}
2290
2291/**
2292 * gsmld_close - close the ldisc for this tty
2293 * @tty: device
2294 *
2295 * Called from the terminal layer when this line discipline is
2296 * being shut down, either because of a close or becsuse of a
2297 * discipline change. The function will not be called while other
2298 * ldisc methods are in progress.
2299 */
2300
2301static void gsmld_close(struct tty_struct *tty)
2302{
2303 struct gsm_mux *gsm = tty->disc_data;
2304
2305 gsmld_detach_gsm(tty, gsm);
2306
2307 gsmld_flush_buffer(tty);
2308 /* Do other clean up here */
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002309 mux_put(gsm);
Alan Coxe1eaea42010-03-26 11:32:54 +00002310}
2311
2312/**
2313 * gsmld_open - open an ldisc
2314 * @tty: terminal to open
2315 *
2316 * Called when this line discipline is being attached to the
2317 * terminal device. Can sleep. Called serialized so that no
2318 * other events will occur in parallel. No further open will occur
2319 * until a close.
2320 */
2321
2322static int gsmld_open(struct tty_struct *tty)
2323{
2324 struct gsm_mux *gsm;
2325
2326 if (tty->ops->write == NULL)
2327 return -EINVAL;
2328
2329 /* Attach our ldisc data */
2330 gsm = gsm_alloc_mux();
2331 if (gsm == NULL)
2332 return -ENOMEM;
2333
2334 tty->disc_data = gsm;
2335 tty->receive_room = 65536;
2336
2337 /* Attach the initial passive connection */
2338 gsm->encoding = 1;
2339 return gsmld_attach_gsm(tty, gsm);
2340}
2341
2342/**
2343 * gsmld_write_wakeup - asynchronous I/O notifier
2344 * @tty: tty device
2345 *
2346 * Required for the ptys, serial driver etc. since processes
2347 * that attach themselves to the master and rely on ASYNC
2348 * IO must be woken up
2349 */
2350
2351static void gsmld_write_wakeup(struct tty_struct *tty)
2352{
2353 struct gsm_mux *gsm = tty->disc_data;
Dan Carpenter328be392010-05-25 11:37:17 +02002354 unsigned long flags;
Alan Coxe1eaea42010-03-26 11:32:54 +00002355
2356 /* Queue poll */
2357 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2358 gsm_data_kick(gsm);
Dan Carpenter328be392010-05-25 11:37:17 +02002359 if (gsm->tx_bytes < TX_THRESH_LO) {
2360 spin_lock_irqsave(&gsm->tx_lock, flags);
Alan Coxe1eaea42010-03-26 11:32:54 +00002361 gsm_dlci_data_sweep(gsm);
Dan Carpenter328be392010-05-25 11:37:17 +02002362 spin_unlock_irqrestore(&gsm->tx_lock, flags);
2363 }
Alan Coxe1eaea42010-03-26 11:32:54 +00002364}
2365
2366/**
2367 * gsmld_read - read function for tty
2368 * @tty: tty device
2369 * @file: file object
2370 * @buf: userspace buffer pointer
2371 * @nr: size of I/O
2372 *
2373 * Perform reads for the line discipline. We are guaranteed that the
2374 * line discipline will not be closed under us but we may get multiple
2375 * parallel readers and must handle this ourselves. We may also get
2376 * a hangup. Always called in user context, may sleep.
2377 *
2378 * This code must be sure never to sleep through a hangup.
2379 */
2380
2381static ssize_t gsmld_read(struct tty_struct *tty, struct file *file,
2382 unsigned char __user *buf, size_t nr)
2383{
2384 return -EOPNOTSUPP;
2385}
2386
2387/**
2388 * gsmld_write - write function for tty
2389 * @tty: tty device
2390 * @file: file object
2391 * @buf: userspace buffer pointer
2392 * @nr: size of I/O
2393 *
2394 * Called when the owner of the device wants to send a frame
2395 * itself (or some other control data). The data is transferred
2396 * as-is and must be properly framed and checksummed as appropriate
2397 * by userspace. Frames are either sent whole or not at all as this
2398 * avoids pain user side.
2399 */
2400
2401static ssize_t gsmld_write(struct tty_struct *tty, struct file *file,
2402 const unsigned char *buf, size_t nr)
2403{
2404 int space = tty_write_room(tty);
2405 if (space >= nr)
2406 return tty->ops->write(tty, buf, nr);
2407 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2408 return -ENOBUFS;
2409}
2410
2411/**
2412 * gsmld_poll - poll method for N_GSM0710
2413 * @tty: terminal device
2414 * @file: file accessing it
2415 * @wait: poll table
2416 *
2417 * Called when the line discipline is asked to poll() for data or
2418 * for special events. This code is not serialized with respect to
2419 * other events save open/close.
2420 *
2421 * This code must be sure never to sleep through a hangup.
2422 * Called without the kernel lock held - fine
2423 */
2424
2425static unsigned int gsmld_poll(struct tty_struct *tty, struct file *file,
2426 poll_table *wait)
2427{
2428 unsigned int mask = 0;
2429 struct gsm_mux *gsm = tty->disc_data;
2430
2431 poll_wait(file, &tty->read_wait, wait);
2432 poll_wait(file, &tty->write_wait, wait);
2433 if (tty_hung_up_p(file))
2434 mask |= POLLHUP;
2435 if (!tty_is_writelocked(tty) && tty_write_room(tty) > 0)
2436 mask |= POLLOUT | POLLWRNORM;
2437 if (gsm->dead)
2438 mask |= POLLHUP;
2439 return mask;
2440}
2441
2442static int gsmld_config(struct tty_struct *tty, struct gsm_mux *gsm,
2443 struct gsm_config *c)
2444{
2445 int need_close = 0;
2446 int need_restart = 0;
2447
2448 /* Stuff we don't support yet - UI or I frame transport, windowing */
Alan Cox5f9a31d2010-11-04 15:17:27 +00002449 if ((c->adaption != 1 && c->adaption != 2) || c->k)
Alan Coxe1eaea42010-03-26 11:32:54 +00002450 return -EOPNOTSUPP;
2451 /* Check the MRU/MTU range looks sane */
2452 if (c->mru > MAX_MRU || c->mtu > MAX_MTU || c->mru < 8 || c->mtu < 8)
2453 return -EINVAL;
2454 if (c->n2 < 3)
2455 return -EINVAL;
2456 if (c->encapsulation > 1) /* Basic, advanced, no I */
2457 return -EINVAL;
2458 if (c->initiator > 1)
2459 return -EINVAL;
2460 if (c->i == 0 || c->i > 2) /* UIH and UI only */
2461 return -EINVAL;
2462 /*
2463 * See what is needed for reconfiguration
2464 */
2465
2466 /* Timing fields */
2467 if (c->t1 != 0 && c->t1 != gsm->t1)
2468 need_restart = 1;
2469 if (c->t2 != 0 && c->t2 != gsm->t2)
2470 need_restart = 1;
2471 if (c->encapsulation != gsm->encoding)
2472 need_restart = 1;
2473 if (c->adaption != gsm->adaption)
2474 need_restart = 1;
2475 /* Requires care */
2476 if (c->initiator != gsm->initiator)
2477 need_close = 1;
2478 if (c->mru != gsm->mru)
2479 need_restart = 1;
2480 if (c->mtu != gsm->mtu)
2481 need_restart = 1;
2482
2483 /*
2484 * Close down what is needed, restart and initiate the new
2485 * configuration
2486 */
2487
2488 if (need_close || need_restart) {
2489 gsm_dlci_begin_close(gsm->dlci[0]);
2490 /* This will timeout if the link is down due to N2 expiring */
2491 wait_event_interruptible(gsm->event,
2492 gsm->dlci[0]->state == DLCI_CLOSED);
2493 if (signal_pending(current))
2494 return -EINTR;
2495 }
2496 if (need_restart)
2497 gsm_cleanup_mux(gsm);
2498
2499 gsm->initiator = c->initiator;
2500 gsm->mru = c->mru;
Ken Mills91f78f32011-01-25 14:17:45 +00002501 gsm->mtu = c->mtu;
Alan Coxe1eaea42010-03-26 11:32:54 +00002502 gsm->encoding = c->encapsulation;
2503 gsm->adaption = c->adaption;
Ken Mills820e62e2010-11-04 15:16:24 +00002504 gsm->n2 = c->n2;
Alan Coxe1eaea42010-03-26 11:32:54 +00002505
2506 if (c->i == 1)
2507 gsm->ftype = UIH;
2508 else if (c->i == 2)
2509 gsm->ftype = UI;
2510
2511 if (c->t1)
2512 gsm->t1 = c->t1;
2513 if (c->t2)
2514 gsm->t2 = c->t2;
2515
2516 /* FIXME: We need to separate activation/deactivation from adding
2517 and removing from the mux array */
2518 if (need_restart)
2519 gsm_activate_mux(gsm);
2520 if (gsm->initiator && need_close)
2521 gsm_dlci_begin_open(gsm->dlci[0]);
2522 return 0;
2523}
2524
2525static int gsmld_ioctl(struct tty_struct *tty, struct file *file,
2526 unsigned int cmd, unsigned long arg)
2527{
2528 struct gsm_config c;
2529 struct gsm_mux *gsm = tty->disc_data;
2530
2531 switch (cmd) {
2532 case GSMIOC_GETCONF:
2533 memset(&c, 0, sizeof(c));
2534 c.adaption = gsm->adaption;
2535 c.encapsulation = gsm->encoding;
2536 c.initiator = gsm->initiator;
2537 c.t1 = gsm->t1;
2538 c.t2 = gsm->t2;
2539 c.t3 = 0; /* Not supported */
2540 c.n2 = gsm->n2;
2541 if (gsm->ftype == UIH)
2542 c.i = 1;
2543 else
2544 c.i = 2;
Alan Cox5f9a31d2010-11-04 15:17:27 +00002545 pr_debug("Ftype %d i %d\n", gsm->ftype, c.i);
Alan Coxe1eaea42010-03-26 11:32:54 +00002546 c.mru = gsm->mru;
2547 c.mtu = gsm->mtu;
2548 c.k = 0;
2549 if (copy_to_user((void *)arg, &c, sizeof(c)))
2550 return -EFAULT;
2551 return 0;
2552 case GSMIOC_SETCONF:
2553 if (copy_from_user(&c, (void *)arg, sizeof(c)))
2554 return -EFAULT;
2555 return gsmld_config(tty, gsm, &c);
2556 default:
2557 return n_tty_ioctl_helper(tty, file, cmd, arg);
2558 }
2559}
2560
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002561/*
2562 * Network interface
2563 *
2564 */
2565
2566static int gsm_mux_net_open(struct net_device *net)
2567{
2568 pr_debug("%s called\n", __func__);
2569 netif_start_queue(net);
2570 return 0;
2571}
2572
2573static int gsm_mux_net_close(struct net_device *net)
2574{
2575 netif_stop_queue(net);
2576 return 0;
2577}
2578
2579static struct net_device_stats *gsm_mux_net_get_stats(struct net_device *net)
2580{
2581 return &((struct gsm_mux_net *)netdev_priv(net))->stats;
2582}
2583static void dlci_net_free(struct gsm_dlci *dlci)
2584{
2585 if (!dlci->net) {
2586 WARN_ON(1);
2587 return;
2588 }
2589 dlci->adaption = dlci->prev_adaption;
2590 dlci->data = dlci->prev_data;
2591 free_netdev(dlci->net);
2592 dlci->net = NULL;
2593}
2594static void net_free(struct kref *ref)
2595{
2596 struct gsm_mux_net *mux_net;
2597 struct gsm_dlci *dlci;
2598
2599 mux_net = container_of(ref, struct gsm_mux_net, ref);
2600 dlci = mux_net->dlci;
2601
2602 if (dlci->net) {
2603 unregister_netdev(dlci->net);
2604 dlci_net_free(dlci);
2605 }
2606}
2607
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002608static inline void muxnet_get(struct gsm_mux_net *mux_net)
2609{
2610 kref_get(&mux_net->ref);
2611}
2612
2613static inline void muxnet_put(struct gsm_mux_net *mux_net)
2614{
2615 kref_put(&mux_net->ref, net_free);
2616}
2617
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002618static int gsm_mux_net_start_xmit(struct sk_buff *skb,
2619 struct net_device *net)
2620{
2621 struct gsm_mux_net *mux_net = (struct gsm_mux_net *)netdev_priv(net);
2622 struct gsm_dlci *dlci = mux_net->dlci;
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002623 muxnet_get(mux_net);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002624
2625 skb_queue_head(&dlci->skb_list, skb);
2626 STATS(net).tx_packets++;
2627 STATS(net).tx_bytes += skb->len;
2628 gsm_dlci_data_kick(dlci);
2629 /* And tell the kernel when the last transmit started. */
2630 net->trans_start = jiffies;
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002631 muxnet_put(mux_net);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002632 return NETDEV_TX_OK;
2633}
2634
2635/* called when a packet did not ack after watchdogtimeout */
2636static void gsm_mux_net_tx_timeout(struct net_device *net)
2637{
2638 /* Tell syslog we are hosed. */
2639 dev_dbg(&net->dev, "Tx timed out.\n");
2640
2641 /* Update statistics */
2642 STATS(net).tx_errors++;
2643}
2644
2645static void gsm_mux_rx_netchar(struct gsm_dlci *dlci,
2646 unsigned char *in_buf, int size)
2647{
2648 struct net_device *net = dlci->net;
2649 struct sk_buff *skb;
2650 struct gsm_mux_net *mux_net = (struct gsm_mux_net *)netdev_priv(net);
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002651 muxnet_get(mux_net);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002652
2653 /* Allocate an sk_buff */
2654 skb = dev_alloc_skb(size + NET_IP_ALIGN);
2655 if (!skb) {
2656 /* We got no receive buffer. */
2657 STATS(net).rx_dropped++;
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002658 muxnet_put(mux_net);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002659 return;
2660 }
2661 skb_reserve(skb, NET_IP_ALIGN);
2662 memcpy(skb_put(skb, size), in_buf, size);
2663
2664 skb->dev = net;
2665 skb->protocol = __constant_htons(ETH_P_IP);
2666
2667 /* Ship it off to the kernel */
2668 netif_rx(skb);
2669
2670 /* update out statistics */
2671 STATS(net).rx_packets++;
2672 STATS(net).rx_bytes += size;
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002673 muxnet_put(mux_net);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002674 return;
2675}
2676
2677int gsm_change_mtu(struct net_device *net, int new_mtu)
2678{
2679 struct gsm_mux_net *mux_net = (struct gsm_mux_net *)netdev_priv(net);
2680 if ((new_mtu < 8) || (new_mtu > mux_net->dlci->gsm->mtu))
2681 return -EINVAL;
2682 net->mtu = new_mtu;
2683 return 0;
2684}
2685
2686static void gsm_mux_net_init(struct net_device *net)
2687{
2688 static const struct net_device_ops gsm_netdev_ops = {
2689 .ndo_open = gsm_mux_net_open,
2690 .ndo_stop = gsm_mux_net_close,
2691 .ndo_start_xmit = gsm_mux_net_start_xmit,
2692 .ndo_tx_timeout = gsm_mux_net_tx_timeout,
2693 .ndo_get_stats = gsm_mux_net_get_stats,
2694 .ndo_change_mtu = gsm_change_mtu,
2695 };
2696
2697 net->netdev_ops = &gsm_netdev_ops;
2698
2699 /* fill in the other fields */
2700 net->watchdog_timeo = GSM_NET_TX_TIMEOUT;
2701 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2702 net->type = ARPHRD_NONE;
2703 net->tx_queue_len = 10;
2704}
2705
2706
2707/* caller holds the dlci mutex */
2708static void gsm_destroy_network(struct gsm_dlci *dlci)
2709{
2710 struct gsm_mux_net *mux_net;
2711
2712 pr_debug("destroy network interface");
2713 if (!dlci->net)
2714 return;
2715 mux_net = (struct gsm_mux_net *)netdev_priv(dlci->net);
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002716 muxnet_put(mux_net);
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002717}
2718
2719
2720/* caller holds the dlci mutex */
2721static int gsm_create_network(struct gsm_dlci *dlci, struct gsm_netconfig *nc)
2722{
2723 char *netname;
2724 int retval = 0;
2725 struct net_device *net;
2726 struct gsm_mux_net *mux_net;
2727
2728 if (!capable(CAP_NET_ADMIN))
2729 return -EPERM;
2730
2731 /* Already in a non tty mode */
2732 if (dlci->adaption > 2)
2733 return -EBUSY;
2734
2735 if (nc->protocol != htons(ETH_P_IP))
2736 return -EPROTONOSUPPORT;
2737
2738 if (nc->adaption != 3 && nc->adaption != 4)
2739 return -EPROTONOSUPPORT;
2740
2741 pr_debug("create network interface");
2742
2743 netname = "gsm%d";
2744 if (nc->if_name[0] != '\0')
2745 netname = nc->if_name;
2746 net = alloc_netdev(sizeof(struct gsm_mux_net),
2747 netname,
2748 gsm_mux_net_init);
2749 if (!net) {
2750 pr_err("alloc_netdev failed");
2751 return -ENOMEM;
2752 }
2753 net->mtu = dlci->gsm->mtu;
2754 mux_net = (struct gsm_mux_net *)netdev_priv(net);
2755 mux_net->dlci = dlci;
2756 kref_init(&mux_net->ref);
2757 strncpy(nc->if_name, net->name, IFNAMSIZ); /* return net name */
2758
2759 /* reconfigure dlci for network */
2760 dlci->prev_adaption = dlci->adaption;
2761 dlci->prev_data = dlci->data;
2762 dlci->adaption = nc->adaption;
2763 dlci->data = gsm_mux_rx_netchar;
2764 dlci->net = net;
2765
2766 pr_debug("register netdev");
2767 retval = register_netdev(net);
2768 if (retval) {
2769 pr_err("network register fail %d\n", retval);
2770 dlci_net_free(dlci);
2771 return retval;
2772 }
2773 return net->ifindex; /* return network index */
2774}
Alan Coxe1eaea42010-03-26 11:32:54 +00002775
2776/* Line discipline for real tty */
2777struct tty_ldisc_ops tty_ldisc_packet = {
2778 .owner = THIS_MODULE,
2779 .magic = TTY_LDISC_MAGIC,
2780 .name = "n_gsm",
2781 .open = gsmld_open,
2782 .close = gsmld_close,
2783 .flush_buffer = gsmld_flush_buffer,
2784 .chars_in_buffer = gsmld_chars_in_buffer,
2785 .read = gsmld_read,
2786 .write = gsmld_write,
2787 .ioctl = gsmld_ioctl,
2788 .poll = gsmld_poll,
2789 .receive_buf = gsmld_receive_buf,
2790 .write_wakeup = gsmld_write_wakeup
2791};
2792
2793/*
2794 * Virtual tty side
2795 */
2796
2797#define TX_SIZE 512
2798
2799static int gsmtty_modem_update(struct gsm_dlci *dlci, u8 brk)
2800{
2801 u8 modembits[5];
2802 struct gsm_control *ctrl;
2803 int len = 2;
2804
2805 if (brk)
2806 len++;
2807
2808 modembits[0] = len << 1 | EA; /* Data bytes */
2809 modembits[1] = dlci->addr << 2 | 3; /* DLCI, EA, 1 */
2810 modembits[2] = gsm_encode_modem(dlci) << 1 | EA;
2811 if (brk)
2812 modembits[3] = brk << 4 | 2 | EA; /* Valid, EA */
2813 ctrl = gsm_control_send(dlci->gsm, CMD_MSC, modembits, len + 1);
2814 if (ctrl == NULL)
2815 return -ENOMEM;
2816 return gsm_control_wait(dlci->gsm, ctrl);
2817}
2818
2819static int gsm_carrier_raised(struct tty_port *port)
2820{
2821 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
2822 /* Not yet open so no carrier info */
2823 if (dlci->state != DLCI_OPEN)
2824 return 0;
2825 if (debug & 2)
2826 return 1;
2827 return dlci->modem_rx & TIOCM_CD;
2828}
2829
2830static void gsm_dtr_rts(struct tty_port *port, int onoff)
2831{
2832 struct gsm_dlci *dlci = container_of(port, struct gsm_dlci, port);
2833 unsigned int modem_tx = dlci->modem_tx;
2834 if (onoff)
2835 modem_tx |= TIOCM_DTR | TIOCM_RTS;
2836 else
2837 modem_tx &= ~(TIOCM_DTR | TIOCM_RTS);
2838 if (modem_tx != dlci->modem_tx) {
2839 dlci->modem_tx = modem_tx;
2840 gsmtty_modem_update(dlci, 0);
2841 }
2842}
2843
2844static const struct tty_port_operations gsm_port_ops = {
2845 .carrier_raised = gsm_carrier_raised,
2846 .dtr_rts = gsm_dtr_rts,
2847};
2848
2849
2850static int gsmtty_open(struct tty_struct *tty, struct file *filp)
2851{
2852 struct gsm_mux *gsm;
2853 struct gsm_dlci *dlci;
2854 struct tty_port *port;
2855 unsigned int line = tty->index;
2856 unsigned int mux = line >> 6;
2857
2858 line = line & 0x3F;
2859
2860 if (mux >= MAX_MUX)
2861 return -ENXIO;
2862 /* FIXME: we need to lock gsm_mux for lifetimes of ttys eventually */
2863 if (gsm_mux[mux] == NULL)
2864 return -EUNATCH;
2865 if (line == 0 || line > 61) /* 62/63 reserved */
2866 return -ECHRNG;
2867 gsm = gsm_mux[mux];
2868 if (gsm->dead)
2869 return -EL2HLT;
2870 dlci = gsm->dlci[line];
2871 if (dlci == NULL)
2872 dlci = gsm_dlci_alloc(gsm, line);
2873 if (dlci == NULL)
2874 return -ENOMEM;
2875 port = &dlci->port;
2876 port->count++;
2877 tty->driver_data = dlci;
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002878 dlci_get(dlci);
2879 dlci_get(dlci->gsm->dlci[0]);
2880 mux_get(dlci->gsm);
Alan Coxe1eaea42010-03-26 11:32:54 +00002881 tty_port_tty_set(port, tty);
2882
2883 dlci->modem_rx = 0;
2884 /* We could in theory open and close before we wait - eg if we get
2885 a DM straight back. This is ok as that will have caused a hangup */
2886 set_bit(ASYNCB_INITIALIZED, &port->flags);
2887 /* Start sending off SABM messages */
2888 gsm_dlci_begin_open(dlci);
2889 /* And wait for virtual carrier */
2890 return tty_port_block_til_ready(port, tty, filp);
2891}
2892
2893static void gsmtty_close(struct tty_struct *tty, struct file *filp)
2894{
2895 struct gsm_dlci *dlci = tty->driver_data;
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002896 struct gsm_mux *gsm;
2897
Alan Coxe1eaea42010-03-26 11:32:54 +00002898 if (dlci == NULL)
2899 return;
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002900 mutex_lock(&dlci->mutex);
2901 gsm_destroy_network(dlci);
2902 mutex_unlock(&dlci->mutex);
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002903 gsm = dlci->gsm;
Alan Coxe1eaea42010-03-26 11:32:54 +00002904 if (tty_port_close_start(&dlci->port, tty, filp) == 0)
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002905 goto out;
Alan Coxe1eaea42010-03-26 11:32:54 +00002906 gsm_dlci_begin_close(dlci);
2907 tty_port_close_end(&dlci->port, tty);
2908 tty_port_tty_set(&dlci->port, NULL);
Russ Gorby6ab8fba2011-06-16 14:20:13 -07002909out:
2910 dlci_put(dlci);
2911 dlci_put(gsm->dlci[0]);
2912 mux_put(gsm);
Alan Coxe1eaea42010-03-26 11:32:54 +00002913}
2914
2915static void gsmtty_hangup(struct tty_struct *tty)
2916{
2917 struct gsm_dlci *dlci = tty->driver_data;
2918 tty_port_hangup(&dlci->port);
2919 gsm_dlci_begin_close(dlci);
2920}
2921
2922static int gsmtty_write(struct tty_struct *tty, const unsigned char *buf,
2923 int len)
2924{
2925 struct gsm_dlci *dlci = tty->driver_data;
2926 /* Stuff the bytes into the fifo queue */
2927 int sent = kfifo_in_locked(dlci->fifo, buf, len, &dlci->lock);
2928 /* Need to kick the channel */
2929 gsm_dlci_data_kick(dlci);
2930 return sent;
2931}
2932
2933static int gsmtty_write_room(struct tty_struct *tty)
2934{
2935 struct gsm_dlci *dlci = tty->driver_data;
2936 return TX_SIZE - kfifo_len(dlci->fifo);
2937}
2938
2939static int gsmtty_chars_in_buffer(struct tty_struct *tty)
2940{
2941 struct gsm_dlci *dlci = tty->driver_data;
2942 return kfifo_len(dlci->fifo);
2943}
2944
2945static void gsmtty_flush_buffer(struct tty_struct *tty)
2946{
2947 struct gsm_dlci *dlci = tty->driver_data;
2948 /* Caution needed: If we implement reliable transport classes
2949 then the data being transmitted can't simply be junked once
2950 it has first hit the stack. Until then we can just blow it
2951 away */
2952 kfifo_reset(dlci->fifo);
2953 /* Need to unhook this DLCI from the transmit queue logic */
2954}
2955
2956static void gsmtty_wait_until_sent(struct tty_struct *tty, int timeout)
2957{
2958 /* The FIFO handles the queue so the kernel will do the right
2959 thing waiting on chars_in_buffer before calling us. No work
2960 to do here */
2961}
2962
Alan Cox60b33c12011-02-14 16:26:14 +00002963static int gsmtty_tiocmget(struct tty_struct *tty)
Alan Coxe1eaea42010-03-26 11:32:54 +00002964{
2965 struct gsm_dlci *dlci = tty->driver_data;
2966 return dlci->modem_rx;
2967}
2968
Alan Cox20b9d172011-02-14 16:26:50 +00002969static int gsmtty_tiocmset(struct tty_struct *tty,
Alan Coxe1eaea42010-03-26 11:32:54 +00002970 unsigned int set, unsigned int clear)
2971{
2972 struct gsm_dlci *dlci = tty->driver_data;
2973 unsigned int modem_tx = dlci->modem_tx;
2974
2975 modem_tx &= clear;
2976 modem_tx |= set;
2977
2978 if (modem_tx != dlci->modem_tx) {
2979 dlci->modem_tx = modem_tx;
2980 return gsmtty_modem_update(dlci, 0);
2981 }
2982 return 0;
2983}
2984
2985
Alan Cox6caa76b2011-02-14 16:27:22 +00002986static int gsmtty_ioctl(struct tty_struct *tty,
Alan Coxe1eaea42010-03-26 11:32:54 +00002987 unsigned int cmd, unsigned long arg)
2988{
Russ Gorbybcd5abe2011-06-16 14:20:12 -07002989 struct gsm_dlci *dlci = tty->driver_data;
2990 struct gsm_netconfig nc;
2991 int index;
2992
2993 switch (cmd) {
2994 case GSMIOC_ENABLE_NET:
2995 if (copy_from_user(&nc, (void __user *)arg, sizeof(nc)))
2996 return -EFAULT;
2997 nc.if_name[IFNAMSIZ-1] = '\0';
2998 /* return net interface index or error code */
2999 mutex_lock(&dlci->mutex);
3000 index = gsm_create_network(dlci, &nc);
3001 mutex_unlock(&dlci->mutex);
3002 if (copy_to_user((void __user *)arg, &nc, sizeof(nc)))
3003 return -EFAULT;
3004 return index;
3005 case GSMIOC_DISABLE_NET:
3006 if (!capable(CAP_NET_ADMIN))
3007 return -EPERM;
3008 mutex_lock(&dlci->mutex);
3009 gsm_destroy_network(dlci);
3010 mutex_unlock(&dlci->mutex);
3011 return 0;
3012 default:
3013 return -ENOIOCTLCMD;
3014 }
Alan Coxe1eaea42010-03-26 11:32:54 +00003015}
3016
3017static void gsmtty_set_termios(struct tty_struct *tty, struct ktermios *old)
3018{
3019 /* For the moment its fixed. In actual fact the speed information
3020 for the virtual channel can be propogated in both directions by
3021 the RPN control message. This however rapidly gets nasty as we
3022 then have to remap modem signals each way according to whether
3023 our virtual cable is null modem etc .. */
3024 tty_termios_copy_hw(tty->termios, old);
3025}
3026
3027static void gsmtty_throttle(struct tty_struct *tty)
3028{
3029 struct gsm_dlci *dlci = tty->driver_data;
3030 if (tty->termios->c_cflag & CRTSCTS)
3031 dlci->modem_tx &= ~TIOCM_DTR;
3032 dlci->throttled = 1;
3033 /* Send an MSC with DTR cleared */
3034 gsmtty_modem_update(dlci, 0);
3035}
3036
3037static void gsmtty_unthrottle(struct tty_struct *tty)
3038{
3039 struct gsm_dlci *dlci = tty->driver_data;
3040 if (tty->termios->c_cflag & CRTSCTS)
3041 dlci->modem_tx |= TIOCM_DTR;
3042 dlci->throttled = 0;
3043 /* Send an MSC with DTR set */
3044 gsmtty_modem_update(dlci, 0);
3045}
3046
3047static int gsmtty_break_ctl(struct tty_struct *tty, int state)
3048{
3049 struct gsm_dlci *dlci = tty->driver_data;
3050 int encode = 0; /* Off */
3051
3052 if (state == -1) /* "On indefinitely" - we can't encode this
3053 properly */
3054 encode = 0x0F;
3055 else if (state > 0) {
3056 encode = state / 200; /* mS to encoding */
3057 if (encode > 0x0F)
3058 encode = 0x0F; /* Best effort */
3059 }
3060 return gsmtty_modem_update(dlci, encode);
3061}
3062
Alan Coxe1eaea42010-03-26 11:32:54 +00003063
3064/* Virtual ttys for the demux */
3065static const struct tty_operations gsmtty_ops = {
3066 .open = gsmtty_open,
3067 .close = gsmtty_close,
3068 .write = gsmtty_write,
3069 .write_room = gsmtty_write_room,
3070 .chars_in_buffer = gsmtty_chars_in_buffer,
3071 .flush_buffer = gsmtty_flush_buffer,
3072 .ioctl = gsmtty_ioctl,
3073 .throttle = gsmtty_throttle,
3074 .unthrottle = gsmtty_unthrottle,
3075 .set_termios = gsmtty_set_termios,
3076 .hangup = gsmtty_hangup,
3077 .wait_until_sent = gsmtty_wait_until_sent,
3078 .tiocmget = gsmtty_tiocmget,
3079 .tiocmset = gsmtty_tiocmset,
3080 .break_ctl = gsmtty_break_ctl,
3081};
3082
3083
3084
3085static int __init gsm_init(void)
3086{
3087 /* Fill in our line protocol discipline, and register it */
3088 int status = tty_register_ldisc(N_GSM0710, &tty_ldisc_packet);
3089 if (status != 0) {
Alan Cox5f9a31d2010-11-04 15:17:27 +00003090 pr_err("n_gsm: can't register line discipline (err = %d)\n",
3091 status);
Alan Coxe1eaea42010-03-26 11:32:54 +00003092 return status;
3093 }
3094
3095 gsm_tty_driver = alloc_tty_driver(256);
3096 if (!gsm_tty_driver) {
3097 tty_unregister_ldisc(N_GSM0710);
Alan Cox5f9a31d2010-11-04 15:17:27 +00003098 pr_err("gsm_init: tty allocation failed.\n");
Alan Coxe1eaea42010-03-26 11:32:54 +00003099 return -EINVAL;
3100 }
3101 gsm_tty_driver->owner = THIS_MODULE;
3102 gsm_tty_driver->driver_name = "gsmtty";
3103 gsm_tty_driver->name = "gsmtty";
3104 gsm_tty_driver->major = 0; /* Dynamic */
3105 gsm_tty_driver->minor_start = 0;
3106 gsm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
3107 gsm_tty_driver->subtype = SERIAL_TYPE_NORMAL;
3108 gsm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV
Alan Cox5f9a31d2010-11-04 15:17:27 +00003109 | TTY_DRIVER_HARDWARE_BREAK;
Alan Coxe1eaea42010-03-26 11:32:54 +00003110 gsm_tty_driver->init_termios = tty_std_termios;
3111 /* Fixme */
3112 gsm_tty_driver->init_termios.c_lflag &= ~ECHO;
3113 tty_set_operations(gsm_tty_driver, &gsmtty_ops);
3114
3115 spin_lock_init(&gsm_mux_lock);
3116
3117 if (tty_register_driver(gsm_tty_driver)) {
3118 put_tty_driver(gsm_tty_driver);
3119 tty_unregister_ldisc(N_GSM0710);
Alan Cox5f9a31d2010-11-04 15:17:27 +00003120 pr_err("gsm_init: tty registration failed.\n");
Alan Coxe1eaea42010-03-26 11:32:54 +00003121 return -EBUSY;
3122 }
Alan Cox5f9a31d2010-11-04 15:17:27 +00003123 pr_debug("gsm_init: loaded as %d,%d.\n",
3124 gsm_tty_driver->major, gsm_tty_driver->minor_start);
Alan Coxe1eaea42010-03-26 11:32:54 +00003125 return 0;
3126}
3127
3128static void __exit gsm_exit(void)
3129{
3130 int status = tty_unregister_ldisc(N_GSM0710);
3131 if (status != 0)
Alan Cox5f9a31d2010-11-04 15:17:27 +00003132 pr_err("n_gsm: can't unregister line discipline (err = %d)\n",
3133 status);
Alan Coxe1eaea42010-03-26 11:32:54 +00003134 tty_unregister_driver(gsm_tty_driver);
3135 put_tty_driver(gsm_tty_driver);
Alan Coxe1eaea42010-03-26 11:32:54 +00003136}
3137
3138module_init(gsm_init);
3139module_exit(gsm_exit);
3140
3141
3142MODULE_LICENSE("GPL");
3143MODULE_ALIAS_LDISC(N_GSM0710);