include/linux/mISDNif.h

   1 /*
   2  *
   3  * Author       Karsten Keil <kkeil@novell.com>
   4  *
   5  * Copyright 2008  by Karsten Keil <kkeil@novell.com>
   6  *
   7  * This code is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU LESSER GENERAL PUBLIC LICENSE
   9  * version 2.1 as published by the Free Software Foundation.
  10  *
  11  * This code is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU LESSER GENERAL PUBLIC LICENSE for more details.
  15  *
  16  */
  17
  18 #ifndef mISDNIF_H
  19 #define mISDNIF_H
  20
  21 #include <stdarg.h>
  22 #include <linux/types.h>
  23 #include <linux/errno.h>
  24 #include <linux/socket.h>
  25
  26 /*
  27  * ABI Version 32 bit
  28  *
  29  * <8 bit> Major version
  30  *              - changed if any interface become backwards incompatible
  31  *
  32  * <8 bit> Minor version
  33  *              - changed if any interface is extended but backwards compatible
  34  *
  35  * <16 bit> Release number
  36  *              - should be incremented on every checkin
  37  */
  38 #define MISDN_MAJOR_VERSION     1
  39 #define MISDN_MINOR_VERSION     1
  40 #define MISDN_RELEASE           20
  41
  42 /* primitives for information exchange
  43  * generell format
  44  * <16  bit  0 >
  45  * <8  bit command>
  46  *    BIT 8 = 1 LAYER private
  47  *    BIT 7 = 1 answer
  48  *    BIT 6 = 1 DATA
  49  * <8  bit target layer mask>
  50  *
  51  * Layer = 00 is reserved for general commands
  52    Layer = 01  L2 -> HW
  53    Layer = 02  HW -> L2
  54    Layer = 04  L3 -> L2
  55    Layer = 08  L2 -> L3
  56  * Layer = FF is reserved for broadcast commands
  57  */
  58
  59 #define MISDN_CMDMASK           0xff00
  60 #define MISDN_LAYERMASK         0x00ff
  61
  62 /* generell commands */
  63 #define OPEN_CHANNEL            0x0100
  64 #define CLOSE_CHANNEL           0x0200
  65 #define CONTROL_CHANNEL         0x0300
  66 #define CHECK_DATA              0x0400
  67
  68 /* layer 2 -> layer 1 */
  69 #define PH_ACTIVATE_REQ         0x0101
  70 #define PH_DEACTIVATE_REQ       0x0201
  71 #define PH_DATA_REQ             0x2001
  72 #define MPH_ACTIVATE_REQ        0x0501
  73 #define MPH_DEACTIVATE_REQ      0x0601
  74 #define MPH_INFORMATION_REQ     0x0701
  75 #define PH_CONTROL_REQ          0x0801
  76
  77 /* layer 1 -> layer 2 */
  78 #define PH_ACTIVATE_IND         0x0102
  79 #define PH_ACTIVATE_CNF         0x4102
  80 #define PH_DEACTIVATE_IND       0x0202
  81 #define PH_DEACTIVATE_CNF       0x4202
  82 #define PH_DATA_IND             0x2002
  83 #define PH_DATA_E_IND           0x3002
  84 #define MPH_ACTIVATE_IND        0x0502
  85 #define MPH_DEACTIVATE_IND      0x0602
  86 #define MPH_INFORMATION_IND     0x0702
  87 #define PH_DATA_CNF             0x6002
  88 #define PH_CONTROL_IND          0x0802
  89 #define PH_CONTROL_CNF          0x4802
  90
  91 /* layer 3 -> layer 2 */
  92 #define DL_ESTABLISH_REQ        0x1004
  93 #define DL_RELEASE_REQ          0x1104
  94 #define DL_DATA_REQ             0x3004
  95 #define DL_UNITDATA_REQ         0x3104
  96 #define DL_INFORMATION_REQ      0x0004
  97
  98 /* layer 2 -> layer 3 */
  99 #define DL_ESTABLISH_IND        0x1008
 100 #define DL_ESTABLISH_CNF        0x5008
 101 #define DL_RELEASE_IND          0x1108
 102 #define DL_RELEASE_CNF          0x5108
 103 #define DL_DATA_IND             0x3008
 104 #define DL_UNITDATA_IND         0x3108
 105 #define DL_INFORMATION_IND      0x0008
 106
 107 /* intern layer 2 managment */
 108 #define MDL_ASSIGN_REQ          0x1804
 109 #define MDL_ASSIGN_IND          0x1904
 110 #define MDL_REMOVE_REQ          0x1A04
 111 #define MDL_REMOVE_IND          0x1B04
 112 #define MDL_STATUS_UP_IND       0x1C04
 113 #define MDL_STATUS_DOWN_IND     0x1D04
 114 #define MDL_STATUS_UI_IND       0x1E04
 115 #define MDL_ERROR_IND           0x1F04
 116 #define MDL_ERROR_RSP           0x5F04
 117
 118 /* DL_INFORMATION_IND types */
 119 #define DL_INFO_L2_CONNECT      0x0001
 120 #define DL_INFO_L2_REMOVED      0x0002
 121
 122 /* PH_CONTROL types */
 123 /* TOUCH TONE IS 0x20XX  XX "0"..."9", "A","B","C","D","*","#" */
 124 #define DTMF_TONE_VAL           0x2000
 125 #define DTMF_TONE_MASK          0x007F
 126 #define DTMF_TONE_START         0x2100
 127 #define DTMF_TONE_STOP          0x2200
 128 #define DTMF_HFC_COEF           0x4000
 129 #define DSP_CONF_JOIN           0x2403
 130 #define DSP_CONF_SPLIT          0x2404
 131 #define DSP_RECEIVE_OFF         0x2405
 132 #define DSP_RECEIVE_ON          0x2406
 133 #define DSP_ECHO_ON             0x2407
 134 #define DSP_ECHO_OFF            0x2408
 135 #define DSP_MIX_ON              0x2409
 136 #define DSP_MIX_OFF             0x240a
 137 #define DSP_DELAY               0x240b
 138 #define DSP_JITTER              0x240c
 139 #define DSP_TXDATA_ON           0x240d
 140 #define DSP_TXDATA_OFF          0x240e
 141 #define DSP_TX_DEJITTER         0x240f
 142 #define DSP_TX_DEJ_OFF          0x2410
 143 #define DSP_TONE_PATT_ON        0x2411
 144 #define DSP_TONE_PATT_OFF       0x2412
 145 #define DSP_VOL_CHANGE_TX       0x2413
 146 #define DSP_VOL_CHANGE_RX       0x2414
 147 #define DSP_BF_ENABLE_KEY       0x2415
 148 #define DSP_BF_DISABLE          0x2416
 149 #define DSP_BF_ACCEPT           0x2416
 150 #define DSP_BF_REJECT           0x2417
 151 #define DSP_PIPELINE_CFG        0x2418
 152 #define HFC_VOL_CHANGE_TX       0x2601
 153 #define HFC_VOL_CHANGE_RX       0x2602
 154 #define HFC_SPL_LOOP_ON         0x2603
 155 #define HFC_SPL_LOOP_OFF        0x2604
 156
 157 /* DSP_TONE_PATT_ON parameter */
 158 #define TONE_OFF                        0x0000
 159 #define TONE_GERMAN_DIALTONE            0x0001
 160 #define TONE_GERMAN_OLDDIALTONE         0x0002
 161 #define TONE_AMERICAN_DIALTONE          0x0003
 162 #define TONE_GERMAN_DIALPBX             0x0004
 163 #define TONE_GERMAN_OLDDIALPBX          0x0005
 164 #define TONE_AMERICAN_DIALPBX           0x0006
 165 #define TONE_GERMAN_RINGING             0x0007
 166 #define TONE_GERMAN_OLDRINGING          0x0008
 167 #define TONE_AMERICAN_RINGPBX           0x000b
 168 #define TONE_GERMAN_RINGPBX             0x000c
 169 #define TONE_GERMAN_OLDRINGPBX          0x000d
 170 #define TONE_AMERICAN_RINGING           0x000e
 171 #define TONE_GERMAN_BUSY                0x000f
 172 #define TONE_GERMAN_OLDBUSY             0x0010
 173 #define TONE_AMERICAN_BUSY              0x0011
 174 #define TONE_GERMAN_HANGUP              0x0012
 175 #define TONE_GERMAN_OLDHANGUP           0x0013
 176 #define TONE_AMERICAN_HANGUP            0x0014
 177 #define TONE_SPECIAL_INFO               0x0015
 178 #define TONE_GERMAN_GASSENBESETZT       0x0016
 179 #define TONE_GERMAN_AUFSCHALTTON        0x0016
 180
 181 /* MPH_INFORMATION_IND */
 182 #define L1_SIGNAL_LOS_OFF       0x0010
 183 #define L1_SIGNAL_LOS_ON        0x0011
 184 #define L1_SIGNAL_AIS_OFF       0x0012
 185 #define L1_SIGNAL_AIS_ON        0x0013
 186 #define L1_SIGNAL_RDI_OFF       0x0014
 187 #define L1_SIGNAL_RDI_ON        0x0015
 188 #define L1_SIGNAL_SLIP_RX       0x0020
 189 #define L1_SIGNAL_SLIP_TX       0x0021
 190
 191 /*
 192  * protocol ids
 193  * D channel 1-31
 194  * B channel 33 - 63
 195  */
 196
 197 #define ISDN_P_NONE             0
 198 #define ISDN_P_BASE             0
 199 #define ISDN_P_TE_S0            0x01
 200 #define ISDN_P_NT_S0            0x02
 201 #define ISDN_P_TE_E1            0x03
 202 #define ISDN_P_NT_E1            0x04
 203 #define ISDN_P_TE_UP0           0x05
 204 #define ISDN_P_NT_UP0           0x06
 205
 206 #define IS_ISDN_P_TE(p) ((p == ISDN_P_TE_S0) || (p == ISDN_P_TE_E1) || \
 207                                 (p == ISDN_P_TE_UP0) || (p == ISDN_P_LAPD_TE))
 208 #define IS_ISDN_P_NT(p) ((p == ISDN_P_NT_S0) || (p == ISDN_P_NT_E1) || \
 209                                 (p == ISDN_P_NT_UP0) || (p == ISDN_P_LAPD_NT))
 210 #define IS_ISDN_P_S0(p) ((p == ISDN_P_TE_S0) || (p == ISDN_P_NT_S0))
 211 #define IS_ISDN_P_E1(p) ((p == ISDN_P_TE_E1) || (p == ISDN_P_NT_E1))
 212 #define IS_ISDN_P_UP0(p) ((p == ISDN_P_TE_UP0) || (p == ISDN_P_NT_UP0))
 213
 214
 215 #define ISDN_P_LAPD_TE          0x10
 216 #define ISDN_P_LAPD_NT          0x11
 217
 218 #define ISDN_P_B_MASK           0x1f
 219 #define ISDN_P_B_START          0x20
 220
 221 #define ISDN_P_B_RAW            0x21
 222 #define ISDN_P_B_HDLC           0x22
 223 #define ISDN_P_B_X75SLP         0x23
 224 #define ISDN_P_B_L2DTMF         0x24
 225 #define ISDN_P_B_L2DSP          0x25
 226 #define ISDN_P_B_L2DSPHDLC      0x26
 227
 228 #define OPTION_L2_PMX           1
 229 #define OPTION_L2_PTP           2
 230 #define OPTION_L2_FIXEDTEI      3
 231 #define OPTION_L2_CLEANUP       4
 232
 233 /* should be in sync with linux/kobject.h:KOBJ_NAME_LEN */
 234 #define MISDN_MAX_IDLEN         20
 235
 236 struct mISDNhead {
 237         unsigned int    prim;
 238         unsigned int    id;
 239 }  __attribute__((packed));
 240
 241 #define MISDN_HEADER_LEN        sizeof(struct mISDNhead)
 242 #define MAX_DATA_SIZE           2048
 243 #define MAX_DATA_MEM            (MAX_DATA_SIZE + MISDN_HEADER_LEN)
 244 #define MAX_DFRAME_LEN          260
 245
 246 #define MISDN_ID_ADDR_MASK      0xFFFF
 247 #define MISDN_ID_TEI_MASK       0xFF00
 248 #define MISDN_ID_SAPI_MASK      0x00FF
 249 #define MISDN_ID_TEI_ANY        0x7F00
 250
 251 #define MISDN_ID_ANY            0xFFFF
 252 #define MISDN_ID_NONE           0xFFFE
 253
 254 #define GROUP_TEI               127
 255 #define TEI_SAPI                63
 256 #define CTRL_SAPI               0
 257
 258 #define MISDN_MAX_CHANNEL       127
 259 #define MISDN_CHMAP_SIZE        ((MISDN_MAX_CHANNEL + 1) >> 3)
 260
 261 #define SOL_MISDN       0
 262
 263 struct sockaddr_mISDN {
 264         sa_family_t    family;
 265         unsigned char   dev;
 266         unsigned char   channel;
 267         unsigned char   sapi;
 268         unsigned char   tei;
 269 };
 270
 271 struct mISDNversion {
 272         unsigned char   major;
 273         unsigned char   minor;
 274         unsigned short  release;
 275 };
 276
 277 struct mISDN_devinfo {
 278         u_int                   id;
 279         u_int                   Dprotocols;
 280         u_int                   Bprotocols;
 281         u_int                   protocol;
 282         u_char                  channelmap[MISDN_CHMAP_SIZE];
 283         u_int                   nrbchan;
 284         char                    name[MISDN_MAX_IDLEN];
 285 };
 286
 287 struct mISDN_devrename {
 288         u_int                   id;
 289         char                    name[MISDN_MAX_IDLEN]; /* new name */
 290 };
 291
 292 /* timer device ioctl */
 293 #define IMADDTIMER      _IOR('I', 64, int)
 294 #define IMDELTIMER      _IOR('I', 65, int)
 295
 296 /* socket ioctls */
 297 #define IMGETVERSION    _IOR('I', 66, int)
 298 #define IMGETCOUNT      _IOR('I', 67, int)
 299 #define IMGETDEVINFO    _IOR('I', 68, int)
 300 #define IMCTRLREQ       _IOR('I', 69, int)
 301 #define IMCLEAR_L2      _IOR('I', 70, int)
 302 #define IMSETDEVNAME    _IOR('I', 71, struct mISDN_devrename)
 303
 304 static inline int
 305 test_channelmap(u_int nr, u_char *map)
 306 {
 307         if (nr <= MISDN_MAX_CHANNEL)
 308                 return map[nr >> 3] & (1 << (nr & 7));
 309         else
 310                 return 0;
 311 }
 312
 313 static inline void
 314 set_channelmap(u_int nr, u_char *map)
 315 {
 316         map[nr >> 3] |= (1 << (nr & 7));
 317 }
 318
 319 static inline void
 320 clear_channelmap(u_int nr, u_char *map)
 321 {
 322         map[nr >> 3] &= ~(1 << (nr & 7));
 323 }
 324
 325 /* CONTROL_CHANNEL parameters */
 326 #define MISDN_CTRL_GETOP                0x0000
 327 #define MISDN_CTRL_LOOP                 0x0001
 328 #define MISDN_CTRL_CONNECT              0x0002
 329 #define MISDN_CTRL_DISCONNECT           0x0004
 330 #define MISDN_CTRL_PCMCONNECT           0x0010
 331 #define MISDN_CTRL_PCMDISCONNECT        0x0020
 332 #define MISDN_CTRL_SETPEER              0x0040
 333 #define MISDN_CTRL_UNSETPEER            0x0080
 334 #define MISDN_CTRL_RX_OFF               0x0100
 335 #define MISDN_CTRL_FILL_EMPTY           0x0200
 336 #define MISDN_CTRL_GETPEER              0x0400
 337 #define MISDN_CTRL_HW_FEATURES_OP       0x2000
 338 #define MISDN_CTRL_HW_FEATURES          0x2001
 339 #define MISDN_CTRL_HFC_OP               0x4000
 340 #define MISDN_CTRL_HFC_PCM_CONN         0x4001
 341 #define MISDN_CTRL_HFC_PCM_DISC         0x4002
 342 #define MISDN_CTRL_HFC_CONF_JOIN        0x4003
 343 #define MISDN_CTRL_HFC_CONF_SPLIT       0x4004
 344 #define MISDN_CTRL_HFC_RECEIVE_OFF      0x4005
 345 #define MISDN_CTRL_HFC_RECEIVE_ON       0x4006
 346 #define MISDN_CTRL_HFC_ECHOCAN_ON       0x4007
 347 #define MISDN_CTRL_HFC_ECHOCAN_OFF      0x4008
 348
 349
 350 /* socket options */
 351 #define MISDN_TIME_STAMP                0x0001
 352
 353 struct mISDN_ctrl_req {
 354         int             op;
 355         int             channel;
 356         int             p1;
 357         int             p2;
 358 };
 359
 360 /* muxer options */
 361 #define MISDN_OPT_ALL           1
 362 #define MISDN_OPT_TEIMGR        2
 363
 364 #ifdef __KERNEL__
 365 #include <linux/list.h>
 366 #include <linux/skbuff.h>
 367 #include <linux/net.h>
 368 #include <net/sock.h>
 369 #include <linux/completion.h>
 370
 371 #define DEBUG_CORE              0x000000ff
 372 #define DEBUG_CORE_FUNC         0x00000002
 373 #define DEBUG_SOCKET            0x00000004
 374 #define DEBUG_MANAGER           0x00000008
 375 #define DEBUG_SEND_ERR          0x00000010
 376 #define DEBUG_MSG_THREAD        0x00000020
 377 #define DEBUG_QUEUE_FUNC        0x00000040
 378 #define DEBUG_L1                0x0000ff00
 379 #define DEBUG_L1_FSM            0x00000200
 380 #define DEBUG_L2                0x00ff0000
 381 #define DEBUG_L2_FSM            0x00020000
 382 #define DEBUG_L2_CTRL           0x00040000
 383 #define DEBUG_L2_RECV           0x00080000
 384 #define DEBUG_L2_TEI            0x00100000
 385 #define DEBUG_L2_TEIFSM         0x00200000
 386 #define DEBUG_TIMER             0x01000000
 387 #define DEBUG_CLOCK             0x02000000
 388
 389 #define mISDN_HEAD_P(s)         ((struct mISDNhead *)&s->cb[0])
 390 #define mISDN_HEAD_PRIM(s)      (((struct mISDNhead *)&s->cb[0])->prim)
 391 #define mISDN_HEAD_ID(s)        (((struct mISDNhead *)&s->cb[0])->id)
 392
 393 /* socket states */
 394 #define MISDN_OPEN      1
 395 #define MISDN_BOUND     2
 396 #define MISDN_CLOSED    3
 397
 398 struct mISDNchannel;
 399 struct mISDNdevice;
 400 struct mISDNstack;
 401 struct mISDNclock;
 402
 403 struct channel_req {
 404         u_int                   protocol;
 405         struct sockaddr_mISDN   adr;
 406         struct mISDNchannel     *ch;
 407 };
 408
 409 typedef int     (ctrl_func_t)(struct mISDNchannel *, u_int, void *);
 410 typedef int     (send_func_t)(struct mISDNchannel *, struct sk_buff *);
 411 typedef int     (create_func_t)(struct channel_req *);
 412
 413 struct Bprotocol {
 414         struct list_head        list;
 415         char                    *name;
 416         u_int                   Bprotocols;
 417         create_func_t           *create;
 418 };
 419
 420 struct mISDNchannel {
 421         struct list_head        list;
 422         u_int                   protocol;
 423         u_int                   nr;
 424         u_long                  opt;
 425         u_int                   addr;
 426         struct mISDNstack       *st;
 427         struct mISDNchannel     *peer;
 428         send_func_t             *send;
 429         send_func_t             *recv;
 430         ctrl_func_t             *ctrl;
 431 };
 432
 433 struct mISDN_sock_list {
 434         struct hlist_head       head;
 435         rwlock_t                lock;
 436 };
 437
 438 struct mISDN_sock {
 439         struct sock             sk;
 440         struct mISDNchannel     ch;
 441         u_int                   cmask;
 442         struct mISDNdevice      *dev;
 443 };
 444
 445
 446
 447 struct mISDNdevice {
 448         struct mISDNchannel     D;
 449         u_int                   id;
 450         u_int                   Dprotocols;
 451         u_int                   Bprotocols;
 452         u_int                   nrbchan;
 453         u_char                  channelmap[MISDN_CHMAP_SIZE];
 454         struct list_head        bchannels;
 455         struct mISDNchannel     *teimgr;
 456         struct device           dev;
 457 };
 458
 459 struct mISDNstack {
 460         u_long                  status;
 461         struct mISDNdevice      *dev;
 462         struct task_struct      *thread;
 463         struct completion       *notify;
 464         wait_queue_head_t       workq;
 465         struct sk_buff_head     msgq;
 466         struct list_head        layer2;
 467         struct mISDNchannel     *layer1;
 468         struct mISDNchannel     own;
 469         struct mutex            lmutex; /* protect lists */
 470         struct mISDN_sock_list  l1sock;
 471 #ifdef MISDN_MSG_STATS
 472         u_int                   msg_cnt;
 473         u_int                   sleep_cnt;
 474         u_int                   stopped_cnt;
 475 #endif
 476 };
 477
 478 typedef int     (clockctl_func_t)(void *, int);
 479
 480 struct  mISDNclock {
 481         struct list_head        list;
 482         char                    name[64];
 483         int                     pri;
 484         clockctl_func_t         *ctl;
 485         void                    *priv;
 486 };
 487
 488 /* global alloc/queue functions */
 489
 490 static inline struct sk_buff *
 491 mI_alloc_skb(unsigned int len, gfp_t gfp_mask)
 492 {
 493         struct sk_buff  *skb;
 494
 495         skb = alloc_skb(len + MISDN_HEADER_LEN, gfp_mask);
 496         if (likely(skb))
 497                 skb_reserve(skb, MISDN_HEADER_LEN);
 498         return skb;
 499 }
 500
 501 static inline struct sk_buff *
 502 _alloc_mISDN_skb(u_int prim, u_int id, u_int len, void *dp, gfp_t gfp_mask)
 503 {
 504         struct sk_buff  *skb = mI_alloc_skb(len, gfp_mask);
 505         struct mISDNhead *hh;
 506
 507         if (!skb)
 508                 return NULL;
 509         if (len)
 510                 memcpy(skb_put(skb, len), dp, len);
 511         hh = mISDN_HEAD_P(skb);
 512         hh->prim = prim;
 513         hh->id = id;
 514         return skb;
 515 }
 516
 517 static inline void
 518 _queue_data(struct mISDNchannel *ch, u_int prim,
 519     u_int id, u_int len, void *dp, gfp_t gfp_mask)
 520 {
 521         struct sk_buff          *skb;
 522
 523         if (!ch->peer)
 524                 return;
 525         skb = _alloc_mISDN_skb(prim, id, len, dp, gfp_mask);
 526         if (!skb)
 527                 return;
 528         if (ch->recv(ch->peer, skb))
 529                 dev_kfree_skb(skb);
 530 }
 531
 532 /* global register/unregister functions */
 533
 534 extern int      mISDN_register_device(struct mISDNdevice *, char *name);
 535 extern void     mISDN_unregister_device(struct mISDNdevice *);
 536 extern int      mISDN_register_Bprotocol(struct Bprotocol *);
 537 extern void     mISDN_unregister_Bprotocol(struct Bprotocol *);
 538 extern struct mISDNclock *mISDN_register_clock(char *, int, clockctl_func_t *,
 539                                                 void *);
 540 extern void     mISDN_unregister_clock(struct mISDNclock *);
 541
 542 extern void     set_channel_address(struct mISDNchannel *, u_int, u_int);
 543 extern void     mISDN_clock_update(struct mISDNclock *, int, struct timeval *);
 544 extern unsigned short mISDN_clock_get(void);
 545
 546 #endif /* __KERNEL__ */
 547 #endif /* mISDNIF_H */