Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_DISCO_F334C8/stm32f3xx_hal_pccard.h@120:2eb10e18b8d7, 2016-04-13 (annotated)

Committer:
elijahorr
Date:
Wed Apr 13 12:29:27 2016 +0000
Revision:
120:2eb10e18b8d7
Parent:
100:cbbeb26dbd92 
V1.1

Who changed what in which revision?

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