STM32L073Z_EVAL BSP User Manual: STM32L073Z_EVAL_EEPROM_Private_Functions

STM32L073Z EVAL BSP Drivers

STM32L073Z_EVAL BSP User Manual
STM32L073Z_EVAL_EEPROM_Private_Functions

Functions

uint32_t BSP_EEPROM_Init (void)
 Initializes peripherals used by the I2C EEPROM driver.
uint32_t BSP_EEPROM_ReadBuffer (uint8_t *pBuffer, uint16_t ReadAddr, uint32_t *NumByteToRead)
 Reads a block of data from the EEPROM.
uint32_t BSP_EEPROM_WriteBuffer (uint8_t *pBuffer, uint16_t WriteAddr, uint32_t NumByteToWrite)
 Writes buffer of data to the I2C EEPROM.
uint32_t BSP_EEPROM_WaitEepromStandbyState (void)
 Wait for EEPROM Standby state.
__weak void BSP_EEPROM_TIMEOUT_UserCallback (void)
 Basic management of the timeout situation.
static uint32_t EEPROM_WritePage (uint8_t *pBuffer, uint16_t WriteAddr, uint32_t *NumByteToWrite)
 Writes more than one byte to the EEPROM with a single WRITE cycle.

Function Documentation

uint32_t BSP_EEPROM_Init ( void  )

Initializes peripherals used by the I2C EEPROM driver.

Parameters:
None
Note:
There are 2 different versions of EEPROM (A01 & A02). Then try to connect on 1st one (EEPROM_I2C_ADDRESS_A01) and if problem, check the 2nd one (EEPROM_I2C_ADDRESS_A02)
Return values:
EEPROM_OK(0) if operation is correctly performed, else return value different from EEPROM_OK (0)

Definition at line 149 of file stm32l073z_eval_eeprom.c.

References EEPROM_ADDRESS_M24LR64_A01, EEPROM_ADDRESS_M24LR64_A02, EEPROM_FAIL, EEPROM_IO_Init(), EEPROM_IO_IsDeviceReady(), EEPROM_MAX_TRIALS, EEPROM_OK, EEPROM_PAGESIZE_M24LR64, EEPROMAddress, and EEPROMPageSize.

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

Reads a block of data from the EEPROM.

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 184 of file stm32l073z_eval_eeprom.c.

References EEPROM_FAIL, EEPROM_IO_ReadData(), EEPROM_OK, and EEPROMAddress.

__weak void BSP_EEPROM_TIMEOUT_UserCallback ( void  )

Basic management of the timeout situation.

Parameters:
None.
Return values:
None.

Definition at line 427 of file stm32l073z_eval_eeprom.c.

Referenced by BSP_EEPROM_WaitEepromStandbyState().

uint32_t BSP_EEPROM_WaitEepromStandbyState ( void  )

Wait for EEPROM Standby state.

Note:
This function allows to wait and check that EEPROM has finished the last operation. It is mostly used after Write operation: after receiving the buffer to be written, the EEPROM may need additional time to actually perform the write operation. During this time, it doesn't answer to I2C packets addressed to it. Once the write operation is complete the EEPROM responds to its address.
Parameters:
None
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 410 of file stm32l073z_eval_eeprom.c.

References BSP_EEPROM_TIMEOUT_UserCallback(), EEPROM_IO_IsDeviceReady(), EEPROM_MAX_TRIALS, EEPROM_OK, EEPROM_TIMEOUT, and EEPROMAddress.

Referenced by EEPROM_WritePage().

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

Writes buffer of data to the I2C EEPROM.

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 WriteAddr is EEPROM_PAGESIZE aligned

< 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 252 of file stm32l073z_eval_eeprom.c.

References EEPROM_OK, EEPROM_WritePage(), and EEPROMPageSize.

static uint32_t EEPROM_WritePage ( uint8_t *  pBuffer,
uint16_t  WriteAddr,
uint32_t *  NumByteToWrite 
) [static]

Writes more than one byte to the EEPROM with a single WRITE cycle.

Note:
The number of bytes (combined to write start address) must not cross the EEPROM page boundary. This function can only write into the boundaries of an EEPROM page. This function doesn't check on boundaries condition (in this driver the function EEPROM_WriteBuffer() which calls EEPROM_WritePage() is responsible of checking on Page boundaries).
Parameters:
pBuffer: pointer to the buffer containing the data to be written to the EEPROM.
WriteAddr: EEPROM's internal address to write to.
NumByteToWrite: pointer to the variable holding number of bytes to be written into the EEPROM.
Note:
The variable pointed by NumByteToWrite is reset to 0 when all the data are written to the EEPROM. Application should monitor this variable in order know when the transfer is complete.
This function just configure the communication and enable the DMA channel to transfer data. Meanwhile, the user application may perform other tasks in parallel.
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 224 of file stm32l073z_eval_eeprom.c.

References BSP_EEPROM_WaitEepromStandbyState(), EEPROM_FAIL, EEPROM_IO_WriteData(), EEPROM_OK, and EEPROMAddress.

Referenced by BSP_EEPROM_WriteBuffer().

Generated on Mon Aug 28 2017 14:54:25 for STM32L073Z_EVAL BSP User Manual by   doxygen 1.7.6.1