STM3210C_EVAL BSP User Manual: STM3210C EVAL EEPROM Exported Functions

STM3210C_EVAL BSP

STM3210C_EVAL BSP User Manual
STM3210C EVAL EEPROM Exported Functions

Functions

uint32_t BSP_EEPROM_Init (void)
 Initializes peripherals used by the EEPROM device selected.
void BSP_EEPROM_SelectDevice (uint8_t DeviceID)
 Select the EEPROM device to communicate.
uint32_t BSP_EEPROM_ReadBuffer (uint8_t *pBuffer, uint16_t ReadAddr, uint32_t *NumByteToRead)
 Reads a block of data from the EEPROM device selected.
uint32_t BSP_EEPROM_WriteBuffer (uint8_t *pBuffer, uint16_t WriteAddr, uint32_t NumByteToWrite)
 Writes buffer of data to the EEPROM device selected.
__weak void BSP_EEPROM_TIMEOUT_UserCallback (void)
 Basic management of the timeout situation.
void EEPROM_I2C_IO_Init (void)
 Initializes peripherals used by the I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_I2C_IO_WriteData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Write data to I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_I2C_IO_ReadData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Read data from I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_I2C_IO_IsDeviceReady (uint16_t DevAddress, uint32_t Trials)
 Checks if target device is ready for communication.

Function Documentation

uint32_t BSP_EEPROM_Init ( void  )

Initializes peripherals used by the EEPROM device selected.

Return values:
EEPROM_OK(0) if operation is correctly performed, else return value different from EEPROM_OK (0)

Definition at line 131 of file stm3210c_eval_eeprom.c.

References EEPROM_FAIL, and EEPROM_DrvTypeDef::Init.

uint32_t BSP_EEPROM_ReadBuffer ( uint8_t *  pBuffer,
uint16_t  ReadAddr,
uint32_t *  NumByteToRead 
)

Reads a block of data from the EEPROM device selected.

Parameters:
pBuffer: pointer to the buffer that receives the data read from the EEPROM.
ReadAddr: EEPROM's internal address to start reading from.
NumByteToRead: pointer to the variable holding number of bytes to be read from the EEPROM.
Note:
The variable pointed by NumByteToRead is reset to 0 when all the data are read from the EEPROM. Application should monitor this variable in order know when the transfer is complete.
Return values:
EEPROM_OK(0) if operation is correctly performed, else return value different from EEPROM_OK (0) or the timeout user callback.

Definition at line 182 of file stm3210c_eval_eeprom.c.

References EEPROM_FAIL, and EEPROM_DrvTypeDef::ReadBuffer.

void BSP_EEPROM_SelectDevice ( uint8_t  DeviceID)

Select the EEPROM device to communicate.

Parameters:
DeviceID,:Specifies the EEPROM device to be selected. This parameter can be one of following parameters:
  • BSP_EEPROM_M24C64_32
  • BSP_EEPROM_M24C08
Return values:
EEPROM_OK(0) if operation is correctly performed, else return value different from EEPROM_OK (0)

Definition at line 153 of file stm3210c_eval_eeprom.c.

References BSP_EEPROM_M24C08, BSP_EEPROM_M24C64_32, and EEPROM_I2C_Drv.

Basic management of the timeout situation.

Return values:
None.

Definition at line 356 of file stm3210c_eval_eeprom.c.

Referenced by EEPROM_I2C_WaitEepromStandbyState().

uint32_t BSP_EEPROM_WriteBuffer ( uint8_t *  pBuffer,
uint16_t  WriteAddr,
uint32_t  NumByteToWrite 
)

Writes buffer of data to the EEPROM device selected.

Parameters:
pBuffer: pointer to the buffer containing the data to be written to the EEPROM.
WriteAddr: EEPROM's internal address to write to.
NumByteToWrite: number of bytes to write to the EEPROM.
Return values:
EEPROM_OK(0) if operation is correctly performed, else return value different from EEPROM_OK (0) or the timeout user callback.

< If NumByteToWrite < EEPROM_PAGESIZE

< If NumByteToWrite < EEPROM_PAGESIZE

< If the number of data to be written is more than the remaining space in the current page:

< Write the data contained in same page

< Write the remaining data in the following page

Definition at line 203 of file stm3210c_eval_eeprom.c.

References EEPROM_FAIL, EEPROM_OK, EEPROMPageSize, and EEPROM_DrvTypeDef::WritePage.

void EEPROM_I2C_IO_Init ( void  )

Initializes peripherals used by the I2C EEPROM driver.

Definition at line 1262 of file stm3210c_eval.c.

References I2Cx_Init().

Referenced by EEPROM_I2C_Init().

HAL_StatusTypeDef EEPROM_I2C_IO_IsDeviceReady ( uint16_t  DevAddress,
uint32_t  Trials 
)

Checks if target device is ready for communication.

Note:
This function is used with Memory devices
Parameters:
DevAddress,:Target device address
Trials,:Number of trials
Return values:
HALstatus

Definition at line 1300 of file stm3210c_eval.c.

References I2Cx_IsDeviceReady().

Referenced by EEPROM_I2C_Init(), and EEPROM_I2C_WaitEepromStandbyState().

HAL_StatusTypeDef EEPROM_I2C_IO_ReadData ( uint16_t  DevAddress,
uint16_t  MemAddress,
uint8_t *  pBuffer,
uint32_t  BufferSize 
)

Read data from I2C EEPROM driver.

Parameters:
DevAddress,:Target device address
MemAddress,:Internal memory address
pBuffer,:Pointer to data buffer
BufferSize,:Amount of data to be read
Return values:
HALstatus

Definition at line 1288 of file stm3210c_eval.c.

References I2Cx_ReadBuffer().

Referenced by EEPROM_I2C_ReadBuffer().

HAL_StatusTypeDef EEPROM_I2C_IO_WriteData ( uint16_t  DevAddress,
uint16_t  MemAddress,
uint8_t *  pBuffer,
uint32_t  BufferSize 
)

Write data to I2C EEPROM driver.

Parameters:
DevAddress,:Target device address
MemAddress,:Internal memory address
pBuffer,:Pointer to data buffer
BufferSize,:Amount of data to be sent
Return values:
HALstatus

Definition at line 1275 of file stm3210c_eval.c.

References I2Cx_WriteBuffer().

Referenced by EEPROM_I2C_WritePage().

Generated on Fri Apr 14 2017 13:00:47 for STM3210C_EVAL BSP User Manual by   doxygen 1.7.6.1