npi_sccp.h

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

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

 @(#) npi_sccp.h,v 0.9.2.5 2007/02/13 14:05:30 brian Exp

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

 Copyright (c) 2001-2007  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 2007/02/13 14:05:30 by brian

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

 npi_sccp.h,v
 Revision 0.9.2.5  2007/02/13 14:05:30  brian
 - corrected ulong and long for 32-bit compat

 Revision 0.9.2.4  2007/02/13 07:55:42  brian
 - working up MTP and UAs

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

#ifndef _SYS_NPI_SCCP_H
#define _SYS_NPI_SCCP_H

#ident "@(#) npi_sccp.h,v openss7-0_9_2_E(0.9.2.5) Copyright (c) 2001-2007 OpenSS7 Corporation."

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

/*
 *  LiS npi.h is version 1
 */
#ifndef N_VERSION_2

#define N_CURRENT_VERSION   0x02	/* current version of NPI */
#define N_VERSION_2	    0x02	/* version of npi, December 16, 1991 */

typedef uchar np_uchar;

/*
 * Information acknowledgement
 */
typedef struct {
	np_ulong PRIM_type;		/* always N_INFO_ACK */
	np_ulong NSDU_size;		/* maximum NSDU size */
	np_ulong ENSDU_size;		/* maximum ENSDU size */
	np_ulong CDATA_size;		/* connect data size */
	np_ulong DDATA_size;		/* discon data size */
	np_ulong ADDR_size;		/* address size */
	np_ulong ADDR_length;		/* address length */
	np_ulong ADDR_offset;		/* address offset */
	np_ulong QOS_length;		/* QOS values length */
	np_ulong QOS_offset;		/* QOS values offset */
	np_ulong QOS_range_length;	/* length of QOS values' range */
	np_ulong QOS_range_offset;	/* offset of QOS values' range */
	np_ulong OPTIONS_flags;		/* bit masking for options supported */
	np_ulong NIDU_size;		/* network i/f data unit size */
	np_long SERV_type;		/* service type */
	np_ulong CURRENT_state;		/* current state */
	np_ulong PROVIDER_type;		/* type of NS provider */
	np_ulong NODU_size;		/* optimal NSDU size */
	np_ulong PROTOID_length;	/* length of bound protocol ids */
	np_ulong PROTOID_offset;	/* offset of bound protocol ids */
	np_ulong NPI_version;		/* version # of npi that is supported */
} __N_info_ack_t;

#define N_info_ack_t __N_info_ack_t

/*
 * Bind acknowledgement
 */
typedef struct {
	np_ulong PRIM_type;		/* always N_BIND_ACK */
	np_ulong ADDR_length;		/* address length */
	np_ulong ADDR_offset;		/* offset of address */
	np_ulong CONIND_number;		/* connection indications */
	np_ulong TOKEN_value;		/* value of "token" assigned to stream */
	np_ulong PROTOID_length;	/* length of bound protocol ids */
	np_ulong PROTOID_offset;	/* offset of bound protocol ids */
} __N_bind_ack_t;

#define N_bind_ack_t __N_bind_ack_t

#endif				/* N_VERSION_2 */

/*
 *  Extended NPI primitives for SCCP.
 */

#define N_NOTICE_IND	32
typedef struct {
	np_ulong PRIM_type;		/* always N_NOTICE_IND */
	np_ulong DEST_length;		/* address data was sent to */
	np_ulong DEST_offset;
	np_ulong SRC_length;		/* address data was sent from */
	np_ulong SRC_offset;
	np_ulong QOS_length;		/* QOS parameters data was sent with */
	np_ulong QOS_offset;
	np_ulong RETURN_cause;		/* reason for return of data */
} N_notice_ind_t;

#define N_INFORM_REQ	33
typedef struct {
	np_ulong PRIM_type;		/* always N_INFORM_REQ */
	np_ulong QOS_length;		/* qos parameters */
	np_ulong QOS_offset;
	np_ulong REASON;		/* inform reason */
} N_inform_req_t;

#define N_INFORM_IND	34
typedef struct {
	np_ulong PRIM_type;		/* always N_INFORM_IND */
	np_ulong QOS_length;		/* qos parameters */
	np_ulong QOS_offset;
	np_ulong REASON;		/* inform reason */
} N_inform_ind_t;

/* Inform reasons for use with N_INFORM_IND */
#define N_SCCP_INFR_NSP_FAILURE		1
#define N_SCCP_INFR_NSP_CONGESTION	2
#define N_SCCP_INFR_NSP_QOS_CHANGE	3
/* Inform reasons for use with N_INFORM_REQ */
#define N_SCCP_INFR_NSU_FAILURE		4
#define N_SCCP_INFR_NSU_CONGESTION	5
#define N_SCCP_INFR_NSU_QOS_CHANGE	6
/* Inform reasons for use with N_INFORM */
#define N_SCCP_INFR_UNSPECIFIED		7

#define N_COORD_REQ	35
typedef struct {
	np_ulong PRIM_type;		/* alwyas N_COORD_REQ */
	np_ulong ADDR_length;		/* affected subsystem */
	np_ulong ADDR_offset;
} N_coord_req_t;

#define N_COORD_RES	36
typedef struct {
	np_ulong PRIM_type;		/* always N_COORD_RES */
	np_ulong ADDR_length;		/* affected subsystem */
	np_ulong ADDR_offset;
} N_coord_res_t;

#define N_COORD_IND	37
typedef struct {
	np_ulong PRIM_type;		/* alwyas N_COORD_IND */
	np_ulong ADDR_length;		/* affected subsystem */
	np_ulong ADDR_offset;
	np_ulong SMI;			/* subsystem multiplicity indicator */
} N_coord_ind_t;

#define N_COORD_CON	38
typedef struct {
	np_ulong PRIM_type;		/* always N_COORD_CON */
	np_ulong ADDR_length;		/* affected subsystem */
	np_ulong ADDR_offset;
	np_ulong SMI;			/* subsystem multiplicity indicator */
} N_coord_con_t;

#define N_STATE_REQ	39
typedef struct {
	np_ulong PRIM_type;		/* always N_STATE_REQ */
	np_ulong ADDR_length;		/* affected subsystem */
	np_ulong ADDR_offset;
	np_ulong STATUS;		/* user status */
} N_state_req_t;

#define N_STATE_IND	40
typedef struct {
	np_ulong PRIM_type;		/* always N_STATE_IND */
	np_ulong ADDR_length;		/* affected subsystem */
	np_ulong ADDR_offset;
	np_ulong STATUS;		/* user status */
	np_ulong SMI;			/* subsystem multiplicity indicator */
} N_state_ind_t;

#define N_PCSTATE_IND	41
typedef struct {
	np_ulong PRIM_type;		/* always N_PCSTATE_IND */
	np_ulong ADDR_length;		/* affected point code */
	np_ulong ADDR_offset;
	np_ulong STATUS;		/* status */
} N_pcstate_ind_t;

#define N_TRAFFIC_IND	42
typedef struct {
	np_ulong PRIM_type;		/* always N_TRAFFIC_IND */
	np_ulong ADDR_length;		/* affected user */
	np_ulong ADDR_offset;
	np_ulong TRAFFIC_mix;		/* traffic mix */
} N_traffic_ind_t;

#define N_SCCP_STATUS_USER_IN_SERVICE			1
#define N_SCCP_STATUS_USER_OUT_OF_SERVICE		2
#define N_SCCP_STATUS_REMOTE_SCCP_AVAILABLE		3
#define N_SCCP_STATUS_REMOTE_SCCP_UNAVAILABLE		4
#define N_SCCP_STATUS_REMOTE_SCCP_UNEQUIPPED		5