mtpi_ioctl.h

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

// #define RL_UNINHIBITED (MTP_UNINHIBITED) /* Routelist Uninhibited (transient state) */
// #define RL_UNBLOCKED (MTP_UNBLOCKED) /* Routelist Unblocked (transient state) */
// #define RL_ACTIVE (MTP_ACTIVE) /* Routelist Active (Link in service) */
// #define RL_RESTART_PHASE_1 (MTP_RESTART_PHASE_1) /* Routelist Restarting Phase 1 */
// #define RL_RESTART_PHASE_2 (MTP_RESTART_PHASE_2) /* Routelist Restarting Phase 2 */

/*
 *  Route set state
 */
typedef struct mtp_timers_rs {
	mtp_timer_t t8;			/* timer t8 */
	mtp_timer_t t11;		/* timer t11 */
	mtp_timer_t t15;		/* timer t15 */
	mtp_timer_t t16;		/* timer t16 */
	mtp_timer_t t18a;		/* timer t18a */
} mtp_timers_rs_t;
typedef struct mtp_statem_rs {
	struct mtp_timers_rs timers;
} mtp_statem_rs_t;

#define RS_ALLOWED	    (MTP_ALLOWED)	/* Routeset Allowed */
#define RS_DANGER	    (MTP_DANGER)	/* Routeset Danger of congestion (primary or
						   secondary) */
#define RS_CONGESTED	    (MTP_CONGESTED)	/* Routeset Congested (Link Set cong, primary or
						   secondary) */
#define RS_RESTRICTED	    (MTP_RESTRICTED)	/* Routeset Restricted (Route Failure or received
						   TFR) */
#define RS_RESTART	    (MTP_RESTART)	/* Routeset Restarting */
#define RS_PROHIBITED	    (MTP_PROHIBITED)	/* Routeset Prohibited (Received TFP) */
#define RS_INHIBITED	    (MTP_INHIBITED)	/* Routeset Inhibited (Management inhibited) */
#define RS_BLOCKED	    (MTP_BLOCKED)	/* Routeset Blocked (Local Link Set failure) */
#define RS_INACTIVE	    (MTP_INACTIVE)	/* Routeset Inactive (Link out of service) */
#define RS_NODANGER	    (MTP_NODANGER)	/* Routeset Out of Danger (transient state) */
#define RS_UNCONGESTED	    (MTP_UNCONGESTED)	/* Routeset Uncongested (transient state) */
#define RS_RESTARTED	    (MTP_RESTARTED)	/* Routeset Restarted */
#define RS_UNINHIBITED	    (MTP_UNINHIBITED)	/* Routeset Uninhibited (transient state) */
#define RS_UNBLOCKED	    (MTP_UNBLOCKED)	/* Routeset Unblocked (transient state) */
#define RS_ACTIVE	    (MTP_ACTIVE)	/* Routeset Active (Link in service) */
#define RS_RESTART_PHASE_1  (MTP_RESTART_PHASE_1)	/* Routeset Restarting Phase 1 */
#define RS_RESTART_PHASE_2  (MTP_RESTART_PHASE_2)	/* Routeset Restarting Phase 2 */

#define RSF_ALLOWED	    (MTPF_ALLOWED)	/* Routeset is allowed */
#define RSF_DANGER	    (MTPF_DANGER)	/* Routeset is in danger of congestion */
#define RSF_CONGESTED	    (MTPF_CONGESTED)	/* Routeset is congested */
#define RSF_RESTRICTED	    (MTPF_RESTRICTED)	/* Routeset is restricted */
#define RSF_RESTART	    (MTPF_RESTART)	/* Routeset is restarting */
#define RSF_PROHIBITED	    (MTPF_PROHIBITED)	/* Routeset is prohibited */
#define RSF_INHIBITED	    (MTPF_INHIBITED)	/* Routeset is inhibited */
#define RSF_BLOCKED	    (MTPF_BLOCKED)	/* Routeset is blocked */
#define RSF_INACTIVE	    (MTPF_INACTIVE)	/* Routeset is inactive */

#define RSF_TFR_PENDING	    (MTPF_TFR_PENDING)	/* Routeset has TFR pending */
#define RSF_CLUSTER	    (MTPF_CLUSTER)	/* Routeset is cluster route */
#define RSF_XFER_FUNC	    (MTPF_XFER_FUNC)	/* Routeset has transfer function */
#define RSF_ADJACENT	    (MTPF_ADJACENT)	/* Routeset is adjacent */

/*
 *  Signalling point state
 */
