npi.h

This a separate release of the OpenSS7 X/Open XTI/TLI library, TLI modules (timod, tirdwr) and the I

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

 @(#) npi.h,v 1.1.2.1 2004/05/17 08:34:01 brian Exp

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

 Copyright (C) 2001-2004  OpenSS7 Corporation <http://www.openss7.com>
 Copyright (C) 1997-2000  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; either version 2 of the License, or (at your option) any later
 version.

 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 success 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 2004/05/17 08:34:01 by brian

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

/*
   npi.h header for the Network Provider Interface (OSI Conforming) 
 */

#ifndef SYS_NPI_H
#define SYS_NPI_H		/* mark file as included */

#ident "@(#) npi.h,v strxnet-0_9_2-4(1.1.2.1) 2004/05/17 08:34:01"

typedef int32_t np_long;
typedef u_int32_t np_ulong;

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

/*
   Primitives that are initiated by the network user. 
 */
#define N_CONN_REQ		 0	/* NC request */
#define N_CONN_RES		 1	/* Accept previous connection indication */
#define N_DISCON_REQ		 2	/* NC disconnection request */
#define N_DATA_REQ		 3	/* Connection-Mode data transfer request */
#define N_EXDATA_REQ		 4	/* Expedited data request */
#define N_INFO_REQ		 5	/* Information Request */
#define N_BIND_REQ		 6	/* Bind a NS user to network address */
#define N_UNBIND_REQ		 7	/* Unbind NS user from network address */
#define N_UNITDATA_REQ		 8	/* Connection-less data send request */
#define N_OPTMGMT_REQ		 9	/* Options Management request */

/*
   Primitives that are initiated by the network provider. 
 */
#define N_CONN_IND		11	/* Incoming connection indication */
#define N_CONN_CON		12	/* Connection established */
#define N_DISCON_IND		13	/* NC disconnected */
#define N_DATA_IND		14	/* Incoming connection-mode data indication */
#define N_EXDATA_IND		15	/* Incoming expedited data indication */
#define N_INFO_ACK		16	/* Information Acknowledgement */
#define N_BIND_ACK		17	/* NS User bound to network address */
#define N_ERROR_ACK		18	/* Error Acknowledgement */
#define N_OK_ACK		19	/* Success Acknowledgement */
#define N_UNITDATA_IND		20	/* Connection-less data receive indication */
#define N_UDERROR_IND		21	/* UNITDATA Error Indication */

/*
   Additional NPI Primitivies 
 */
#define N_DATACK_REQ		23	/* Data acknowledgement request */
#define N_DATACK_IND		24	/* Data acknowledgement indication */
#define N_RESET_REQ		25	/* NC reset request */
#define N_RESET_IND		26	/* Incoming NC reset request indication */
#define N_RESET_RES		27	/* Reset processing accepted */
#define N_RESET_CON		28	/* Reset processing complete */

/*
   The following are the events that drive the state machine 
 */

/*
   Initialization events 
 */
#define NE_BIND_REQ		 0	/* bind request */
#define NE_UNBIND_REQ		 1	/* unbind request */
#define NE_OPTMGMT_REQ		 2	/* manage options request */
#define NE_BIND_ACK		 3	/* bind acknowledgement */
#define NE_ERROR_ACK		 5	/* error acknowledgement */
#define NE_OK_ACK1		 6	/* ok ack, outcnt == 0 */
#define NE_OK_ACK2		 7	/* ok ack, outcnt == 1, q == rq */
#define NE_OK_ACK3		 8	/* ok ack, outcnt == 1, q! == rq */
#define NE_OK_ACK4		 9	/* ok ack, outcnt > 1 */

/*
   Connection-Mode events 
 */
#define NE_CONN_REQ		10	/* connect request */
#define NE_CONN_RES		11	/* connect response */
#define NE_DISCON_REQ		12	/* disconnect request */
#define NE_DATA_REQ		13	/* data request */
#define NE_EXDATA_REQ		14	/* expedited data request */
#define NE_CONN_IND		16	/* connect indication */
#define NE_CONN_CON		17	/* connect confirm */
#define NE_DATA_IND		18	/* data indication */
#define NE_EXDATA_IND		19	/* expedited data indication */
#define NE_DISCON_IND1		21	/* disconnect indication, outcnt == 0 */
#define NE_DISCON_IND2		22	/* disconnect indication, outcnt == 1 */
#define NE_DISCON_IND3		23	/* disconnect indication, outcnt > 1 */
#define NE_PASS_CON		24	/* pass connection */
#define NE_RESET_REQ		28	/* reset request */
#define NE_RESET_RES		29	/* reset response */
#define NE_DATACK_REQ		30	/* data acknowledgement request */
#define NE_DATACK_IND		31	/* data acknowledgement indication */
#define NE_RESET_IND		32	/* reset indication */
#define NE_RESET_CON		33	/* reset confirm */

/*
   Connection-less events 
 */
#define NE_UNITDATA_REQ		25	/* unitdata request */
#define NE_UNITDATA_IND		26	/* unitdata indication */
#define NE_UDERROR_IND		27	/* unitdata error indication */

#define NE_NOEVENTS		36	/* no events */

/*
   NPI interface states 
 */
#define NS_UNBND		 0	/* NS user not bound to network address */
#define NS_WACK_BREQ		 1	/* Awaiting acknowledgement of N_BIND_REQ */
#define NS_WACK_UREQ		 2	/* Pending acknowledgement for N_UNBIND_REQ */
#define NS_IDLE			 3	/* Idle, no connection */
#define NS_WACK_OPTREQ		 4	/* Pending acknowledgement of N_OPTMGMT_REQ */
#define NS_WACK_RRES		 5	/* Pending acknowledgement of N_RESET_RES */
#define NS_WCON_CREQ		 6	/* Pending confirmation of N_CONN_REQ */
#define NS_WRES_CIND		 7	/* Pending response of N_CONN_REQ */
#define NS_WACK_CRES		 8	/* Pending acknowledgement of N_CONN_RES */
#define NS_DATA_XFER		 9	/* Connection-mode data transfer */
#define NS_WCON_RREQ		10	/* Pending confirmation of N_RESET_REQ */
#define NS_WRES_RIND		11	/* Pending response of N_RESET_IND */
#define NS_WACK_DREQ6		12	/* Waiting ack of N_DISCON_REQ */
#define NS_WACK_DREQ7		13	/* Waiting ack of N_DISCON_REQ */
#define NS_WACK_DREQ9		14	/* Waiting ack of N_DISCON_REQ */
#define NS_WACK_DREQ10		15	/* Waiting ack of N_DISCON_REQ */
#define NS_WACK_DREQ11		16	/* Waiting ack of N_DISCON_REQ */

#define NS_NOSTATES		18	/* No states */

/*
   N_ERROR_ACK error return code values 
 */
#define NBADADDR		 1	/* Incorrect address format/illegal address information */
#define NBADOPT			 2	/* Options in incorrect format or contain illegal
					   information */
#define NACCESS			 3	/* User did not have proper permissions */
#define NNOADDR			 5	/* NS Provider could not allocate address */
#define NOUTSTATE		 6	/* Primitive was issues in wrong sequence */
#define NBADSEQ			 7	/* Sequence number in primitive was incorrect/illegal */
#define NSYSERR			 8	/* UNIX system error occurred */
#define NBADDATA		10	/* User data spec. outside range supported by NS provider */
#define NBADFLAG		16	/* Flags specified in primitive were illegal/incorrect */
#define NNOTSUPPORT		18	/* Primitive type not supported by the NS provider */
#define NBOUND			19	/* Illegal second attempt to bind listener or default
					   listener */
#define NBADQOSPARAM		20	/* QOS values specified are outside the range supported by
					   the NS provider */
#define NBADQOSTYPE		21	/* QOS structure type specified is not supported by the NS
					   provider */
#define NBADTOKEN		22	/* Token used is not associated with an open stream */
#define NNOPROTOID		23	/* Protocol id could not be allocated */

/*
   N_UDERROR_IND reason codes 
 */
#define N_UD_UNDEFINED		10	/* no reason specified */
#define N_UD_TD_EXCEEDED	11	/* Transit delay exceeded */
#define N_UD_CONGESTION		12	/* NS Provider congestion */
#define N_UD_QOS_UNAVAIL	13	/* Requested QOS/service characteristic unavailable */
#define N_UD_LIFE_EXCEEDED	14	/* NSDU Lifetime exceeded */
#define N_UD_ROUTE_UNAVAIL	15	/* Suitable route unavailable */
#define N_UD_SEG_REQUIRED	16	/* Segmentation reqd where none permitted */

/*
   NPI Originator for Resets and Disconnects 
 */
#define N_PROVIDER		0x0100	/* provider originated reset/disconnect */
#define N_USER			0x0101	/* user originated reset/disconnect */
#define N_UNDEFINED		0x0102	/* reset/disconnect originator undefined */

/*
   NPI Disconnect & Reset reasons when the originator is the N_UNDEFINED 
 */
#define N_REASON_UNDEFINED	0x0200

/*
   NPI Disconnect reasons when the originator is the N_PROVIDER 
 */
#define N_DISC_P		0x0300	/* Disconnection-permanent condition */
#define N_DISC_T		0x0301	/* Disconnection-transient condition */
#define N_REJ_NSAP_UNKNOWN	0x0302	/* Connection rejection-NSAP address unknown (permanent
					   condition) */
