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