eeprom.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////////////////
/// \file heivs/eeprom.h
/// \brief ARMEBS4 eeprom access functions
/// \author Pascal Sartoretti (sap at hevs dot ch)
//////////////////////////////////////////////////////////////////////////////////
/**
 * \addtogroup libheivs_stm32_eeprom External EEPROM
 * \brief Stores board SN, MAC address and Touchscreen calibration
 * \ingroup onboard
 * @{
 ***************************************************************************/
#ifndef HEIVS_EEPROM_H
#define HEIVS_EEPROM_H

#include <stdint.h>
#include "heivs/error.h"

#ifdef __cplusplus
    extern "C" {
#endif

//////////////////////////////////////////////////////////////////////////////////
/// \brief Returns the unique number from the EEPROM
/// \param number pointer to unique number for ARMEBS4 (1-255)
/// \return error type possible are :
/// \li #NO_ERROR - all is OK
/// \li #ERROR_EEPROM_BAD_MAGIC - eeeprom is not ok (call EEPROM_FirstInit())
/// \li any other I2C possible error from I2C
//////////////////////////////////////////////////////////////////////////////////
status_e EEPROM_ReadUniqueNumber(uint8_t *number);

//////////////////////////////////////////////////////////////////////////////////
/// \brief Write the touch calbration to EEPROM
/// \param calib pointer to calib structure, null for reseting the calibration
/// \return error type possible are :
/// \li #NO_ERROR - all is OK
/// \li #ERROR_EEPROM_BAD_MAGIC - eeeprom is not ok (call EEPROM_FirstInit())
/// \li any other I2C possible error from I2C
//////////////////////////////////////////////////////////////////////////////////
status_e EEPROM_Calib_Write(const uint8_t calib[24]);

//////////////////////////////////////////////////////////////////////////////////
/// \brief Returns the touch calbration from EEPROM
/// \param calib pointer to calib structure
/// \return error type possible are :
/// \li #NO_ERROR - all is OK
/// \li #ERROR_EEPROM_BAD_MAGIC - eeeprom is not ok (call EEPROM_FirstInit())
/// \li #ERROR_EEPROM_BAD_CALIB - calibration is not valid
/// \li any other I2C possible error from I2C
//////////////////////////////////////////////////////////////////////////////////
status_e EEPROM_Calib_Read(uint8_t calib[24]);

//////////////////////////////////////////////////////////////////////////////////
/// \brief Returns the mac address
/// \param mac pointer to the mac address (6*uint8_t)
/// \return error type possible are :
/// \li #NO_ERROR - all is OK
/// \li #ERROR_EEPROM_BAD_MAGIC - eeeprom is not ok (call EEPROM_FirstInit())
/// \li any other I2C possible error from I2C
//////////////////////////////////////////////////////////////////////////////////
status_e EEPROM_ReadMacAddress(uint8_t *mac);



//////////////////////////////////////////////////////////////////////////////////
/// \brief First initialisation of EEPROM
/// \param number value to set to this ARMEBS4 board
/// \param macAddr pointer to structure of MAC address (6 bytes pointer)
/// \return error type possible are :
/// \li #NO_ERROR - all is OK
/// \li #ERROR_BAD_PARAM - a parameter is missing
/// \li any other I2C possible error from I2C
/// Touchscreen calibration is erased
//////////////////////////////////////////////////////////////////////////////////
status_e EEPROM_FirstInit(uint8_t number, uint8_t *macAddr);

#ifdef __cplusplus
    }
#endif

/**
 * @}
 */
#endif /* HEIVS_EEPROM_H */