#define N_REJ_NSAP_UNREACH_P	0x0303	/* Connection rejection-NSAP unreachable (permanent
					   condition) */
#define N_REJ_NSAP_UNREACH_T	0x0304	/* Connection rejection-NSAP unreachable (transient
					   condition) */

/*
   NPI Disconnect reasons when the originator is the N_USER 
 */
#define N_DISC_NORMAL		0x0400	/* Disconnection-normal condition */
#define N_DISC_ABNORMAL		0x0401	/* Disconnection-abnormal condition */
#define N_REJ_P			0x0402	/* Connection rejection-permanent condition */
#define N_REJ_T			0x0403	/* Connection rejection-transient condition */
#define N_REJ_INCOMPAT_INFO	0x0406	/* Connection rejection-incompatible information in
					   NS-user-data */

/*
   NPI Disconnect reasons when the originator is the N_USER or N_PROVIDER 
 */
#define N_REJ_QOS_UNAVAIL_P	0x0305	/* Connection rejection-QOS unavailable (permanent
					   condition) */
#define N_REJ_QOS_UNAVAIL_T	0x0306	/* Connection rejection-QOS unavailable (transient
					   condition) */
#define N_REJ_UNSPECIFIED	0x0307	/* Connection rejection-reason unspecified */

/*
   NPI Reset reasons when originator is N_PROVIDER 
 */
