dlpi.h

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

						   deletion */

typedef struct {
	dl_long dl_min;
	dl_long dl_max;
} dl_protect_t;

/*
   Resilience specification

   probabilities are scaled by a factor of 10,000 with a time interval of 10,000 seconds. 
 */
typedef struct {
	dl_long dl_disc_prob;		/* prob. of provider init DISC */
	dl_long dl_reset_prob;		/* prob. of provider init RESET */
} dl_resilience_t;

/*
   QOS type definition to be used for negotiation with the remote end of a connection, or a
   connectionless unitdata request. There are two type definitions to handle the negotiation
   process at connection establishment. The typedef dl_qos_range_t is used to present a range for
   parameters. This is used in the DL_CONNECT_REQ and DL_CONNECT_IND messages. The typedef
   dl_qos_sel_t is used to select a specific value for the QOS parameters. This is used in the
   DL_CONNECT_RES, DL_CONNECT_CON, and DL_INFO_ACK messages to define the selected QOS parameters
   for a connection.

   NOTE: A DataLink provider which has unknown values for any of the fields will use a value of
   DL_UNKNOWN for all values in the fields.

   NOTE: A QOS parameter value of DL_QOS_DONT_CARE informs the DLS provider the user requesting
   this value doesn't care what the QOS parameter is set to. This value becomes the least possible
   value in the range of QOS parameters. The order of the QOS parameter range is then:

   DL_QOS_DONT_CARE < 0 < MAXIMUM QOS VALUE 
 */
#define DL_UNKNOWN              -1
#define DL_QOS_DONT_CARE        -2

/*
   Every QOS structure has the first 4 bytes containing a type field, denoting the definition of
   the rest of the structure. This is used in the same manner has the dl_primitive variable is in
   messages.

   The following list is the defined QOS structure type values and structures. 
 */
#define DL_QOS_CO_RANGE1		0x0101	/* CO QOS range struct. */
#define DL_QOS_CO_SEL1			0x0102	/* CO QOS selection structure */
#define DL_QOS_CL_RANGE1		0x0103	/* CL QOS range struct. */
#define DL_QOS_CL_SEL1			0x0104	/* CL QOS selection */

typedef struct {
	dl_ulong dl_qos_type;
	dl_through_t dl_rcv_throughput;	/* desired and accep. */
	dl_transdelay_t dl_rcv_trans_delay;	/* desired and accep. */
	dl_through_t dl_xmt_throughput;
	dl_transdelay_t dl_xmt_trans_delay;
	dl_priority_t dl_priority;	/* min and max values */
	dl_protect_t dl_protection;	/* min and max values */
	dl_long dl_residual_error;
	dl_resilience_t dl_resilience;
} dl_qos_co_range1_t;

typedef struct {
	dl_ulong dl_qos_type;
	dl_long dl_rcv_throughput;
	dl_long dl_rcv_trans_delay;
	dl_long dl_xmt_throughput;
	dl_long dl_xmt_trans_delay;
	dl_long dl_priority;
	dl_long dl_protection;
	dl_long dl_residual_error;
	dl_resilience_t dl_resilience;
} dl_qos_co_sel1_t;

typedef struct {
	dl_ulong dl_qos_type;
	dl_transdelay_t dl_trans_delay;
	dl_priority_t dl_priority;
	dl_protect_t dl_protection;
	dl_long dl_residual_error;
} dl_qos_cl_range1_t;

typedef struct {
	dl_ulong dl_qos_type;
	dl_long dl_trans_delay;
	dl_long dl_priority;
	dl_long dl_protection;
	dl_long dl_residual_error;
} dl_qos_cl_sel1_t;
/*
   DLPI interface primitive definitions.

   Each primitive is sent as a stream message.  It is possible that the messages may be viewed as a 
   sequence of bytes that have the following form without any padding. The structure definition of
   the following messages may have to change depending on the underlying hardware architecture and
   crossing of a hardware boundary with a different hardware architecture.

   Fields in the primitives having a name of the form dl_reserved cannot be used and have the value 
   of binary zero, no bits turned on.

   Each message has the name defined followed by the stream message type (M_PROTO, M_PCPROTO,
   M_DATA) 
 */

/*
   LOCAL MANAGEMENT SERVICE PRIMITIVES 
 */

/*
   DL_INFO_REQ, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* set to DL_INFO_REQ */
} dl_info_req_t;

