sensor_database.h

#ifndef _AVRIO_WUSB_SENSOR_DATABASE_H_
#define _AVRIO_WUSB_SENSOR_DATABASE_H_

#include <avrio/wusb/sensor.h>
#include "wusb-config.h"

__BEGIN_C_DECLS
/* ========================================================================== */
/* constants ================================================================ */
typedef enum {

  /* Flags */
  WSDBASE_VALID_DID   = 3, 
  WSDBASE_TX_SEQN     = 4, 
  WSDBASE_RX_SEQN     = 5, 
  /* Status */
  WSDBASE_BACKDATA    = 6, 
  WSDBASE_NOTIFY      = 7  
} eWSensorRecordFlags;

#define WSDBASE_SENSOR_INIT_FLAGS (0)

#define WSDBASE_SENSOR_FILE_SIZE(DbaseSize) (sizeof(uint16_t)+sizeof(xWSensorRecord)*(DbaseSize))

#define WSDBASE_SENSOR_DBASE_SIZE(FileSize) ((FileSize-sizeof(uint16_t))/sizeof(xWSensorRecord))

/* structures =============================================================== */
typedef struct xWSensorRecord {

  uint32_t ulMid;  
  uint8_t ucFlag;  
  uint8_t ucBackDataLength; 
  uint8_t pucBackData[WUSB_CONFIG_HUB_BACKDATA_SIZE];  
} xWSensorRecord;

typedef struct xWSensorDataBase {

  uint16_t usSize; 
  uint16_t usNextFreeDeviceId; 
} xWSensorDataBase;

/* == <API> == public application interface  =====class WusbSensorDataBase=== */
int iWSdBaseOpen (int iArg1, void * pvArg2);

uint16_t usWSdBaseAddSensor (uint32_t ulMid);

bool xWSdBaseDeleteSensor (uint16_t usDeviceId);

void vWSdBaseClear (void);

#if defined(__DOXYGEN__)

inline uint16_t usWSdBaseSize (void);

uint16_t usWSdBaseLength (void);

inline void vWSdBaseSetLength (uint16_t usLength);

uint8_t ucWSdBaseSensorFlag (uint16_t usDeviceId);

inline void vWSdBaseSensorSetFlag (uint16_t usDeviceId, uint8_t ucFlag);

uint8_t ucWSdBaseSensorBackDataLength (uint16_t usDeviceId);

void vWSdBaseSensorSetBackDataLength (uint16_t usDeviceId, uint8_t ucBackDataLength);

uint8_t ucWSdBaseSensorBackData (uint16_t usDeviceId, uint8_t * pucBackData);

inline void vWSdBaseSensorSetBackData ( uint16_t usDeviceId, 
                                        const uint8_t * pucBackData,
                                        uint8_t ucBackDataLength);                                       );

uint32_t ulWSdBaseSensorMid (uint16_t usDeviceId);

inline void vWSdBaseSensorSetMid (uint16_t usDeviceId, uint32_t ulMid);

int iWSdBaseInit (size_t xFileSize);

int iWSdBaseRead (void * pvAddress, uint8_t * pucData, size_t xDataLength);

int iWSdBaseWrite (void * pvAddress, const uint8_t * pucData, size_t xDataLength); 

void vWSdBaseFindNextFreeDeviceId (void);

inline uint16_t usWSdBaseNextFreeDeviceId (void);
/* == <API-END> == public application interface  ===class WusbSensorDataBase= */
#else /* __DOXYGEN__ defined */
/* internal public functions ================================================ */
int iWSdBaseRead (void * pvAddress, uint8_t * pucData, size_t xDataLength);
int iWSdBaseWrite (void * pvAddress, const uint8_t * pucData, size_t xDataLength); 
int iWSdBaseInit (size_t xFileSize);
uint16_t usWSdBaseLength (void);
void vWSdBaseFindNextFreeDeviceId (void);
uint32_t ulWSdBaseSensorMid (uint16_t usDeviceId);
uint8_t ucWSdBaseSensorFlag (uint16_t usDeviceId);
uint8_t ucWSdBaseSensorBackDataLength (uint16_t usDeviceId);
uint8_t ucWSdBaseSensorBackData (uint16_t usDeviceId, uint8_t * pucBackData);
void vWSdBaseSensorSetField (  uint16_t usDeviceId, uint8_t ucFieldOffset, 
                              const void * pvValue, uint8_t ucSizeOfValue);                              
/* public variables ========================================================= */
extern xWSensorDataBase dSensorDbase;

/* inline public functions ================================================== */
__STATIC_ALWAYS_INLINE (uint16_t 
usWSdBaseSize (void)) {

  return dSensorDbase.usSize;
}

__STATIC_ALWAYS_INLINE (uint16_t 
usWSdBaseNextFreeDeviceId (void)) {

  return dSensorDbase.usNextFreeDeviceId;
}

__STATIC_ALWAYS_INLINE (void
vWSdBaseSetLength (uint16_t usLength)) {

  iWSdBaseWrite (0, (const uint8_t *)&usLength, sizeof(uint16_t));
}

__STATIC_ALWAYS_INLINE (void 
vWSdBaseSensorSetMid (uint16_t usDeviceId, uint32_t ulMid)) {

  vWSdBaseSensorSetField (usDeviceId, 
                         STRUCT_FIELD_OFFSET(xWSensorRecord, ulMid),
                         &ulMid, sizeof(uint32_t));
}

__STATIC_ALWAYS_INLINE (void
vWSdBaseSensorSetFlag (uint16_t usDeviceId, uint8_t ucFlag)) {

  vWSdBaseSensorSetField (usDeviceId, 
                         STRUCT_FIELD_OFFSET(xWSensorRecord, ucFlag),
                         &ucFlag, sizeof(uint8_t));
}

__STATIC_ALWAYS_INLINE (void
vWSdBaseSensorSetBackDataLength (uint16_t usDeviceId, uint8_t ucBackDataLength)) {

  vWSdBaseSensorSetField (usDeviceId, 
                         STRUCT_FIELD_OFFSET(xWSensorRecord, ucBackDataLength),
                         &ucBackDataLength, sizeof(uint8_t));
}


__STATIC_ALWAYS_INLINE (void
vWSdBaseSensorSetBackData (uint16_t usDeviceId, const uint8_t * pucBackData, uint8_t ucBackDataLength)) {

  vWSdBaseSensorSetField (usDeviceId, 
                         STRUCT_FIELD_OFFSET(xWSensorRecord, pucBackData),
                         pucBackData, ucBackDataLength);
  vWSdBaseSensorSetBackDataLength (usDeviceId, ucBackDataLength);
}

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