cpmacro.h

Go to the documentation of this file.

/*****************************************************************************\
*  CANpie                                                                     *
*                                                                             *
*  File        : cpmacro.h                                                    *
*  Description : This file supplies some support macros for access of the     *
*                "CpStruct_CAN" message structure. The macros are a faster    *
*                solution compared to functions. However, there is the lack   *
*                of error checking. Please be aware of this when using these  *
*                macros.                                                      *
*  Author      : Uwe Koppe                                                    *
*  e-mail      : koppe@microcontrol.net                                       *
*                                                                             *
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - *
*                                                                             *
*   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.                                       *
*                                                                             *
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - *
*                                                                             *
*  History                                                                    *
*  Vers.    Date        Comment                                         Aut.  *
*  -----    ----------  ---------------------------------------------   ----  *
*  0.6      27.07.1999  Initial version                                 UK    *
*  0.7      09.02.2001  Fixed CpMacSetBufNum()                          UK    *
*  0.8                  - no changes -                                          *
*                                                                             *
\*****************************************************************************/


#ifndef  _CANpie_MacroSupport_
#define  _CANpie_MacroSupport_


#include "compiler.h"

/*-----------------------------------------------------------------------------
**    Online documentation for Doxygen
*/

/*-----------------------------------------------------------------------------
** CP_MASK_XXX
** mask for CAN message (RTR, Extended CAN)
*/


/*-------------------------------------------------------------------*/
#define  CP_MASK_STD_FRAME 0x000007FF


/*-------------------------------------------------------------------*/
#define  CP_MASK_EXT_FRAME 0x1FFFFFFF


/*-------------------------------------------------------------------*/
#define  CP_MASK_EXT_BIT   0x80000000


/*-------------------------------------------------------------------*/
#define  CP_MASK_RTR_BIT   0x40000000


/*-------------------------------------------------------------------*/
#define  CP_MASK_DLC_BITS  0x0000000F


/*-------------------------------------------------------------------*/
#define  CP_MASK_BUF_BITS  0x000000F0


#define  CpMacGetBufNum(MSG_PTR)          (_U08)(((MSG_PTR)->v_MsgFlags) >> 4)


#define  CpMacGetData(MSG_PTR, POS)       ( (MSG_PTR)->v_MsgData[POS] )


#define  CpMacGetDlc(MSG_PTR)             (_U08)(((MSG_PTR)->v_MsgFlags) & CP_MASK_DLC_BITS)


#define  CpMacGetExtId(MSG_PTR)           (((MSG_PTR)->v_MsgId) & CP_MASK_EXT_FRAME)


#define  CpMacGetStdId(MSG_PTR)           (_U16)(((MSG_PTR)->v_MsgId) & CP_MASK_STD_FRAME)


#define  CpMacIsExtended(MSG_PTR)         (_U08)(((MSG_PTR)->v_MsgId & CP_MASK_EXT_BIT ) != 0)


#define  CpMacIsRemote(MSG_PTR)           (_U08)(((MSG_PTR)->v_MsgId & CP_MASK_RTR_BIT) != 0)


#define  CpMacMsgClear(MSG_PTR)           (MSG_PTR)->v_MsgId= 0;(MSG_PTR)->v_MsgFlags = 0


#define  CpMacSetBufNum(MSG_PTR, VAL)     (MSG_PTR)->v_MsgFlags &= (~CP_MASK_BUF_BITS); (MSG_PTR)->v_MsgFlags |= (VAL << 4)


#define  CpMacSetData(MSG_PTR, POS, VAL)  (MSG_PTR)->v_MsgData[POS] = VAL


#define  CpMacSetDlc(MSG_PTR, DLC)        (MSG_PTR)->v_MsgFlags &= (~CP_MASK_DLC_BITS); (MSG_PTR)->v_MsgFlags |= DLC


#define  CpMacSetExtId(MSG_PTR, VAL)      (MSG_PTR)->v_MsgId = VAL | CP_MASK_EXT_BIT


#define  CpMacSetRemote(MSG_PTR)          (MSG_PTR)->v_MsgId |= CP_MASK_RTR_BIT


#define  CpMacSetStdId(MSG_PTR, VAL)      (MSG_PTR)->v_MsgId = VAL



#endif   /* _CANpie_MacroSupport_ */

---