typedef struct mtp_timers_sp {
	mtp_timer_t t1r;		/* timer t1r */
	mtp_timer_t t18;		/* timer t18 */
	mtp_timer_t t20;		/* timer t20 */
	mtp_timer_t t22a;		/* timer t22a */
	mtp_timer_t t23a;		/* timer t23a */
	mtp_timer_t t24a;		/* timer t24a */
	mtp_timer_t t26a;		/* timer t26a */
	mtp_timer_t t27a;		/* timer t27a */
} mtp_timers_sp_t;
typedef struct mtp_statem_sp {
	struct mtp_timers_sp timers;
} mtp_statem_sp_t;

#define SP_ALLOWED	    (MTP_ALLOWED)	/* Sig Point Allowed */
#define SP_DANGER	    (MTP_DANGER)	/* Sig Point Danger of congestion (primary or
						   secondary) */
#define SP_CONGESTED	    (MTP_CONGESTED)	/* Sig Point Congested (Link Set cong, primary or
						   secondary ) */
#define SP_RESTRICTED	    (MTP_RESTRICTED)	/* Sig Point Restricted (Route Failure or received
						   TFR) */
#define SP_RESTART	    (MTP_RESTART)	/* Sig Point Restarting */
#define SP_PROHIBITED	    (MTP_PROHIBITED)	/* Sig Point Prohibited (Received TFP) */
#define SP_INHIBITED	    (MTP_INHIBITED)	/* Sig Point Inhibited (Management inhibited) */
#define SP_BLOCKED	    (MTP_BLOCKED)	/* Sig Point Blocked (Local Link Set failure) */
#define SP_INACTIVE	    (MTP_INACTIVE)	/* Sig Point Inactive (Link out of service) */
#define SP_NODANGER	    (MTP_NODANGER)	/* Sig Point Out of Danger (transient state) */
#define SP_UNCONGESTED	    (MTP_UNCONGESTED)	/* Sig Point Uncongested (transient state) */
#define SP_RESTARTED	    (MTP_RESTARTED)	/* Sig Point Restarted */
#define SP_UNINHIBITED	    (MTP_UNINHIBITED)	/* Sig Point Uninhibited (transient state) */
#define SP_UNBLOCKED	    (MTP_UNBLOCKED)	/* Sig Point Unblocked (transient state) */
#define SP_ACTIVE	    (MTP_ACTIVE)	/* Sig Point Active (Link in service) */
#define SP_RESTART_PHASE_1  (MTP_RESTART_PHASE_1)	/* Sig Point Restarting Phase 1 */
#define SP_RESTART_PHASE_2  (MTP_RESTART_PHASE_2)	/* Sig Point Restarting Phase 2 */

#define SPF_RESTART	    (MTPF_RESTART)	/* Sig Point restarting */
#define SPF_CLUSTER	    (MTPF_CLUSTER)	/* Sig Point is cluster route */
#define SPF_XFER_FUNC	    (MTPF_XFER_FUNC)	/* Sig Point has transfer function */
#define SPF_SECURITY	    (MTPF_SECURITY)	/* Sig Point has additional security procedures */
#define SPF_LOSC_PROC_A	    (MTPF_LOSC_PROC_A)	/* Sig Point uses link oscillation procedure A */
#define SPF_LOSC_PROC_B	    (MTPF_LOSC_PROC_B)	/* Sig Point uses link oscillation procedure B */
#define SPF_RESTART_PHASE_1 (MTPF_RESTART_PHASE_1)	/* Sig Point restarting */
#define SPF_RESTART_PHASE_2 (MTPF_RESTART_PHASE_2)	/* Sig Point restarting */
#define SPF_RESTART_LOCKOUT (MTPF_RESTART_LOCKOUT)	/* Sig Point restarting (T27a running) */

/*
 *  Network appearance state
 */
typedef struct mtp_timers_na {
} mtp_timers_na_t;
typedef struct mtp_statem_na {
	struct mtp_timers_na timers;
} mtp_statem_na_t;

/*
 *  Default state
 */
typedef struct mtp_timers_df {
} mtp_timers_df_t;
typedef struct mtp_statem_df {
	struct mtp_timers_df timers;
} mtp_statem_df_t;

typedef union mtp_statem_obj {
	struct mtp_statem_na na;	/* Network Appearance */
	struct mtp_statem_sp sp;	/* Signalling Point */
	struct mtp_statem_rs rs;	/* Route Set */
	struct mtp_statem_rl rl;	/* Route List */
	struct mtp_statem_rt rt;	/* Route */
	struct mtp_statem_ls ls;	/* Combined Link Set */
	struct mtp_statem_lk lk;	/* Link Set */
	struct mtp_statem_sl sl;	/* Signalling Link */
	struct mtp_statem_df df;	/* Default */
} mtp_statem_obj_t;

