1 /******************************************************************************
2 
3   FileName:         5ESS.h
4 
5   Contents:         Header and definition for the AT&T 5ESS ISDN dialect. The
6                     header contains the following parts:
7 
8                     - Definition of codes
9                     - Definition of information elements (5ESSie_).
10                     - Definition of messages (5ESSmes_).
11                     - Function prototypes.
12 
13   Description:      The AT&T 5ESS ISDN dialect here covers ????
14 
15   Related Files:    5ESS.h              AT&T 5ESS ISDN Definitions
16                     5ESSie.c            AT&T 5ESS ISDN IE encoders/coders (not extant yet)
17                                         See Q931ie.c for IE encoders/coders
18                     5ESSStateTE.c       AT&T 5ESS ISDN TE State Engine
19                     5ESSStateNT.c       AT&T 5ESS ISDN NT State Engine
20 
21   License/Copyright:
22 
23   Copyright (c) 2007, Jan Vidar Berger, Case Labs, Ltd. All rights reserved.
24   email:janvb@caselaboratories.com
25 
26   Copyright (c) 2007, Michael Jerris. All rights reserved.
27   email:mike@jerris.com
28 
29   Copyright (c) 2007, Michael S. Collins, All rights reserved.
30   email:mcollins@fcnetwork.com
31 
32   Redistribution and use in source and binary forms, with or without
33   modification, are permitted provided that the following conditions are
34   met:
35 
36     * Redistributions of source code must retain the above copyright notice,
37     this list of conditions and the following disclaimer.
38     * Redistributions in binary form must reproduce the above copyright notice,
39     this list of conditions and the following disclaimer in the documentation
40     and/or other materials provided with the distribution.
41     * Neither the name of the Case Labs, Ltd nor the names of its contributors
42     may be used to endorse or promote products derived from this software
43     without specific prior written permission.
44 
45   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
46   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
49   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
50   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
53   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
55   POSSIBILITY OF SUCH DAMAGE.
56 ******************************************************************************/
57 
58 #ifndef _5ESS_NL
59 #define _5ESS_NL
60 
61 #include "Q931.h"
62 
63 /*****************************************************************************
64 
65   Q.931 Message codes
66   Only 5ESS specific message and ie types
67   here the rest are inherited from Q931.h
68 
69 *****************************************************************************/
70 
71 
72 /*****************************************************************************
73 
74   Q.931 Message Pack/Unpack functions. Implemented in 5ESSmes.c
75   Note: Because C variables may not begin with numeric digit, all identifiers
76         are prefixed with "ATT5ESS" instead of a bare "5ESS"
77 
78 *****************************************************************************/
79 L3INT ATT5ESSUmes_Setup(Q931_TrunkInfo_t *pTrunk, L3UCHAR *IBuf, Q931mes_Generic *OBuf, L3INT IOff, L3INT Size);
80 L3INT ATT5ESSPmes_Setup(Q931_TrunkInfo_t *pTrunk, Q931mes_Generic *IBuf, L3INT ISize, L3UCHAR *OBuf, L3INT *OSize);
81 L3INT ATT5ESSUmes_SetupAck(Q931_TrunkInfo_t *pTrunk, L3UCHAR *IBuf, Q931mes_Generic *OBuf, L3INT IOff, L3INT Size);
82 L3INT ATT5ESSPmes_SetupAck(Q931_TrunkInfo_t *pTrunk, Q931mes_Generic *IBuf, L3INT ISize, L3UCHAR *OBuf, L3INT *OSize);
83 
84 L3INT ATT5ESSUmes_0x07(Q931_TrunkInfo_t *pTrunk, L3UCHAR *IBuf, Q931mes_Generic *mes, L3INT IOff, L3INT Size);
85 L3INT ATT5ESSPmes_0x07(Q931_TrunkInfo_t *pTrunk, Q931mes_Generic *IBuf, L3INT ISize, L3UCHAR *OBuf, L3INT *OSize);
86 L3INT ATT5ESSUmes_0x0f(Q931_TrunkInfo_t *pTrunk, L3UCHAR *IBuf, Q931mes_Generic *mes, L3INT IOff, L3INT Size);
87 L3INT ATT5ESSPmes_0x0f(Q931_TrunkInfo_t *pTrunk, Q931mes_Generic *IBuf, L3INT ISize, L3UCHAR *OBuf, L3INT *OSize);
88 
89 
90 
91 /*****************************************************************************
92 
93   Q.931 Process Function Prototyping. Implemented in 5ESSStateTE.c
94 
95 *****************************************************************************/
96 L3INT ATT5ESSProc0x0fTE(Q931_TrunkInfo_t *pTrunk, L3UCHAR * buf, L3INT iFrom);
97 L3INT ATT5ESSProc0x07TE(Q931_TrunkInfo_t *pTrunk, L3UCHAR * buf, L3INT iFrom);
98 
99 
100 void ATT5ESSCreateTE(L3UCHAR i);
101 void ATT5ESSCreateNT(L3UCHAR i);
102 
103 #endif /* _5ESS_NL */
104