/********************************************************************20**
  
     Name:     general layer
  
     Type:     C include file
  
     Desc:     Defines required by two or more layer service user
               interfaces.
   
     File:     gen.h
  
     Sid:      gen.h@@/main/89 - Tue Feb 27 09:27:43 2001
   
     Prg:      na
  
*********************************************************************21*/

#ifndef __GENH__
#define __GENH__

  
/*
*     The defines declared in this file correspond to defines
*     used by the following TRILLIUM software:
*
*     part no.                      description
*     --------    ----------------------------------------------
*     1000001     Physical Layer - SCC
*     1000002     Data Link Layer - LAPB
*     1000003     Data Link Layer - LAPD
*     1000004     Data Link Layer - Multilink
*     1000005     Data Link Layer - LAPB & LAPD
*     1000006     Network Layer - X.25 Intermediate System
*     1000007     Network Layer - X.25 End System
*     1000008     Network Layer - X.75
*     1000009     Network Layer - Q.930/Q.931
*     1000010     Application Layer - Asynchronous PAD
*     1000012     Spanning Tree
*     1000014     Network Layer - X.25 End & Intermediate System
*     1000016     Network Layer - ISO Internet Protocol - End System
*     1000017     Data Link Layer - Basic Frame Relay
*     1000018     Data Link Layer - Extended Frame Relay
*     1000019     Data Link Layer - Logical Link Control 1
*     1000020     Data Link Layer - Logical Link Control 2
*     1000021     Data Link Layer - Logical Link Control 3
*     1000022     Network Layer - ISO Internet Protocol - Intermediate System
*     1000023     Network Layer - X.31
*     1000024     Signalling System 7
*     1000026     TCP/IP
*     1000034     Physical Layer - ISAC-S
*     1000043     ATM - Q.93B
*     1000053     ATM - Fujitsu ALC driver
*     1000058     ATM - Fujitsu ITC driver
*     1000044     ATM - Q.SAAL
*
*/
  
/*
*     This software may be combined with the following TRILLIUM
*     software:
*
*     part no.                      description
*     --------    ----------------------------------------------
*     1000001     Physical Layer - SCC
*     1000002     Data Link Layer - LAPB
*     1000003     Data Link Layer - LAPD
*     1000004     Data Link Layer - Multilink
*     1000005     Data Link Layer - LAPB & LAPD
*     1000006     Network Layer - X.25 Intermediate System
*     1000007     Network Layer - X.25 End System
*     1000008     Network Layer - X.75
*     1000009     Network Layer - Q.930/Q.931
*     1000010     Application Layer - Asynchronous PAD
*     1000012     Spanning Tree
*     1000014     Network Layer - X.25 End & Intermediate System
*     1000016     Network Layer - ISO Internet Protocol - End System
*     1000017     Data Link Layer - Basic Frame Relay
*     1000018     Data Link Layer - Extended Frame Relay
*     1000019     Data Link Layer - Logical Link Control 1
*     1000020     Data Link Layer - Logical Link Control 2
*     1000021     Data Link Layer - Logical Link Control 3
*     1000022     Network Layer - ISO Internet Protocol - Intermediate System
*     1000023     Network Layer - X.31
*     1000024     Signalling System 7
*     1000034     Physical Layer - ISAC-S
*     1000043     ATM - Q.93B
*     1000044     ATM - Q.SAAL
*     1000053     ATM - Fujitsu ALC driver
*     1000058     ATM - Fujitsu ITC driver
*/

/* defines */

/* bndCfg.bufOwnshp for xxBndReq */

#define SUOWN         0     /* service user (upper layer) owns buffers */
#define SPOWN         1     /* service provider (lower layer) owns buffers */

/* bndCfg.flcTyp for xxBndReq */

#define FLCNOTALLOW   0     /* flow control not allowed */
#define FLCALLOW      1     /* flow control allowed */

/* bndCfg.wdw for xxBndReq */

#define WDWNOTALLOW   0     /* window not allowed */

/* state values (e.g., for an interface) */

#define STATE_DISCONNECTED   0x00     /* disconnected state */
#define STATE_CONNECTING     0x01     /* connecting state */
#define STATE_CONNECTED      0x02     /* connected state */
#define STATE_DISCONNECTING  0x03     /* disconnecting state */

/* Protocol Address Structure related defines ..*/
#define MAX_PROTADDR_LEN     16       /* Right now defined for IP, IPX 
                                       * and IPV6 
                                       */
