STM32L4R9I-Discovery BSP User Manual: Exported Functions

STM32L4R9I-Discovery BSP

STM32L4R9I-Discovery BSP User Manual

Functions

uint8_t BSP_OSPI_NOR_Init (void)
 Initializes the OSPI interface.
uint8_t BSP_OSPI_NOR_DeInit (void)
 De-Initializes the OSPI interface.
uint8_t BSP_OSPI_NOR_Read (uint8_t *pData, uint32_t ReadAddr, uint32_t Size)
 Reads an amount of data from the OSPI memory.
uint8_t BSP_OSPI_NOR_Write (uint8_t *pData, uint32_t WriteAddr, uint32_t Size)
 Writes an amount of data to the OSPI memory.
uint8_t BSP_OSPI_NOR_Erase_Block (uint32_t BlockAddress)
 Erases the specified block of the OSPI memory.
uint8_t BSP_OSPI_NOR_Erase_Sector (uint32_t Sector)
 Erases the specified sector of the OSPI memory.
uint8_t BSP_OSPI_NOR_Erase_Chip (void)
 Erases the entire OSPI memory.
uint8_t BSP_OSPI_NOR_GetStatus (void)
 Reads current status of the OSPI memory.
uint8_t BSP_OSPI_NOR_GetInfo (OSPI_NOR_Info *pInfo)
 Return the configuration of the OSPI memory.
uint8_t BSP_OSPI_NOR_EnableMemoryMappedMode (void)
 Configure the OSPI in memory-mapped mode.
uint8_t BSP_OSPI_NOR_SuspendErase (void)
 This function suspends an ongoing erase command.
uint8_t BSP_OSPI_NOR_ResumeErase (void)
 This function resumes a paused erase command.
uint8_t BSP_OSPI_NOR_EnterDeepPowerDown (void)
 This function enter the OSPI memory in deep power down mode.
uint8_t BSP_OSPI_NOR_LeaveDeepPowerDown (void)
 This function leave the OSPI memory from deep power down mode.

Function Documentation

uint8_t BSP_OSPI_NOR_DeInit ( void  )

De-Initializes the OSPI interface.

Return values:
OSPImemory status

Definition at line 206 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_ERROR, OSPI_NOR_MspDeInit(), OSPI_NOR_OCTAL_DISABLE, OSPI_NOR_OctalMode(), OSPI_NOR_OK, and OSPINORHandle.

Configure the OSPI in memory-mapped mode.

Return values:
OSPImemory status

Definition at line 643 of file stm32l4r9i_discovery_ospi_nor.c.

References DUMMY_CYCLES_READ_OCTAL, OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_WriteEnable(), and OSPINORHandle.

uint8_t BSP_OSPI_NOR_EnterDeepPowerDown ( void  )

This function enter the OSPI memory in deep power down mode.

Return values:
OSPImemory status

Definition at line 812 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_ERROR, OSPI_NOR_OK, and OSPINORHandle.

uint8_t BSP_OSPI_NOR_Erase_Block ( uint32_t  BlockAddress)

Erases the specified block of the OSPI memory.

Parameters:
BlockAddress,:Block address to erase
Return values:
OSPImemory status

Definition at line 385 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_AutoPollingMemReady(), OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_WriteEnable(), and OSPINORHandle.

uint8_t BSP_OSPI_NOR_Erase_Chip ( void  )

Erases the entire OSPI memory.

Return values:
OSPImemory status

Definition at line 494 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_AutoPollingMemReady(), OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_WriteEnable(), and OSPINORHandle.

uint8_t BSP_OSPI_NOR_Erase_Sector ( uint32_t  Sector)

Erases the specified sector of the OSPI memory.

Parameters:
Sector,:Sector address to erase (0 to 255)
Return values:
OSPImemory status
Note:
This function is non blocking meaning that sector erase operation is started but not completed when the function returns. Application has to call BSP_QSPI_GetStatus() to know when the device is available again (i.e. erase operation completed).

