drivers/isdn/gigaset/gigaset.h

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