/*
   DL_INFO_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* set to DL_INFO_ACK */
	dl_ulong dl_max_sdu;		/* Max bytes in a DLSDU */
	dl_ulong dl_min_sdu;		/* Min bytes in a DLSDU */
	dl_ulong dl_addr_length;	/* length of DLSAP address */
	dl_ulong dl_mac_type;		/* type of medium supported */
	dl_ulong dl_reserved;		/* value set to zero */
	dl_ulong dl_current_state;	/* state of DLPI interface */
	dl_long dl_sap_length;		/* length of dlsap SAP part */
	dl_ulong dl_service_mode;	/* CO, CL or ACL */
	dl_ulong dl_qos_length;		/* length of qos values */
	dl_ulong dl_qos_offset;		/* offset from start of block */
	dl_ulong dl_qos_range_length;	/* available range of qos */
	dl_ulong dl_qos_range_offset;	/* offset from start of block */
	dl_ulong dl_provider_style;	/* style1 or style2 */
	dl_ulong dl_addr_offset;	/* offset of the dlsap addr */
	dl_ulong dl_version;		/* version number */
	dl_ulong dl_brdcst_addr_length;	/* length of broadcast addr */
	dl_ulong dl_brdcst_addr_offset;	/* offset from start of block */
	dl_ulong dl_growth;		/* set to zero */
} dl_info_ack_t;

/*
   DL_ATTACH_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* set to DL_ATTACH_REQ */
	dl_ulong dl_ppa;		/* id of the PPA */
} dl_attach_req_t;

/*
   DL_DETACH_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* set to DL_DETACH_REQ */
} dl_detach_req_t;

/*
   DL_BIND_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* set to DL_BIND_REQ */
	dl_ulong dl_sap;		/* info to identify dlsap addr */
	dl_ulong dl_max_conind;		/* max # of outstanding con_ind */
	dl_ushort dl_service_mode;	/* CO, CL or ACL */
	dl_ushort dl_conn_mgmt;		/* if non-zero, is con-mgmt stream */
	dl_ulong dl_xidtest_flg;	/* auto init. of test and xid */
} dl_bind_req_t;

/*
   DL_BIND_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_BIND_ACK */
	dl_ulong dl_sap;		/* DLSAP addr info */
	dl_ulong dl_addr_length;	/* length of complete DLSAP addr */
	dl_ulong dl_addr_offset;	/* offset from start of M_PCPROTO */
	dl_ulong dl_max_conind;		/* allowed max. # of con-ind */
	dl_ulong dl_xidtest_flg;	/* responses supported by provider */
} dl_bind_ack_t;

/*
   DL_SUBS_BIND_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_SUBS_BIND_REQ */
	dl_ulong dl_subs_sap_offset;	/* offset of subs_sap */
	dl_ulong dl_subs_sap_length;	/* length of subs_sap */
	dl_ulong dl_subs_bind_class;	/* peer or hierarchical */
} dl_subs_bind_req_t;
#define	dl_subs_sap_len	dl_subs_sap_length	/* SCO compatibility */

/*
   DL_SUBS_BIND_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_SUBS_BIND_ACK */
	dl_ulong dl_subs_sap_offset;	/* offset of subs_sap */
	dl_ulong dl_subs_sap_length;	/* length of subs_sap */
} dl_subs_bind_ack_t;

/*
   DL_UNBIND_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_UNBIND_REQ */
} dl_unbind_req_t;

/*
   DL_SUBS_UNBIND_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_SUBS_UNBIND_REQ */
	dl_ulong dl_subs_sap_offset;	/* offset of subs_sap */
	dl_ulong dl_subs_sap_length;	/* length of subs_sap */
} dl_subs_unbind_req_t;

/*
   DL_OK_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_OK_ACK */
	dl_ulong dl_correct_primitive;	/* primitive acknowledged */
} dl_ok_ack_t;

/*
   DL_ERROR_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_ERROR_ACK */
	dl_ulong dl_error_primitive;	/* primitive in error */
	dl_ulong dl_errno;		/* DLPI error code */
	dl_ulong dl_unix_errno;		/* UNIX system error code */
} dl_error_ack_t;

/*
   DL_ENABMULTI_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_ENABMULTI_REQ */
	dl_ulong dl_addr_length;	/* length of multicast address */
	dl_ulong dl_addr_offset;	/* offset from start of M_PROTO block */
} dl_enabmulti_req_t;

