isupi.h

OpenSS7 This the fourth public release of the OpenSS7 Master Package. See README in the release for

/*****************************************************************************

 @(#) isupi.h,v 0.9.2.4 2006/10/31 21:04:37 brian Exp

 -----------------------------------------------------------------------------

 Copyright (c) 2001-2006  OpenSS7 Corporation <http://www.openss7.com/>
 Copyright (c) 1997-2001  Brian F. G. Bidulock <[e-mail]>

 All Rights Reserved.

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free Software
 Foundation; version 2 of the License.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 details.

 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc., 675 Mass
 Ave, Cambridge, MA 02139, USA.

 -----------------------------------------------------------------------------

 U.S. GOVERNMENT RESTRICTED RIGHTS.  If you are licensing this Software on
 behalf of the U.S. Government ("Government"), the following provisions apply
 to you.  If the Software is supplied by the Department of Defense ("DoD"), it
 is classified as "Commercial Computer Software" under paragraph 252.227-7014
 of the DoD Supplement to the Federal Acquisition Regulations ("DFARS") (or any
 successor regulations) and the Government is acquiring only the license rights
 granted herein (the license rights customarily provided to non-Government
 users).  If the Software is supplied to any unit or agency of the Government
 other than DoD, it is classified as "Restricted Computer Software" and the
 Government's rights in the Software are defined in paragraph 52.227-19 of the
 Federal Acquisition Regulations ("FAR") (or any successor regulations) or, in
 the cases of NASA, in paragraph 18.52.227-86 of the NASA Supplement to the FAR
 (or any successor regulations).

 -----------------------------------------------------------------------------

 Commercial licensing and support of this software is available from OpenSS7
 Corporation at a fee.  See http://www.openss7.com/

 -----------------------------------------------------------------------------

 Last Modified 2006/10/31 21:04:37 by brian

 -----------------------------------------------------------------------------

 isupi.h,v
 Revision 0.9.2.4  2006/10/31 21:04:37  brian
 - changes for 32-bit compatibility and remove HZ dependency

 *****************************************************************************/

#ifndef __SS7_ISUPI_H__
#define __SS7_ISUPI_H__

#ident "@(#) isupi.h,v openss7-0_9_2_E(0.9.2.4) Copyright (c) 2001-2006 OpenSS7 Corporation."

/* This file can be processed by doxygen(1). */

/*
 *  ISUP addresss
 */

typedef struct isup_addr {
	cc_ulong scope;			/* the scope of the identifier */
	cc_ulong id;			/* the identifier within the scope */
	cc_ulong cic;			/* circuit identification code within the scope */
} isup_addr_t;

#define ISUP_SCOPE_CT		1	/* circuit scope */
#define ISUP_SCOPE_CG		2	/* circuit group scope */
#define ISUP_SCOPE_TG		3	/* trunk group scope */
#define ISUP_SCOPE_SR		4	/* signalling relation scope */
#define ISUP_SCOPE_SP		5	/* signalling point scope */
#define ISUP_SCOPE_DF		6	/* default scope */
#define ISUP_SCOPE_CIC		7	/* for unidentified cic addresses */

/*
 *  Definitions for CCI for Q.764 Conforming CCS Providers.
 */

enum {
	ISUP_INCOMING_INTERNATIONAL_EXCHANGE = 0x00000001UL,
	ISUP_SUSPEND_NATIONALLY_PERFORMED = 0x00000002UL,
};

enum {
	CMS_IDLE = 0,
	CMS_WCON_BLREQ,
	CMS_WRES_BLIND,
	CMS_WACK_BLRES,
	CMS_WCON_UBREQ,
	CMS_WRES_UBIND,
	CMS_WACK_UBRES,
	CMS_WCON_RESREQ,
	CMS_WRES_RESIND,
	CMS_WACK_RESRES,
	CMS_WCON_QRYREQ,
	CMS_WRES_QRYIND,
	CMS_WACK_QRYRES,
};

enum {
	CKS_IDLE = 0,
	CKS_WIND_CONT,
	CKS_WRES_CONT,
	CKS_WIND_CTEST,
	CKS_WREQ_CTEST,
	CKS_WIND_CCREP,
	CKS_WREQ_CCREP,
	CKS_WCON_RELREQ,
	CKS_WRES_RELIND,
};

/*
 *  Circuit States:
 */
#define CTS_ICC			0x00000010
#define CTS_OGC			0x00000020
#define CTS_COT			0x00000040
#define CTS_LPA			0x00000080
#define CTS_COR			0x00000100
#define CTS_MASK		0x0000000f

#define CTS_DIRECTION(__val)	(__val & (CTS_ICC|CTS_OGC))
#define CTS_CONT_CHECK(__val)	(__val & (CTS_COT|CTS_LPA|CTS_COR))
#define CTS_MESSAGE(__val)	(__val & CTS_MASK)

