freeswitch/libs/openzap/src/isdn/Q921.c

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

  FileName:     q921.c

  Description:  Contains the implementation of a Q.921 protocol on top of the
                Comet Driver.

                Most of the work required to execute a Q.921 protocol is 
                taken care of by the Comet ship and it's driver. This layer
                will simply configure and make use of these features to 
                complete a Q.921 implementation.

  Created:      27.dec.2000/JVB

  License/Copyright:

  Copyright (c) 2007, Jan Vidar Berger, Case Labs, Ltd. All rights reserved.
  email:janvb@caselaboratories.com  

  Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are 
  met:

    * Redistributions of source code must retain the above copyright notice, 
	  this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, 
	  this list of conditions and the following disclaimer in the documentation 
	  and/or other materials provided with the distribution.
    * Neither the name of the Case Labs, Ltd nor the names of its contributors 
	  may be used to endorse or promote products derived from this software 
	  without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
  POSSIBILITY OF SUCH DAMAGE.

*****************************************************************************/
#include "Q921.h"
#include <stdlib.h>
#include "mfifo.h"

/*****************************************************************************
  Global Tables & Variables.
*****************************************************************************/
#ifdef Q921_HANDLE_STATIC 
Q921Data Q921DevSpace[Q921MAXTRUNK];
#endif

int Q921HeaderSpace={0};

int (*Q921Tx21Proc)(L2TRUNK dev, L2UCHAR *, int)={NULL};
int (*Q921Tx23Proc)(L2TRUNK dev, L2UCHAR *, int)={NULL};

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

  Function:     Q921Init

  Decription:   Initialize the Q.921 stack so it is ready for use. This 
                function MUST be called as part of initializing the 
                application.

*****************************************************************************/
void Q921Init()
{
#ifdef Q921_HANDLE_STATIC
    int x;
    for(x=0; x<Q921MAXTRUNK;x++)
    {
		Q921_InitTrunk(x, 0, 0, Q921_TE);
    }
#endif
}

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

  Function:     Q921_InitTrunk

  Decription:   Initialize a Q.921 trunk so it is ready for use. This 
                function should be called before you call the rx functions
				if your trunk will not use hardcoded tei and sapi of 0 or
				if your trunk is not TE (user) mode (i.e. NET).

*****************************************************************************/
void Q921_InitTrunk(L2TRUNK trunk, L2UCHAR sapi, L2UCHAR tei, Q921NetUser_t NetUser)
{
	if (L2TRUNKHANDLE(trunk).initialized != INITIALIZED_MAGIC) {
		MFIFOCreate(L2TRUNKHANDLE(trunk).HDLCInQueue, Q921MAXHDLCSPACE, 10);
		L2TRUNKHANDLE(trunk).initialized = INITIALIZED_MAGIC;
	}
	L2TRUNKHANDLE(trunk).vr = 0;
	L2TRUNKHANDLE(trunk).vs = 0;
	L2TRUNKHANDLE(trunk).state = 0;
	L2TRUNKHANDLE(trunk).sapi = sapi;
	L2TRUNKHANDLE(trunk).tei = tei;
	L2TRUNKHANDLE(trunk).NetUser = NetUser;
}

void Q921SetHeaderSpace(int hspace)
{
    Q921HeaderSpace=hspace;
}

void Q921SetTx21CB(int (*callback)(L2TRUNK dev, L2UCHAR *, int))
{
    Q921Tx21Proc = callback;
}

void Q921SetTx23CB(int (*callback)(L2TRUNK dev, L2UCHAR *, int))
{
    Q921Tx23Proc = callback;
}

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

  Function:     Q921QueueHDLCFrame

  Description:  Called to receive and queue an incoming HDLC frame. Will
                queue this in Q921HDLCInQueue. The called must either call
                Q921Rx12 directly afterwards or signal Q921Rx12 to be called
                later. Q921Rx12 will read from the same queue and process
                the frame.

                This function assumes that the message contains header 
                space. This is removed for internal Q921 processing, but 
                must be keept for I frames.

  Parameters:   trunk   trunk #
                b       ptr to frame;
                size    size of frame in bytes

*****************************************************************************/
int Q921QueueHDLCFrame(L2TRUNK trunk, L2UCHAR *b, int size)
{
    return MFIFOWriteMes(L2TRUNKHANDLE(trunk).HDLCInQueue, b, size);
}

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

  Function:     Q921SendI

  Description:  Compose and Send I Frame to layer. Will receive an I frame
                with space for L2 header and fill out that header before
                it call Q921Tx21Proc.

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          P fiels octet 5
                mes         ptr to I frame message.
                size        size of message in bytes.

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendI(L2TRUNK trunk, L2UCHAR Sapi, char cr, L2UCHAR Tei, char pf, L2UCHAR *mes, int size)
{
    mes[Q921HeaderSpace+0] = (Sapi&0xfc) | ((cr<<1)&0x02);
    mes[Q921HeaderSpace+1] = (Tei<<1) | 0x01;
    mes[Q921HeaderSpace+2] = L2TRUNKHANDLE(trunk).vs<<1;
    mes[Q921HeaderSpace+3] = (L2TRUNKHANDLE(trunk).vr<<1) | (pf & 0x01);
    L2TRUNKHANDLE(trunk).vs++;

    return Q921Tx21Proc(trunk, mes, size);
}

