File /code/strss7/include/ss7/lki.h

#ifndef __SS7_LKI_H__
#define __SS7_LKI_H__

#ident "@(#) $Name:  $($Revision: 0.8.2.2 $) Copyright (c) 1997-2002 OpenSS7 Corporation."

typedef lmi_long lk_long;
typedef lmi_ulong lk_ulong;
typedef lmi_ushort lk_ushort;
typedef lmi_uchar lk_uchar;

#define LK_PROTO_BASE				   80L

#define LK_DSTR_FIRST				(   1L + LK_PROTO_BASE )
#define LK_MESSAGE_FOR_DISTRIBUTION_REQ		(   2L + LK_PROTO_BASE )
#define LK_MESSAGE_FOR_ROUTING_REQ		(   3L + LK_PROTO_BASE )
#define LK_NETWORK_CONFIGURATION_CHANGE_REQ	(   4L + LK_PROTO_BASE )
#define LK_MANAGEMENT_INHIBIT_REQ		(   5L + LK_PROTO_BASE )
#define LK_MANAGEMENT_UNINHIBIT_REQ		(   6L + LK_PROTO_BASE )
#define LK_ROUTE_UNINHIBIT_REQ			(   7L + LK_PROTO_BASE )
#define LK_DSTR_LAST				(   7L + LK_PROTO_BASE )

#define LK_USTR_LAST				(  -1L - LK_PROTO_BASE )
#define LK_MESSAGE_FOR_DISTRIBUTION_IND		(  -1L - LK_PROTO_BASE )
#define LK_MESSAGE_FOR_ROUTING_IND		(  -2L - LK_PROTO_BASE )
#define LK_MANAGEMENT_INHIBITED_IND		(  -3L - LK_PROTO_BASE )
#define LK_MANAGEMENT_INHIBIT_DENIED_IND	(  -4L - LK_PROTO_BASE )
#define LK_MANAGEMENT_UNINHIBIT_DENIED_IND	(  -5L - LK_PROTO_BASE )
#define LK_ROUTE_UNINHIBIT_ABANDONED_IND	(  -6L - LK_PROTO_BASE )
#define LK_TIME_CONTROLLED_CHANGEOVER_IND	(  -7L - LK_PROTO_BASE )
#define LK_USTR_FIRST				(  -7L - LK_PROTO_BASE )

/*
 *  LKI PROTOCOL PRIMITIVES
 */

#define LK_REASON_UNSPECIFIED		0	/* unspecified (unknown) */
#define LK_REASON_INHIBITED		1	/* the link is inhibited */
#define LK_REASON_UNINHIBITED		2	/* the link is uninhibited */
#define LK_REASON_INHIBITING		3	/* inhibiting in progress */
#define LK_REASON_UNINHIBITING		4	/* uninhibiting in progress */
#define LK_REASON_BUSY			5	/* the action is already in progress */
#define LK_REASON_INACCESSIBLE		6	/* the adjacent SP is inaccessible */
#define LK_REASON_CRITICAL		7	/* the link is critical to a route */
#define LK_REASON_MAXIMUM_RETRIES	8	/* maximum number of retries attempted */

/*
 *  LK_MANAGEMENT_INHIBIT_DENIED_IND, M_PROTO
 */
typedef struct {
	lk_long primitive;		/* LK_MANAGEMENT_INHIBIT_DENIED_IND */
	lk_ulong reason;		/* reason for denying inhibit */
} lk_local_inhibit_denied_ind_t;

/*
 *  LK_MANAGEMENT_UNINHIBIT_DENIED_IND, M_PROTO
 */
typedef struct {
	lk_long primitive;		/* LK_MANAGEMENT_UNINHIBIT_DENIED_IND */
	lk_ulong reason;		/* reason for denying inhibit */
} lk_management_uninhibit_denied_ind_t;

/*
 *  LK_MSU_REQ, options M_PROTO type, with M_DATA block(s)
 */

typedef struct {
	lk_long lk_primitive;
	lk_ulong lk_network_ind;	/* network indicator */
	lk_ulong lk_msg_prior;		/* message priority */
	lk_ulong lk_service_ind;	/* service indicator */
	lk_ulong lk_opc;		/* originating point code */
	lk_ulong lk_dpc;		/* destination point code */
	lk_ulong lk_sls;		/* signalling link selection */
} lk_msu_req_t;

union LK_primitives {
	lk_long lk_primitive;
	lk_msu_req_t msu_req;
};

#define LK_MSU_REQ_SIZE			sizeof(lk_msu_req_t)

#define LK_PRIM_MAX_SIZE		sizeof(LK_primitives)

#endif				/* __SS7_LKI_H__ */