#define CTS_IDLE		0x00000000
#define CTS_WAIT_IAM		0x00000001
#define CTS_WAIT_CCR		0x00000002
#define CTS_WAIT_LPA		0x00000003
#define CTS_WAIT_SAM		0x00000004
#define CTS_WAIT_ACM		0x00000005
#define CTS_WAIT_ANM		0x00000006
#define CTS_ANSWERED		0x00000007
#define CTS_SUSPENDED		0x00000008
#define CTS_WAIT_RLC		0x00000009
#define CTS_SEND_RLC		0x0000000a

#define CTS_ICC_WAIT_COT_CCR	( CTS_ICC | CTS_COT | CTS_WAIT_CCR )
#define CTS_OGC_WAIT_COT_CCR	( CTS_OGC | CTS_COT | CTS_WAIT_CCR )
#define CTS_ICC_WAIT_LPA_CCR	( CTS_ICC | CTS_LPA | CTS_WAIT_CCR )
#define CTS_OGC_WAIT_LPA_CCR	( CTS_OGC | CTS_LPA | CTS_WAIT_CCR )
#define CTS_ICC_WAIT_CCR	( CTS_ICC | CTS_WAIT_CCR )
#define CTS_OGC_WAIT_CCR	( CTS_OGC | CTS_WAIT_CCR )
#define CTS_ICC_WAIT_COR_SAM	( CTS_ICC | CTS_COR | CTS_WAIT_SAM )
#define CTS_OGC_WAIT_COR_SAM	( CTS_OGC | CTS_COR | CTS_WAIT_SAM )
#define CTS_ICC_WAIT_COT_SAM	( CTS_ICC | CTS_COT | CTS_WAIT_SAM )
#define CTS_OGC_WAIT_COT_SAM	( CTS_OGC | CTS_COT | CTS_WAIT_SAM )
#define CTS_ICC_WAIT_LPA_SAM	( CTS_ICC | CTS_LPA | CTS_WAIT_SAM )
#define CTS_OGC_WAIT_LPA_SAM	( CTS_OGC | CTS_LPA | CTS_WAIT_SAM )
#define CTS_ICC_WAIT_SAM	( CTS_ICC | CTS_WAIT_SAM )
#define CTS_OGC_WAIT_SAM	( CTS_OGC | CTS_WAIT_SAM )
#define CTS_ICC_WAIT_COR_ACM	( CTS_ICC | CTS_COR | CTS_WAIT_ACM )
#define CTS_OGC_WAIT_COR_ACM	( CTS_OGC | CTS_COR | CTS_WAIT_ACM )
#define CTS_ICC_WAIT_COT_ACM	( CTS_ICC | CTS_COT | CTS_WAIT_ACM )
#define CTS_OGC_WAIT_COT_ACM	( CTS_OGC | CTS_COT | CTS_WAIT_ACM )
#define CTS_ICC_WAIT_LPA_ACM	( CTS_ICC | CTS_LPA | CTS_WAIT_ACM )
#define CTS_OGC_WAIT_LPA_ACM	( CTS_OGC | CTS_LPA | CTS_WAIT_ACM )
#define CTS_ICC_WAIT_ACM	( CTS_ICC | CTS_WAIT_ACM )
#define CTS_OGC_WAIT_ACM	( CTS_OGC | CTS_WAIT_ACM )
#define CTS_ICC_WAIT_ANM	( CTS_ICC | CTS_WAIT_ANM )
#define CTS_OGC_WAIT_ANM	( CTS_OGC | CTS_WAIT_ANM )
#define CTS_ICC_ANSWERED	( CTS_ICC | CTS_ANSWERED )
#define CTS_OGC_ANSWERED	( CTS_OGC | CTS_ANSWERED )
#define CTS_ICC_SUSPENDED	( CTS_ICC | CTS_SUSPENDED )
#define CTS_OGC_SUSPENDED	( CTS_OGC | CTS_SUSPENDED )
#define CTS_ICC_WAIT_RLC	( CTS_ICC | CTS_WAIT_RLC )
#define CTS_OGC_WAIT_RLC	( CTS_OGC | CTS_WAIT_RLC )
#define CTS_ICC_SEND_RLC	( CTS_ICC | CTS_SEND_RLC )
#define CTS_OGC_SEND_RLC	( CTS_OGC | CTS_SEND_RLC )

/*
 *  Circuit, Group and MTP Flags
 */
