Commit | Line | Data |
---|---|---|
917f5085 TS |
1 | /* |
2 | * Siemens Gigaset 307x driver | |
6fd5ea63 HL |
3 | * Common header file for all connection variants |
4 | * | |
70440cf2 | 5 | * Written by Stefan Eilers |
6fd5ea63 HL |
6 | * and Hansjoerg Lipp <hjlipp@web.de> |
7 | * | |
917f5085 TS |
8 | * ===================================================================== |
9 | * This program is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU General Public License as | |
11 | * published by the Free Software Foundation; either version 2 of | |
12 | * the License, or (at your option) any later version. | |
13 | * ===================================================================== | |
6fd5ea63 HL |
14 | */ |
15 | ||
16 | #ifndef GIGASET_H | |
17 | #define GIGASET_H | |
18 | ||
c8770dca TS |
19 | /* define global prefix for pr_ macros in linux/kernel.h */ |
20 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt | |
21 | ||
6fd5ea63 | 22 | #include <linux/kernel.h> |
76e506a7 | 23 | #include <linux/sched.h> |
6fd5ea63 HL |
24 | #include <linux/compiler.h> |
25 | #include <linux/types.h> | |
b91ecb00 | 26 | #include <linux/ctype.h> |
5a0e3ad6 | 27 | #include <linux/slab.h> |
6fd5ea63 | 28 | #include <linux/spinlock.h> |
6fd5ea63 HL |
29 | #include <linux/skbuff.h> |
30 | #include <linux/netdevice.h> | |
31 | #include <linux/ppp_defs.h> | |
32 | #include <linux/timer.h> | |
33 | #include <linux/interrupt.h> | |
34 | #include <linux/tty.h> | |
35 | #include <linux/tty_driver.h> | |
36 | #include <linux/list.h> | |
60063497 | 37 | #include <linux/atomic.h> |
6fd5ea63 | 38 | |
d9ba9c91 TS |
39 | #define GIG_VERSION {0, 5, 0, 0} |
40 | #define GIG_COMPAT {0, 4, 0, 0} | |
6fd5ea63 | 41 | |
917f5085 | 42 | #define MAX_REC_PARAMS 10 /* Max. number of params in response string */ |
63e055d1 | 43 | #define MAX_RESP_SIZE 511 /* Max. size of a response string */ |
6fd5ea63 | 44 | |
917f5085 | 45 | #define MAX_EVENTS 64 /* size of event queue */ |
6fd5ea63 HL |
46 | |
47 | #define RBUFSIZE 8192 | |
6fd5ea63 | 48 | |
ec81b5e6 | 49 | #define GIG_TICK 100 /* in milliseconds */ |
6fd5ea63 HL |
50 | |
51 | /* timeout values (unit: 1 sec) */ | |
52 | #define INIT_TIMEOUT 1 | |
53 | ||
54 | /* timeout values (unit: 0.1 sec) */ | |
55 | #define RING_TIMEOUT 3 /* for additional parameters to RING */ | |
56 | #define BAS_TIMEOUT 20 /* for response to Base USB ops */ | |
57 | #define ATRDY_TIMEOUT 3 /* for HD_READY_SEND_ATDATA */ | |
58 | ||
59 | #define BAS_RETRY 3 /* max. retries for base USB ops */ | |
60 | ||
61 | #define MAXACT 3 | |
62 | ||
6fd5ea63 HL |
63 | extern int gigaset_debuglevel; /* "needs" cast to (enum debuglevel) */ |
64 | ||
c652cbd8 | 65 | /* debug flags, combine by adding/bitwise OR */ |
73a88814 | 66 | enum debuglevel { |
c652cbd8 | 67 | DEBUG_INTR = 0x00008, /* interrupt processing */ |
6fd5ea63 HL |
68 | DEBUG_CMD = 0x00020, /* sent/received LL commands */ |
69 | DEBUG_STREAM = 0x00040, /* application data stream I/O events */ | |
70 | DEBUG_STREAM_DUMP = 0x00080, /* application data stream content */ | |
71 | DEBUG_LLDATA = 0x00100, /* sent/received LL data */ | |
1528b18f | 72 | DEBUG_EVENT = 0x00200, /* event processing */ |
6fd5ea63 | 73 | DEBUG_HDLC = 0x00800, /* M10x HDLC processing */ |
1528b18f | 74 | DEBUG_CHANNEL = 0x01000, /* channel allocation/deallocation */ |
784d5858 TS |
75 | DEBUG_TRANSCMD = 0x02000, /* AT-COMMANDS+RESPONSES */ |
76 | DEBUG_MCMD = 0x04000, /* COMMANDS THAT ARE SENT VERY OFTEN */ | |
917f5085 TS |
77 | DEBUG_INIT = 0x08000, /* (de)allocation+initialization of data |
78 | structures */ | |
c652cbd8 | 79 | DEBUG_SUSPEND = 0x10000, /* suspend/resume processing */ |
6fd5ea63 | 80 | DEBUG_OUTPUT = 0x20000, /* output to device */ |
784d5858 | 81 | DEBUG_ISO = 0x40000, /* isochronous transfers */ |
6fd5ea63 | 82 | DEBUG_IF = 0x80000, /* character device operations */ |
917f5085 TS |
83 | DEBUG_USBREQ = 0x100000, /* USB communication (except payload |
84 | data) */ | |
784d5858 | 85 | DEBUG_LOCKCMD = 0x200000, /* AT commands and responses when |
917f5085 | 86 | MS_LOCKED */ |
6fd5ea63 | 87 | |
917f5085 TS |
88 | DEBUG_ANY = 0x3fffff, /* print message if any of the others is |
89 | activated */ | |
6fd5ea63 HL |
90 | }; |
91 | ||
6fd5ea63 | 92 | #ifdef CONFIG_GIGASET_DEBUG |
784d5858 | 93 | |
475be4d8 JP |
94 | #define gig_dbg(level, format, arg...) \ |
95 | do { \ | |
917f5085 | 96 | if (unlikely(((enum debuglevel)gigaset_debuglevel) & (level))) \ |
784d5858 | 97 | printk(KERN_DEBUG KBUILD_MODNAME ": " format "\n", \ |
475be4d8 | 98 | ## arg); \ |
917f5085 | 99 | } while (0) |
73a88814 | 100 | #define DEBUG_DEFAULT (DEBUG_TRANSCMD | DEBUG_CMD | DEBUG_USBREQ) |
784d5858 | 101 | |
6fd5ea63 | 102 | #else |
784d5858 TS |
103 | |
104 | #define gig_dbg(level, format, arg...) do {} while (0) | |
105 | #define DEBUG_DEFAULT 0 | |
106 | ||
6fd5ea63 HL |
107 | #endif |
108 | ||
109 | void gigaset_dbg_buffer(enum debuglevel level, const unsigned char *msg, | |
01371500 | 110 | size_t len, const unsigned char *buf); |
6fd5ea63 HL |
111 | |
112 | /* connection state */ | |
113 | #define ZSAU_NONE 0 | |
6fd5ea63 HL |
114 | #define ZSAU_PROCEEDING 1 |
115 | #define ZSAU_CALL_DELIVERED 2 | |
116 | #define ZSAU_ACTIVE 3 | |
63b203b4 | 117 | #define ZSAU_DISCONNECT_IND 4 |
6fd5ea63 HL |
118 | #define ZSAU_NULL 5 |
119 | #define ZSAU_DISCONNECT_REQ 6 | |
120 | #define ZSAU_UNKNOWN -1 | |
121 | ||
122 | /* USB control transfer requests */ | |
917f5085 TS |
123 | #define OUT_VENDOR_REQ (USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT) |
124 | #define IN_VENDOR_REQ (USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT) | |
6fd5ea63 | 125 | |
d9ba9c91 | 126 | /* interrupt pipe messages */ |
6fd5ea63 HL |
127 | #define HD_B1_FLOW_CONTROL 0x80 |
128 | #define HD_B2_FLOW_CONTROL 0x81 | |
d9ba9c91 TS |
129 | #define HD_RECEIVEATDATA_ACK (0x35) /* 3070 */ |
130 | #define HD_READY_SEND_ATDATA (0x36) /* 3070 */ | |
131 | #define HD_OPEN_ATCHANNEL_ACK (0x37) /* 3070 */ | |
132 | #define HD_CLOSE_ATCHANNEL_ACK (0x38) /* 3070 */ | |
133 | #define HD_DEVICE_INIT_OK (0x11) /* ISurf USB + 3070 */ | |
134 | #define HD_OPEN_B1CHANNEL_ACK (0x51) /* ISurf USB + 3070 */ | |
135 | #define HD_OPEN_B2CHANNEL_ACK (0x52) /* ISurf USB + 3070 */ | |
136 | #define HD_CLOSE_B1CHANNEL_ACK (0x53) /* ISurf USB + 3070 */ | |
137 | #define HD_CLOSE_B2CHANNEL_ACK (0x54) /* ISurf USB + 3070 */ | |
138 | #define HD_SUSPEND_END (0x61) /* ISurf USB */ | |
139 | #define HD_RESET_INTERRUPT_PIPE_ACK (0xFF) /* ISurf USB + 3070 */ | |
140 | ||
141 | /* control requests */ | |
142 | #define HD_OPEN_B1CHANNEL (0x23) /* ISurf USB + 3070 */ | |
143 | #define HD_CLOSE_B1CHANNEL (0x24) /* ISurf USB + 3070 */ | |
144 | #define HD_OPEN_B2CHANNEL (0x25) /* ISurf USB + 3070 */ | |
145 | #define HD_CLOSE_B2CHANNEL (0x26) /* ISurf USB + 3070 */ | |
146 | #define HD_RESET_INTERRUPT_PIPE (0x27) /* ISurf USB + 3070 */ | |
147 | #define HD_DEVICE_INIT_ACK (0x34) /* ISurf USB + 3070 */ | |
148 | #define HD_WRITE_ATMESSAGE (0x12) /* 3070 */ | |
149 | #define HD_READ_ATMESSAGE (0x13) /* 3070 */ | |
150 | #define HD_OPEN_ATCHANNEL (0x28) /* 3070 */ | |
151 | #define HD_CLOSE_ATCHANNEL (0x29) /* 3070 */ | |
6fd5ea63 | 152 | |
c652cbd8 TS |
153 | /* number of B channels supported by base driver */ |
154 | #define BAS_CHANNELS 2 | |
155 | ||
6fd5ea63 | 156 | /* USB frames for isochronous transfer */ |
917f5085 TS |
157 | #define BAS_FRAMETIME 1 /* number of milliseconds between frames */ |
158 | #define BAS_NUMFRAMES 8 /* number of frames per URB */ | |
159 | #define BAS_MAXFRAME 16 /* allocated bytes per frame */ | |
160 | #define BAS_NORMFRAME 8 /* send size without flow control */ | |
161 | #define BAS_HIGHFRAME 10 /* " " with positive flow control */ | |
162 | #define BAS_LOWFRAME 5 /* " " with negative flow control */ | |
163 | #define BAS_CORRFRAMES 4 /* flow control multiplicator */ | |
164 | ||
f86936ff TS |
165 | #define BAS_INBUFSIZE (BAS_MAXFRAME * BAS_NUMFRAMES) /* size of isoc in buf |
166 | * per URB */ | |
917f5085 TS |
167 | #define BAS_OUTBUFSIZE 4096 /* size of common isoc out buffer */ |
168 | #define BAS_OUTBUFPAD BAS_MAXFRAME /* size of pad area for isoc out buf */ | |
6fd5ea63 HL |
169 | |
170 | #define BAS_INURBS 3 | |
171 | #define BAS_OUTURBS 3 | |
172 | ||
173 | /* variable commands in struct bc_state */ | |
174 | #define AT_ISO 0 | |
175 | #define AT_DIAL 1 | |
176 | #define AT_MSN 2 | |
177 | #define AT_BC 3 | |
178 | #define AT_PROTO 4 | |
179 | #define AT_TYPE 5 | |
1ce368ff | 180 | #define AT_CLIP 6 |
7bb5fdc2 | 181 | /* total number */ |
1ce368ff | 182 | #define AT_NUM 7 |
6fd5ea63 HL |
183 | |
184 | /* variables in struct at_state_t */ | |
63b203b4 | 185 | /* - numeric */ |
917f5085 TS |
186 | #define VAR_ZSAU 0 |
187 | #define VAR_ZDLE 1 | |
2ed5e4ff | 188 | #define VAR_ZCTP 2 |
63b203b4 | 189 | /* total number */ |
2ed5e4ff | 190 | #define VAR_NUM 3 |
63b203b4 | 191 | /* - string */ |
917f5085 TS |
192 | #define STR_NMBR 0 |
193 | #define STR_ZCPN 1 | |
194 | #define STR_ZCON 2 | |
195 | #define STR_ZBC 3 | |
196 | #define STR_ZHLC 4 | |
63b203b4 | 197 | /* total number */ |
917f5085 TS |
198 | #define STR_NUM 5 |
199 | ||
63b203b4 | 200 | /* event types */ |
917f5085 TS |
201 | #define EV_TIMEOUT -105 |
202 | #define EV_IF_VER -106 | |
203 | #define EV_PROC_CIDMODE -107 | |
204 | #define EV_SHUTDOWN -108 | |
205 | #define EV_START -110 | |
206 | #define EV_STOP -111 | |
207 | #define EV_IF_LOCK -112 | |
917f5085 TS |
208 | #define EV_ACCEPT -114 |
209 | #define EV_DIAL -115 | |
210 | #define EV_HUP -116 | |
211 | #define EV_BC_OPEN -117 | |
212 | #define EV_BC_CLOSED -118 | |
6fd5ea63 HL |
213 | |
214 | /* input state */ | |
2032e2c2 TS |
215 | #define INS_command 0x0001 /* receiving messages (not payload data) */ |
216 | #define INS_DLE_char 0x0002 /* DLE flag received (in DLE mode) */ | |
917f5085 TS |
217 | #define INS_byte_stuff 0x0004 |
218 | #define INS_have_data 0x0008 | |
2032e2c2 | 219 | #define INS_DLE_command 0x0020 /* DLE message start (<DLE> X) received */ |
6fd5ea63 HL |
220 | #define INS_flag_hunt 0x0040 |
221 | ||
222 | /* channel state */ | |
223 | #define CHS_D_UP 0x01 | |
224 | #define CHS_B_UP 0x02 | |
225 | #define CHS_NOTIFY_LL 0x04 | |
226 | ||
917f5085 TS |
227 | #define ICALL_REJECT 0 |
228 | #define ICALL_ACCEPT 1 | |
229 | #define ICALL_IGNORE 2 | |
6fd5ea63 HL |
230 | |
231 | /* device state */ | |
917f5085 TS |
232 | #define MS_UNINITIALIZED 0 |
233 | #define MS_INIT 1 | |
234 | #define MS_LOCKED 2 | |
235 | #define MS_SHUTDOWN 3 | |
236 | #define MS_RECOVER 4 | |
237 | #define MS_READY 5 | |
6fd5ea63 HL |
238 | |
239 | /* mode */ | |
917f5085 TS |
240 | #define M_UNKNOWN 0 |
241 | #define M_CONFIG 1 | |
242 | #define M_UNIMODEM 2 | |
243 | #define M_CID 3 | |
6fd5ea63 HL |
244 | |
245 | /* start mode */ | |
917f5085 TS |
246 | #define SM_LOCKED 0 |
247 | #define SM_ISDN 1 /* default */ | |
6fd5ea63 | 248 | |
088ec0cc TS |
249 | /* layer 2 protocols (AT^SBPR=...) */ |
250 | #define L2_BITSYNC 0 | |
251 | #define L2_HDLC 1 | |
252 | #define L2_VOICE 2 | |
253 | ||
6fd5ea63 HL |
254 | struct gigaset_ops; |
255 | struct gigaset_driver; | |
256 | ||
257 | struct usb_cardstate; | |
258 | struct ser_cardstate; | |
259 | struct bas_cardstate; | |
260 | ||
261 | struct bc_state; | |
262 | struct usb_bc_state; | |
263 | struct ser_bc_state; | |
264 | struct bas_bc_state; | |
265 | ||
266 | struct reply_t { | |
917f5085 TS |
267 | int resp_code; /* RSP_XXXX */ |
268 | int min_ConState; /* <0 => ignore */ | |
269 | int max_ConState; /* <0 => ignore */ | |
270 | int parameter; /* e.g. ZSAU_XXXX <0: ignore*/ | |
271 | int new_ConState; /* <0 => ignore */ | |
272 | int timeout; /* >0 => *HZ; <=0 => TOUT_XXXX*/ | |
273 | int action[MAXACT]; /* ACT_XXXX */ | |
274 | char *command; /* NULL==none */ | |
6fd5ea63 HL |
275 | }; |
276 | ||
528efc6a TS |
277 | extern struct reply_t gigaset_tab_cid[]; |
278 | extern struct reply_t gigaset_tab_nocid[]; | |
6fd5ea63 HL |
279 | |
280 | struct inbuf_t { | |
917f5085 TS |
281 | struct cardstate *cs; |
282 | int inputstate; | |
9d4bee2b | 283 | int head, tail; |
917f5085 | 284 | unsigned char data[RBUFSIZE]; |
6fd5ea63 HL |
285 | }; |
286 | ||
287 | /* isochronous write buffer structure | |
288 | * circular buffer with pad area for extraction of complete USB frames | |
289 | * - data[read..nextread-1] is valid data already submitted to the USB subsystem | |
290 | * - data[nextread..write-1] is valid data yet to be sent | |
291 | * - data[write] is the next byte to write to | |
292 | * - in byte-oriented L2 procotols, it is completely free | |
293 | * - in bit-oriented L2 procotols, it may contain a partial byte of valid data | |
294 | * - data[write+1..read-1] is free | |
295 | * - wbits is the number of valid data bits in data[write], starting at the LSB | |
296 | * - writesem is the semaphore for writing to the buffer: | |
297 | * if writesem <= 0, data[write..read-1] is currently being written to | |
298 | * - idle contains the byte value to repeat when the end of valid data is | |
299 | * reached; if nextread==write (buffer contains no data to send), either the | |
917f5085 TS |
300 | * BAS_OUTBUFPAD bytes immediately before data[write] (if |
301 | * write>=BAS_OUTBUFPAD) or those of the pad area (if write<BAS_OUTBUFPAD) | |
302 | * are also filled with that value | |
6fd5ea63 HL |
303 | */ |
304 | struct isowbuf_t { | |
9d4bee2b TS |
305 | int read; |
306 | int nextread; | |
307 | int write; | |
6fd5ea63 HL |
308 | atomic_t writesem; |
309 | int wbits; | |
310 | unsigned char data[BAS_OUTBUFSIZE + BAS_OUTBUFPAD]; | |
311 | unsigned char idle; | |
312 | }; | |
313 | ||
314 | /* isochronous write URB context structure | |
315 | * data to be stored along with the URB and retrieved when it is returned | |
316 | * as completed by the USB subsystem | |
317 | * - urb: pointer to the URB itself | |
318 | * - bcs: pointer to the B Channel control structure | |
319 | * - limit: end of write buffer area covered by this URB | |
dbd98231 | 320 | * - status: URB completion status |
6fd5ea63 HL |
321 | */ |
322 | struct isow_urbctx_t { | |
323 | struct urb *urb; | |
324 | struct bc_state *bcs; | |
325 | int limit; | |
dbd98231 | 326 | int status; |
6fd5ea63 HL |
327 | }; |
328 | ||
329 | /* AT state structure | |
330 | * data associated with the state of an ISDN connection, whether or not | |
331 | * it is currently assigned a B channel | |
332 | */ | |
333 | struct at_state_t { | |
917f5085 TS |
334 | struct list_head list; |
335 | int waiting; | |
336 | int getstring; | |
69049cc8 | 337 | unsigned timer_index; |
6fd5ea63 HL |
338 | unsigned long timer_expires; |
339 | int timer_active; | |
917f5085 TS |
340 | unsigned int ConState; /* State of connection */ |
341 | struct reply_t *replystruct; | |
342 | int cid; | |
343 | int int_var[VAR_NUM]; /* see VAR_XXXX */ | |
344 | char *str_var[STR_NUM]; /* see STR_XXXX */ | |
345 | unsigned pending_commands; /* see PC_XXXX */ | |
69049cc8 | 346 | unsigned seq_index; |
917f5085 TS |
347 | |
348 | struct cardstate *cs; | |
349 | struct bc_state *bcs; | |
6fd5ea63 HL |
350 | }; |
351 | ||
6fd5ea63 HL |
352 | struct event_t { |
353 | int type; | |
354 | void *ptr, *arg; | |
355 | int parameter; | |
356 | int cid; | |
357 | struct at_state_t *at_state; | |
358 | }; | |
359 | ||
360 | /* This buffer holds all information about the used B-Channel */ | |
361 | struct bc_state { | |
917f5085 TS |
362 | struct sk_buff *tx_skb; /* Current transfer buffer to modem */ |
363 | struct sk_buff_head squeue; /* B-Channel send Queue */ | |
6fd5ea63 HL |
364 | |
365 | /* Variables for debugging .. */ | |
917f5085 TS |
366 | int corrupted; /* Counter for corrupted packages */ |
367 | int trans_down; /* Counter of packages (downstream) */ | |
368 | int trans_up; /* Counter of packages (upstream) */ | |
6fd5ea63 HL |
369 | |
370 | struct at_state_t at_state; | |
6fd5ea63 | 371 | |
e7752ee2 TS |
372 | /* receive buffer */ |
373 | unsigned rx_bufsize; /* max size accepted by application */ | |
374 | struct sk_buff *rx_skb; | |
375 | __u16 rx_fcs; | |
917f5085 | 376 | int inputstate; /* see INS_XXXX */ |
6fd5ea63 HL |
377 | |
378 | int channel; | |
379 | ||
380 | struct cardstate *cs; | |
381 | ||
917f5085 | 382 | unsigned chstate; /* bitmap (CHS_*) */ |
6fd5ea63 | 383 | int ignore; |
088ec0cc | 384 | unsigned proto2; /* layer 2 protocol (L2_*) */ |
917f5085 | 385 | char *commands[AT_NUM]; /* see AT_XXXX */ |
6fd5ea63 HL |
386 | |
387 | #ifdef CONFIG_GIGASET_DEBUG | |
388 | int emptycount; | |
389 | #endif | |
390 | int busy; | |
391 | int use_count; | |
392 | ||
784d5858 | 393 | /* private data of hardware drivers */ |
6fd5ea63 | 394 | union { |
917f5085 TS |
395 | struct ser_bc_state *ser; /* serial hardware driver */ |
396 | struct usb_bc_state *usb; /* usb hardware driver (m105) */ | |
397 | struct bas_bc_state *bas; /* usb hardware driver (base) */ | |
6fd5ea63 | 398 | } hw; |
7bb5fdc2 | 399 | |
1b4843c5 TS |
400 | void *ap; /* associated LL application */ |
401 | int apconnstate; /* LL application connection state */ | |
402 | spinlock_t aplock; | |
6fd5ea63 HL |
403 | }; |
404 | ||
405 | struct cardstate { | |
406 | struct gigaset_driver *driver; | |
407 | unsigned minor_index; | |
784d5858 | 408 | struct device *dev; |
01107d34 | 409 | struct device *tty_dev; |
e468c048 | 410 | unsigned flags; |
6fd5ea63 HL |
411 | |
412 | const struct gigaset_ops *ops; | |
413 | ||
414 | /* Stuff to handle communication */ | |
6fd5ea63 HL |
415 | wait_queue_head_t waitqueue; |
416 | int waiting; | |
9d4bee2b TS |
417 | int mode; /* see M_XXXX */ |
418 | int mstate; /* Modem state: see MS_XXXX */ | |
917f5085 | 419 | /* only changed by the event layer */ |
6fd5ea63 HL |
420 | int cmd_result; |
421 | ||
422 | int channels; | |
917f5085 | 423 | struct bc_state *bcs; /* Array of struct bc_state */ |
6fd5ea63 | 424 | |
917f5085 TS |
425 | int onechannel; /* data and commands transmitted in one |
426 | stream (M10x) */ | |
6fd5ea63 HL |
427 | |
428 | spinlock_t lock; | |
917f5085 TS |
429 | struct at_state_t at_state; /* at_state_t for cid == 0 */ |
430 | struct list_head temp_at_states;/* list of temporary "struct | |
431 | at_state_t"s without B channel */ | |
6fd5ea63 HL |
432 | |
433 | struct inbuf_t *inbuf; | |
434 | ||
435 | struct cmdbuf_t *cmdbuf, *lastcmdbuf; | |
436 | spinlock_t cmdlock; | |
437 | unsigned curlen, cmdbytes; | |
438 | ||
48a7466f | 439 | struct tty_port port; |
6fd5ea63 HL |
440 | struct tasklet_struct if_wake_tasklet; |
441 | unsigned control_state; | |
442 | ||
443 | unsigned fwver[4]; | |
444 | int gotfwver; | |
445 | ||
69049cc8 TS |
446 | unsigned running; /* !=0 if events are handled */ |
447 | unsigned connected; /* !=0 if hardware is connected */ | |
088ec0cc | 448 | unsigned isdn_up; /* !=0 after gigaset_isdn_start() */ |
6fd5ea63 | 449 | |
69049cc8 | 450 | unsigned cidmode; |
6fd5ea63 | 451 | |
917f5085 | 452 | int myid; /* id for communication with LL */ |
088ec0cc TS |
453 | void *iif; /* LL interface structure */ |
454 | unsigned short hw_hdr_len; /* headroom needed in data skbs */ | |
6fd5ea63 HL |
455 | |
456 | struct reply_t *tabnocid; | |
457 | struct reply_t *tabcid; | |
458 | int cs_init; | |
917f5085 TS |
459 | int ignoreframes; /* frames to ignore after setting up the |
460 | B channel */ | |
abfd1dc7 | 461 | struct mutex mutex; /* locks this structure: |
784d5858 TS |
462 | * connected is not changed, |
463 | * hardware_up is not changed, | |
464 | * MState is not changed to or from | |
465 | * MS_LOCKED */ | |
6fd5ea63 HL |
466 | |
467 | struct timer_list timer; | |
468 | int retry_count; | |
2032e2c2 TS |
469 | int dle; /* !=0 if DLE mode is active |
470 | (ZDLE=1 received -- M10x only) */ | |
917f5085 TS |
471 | int cur_at_seq; /* sequence of AT commands being |
472 | processed */ | |
784d5858 | 473 | int curchannel; /* channel those commands are meant |
917f5085 | 474 | for */ |
9d4bee2b | 475 | int commands_pending; /* flag(s) in xxx.commands_pending have |
917f5085 | 476 | been set */ |
f86936ff TS |
477 | struct tasklet_struct |
478 | event_tasklet; /* tasklet for serializing AT commands. | |
479 | * Scheduled | |
480 | * -> for modem reponses (and | |
481 | * incoming data for M10x) | |
482 | * -> on timeout | |
483 | * -> after setting bits in | |
484 | * xxx.at_state.pending_command | |
485 | * (e.g. command from LL) */ | |
486 | struct tasklet_struct | |
487 | write_tasklet; /* tasklet for serial output | |
488 | * (not used in base driver) */ | |
6fd5ea63 HL |
489 | |
490 | /* event queue */ | |
491 | struct event_t events[MAX_EVENTS]; | |
69049cc8 | 492 | unsigned ev_tail, ev_head; |
6fd5ea63 HL |
493 | spinlock_t ev_lock; |
494 | ||
495 | /* current modem response */ | |
475be4d8 | 496 | unsigned char respdata[MAX_RESP_SIZE + 1]; |
6fd5ea63 HL |
497 | unsigned cbytes; |
498 | ||
784d5858 | 499 | /* private data of hardware drivers */ |
6fd5ea63 | 500 | union { |
917f5085 TS |
501 | struct usb_cardstate *usb; /* USB hardware driver (m105) */ |
502 | struct ser_cardstate *ser; /* serial hardware driver */ | |
503 | struct bas_cardstate *bas; /* USB hardware driver (base) */ | |
6fd5ea63 HL |
504 | } hw; |
505 | }; | |
506 | ||
507 | struct gigaset_driver { | |
508 | struct list_head list; | |
917f5085 | 509 | spinlock_t lock; /* locks minor tables and blocked */ |
6fd5ea63 HL |
510 | struct tty_driver *tty; |
511 | unsigned have_tty; | |
512 | unsigned minor; | |
513 | unsigned minors; | |
514 | struct cardstate *cs; | |
6fd5ea63 HL |
515 | int blocked; |
516 | ||
517 | const struct gigaset_ops *ops; | |
518 | struct module *owner; | |
519 | }; | |
520 | ||
521 | struct cmdbuf_t { | |
522 | struct cmdbuf_t *next, *prev; | |
523 | int len, offset; | |
524 | struct tasklet_struct *wake_tasklet; | |
525 | unsigned char buf[0]; | |
526 | }; | |
527 | ||
528 | struct bas_bc_state { | |
529 | /* isochronous output state */ | |
9d4bee2b | 530 | int running; |
6fd5ea63 HL |
531 | atomic_t corrbytes; |
532 | spinlock_t isooutlock; | |
533 | struct isow_urbctx_t isoouturbs[BAS_OUTURBS]; | |
534 | struct isow_urbctx_t *isooutdone, *isooutfree, *isooutovfl; | |
535 | struct isowbuf_t *isooutbuf; | |
784d5858 TS |
536 | unsigned numsub; /* submitted URB counter |
537 | (for diagnostic messages only) */ | |
6fd5ea63 HL |
538 | struct tasklet_struct sent_tasklet; |
539 | ||
540 | /* isochronous input state */ | |
541 | spinlock_t isoinlock; | |
542 | struct urb *isoinurbs[BAS_INURBS]; | |
543 | unsigned char isoinbuf[BAS_INBUFSIZE * BAS_INURBS]; | |
784d5858 | 544 | struct urb *isoindone; /* completed isoc read URB */ |
dbd98231 | 545 | int isoinstatus; /* status of completed URB */ |
784d5858 TS |
546 | int loststatus; /* status of dropped URB */ |
547 | unsigned isoinlost; /* number of bytes lost */ | |
548 | /* state of bit unstuffing algorithm | |
549 | (in addition to BC_state.inputstate) */ | |
550 | unsigned seqlen; /* number of '1' bits not yet | |
551 | unstuffed */ | |
552 | unsigned inbyte, inbits; /* collected bits for next byte */ | |
6fd5ea63 | 553 | /* statistics */ |
784d5858 TS |
554 | unsigned goodbytes; /* bytes correctly received */ |
555 | unsigned alignerrs; /* frames with incomplete byte at end */ | |
556 | unsigned fcserrs; /* FCS errors */ | |
557 | unsigned frameerrs; /* framing errors */ | |
558 | unsigned giants; /* long frames */ | |
559 | unsigned runts; /* short frames */ | |
560 | unsigned aborts; /* HDLC aborts */ | |
561 | unsigned shared0s; /* '0' bits shared between flags */ | |
562 | unsigned stolen0s; /* '0' stuff bits also serving as | |
563 | leading flag bits */ | |
6fd5ea63 HL |
564 | struct tasklet_struct rcvd_tasklet; |
565 | }; | |
566 | ||
567 | struct gigaset_ops { | |
917f5085 TS |
568 | /* Called from ev-layer.c/interface.c for sending AT commands to the |
569 | device */ | |
e3628dd1 | 570 | int (*write_cmd)(struct cardstate *cs, struct cmdbuf_t *cb); |
6fd5ea63 HL |
571 | |
572 | /* Called from interface.c for additional device control */ | |
573 | int (*write_room)(struct cardstate *cs); | |
574 | int (*chars_in_buffer)(struct cardstate *cs); | |
575 | int (*brkchars)(struct cardstate *cs, const unsigned char buf[6]); | |
576 | ||
577 | /* Called from ev-layer.c after setting up connection | |
578 | * Should call gigaset_bchannel_up(), when finished. */ | |
579 | int (*init_bchannel)(struct bc_state *bcs); | |
580 | ||
581 | /* Called from ev-layer.c after hanging up | |
582 | * Should call gigaset_bchannel_down(), when finished. */ | |
583 | int (*close_bchannel)(struct bc_state *bcs); | |
584 | ||
585 | /* Called by gigaset_initcs() for setting up bcs->hw.xxx */ | |
586 | int (*initbcshw)(struct bc_state *bcs); | |
587 | ||
588 | /* Called by gigaset_freecs() for freeing bcs->hw.xxx */ | |
81fa7b82 | 589 | void (*freebcshw)(struct bc_state *bcs); |
6fd5ea63 | 590 | |
73a88814 | 591 | /* Called by gigaset_bchannel_down() for resetting bcs->hw.xxx */ |
6fd5ea63 HL |
592 | void (*reinitbcshw)(struct bc_state *bcs); |
593 | ||
594 | /* Called by gigaset_initcs() for setting up cs->hw.xxx */ | |
595 | int (*initcshw)(struct cardstate *cs); | |
596 | ||
597 | /* Called by gigaset_freecs() for freeing cs->hw.xxx */ | |
598 | void (*freecshw)(struct cardstate *cs); | |
599 | ||
917f5085 TS |
600 | /* Called from common.c/interface.c for additional serial port |
601 | control */ | |
602 | int (*set_modem_ctrl)(struct cardstate *cs, unsigned old_state, | |
603 | unsigned new_state); | |
6fd5ea63 HL |
604 | int (*baud_rate)(struct cardstate *cs, unsigned cflag); |
605 | int (*set_line_ctrl)(struct cardstate *cs, unsigned cflag); | |
606 | ||
088ec0cc TS |
607 | /* Called from LL interface to put an skb into the send-queue. |
608 | * After sending is completed, gigaset_skb_sent() must be called | |
4dd8230a | 609 | * with the skb's link layer header preserved. */ |
6fd5ea63 HL |
610 | int (*send_skb)(struct bc_state *bcs, struct sk_buff *skb); |
611 | ||
612 | /* Called from ev-layer.c to process a block of data | |
613 | * received through the common/control channel. */ | |
614 | void (*handle_input)(struct inbuf_t *inbuf); | |
615 | ||
616 | }; | |
617 | ||
d9ba9c91 TS |
618 | /* = Common structures and definitions ======================================= |
619 | */ | |
6fd5ea63 HL |
620 | |
621 | /* Parser states for DLE-Event: | |
622 | * <DLE-EVENT>: <DLE_FLAG> "X" <EVENT> <DLE_FLAG> "." | |
623 | * <DLE_FLAG>: 0x10 | |
624 | * <EVENT>: ((a-z)* | (A-Z)* | (0-10)*)+ | |
625 | */ | |
784d5858 | 626 | #define DLE_FLAG 0x10 |
6fd5ea63 HL |
627 | |
628 | /* =========================================================================== | |
629 | * Functions implemented in asyncdata.c | |
630 | */ | |
631 | ||
088ec0cc | 632 | /* Called from LL interface to put an skb into the send queue. */ |
6fd5ea63 HL |
633 | int gigaset_m10x_send_skb(struct bc_state *bcs, struct sk_buff *skb); |
634 | ||
635 | /* Called from ev-layer.c to process a block of data | |
636 | * received through the common/control channel. */ | |
637 | void gigaset_m10x_input(struct inbuf_t *inbuf); | |
638 | ||
639 | /* =========================================================================== | |
640 | * Functions implemented in isocdata.c | |
641 | */ | |
642 | ||
088ec0cc | 643 | /* Called from LL interface to put an skb into the send queue. */ |
6fd5ea63 HL |
644 | int gigaset_isoc_send_skb(struct bc_state *bcs, struct sk_buff *skb); |
645 | ||
646 | /* Called from ev-layer.c to process a block of data | |
647 | * received through the common/control channel. */ | |
648 | void gigaset_isoc_input(struct inbuf_t *inbuf); | |
649 | ||
650 | /* Called from bas-gigaset.c to process a block of data | |
651 | * received through the isochronous channel */ | |
917f5085 TS |
652 | void gigaset_isoc_receive(unsigned char *src, unsigned count, |
653 | struct bc_state *bcs); | |
6fd5ea63 HL |
654 | |
655 | /* Called from bas-gigaset.c to put a block of data | |
656 | * into the isochronous output buffer */ | |
657 | int gigaset_isoc_buildframe(struct bc_state *bcs, unsigned char *in, int len); | |
658 | ||
659 | /* Called from bas-gigaset.c to initialize the isochronous output buffer */ | |
660 | void gigaset_isowbuf_init(struct isowbuf_t *iwb, unsigned char idle); | |
661 | ||
662 | /* Called from bas-gigaset.c to retrieve a block of bytes for sending */ | |
663 | int gigaset_isowbuf_getbytes(struct isowbuf_t *iwb, int size); | |
664 | ||
665 | /* =========================================================================== | |
088ec0cc | 666 | * Functions implemented in LL interface |
6fd5ea63 HL |
667 | */ |
668 | ||
088ec0cc | 669 | /* Called from common.c for setting up/shutting down with the ISDN subsystem */ |
bc35b4e3 TS |
670 | void gigaset_isdn_regdrv(void); |
671 | void gigaset_isdn_unregdrv(void); | |
672 | int gigaset_isdn_regdev(struct cardstate *cs, const char *isdnid); | |
673 | void gigaset_isdn_unregdev(struct cardstate *cs); | |
6fd5ea63 | 674 | |
088ec0cc | 675 | /* Called from hardware module to indicate completion of an skb */ |
6fd5ea63 | 676 | void gigaset_skb_sent(struct bc_state *bcs, struct sk_buff *skb); |
088ec0cc TS |
677 | void gigaset_skb_rcvd(struct bc_state *bcs, struct sk_buff *skb); |
678 | void gigaset_isdn_rcv_err(struct bc_state *bcs); | |
6fd5ea63 HL |
679 | |
680 | /* Called from common.c/ev-layer.c to indicate events relevant to the LL */ | |
088ec0cc TS |
681 | void gigaset_isdn_start(struct cardstate *cs); |
682 | void gigaset_isdn_stop(struct cardstate *cs); | |
6fd5ea63 | 683 | int gigaset_isdn_icall(struct at_state_t *at_state); |
088ec0cc TS |
684 | void gigaset_isdn_connD(struct bc_state *bcs); |
685 | void gigaset_isdn_hupD(struct bc_state *bcs); | |
686 | void gigaset_isdn_connB(struct bc_state *bcs); | |
687 | void gigaset_isdn_hupB(struct bc_state *bcs); | |
6fd5ea63 HL |
688 | |
689 | /* =========================================================================== | |
690 | * Functions implemented in ev-layer.c | |
691 | */ | |
692 | ||
693 | /* tasklet called from common.c to process queued events */ | |
694 | void gigaset_handle_event(unsigned long data); | |
695 | ||
696 | /* called from isocdata.c / asyncdata.c | |
697 | * when a complete modem response line has been received */ | |
698 | void gigaset_handle_modem_response(struct cardstate *cs); | |
699 | ||
700 | /* =========================================================================== | |
701 | * Functions implemented in proc.c | |
702 | */ | |
703 | ||
704 | /* initialize sysfs for device */ | |
b1d47464 TS |
705 | void gigaset_init_dev_sysfs(struct cardstate *cs); |
706 | void gigaset_free_dev_sysfs(struct cardstate *cs); | |
6fd5ea63 HL |
707 | |
708 | /* =========================================================================== | |
709 | * Functions implemented in common.c/gigaset.h | |
710 | */ | |
711 | ||
712 | void gigaset_bcs_reinit(struct bc_state *bcs); | |
713 | void gigaset_at_init(struct at_state_t *at_state, struct bc_state *bcs, | |
784d5858 | 714 | struct cardstate *cs, int cid); |
6fd5ea63 | 715 | int gigaset_get_channel(struct bc_state *bcs); |
7bb5fdc2 | 716 | struct bc_state *gigaset_get_free_channel(struct cardstate *cs); |
6fd5ea63 HL |
717 | void gigaset_free_channel(struct bc_state *bcs); |
718 | int gigaset_get_channels(struct cardstate *cs); | |
719 | void gigaset_free_channels(struct cardstate *cs); | |
720 | void gigaset_block_channels(struct cardstate *cs); | |
721 | ||
722 | /* Allocate and initialize driver structure. */ | |
723 | struct gigaset_driver *gigaset_initdriver(unsigned minor, unsigned minors, | |
784d5858 TS |
724 | const char *procname, |
725 | const char *devname, | |
784d5858 TS |
726 | const struct gigaset_ops *ops, |
727 | struct module *owner); | |
6fd5ea63 HL |
728 | |
729 | /* Deallocate driver structure. */ | |
730 | void gigaset_freedriver(struct gigaset_driver *drv); | |
befba36a | 731 | |
6fd5ea63 HL |
732 | struct cardstate *gigaset_get_cs_by_tty(struct tty_struct *tty); |
733 | struct cardstate *gigaset_get_cs_by_id(int id); | |
6fd5ea63 HL |
734 | void gigaset_blockdriver(struct gigaset_driver *drv); |
735 | ||
917f5085 TS |
736 | /* Allocate and initialize card state. Calls hardware dependent |
737 | gigaset_init[b]cs(). */ | |
6fd5ea63 HL |
738 | struct cardstate *gigaset_initcs(struct gigaset_driver *drv, int channels, |
739 | int onechannel, int ignoreframes, | |
740 | int cidmode, const char *modulename); | |
741 | ||
742 | /* Free card state. Calls hardware dependent gigaset_free[b]cs(). */ | |
743 | void gigaset_freecs(struct cardstate *cs); | |
744 | ||
745 | /* Tell common.c that hardware and driver are ready. */ | |
746 | int gigaset_start(struct cardstate *cs); | |
747 | ||
748 | /* Tell common.c that the device is not present any more. */ | |
749 | void gigaset_stop(struct cardstate *cs); | |
750 | ||
751 | /* Tell common.c that the driver is being unloaded. */ | |
e468c048 | 752 | int gigaset_shutdown(struct cardstate *cs); |
6fd5ea63 HL |
753 | |
754 | /* Tell common.c that an skb has been sent. */ | |
755 | void gigaset_skb_sent(struct bc_state *bcs, struct sk_buff *skb); | |
756 | ||
757 | /* Append event to the queue. | |
758 | * Returns NULL on failure or a pointer to the event on success. | |
759 | * ptr must be kmalloc()ed (and not be freed by the caller). | |
760 | */ | |
761 | struct event_t *gigaset_add_event(struct cardstate *cs, | |
784d5858 TS |
762 | struct at_state_t *at_state, int type, |
763 | void *ptr, int parameter, void *arg); | |
6fd5ea63 HL |
764 | |
765 | /* Called on CONFIG1 command from frontend. */ | |
d9ba9c91 | 766 | int gigaset_enterconfigmode(struct cardstate *cs); |
6fd5ea63 HL |
767 | |
768 | /* cs->lock must not be locked */ | |
769 | static inline void gigaset_schedule_event(struct cardstate *cs) | |
770 | { | |
771 | unsigned long flags; | |
772 | spin_lock_irqsave(&cs->lock, flags); | |
69049cc8 | 773 | if (cs->running) |
6fd5ea63 HL |
774 | tasklet_schedule(&cs->event_tasklet); |
775 | spin_unlock_irqrestore(&cs->lock, flags); | |
776 | } | |
777 | ||
778 | /* Tell common.c that B channel has been closed. */ | |
779 | /* cs->lock must not be locked */ | |
780 | static inline void gigaset_bchannel_down(struct bc_state *bcs) | |
781 | { | |
782 | gigaset_add_event(bcs->cs, &bcs->at_state, EV_BC_CLOSED, NULL, 0, NULL); | |
6fd5ea63 HL |
783 | gigaset_schedule_event(bcs->cs); |
784 | } | |
785 | ||
786 | /* Tell common.c that B channel has been opened. */ | |
787 | /* cs->lock must not be locked */ | |
788 | static inline void gigaset_bchannel_up(struct bc_state *bcs) | |
789 | { | |
790 | gigaset_add_event(bcs->cs, &bcs->at_state, EV_BC_OPEN, NULL, 0, NULL); | |
6fd5ea63 HL |
791 | gigaset_schedule_event(bcs->cs); |
792 | } | |
793 | ||
e7752ee2 TS |
794 | /* set up next receive skb for data mode */ |
795 | static inline struct sk_buff *gigaset_new_rx_skb(struct bc_state *bcs) | |
796 | { | |
797 | struct cardstate *cs = bcs->cs; | |
798 | unsigned short hw_hdr_len = cs->hw_hdr_len; | |
799 | ||
800 | if (bcs->ignore) { | |
801 | bcs->rx_skb = NULL; | |
802 | } else { | |
803 | bcs->rx_skb = dev_alloc_skb(bcs->rx_bufsize + hw_hdr_len); | |
804 | if (bcs->rx_skb == NULL) | |
805 | dev_warn(cs->dev, "could not allocate skb\n"); | |
806 | else | |
807 | skb_reserve(bcs->rx_skb, hw_hdr_len); | |
808 | } | |
809 | return bcs->rx_skb; | |
810 | } | |
6fd5ea63 | 811 | |
6fd5ea63 | 812 | /* append received bytes to inbuf */ |
714e8236 TS |
813 | int gigaset_fill_inbuf(struct inbuf_t *inbuf, const unsigned char *src, |
814 | unsigned numbytes); | |
6fd5ea63 HL |
815 | |
816 | /* =========================================================================== | |
817 | * Functions implemented in interface.c | |
818 | */ | |
819 | ||
820 | /* initialize interface */ | |
821 | void gigaset_if_initdriver(struct gigaset_driver *drv, const char *procname, | |
f4eaa370 | 822 | const char *devname); |
6fd5ea63 HL |
823 | /* release interface */ |
824 | void gigaset_if_freedriver(struct gigaset_driver *drv); | |
825 | /* add minor */ | |
826 | void gigaset_if_init(struct cardstate *cs); | |
827 | /* remove minor */ | |
828 | void gigaset_if_free(struct cardstate *cs); | |
829 | /* device received data */ | |
830 | void gigaset_if_receive(struct cardstate *cs, | |
784d5858 | 831 | unsigned char *buffer, size_t len); |
6fd5ea63 HL |
832 | |
833 | #endif |