int Q921Rx32(L2TRUNK trunk, L2UCHAR * Mes, L2INT Size)
{
	return Q921SendI(trunk, 
					L2TRUNKHANDLE(trunk).sapi, 
					L2TRUNKHANDLE(trunk).NetUser == Q921_TE ? 0 : 1,
					L2TRUNKHANDLE(trunk).tei, 
					0, 
					Mes, 
					Size);
}
/*****************************************************************************

  Function:     Q921SendRR

  Description:  Compose and send Receive Ready.

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          P/F fiels octet 5

  Return Value: 0 if failed, 1 if Send.

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

int Q921SendRR(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)0x01;
    mes[Q921HeaderSpace+3] = (L2UCHAR)((L2TRUNKHANDLE(trunk).vr<<1) | (pf & 0x01));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+4);
}

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

  Function:     Q921SendRNR

  Description:  Compose and send Receive Nor Ready

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          P/F fiels octet 5

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendRNR(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)0x05;
    mes[Q921HeaderSpace+3] = (L2UCHAR)((L2TRUNKHANDLE(trunk).vr<<1) | (pf & 0x01));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+4);
}

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

  Function:     Q921SendREJ

  Description:  Compose and Send Reject.

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          P/F fiels octet 5

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendREJ(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)0x09;
    mes[Q921HeaderSpace+3] = (L2UCHAR)((L2TRUNKHANDLE(trunk).vr<<1) | (pf & 0x01));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+4);
}

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

  Function:     Q921SendSABME

  Description:  Compose and send SABME

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          P fiels octet 4

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendSABME(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)(0x6f | ((pf<<4)&0x10));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+3);
}

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

  Function:     Q921SendDM

  Description:  Comose and Send DM (Disconnected Mode)

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          F fiels octet 4

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendDM(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)(0x0f | ((pf<<4)&0x10));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+3);
}

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

  Function:     Q921SendDISC

  Description:  Compose and Send Disconnect

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          P fiels octet 4

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendDISC(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)(0x43 | ((pf<<4)&0x10));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+3);
}

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

  Function:     Q921SendUA

  Description:  Compose and Send UA

  Parameters:   trunk       trunk #
                Sapi        Sapi
                cr          C/R field.
                Tei         Tei.
                pf          F fiels octet 4

  Return Value: 0 if failed, 1 if Send.

*****************************************************************************/
int Q921SendUA(L2TRUNK trunk, int Sapi, int cr, int Tei, int pf)
{
    L2UCHAR mes[400];

    mes[Q921HeaderSpace+0] = (L2UCHAR)((Sapi&0xfc) | ((cr<<1)&0x02));
    mes[Q921HeaderSpace+1] = (L2UCHAR)((Tei<<1) | 0x01);
    mes[Q921HeaderSpace+2] = (L2UCHAR)(0x63 | ((pf<<4)&0x10));

    return Q921Tx21Proc(trunk, mes, Q921HeaderSpace+3);
}

int Q921ProcSABME(L2TRUNK trunk, L2UCHAR *mes, int size)
{
	/* TODO:  Do we need these paramaters? */
	(void)mes;
	(void)size;

    L2TRUNKHANDLE(trunk).vr=0;
    L2TRUNKHANDLE(trunk).vs=0;

    return 1;
}

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

  Function:     Q921Rx12

  Description:  Called to process a message frame from layer 1. Will 
                identify the message and call the proper 'processor' for
                layer 2 messages and forward I frames to the layer 3 entity.

                Q921Rx12 will check the input fifo for a message, and if a 
                message exist process one message before it exits. The caller
                must either call Q921Rx12 polling or keep track on # 
                messages in the queue.

  Parameters:   trunk       trunk #.

  Return Value: # messages processed (always 1 or 0).

*****************************************************************************/
int Q921Rx12(L2TRUNK trunk)
{
    L2UCHAR *mes;
    int rs,size;     /* receive size & Q921 frame size*/
    L2UCHAR *smes = MFIFOGetMesPtr(L2TRUNKHANDLE(trunk).HDLCInQueue, &size);
    if(smes != NULL)
    {
        rs = size - Q921HeaderSpace;
        mes = &smes[Q921HeaderSpace];
        /* check for I frame */
        if((mes[2] & 0x01) == 0)
        {
            if(Q921Tx23Proc(trunk, smes, size-2)) /* -2 to clip away CRC */
            {
                L2TRUNKHANDLE(trunk).vr++;
                Q921SendRR(trunk, (mes[0]&0xfc)>>2, (mes[0]>>1)&0x01,mes[1]>>1, mes[3]&0x01);
            }
            else
            {
                /* todo: whatever*/
            }
        }

        /* check for RR */
        else if(mes[2] ==0x01)
        {
            /* todo: check if RR is responce to I */
            Q921SendRR(trunk, (mes[0]&0xfc)>>2, (mes[0]>>1)&0x01,mes[1]>>1, mes[2]&0x01);
        }

        /* check for RNR */
        /* check for REJ */
        /* check for SABME */
        else if((mes[2] & 0xef) == 0x6f)
        {
            Q921ProcSABME(trunk, mes, rs);
            Q921SendUA(trunk, (mes[0]&0xfc)>>2, (mes[0]>>1)&0x01,mes[1]>>1, (mes[2]&0x10)>>4);
        }

        /* check for DM */
        /* check for UI */
        /* check for DISC */
        /* check for UA */
        /* check for FRMR */
        /* check for XID */

        else
        {
            /* what the ? Issue an error */
			/* Q921ErrorProc(trunk, Q921_UNKNOWNFRAME, mes, rs); */
            /* todo: REJ or FRMR */
        }

        MFIFOKillNext(L2TRUNKHANDLE(trunk).HDLCInQueue);

        return 1;
    }
    return 0;
}