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