/*
 *  STATE
 */

typedef struct mtp_statem {
	mtp_ulong type;			/* object type */
	mtp_ulong id;			/* object id */
	mtp_ulong flags;		/* object flags */
	mtp_ulong state;		/* object state */
	/* followed by object-specific state structure */
	mtp_statem_obj_t statem[0];
} mtp_statem_t;

#define	MTP_IOCGSTATEM	_IOWR(	MTP_IOC_MAGIC,	 6,	mtp_statem_t	)
#define	MTP_IOCCMRESET	_IOWR(	MTP_IOC_MAGIC,	 7,	mtp_statem_t	)

/*
 *  Signalling link statistics
 */
typedef struct mtp_stats_sl {
} mtp_stats_sl_t;

/*
 *  Link statistics
 */
typedef struct mtp_stats_lk {
} mtp_stats_lk_t;

/*
 *  Link set statistics
 */
typedef struct mtp_stats_ls {
} mtp_stats_ls_t;

/*
 *  Route statistics
 */
typedef struct mtp_stats_rt {
} mtp_stats_rt_t;

/*
 *  Route list statistics
 */
typedef struct mtp_stats_rl {
} mtp_stats_rl_t;

/*
 *  Route set statistics
 */
typedef struct mtp_stats_rs {
} mtp_stats_rs_t;

/*
 *  Signalling point statistics
 */
typedef struct mtp_stats_sp {
} mtp_stats_sp_t;

/*
 *  Network appearance statistics
 */
typedef struct mtp_stats_na {
} mtp_stats_na_t;

/*
 *  Default statistics
 */
typedef struct mtp_stats_df {
} mtp_stats_df_t;

typedef union mtp_stats_obj {
	struct mtp_stats_na na;		/* Network Appearance */
	struct mtp_stats_sp sp;		/* Signalling Point */
	struct mtp_stats_rs rs;		/* Route Set */
	struct mtp_stats_rl rl;		/* Route List */
	struct mtp_stats_rt rt;		/* Route */
	struct mtp_stats_ls ls;		/* Combined Link Set */
	struct mtp_stats_lk lk;		/* Link Set */
	struct mtp_stats_sl sl;		/* Signalling Link */
	struct mtp_stats_df df;		/* Default */
} mtp_stats_obj_t;

/*
 *  STATISTICS
 */
typedef struct mtp_stats {
	mtp_ulong type;			/* object type */
	mtp_ulong id;			/* object id */
	mtp_ulong header;		/* object stats header */
	/* followed by object-specific statistics structure */
	mtp_stats_obj_t stats[0];
} mtp_stats_t;

#define	MTP_IOCGSTATSP	_IOWR(	MTP_IOC_MAGIC,	 8,	mtp_stats_t	)
#define	MTP_IOCSSTATSP	_IOWR(	MTP_IOC_MAGIC,	 9,	mtp_stats_t	)
#define	MTP_IOCGSTATS	_IOWR(	MTP_IOC_MAGIC,	10,	mtp_stats_t	)
#define	MTP_IOCSSTATS	_IOWR(	MTP_IOC_MAGIC,	11,	mtp_stats_t	)

/*
 *  Signalling link notifications
 */
typedef struct mtp_notify_sl {
	mtp_ulong events;
} mtp_notify_sl_t;

#define MTP_EVT_SL_RPO_START			(1<< 0)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_RPO_STOP			(1<< 1)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_LOC_INHIB_START		(1<< 2)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_LOC_INHIB_STOP		(1<< 3)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_REM_INHIB_START		(1<< 4)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_REM_INHIB_STOP		(1<< 5)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_CONG_START			(1<< 6)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_CONG_STOP			(1<< 7)	/* Table 2/Q.752 2.10 */
#define MTP_EVT_SL_CONG_LOSS			(1<< 8)	/* Table 2/Q.752 2.10 */

/*
 *  Link set notifications
 */
typedef struct mtp_notify_lk {
	mtp_ulong events;
} mtp_notify_lk_t;

#define MTP_EVT_LK_FAILURE_START		(1<< 9)
#define MTP_EVT_LK_FAILURE_STOP			(1<<10)
#define MTP_EVT_LK_SEND_TFP			(1<<11)
#define MTP_EVT_LK_SEND_TFA			(1<<12)

/*
 *  Combined link set notifications
 */
typedef struct mtp_notify_ls {
	mtp_ulong events;
} mtp_notify_ls_t;

/*
 *  Route notifications
 */
typedef struct mtp_notify_rt {
	mtp_ulong events;
} mtp_notify_rt_t;

