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