#define CCTF_LOC_M_BLOCKED		0x00000001UL
#define CCTF_REM_M_BLOCKED		0x00000002UL
#define CCTF_LOC_H_BLOCKED		0x00000004UL
#define CCTF_REM_H_BLOCKED		0x00000008UL
#define CCTF_LOC_M_BLOCK_PENDING	0x00000010UL
#define CCTF_REM_M_BLOCK_PENDING	0x00000020UL
#define CCTF_LOC_H_BLOCK_PENDING	0x00000040UL
#define CCTF_REM_H_BLOCK_PENDING	0x00000080UL
#define CCTF_LOC_M_UNBLOCK_PENDING	0x00000100UL
#define CCTF_REM_M_UNBLOCK_PENDING	0x00000200UL
#define CCTF_LOC_H_UNBLOCK_PENDING	0x00000400UL
#define CCTF_REM_H_UNBLOCK_PENDING	0x00000800UL
#define CCTF_LOC_RESET_PENDING		0x00001000UL
#define CCTF_REM_RESET_PENDING		0x00002000UL
#define CCTF_LOC_QUERY_PENDING		0x00004000UL
#define CCTF_REM_QUERY_PENDING		0x00008000UL
#define CCTF_ORIG_SUSPENDED		0x00010000UL
#define CCTF_TERM_SUSPENDED		0x00020000UL
#define CCTF_UPT_PENDING		0x00040000UL
#define CCTF_LOC_S_BLOCKED		0x00080000UL
#define CCTF_LOC_G_BLOCK_PENDING	0x00100000UL
#define CCTF_REM_G_BLOCK_PENDING	0x00200000UL
#define CCTF_LOC_G_UNBLOCK_PENDING	0x00400000UL
#define CCTF_REM_G_UNBLOCK_PENDING	0x00800000UL
#define CCTF_COR_PENDING		0x01000000UL
#define CCTF_COT_PENDING		0x02000000UL
#define CCTF_LPA_PENDING		0x04000000UL

#define CCTM_OUT_OF_SERVICE	( \
					CCTF_LOC_S_BLOCKED | \
					CCTF_REM_M_BLOCKED | \
					CCTF_REM_H_BLOCKED | \
					CCTF_REM_M_BLOCK_PENDING | \
					CCTF_REM_H_BLOCK_PENDING | \
					CCTF_REM_G_BLOCK_PENDING | \
					CCTF_LOC_RESET_PENDING | \
					CCTF_REM_RESET_PENDING | \
					0 \
				)

#define CCTM_CONT_CHECK		( \
					CCTF_COR_PENDING | \
					CCTF_COT_PENDING | \
					CCTF_LPA_PENDING | \
					0 \
				)

/*
   Cause values for CC_CALL_REATTEMPT_IND 
 */
/*
   Cause values -- Q.764 conforming 
 */
#define ISUP_REATTEMPT_DUAL_SIEZURE		1UL
#define ISUP_REATTEMPT_RESET			2UL
#define ISUP_REATTEMPT_BLOCKING			3UL
#define ISUP_REATTEMPT_T24_TIMEOUT		4UL
#define ISUP_REATTEMPT_UNEXPECTED		5UL
#define ISUP_REATTEMPT_COT_FAILURE		6UL
#define ISUP_REATTEMPT_CIRCUIT_BUSY		7UL

/*
   Call types for CC_SETUP_REQ and CC_SETUP_IND 
 */
/*
   Call types -- Q.764 Conforming 
 */
#define ISUP_CALL_TYPE_SPEECH			0x00000000UL
#define ISUP_CALL_TYPE_64KBS_UNRESTRICTED	0x00000002UL
#define ISUP_CALL_TYPE_3_1kHZ_AUDIO		0x00000003UL
#define ISUP_CALL_TYPE_64KBS_PREFERRED		0x00000006UL
#define ISUP_CALL_TYPE_2x64KBS_UNRESTRICTED	0x00000007UL
#define ISUP_CALL_TYPE_384KBS_UNRESTRICTED	0x00000008UL
#define ISUP_CALL_TYPE_1536KBS_UNRESTRICTED	0x00000009UL
#define ISUP_CALL_TYPE_1920KBS_UNRESTRICTED	0x0000000aUL
/*
   Call flags for CC_SETUP_REQ and CC_SETUP_IND 
 */
/*
   Call flags -- Q.764 Conforming 
 */
#define ISUP_NCI_ONE_SATELLITE_CCT		0x00000001UL
#define ISUP_NCI_TWO_SATELLITE_CCT		0x00000002UL
#define ISUP_NCI_SATELLITE_MASK			0x00000003UL
#define ISUP_NCI_CONT_CHECK_REQUIRED		0x00000004UL
#define ISUP_NCI_CONT_CHECK_PREVIOUS		0x00000008UL
#define ISUP_NCI_CONT_CHECK_MASK		0x0000000cUL
#define ISUP_NCI_OG_ECHO_CONTROL_DEVICE		0x00000010UL
/*