/*
 *  Route list notifications
 */
typedef struct mtp_notify_rl {
	mtp_ulong events;
} mtp_notify_rl_t;

/*
 *  Route set notifications
 */
typedef struct mtp_notify_rs {
	mtp_ulong events;
} mtp_notify_rs_t;

#define MTP_EVT_RS_UNAVAIL_START		(1<<13)
#define MTP_EVT_RS_UNAVAIL_STOP			(1<<14)
#define MTP_EVT_RS_REROUTE_ADJ			(1<<15)
#define MTP_EVT_RS_ADJ_SP_INACCESS_START	(1<<16)
#define MTP_EVT_RS_ADJ_SP_INACCESS_STOP		(1<<17)
#define MTP_EVT_RS_TFC_RECV			(1<<18)

/*
 *  Signalling point notifications
 */
typedef struct mtp_notify_sp {
	mtp_ulong events;
} mtp_notify_sp_t;

#define MTP_EVT_SP_MSU_DISCARDED		(1<<19)
#define MTP_EVT_SP_UPU_SENT			(1<<20)
#define MTP_EVT_SP_UPU_RECV			(1<<21)

/*
 *  Network appearance notifications
 */
typedef struct mtp_notify_na {
	mtp_ulong events;
} mtp_notify_na_t;

/*
 *  Default notifications
 */
typedef struct mtp_notify_df {
	mtp_ulong events;
} mtp_notify_df_t;

typedef union mtp_notify_obj {
	struct mtp_notify_na na;	/* Network Appearance */
	struct mtp_notify_sp sp;	/* Signalling Point */
	struct mtp_notify_rs rs;	/* Route Set */
	struct mtp_notify_rl rl;	/* Route List */
	struct mtp_notify_rt rt;	/* Route */
	struct mtp_notify_ls ls;	/* Combined Link Set */
	struct mtp_notify_lk lk;	/* Link Set */
	struct mtp_notify_sl sl;	/* Signalling Link */
	struct mtp_notify_df df;	/* Default */
} mtp_notify_obj_t;

/*
 *  EVENTS
 */
typedef struct mtp_notify {
	mtp_ulong type;			/* object type */
	mtp_ulong id;			/* object id */
	/* followed by object-specific notification structure */
	mtp_notify_obj_t events[0];
} mtp_notify_t;

#define	MTP_IOCGNOTIFY	_IOWR(	MTP_IOC_MAGIC,	12,	mtp_notify_t	)
#define	MTP_IOCSNOTIFY	_IOWR(	MTP_IOC_MAGIC,	13,	mtp_notify_t	)
#define	MTP_IOCCNOTIFY	_IOWR(	MTP_IOC_MAGIC,	14,	mtp_notify_t	)

/*
 *  MANAGEMENT
 */
typedef struct mtp_mgmt {
	mtp_ulong type;			/* object type */
	mtp_ulong id;			/* object id */
	mtp_ulong cmd;			/* mgmt command */
} mtp_mgmt_t;

#define MTP_MGMT_ALLOW			 0
#define MTP_MGMT_RESTRICT		 1
#define MTP_MGMT_PROHIBIT		 2
#define MTP_MGMT_ACTIVATE		 3
#define MTP_MGMT_DEACTIVATE		 4
#define MTP_MGMT_BLOCK			 5
#define MTP_MGMT_UNBLOCK		 6
#define MTP_MGMT_INHIBIT		 7
#define MTP_MGMT_UNINHIBIT		 8
#define MTP_MGMT_CONGEST		 9
#define MTP_MGMT_UNCONGEST		10
#define MTP_MGMT_DANGER			11
#define MTP_MGMT_NODANGER		12
#define MTP_MGMT_RESTART		13
#define MTP_MGMT_RESTARTED		14

#define	MTP_IOCCMGMT	_IOW(	MTP_IOC_MAGIC,	15,	mtp_mgmt_t	)

/*
 *  PASS LOWER
 */
typedef struct mtp_pass {
	mtp_ulong muxid;		/* mux index of lower SL structure to pass message to */
	mtp_ulong type;			/* type of message block */
	mtp_ulong band;			/* band of mesage block */
	mtp_ulong ctl_length;		/* length of cntl part */
	mtp_ulong dat_length;		/* length of data part */
	/* followed by cntl and data part of message to pass to signalling link */
} mtp_pass_t;

#define MTP_IOCCPASS	_IOW(	MTP_IOC_MAGIC,	16,	mtp_pass_t	)

#define MTP_IOC_FIRST    0
#define MTP_IOC_LAST    16
#define MTP_IOC_PRIVATE 32

#endif				/* __MTPI_IOCTL_H__ */