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