/********************************************************************20**
  
     Name:     system services interface
  
     Type:     C include file
  
     Desc:     Defines required by the system services service user.
  
     File:     ssi.h
  
     Sid:      ssi.h@@/main/85 - Tue Feb 27 09:27:50 2001

     Prg:      nkk
  
*********************************************************************21*/
  
#ifndef __SSIH__
#define __SSIH__


/*
*     The defines declared in this file correspond to defines
*     used by the following TRILLIUM software:
*
*     part no.                      description
*     --------    ----------------------------------------------
*     1000011     Multiprocessor Operating System
*     1000035     68302 MOS/SCC
*
*/

/*
*     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
*     1000014     Network Layer - X.25 End & Intermediate System
*     1000017     Data Link Layer - Basic Frame Relay
*     1000018     Data Link Layer - Extended Frame Relay
*     1000023     Network Layer - X.31
*     1000024     Signalling System 7 (SS7)
*     1000026     TCP/IP
*     1000027     Signalling System 7 - MTP Level 2
*     1000028     Signalling System 7 - MTP Level 3
*     1000029     Signalling System 7 - ISUP
*     1000030     Signalling System 7 - SCCP
*     1000031     Signalling System 7 - TCAP
*     1000034     Physical Layer - ISAC-S
*     1000040     UDP/IP
*     1000041     ESCC
*     1000042     Signalling System 7 - TUP
*     1000043     Network Layer - Q.93B
*     1000044     Data Link Layer - Q.SAAL
*     1000048     UNI Management Entity (UME)
*     1000050     LAN Emulation Client (LEC)
*     1000053     Data Link Layer - Q.2140
*     1000054     Data Link Layer - Q.2140
*     1000066     LAN Emulation Services (LEServices)
*     1000139     MPC860SAR driver
*
*/


/* defines */
  
/* order for SCatQueue */
  
#define Q1Q2        0                 /* Q1 in front of Q2 into Q1 */
#define Q2Q1        1                 /* Q2 in front of Q1 into Q1 */
  
/* order for SCatMsg */
  
#define M1M2        0                 /* M1 in front of M2 into M1 */
#define M2M1        1                 /* M2 in front of M1 into M1 */
  
/* period for SRegTmr */
  
#ifdef WINNT_IATM
#define PONE        1000              /* number of ticks to a second */
#else
#define PTENTH      1                 /* tenth of second */
#define PONE       10                 /* one second */
#define PTEN      100                 /* ten seconds */
#define PHUND    1000                 /* one hundred seconds */
#endif /* WINNT_IATM */  

/* reason for SActvInit and logRstHlt function */
  
#define NRM_TERM    0                 /* normal termination */
#define PWR_UP      1                 /* power up */
#define SWITCH      2                 /* switch depressed */
#define SW_ERROR    3                 /* software error */
#define DMT_FIRED   4                 /* deadman timer fired */
#define EXTERNAL    5                 /* external, another board */
#define SHUTDOWN    6                 /* shutdown interrupt */
  
/* To indicate how the data is to be attached */
#define PREBUF         0    /* pre buffer */
#define PSTBUF         1    /* post buffer */

/* return codes for all functions */
  
#define ROK         0                 /* ok */
#define RFAILED     1                 /* failed, general */
#define ROKDNA      2                 /* ok, data not available */
#define RNA         3                 /* failed, not available */
#define ROUTRES     4                 /* failed, out of resources */
#define ROKIGNORE   5                 /* ok, ignore */
#define RIGNORE     6                 /* failed, ignore */
#define ROKCRSIG    7                 /* ok, connect request (signal) */
#define ROKCRPRM    8                 /* ok, connect request (primitive) */
#define ROKDRSIG    9                 /* ok, disconnect request (signal) */
#define ROKDRPRM    10                /* ok, disconnect request (primitive) */
#define ROKDCPRM    11                /* ok, disconnect confirm (primitive) */
#define ROKDUP      12                /* ok, duplicate entry found */
#define RSKIP       13                /* ok, skip the token */
#define ROKDRPRMSP  14                /* ok, disconnect request (primitive)
                                       * with service provider conn. id.
                                       */
