sdli.h

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

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

 @(#) sdli.h,v 0.9.2.3 2006/09/18 13:52:34 brian Exp

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

 Copyright (C) 2001-2004  OpenSS7 Corporation <http://www.openss7.com>

 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 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 2006/09/18 13:52:34 by brian

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

#ifndef __SDLI_H__
#define __SDLI_H__

#ident "@(#) sdli.h,v openss7-0_9_2_E(0.9.2.3) Copyright (c) 2001-2004  OpenSS7 Corporation"

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

/*
 *  The purpose of the SDL interface is to provide separation between the
 *  SDTI (Signalling Data Terminal Interface) which provides SS7 Signalling
 *  Data Terminal (SDT) state machine services including DAEDR, DAEDT, AERM,
 *  SUERM and EIM, and the underlying driver which provides access to the
 *  line (L1).
 */

typedef lmi_long sdl_long;
typedef lmi_ulong sdl_ulong;
typedef lmi_ushort sdl_ushort;
typedef lmi_uchar sdl_uchar;

#define SDL_PROTO_BASE			 32L

#define SDL_DSTR_FIRST			( 1L + SDL_PROTO_BASE)
#define SDL_BITS_FOR_TRANSMISSION_REQ	( 1L + SDL_PROTO_BASE)
#define SDL_CONNECT_REQ			( 2L + SDL_PROTO_BASE)
#define SDL_DISCONNECT_REQ		( 3L + SDL_PROTO_BASE)
#define SDL_DSTR_LAST			( 3L + SDL_PROTO_BASE)

#define SDL_USTR_LAST			(-1L - SDL_PROTO_BASE)
#define SDL_RECEIVED_BITS_IND		(-1L - SDL_PROTO_BASE)
#define SDL_DISCONNECT_IND		(-2L - SDL_PROTO_BASE)
#define SDL_USTR_FIRST			(-2L - SDL_PROTO_BASE)

/*
 *  SDLI PROTOCOL PRIMITIVES
 */

/*
 *  SDL_BITS_FOR_TRANSMISSION_REQ, M_PROTO w/ M_DATA or M_DATA
 *  -------------------------------------------------------------------------
 *  Used by the SDT to send bits to the SDL.
 */
typedef struct {
	sdl_long sdl_primitive;		/* SDL_BITS_FOR_TRANSMISSION_REQ */
} sdl_bits_for_transmission_req_t;

/*
 *  SDL_CONNECT_REQ, M_PROTO or M_PCPROTO
 *  -------------------------------------------------------------------------
 *  Used by the SDT to request that it be connected to the line.  Connection
 *  to the line might require some switching or other mecahnism.
 */
typedef struct {
	sdl_long sdl_primitive;		/* SDL_CONNECT_REQ */
	sdl_ulong sdl_flags;		/* direction flags */
} sdl_connect_req_t;

#define SDL_RX_DIRECTION	0x01
#define SDL_TX_DIRECTION	0x02

/*
 *  SDL_DISCONNECT_REQ, M_PROTO or M_PCPROTO
 *  -------------------------------------------------------------------------
 *  Used by the SDT to request that it be disconnected from the line.
 *  Disconnection from the line might require some switching or other
 *  mecahnism.
 */
typedef struct {
	sdl_long sdl_primitive;		/* SDL_DISCONNECT_REQ */
	sdl_ulong sdl_flags;		/* direction flags */
} sdl_disconnect_req_t;

/*
 *  SDL_RECEIVED_BITS_IND, M_PROTO w/ M_DATA or M_DATA
 *  -------------------------------------------------------------------------
 *  Used by the SDL to send received bits to the SDT.
 */
typedef struct {
	sdl_long sdl_primitive;		/* SDL_RECEIVED_BITS_IND */
} sdl_received_bits_ind_t;

/*
 *  SDL_DISCONNECT_IND, M_PROTO or M_PCPROTO
 *  -------------------------------------------------------------------------
 *  Used by the SDL to indicated to the SDT that it has been disconnected from
 *  the line.
 */
typedef struct {
	sdl_long sdl_primitive;		/* SDL_DISCONNECT_IND */
} sdl_disconnect_ind_t;

union SDL_primitives {
	sdl_long sdl_primitive;
	sdl_bits_for_transmission_req_t bits_for_transmission_req;
	sdl_connect_req_t connect_req;
	sdl_disconnect_req_t disconnect_req;
	sdl_received_bits_ind_t received_bits_ind;
	sdl_disconnect_ind_t disconnect_ind;
};

#define SDL_BITS_FOR_TRANSMISSION_REQ_SIZE	sizeof(sdl_bits_for_transmission_req_t)
#define SDL_CONNECT_REQ_SIZE			sizeof(sdl_connect_req_t)
#define SDL_DISCONNECT_REQ_SIZE			sizeof(sdl_disconnect_req_t)
#define SDL_RECEIVED_BITS_IND_SIZE		sizeof(sdl_received_bits_ind_t)
#define SDL_DISCONNECT_IND_SIZE			sizeof(sdl_disconnect_ind_t)

#endif				/* __SDLI_H__ */