Definition at line 443 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_WriteEnable(), and OSPINORHandle.

uint8_t BSP_OSPI_NOR_GetInfo ( OSPI_NOR_Info pInfo)

Return the configuration of the OSPI memory.

Parameters:
pInfo,:pointer on the configuration structure
Return values:
OSPImemory status

Definition at line 627 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_Info::EraseSectorSize, OSPI_NOR_Info::EraseSectorsNumber, OSPI_NOR_Info::FlashSize, OSPI_NOR_OK, OSPI_NOR_Info::ProgPageSize, and OSPI_NOR_Info::ProgPagesNumber.

uint8_t BSP_OSPI_NOR_GetStatus ( void  )

Reads current status of the OSPI memory.

Return values:
OSPImemory status

Definition at line 542 of file stm32l4r9i_discovery_ospi_nor.c.

References DUMMY_CYCLES_READ_OCTAL, OSPI_NOR_BUSY, OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_SUSPENDED, and OSPINORHandle.

Referenced by BSP_OSPI_NOR_ResumeErase(), and BSP_OSPI_NOR_SuspendErase().

uint8_t BSP_OSPI_NOR_Init ( void  )

Initializes the OSPI interface.

Return values:
OSPImemory status

Definition at line 133 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_ERROR, OSPI_NOR_MspInit(), OSPI_NOR_NOT_SUPPORTED, OSPI_NOR_OCTAL_ENABLE, OSPI_NOR_OctalMode(), OSPI_NOR_OK, OSPI_NOR_ResetMemory(), and OSPINORHandle.

uint8_t BSP_OSPI_NOR_LeaveDeepPowerDown ( void  )

This function leave the OSPI memory from deep power down mode.

Return values:
OSPImemory status

Definition at line 850 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_ERROR, OSPI_NOR_OK, and OSPINORHandle.

uint8_t BSP_OSPI_NOR_Read ( uint8_t *  pData,
uint32_t  ReadAddr,
uint32_t  Size 
)

Reads an amount of data from the OSPI memory.

Parameters:
pData,:Pointer to data to be read
ReadAddr,:Read start address
Size,:Size of data to read
Return values:
OSPImemory status

Definition at line 244 of file stm32l4r9i_discovery_ospi_nor.c.

References DUMMY_CYCLES_READ_OCTAL, OSPI_NOR_ERROR, OSPI_NOR_OK, and OSPINORHandle.

uint8_t BSP_OSPI_NOR_ResumeErase ( void  )

This function resumes a paused erase command.

Return values:
OSPImemory status

Definition at line 759 of file stm32l4r9i_discovery_ospi_nor.c.

References BSP_OSPI_NOR_GetStatus(), OSPI_NOR_BUSY, OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_SUSPENDED, and OSPINORHandle.

uint8_t BSP_OSPI_NOR_SuspendErase ( void  )

This function suspends an ongoing erase command.

Return values:
OSPImemory status

Definition at line 710 of file stm32l4r9i_discovery_ospi_nor.c.

References BSP_OSPI_NOR_GetStatus(), OSPI_NOR_BUSY, OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_SUSPENDED, and OSPINORHandle.

uint8_t BSP_OSPI_NOR_Write ( uint8_t *  pData,
uint32_t  WriteAddr,
uint32_t  Size 
)

Writes an amount of data to the OSPI memory.

Parameters:
pData,:Pointer to data to be written
WriteAddr,:Write start address
Size,:Size of data to write
Return values:
OSPImemory status

Definition at line 298 of file stm32l4r9i_discovery_ospi_nor.c.

References OSPI_NOR_AutoPollingMemReady(), OSPI_NOR_ERROR, OSPI_NOR_OK, OSPI_NOR_WriteEnable(), and OSPINORHandle.

Generated on Fri Oct 13 2017 02:37:42 for STM32L4R9I-Discovery BSP User Manual by   doxygen 1.7.6.1