#define ROKDRPRMSU  15                /* ok, disconnect request (primitive)
                                       * with service user conn. id.
                                       */
#define ROKPENDING  16                /* OK - operation still pending */
#define RLONG       17                /* long */

#define RINPROGRESS 18                /* connection in progress: cm_inet */
#define RWOULDBLOCK 19                /* would block:   cm_inet */
#define RCLOSED     20                /* socket closed: cm_inet */
#define RTIMEOUT    21                /* timeout:       cm_inet */
#define RISCONN     22                /* connected :    cm_inet */

/* print buffer size */

#define PRNTSZE     255               /* print buffer size */

/* end of file */

#ifndef EOF
#define EOF         (-1)              /* end of file */
#endif

/* static buffer size calculations */

#ifdef MOSVER                         /* mos version */
#define MINBUFSIZE      (PTRALIGN(sizeof(Chain))+PTRALIGN(sizeof(MemoryId))+PTRALIGN(sizeof(S8))+PTRALIGN(sizeof(Size)))
#define SBUFSIZE(size)  (size < (Size) MINBUFSIZE ? (Size) MINBUFSIZE : PTRALIGN(size))
#else
#ifdef MSVER2                         /* mos version 2 */
#define MINBUFSIZE      (PTRALIGN(sizeof(SBuf)))
#define SBUFSIZE(size)  (size < (Size) MINBUFSIZE ? (Size) MINBUFSIZE : (Size)PTRALIGN(size))
#define SLockId           U8     /* lock type */
#define SInitLock(l, t)   ((*l) = ROK)
#define SLock(l)          ((*l) = ROK)
#define SUnlock(l)        ((*l) = ROK)
#define SDestroyLock(l)   ((*l) = ROK)
#else                                 /* default version */
#ifdef PS 
#define UNIT_HEAP_SIZE 32
#define SBUFSIZE(size)  (((size/UNIT_HEAP_SIZE) + 1) * UNIT_HEAP_SIZE)
#else
#ifdef MT                         /* multi-threaded */
#define MINBUFSIZE      sizeof(SBuf)
#define SBUFSIZE(size)  (size < (Size) MINBUFSIZE ? (Size) MINBUFSIZE : (Size)size)
#else
#define SBUFSIZE(size)  (size)
#endif /* MT */
#endif /* PS */
#endif /* MSVER2 */
#endif /* MOSVER */

/* maximum value for system timer used for wrap around counter */

/* note:  this value must agree with the current typedef for Ticks
   or timer wraparound and statistics based on duration may not work */

#define MAXTICKS   0xffffffff        /* maximum value for Tick */


/* error codes */

/* base plus offset is passed as first parameter to sError function */
/* ERRZERO is passed as second parameter to sError function if no */
/* additional information is available */  
  
#define ERRZERO        0            /* no additional information */


/* base error codes */

