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