rl_protocol.h

/****************************************************************************************
 * FileName     : rl_protocol.h
 *
 * Description  : This file defines the functions required for Communication Protocol
 *
 ****************************************************************************************
 * (C) Copyright 2014, Texas Instruments Incorporated. - TI web address www.ti.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 Texas Instruments Incorporated 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.
 */
/****************************************************************************************
 * FILE INCLUSION PROTECTION
 ****************************************************************************************
 */
#ifndef RL_PROTOCOL_H
#define RL_PROTOCOL_H

/******************************************************************************
 * INCLUDE FILES
 ******************************************************************************
 */

#ifdef __cplusplus
extern "C" {
#endif

/* RHCP Length Constants*/
#define SYNC_PATTERN_LEN                    (4U)
#define RHCP_HEADER_LEN                     (12U)
#define RL_CRC_LEN_MAX                      (8U)     /* RHCP CRC max Length in bytes */

#define RL_CMD_PL_LEN_MAX                   ((RL_MAX_SIZE_MSG - (SYNC_PATTERN_LEN \
                                             + RHCP_HEADER_LEN + RL_CRC_LEN_MAX)))

typedef rlUInt16_t rlSysNRespType_t;

typedef struct rlErrorResp
{
    rlSysNRespType_t   errorType;
    rlUInt16_t            sbcID;
}rlErrorResp_t;


typedef struct rlSyncPattern
{
    rlUInt16_t sync1;
    rlUInt16_t sync2;
}rlSyncPattern_t;

#ifndef MMWL_BIG_ENDIAN
typedef struct rlOpcode
{
    rlUInt16_t     b4Direction         : 4;
    rlUInt16_t     b2MsgType           : 2;
    rlUInt16_t     b10MsgId            : 10;

}rlOpcode_t;
#else
typedef struct rlOpcode
{
    rlUInt16_t     b10MsgId            : 10;
    rlUInt16_t     b2MsgType           : 2;
    rlUInt16_t     b4Direction         : 4;
}rlOpcode_t;
#endif

#ifndef MMWL_BIG_ENDIAN
typedef struct rlHdrFlags
{
    rlUInt16_t     b2RetryFlag        : 2;
    rlUInt16_t     b2AckFlag          : 2;
    rlUInt16_t     b4Version          : 4;
    rlUInt16_t     b2Crc              : 2;
    rlUInt16_t     b2CrcLen           : 2;
    rlUInt16_t     b4SeqNum           : 4;
}rlHdrFlags_t;
#else
typedef struct rlHdrFlags
{
    rlUInt16_t     b4SeqNum           : 4;
    rlUInt16_t     b2CrcLen           : 2;
    rlUInt16_t     b2Crc              : 2;
    rlUInt16_t     b4Version          : 4;
    rlUInt16_t     b2AckFlag          : 2;
    rlUInt16_t     b2RetryFlag        : 2;
}rlHdrFlags_t;

#endif

typedef struct rlProtHeader
{
    rlOpcode_t opcode;
    rlUInt16_t len;
    rlHdrFlags_t flags;
    rlUInt16_t remChunks;
    rlUInt16_t nsbc;
    rlUInt16_t chksum;
}rlProtHeader_t;

typedef struct rlRhcpMsg
{
    rlSyncPattern_t syncPattern;
    rlProtHeader_t  hdr;
    rlUInt8_t      payload[RL_CMD_PL_LEN_MAX + RL_CRC_LEN_MAX];
}rlRhcpMsg_t;


#ifdef __cplusplus
}
#endif

#endif
/*
 * END OF RL_PROTOCOL_H FILE
 */