STM32F4xx HAL Driver master
STM32CubeF4 HAL / LL Drivers API Reference
Loading...
Searching...
No Matches
stm32f4xx_hal_pccard.h
Go to the documentation of this file.
1
18
19/* Define to prevent recursive inclusion -------------------------------------*/
20#ifndef STM32F4xx_HAL_PCCARD_H
21#define STM32F4xx_HAL_PCCARD_H
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27#if defined(FMC_Bank4) || defined(FSMC_Bank4)
28
29/* Includes ------------------------------------------------------------------*/
30#if defined(FSMC_Bank4)
31#include "stm32f4xx_ll_fsmc.h"
32#else
33#include "stm32f4xx_ll_fmc.h"
34#endif /* FSMC_Bank4 */
35
39
43
44/* Exported typedef ----------------------------------------------------------*/
48
52typedef enum
53{
54 HAL_PCCARD_STATE_RESET = 0x00U,
55 HAL_PCCARD_STATE_READY = 0x01U,
56 HAL_PCCARD_STATE_BUSY = 0x02U,
57 HAL_PCCARD_STATE_ERROR = 0x04U
58} HAL_PCCARD_StateTypeDef;
59
60typedef enum
61{
62 HAL_PCCARD_STATUS_SUCCESS = 0U,
63 HAL_PCCARD_STATUS_ONGOING,
64 HAL_PCCARD_STATUS_ERROR,
65 HAL_PCCARD_STATUS_TIMEOUT
66} HAL_PCCARD_StatusTypeDef;
67
71#if (USE_HAL_PCCARD_REGISTER_CALLBACKS == 1)
72typedef struct __PCCARD_HandleTypeDef
73#else
74typedef struct
75#endif /* USE_HAL_PCCARD_REGISTER_CALLBACKS */
76{
77 FMC_PCCARD_TypeDef *Instance;
78
79 FMC_PCCARD_InitTypeDef Init;
80
81 __IO HAL_PCCARD_StateTypeDef State;
82
83 HAL_LockTypeDef Lock;
84
85#if (USE_HAL_PCCARD_REGISTER_CALLBACKS == 1)
86 void (* MspInitCallback)(struct __PCCARD_HandleTypeDef *hpccard);
87 void (* MspDeInitCallback)(struct __PCCARD_HandleTypeDef *hpccard);
88 void (* ItCallback)(struct __PCCARD_HandleTypeDef *hpccard);
89#endif /* USE_HAL_PCCARD_REGISTER_CALLBACKS */
90} PCCARD_HandleTypeDef;
91
92#if (USE_HAL_PCCARD_REGISTER_CALLBACKS == 1)
96typedef enum
97{
98 HAL_PCCARD_MSP_INIT_CB_ID = 0x00U,
99 HAL_PCCARD_MSP_DEINIT_CB_ID = 0x01U,
100 HAL_PCCARD_IT_CB_ID = 0x02U
101} HAL_PCCARD_CallbackIDTypeDef;
102
106typedef void (*pPCCARD_CallbackTypeDef)(PCCARD_HandleTypeDef *hpccard);
107#endif /* USE_HAL_PCCARD_REGISTER_CALLBACKS */
111
112/* Exported constants --------------------------------------------------------*/
113/* Exported macro ------------------------------------------------------------*/
121#if (USE_HAL_PCCARD_REGISTER_CALLBACKS == 1)
122#define __HAL_PCCARD_RESET_HANDLE_STATE(__HANDLE__) do { \
123 (__HANDLE__)->State = HAL_PCCARD_STATE_RESET; \
124 (__HANDLE__)->MspInitCallback = NULL; \
125 (__HANDLE__)->MspDeInitCallback = NULL; \
126 } while(0)
127#else
128#define __HAL_PCCARD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_PCCARD_STATE_RESET)
129#endif /* USE_HAL_PCCARD_REGISTER_CALLBACKS */
133
134/* Exported functions --------------------------------------------------------*/
138
142/* Initialization/de-initialization functions **********************************/
143HAL_StatusTypeDef HAL_PCCARD_Init(PCCARD_HandleTypeDef *hpccard, FMC_NAND_PCC_TimingTypeDef *ComSpaceTiming,
144 FMC_NAND_PCC_TimingTypeDef *AttSpaceTiming,
145 FMC_NAND_PCC_TimingTypeDef *IOSpaceTiming);
146HAL_StatusTypeDef HAL_PCCARD_DeInit(PCCARD_HandleTypeDef *hpccard);
147void HAL_PCCARD_MspInit(PCCARD_HandleTypeDef *hpccard);
148void HAL_PCCARD_MspDeInit(PCCARD_HandleTypeDef *hpccard);
152
156/* IO operation functions *****************************************************/
157HAL_StatusTypeDef HAL_PCCARD_Read_ID(PCCARD_HandleTypeDef *hpccard, uint8_t CompactFlash_ID[], uint8_t *pStatus);
158HAL_StatusTypeDef HAL_PCCARD_Write_Sector(PCCARD_HandleTypeDef *hpccard, uint16_t *pBuffer, uint16_t SectorAddress,
159 uint8_t *pStatus);
160HAL_StatusTypeDef HAL_PCCARD_Read_Sector(PCCARD_HandleTypeDef *hpccard, uint16_t *pBuffer, uint16_t SectorAddress,
161 uint8_t *pStatus);
162HAL_StatusTypeDef HAL_PCCARD_Erase_Sector(PCCARD_HandleTypeDef *hpccard, uint16_t SectorAddress, uint8_t *pStatus);
163HAL_StatusTypeDef HAL_PCCARD_Reset(PCCARD_HandleTypeDef *hpccard);
164void HAL_PCCARD_IRQHandler(PCCARD_HandleTypeDef *hpccard);
165void HAL_PCCARD_ITCallback(PCCARD_HandleTypeDef *hpccard);
166
167#if (USE_HAL_PCCARD_REGISTER_CALLBACKS == 1)
168/* PCCARD callback registering/unregistering */
169HAL_StatusTypeDef HAL_PCCARD_RegisterCallback(PCCARD_HandleTypeDef *hpccard, HAL_PCCARD_CallbackIDTypeDef CallbackId,
170 pPCCARD_CallbackTypeDef pCallback);
171HAL_StatusTypeDef HAL_PCCARD_UnRegisterCallback(PCCARD_HandleTypeDef *hpccard,
172 HAL_PCCARD_CallbackIDTypeDef CallbackId);
173#endif /* USE_HAL_PCCARD_REGISTER_CALLBACKS */
177
181/* PCCARD State functions *******************************************************/
182HAL_PCCARD_StateTypeDef HAL_PCCARD_GetState(PCCARD_HandleTypeDef *hpccard);
183HAL_PCCARD_StatusTypeDef HAL_PCCARD_GetStatus(PCCARD_HandleTypeDef *hpccard);
184HAL_PCCARD_StatusTypeDef HAL_PCCARD_ReadStatus(PCCARD_HandleTypeDef *hpccard);
188
192/* Private types -------------------------------------------------------------*/
193/* Private variables ---------------------------------------------------------*/
194/* Private constants ---------------------------------------------------------*/
198#define PCCARD_DEVICE_ADDRESS 0x90000000U
199#define PCCARD_ATTRIBUTE_SPACE_ADDRESS 0x98000000U /* Attribute space size to @0x9BFF FFFF */
200#define PCCARD_COMMON_SPACE_ADDRESS PCCARD_DEVICE_ADDRESS /* Common space size to @0x93FF FFFF */
201#define PCCARD_IO_SPACE_ADDRESS 0x9C000000U /* IO space size to @0x9FFF FFFF */
202#define PCCARD_IO_SPACE_PRIMARY_ADDR 0x9C0001F0U /* IO space size to @0x9FFF FFFF */
203
204/* Flash-ATA registers description */
205#define ATA_DATA ((uint8_t)0x00) /* Data register */
206#define ATA_SECTOR_COUNT ((uint8_t)0x02) /* Sector Count register */
207#define ATA_SECTOR_NUMBER ((uint8_t)0x03) /* Sector Number register */
208#define ATA_CYLINDER_LOW ((uint8_t)0x04) /* Cylinder low register */
209#define ATA_CYLINDER_HIGH ((uint8_t)0x05) /* Cylinder high register */
210#define ATA_CARD_HEAD ((uint8_t)0x06) /* Card/Head register */
211#define ATA_STATUS_CMD ((uint8_t)0x07) /* Status(read)/Command(write) register */
212#define ATA_STATUS_CMD_ALTERNATE ((uint8_t)0x0E) /* Alternate Status(read)/Command(write) register */
213#define ATA_COMMON_DATA_AREA ((uint16_t)0x0400) /* Start of data area (for Common access only!) */
214#define ATA_CARD_CONFIGURATION ((uint16_t)0x0202) /* Card Configuration and Status Register */
215
216/* Flash-ATA commands */
217#define ATA_READ_SECTOR_CMD ((uint8_t)0x20)
218#define ATA_WRITE_SECTOR_CMD ((uint8_t)0x30)
219#define ATA_ERASE_SECTOR_CMD ((uint8_t)0xC0)
220#define ATA_IDENTIFY_CMD ((uint8_t)0xEC)
221
222/* PC Card/Compact Flash status */
223#define PCCARD_TIMEOUT_ERROR ((uint8_t)0x60)
224#define PCCARD_BUSY ((uint8_t)0x80)
225#define PCCARD_PROGR ((uint8_t)0x01)
226#define PCCARD_READY ((uint8_t)0x40)
227
228#define PCCARD_SECTOR_SIZE 255U /* In half words */
229
233/* Compact Flash redefinition */
234#define HAL_CF_Init HAL_PCCARD_Init
235#define HAL_CF_DeInit HAL_PCCARD_DeInit
236#define HAL_CF_MspInit HAL_PCCARD_MspInit
237#define HAL_CF_MspDeInit HAL_PCCARD_MspDeInit
238
239#define HAL_CF_Read_ID HAL_PCCARD_Read_ID
240#define HAL_CF_Write_Sector HAL_PCCARD_Write_Sector
241#define HAL_CF_Read_Sector HAL_PCCARD_Read_Sector
242#define HAL_CF_Erase_Sector HAL_PCCARD_Erase_Sector
243#define HAL_CF_Reset HAL_PCCARD_Reset
244#define HAL_CF_IRQHandler HAL_PCCARD_IRQHandler
245#define HAL_CF_ITCallback HAL_PCCARD_ITCallback
246
247#define HAL_CF_GetState HAL_PCCARD_GetState
248#define HAL_CF_GetStatus HAL_PCCARD_GetStatus
249#define HAL_CF_ReadStatus HAL_PCCARD_ReadStatus
250
251#define HAL_CF_STATUS_SUCCESS HAL_PCCARD_STATUS_SUCCESS
252#define HAL_CF_STATUS_ONGOING HAL_PCCARD_STATUS_ONGOING
253#define HAL_CF_STATUS_ERROR HAL_PCCARD_STATUS_ERROR
254#define HAL_CF_STATUS_TIMEOUT HAL_PCCARD_STATUS_TIMEOUT
255#define HAL_CF_StatusTypeDef HAL_PCCARD_StatusTypeDef
256
257#define CF_DEVICE_ADDRESS PCCARD_DEVICE_ADDRESS
258#define CF_ATTRIBUTE_SPACE_ADDRESS PCCARD_ATTRIBUTE_SPACE_ADDRESS
259#define CF_COMMON_SPACE_ADDRESS PCCARD_COMMON_SPACE_ADDRESS
260#define CF_IO_SPACE_ADDRESS PCCARD_IO_SPACE_ADDRESS
261#define CF_IO_SPACE_PRIMARY_ADDR PCCARD_IO_SPACE_PRIMARY_ADDR
262
263#define CF_TIMEOUT_ERROR PCCARD_TIMEOUT_ERROR
264#define CF_BUSY PCCARD_BUSY
265#define CF_PROGR PCCARD_PROGR
266#define CF_READY PCCARD_READY
267
268#define CF_SECTOR_SIZE PCCARD_SECTOR_SIZE
269
270/* Private macros ------------------------------------------------------------*/
274
275
279
280#endif /* FMC_Bank4 || FSMC_Bank4 */
281
282#ifdef __cplusplus
283}
284#endif
285
286#endif /* STM32F4xx_HAL_PCCARD_H */
HAL_StatusTypeDef
HAL Status structures definition.
HAL_LockTypeDef
HAL Lock structures definition.
Header file of FMC HAL module.
Header file of FSMC HAL module.