text: /***************************************************************************//**
   * @file
   * @brief Board Controller Communications Protocol (BCP) definitions
   * @version 5.6.0
   *******************************************************************************
   * # License
   * <b>Copyright 2015 Silicon Labs, Inc. http://www.silabs.com</b>
   *******************************************************************************
   *
   * This file is licensed under the Silabs License Agreement. See the file
   * "Silabs_License_Agreement.txt" for details. Before using this software for
   * any purpose, you must agree to the terms of that agreement.
   *
   ******************************************************************************/
  
  #ifndef __BSP_BCP_H
  #define __BSP_BCP_H
  #include <stdint.h>
  
  #if defined(HAL_CONFIG)
  #include "bsphalconfig.h"
  #else
  #include "bspconfig.h"
  #endif
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /***************************************************************************//**
   * @addtogroup BSP
   * @{
   ******************************************************************************/
  /***************************************************************************//**
   * @addtogroup BSP_STK API for STKs and WSTKs
   * @{
   ******************************************************************************/
  
  /* BCP Packet Types */
  #define BSP_BCP_INVALID          0   /**< Invalid packet received */
  
  #define BSP_BCP_FIRST            1   /**< Smallest numerical value of  message type */
  
  #define BSP_BCP_ACK              5   /**< Generic ACK for one way packages */
  #define BSP_BCP_ECHO_REQ         10  /**< EFM32 BC alive request */
  #define BSP_BCP_ECHO_REPLY       11  /**< BC alive response */
  #define BSP_BCP_CURRENT_REQ      14  /**< EFM32 Request AEM current */
  #define BSP_BCP_CURRENT_REPLY    16  /**< BC Response AEM current */
  #define BSP_BCP_VOLTAGE_REQ      18  /**< EFM32 Request AEM voltage */
  #define BSP_BCP_VOLTAGE_REPLY    20  /**< BC Response AEM voltage */
  #define BSP_BCP_ENERGYMODE       22  /**< EFM32 Report Energy Mode (for AEM) */
  #define BSP_BCP_STDOUT           24  /**< Debug packet (not used)  */
  #define BSP_BCP_STDERR           26  /**< Debug packet (not used)  */
  #define BSP_BCP_TEST             32  /**< Reserved type for test */
  #define BSP_BCP_TEST_REPLY       33  /**< Reserved type for test (reply) */
  #define BSP_BCP_NET_REQUEST      64  /**< Net gateway request packet */
  #define BSP_BCP_NET_REPLY        65  /**< Net gateway reply packet */
  
  #define BSP_BCP_LAST             100 /**< Last defined message type */
  
  #define BSP_BCP_MAGIC            0xF1 /**< Magic byte to indicate start of packet */
  
  #if ( (BSP_BCP_VERSION == 1) || DOXY_DOC_ONLY)
  
  #ifdef DOXY_DOC_ONLY
  /* Hack for doxygen doc ! */
  #define BSP_BCP_PACKET_SIZe      30 /**< Max packet size for version 1 of the protocol. */
  #else
  #define BSP_BCP_PACKET_SIZE      30 /**< Max packet size for version 1 of the protocol. */
  #endif
  
  /** @brief BCP Packet Structure - Board controller communication protocol version 1. */
  typedef struct {
    uint8_t magic;                      /**< Magic - start of packet - must be BSP_BCP_MAGIC */
    uint8_t type;                       /**< Type of packet */
    uint8_t payloadLength;              /**< Length of data segment >=0 and <=BSP_BCP_PACKET_SIZE */
    uint8_t data[BSP_BCP_PACKET_SIZE];  /**< BCP Packet Data payload */
  #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  /**< Max packet size for version 2 of the protocol. */
  
  /** @brief BCP Packet Structure - Board controller communication protocol version 2. */
  typedef struct {
    uint8_t magic;                      /**< Magic - start of packet - must be BSP_BCP_MAGIC */
    uint8_t type;                       /**< Type - packet type */
    uint8_t payloadLength;              /**< Length of data segment >=0 and <=BSP_BCP_PACKET_SIZE */
    uint8_t reserved;                   /**< Reserved for future expansion */
    uint8_t data[BSP_BCP_PACKET_SIZE];  /**< BCP Packet Data payload */
  } BCP_Packet;
  
  /** @brief BCP Packet Header definition */
  typedef struct {
    uint8_t magic;                    /**< Magic - start of packet - must be BSP_BCP_MAGIC */
    uint8_t type;                     /**< Type - packet type */
    uint8_t payloadLength;            /**< Length of data segment >=0 and <=BSP_BCP_PACKET_SIZE */
    uint8_t reserved;                 /**< Reserved for future expansion */
  } 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
  
  /** @} (end group BSP_STK) */
  /** @} (end group BSP) */
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* __BSP_BCP_H */
  