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