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