sys/i4b/layer2/i4b_l2.h

   1 /*
   2  * Copyright (c) 1997, 1999 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_l2.h - ISDN layer 2 (Q.921) definitions
  28  *      ---------------------------------------------
  29  *
  30  *      $Id: i4b_l2.h,v 1.20 1999/12/13 21:25:27 hm Exp $
  31  *
  32  * $FreeBSD$
  33  *
  34  *      last edit-date: [Mon Dec 13 22:03:29 1999]
  35  *
  36  *---------------------------------------------------------------------------*/
  37
  38 #ifndef _I4B_L2_H_
  39 #define _I4B_L2_H_
  40
  41 typedef struct {
  42         int     unit;           /* unit number this entry is for */
  43
  44         int     Q921_state;     /* state according to Q.921 */
  45
  46         u_char  last_ril;       /* last reference number from TEI management */
  47         u_char  last_rih;
  48
  49         int     tei_valid;      /* tei is valid flag */
  50 #define TEI_INVALID     0
  51 #define TEI_VALID       1
  52         int     tei;            /* tei, if tei flag valid */
  53
  54         int     ph_active;      /* Layer 1 active flag */
  55 #define PH_INACTIVE     0       /* layer 1 inactive */
  56 #define PH_ACTIVEPEND   1       /* already tried to activate */
  57 #define PH_ACTIVE       2       /* layer 1 active */
  58
  59         int     T200;           /* Multiframe timeout timer */
  60         int     T201;           /* min time between TEI ID check */
  61         int     T202;           /* min time between TEI ID Req messages */
  62         int     N202;           /* TEI ID Req tx counter */
  63         void(*T202func)(void *);/* function to be called when T202 expires */
  64         int     T203;           /* max line idle time */
  65
  66 #if defined(__FreeBSD__)
  67         struct  callout_handle T200_callout;
  68         struct  callout_handle T202_callout;
  69         struct  callout_handle T203_callout;
  70         struct  callout_handle IFQU_callout;
  71 #endif
  72
  73 /*
  74  * i4b_iframe.c, i4b_i_frame_queued_up(): value of IFQU_DLY
  75  * some experimentation Gary did showed a minimal value of (hz/20) was
  76  * possible to let this work, Gary suggested using (hz/10) but i settled
  77  * down to using (hz/5) for now (-hm).
  78  */
  79 #define IFQU_DLY (hz/5)         /* reschedule I-FRAME-QUEUED-UP 0.2 sec */
  80
  81         int     vr;             /* receive sequence frame counter */
  82         int     vs;             /* transmit sequence frame counter */
  83         int     va;             /* acknowledge sequence frame counter */
  84
  85         int     ack_pend;       /* acknowledge pending */
  86         int     rej_excpt;      /* reject exception */
  87         int     peer_busy;      /* peer receiver busy */
  88         int     own_busy;       /* own receiver busy */
  89         int     l3initiated;    /* layer 3 initiated */
  90
  91         struct ifqueue i_queue; /* queue of outgoing i frames */
  92 #define IQUEUE_MAXLEN   20
  93
  94         /* this implementation only supports a k-value of 1 !!! */
  95         struct mbuf *ua_frame;  /* last unacked frame */
  96         int     ua_num;         /* last unacked frame number */
  97 #define UA_EMPTY (-1)           /* ua_frame is unused   */
  98
  99         int     rxd_CR;         /* received Command Response bit */
 100         int     rxd_PF;         /* received Poll/Final bit */
 101         int     rxd_NR;         /* received N(R) field */
 102         int     RC;             /* Retry Counter */
 103
 104         int     iframe_sent;    /* check if i frame acked by another i frame */
 105
 106         int (*postfsmfunc)(int);/* function to be called at fsm exit */
 107         int     postfsmarg;     /* argument for above function */
 108
 109         /* statistics */
 110
 111         lapdstat_t      stat;   /* lapd protocol statistics */
 112
 113 } l2_softc_t;
 114
 115 extern l2_softc_t l2_softc[];
 116
 117 /* Q.912 system parameters (Q.921 03/93 pp 43) */
 118
 119 #define MAX_K_VALUE     1       /* BRI - # of outstanding frames        */
 120
 121 #define N200    3               /* max no of retransmissions */
 122 #define N201DEF 260             /* max no of octetts in information field */
 123 #define N202DEF 3               /* max no of TEI ID Request message transmissions */
 124
 125 #define T200DEF (hz*1)          /* default T200 timer value = 1 second  */
 126 #define T201DEF T200DEF         /* default T201 timer value = T200DEF   */
 127 #define T202DEF (hz*2)          /* default T202 timer value = 2 seconds */
 128 #define T203DEF (hz*10)         /* default T203 timer value = 10 seconds*/
 129
 130 /* modulo 128 operations */
 131
 132 #define M128INC(v)      (v)++;          \
 133                         if((v)>127)     \
 134                         {               \
 135                                 v = 0;  \
 136                         }
 137
 138 #define M128DEC(v)      (v)--;          \
 139                         if((v)<0)       \
 140                         {               \
 141                                 v = 127;\
 142                         }
 143
 144 /* P-bit values */
 145
 146 typedef enum {
 147         P0,
 148         P1
 149 } pbit_t;
 150
 151 /* F-bit values */
 152
 153 typedef enum {
 154         F0,
 155         F1
 156 } fbit_t;
 157
 158 /* CR-bit values to NT */
 159
 160 typedef enum {
 161         CR_CMD_TO_NT,
 162         CR_RSP_TO_NT
 163 } crbit_to_nt_t;
 164
 165 /* CR-bit values from NT */
 166
 167 typedef enum {
 168         CR_RSP_FROM_NT,
 169         CR_CMD_FROM_NT
 170 } crbit_from_nt_t;
 171
 172 /* address field - octett 2 */
 173
 174 #define OFF_SAPI        0       /* SAPI offset, HDLC flag is eaten by L1 */
 175 #define SAPI_CCP        0       /* SAPI = 0 - call control procedures */
 176 #define SAPI_X25        16      /* SAPI = 16 - X.25 packet procedures */
 177 #define SAPI_L2M        63      /* SAPI = 63 - Layer 2 management procedures */
 178
 179 /* extract and insert macros for SAPI octett */
 180
 181 #define GETSAPI(octett)         (((octett) >> 2) & 0x3f)
 182 #define PUTSAPI(sapi,cr,octett) ((octett) = (((sapi << 2) & 0xfc) | ((cr & 0x01) << 1)))
 183 #define GETCR(octett)           (((octett) >> 1) & 0x01)
 184 #define GETEA(octett)           ((octett) & 0x01)
 185
 186 /* address field - octett 3 */
 187
 188 #define OFF_TEI         1       /* TEI offset */
 189 #define GETTEI(octett) (((octett) >> 1) & 0x7f)
 190 #define PUTTEI(tei, octett) ((octett) = ((((tei) << 1) & 0xfe)) | 0x01)
 191 #define GROUP_TEI       127     /* broadcast TEI for LME */
 192
 193 /* control field - octett 4 */
 194
 195 #define OFF_CNTL        2       /* 1st byte of control field */
 196
 197 /* S frames */
 198
 199 #define S_FRAME_LEN     4       /* lenght of a U-frame */
 200 #define OFF_SRCR        2       /* 1st byte of control field,   */
 201                                 /* R-commands and R-responses   */
 202 #define OFF_SNR         3       /* 2nd byte of control field, N(R) and PF */
 203 #define SPFBIT          0x01    /* poll/final bit mask */
 204 #define SPBITSET        SPFBIT
 205 #define SFBITSET        SPFBIT
 206 #define GETSNR(octett) (((octett) >> 1) & 0x7f)
 207 #define GETSPF(octett) ((octett) & SPFBIT)
 208 #define RR              0x01    /* RR and bit 0 set */
 209 #define RNR             0x05    /* RNR and bit 0 set */
 210 #define REJ             0x09    /* REJ and bit 0 set */
 211
 212 /* U frames */
 213
 214 #define UI_HDR_LEN      3       /* length of UI header in front of L3 frame */
 215 #define U_FRAME_LEN     3       /* lenght of a U-frame */
 216 #define UPFBIT          0x10    /* poll/final bit mask */
 217 #define UPBITSET        UPFBIT
 218 #define UFBITSET        UPFBIT
 219 #define GETUPF(octett) (((octett) >> 4) & 0x01)
 220
 221 /* commands/responses with pf bit set to 0 */
 222
 223 #define SABME           0x6f
 224 #define DM              0x0f
 225 #define UI              0x03
 226 #define DISC            0x43
 227 #define UA              0x63
 228 #define FRMR            0x87
 229 #define XID             0xaf
 230
 231 /* control field - octett 3 */
 232
 233 #define OFF_MEI         3       /* 2nd byte of control field */
 234
 235 /* control field - octett 4,5 */
 236
 237 #define OFF_RIL         4       /* Ri low byte */
 238 #define OFF_RIH         5       /* Ri high byte */
 239
 240 /* control field - octett 6 */
 241
 242 #define OFF_MT          6       /* Message Type */
 243 #define OFF_AI          7       /* Action Indicator  */
 244 #define GET_TEIFROMAI(octett) (((octett) >> 1) & 0x7f)
 245
 246 /* I frame */
 247
 248 #define I_HDR_LEN       4       /* length of I header in front of L3 frame */
 249 #define OFF_INS         2       /* transmit sequence number */
 250 #define OFF_INR         3       /* receive sequence number */
 251 #define IPFBIT          0x01    /* poll/final bit mask */
 252 #define IPBITSET        0x01
 253 #define GETINR(octett)  (((octett) >> 1) & 0x7f)
 254 #define GETINS(octett)  (((octett) >> 1) & 0x7f)
 255 #define GETIP(octett)   ((octett) & IPFBIT)
 256
 257 /* structure of a TEI management frame */
 258
 259 #define TEI_MGMT_FRM_LEN   8            /* frame length */
 260 #define TEIM_SAPIO      0x00            /* SAPI, CR, EA */
 261 #define TEIM_TEIO       0x01            /* TEI, EA */
 262 #define TEIM_UIO        0x02            /* frame type = UI = 0x03 */
 263 #define TEIM_MEIO       0x03            /* management entity id = 0x0f */
 264 #define         MEI     0x0f
 265 #define TEIM_RILO       0x04            /* reference number, low  */
 266 #define TEIM_RIHO       0x05            /* reference number, high */
 267 #define TEIM_MTO        0x06            /* message type */
 268 #define         MT_ID_REQEST    0x01
 269 #define         MT_ID_ASSIGN    0x02
 270 #define         MT_ID_DENY      0x03
 271 #define         MT_ID_CHK_REQ   0x04
 272 #define         MT_ID_CHK_RSP   0x05
 273 #define         MT_ID_REMOVE    0x06
 274 #define         MT_ID_VERIFY    0x07
 275 #define TEIM_AIO        0x07            /* action indicator */
 276
 277 /* i4b_mdl_error_ind codes */
 278
 279 enum MDL_ERROR_CODES {
 280         MDL_ERR_A,
 281         MDL_ERR_B,
 282         MDL_ERR_C,
 283         MDL_ERR_D,
 284         MDL_ERR_E,
 285         MDL_ERR_F,
 286         MDL_ERR_G,
 287         MDL_ERR_H,
 288         MDL_ERR_I,
 289         MDL_ERR_J,
 290         MDL_ERR_K,
 291         MDL_ERR_L,
 292         MDL_ERR_M,
 293         MDL_ERR_N,
 294         MDL_ERR_O,
 295         MDL_ERR_MAX
 296 };
 297
 298 /* forward decl */
 299
 300 extern void i4b_acknowledge_pending ( l2_softc_t *l2sc );
 301 extern struct mbuf * i4b_build_s_frame ( l2_softc_t *l2sc, crbit_to_nt_t crbit, pbit_t pbit, u_char type );
 302 extern struct mbuf * i4b_build_u_frame ( l2_softc_t *l2sc, crbit_to_nt_t crbit, pbit_t pbit, u_char type );
 303 extern void i4b_clear_exception_conditions ( l2_softc_t *l2sc );
 304 extern int i4b_dl_data_req ( int unit, struct mbuf *m );
 305 extern int i4b_dl_establish_req ( int unit );
 306 extern int i4b_dl_release_req ( int unit );
 307 extern int i4b_dl_unit_data_req ( int unit, struct mbuf *m );
 308 extern void i4b_enquiry_response ( l2_softc_t *l2sc );
 309 extern void i4b_establish_data_link ( l2_softc_t *l2sc );
 310 extern void i4b_invoke_retransmission ( l2_softc_t *l2sc, int nr );
 311 extern void i4b_i_frame_queued_up ( l2_softc_t *l2sc );
 312 extern void i4b_l1_activate ( l2_softc_t *l2sc );
 313 extern int i4b_l2_nr_ok ( int nr, int va, int vs );
 314 extern void i4b_make_rand_ri ( l2_softc_t *l2sc );
 315 extern void i4b_mdl_assign_ind ( l2_softc_t *l2sc );
 316 extern void i4b_mdl_error_ind ( l2_softc_t *l2sc, char *where, int errorcode );
 317 extern int i4b_mph_attach_ind ( int unit, int type );
 318 extern int i4b_mph_status_ind ( int unit, int status, int parm );
 319 extern void i4b_next_l2state ( l2_softc_t *l2sc, int event );
 320 extern void i4b_nr_error_recovery ( l2_softc_t *l2sc );
 321 extern int i4b_ph_activate_ind ( int unit );
 322 extern int i4b_ph_deactivate_ind ( int unit );
 323 extern int i4b_ph_data_ind ( int unit, struct mbuf *m );
 324 extern void i4b_print_frame ( int len, u_char *buf );
 325 extern char *i4b_print_l2state ( l2_softc_t *l2sc );
 326 extern void i4b_print_l2var ( l2_softc_t *l2sc );
 327 extern void i4b_rxd_ack(l2_softc_t *l2sc, int nr);
 328 extern void i4b_rxd_i_frame ( int unit, struct mbuf *m );
 329 extern void i4b_rxd_s_frame ( int unit, struct mbuf *m );
 330 extern void i4b_rxd_u_frame ( int unit, struct mbuf *m );
 331 extern void i4b_T200_restart ( l2_softc_t *l2sc );
 332 extern void i4b_T200_start ( l2_softc_t *l2sc );
 333 extern void i4b_T200_stop ( l2_softc_t *l2sc );
 334 extern void i4b_T202_start ( l2_softc_t *l2sc );
 335 extern void i4b_T202_stop ( l2_softc_t *l2sc );
 336 extern void i4b_T203_restart ( l2_softc_t *l2sc );
 337 extern void i4b_T203_start ( l2_softc_t *l2sc );
 338 extern void i4b_T203_stop ( l2_softc_t *l2sc );
 339 extern void i4b_tei_assign ( l2_softc_t *l2sc );
 340 extern void i4b_tei_chkresp ( l2_softc_t *l2sc );
 341 extern void i4b_tei_rxframe ( int unit, struct mbuf *m );
 342 extern void i4b_tei_verify ( l2_softc_t *l2sc );
 343 extern void i4b_transmit_enquire ( l2_softc_t *l2sc );
 344 extern void i4b_tx_disc ( l2_softc_t *l2sc, pbit_t pbit );
 345 extern void i4b_tx_dm ( l2_softc_t *l2sc, fbit_t fbit );
 346 extern void i4b_tx_frmr ( l2_softc_t *l2sc, fbit_t fbit );
 347 extern void i4b_tx_rej_response ( l2_softc_t *l2sc, fbit_t fbit );
 348 extern void i4b_tx_rnr_command ( l2_softc_t *l2sc, pbit_t pbit );
 349 extern void i4b_tx_rnr_response ( l2_softc_t *l2sc, fbit_t fbit );
 350 extern void i4b_tx_rr_command ( l2_softc_t *l2sc, pbit_t pbit );
 351 extern void i4b_tx_rr_response ( l2_softc_t *l2sc, fbit_t fbit );
 352 extern void i4b_tx_sabme ( l2_softc_t *l2sc, pbit_t pbit );
 353 extern void i4b_tx_ua ( l2_softc_t *l2sc, fbit_t fbit );
 354
 355 #endif /* _I4B_L2_H_ */