tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_pccard.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_pccard.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-2014
   7   * @brief   Header file of PCCARD HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F3xx_HAL_PCCARD_H
  40 #define __STM32F3xx_HAL_PCCARD_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx)
  48   #include "stm32f3xx_ll_fmc.h"
  49 #endif /* STM32F302xE || STM32F303xE || STM32F398xx */
  50
  51 /** @addtogroup STM32F3xx_HAL_Driver
  52   * @{
  53   */
  54
  55 /** @addtogroup PCCARD
  56   * @{
  57   */
  58
  59 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx)
  60
  61 /* Exported typedef ----------------------------------------------------------*/
  62 /** @defgroup PCCARD_Exported_Types PCCARD Exported Types
  63   * @{
  64   */
  65
  66 /**
  67   * @brief  HAL PCCARD State structures definition
  68   */
  69 typedef enum
  70 {
  71   HAL_PCCARD_STATE_RESET     = 0x00,    /*!< PCCARD peripheral not yet initialized or disabled */
  72   HAL_PCCARD_STATE_READY     = 0x01,    /*!< PCCARD peripheral ready                           */
  73   HAL_PCCARD_STATE_BUSY      = 0x02,    /*!< PCCARD peripheral busy                            */
  74   HAL_PCCARD_STATE_ERROR     = 0x04     /*!< PCCARD peripheral error                           */
  75 }HAL_PCCARD_StateTypeDef;
  76
  77 typedef enum
  78 {
  79   CF_SUCCESS = 0,
  80   CF_ONGOING,
  81   CF_ERROR,
  82   CF_TIMEOUT
  83 }CF_StatusTypedef;
  84
  85 /**
  86   * @brief  FMC_PCCARD handle Structure definition
  87   */
  88 typedef struct
  89 {
  90   FMC_PCCARD_TypeDef           *Instance;              /*!< Register base address for PCCARD device          */
  91
  92   FMC_PCCARD_InitTypeDef       Init;                   /*!< PCCARD device control configuration parameters   */
  93
  94   __IO HAL_PCCARD_StateTypeDef State;                  /*!< PCCARD device access state                       */
  95
  96   HAL_LockTypeDef              Lock;                   /*!< PCCARD Lock                                      */
  97
  98 }PCCARD_HandleTypeDef;
  99 /**
 100   * @}
 101   */
 102
 103 /* Exported constants --------------------------------------------------------*/
 104 /** @defgroup PCCARD_Exported_Constants PCCARD Exported Constants
 105   * @{
 106   */
 107
 108 #define CF_DEVICE_ADDRESS             ((uint32_t)0x90000000)
 109 #define CF_ATTRIBUTE_SPACE_ADDRESS    ((uint32_t)0x98000000)   /* Attribute space size to @0x9BFF FFFF */
 110 #define CF_COMMON_SPACE_ADDRESS       CF_DEVICE_ADDRESS        /* Common space size to @0x93FF FFFF    */
 111 #define CF_IO_SPACE_ADDRESS           ((uint32_t)0x9C000000)   /* IO space size to @0x9FFF FFFF        */
 112 #define CF_IO_SPACE_PRIMARY_ADDR      ((uint32_t)0x9C0001F0)   /* IO space size to @0x9FFF FFFF        */
 113
 114 /* Compact Flash-ATA registers description */
 115 #define CF_DATA                       ((uint8_t)0x00)    /* Data register */
 116 #define CF_SECTOR_COUNT               ((uint8_t)0x02)    /* Sector Count register */
 117 #define CF_SECTOR_NUMBER              ((uint8_t)0x03)    /* Sector Number register */
 118 #define CF_CYLINDER_LOW               ((uint8_t)0x04)    /* Cylinder low register */
 119 #define CF_CYLINDER_HIGH              ((uint8_t)0x05)    /* Cylinder high register */
 120 #define CF_CARD_HEAD                  ((uint8_t)0x06)    /* Card/Head register */
 121 #define CF_STATUS_CMD                 ((uint8_t)0x07)    /* Status(read)/Command(write) register */
 122 #define CF_STATUS_CMD_ALTERNATE       ((uint8_t)0x0E)    /* Alternate Status(read)/Command(write) register */
 123 #define CF_COMMON_DATA_AREA           ((uint16_t)0x0400) /* Start of data area (for Common access only!) */
 124
 125 /* Compact Flash-ATA commands */
 126 #define CF_READ_SECTOR_CMD            ((uint8_t)0x20)
 127 #define CF_WRITE_SECTOR_CMD           ((uint8_t)0x30)
 128 #define CF_ERASE_SECTOR_CMD           ((uint8_t)0xC0)
 129 #define CF_IDENTIFY_CMD               ((uint8_t)0xEC)
 130
 131 /* Compact Flash status */
 132 #define CF_TIMEOUT_ERROR              ((uint8_t)0x60)
 133 #define CF_BUSY                       ((uint8_t)0x80)
 134 #define CF_PROGR                      ((uint8_t)0x01)
 135 #define CF_READY                      ((uint8_t)0x40)
 136
 137 #define CF_SECTOR_SIZE                ((uint32_t)255)    /* In half words */
 138
 139 /**
 140   * @}
 141   */
 142
 143 /* Exported macro ------------------------------------------------------------*/
 144 /** @defgroup PCCARD_Exported_Macros PCCARD Exported Macros
 145   * @{
 146   */
 147
 148 /** @brief Reset PCCARD handle state
 149   * @param  __HANDLE__: specifies the PCCARD handle.
 150   * @retval None
 151   */
 152 #define __HAL_PCCARD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_PCCARD_STATE_RESET)
 153 /**
 154   * @}
 155   */
 156
 157 /* Exported functions --------------------------------------------------------*/
 158 /** @addtogroup PCCARD_Exported_Functions PCCARD Exported Functions
 159   * @{
 160   */
 161
 162 /** @addtogroup PCCARD_Exported_Functions_Group1 Initialization and de-initialization functions
 163   * @{
 164   */
 165 /* Initialization/de-initialization functions  **********************************/
 166 HAL_StatusTypeDef  HAL_PCCARD_Init(PCCARD_HandleTypeDef *hpccard, FMC_NAND_PCC_TimingTypeDef *ComSpaceTiming, FMC_NAND_PCC_TimingTypeDef *AttSpaceTiming, FMC_NAND_PCC_TimingTypeDef *IOSpaceTiming);
 167 HAL_StatusTypeDef  HAL_PCCARD_DeInit(PCCARD_HandleTypeDef *hpccard);
 168 void HAL_PCCARD_MspInit(PCCARD_HandleTypeDef *hpccard);
 169 void HAL_PCCARD_MspDeInit(PCCARD_HandleTypeDef *hpccard);
 170 /**
 171   * @}
 172   */
 173
 174 /** @addtogroup PCCARD_Exported_Functions_Group2 Input Output and memory functions
 175   * @{
 176   */
 177 /* IO operation functions  *****************************************************/
 178 HAL_StatusTypeDef  HAL_CF_Read_ID(PCCARD_HandleTypeDef *hpccard, uint8_t CompactFlash_ID[], uint8_t *pStatus);
 179 HAL_StatusTypeDef  HAL_CF_Write_Sector(PCCARD_HandleTypeDef *hpccard, uint16_t *pBuffer, uint16_t SectorAddress,  uint8_t *pStatus);
 180 HAL_StatusTypeDef  HAL_CF_Read_Sector(PCCARD_HandleTypeDef *hpccard, uint16_t *pBuffer, uint16_t SectorAddress, uint8_t *pStatus);
 181 HAL_StatusTypeDef  HAL_CF_Erase_Sector(PCCARD_HandleTypeDef *hpccard, uint16_t SectorAddress, uint8_t *pStatus);
 182 HAL_StatusTypeDef  HAL_CF_Reset(PCCARD_HandleTypeDef *hpccard);
 183 void               HAL_PCCARD_IRQHandler(PCCARD_HandleTypeDef *hpccard);
 184 void        HAL_PCCARD_ITCallback(PCCARD_HandleTypeDef *hpccard);
 185
 186 /**
 187   * @}
 188   */
 189
 190 /** @defgroup PCCARD_Exported_Functions_Group3 Peripheral State functions
 191   * @{
 192   */
 193 /* PCCARD State functions *******************************************************/
 194 HAL_PCCARD_StateTypeDef HAL_PCCARD_GetState(PCCARD_HandleTypeDef *hpccard);
 195 CF_StatusTypedef HAL_CF_GetStatus(PCCARD_HandleTypeDef *hpccard);
 196 CF_StatusTypedef HAL_CF_ReadStatus(PCCARD_HandleTypeDef *hpccard);
 197 /**
 198   * @}
 199   */
 200
 201 /**
 202   * @}
 203   */
 204 #endif /* STM32F302xE || STM32F303xE || STM32F398xx */
 205 /**
 206   * @}
 207   */
 208
 209 /**
 210   * @}
 211   */
 212
 213 #ifdef __cplusplus
 214 }
 215 #endif
 216
 217 #endif /* __STM32F3xx_HAL_PCCARD_H */
 218
 219 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/