bsp_bcp.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef __BSP_BCP_H
#define __BSP_BCP_H
#include <stdint.h>

#include "bspconfig.h"

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************/
/***************************************************************************/
/* BCP Packet Types */
#define BSP_BCP_INVALID          0   
#define BSP_BCP_FIRST            1   
#define BSP_BCP_ACK              5   
#define BSP_BCP_ECHO_REQ         10  
#define BSP_BCP_ECHO_REPLY       11  
#define BSP_BCP_CURRENT_REQ      14  
#define BSP_BCP_CURRENT_REPLY    16  
#define BSP_BCP_VOLTAGE_REQ      18  
#define BSP_BCP_VOLTAGE_REPLY    20  
#define BSP_BCP_ENERGYMODE       22  
#define BSP_BCP_STDOUT           24  
#define BSP_BCP_STDERR           26  
#define BSP_BCP_TEST             32  
#define BSP_BCP_TEST_REPLY       33  
#define BSP_BCP_NET_REQUEST      64  
#define BSP_BCP_NET_REPLY        65  
#define BSP_BCP_LAST             100 
#define BSP_BCP_MAGIC            0xF1 
#if ( ( BSP_BCP_VERSION == 1 ) || DOXY_DOC_ONLY )

#ifdef DOXY_DOC_ONLY
                                    /* Hack for doxygen doc ! */
#define BSP_BCP_PACKET_SIZe      30 
#else
#define BSP_BCP_PACKET_SIZE      30 
#endif

typedef struct
{
  uint8_t magic;                      
  uint8_t type;                       
  uint8_t payloadLength;              
  uint8_t data[BSP_BCP_PACKET_SIZE];  
#ifdef DOXY_DOC_ONLY
} BCP_Packet_;                        /* Hack for doxygen doc ! */
#else
} BCP_Packet;
#endif
#endif




#if ( ( BSP_BCP_VERSION == 2 ) || DOXY_DOC_ONLY )

#define BSP_BCP_PACKET_SIZE      132  
typedef struct
{
  uint8_t magic;                      
  uint8_t type;                       
  uint8_t payloadLength;              
  uint8_t reserved;                   
  uint8_t data[BSP_BCP_PACKET_SIZE];  
} BCP_Packet;

typedef struct
{
  uint8_t magic;                    
  uint8_t type;                     
  uint8_t payloadLength;            
  uint8_t reserved;                 
} BCP_PacketHeader;
#endif




#if ( ( BSP_BCP_VERSION != 1 ) && ( BSP_BCP_VERSION != 2 ) )
#error "BSP BCP Board Controller communications protocol version error."
#endif

#if ( BSP_BCP_PACKET_SIZE >= 255 )
#error "BSP BCP Board Controller communications packets must be less than 255 bytes in size!"
#endif

#ifdef __cplusplus
}
#endif

#endif  /* __BSP_BCP_H */