mtpi_ioctl.h

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

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

 @(#) mtpi_ioctl.h,v 0.9.2.8 2007/02/26 07:25:32 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/26 07:25:32 by brian

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

 mtpi_ioctl.h,v
 Revision 0.9.2.8  2007/02/26 07:25:32  brian
 - synchronizing changes

 Revision 0.9.2.7  2007/02/21 05:00:50  brian
 - typo

 Revision 0.9.2.6  2007/02/21 01:09:06  brian
 - updating mtp.c driver, better mi_open allocators

 Revision 0.9.2.5  2007/02/17 02:49:11  brian
 - first clean recompile of MTP modules on LFS

 Revision 0.9.2.4  2007/02/13 14:05:28  brian
 - corrected ulong and long for 32-bit compat

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

#ifndef __MTPI_IOCTL_H__
#define __MTPI_IOCTL_H__

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

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

#include <linux/ioctl.h>

#define MTP_IOC_MAGIC 'm'

#define MTP_OBJ_TYPE_DF		 0	/* default */
#define MTP_OBJ_TYPE_MT		 1	/* MTP user */
#define MTP_OBJ_TYPE_NA		 2	/* network appearance */
#define MTP_OBJ_TYPE_SP		 3	/* signalling point */
#define MTP_OBJ_TYPE_RS		 4	/* route set */
#define MTP_OBJ_TYPE_RL		 5	/* route list */
#define MTP_OBJ_TYPE_RT		 6	/* route */
#define MTP_OBJ_TYPE_LS		 7	/* combined link set */
#define MTP_OBJ_TYPE_LK		 8	/* link set */
#define MTP_OBJ_TYPE_SL		 9	/* signalling link */
#define MTP_OBJ_TYPE_CB		10	/* changeover buffer */
#define MTP_OBJ_TYPE_CR		11	/* controlled rerouting buffer */

#define RT_TYPE_MEMBER	0
#define RT_TYPE_CLUSTER	1

#define RS_TYPE_MEMBER	0
#define RS_TYPE_CLUSTER	1

#ifdef __KERNEL__
typedef mblk_t *mtp_timer_t;
#else				/* __KERNEL__ */
typedef unsigned long mtp_timer_t;
#endif				/* __KERNEL__ */

/*
 *  Signalling link options
 */
typedef struct mtp_opt_conf_sl {
	/* signalling link timers */
	mtp_ulong t1;			/* timer t1 value */
	mtp_ulong t2;			/* timer t2 value */
	mtp_ulong t3;			/* timer t3 value */
	mtp_ulong t4;			/* timer t4 value */
	mtp_ulong t5;			/* timer t5 value */
	mtp_ulong t12;			/* timer t12 value */
	mtp_ulong t13;			/* timer t13 value */
	mtp_ulong t14;			/* timer t14 value */
	mtp_ulong t17;			/* timer t17 value */
	mtp_ulong t19a;			/* timer t19a value */
	mtp_ulong t20a;			/* timer t20a value */
	mtp_ulong t21a;			/* timer t21a value */
	mtp_ulong t22;			/* timer t22 value */
	mtp_ulong t23;			/* timer t23 value */
	mtp_ulong t24;			/* timer t24 value */
	mtp_ulong t31a;			/* timer t31a value */
	mtp_ulong t32a;			/* timer t32a value */
	mtp_ulong t33a;			/* timer t33a value */
	mtp_ulong t34a;			/* timer t34a value */
	mtp_ulong t1t;			/* timer t1t value */
	mtp_ulong t2t;			/* timer t2t value */
	mtp_ulong t1s;			/* timer t1s value */
} mtp_opt_conf_sl_t;

/*
 *  Link set options
 */
typedef struct mtp_opt_conf_lk {
	/* signalling link timers */
	mtp_ulong t1;			/* timer t1 value */
	mtp_ulong t2;			/* timer t2 value */
	mtp_ulong t3;			/* timer t3 value */
	mtp_ulong t4;			/* timer t4 value */
	mtp_ulong t5;			/* timer t5 value */
	mtp_ulong t12;			/* timer t12 value */
	mtp_ulong t13;			/* timer t13 value */
	mtp_ulong t14;			/* timer t14 value */
	mtp_ulong t17;			/* timer t17 value */
	mtp_ulong t19a;			/* timer t19a value */
	mtp_ulong t20a;			/* timer t20a value */
	mtp_ulong t21a;			/* timer t21a value */
	mtp_ulong t22;			/* timer t22 value */
	mtp_ulong t23;			/* timer t23 value */
	mtp_ulong t24;			/* timer t24 value */
	mtp_ulong t31a;			/* timer t31a value */
	mtp_ulong t32a;			/* timer t32a value */
	mtp_ulong t33a;			/* timer t33a value */
	mtp_ulong t34a;			/* timer t34a value */
	mtp_ulong t1t;			/* timer t1t value */
	mtp_ulong t2t;			/* timer t2t value */
	mtp_ulong t1s;			/* timer t1s value */
	/* link timers */
	mtp_ulong t7;			/* timer t7 value */
	mtp_ulong t19;			/* timer t19 value */
	mtp_ulong t21;			/* timer t21 value */
	mtp_ulong t25a;			/* timer t25a value */
	mtp_ulong t28a;			/* timer t28a value */
	mtp_ulong t29a;			/* timer t29a value */
	mtp_ulong t30a;			/* timer t30a value */
} mtp_opt_conf_lk_t;

/*
 *  Combined link set options
 */
typedef struct mtp_opt_conf_ls {
	/* signalling link timers */
	mtp_ulong t1;			/* timer t1 value */
	mtp_ulong t2;			/* timer t2 value */
	mtp_ulong t3;			/* timer t3 value */
	mtp_ulong t4;			/* timer t4 value */
	mtp_ulong t5;			/* timer t5 value */
	mtp_ulong t12;			/* timer t12 value */
	mtp_ulong t13;			/* timer t13 value */
	mtp_ulong t14;			/* timer t14 value */
	mtp_ulong t17;			/* timer t17 value */
	mtp_ulong t19a;			/* timer t19a value */
	mtp_ulong t20a;			/* timer t20a value */
	mtp_ulong t21a;			/* timer t21a value */
	mtp_ulong t22;			/* timer t22 value */
	mtp_ulong t23;			/* timer t23 value */
	mtp_ulong t24;			/* timer t24 value */
	mtp_ulong t31a;			/* timer t31a value */
	mtp_ulong t32a;			/* timer t32a value */
	mtp_ulong t33a;			/* timer t33a value */
	mtp_ulong t34a;			/* timer t34a value */
	mtp_ulong t1t;			/* timer t1t value */
	mtp_ulong t2t;			/* timer t2t value */
	mtp_ulong t1s;			/* timer t1s value */
	/* link timers */
	mtp_ulong t7;			/* timer t7 value */
	mtp_ulong t19;			/* timer t19 value */
	mtp_ulong t21;			/* timer t21 value */
	mtp_ulong t25a;			/* timer t25a value */
	mtp_ulong t28a;			/* timer t28a value */
	mtp_ulong t29a;			/* timer t29a value */
	mtp_ulong t30a;			/* timer t30a value */
} mtp_opt_conf_ls_t;

/*
 *  Route options
 */
typedef struct mtp_opt_conf_rt {
	/* route timers */
	mtp_ulong t6;			/* timer t6 value */
	mtp_ulong t10;			/* timer t10 value */
} mtp_opt_conf_rt_t;

/*
 *  Route list options
 */
typedef struct mtp_opt_conf_rl {
	/* route timers */
	mtp_ulong t6;			/* timer t6 value */
	mtp_ulong t10;			/* timer t10 value */
} mtp_opt_conf_rl_t;

/*
 *  Route set options
 */
typedef struct mtp_opt_conf_rs {
	/* route timers */
	mtp_ulong t6;			/* timer t6 value */
	mtp_ulong t10;			/* timer t10 value */
	/* route set timers */
	mtp_ulong t8;			/* timer t8 value */
	mtp_ulong t11;			/* timer t11 value */
	mtp_ulong t15;			/* timer t15 value */
	mtp_ulong t16;			/* timer t16 value */
	mtp_ulong t18a;			/* timer t18a value */
} mtp_opt_conf_rs_t;

/*
 *  Signalling point options
 */
typedef struct mtp_opt_conf_sp {
	/* signalling link timers */
	mtp_ulong t1;			/* timer t1 value */
	mtp_ulong t2;			/* timer t2 value */
	mtp_ulong t3;			/* timer t3 value */
	mtp_ulong t4;			/* timer t4 value */
	mtp_ulong t5;			/* timer t5 value */
	mtp_ulong t12;			/* timer t12 value */
	mtp_ulong t13;			/* timer t13 value */
	mtp_ulong t14;			/* timer t14 value */
	mtp_ulong t17;			/* timer t17 value */
	mtp_ulong t19a;			/* timer t19a value */
	mtp_ulong t20a;			/* timer t20a value */
	mtp_ulong t21a;			/* timer t21a value */
	mtp_ulong t22;			/* timer t22 value */
	mtp_ulong t23;			/* timer t23 value */
	mtp_ulong t24;			/* timer t24 value */
	mtp_ulong t31a;			/* timer t31a value */
	mtp_ulong t32a;			/* timer t32a value */
	mtp_ulong t33a;			/* timer t33a value */
	mtp_ulong t34a;			/* timer t34a value */
	mtp_ulong t1t;			/* timer t1t value */
	mtp_ulong t2t;			/* timer t2t value */
	mtp_ulong t1s;			/* timer t1s value */
	/* link timers */
	mtp_ulong t7;			/* timer t7 value */
	mtp_ulong t19;			/* timer t19 value */
	mtp_ulong t21;			/* timer t21 value */
	mtp_ulong t25a;			/* timer t25a value */
	mtp_ulong t28a;			/* timer t28a value */
	mtp_ulong t29a;			/* timer t29a value */
	mtp_ulong t30a;			/* timer t30a value */
	/* route timers */
	mtp_ulong t6;			/* timer t6 value */
	mtp_ulong t10;			/* timer t10 value */
	/* route set timers */
	mtp_ulong t8;			/* timer t8 value */
	mtp_ulong t11;			/* timer t11 value */
	mtp_ulong t15;			/* timer t15 value */
	mtp_ulong t16;			/* timer t16 value */
	mtp_ulong t18a;			/* timer t18a value */
	/* signalling point timers */
	mtp_ulong t1r;			/* timer t1r value */
	mtp_ulong t18;			/* timer t18 value */
	mtp_ulong t20;			/* timer t20 value */
	mtp_ulong t22a;			/* timer t22a value */
	mtp_ulong t23a;			/* timer t23a value */
	mtp_ulong t24a;			/* timer t24a value */
	mtp_ulong t26a;			/* timer t26a value */
	mtp_ulong t27a;			/* timer t27a value */
} mtp_opt_conf_sp_t;

/*
 *  Network appearance options
 */
typedef struct mtp_opt_conf_na {
	/* signalling link timers */
	mtp_ulong t1;			/* timer t1 value */
	mtp_ulong t2;			/* timer t2 value */
	mtp_ulong t3;			/* timer t3 value */
	mtp_ulong t4;			/* timer t4 value */
	mtp_ulong t5;			/* timer t5 value */
	mtp_ulong t12;			/* timer t12 value */
	mtp_ulong t13;			/* timer t13 value */
	mtp_ulong t14;			/* timer t14 value */
	mtp_ulong t17;			/* timer t17 value */
	mtp_ulong t19a;			/* timer t19a value */
	mtp_ulong t20a;			/* timer t20a value */
	mtp_ulong t21a;			/* timer t21a value */
	mtp_ulong t22;			/* timer t22 value */
	mtp_ulong t23;			/* timer t23 value */
	mtp_ulong t24;			/* timer t24 value */
	mtp_ulong t31a;			/* timer t31a value */
	mtp_ulong t32a;			/* timer t32a value */
	mtp_ulong t33a;			/* timer t33a value */
	mtp_ulong t34a;			/* timer t34a value */
	mtp_ulong t1t;			/* timer t1t value */
	mtp_ulong t2t;			/* timer t2t value */
	mtp_ulong t1s;			/* timer t1s value */
	/* link timers */
	mtp_ulong t7;			/* timer t7 value */
	mtp_ulong t19;			/* timer t19 value */
	mtp_ulong t21;			/* timer t21 value */
	mtp_ulong t25a;			/* timer t25a value */
	mtp_ulong t28a;			/* timer t28a value */
	mtp_ulong t29a;			/* timer t29a value */
	mtp_ulong t30a;			/* timer t30a value */
	/* route timers */
	mtp_ulong t6;			/* timer t6 value */
	mtp_ulong t10;			/* timer t10 value */
	/* route set timers */
	mtp_ulong t8;			/* timer t8 value */
	mtp_ulong t11;			/* timer t11 value */
	mtp_ulong t15;			/* timer t15 value */
	mtp_ulong t16;			/* timer t16 value */
	mtp_ulong t18a;			/* timer t18a value */
	/* signalling point timers */
	mtp_ulong t1r;			/* timer t1r value */
	mtp_ulong t18;			/* timer t18 value */
	mtp_ulong t20;			/* timer t20 value */
	mtp_ulong t22a;			/* timer t22a value */
	mtp_ulong t23a;			/* timer t23a value */
	mtp_ulong t24a;			/* timer t24a value */
	mtp_ulong t26a;			/* timer t26a value */
	mtp_ulong t27a;			/* timer t27a value */
} mtp_opt_conf_na_t;

/*
 *  Default options
 */
typedef struct mtp_opt_conf_df {
} mtp_opt_conf_df_t;

typedef union mtp_option_obj {
	struct mtp_opt_conf_na na;	/* Network Appearance */
	struct mtp_opt_conf_sp sp;	/* Signalling Point */
	struct mtp_opt_conf_rs rs;	/* Route Set */
	struct mtp_opt_conf_rl rl;	/* Route List */
	struct mtp_opt_conf_rt rt;	/* Route */
	struct mtp_opt_conf_ls ls;	/* Combined Link Set */
	struct mtp_opt_conf_lk lk;	/* Link Set */
	struct mtp_opt_conf_sl sl;	/* Signalling Link */
	struct mtp_opt_conf_df df;	/* Default */
} mtp_option_obj_t;

/*
 *  OPTIONS
 */
typedef struct mtp_option {
	mtp_ulong type;			/* object type */
	mtp_ulong id;			/* object id */
	/* followed by object-specific protocol options structure */
	mtp_option_obj_t options[0];
} mtp_option_t;

#define	MTP_IOCGOPTION	_IOWR(	MTP_IOC_MAGIC,	 0,	mtp_option_t	)
#define	MTP_IOCSOPTION	_IOWR(	MTP_IOC_MAGIC,	 1,	mtp_option_t	)

/*
 *  Signalling link configuration
 */
typedef struct mtp_conf_sl {
	mtp_ulong muxid;		/* lower multiplexor id */
	mtp_ulong lkid;			/* link set id */
	mtp_ulong slc;			/* signalling link code in lk */
} mtp_conf_sl_t;

/*
 *  Link set configuration
 */
typedef struct mtp_conf_lk {
	mtp_ulong lsid;			/* combined link set id */