CLCm_Message.h

Go to the documentation of this file.

//*********************************************************
// File:            CLCm_Message.h
// Project:         CopperLan CHAILink SDK Common Part
//                  For Client & Server
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef __CLCM_MESSAGE_H__
#define __CLCM_MESSAGE_H__

#include "CLCm_Defines.h"

#ifdef __cplusplus
extern "C" {
#endif


//=========================================================================
// Message map
//=========================================================================

/*  
    CopperLan CMD payload legend
        oh oh oh oh : Object handle
        mi mi       : Method ID (CMLID_* value)
        st st       : Status (used for function call return command)
        ** **       : n bytes of Arguments depending on Method IDs
        |           : end of payload

    CopperLan CMD message:
        oh oh oh oh
        mi mi st st
        ** ** |
*/

//=========================================================================
// CHAILink command message sizes & positions 
//=========================================================================

#define CLMSG_HEADER_OBJECTHANDLE_SIZE          (4)
#define CLMSG_HEADER_METHODID_SIZE              (2)
#define CLMSG_HEADER_STATUS_SIZE                (2)
#define CLMSG_HEADER_SIZE                       (CLMSG_HEADER_OBJECTHANDLE_SIZE + CLMSG_HEADER_METHODID_SIZE + CLMSG_HEADER_STATUS_SIZE)

#define CLMSG_HEADER_POS                        (0)
#define CLMSG_HEADER_OBJECTHANDLE_POS           (CLMSG_HEADER_POS)
#define CLMSG_HEADER_METHODID_POS               (CLMSG_HEADER_OBJECTHANDLE_POS + CLMSG_HEADER_OBJECTHANDLE_SIZE)
#define CLMSG_HEADER_STATUS_POS                 (CLMSG_HEADER_METHODID_POS + CLMSG_HEADER_METHODID_SIZE)
#define CLMSG_DATA_POS                          (CLMSG_HEADER_STATUS_POS + CLMSG_HEADER_STATUS_SIZE) 

#define CLMSG_ETHERNETFRAMEMAXSIZE                  (1500 + 18)     // This size correspond to a valid Ethernet 2 frame :
    //      18 bytes for header and
    //      1500 bytes for max payload
    //      The CRC is created or verified by the VNM Chip
#define CLMSG_ETHERNETMSGMAXSIZE                    (CLMSG_HEADER_SIZE + 2 + CLMSG_ETHERNETFRAMEMAXSIZE)

// Message size default and minimum size is 400
#define CLMSG_MESSAGEMINSIZE                        400
#define CLMSG_MESSAGEMAXSIZE                        CLMSG_ETHERNETMSGMAXSIZE

// CLMSG_MESSAGESIZE corresponds to the maximum CHAI Link message size except for Ethernet passthru messages.
// Check CLMSG_MESSAGESIZE
#if !defined(CLMSG_MESSAGESIZE)
#define CLMSG_MESSAGESIZE                           CLMSG_MESSAGEMINSIZE
#else
#if CLMSG_MESSAGESIZE < CLMSG_MESSAGEMINSIZE
#error CLMSG_MESSAGESIZE MUST be at least 400 bytes long.
#elif CLMSG_MESSAGESIZE > CLMSG_MESSAGEMAXSIZE
#error CLMSG_MESSAGESIZE MUST be less than CLMSG_MESSAGEMAXSIZE bytes long.
#endif
#endif

#define CLMSG_PAYLOADMAXSIZE                    (CLMSG_MESSAGESIZE - CLMSG_HEADER_SIZE)

#define DESERIALIZE_MSGHEADER(hObject, wMethodID, wStatus, ptr) \
    DESERIALIZE_UINT32(hObject, ptr); \
    DESERIALIZE_UINT16(wMethodID, ptr); \
    DESERIALIZE_UINT16(wStatus, ptr); \

#define SERIALIZE_MSGHEADER(ptr, hObject, wMethodID, wStatus) \
    SERIALIZE_UINT32(ptr, hObject); \
    SERIALIZE_UINT16(ptr, wMethodID); \
    SERIALIZE_UINT16(ptr, wStatus); \


#ifdef __cplusplus
}
#endif

#endif // __CLCM_MESSAGE_H__