#define N_CONGESTION		0x0500	/* Reset due to congestion */
#define N_RESET_UNSPECIFIED	0x0501	/* Reset-reason "unspecified" */

/*
   NPI Reset reasons when originator is N_USER 
 */
#define N_USER_RESYNC		0x0600	/* Reset due to user resynchronization */

/*
   CONN_flags definition; (used in N_conn_req, N_conn_ind, N_conn_res, and N_conn_con primitives)

   Flags to indicate support of network provider options; (used with the OPTIONS_flags field of
   N_info_ack primitive) 
 */
#define REC_CONF_OPT		0x00000001L	/* Receipt Confirmation Selection and Support */
#define EX_DATA_OPT		0x00000002L	/* Expedited Data Selection and Support */

/*
   This flag is used with the OPTIONS_flags field of N_info_ack as well as the OPTMGMT_flags field
   of the N_optmgmt_req primitive 
 */
#define DEFAULT_RC_SEL		0x00000004L	/* Indicates if default receipt confirmation is
						   selected */

/*
   BIND_flags; (used with N_bind_req primitive) 
 */

#define DEFAULT_LISTENER	0x00000001L	/* indicates if this stream is the default listener 
						 */
#define TOKEN_REQUEST		0x00000002L	/* indicates if "token" should be assigned to the
						   stream */
