avrio/wusb/hub.h

#ifndef _AVRIO_WUSB_HUB_H_
#define _AVRIO_WUSB_HUB_H_

#include <avrio/mutex.h>
#include <avrio/task.h>
#include <avrio/wusb/net/network.h>
#include <avrio/wusb/hub/sensor_database.h>

__BEGIN_C_DECLS
/* ========================================================================== */
/* macros =================================================================== */
/* constants ================================================================ */
#define WHUB_MAJOR  (0x01)
#define WHUB_MINOR  (0x00)
#define WHUB_BUILD  (0x00)

typedef enum  {

  WHUB_EEPROMBLANK    = 0,  
  /* Mode */
  WHUB_AUTOBIND       = 1, 
  WHUB_SEEDEDBIND     = 2, 
  WHUB_SEARCHCHANNEL  = 3, 
  /* Sensor Status */
  WHUB_BACKDATA       = 4, 
  WHUB_NODEBOUND      = 5, 
  /* Hub Status */
  WHUB_BIND           = 6, 
  WHUB_CONFIGSAVED    = 7  
} eWHubStatus;

typedef enum {

  WHUB_RESPONSE             = 0x80,
  WHUB_RSP_HUB_INFO         = 0x81,  
  WHUB_RSP_BIND             = 0x82,  
  WHUB_RSP_BIND_INFO        = 0x83,  
  WHUB_RSP_DELETE_NODE      = 0x84,  
  WHUB_RSP_SEND_MSG         = 0x85,  
  WHUB_RSP_INCOMING_MSG     = 0x86,  
  WHUB_RSP_ENUM_DEVICES     = 0x87,  
  WHUB_RSP_NETWORK_CONFIG   = 0x88,  
  WHUB_RSP_NETWORK_STATUS   = 0x89,  
  WHUB_RSP_RESET            = 0x8A,  
  WHUB_RSP_CHANGE_CHANNEL   = 0x8B,  
  WHUB_RSP_UNKNOWN_CMD      = 0xFF  
} eWHubMsgId;

typedef enum  {

  WHUB_STA_SUCCESS                = 0x00,
  WHUB_STA_UNKNOWN_ID             = 0x01,
  WHUB_STA_BUFFER_OVERFLOW        = 0x02,
  WHUB_STA_PRIOR_PAYLOAD_LOST     = 0x03,
  WHUB_STA_PN_CODE_INDEX_INVALID  = 0x04,
  WHUB_STA_CHANNEL_INVALID        = 0x05,
  WHUB_STA_MSG_QUEUED             = 0x06,

  WHUB_STA_SEARCH_CHANNEL_FAILURE = 0x08
} eWHubMsgStatus;

/* structures =============================================================== */
typedef struct xWHubMessage {

  uint8_t ucId; 
  uint8_t ucStatus;  
  uint16_t usDeviceId; 
  uint8_t ucDataLength; 
  uint8_t * pucData;  
} xWHubMessage;

typedef struct xWHubConfig {

  uint8_t ucStatus; 
  uint8_t ucDataChannel; 
  uint8_t ucBindChannel; 
  uint8_t ucDataPnCode;   
} xWHubConfig;

typedef struct xWHubService {

  xTaskHandle xTask;
  xMutex xModeMutex;  
  uint8_t ucRssiCounter;
} xWHubService;

typedef struct xWusbHub {

  uint8_t ucFlag; 
  uint8_t ucNoiseThreshold;
  xWHubService xService; 
  xWHubConfig xConfig; 
  xWHubMessage xMsg;
} xWusbHub;

/* == <API> == public application interface  ========class xWusbHub=========== */
int iWHubInit (  eWDevDataRate eDataRate, 
                int iSensorDbaseFileArg1, 
                void * pvSensorDbaseFileArg2);
const xWHubMessage * pxWHubLoop (void);

#if defined(__DOXYGEN__)

inline uint8_t ucWHubStatus (void);

inline bool xWHubStatusFlag (eWHubStatus eFlag);

void vWHubSetStatusFlag (eWHubStatus eFlag, bool xValue);

void vWHubToggleStatusFlag (eWHubStatus eFlag);

inline uint8_t ucWHubDataChannel (void);

bool xWHubSetDataChannel (uint8_t ucIndex);

inline uint8_t ucWHubBindChannel (void);

inline uint8_t ucWHubDataPnCode (void);

bool xWHubSetDataPnCode (uint8_t ucIndex);

inline const uint8_t * pucWHubMid (void);