#define MAX_PROT_ADDRS       4        /* Number of Protocols supported */

/* addrs structure for xxConReq, xxDiscReq, xxCfgReq */

#define ADRLEN        20    /* Address Length */
#define SHRTADRLEN    32    /* Short Addres Length */
#define LNGADRLEN     64    /* Long Address Length */

/* token or element header values */

#define NOTPRSNT       0    /* not present */
#define PRSNT_NODEF    1    /* present - no default */
#define PRSNT_DEF      2    /* present - default */

#define MF_SIZE_TKNSTRS  22 /* token string size - small */
#define MF_SIZE_TKNSTRM  32 /* token string size - medium */
#define MF_SIZE_TKNSTR  132 /* token string size - regular */
#define MF_SIZE_TKNSTRE 255 /* token string size - extra large */
#define MF_SIZE_TKNBITS 7   /* token bits size */
#define TP_SIZE_TKNSTR  8   /* token string size */

/* defines for type of service class */

#define FRMRLY         1     /* frame relay */
#define MACINT         2     /* mac interface */

/* defines for ISUP and B-ISUP  */


/* subsystem field */

#define SSF_INTER         0      /* international subsystem field */
#define SSF_NAT           2      /* national subsystem field */

#define PRI_ZERO          0      /* priority 0 - lowest */
#define PRI_ONE           1      /* priority 1 */
#define PRI_TWO           2      /* priority 2 */

/* direction of suspend */

#define FROM_LWR          1      /* direction from lower */
#define FROM_UPR          2      /* direction from upper */

#define MOD15             0x0f   /* modulo 15 mask */
#define NOTUSED           0      /* not used */

#define DIR_OUT           1
#define DIR_INC           2

#define PRESALLOW         0
#define PRESREST          1
#define MFROK             0
#define MFRFAILED         1
#define MFREOM            2

/* defines for ATM */

#ifndef CMFILE_REORG_1

/* special vcc's */

#define ATMVPI_SIG     0     /* Q.93B signalling */
#define ATMVCI_SIG     5     /* Q.93B signalling */

#define ATMVPI_ILMI    0     /* ILMI address registration */
#define ATMVCI_ILMI    16    /* ILMI address registration */

/* loss priority */

#define ATMLP_HIGH     0     /* high priority */
#define ATMLP_LOW      1     /* low priority */

/* congestion indication */

#define ATMCI_NOCONG   0     /* not congested */
#define ATMCI_CONG     1     /* congested */

/* reception status */

#define ATMRS_NOERROR  0     /* no error */
#define ATMRS_ERROR    1     /* error */

/* establishement */

#define AM_E_DEMAND       0x00  /* demand */

/* quality of service classes */

#define ATMQOS_CLASS0  0     /* QoS class 0 -unspecified QoS class*/
#define ATMQOS_CLASS1  1     /* QoS class 1 */
#define ATMQOS_CLASS2  2     /* QoS class 2 */
#define ATMQOS_CLASS3  3     /* QoS class 3 */
#define ATMQOS_CLASS4  4     /* QoS class 4 */

/* ATM traffic descriptor octet group identifiers */

#define AM_ATD_FPCR_ID0     0x82  /* forward  peak  cell rate id, CLP = 0   */
#define AM_ATD_BPCR_ID0     0x83  /* backward peak  cell rate id, CLP = 0   */
#define AM_ATD_FPCR_ID1     0x84  /* forward  peak  cell rate id, CLP = 0+1 */
#define AM_ATD_BPCR_ID1     0x85  /* backward peak  cell rate id, CLP = 0+1 */
#define AM_ATD_FSCR_ID0     0x88  /* forward  sust. cell rate id, CLP = 0   */
#define AM_ATD_BSCR_ID0     0x89  /* backward sust. cell rate id, CLP = 0   */
#define AM_ATD_FSCR_ID1     0x90  /* forward  sust. cell rate id, CLP = 0+1 */
#define AM_ATD_BSCR_ID1     0x91  /* backward sust. cell rate id, CLP = 0+1 */
#define AM_ATD_FMBS_ID0     0xa0  /* forward  mean burst size id, CLP = 0   */
#define AM_ATD_BMBS_ID0     0xa1  /* backward mean burst size id, CLP = 0   */
#define AM_ATD_FMBS_ID1     0xb0  /* forward  mean burst size id, CLP = 0+1 */
#define AM_ATD_BMBS_ID1     0xb1  /* backward mean burst size id, CLP = 0+1 */
#define AM_ATD_BSTEFFRTIND  0xbe  /* best effort indicator */
#define AM_ATD_TFCMGMTOPTID 0xbf  /* traffic management options id */

