STM32091C_EVAL BSP User Manual: Exported Functions

STM32091C EVAL BSP Drivers

STM32091C_EVAL BSP User Manual
Exported 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 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_IO_Init (void)
 Initializes peripherals used by the I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_IO_WriteData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Write data to I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_IO_ReadData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Read data from I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_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 I2C EEPROM driver.

Note:
There are 2 different versions of M24LR64 (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 145 of file stm32091c_eval_eeprom.c.

References EEPROM_FAIL, EEPROM_I2C_Drv, 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:
pBufferpointer to the buffer that receives the data read from the EEPROM.
ReadAddrEEPROM's internal address to start reading from.
NumByteToReadpointer 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 173 of file stm32091c_eval_eeprom.c.

References EEPROM_FAIL, and EEPROM_DrvTypeDef::ReadBuffer.

Basic management of the timeout situation.

Return values:
None

Definition at line 347 of file stm32091c_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:
pBufferpointer to the buffer containing the data to be written to the EEPROM.
WriteAddrEEPROM's internal address to write to.
NumByteToWritenumber 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 194 of file stm32091c_eval_eeprom.c.

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

void EEPROM_IO_Init ( void  )

Initializes peripherals used by the I2C EEPROM driver.

Return values:
None

Definition at line 1191 of file stm32091c_eval.c.

References I2C1_Init().

Referenced by EEPROM_I2C_Init().

HAL_StatusTypeDef EEPROM_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:
DevAddressTarget device address
TrialsNumber of trials
Return values:
HALstatus

Definition at line 1229 of file stm32091c_eval.c.

References I2C1_IsDeviceReady().

Referenced by EEPROM_I2C_Init(), and EEPROM_I2C_WaitEepromStandbyState().

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

Read data from I2C EEPROM driver.

Parameters:
DevAddressTarget device address
MemAddressInternal memory address
pBufferPointer to data buffer
BufferSizeAmount of data to be read
Return values:
HALstatus

Definition at line 1217 of file stm32091c_eval.c.

References I2C1_ReadBuffer().

Referenced by EEPROM_I2C_ReadBuffer().

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

Write data to I2C EEPROM driver.

Parameters:
DevAddressTarget device address
MemAddressInternal memory address
pBufferPointer to data buffer
BufferSizeAmount of data to be sent
Return values:
HALstatus

Definition at line 1204 of file stm32091c_eval.c.

References I2C1_WriteBuffer().

Referenced by EEPROM_I2C_WritePage().

Generated on Wed Jul 5 2017 09:21:50 for STM32091C_EVAL BSP User Manual by   doxygen 1.7.6.1