void vWHubSetMid (const uint8_t * pucMid);

/*
 * @brief Passe de canal en canal dans le subset à la recherche le premier canal disponible
 */
void vWHubFindAnAvailableChannel (void);

inline uint16_t usWHubNumberOfNodes (void);

inline uint16_t usWHubMaxNumberOfNodes (void);

inline uint16_t usWHubDeleteAllNodes (void);

inline bool WHubNodeDelete (uint16_t ucDeviceId);

bool xWHubNodeFlag (uint16_t ucDeviceId, uint8_t * pucNodeFlag);

inline void vWHubNodeSetFlag (uint16_t ucDeviceId, uint8_t ucNodeFlag);

inline uint32_t ulWHubNodeMid (uint16_t ucDeviceId);

inline uint8_t ucWHubNodeDataLength (uint16_t ucDeviceId);

inline void vWHubNodeSetData (uint16_t ucDeviceId, uint8_t ucDataLength, const uint8_t * pucData);

/* == <API-END> == public application interface  ====class xWusbHub=========== */
#else /* __DOXYGEN__ defined */
/* internal public functions ================================================ */
bool xWHubNodeFlag (uint16_t ucDeviceId, uint8_t * pucNodeFlag);
bool xWHubSetDataPnCode (uint8_t ucIndex);
bool xWHubSetDataChannel (uint8_t ucIndex);
void vWHubSetMid (const uint8_t * pucMid);
void vWHubFindAnAvailableChannel (void);
void vWHubSetStatusFlag (eWHubStatus eFlag, bool xValue);
void vWHubToggleStatusFlag (eWHubStatus eFlag);

/* public variables ========================================================= */
extern xWusbHub dHub;

/* inline public functions ================================================== */

/*------------ Getters Hub Config -------------*/
__STATIC_ALWAYS_INLINE (uint8_t
ucWHubStatus (void)) {

  return dHub.xConfig.ucStatus;
}

__STATIC_ALWAYS_INLINE (bool
xWHubStatusFlag (eWHubStatus eFlag)) {

  return xWPktBit (dHub.xConfig.ucStatus, eFlag);
}

__STATIC_ALWAYS_INLINE (const uint8_t *
pucWHubMid (void)) {

  return pucWDevMid();
}

__STATIC_ALWAYS_INLINE (uint8_t
ucWHubDataChannel (void)) {

  return dHub.xConfig.ucDataChannel;
}

__STATIC_ALWAYS_INLINE (uint8_t 
ucWHubBindChannel (void)) {

  return dHub.xConfig.ucBindChannel;
}

__STATIC_ALWAYS_INLINE (uint8_t 
ucWHubDataPnCode (void)) {

  return dHub.xConfig.ucDataPnCode;
}

/*------------ Getters Node -------------*/
__STATIC_ALWAYS_INLINE (uint16_t
usWHubNumberOfNodes (void)) {

  return usWSdBaseLength();
}

__STATIC_ALWAYS_INLINE (uint16_t
usWHubMaxNumberOfNodes (void)) {

  return usWSdBaseSize();
}

__STATIC_ALWAYS_INLINE (size_t
ucWHubNodeDataLength (uint16_t ucDeviceId)) {

  return ucWSdBaseSensorBackDataLength (ucDeviceId);
}

__STATIC_ALWAYS_INLINE (uint32_t
ulWHubNodeMid (uint16_t ucDeviceId)) {

  return ulWSdBaseSensorMid (ucDeviceId);
}

/*------------ Setters Node -------------*/
__STATIC_ALWAYS_INLINE (void
usWHubDeleteAllNodes (void)) {

  vWSdBaseClear();
}

__STATIC_ALWAYS_INLINE (bool
WHubNodeDelete (uint16_t ucDeviceId)) {

  return xWSdBaseDeleteSensor (ucDeviceId);
}

__STATIC_ALWAYS_INLINE (void
vWHubNodeSetData (uint16_t ucDeviceId, uint8_t DataLength, const uint8_t * Data)) {

   vWSdBaseSensorSetBackData (ucDeviceId, Data, DataLength);
}

__STATIC_ALWAYS_INLINE (void
vWHubNodeSetFlag (uint16_t ucDeviceId, uint8_t NodeFlag)) {

  vWSdBaseSensorSetFlag (ucDeviceId, NodeFlag);
}

#endif  /* __DOXYGEN__ not defined */
/* ========================================================================== */
__END_C_DECLS
#endif  /* _AVRIO_WUSB_HUB_H_ */