STM3210E_EVAL BSP User Manual: stm3210e_eval_serialflash.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm3210e_eval_serialflash.h
00004   * @author  MCD Application Team
00005   * @version V6.0.2
00006   * @date    29-April-2016
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm3210e_eval_flash driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */ 
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM3210E_EVAL_SERIAL_FLASH_H
00041 #define __STM3210E_EVAL_SERIAL_FLASH_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm3210e_eval.h"
00049 
00050 /** @addtogroup BSP
00051   * @{
00052   */ 
00053 
00054 /** @addtogroup STM3210E_EVAL
00055   * @{
00056   */
00057   
00058 /** @addtogroup STM3210E_EVAL_SERIAL_FLASH
00059   * @{
00060   */  
00061 
00062 /** @defgroup STM3210E_EVAL_SERIAL_FLASH_Exported_Constants STM3210E EVAL SERIAL FLASH Exported Constants
00063   * @{
00064   */
00065 #define   FLASH_OK         0x00
00066 #define   FLASH_ERROR      0x01
00067 /**
00068   * @}
00069   */ 
00070 
00071 /** @addtogroup STM3210E_EVAL_SERIAL_FLASH_Exported_Functions
00072   * @{
00073   */
00074 uint8_t  BSP_SERIAL_FLASH_Init(void);
00075 uint8_t  BSP_SERIAL_FLASH_EraseSector(uint32_t SectorAddr);
00076 uint8_t  BSP_SERIAL_FLASH_EraseBulk(void);
00077 uint8_t  BSP_SERIAL_FLASH_WritePage(uint32_t uwStartAddress, uint8_t* pData, uint32_t uwDataSize);
00078 uint8_t  BSP_SERIAL_FLASH_WriteData(uint32_t uwStartAddress, uint8_t* pData, uint32_t uwDataSize);
00079 uint8_t  BSP_SERIAL_FLASH_ReadData( uint32_t uwStartAddress, uint8_t* pData, uint32_t uwDataSize);
00080 uint32_t BSP_SERIAL_FLASH_ReadID(void);
00081 
00082 /* Link function for EEPROM peripheral over SPI */
00083 HAL_StatusTypeDef         FLASH_SPI_IO_Init(void);
00084 uint8_t                   FLASH_SPI_IO_WriteByte(uint8_t Data);
00085 uint8_t                   FLASH_SPI_IO_ReadByte(void);
00086 HAL_StatusTypeDef         FLASH_SPI_IO_ReadData(uint32_t MemAddress, uint8_t* pBuffer, uint32_t BufferSize);
00087 void                      FLASH_SPI_IO_WriteEnable(void);
00088 HAL_StatusTypeDef         FLASH_SPI_IO_WaitForWriteEnd(void);
00089 uint32_t                  FLASH_SPI_IO_ReadID(void);
00090 /**
00091   * @}
00092   */
00093 
00094   
00095 #ifdef __cplusplus
00096 }
00097 #endif
00098 
00099 #endif /* __STM3210E_EVAL_SERIAL_FLASH_H */
00100 /**
00101   * @}
00102   */
00103 
00104 /**
00105   * @}
00106   */
00107 
00108 /**
00109   * @}
00110   */
00111 
00112 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/