#define  ERRSS          0           /* system services */
#define  ERRLM        500           /* layer management */
#define  ERRAP       1000           /* async pad */
#define  ERRXN       2000           /* x.25/x.75 */
#define  ERRFM       3000           /* SS7 - Fault Manager*/
#define  ERRVX       3200           /* vrtxsa */
#define  ERRPS       3300           /* psos */
#define  ERRVW       3400           /* vxworks */
#define  ERRHE       3600           /* hello world */
#define  ERRWN       3600           /* MTP 3 Wrapper */
#define  ERRQI       3700           /* QUICC driver */
#define  ERRWI       3800           /* ISUP Wrapper */
#define  ERRWU       3900           /* TUP Wrapper */
#define  ERRLB       4000           /* lapb */
#define  ERRBD       4000           /* lapb, lapd, lapb/lapd */
#define  ERRSC       5000           /* scc */
#define  ERRMS       5500           /* mos */
#define  ERRSM       6500           /* stack manager - see below */
#define  ERRLL       8500           /* logical link control (obsolete) */
#define  ERRBI       8500           /* b-isup */
#define  ERRTC       8500           /* TCP/IP (obsolete) */
#define  ERRIX       9000           /* x.31 */
#define  ERRMF       9500           /* message functions */
#define  ERRAR       9600           /* arp (obsolete) */
#define  ERRMA       9600           /* ss7 - map */
#define  ERROD      10600           /* ODI mac */
#define  ERRSE      10700           /* sec */
#define  ERRSI      11000           /* ss7 - isup */
#define  ERRSN      12000           /* ss7 - mtp, level 3 */
#define  ERRSD      13000           /* ss7 - mtp, level 2 */
#define  ERRSA      13500           /* q.2140 */
#define  ERRIN      14000           /* q.930/q.931 */
#define  ERRIS      15000           /* siemens isac-s */
#define  ERRLC      15500           /* llc */
#define  ERRTP      16000           /* ss7 - tup */
#define  ERRCM      17000           /* common files */
#define  ERRST      18000           /* ss7 - tcap */
#define  ERRFN      18500           /* FN - Q.933 Frame Relay Network Layer */
#define  ERRSP      19000           /* ss7 - sccp */
#define  ERRME      20000           /* message exchange*/
#define  ERREV      20100           /* V5.1 Envelope Function */
#define  ERRNV      20500           /* V5.1 PSTN */
#define  ERRLV      20300           /* LAPV5-DL */
#define  ERRAC      21000           /* atm - cpcs */
#define  ERRAS      22000           /* atm - q.saal */
#define  ERRAM      23000           /* atm - q.93b */
#define  ERRM6      24000           /* dummy mac (MACINT6) */
#define  ERRPN      24500           /* PNNI */
#define  ERRUM      25000           /* atm - ume */
#define  ERRMU      26000           /* atm - management user */
#define  ERRFR      26100           /* Q.922 - frame data link */
#define  ERRMPOFR   26500           /* MPOFR - library error defines */
#define  ERRLR      27000           /* loader */
#define  ERRLU      28000           /* loader service user */
#define  ERRRY      29000           /* relay */
#define  ERROS      30000           /* OS library */
#define  ERREC      31000           /* ATM - LANE Client (LEC) */
#define  ERRES      31500           /* ATM - LANE Services (LEServices) */
#define  ERRTU      32000           /* TCAP - User */
#define  ERRFA      32200           /* ATM - Fujitsu ALC driver */
#define  ERRSR      32500           /* MTP Level 3 Simple Router */
#define  ERRPL      32700           /* ATM - PMC Sierra LASAR driver */
#define  ERRAF      33000           /* FR-ATM Interworking Layer */
#define  ERRCV      34000           /* Control Protocol */
#define  ERRMV      34200           /* V5.X System Manager layer */
#define  ERRCMDRV   34400           /* Common Driver */
#define  ERRPQ      34500           /* Power Quicc */
#define  ERRGL      34600           /* GPRS Logical Link Control */
#define  ERRVO      34700           /* Power Quicc II MPC8260 */
#define  ERRZP      34800           /* PSF - SCCP */
#define  ERRP1      34900           /* PLOA PXY dummy */

#define  ERRNEXT    ERRP1 + 100     /* Modify it to indicate how much you'll be
                                       using */

/* note: release 1.6 and earlier of q.930/q.931 used base code 1500 */

/* 
 * management interface error code bases
 *
 * ERRSM = 6500
 *
 * Each layer that uses this file need to reserve a range of errnos.
 * These errnos are used in stack management packing/unpaking routines, 
 * and also in primitives terminated by the stack manager.  
 *
 * The next base of error codes is ERRLL = 8500, so we have a range