/* number of stop bits */

#define AM_NSB_UNUSED     0x00  /* none specified */
#define AM_NSB_1          0x01  /* 1 stop bit */
#define AM_NSB_15         0x02  /* 1.5 stop bits */
#define AM_NSB_2          0x03  /* 2 stop bits */

/* crankback blocked transit type */

#define AM_CBTT_BLKSUCCEND   0x02    /* call or party has been blocked at the succeeding end of this interface */
#define AM_CBTT_BLKNODE      0x03    /* blocked node */
#define AM_CBTT_BLKLINK      0x04    /* blocked link */

/* crankback cause indicator */

#define AM_CBCAUSE_IND       0x85    /* crankback cause indicator */

/* Cranckback and general cause values */

#define AM_CV_INVCAUSEVAL      0     /* invalid cause value - proprietary */
#define AM_CV_UNALLOCNMB       1     /* unallocated (unassigned) number */
#define AM_CV_NOROUTTRANSNET   2     /* no route to transit network */
#define AM_CV_NOROUTDST        3     /* no route to destination */
#define AM_CV_VCCUNACPT        10    /* UNI 3.0: VPCI/VCI unacceptable */
#define AM_CV_NORMCALLCLR      16    /* UNI 3.1: normal call clearing */
#define AM_CV_USRBUSY          17    /* user busy */
#define AM_CV_NOUSRRSP         18    /* no user response */
#define AM_CV_NOANSUSR         19    /* no answer from user */
#define AM_CV_CALLREJ          21    /* call rejected */
#define AM_CV_NMBCHNG          22    /* number changed */
#define AM_CV_CALLREJCLIR      23    /* user rejects all calls with CLIR */
#define AM_CV_DSTOUTORD        27    /* destination out of order */
#define AM_CV_INVNMBFORM       28    /* invalid number format */
#define AM_CV_RSPSTATENQ       30    /* response to STATUS ENQUIRY */
#define AM_CV_NORMUNSPEC       31    /* normal unspecified */
#define AM_CV_PNDADDPTYREQ     32    /* PNNI: too many pending add party requests */
#define AM_CV_CHNGINPGL        34    /* PNNI: Call cleared due to change in PGL */
#define AM_CV_REQVCCUNAVAIL    35    /* requested VPCI/VCI unavailable */
#define AM_CV_VCCFAIL          36    /* UNI 3.1: VPCI/VCI assignment failure */
#define AM_CV_RATEUNAVAIL1     37    /* UNI 3.1: user cell rate unavailable */
#define AM_CV_NETOUTORD        38    /* network out of order */
#define AM_CV_TMPFAIL          41    /* Temporary failure */
#define AM_CV_ACCINFODISC      43    /* access info discarded */
#define AM_CV_NOVCCAVAIL       45    /* no VPCI/VCI unavailable */
#define AM_CV_RESUNAVAIL       47    /* resources unavailable, unspecified */
#define AM_CV_QOSUNAVAIL       49    /* Quality of Service unavailable */
#define AM_CV_RATEUNAVAIL      51    /* UNI 3.0: user cell rate unavailable */
#define AM_CV_REQPVPCVCCUNAV   53    /* PNNI: Requested Called party soft PVPC/PVCC not available */
#define AM_CV_BCAPNOTAUTH      57    /* bearer capability not authorized */
#define AM_CV_BCAPUNAVAIL      58    /* bearer capability not available */
#define AM_CV_SRVUNAVAIL       63    /* Service or option unavailable */
#define AM_CV_BCAPNOTIMPL      65    /* bearer capability not implemented */
#define AM_CV_COMBUNSUPP       73    /* unsupported comb. of traffic parameters */
#define AM_CV_AALPARMUNSUPP1   78    /* UNI 3.1: AAL paramteres cannot be supported */
#define AM_CV_INVCALLREF       81    /* invalid call reference */
#define AM_CV_CHANNOTEXST      82    /* identified channel does not exist */
#define AM_CV_DSTNOTCOMP       88    /* incompatible destination */
#define AM_CV_INVENDPTREF      89    /* invalid endpoint reference */
#define AM_CV_INVTRANSNET      91    /* invalid transit network selection */
#define AM_CV_MANYADDPTYREQ    92    /* too many add party requests */