sys/net/i4b/include/i386/i4b_ioctl.h

   1 /*
   2  * Copyright (c) 1997, 2001 Hellmuth Michaelis. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  *
  25  *---------------------------------------------------------------------------
  26  *
  27  *      i4b_ioctl.h - messages kernel <--> userland
  28  *      -------------------------------------------
  29  *
  30  * $FreeBSD: src/sys/i386/include/i4b_ioctl.h,v 1.6.2.5 2002/04/25 12:29:42 gj Exp $
  31  * $DragonFly: src/sys/net/i4b/include/i386/i4b_ioctl.h,v 1.2 2003/06/17 04:28:35 dillon Exp $
  32  *
  33  *      last edit-date: [Sun Dec 16 15:09:12 2001]
  34  *
  35  *---------------------------------------------------------------------------*/
  36
  37 #ifndef _I4B_IOCTL_H_
  38 #define _I4B_IOCTL_H_
  39
  40 #if defined(__FreeBSD__) && __FreeBSD__ >= 3
  41 #ifndef _MACHINE_TYPES_H_
  42 #include <machine/types.h>
  43 #endif /* _MACHINE_TYPES_H_ */
  44 #endif /* __FreeBSD__ */
  45
  46 /*---------------------------------------------------------------------------*
  47  *      version and release number for isdn4bsd package
  48  *---------------------------------------------------------------------------*/
  49 #define VERSION         1               /* version number       */
  50 #define REL             1               /* release number       */
  51 #define STEP            1               /* release step         */
  52
  53 /*---------------------------------------------------------------------------*
  54  * date/time format in i4b log messages
  55  * ------------------------------------
  56  * Being year 2000 clean is not easy with the current state of the
  57  * ANSI C library standard and it's implementation for some locales.
  58  * You might like to use the "%c" format of "strftime" sometimes,
  59  * but this breaks Y2K in some locales. Also the old standard logfile
  60  * format "%d.%m.%y %H:%M:%S" is non compliant.
  61  * NetBSD's current toolset warns about this problems, and we compile
  62  * with -Werror, so this problems need to be resolved.
  63  *---------------------------------------------------------------------------*/
  64 #define I4B_TIME_FORMAT "%d.%m.%Y %H:%M:%S"
  65
  66 /*---------------------------------------------------------------------------*
  67  *      max number of controllers in system
  68  *---------------------------------------------------------------------------*/
  69 #define MAX_CONTROLLERS 8               /* max number of controllers    */
  70
  71 /*---------------------------------------------------------------------------*
  72  *      ISDN D-channel protocols
  73  *---------------------------------------------------------------------------*/
  74 #define PROTOCOL_DSS1   0               /* default, Euro-ISDN/DSS1 */
  75 #define PROTOCOL_D64S   1               /* 64k leased line, no protocol */
  76
  77 /*---------------------------------------------------------------------------*
  78  *      controller types
  79  *---------------------------------------------------------------------------*/
  80 #define CTRL_INVALID    (-1)            /* invalid, error               */
  81 #define CTRL_UNKNOWN    0               /* unknown controller type      */
  82 #define CTRL_PASSIVE    1               /* passive ISDN controller cards*/
  83 #define CTRL_DAIC       2               /* Diehl active controller cards*/
  84 #define CTRL_TINADD     3               /* Stollmann Tina-dd active card*/
  85 #define CTRL_AVMB1      4               /* AVM B1 active card           */
  86 #define CTRL_CAPI       5               /* cards seen via the CAPI layer*/
  87 #define CTRL_NUMTYPES   6               /* number of controller types   */
  88
  89 /*---------------------------------------------------------------------------*
  90  *      CTRL_PASSIVE: driver types
  91  *---------------------------------------------------------------------------*/
  92 #define MAXL1UNITS      8               /* max number of units  */
  93
  94 #define L1DRVR_ISIC     0               /* isic - driver        */
  95 #define L1DRVR_IWIC     1               /* iwic - driver        */
  96 #define L1DRVR_IFPI     2               /* ifpi - driver        */
  97 #define L1DRVR_IHFC     3               /* ihfc - driver        */
  98 #define L1DRVR_IFPNP    4               /* ifpnp - driver       */
  99 #define L1DRVR_ICCHP    5               /* icchp - driver       */
 100 #define L1DRVR_ITJC     6               /* itjc - driver        */
 101 #define L1DRVR_IFPI2    7               /* ifpi2 - driver        */
 102
 103 /* MAXL1DRVR MUST be updated when more passive drivers are added !!! */
 104 #define MAXL1DRVR       (L1DRVR_IFPI2 + 1)
 105
 106 /*---------------------------------------------------------------------------*
 107  *      card types for CTRL_PASSIVE
 108  *---------------------------------------------------------------------------*/
 109 #define CARD_TYPEP_INVAL        (-1)    /* invalid, error               */
 110 #define CARD_TYPEP_UNK          0       /* unknown                      */
 111 #define CARD_TYPEP_8            1       /* Teles, S0/8                  */
 112 #define CARD_TYPEP_16           2       /* Teles, S0/16                 */
 113 #define CARD_TYPEP_16_3         3       /* Teles, S0/16.3               */
 114 #define CARD_TYPEP_AVMA1        4       /* AVM A1 or AVM Fritz!Card     */
 115 #define CARD_TYPEP_163P         5       /* Teles, S0/16.3 PnP           */
 116 #define CARD_TYPEP_CS0P         6       /* Creatix, S0 PnP              */
 117 #define CARD_TYPEP_USRTA        7       /* US Robotics ISDN TA internal */
 118 #define CARD_TYPEP_DRNNGO       8       /* Dr. Neuhaus Niccy GO@        */
 119 #define CARD_TYPEP_SWS          9       /* Sedlbauer Win Speed          */
 120 #define CARD_TYPEP_DYNALINK     10      /* Dynalink IS64PH              */
 121 #define CARD_TYPEP_BLMASTER     11      /* ISDN Blaster / ISDN Master   */
 122 #define CARD_TYPEP_PCFRITZ      12      /* AVM PCMCIA Fritz!Card        */
 123 #define CARD_TYPEP_ELSAQS1ISA   13      /* ELSA QuickStep 1000pro ISA   */
 124 #define CARD_TYPEP_ELSAQS1PCI   14      /* ELSA QuickStep 1000pro PCI   */
 125 #define CARD_TYPEP_SIEMENSITALK 15      /* Siemens I-Talk               */
 126 #define CARD_TYPEP_ELSAMLIMC    16      /* ELSA MicroLink ISDN/MC       */
 127 #define CARD_TYPEP_ELSAMLMCALL  17      /* ELSA MicroLink MCall         */
 128 #define CARD_TYPEP_ITKIX1       18      /* ITK ix1 micro                */
 129 #define CARD_TYPEP_AVMA1PCI     19      /* AVM FRITZ!CARD PCI           */
 130 #define CARD_TYPEP_PCC16        20      /* ELSA PCC-16                  */
 131 #define CARD_TYPEP_AVM_PNP      21      /* AVM FRITZ!CARD PnP           */
 132 #define CARD_TYPEP_SIE_ISURF2   22      /* Siemens I-Surf 2 PnP         */
 133 #define CARD_TYPEP_ASUSCOMIPAC  23      /* Asuscom ISDNlink 128 K PnP   */
 134 #define CARD_TYPEP_WINB6692     24      /* Winbond W6692 based          */
 135 #define CARD_TYPEP_16_3C        25      /* Teles S0/16.3c PnP (HFC-S/SP */
 136 #define CARD_TYPEP_ACERP10      26      /* Acer ISDN P10 (HFC-S)        */
 137 #define CARD_TYPEP_TELEINT_NO_1 27      /* TELEINT ISDN SPEED No. 1 (HFC-1) */
 138 #define CARD_TYPEP_CCD_HFCS_PCI 28      /* Cologne Chip HFC-S PCI based */
 139 #define CARD_TYPEP_NETJET_S     29      /* Traverse NetJet-S (Tiger300) */
 140 #define CARD_TYPEP_DIVA_ISA     30      /* Eicon DIVA ISA PnP 2.0 or 2.02 */
 141 #define CARD_TYPEP_COMPAQ_M610  31      /* Compaq Microcom 610          */
 142 #define CARD_TYPEP_AVMA1PCI_V2  32      /* AVM FRITZ!CARD PCI Ver. 2    */
 143 /*
 144  * in case you add support for more cards, please update:
 145  *
 146  *      isdnd:          controller.c, name_of_controller()
 147  *
 148  * and adjust CARD_TYPEP_MAX below.
 149  */
 150
 151 #define CARD_TYPEP_MAX          32      /* max type */
 152
 153 /*---------------------------------------------------------------------------*
 154  *      card types for CTRL_DAIC
 155  *---------------------------------------------------------------------------*/
 156 #define CARD_TYPEA_DAIC_UNK     0
 157 #define CARD_TYPEA_DAIC_S       1
 158 #define CARD_TYPEA_DAIC_SX      2
 159 #define CARD_TYPEA_DAIC_SCOM    3
 160 #define CARD_TYPEA_DAIC_QUAD    4
 161
 162 /*---------------------------------------------------------------------------*
 163  *      card types for CTRL_CAPI
 164  *---------------------------------------------------------------------------*/
 165 #define CARD_TYPEC_CAPI_UNK     0
 166 #define CARD_TYPEC_AVM_T1_PCI   1
 167 #define CARD_TYPEC_AVM_B1_PCI   2
 168 #define CARD_TYPEC_AVM_B1_ISA   3
 169
 170 /*---------------------------------------------------------------------------*
 171  *      max length of some strings
 172  *---------------------------------------------------------------------------*/
 173 #define TELNO_MAX       41  /* max length of a telephone number (+ '\0')  */
 174 #define DISPLAY_MAX     91  /* max length of display information (+ '\0') */
 175 #define DATETIME_MAX    21  /* max length of datetime information (+ '\0')*/
 176 #define KEYPAD_MAX      35  /* max length of a keypad string (+ '\0')     */
 177
 178 /*---------------------------------------------------------------------------*
 179  *      in case the src or dst telephone number is empty
 180  *---------------------------------------------------------------------------*/
 181 #define TELNO_EMPTY     "NotAvailable"
 182
 183 /*---------------------------------------------------------------------------*
 184  *      B channel parameters
 185  *---------------------------------------------------------------------------*/
 186 #define BCH_MAX_DATALEN 2048    /* max length of a B channel frame */
 187
 188 /*---------------------------------------------------------------------------*
 189  * userland driver types
 190  * ---------------------
 191  * a "driver" is defined here as a piece of software interfacing an
 192  * ISDN B channel with a userland service, such as IP, Telephony etc.
 193  *---------------------------------------------------------------------------*/
 194 #define BDRV_RBCH       0       /* raw b-channel interface driver       */
 195 #define BDRV_TEL        1       /* telephone (speech) interface driver  */
 196 #define BDRV_IPR        2       /* IP over raw HDLC interface driver    */
 197 #define BDRV_ISPPP      3       /* sync Kernel PPP interface driver     */
 198 #define BDRV_IBC        4       /* BSD/OS point to point driver         */
 199 #define BDRV_ING        5       /* NetGraph ing driver                  */
 200
 201 /*---------------------------------------------------------------------------*
 202  * B channel protocol
 203  *---------------------------------------------------------------------------*/
 204 #define BPROT_NONE      0       /* no protocol at all, raw data         */
 205 #define BPROT_RHDLC     1       /* raw HDLC: flag, data, crc, flag      */
 206
 207 /*---------------------------------------------------------------------------*
 208  * causes data type
 209  *---------------------------------------------------------------------------*/
 210 typedef unsigned int cause_t;           /* 32 bit unsigned int  */
 211
 212 /*---------------------------------------------------------------------------*
 213  * call descriptor id (cdid) definitions
 214  *---------------------------------------------------------------------------*/
 215 #define CDID_UNUSED     0       /* cdid is invalid and unused           */
 216 #define CDID_MAX        99999   /* highest valid cdid, wraparound to 1  */
 217
 218 /*---------------------------------------------------------------------------*
 219  *      The shorthold algorithm to use
 220  *---------------------------------------------------------------------------*/
 221 #define SHA_FIXU        0    /* timeout algorithm for fix unit charging */
 222 #define SHA_VARU        1    /* timeout algorithm for variable unit charging */
 223
 224 /*---------------------------------------------------------------------------*
 225  *      The shorthold data struct
 226  *---------------------------------------------------------------------------*/
 227 typedef struct {
 228         int     shorthold_algorithm;    /* shorthold algorithm to use   */
 229         int     unitlen_time;           /* length of a charging unit    */
 230         int     idle_time;              /* time without activity on b ch*/
 231         int     earlyhup_time;          /* safety area at end of unit   */
 232 } msg_shorthold_t;
 233
 234
 235 /****************************************************************************
 236
 237         outgoing call:
 238         --------------
 239
 240                 userland                kernel
 241                 --------                ------
 242
 243                 CDID_REQ ----------------->
 244
 245                     <------------------ cdid
 246
 247                 CONNECT_REQ -------------->
 248
 249                     <------------------ PROCEEDING_IND (if connect req ok)
 250
 251                     <------------------ CONNECT_ACTIVE_IND (if connection ok)
 252
 253                 or
 254
 255                     <------------------ DISCONNECT_IND (if connection failed)
 256
 257
 258
 259         incoming call:
 260         --------------
 261
 262                 userland                kernel
 263                 --------                ------
 264
 265                     <------------------ CONNECT_IND
 266
 267                 CONNECT_RESP ------------->
 268
 269                     <------------------ CONNECT_ACTIVE_IND (if accepted)
 270
 271
 272
 273         active disconnect:
 274         ------------------
 275
 276                 userland                kernel
 277                 --------                ------
 278
 279                 DISCONNECT_REQ ------------>
 280
 281                     <------------------ DISCONNECT_IND
 282
 283
 284         passive disconnect:
 285         -------------------
 286
 287                 userland                kernel
 288                 --------                ------
 289
 290                     <------------------ DISCONNECT_IND
 291
 292
 293 ****************************************************************************/
 294
 295
 296 /*===========================================================================*
 297  *===========================================================================*
 298  *      "read" messages from kernel -> userland
 299  *===========================================================================*
 300  *===========================================================================*/
 301
 302
 303 /*---------------------------------------------------------------------------*
 304  *      message header, included in every message
 305  *---------------------------------------------------------------------------*/
 306 typedef struct {
 307         char            type;           /* message identifier           */
 308 #define MSG_CONNECT_IND         'a'
 309 #define MSG_CONNECT_ACTIVE_IND  'b'
 310 #define MSG_DISCONNECT_IND      'c'
 311 #define MSG_DIALOUT_IND         'd'
 312 #define MSG_IDLE_TIMEOUT_IND    'e'
 313 #define MSG_ACCT_IND            'f'
 314 #define MSG_CHARGING_IND        'g'
 315 #define MSG_PROCEEDING_IND      'h'
 316 #define MSG_ALERT_IND           'i'
 317 #define MSG_DRVRDISC_REQ        'j'
 318 #define MSG_L12STAT_IND         'k'
 319 #define MSG_TEIASG_IND          'l'
 320 #define MSG_PDEACT_IND          'm'
 321 #define MSG_NEGCOMP_IND         'n'
 322 #define MSG_IFSTATE_CHANGED_IND 'o'
 323 #define MSG_DIALOUTNUMBER_IND   'p'
 324 #define MSG_PACKET_IND          'q'
 325 #define MSG_KEYPAD_IND          'r'
 326         int             cdid;           /* call descriptor id           */
 327 } msg_hdr_t;
 328
 329 /*---------------------------------------------------------------------------*
 330  *      connect indication
 331  *              indicates incoming connection
 332  *---------------------------------------------------------------------------*/
 333 typedef struct {
 334         msg_hdr_t       header;         /* common header                */
 335         int             controller;     /* controller number            */
 336         int             channel;        /* channel number               */
 337 #define  CHAN_B1  0             /* this _must_ be 0, HSCX B1 is also 0  */
 338 #define  CHAN_B2  1             /* this _must_ be 1, HSCX B2 is also 1  */
 339 #define  CHAN_ANY (-1)          /* outgoing, not possible for incoming  */
 340 #define  CHAN_NO  (-2)          /* call waiting (CW) for incoming       */
 341         int             bprot;  /* b channel protocot, see BPROT_XXX    */
 342         char            dst_telno[TELNO_MAX];   /* destination telno    */
 343         char            src_telno[TELNO_MAX];   /* source telno         */
 344         int             scr_ind;/* screening indicator                  */
 345 #define  SCR_NONE     0         /* no screening indicator transmitted   */
 346 #define  SCR_USR_NOSC 1         /* screening user provided, not screened*/
 347 #define  SCR_USR_PASS 2         /* screening user provided, verified & passed */
 348 #define  SCR_USR_FAIL 3         /* screening user provided, verified & failed */
 349 #define  SCR_NET      4         /* screening network provided           */
 350         int             prs_ind;/* presentation indicator               */
 351 #define  PRS_NONE     0         /* no presentation indicator transmitted*/
 352 #define  PRS_ALLOWED  1         /* presentation allowed                 */
 353 #define  PRS_RESTRICT 2         /* presentation restricted              */
 354 #define  PRS_NNINTERW 3         /* number not available due to interworking */
 355 #define  PRS_RESERVED 4         /* reserved                             */
 356         char            display[DISPLAY_MAX];   /* content of display IE*/
 357 } msg_connect_ind_t;
 358
 359 /*---------------------------------------------------------------------------*
 360  *      connect active indication
 361  *              indicates active connection
 362  *---------------------------------------------------------------------------*/
 363 typedef struct {
 364         msg_hdr_t       header;         /* common header                   */
 365         int             controller;     /* controller number actually used */
 366         int             channel;        /* channel number actually used    */
 367         char            datetime[DATETIME_MAX]; /* content of date/time IE */
 368 } msg_connect_active_ind_t;
 369
 370 /*---------------------------------------------------------------------------*
 371  *      disconnect indication
 372  *              indicates a disconnect
 373  *---------------------------------------------------------------------------*/
 374 typedef struct {
 375         msg_hdr_t       header;         /* common header        */
 376         cause_t         cause;          /* cause code           */
 377 } msg_disconnect_ind_t;
 378
 379 /*---------------------------------------------------------------------------*
 380  *      negotiation complete
 381  *              indicates an interface is completely up & running
 382  *---------------------------------------------------------------------------*/
 383 typedef struct {
 384         msg_hdr_t       header;         /* common header        */
 385 } msg_negcomplete_ind_t;
 386
 387 /*---------------------------------------------------------------------------*
 388  *      interface changes internal state
 389  *              indicates an interface has somehow switched its FSM
 390  *---------------------------------------------------------------------------*/
 391 typedef struct {
 392         msg_hdr_t       header;         /* common header        */
 393         int state;                      /* new interface state */
 394 } msg_ifstatechg_ind_t;
 395
 396 /*---------------------------------------------------------------------------*
 397  *      initiate a call to a remote site
 398  *              i.e. the IP driver got a packet and wants a connection
 399  *---------------------------------------------------------------------------*/
 400 typedef struct {
 401         msg_hdr_t       header;         /* common header        */
 402         int             driver;         /* driver type          */
 403         int             driver_unit;    /* driver unit number   */
 404 } msg_dialout_ind_t;
 405
 406 /*---------------------------------------------------------------------------*
 407  *      dial a number
 408  *---------------------------------------------------------------------------*/
 409 typedef struct {
 410         msg_hdr_t       header;         /* common header        */
 411         int             driver;         /* driver type          */
 412         int             driver_unit;    /* driver unit number   */
 413         int             cmdlen;         /* length of string     */
 414         char            cmd[TELNO_MAX]; /* the number to dial   */
 415 } msg_dialoutnumber_ind_t;
 416
 417 /*---------------------------------------------------------------------------*
 418  *      send keypad string
 419  *---------------------------------------------------------------------------*/
 420 typedef struct {
 421         msg_hdr_t       header;         /* common header        */
 422         int             driver;         /* driver type          */
 423         int             driver_unit;    /* driver unit number   */
 424         int             cmdlen;         /* length of string     */
 425         char            cmd[KEYPAD_MAX];/* keypad string        */
 426 } msg_keypad_ind_t;
 427
 428 /*---------------------------------------------------------------------------*
 429  *      idle timeout disconnect sent indication
 430  *              kernel has sent disconnect request because of b-ch idle
 431  *---------------------------------------------------------------------------*/
 432 typedef struct {
 433         msg_hdr_t       header;         /* common header        */
 434 } msg_idle_timeout_ind_t;
 435
 436 /*---------------------------------------------------------------------------*
 437  *      accounting information from userland interface driver to daemon
 438  *---------------------------------------------------------------------------*/
 439 typedef struct {
 440         msg_hdr_t       header;         /* common header                */
 441         int             accttype;       /* accounting type              */
 442 #define  ACCT_DURING 0
 443 #define  ACCT_FINAL  1
 444         int             driver;         /* driver type                  */
 445         int             driver_unit;    /* driver unit number           */
 446         int             ioutbytes;      /* ISDN # of bytes sent         */
 447         int             iinbytes;       /* ISDN # of bytes received     */
 448         int             outbps;         /* bytes per sec out            */
 449         int             inbps;          /* bytes per sec in             */
 450         int             outbytes;       /* driver # of bytes sent       */
 451         int             inbytes;        /* driver # of bytes received   */
 452 } msg_accounting_ind_t;
 453
 454 /*---------------------------------------------------------------------------*
 455  *      charging information from isdn driver to daemon
 456  *---------------------------------------------------------------------------*/
 457 typedef struct {
 458         msg_hdr_t       header;         /* common header                */
 459         int             units;          /* number of units              */
 460         int             units_type;     /* type of units info           */
 461 #define  CHARGE_INVALID 0       /* invalid, unknown */
 462 #define  CHARGE_AOCD    1       /* advice of charge during call */
 463 #define  CHARGE_AOCE    2       /* advice of charge at end of call */
 464 #define  CHARGE_CALC    3       /* locally calculated from rates information */
 465 } msg_charging_ind_t;
 466
 467 /*---------------------------------------------------------------------------*
 468  *      call proceeding indication
 469  *              indicates outgoing SETUP has been acknowleged
 470  *---------------------------------------------------------------------------*/
 471 typedef struct {
 472         msg_hdr_t       header;         /* common header                   */
 473         int             controller;     /* controller number actually used */
 474         int             channel;        /* channel number actually used    */
 475 } msg_proceeding_ind_t;
 476
 477 /*---------------------------------------------------------------------------*
 478  *      alert indication
 479  *              indicates remote user side "rings"
 480  *---------------------------------------------------------------------------*/
 481 typedef struct {
 482         msg_hdr_t       header;         /* common header                   */
 483 } msg_alert_ind_t;
 484
 485 /*---------------------------------------------------------------------------*
 486  *      driver requests to disconnect line
 487  *---------------------------------------------------------------------------*/
 488 typedef struct {
 489         msg_hdr_t       header;         /* common header        */
 490         int             driver;         /* driver type          */
 491         int             driver_unit;    /* driver unit number   */
 492 } msg_drvrdisc_req_t;
 493
 494 /*---------------------------------------------------------------------------*
 495  *      connect packet logging
 496  *---------------------------------------------------------------------------*/
 497
 498 typedef struct {
 499         msg_hdr_t       header;         /* common header        */
 500         int             driver;         /* driver type          */
 501         int             driver_unit;    /* driver unit number   */
 502         int             direction;      /* 0=in 1=out           */
 503 #define DIRECTION_IN    0               /* sending packet to remote     */
 504 #define DIRECTION_OUT   1               /* received packet from remote  */
 505 #define MAX_PACKET_LOG  40              /* space for IP and TCP header  */
 506         u_int8_t        pktdata[MAX_PACKET_LOG];
 507 } msg_packet_ind_t;
 508
 509 /*---------------------------------------------------------------------------*
 510  *      state of layer 1/2
 511  *---------------------------------------------------------------------------*/
 512 typedef struct {
 513         msg_hdr_t       header;         /* common header        */
 514         int             controller;     /* controller unit      */
 515         int             layer;          /* layer number (1/2)   */
 516 #define LAYER_ONE       1
 517 #define LAYER_TWO       2
 518         int             state;          /* state info           */
 519 #define LAYER_IDLE      0
 520 #define LAYER_ACTIVE    1
 521 } msg_l12stat_ind_t;
 522
 523 /*---------------------------------------------------------------------------*
 524  *      TEI assignment messages
 525  *---------------------------------------------------------------------------*/
 526 typedef struct {
 527         msg_hdr_t       header;         /* common header        */
 528         int             controller;     /* controller unit      */
 529         int             tei;            /* TEI or -1 if invalid */
 530 } msg_teiasg_ind_t;
 531
 532 /*---------------------------------------------------------------------------*
 533  *      persistent deactivation state of stack
 534  *---------------------------------------------------------------------------*/
 535 typedef struct {
 536         msg_hdr_t       header;         /* common header        */
 537         int             controller;     /* controller unit      */
 538         int             numactive;      /* number of active connections */
 539 } msg_pdeact_ind_t;
 540
 541
 542 /*===========================================================================*
 543  *===========================================================================*
 544  *      "ioctl" messages from userland -> kernel
 545  *===========================================================================*
 546  *===========================================================================*/
 547
 548 /*---------------------------------------------------------------------------*
 549  *      request a unique cdid (to setup an outgoing call)
 550  *---------------------------------------------------------------------------*/
 551 typedef struct {
 552         int             cdid;                   /* call descriptor id   */
 553 } msg_cdid_req_t;
 554
 555 #define I4B_CDID_REQ            _IOWR('4', 0, int)
 556
 557 /*---------------------------------------------------------------------------*
 558  *      connect request
 559  *              requests an outgoing connection
 560  *---------------------------------------------------------------------------*/
 561 typedef struct {
 562         int             cdid;           /* call descriptor id                */
 563         int             controller;     /* controller to use                 */
 564         int             channel;        /* channel to use                    */
 565         int             txdelay;        /* tx delay after connect            */
 566         int             bprot;          /* b channel protocol                */
 567         int             driver;         /* driver to route b channel data to */
 568         int             driver_unit;    /*      unit number for above driver */
 569         msg_shorthold_t shorthold_data; /* the shorthold data                */
 570         int             unitlen_method; /* how to calculate the unitlength   */
 571 #define  ULEN_METHOD_STATIC  0  /* use unitlen_time value (see above) */
 572 #define  ULEN_METHOD_DYNAMIC 1  /* use AOCD */
 573         char            dst_telno[TELNO_MAX];   /* destination telephone no  */
 574         char            src_telno[TELNO_MAX];   /* source telephone number   */
 575         char            keypad[KEYPAD_MAX];     /* keypad string             */
 576 } msg_connect_req_t;
 577
 578 #define I4B_CONNECT_REQ _IOW('4', 1, msg_connect_req_t)
 579
 580 /*---------------------------------------------------------------------------*
 581  *      connect response
 582  *              this is the answer to an incoming connect indication
 583  *---------------------------------------------------------------------------*/
 584 typedef struct {
 585         int     cdid;           /* call descriptor id                   */
 586         int     response;       /* what to do with incoming call        */
 587 #define  SETUP_RESP_DNTCRE 0    /* dont care, call is not for me        */
 588 #define  SETUP_RESP_REJECT 1    /* reject call                          */
 589 #define  SETUP_RESP_ACCEPT 2    /* accept call                          */
 590         cause_t cause;          /* cause for case SETUP_RESP_REJECT     */
 591                 /* the following are only used for SETUP_RESP_ACCEPT !! */
 592         int     txdelay;        /* tx delay after connect               */
 593         int     bprot;          /* B chan protocol                      */
 594         int     driver;         /* driver to route b channel data to    */
 595         int     driver_unit;    /*      unit number for above driver    */
 596         int     max_idle_time;  /* max time without activity on b ch    */
 597 } msg_connect_resp_t;
 598
 599 #define I4B_CONNECT_RESP        _IOW('4', 2, msg_connect_resp_t)
 600
 601 /*---------------------------------------------------------------------------*
 602  *      disconnect request
 603  *              active disconnect request
 604  *---------------------------------------------------------------------------*/
 605 typedef struct {
 606         int     cdid;           /* call descriptor id                   */
 607         cause_t cause;          /* protocol independent cause           */
 608 } msg_discon_req_t;
 609
 610 #define I4B_DISCONNECT_REQ      _IOW('4', 3, msg_discon_req_t)
 611
 612 /*---------------------------------------------------------------------------*
 613  *      controller info request
 614  *---------------------------------------------------------------------------*/
 615 typedef struct {
 616         int     controller;     /* controller number                    */
 617         int     ncontroller;    /* number of controllers in system      */
 618         int     ctrl_type;      /* controller type passive/active       */
 619         int     card_type;      /* brand / version                      */
 620         int     tei;            /* tei controller probably has          */
 621         int     nbch;           /* number of b channels provided        */
 622 } msg_ctrl_info_req_t;
 623
 624 #define I4B_CTRL_INFO_REQ       _IOWR('4', 4, msg_ctrl_info_req_t)
 625
 626 /*---------------------------------------------------------------------------*
 627  *      dialout response
 628  *              status report to driver who requested a dialout
 629  *---------------------------------------------------------------------------*/
 630 typedef struct {
 631         int             driver;         /* driver to route b channel data to */
 632         int             driver_unit;    /*      unit number for above driver */
 633         int             stat;           /* state of dialout request          */
 634 #define  DSTAT_NONE     0
 635 #define  DSTAT_TFAIL    1               /* transient failure */
 636 #define  DSTAT_PFAIL    2               /* permanent failure */
 637 #define  DSTAT_INONLY   3               /* no outgoing dials allowed */
 638         cause_t         cause;          /* exact i4b cause */
 639 } msg_dialout_resp_t;
 640
 641 #define I4B_DIALOUT_RESP        _IOW('4', 5, msg_dialout_resp_t)
 642
 643 /*---------------------------------------------------------------------------*
 644  *      timeout value update
 645  *---------------------------------------------------------------------------*/
 646 typedef struct {
 647         int     cdid;           /* call descriptor id                   */
 648         msg_shorthold_t shorthold_data;
 649 } msg_timeout_upd_t;
 650
 651 #define I4B_TIMEOUT_UPD         _IOW('4', 6, msg_timeout_upd_t)
 652
 653 /*---------------------------------------------------------------------------*
 654  *      soft enable/disable
 655  *---------------------------------------------------------------------------*/
 656 typedef struct {
 657         int             driver;         /* driver to route b channel data to */
 658         int             driver_unit;    /*      unit number for above driver */
 659         int             updown;         /* what to do                        */
 660 #define  SOFT_ENA       0       /* enable interface */
 661 #define  SOFT_DIS       1       /* disable interface */
 662 } msg_updown_ind_t;
 663
 664 #define I4B_UPDOWN_IND          _IOW('4', 7, msg_updown_ind_t)
 665
 666 /*---------------------------------------------------------------------------*
 667  *      send alert request
 668  *---------------------------------------------------------------------------*/
 669 typedef struct {
 670         int     cdid;           /* call descriptor id                   */
 671 } msg_alert_req_t;
 672
 673 #define I4B_ALERT_REQ           _IOW('4', 8, msg_alert_req_t)
 674
 675 /*---------------------------------------------------------------------------*
 676  *      request version and release info from kernel part
 677  *      (msg_vr_req_t is also used by tel & rbch drivers)
 678  *---------------------------------------------------------------------------*/
 679 typedef struct {
 680         int     version;        /* version number */
 681         int     release;        /* release number */
 682         int     step;           /* release step number */
 683 } msg_vr_req_t;
 684
 685 #define I4B_VR_REQ              _IOR('4', 9, msg_vr_req_t)
 686
 687 /*---------------------------------------------------------------------------*
 688  *      set ISDN protocol used by a controller
 689  *---------------------------------------------------------------------------*/
 690 typedef struct {
 691         int     controller;     /* controller number            */
 692         int     protocol;       /* ISDN D-channel protocol type */
 693 } msg_prot_ind_t;
 694
 695 #define I4B_PROT_IND            _IOW('4', 10, msg_prot_ind_t)
 696
 697 /*---------------------------------------------------------------------------*
 698  *      Protocol download to active cards
 699  *---------------------------------------------------------------------------*/
 700 struct isdn_dr_prot {
 701         size_t bytecount;       /* length of code */
 702         u_int8_t *microcode;    /* pointer to microcode */
 703 };
 704
 705 struct isdn_download_request {
 706         int controller;         /* controller number */
 707         int numprotos;          /* number of protocols in 'protocols' */
 708         struct isdn_dr_prot *protocols;
 709 };
 710
 711 #define I4B_CTRL_DOWNLOAD       _IOW('4', 100, struct isdn_download_request)
 712
 713 /*---------------------------------------------------------------------------*
 714  *      Generic diagnostic interface for active cards
 715  *---------------------------------------------------------------------------*/
 716 struct isdn_diagnostic_request {
 717         int controller;         /* controller number */
 718         u_int32_t cmd;          /* diagnostic command to execute */
 719         size_t in_param_len;    /* length of additional input parameter */
 720 #define I4B_ACTIVE_DIAGNOSTIC_MAXPARAMLEN       65536
 721         void *in_param;         /* optional input parameter */
 722         size_t out_param_len;   /* available output space */
 723         void *out_param;        /* output data goes here */
 724 };
 725
 726 #define I4B_ACTIVE_DIAGNOSTIC   _IOW('4', 102, struct isdn_diagnostic_request)
 727
 728 #endif /* _I4B_IOCTL_H_ */