/*
   DL_DISABMULTI_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_DISABMULTI_REQ */
	dl_ulong dl_addr_length;	/* length of multicast address */
	dl_ulong dl_addr_offset;	/* offset from start of M_PROTO block */
} dl_disabmulti_req_t;

/*
   DL_PROMISCON_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_PROMISCON_REQ */
	dl_ulong dl_level;		/* physical,SAP, or ALL multicast */
} dl_promiscon_req_t;

/*
   DL_PROMISCOFF_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_PROMISCOFF_REQ */
	dl_ulong dl_level;		/* Physical,SAP, or ALL multicast */
} dl_promiscoff_req_t;

/*
   Primitives to get and set the Physical address 
 */

/*
   DL_PHYS_ADDR_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_PHYS_ADDR_REQ */
	dl_ulong dl_addr_type;		/* factory or current physical addr */
} dl_phys_addr_req_t;

/*
   DL_PHYS_ADDR_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_PHYS_ADDR_ACK */
	dl_ulong dl_addr_length;	/* length of the physical addr */
	dl_ulong dl_addr_offset;	/* offset from start of block */
} dl_phys_addr_ack_t;

/*
   DL_SET_PHYS_ADDR_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_SET_PHYS_ADDR_REQ */
	dl_ulong dl_addr_length;	/* length of physical addr */
	dl_ulong dl_addr_offset;	/* offset from start of block */
} dl_set_phys_addr_req_t;

/*
   Primitives to get statistics 
 */

/*
   DL_GET_STATISTICS_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_GET_STATISTICS_REQ */
} dl_get_statistics_req_t;

/*
   DL_GET_STATISTICS_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_GET_STATISTICS_ACK */
	dl_ulong dl_stat_length;	/* length of statistics structure */
	dl_ulong dl_stat_offset;	/* offset from start of block */
} dl_get_statistics_ack_t;

/*
   CONNECTION-ORIENTED SERVICE PRIMITIVES 
 */

/*
   DL_CONNECT_REQ, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_CONNECT_REQ */
	dl_ulong dl_dest_addr_length;	/* len. of dlsap addr */
	dl_ulong dl_dest_addr_offset;	/* offset */
	dl_ulong dl_qos_length;		/* len. of QOS parm val */
	dl_ulong dl_qos_offset;		/* offset */
	dl_ulong dl_growth;		/* set to zero */
} dl_connect_req_t;

/*
   DL_CONNECT_IND, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_CONNECT_IND */
	dl_ulong dl_correlation;	/* provider's correl. token */
	dl_ulong dl_called_addr_length;	/* length of called address */
	dl_ulong dl_called_addr_offset;	/* offset from start of block */
	dl_ulong dl_calling_addr_length;	/* length of calling address */
	dl_ulong dl_calling_addr_offset;	/* offset from start of block */
	dl_ulong dl_qos_length;		/* length of qos structure */
	dl_ulong dl_qos_offset;		/* offset from start of block */
	dl_ulong dl_growth;		/* set to zero */
} dl_connect_ind_t;

/*
   DL_CONNECT_RES, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_CONNECT_RES */
	dl_ulong dl_correlation;	/* provider's correlation token */
	dl_ulong dl_resp_token;		/* token of responding stream */
	dl_ulong dl_qos_length;		/* length of qos structure */
	dl_ulong dl_qos_offset;		/* offset from start of block */
	dl_ulong dl_growth;		/* set to zero */
} dl_connect_res_t;

/*
   DL_CONNECT_CON, M_PROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_CONNECT_CON */
	dl_ulong dl_resp_addr_length;	/* responder's address len */
	dl_ulong dl_resp_addr_offset;	/* offset from start of block */
	dl_ulong dl_qos_length;		/* length of qos structure */
	dl_ulong dl_qos_offset;		/* offset from start of block */
	dl_ulong dl_growth;		/* set to zero */
} dl_connect_con_t;

/*
   DL_TOKEN_REQ, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_TOKEN_REQ */
} dl_token_req_t;

/*
   DL_TOKEN_ACK, M_PCPROTO type 
 */
typedef struct {
	dl_ulong dl_primitive;		/* DL_TOKEN_ACK */
	dl_ulong dl_token;		/* Connection response token */
} dl_token_ack_t;

/*
   DL_DISCONNECT_REQ, M_PROTO type 
 */
typedef struct {