#define DEFAULT_DEST		0x00000004L	/* indicates if default dest. stream */

/*
   QOS Parameter Definitions 
 */

/*
   Throughput

   This parameter is specified for both directions. 
 */
typedef struct {
	np_long thru_targ_value;	/* target throughput values */
	np_long thru_min_value;		/* minimum acceptable throughput value */
} thru_values_t;

/*
   Transit Delay 
 */
typedef struct {
	np_long td_targ_value;		/* target transit delay */
	np_long td_max_value;		/* maximum acceptable transit delay */
} td_values_t;

/*
   Protection Values 
 */
typedef struct {
	np_long protect_targ_value;	/* target protection value */
	np_long protect_min_value;	/* minimum or available protection */
} protection_values_t;

/*
   Priority Values 
 */
typedef struct {
	np_long priority_targ_value;	/* target priority */
	np_long priority_min_value;	/* minimum acceptable priority */
} priority_values_t;

/*
   Types of protection specifications 
 */
#define N_NO_PROT		0x00000000L	/* no protection */
#define N_PASSIVE_PROT		0x00000001L	/* protection against passive monitoring */
#define N_ACTIVE_PROT		0x00000002L	/* protection against active monitoring */
#define N_ACTIVE_PASSIVE_PROT	0x00000003L	/* protection against active and passive monitoring 
						 */

/*
   Cost Selection 
 */
#define N_LEAST_EXPENSIVE	0x00000000L	/* choose least expensive means */

/*
   QOS STRUCTURE TYPES AND DEFINED VALUES 
 */
#define N_QOS_CO_RANGE1		0x0101
#define N_QOS_CO_SEL1		0x0102
#define N_QOS_CL_RANGE1		0x0103
#define N_QOS_CL_SEL1		0x0104
#define N_QOS_CO_OPT_RANGE1	0x0105
#define N_QOS_CO_OPT_SEL1	0x0106

/*
   When a NS user/provider cannot determine the value of a QOS field, it should return a value of
   QOS_UNKNOWN. 
 */
#define QOS_UNKNOWN			-1

/*
   QOS range for CONS. (Used with N_CONN_REQ and N_CONN_IND.) 
 */
typedef struct {
	np_ulong n_qos_type;		/* always N_QOS_CO_RANGE */
	thru_values_t src_throughput_range;	/* source throughput range */
	thru_values_t dest_throughput_range;	/* destination throughput range */
	td_values_t transit_delay_range;	/* transit delay range */
	protection_values_t protection_range;	/* protection range */
	priority_values_t priority_range;	/* priority range */
} N_qos_co_range_t;

/*
   QOS selected for CONS. (Used with N_CONN_RES and N_CONN_CON.) 
 */
typedef struct {
	np_ulong n_qos_type;		/* always N_QOS_CO_SEL */
	np_long src_throughput_sel;	/* source throughput selected */
	np_long dest_throughput_sel;	/* destination throughput selected */
	np_long transit_delay_sel;	/* transit delay selected */
	np_long protection_sel;		/* NC protection selected */
	np_long priority_sel;		/* NC priority selected */
} N_qos_co_sel_t;

/*
   QOS range for CLNS options management. (Used with N_INFO_ACK.) 
 */
typedef struct {
	np_ulong n_qos_type;		/* always N_QOS_CL_RANGE */
	td_values_t transit_delay_max;	/* maximum transit delay */
	np_ulong residual_error_rate;	/* residual error rate */
	protection_values_t protection_range;	/* protection range */
	priority_values_t priority_range;	/* priority range */
	np_long max_accept_cost;	/* maximum acceptable cost */
} N_qos_cl_range_t;

/*
   QOS selection for CLNS options management. (Used with N_OPTMGMT_REQ and N_INFO_ACK.) 
 */
typedef struct {
	np_ulong n_qos_type;		/* always N_QOS_CL_sel */
	np_long transit_delay_max;	/* maximum transit delay */
	np_ulong residual_error_rate;	/* residual error rate */