STM32L4R9I_EVAL BSP User Manual: stm32l4r9i_eval_ospi_ram.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l4r9i_eval_ospi_ram.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains the common defines and functions prototypes for
00006   *          the stm32l4r9i_eval_ospi_ram.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32L4R9I_EVAL_OSPI_RAM_H
00039 #define __STM32L4R9I_EVAL_OSPI_RAM_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32l4xx_hal.h"
00047 #include "../Components/iss66wvh8m8/iss66wvh8m8.h"
00048 
00049 /** @addtogroup BSP
00050   * @{
00051   */
00052 
00053 /** @addtogroup STM32L4R9I_EVAL
00054   * @{
00055   */
00056 
00057 /** @addtogroup STM32L4R9I_EVAL_OSPI_RAM
00058   * @{
00059   */
00060 
00061 /* Exported constants --------------------------------------------------------*/
00062 /** @defgroup STM32L4R9I_EVAL_OSPI_RAM_Exported_Constants Exported Constants
00063   * @{
00064   */
00065 /* OSPI Error codes */
00066 #define OSPI_RAM_OK            ((uint8_t)0x00)
00067 #define OSPI_RAM_ERROR         ((uint8_t)0x01)
00068 
00069 /**
00070   * @}
00071   */
00072 
00073 /* Exported types ------------------------------------------------------------*/
00074 
00075 /* Exported functions --------------------------------------------------------*/
00076 /** @defgroup STM32L4R9I_EVAL_OSPI_RAM_Exported_Functions Exported Functions
00077   * @{
00078   */
00079 uint8_t BSP_OSPI_RAM_Init                  (void);
00080 uint8_t BSP_OSPI_RAM_DeInit                (void);
00081 uint8_t BSP_OSPI_RAM_Read                  (uint8_t* pData, uint32_t ReadAddr, uint32_t Size);
00082 uint8_t BSP_OSPI_RAM_Read_DMA              (uint8_t* pData, uint32_t ReadAddr, uint32_t Size);
00083 uint8_t BSP_OSPI_RAM_Write                 (uint8_t* pData, uint32_t WriteAddr, uint32_t Size);
00084 uint8_t BSP_OSPI_RAM_Write_DMA             (uint8_t* pData, uint32_t WriteAddr, uint32_t Size);
00085 uint8_t BSP_OSPI_RAM_EnableMemoryMappedMode(void);
00086 uint8_t BSP_OSPI_RAM_EnterDeepPowerDown    (void);
00087 uint8_t BSP_OSPI_RAM_LeaveDeepPowerDown    (void);
00088 void    BSP_OSPI_RAM_DMA_IRQHandler        (void);
00089 void    BSP_OSPI_RAM_IRQHandler            (void);
00090 
00091 /**
00092   * @}
00093   */
00094 
00095 /**
00096   * @}
00097   */
00098 
00099 /**
00100   * @}
00101   */
00102 
00103 /**
00104   * @}
00105   */
00106 
00107 #ifdef __cplusplus
00108 }
00109 #endif
00110 
00111 #endif /* __STM32L4R9I_EVAL_OSPI__RAM_H */
00112 
00113 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/