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