Functions
Collaboration diagram for EEPROM Exported Functions:

Functions

uint8_t BSP_EEPROM_DeInit (void)
 DeInitializes the EEPROM. More...
 
uint32_t BSP_EEPROM_Init (void)
 Initializes peripherals used by the I2C EEPROM driver. More...
 
uint32_t BSP_EEPROM_ReadBuffer (uint8_t *pBuffer, uint16_t ReadAddr, uint16_t *NumByteToRead)
 Reads a block of data from the EEPROM. More...
 
void BSP_EEPROM_TIMEOUT_UserCallback (void)
 Basic management of the timeout situation. More...
 
uint32_t BSP_EEPROM_WaitEepromStandbyState (void)
 Wait for EEPROM Standby state. More...
 
uint32_t BSP_EEPROM_WriteBuffer (uint8_t *pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite)
 Writes buffer of data to the I2C EEPROM. More...
 
uint32_t BSP_EEPROM_WritePage (uint8_t *pBuffer, uint16_t WriteAddr, uint8_t *NumByteToWrite)
 Writes more than one byte to the EEPROM with a single WRITE cycle. More...
 
void EEPROM_IO_Init (void)
 Initializes peripherals used by the I2C EEPROM driver. More...
 
HAL_StatusTypeDef EEPROM_IO_IsDeviceReady (uint16_t DevAddress, uint32_t Trials)
 Checks if target device is ready for communication. More...
 
HAL_StatusTypeDef EEPROM_IO_ReadData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Read data from I2C EEPROM driver in using DMA channel. More...
 
HAL_StatusTypeDef EEPROM_IO_WriteData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Write data to I2C EEPROM driver in using DMA channel. More...
 

Detailed Description

Function Documentation

◆ BSP_EEPROM_DeInit()

uint8_t BSP_EEPROM_DeInit ( void  )

DeInitializes the EEPROM.

Return values
EEPROMstate

Definition at line 180 of file stm32f769i_discovery_eeprom.c.

◆ BSP_EEPROM_Init()

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 157 of file stm32f769i_discovery_eeprom.c.

◆ BSP_EEPROM_ReadBuffer()

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

Reads a block of data from the EEPROM.

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 201 of file stm32f769i_discovery_eeprom.c.

◆ BSP_EEPROM_TIMEOUT_UserCallback()

void BSP_EEPROM_TIMEOUT_UserCallback ( void  )

Basic management of the timeout situation.

Return values
None

Definition at line 456 of file stm32f769i_discovery_eeprom.c.

◆ 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.
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 440 of file stm32f769i_discovery_eeprom.c.

◆ BSP_EEPROM_WriteBuffer()

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

Writes buffer of data to the I2C EEPROM.

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.

Definition at line 283 of file stm32f769i_discovery_eeprom.c.

◆ BSP_EEPROM_WritePage()

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

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 BSP_EEPROM_WriteBuffer() which calls BSP_EEPROM_WritePage() is responsible of checking on Page boundaries).
Parameters
pBufferpointer to the buffer containing the data to be written to the EEPROM.
WriteAddrEEPROM's internal address to write to.
NumByteToWritepointer 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 248 of file stm32f769i_discovery_eeprom.c.

◆ EEPROM_IO_Init()

void EEPROM_IO_Init ( void  )

Initializes peripherals used by the I2C EEPROM driver.

Definition at line 793 of file stm32469i_discovery.c.

◆ EEPROM_IO_IsDeviceReady()

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 831 of file stm32469i_discovery.c.

◆ EEPROM_IO_ReadData()

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

Read data from I2C EEPROM driver in using DMA channel.

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

Definition at line 819 of file stm32469i_discovery.c.

◆ EEPROM_IO_WriteData()

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

Write data to I2C EEPROM driver in using DMA channel.

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

Definition at line 806 of file stm32469i_discovery.c.



picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:15:08