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