esos_ecan.h

Go to the documentation of this file.

/*
 * "Copyright (c) 2019 J. W. Bruce ("AUTHOR(S)")"
 * All rights reserved.
 * (J. W. Bruce, jwbruce_AT_tntech.edu, Tennessee Tech University)
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement is
 * hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the authors appear in all copies of this software.
 *
 * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 * Please maintain this header in its entirety when copying/modifying
 * these files.
 *
 *
 */
 
#ifndef ESOS_ECAN_H
#define ESOS_ECAN_H
 
/* I N C L U D E S **********************************************************/
#include    "esos.h"
 
/* D E F I N E S ************************************************************/
#define MAX_CANFACTORY_CLIENTS  32
#define DEFAULT_MSG_ID      0x7a0
#define DEBUG_MODE        ESOS_USER_FLAG_F
 
#define ENABLE_DEBUG_MODE()   esos_SetUserFlag(DEBUG_MODE)
#define DISABLE_DEBUG_MODE()  esos_ClearUserFlag(DEBUG_MODE)
#define CHECK_DEBUG_MODE_ENABLED()    esos_IsUserFlagSet(DEBUG_MODE)
 
#define TRUE                    1
#define FALSE                   0
 
/* S T R U C T U R E S ******************************************************/
typedef enum {
  MASKCONTROL_FIELD_NONZERO,
  MASKCONTROL_EQUAL
} maskcontrol_t;
 
typedef struct {
  uint16_t        u16_canID;
  uint16_t        u16_idMask;
  maskcontrol_t   m_idMaskControl;
  uint8_t (*pf_task) (ESOS_TASK_HANDLE pst_Task);
  //uint8_t(*pfn) (struct stTask *pst_Task);
} client_t;
 
/* P U B L I C  P R O T O T Y P E S *****************************************/
//void esos_ecan_send ( uint16_t u16_can_id, uint8_t *pu8_msg, uint8_t u8_len );
 
#define ESOS_ECAN_SEND(u16_can_id,pu8_msg,u8_len)   { \
                                                        do { \
                                                            ESOS_TASK_HANDLE __esos_ecan_hTask; \
                                                            MAILMESSAGE __esos_ecan_mailMsg; \
                                                            uint8_t __esos_mail_msgBuf[ sizeof( uint16_t ) + 8 * sizeof( uint8_t ) ]; \
                                                            __esos_ecan_hTask = esos_GetTaskHandle( CANFactory ); \
                                                            if ( ESOS_TASK_MAILBOX_GOT_AT_LEAST_DATA_BYTES( __esos_ecan_hTask, __MAIL_MSG_HEADER_LEN + sizeof( uint8_t ) * u8_len + sizeof( uint16_t ) ) ) { \
                                                                *( ( uint16_t* ) &__esos_mail_msgBuf[0] ) = u16_can_id; \
                                                                memcpy( &__esos_mail_msgBuf[ sizeof( uint16_t ) ], pu8_msg, u8_len ); \
                                                                ESOS_TASK_MAKE_MSG_AUINT8 ( __esos_ecan_mailMsg, __esos_mail_msgBuf, sizeof( uint8_t ) * u8_len + sizeof( uint16_t ) ); \
                                                                ESOS_TASK_SEND_MESSAGE( __esos_ecan_hTask, &__esos_ecan_mailMsg ); \
                                                            } \
                                                        } while ( 0 ); \
                                                    }
 
void esos_ecan_canfactory_subscribe(ESOS_TASK_HANDLE pst_Task, uint16_t u16_can_id, uint16_t u16_mask, maskcontrol_t m_mask_control);
 
void esos_ecan_canfactory_unsubscribe(uint8_t(*pst_Task) (ESOS_TASK_HANDLE), uint16_t u16_can_id, uint16_t u16_mask, maskcontrol_t m_mask_control);
 
BOOL esos_ecan_mask_check (uint16_t u16_subscribed, uint16_t u16_recieved, uint16_t u16_mask);
 
ESOS_USER_TASK ( CANFactory );
 
#endif  /* ESOS_ECAN_H */