-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathstm32u5x9j_discovery_ospi.h
264 lines (227 loc) · 9.57 KB
/
stm32u5x9j_discovery_ospi.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
/**
******************************************************************************
* @file stm32u5x9j_discovery_ospi.h
* @author MCD Application Team
* @brief This file contains the common defines and functions prototypes for
* the stm32u5x9j_discovery_ospi.c driver.
******************************************************************************
* @attention
*
* Copyright (c) 2023 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STM32U5x9J_DISCOVERY_OSPI_H
#define STM32U5x9J_DISCOVERY_OSPI_H
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
#include "stm32u5x9j_discovery_conf.h"
#include "stm32u5x9j_discovery_errno.h"
#include "../Components/mx25um51245g/mx25um51245g.h"
/** @addtogroup BSP
* @{
*/
/** @addtogroup STM32U5x9J_DISCOVERY
* @{
*/
/** @addtogroup STM32U5x9J_DISCOVERY_OSPI
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup STM32U5x9J_DISCOVERY_OSPI_Exported_Types OSPI Exported Types
* @{
*/
typedef enum
{
OSPI_ACCESS_NONE = 0, /*!< Instance not initialized, */
OSPI_ACCESS_INDIRECT, /*!< Instance use indirect mode access */
OSPI_ACCESS_MMP /*!< Instance use Memory Mapped Mode read */
} OSPI_Access_t;
#if (USE_HAL_XSPI_REGISTER_CALLBACKS == 1)
typedef struct
{
pOSPI_CallbackTypeDef pMspInitCb;
pOSPI_CallbackTypeDef pMspDeInitCb;
} BSP_OSPI_Cb_t;
#endif /* (USE_HAL_XSPI_REGISTER_CALLBACKS == 1) */
typedef struct
{
uint32_t MemorySize;
uint32_t ClockPrescaler;
uint32_t SampleShifting;
uint32_t TransferRate;
} MX_OSPI_InitTypeDef;
/**
* @}
*/
/** @defgroup STM32U5x9J_DISCOVERY_OSPI_NOR_Exported_Types OSPI NOR Exported Types
* @{
*/
#define BSP_OSPI_NOR_Info_t MX25UM51245G_Info_t
#define BSP_OSPI_NOR_Interface_t MX25UM51245G_Interface_t
#define BSP_OSPI_NOR_Transfer_t MX25UM51245G_Transfer_t
#define BSP_OSPI_NOR_Erase_t MX25UM51245G_Erase_t
typedef struct
{
OSPI_Access_t IsInitialized; /*!< Instance access Flash method */
BSP_OSPI_NOR_Interface_t InterfaceMode; /*!< Flash Interface mode of Instance */
BSP_OSPI_NOR_Transfer_t TransferRate; /*!< Flash Transfer mode of Instance */
} OSPI_NOR_Ctx_t;
typedef struct
{
BSP_OSPI_NOR_Interface_t InterfaceMode; /*!< Current Flash Interface mode */
BSP_OSPI_NOR_Transfer_t TransferRate; /*!< Current Flash Transfer rate */
} BSP_OSPI_NOR_Init_t;
/**
* @}
*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup STM32U5x9J_DISCOVERY_OSPI_Exported_Constants OSPI Exported Constants
* @{
*/
/* Definition for OSPI clock resources */
#define OSPI_CLK_ENABLE() __HAL_RCC_OSPI1_CLK_ENABLE()
#define OSPI_CLK_DISABLE() __HAL_RCC_OSPI1_CLK_DISABLE()
#define OSPI_CLK_GPIO_CLK_ENABLE() __HAL_RCC_GPIOF_CLK_ENABLE()
#define OSPI_DQS_GPIO_CLK_ENABLE() __HAL_RCC_GPIOA_CLK_ENABLE()
#define OSPI_CS_GPIO_CLK_ENABLE() __HAL_RCC_GPIOA_CLK_ENABLE()
#define OSPI_D0_GPIO_CLK_ENABLE() __HAL_RCC_GPIOF_CLK_ENABLE()
#define OSPI_D1_GPIO_CLK_ENABLE() __HAL_RCC_GPIOF_CLK_ENABLE()
#define OSPI_D2_GPIO_CLK_ENABLE() __HAL_RCC_GPIOF_CLK_ENABLE()
#define OSPI_D3_GPIO_CLK_ENABLE() __HAL_RCC_GPIOF_CLK_ENABLE()
#define OSPI_D4_GPIO_CLK_ENABLE() __HAL_RCC_GPIOC_CLK_ENABLE()
#define OSPI_D5_GPIO_CLK_ENABLE() __HAL_RCC_GPIOC_CLK_ENABLE()
#define OSPI_D6_GPIO_CLK_ENABLE() __HAL_RCC_GPIOC_CLK_ENABLE()
#define OSPI_D7_GPIO_CLK_ENABLE() __HAL_RCC_GPIOC_CLK_ENABLE()
#define OSPI_FORCE_RESET() __HAL_RCC_OSPI1_FORCE_RESET()
#define OSPI_RELEASE_RESET() __HAL_RCC_OSPI1_RELEASE_RESET()
/* Definition for OSPI Pins */
/* OSPI_CLK */
#define OSPI_CLK_PIN GPIO_PIN_10
#define OSPI_CLK_GPIO_PORT GPIOF
#define OSPI_CLK_PIN_AF GPIO_AF3_OCTOSPI1
/* OSPI_DQS */
#define OSPI_DQS_PIN GPIO_PIN_1
#define OSPI_DQS_GPIO_PORT GPIOA
#define OSPI_DQS_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_CS */
#define OSPI_CS_PIN GPIO_PIN_2
#define OSPI_CS_GPIO_PORT GPIOA
#define OSPI_CS_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D0 */
#define OSPI_D0_PIN GPIO_PIN_8
#define OSPI_D0_GPIO_PORT GPIOF
#define OSPI_D0_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D1 */
#define OSPI_D1_PIN GPIO_PIN_9
#define OSPI_D1_GPIO_PORT GPIOF
#define OSPI_D1_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D2 */
#define OSPI_D2_PIN GPIO_PIN_7
#define OSPI_D2_GPIO_PORT GPIOF
#define OSPI_D2_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D3 */
#define OSPI_D3_PIN GPIO_PIN_6
#define OSPI_D3_GPIO_PORT GPIOF
#define OSPI_D3_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D4 */
#define OSPI_D4_PIN GPIO_PIN_1
#define OSPI_D4_GPIO_PORT GPIOC
#define OSPI_D4_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D5 */
#define OSPI_D5_PIN GPIO_PIN_2
#define OSPI_D5_GPIO_PORT GPIOC
#define OSPI_D5_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D6 */
#define OSPI_D6_PIN GPIO_PIN_3
#define OSPI_D6_GPIO_PORT GPIOC
#define OSPI_D6_PIN_AF GPIO_AF10_OCTOSPI1
/* OSPI_D7 */
#define OSPI_D7_PIN GPIO_PIN_0
#define OSPI_D7_GPIO_PORT GPIOC
#define OSPI_D7_PIN_AF GPIO_AF3_OCTOSPI1
/**
* @}
*/
/** @defgroup STM32U5x9J_DISCOVERY_OSPI_NOR_Exported_Constants OSPI NOR Exported Constants
* @{
*/
#define OSPI_NOR_INSTANCES_NUMBER 1U
/* Definition for OSPI modes */
#define BSP_OSPI_NOR_SPI_MODE (BSP_OSPI_NOR_Interface_t)MX25UM51245G_SPI_MODE /* 1 Cmd Line, 1 Address Line
and 1 Data Line */
#define BSP_OSPI_NOR_OPI_MODE (BSP_OSPI_NOR_Interface_t)MX25UM51245G_OPI_MODE /* 8 Cmd Lines, 8 Address Lines
and 8 Data Lines */
/* Definition for OSPI transfer rates */
#define BSP_OSPI_NOR_STR_TRANSFER (BSP_OSPI_NOR_Transfer_t)MX25UM51245G_STR_TRANSFER /* Single Transfer Rate */
#define BSP_OSPI_NOR_DTR_TRANSFER (BSP_OSPI_NOR_Transfer_t)MX25UM51245G_DTR_TRANSFER /* Double Transfer Rate */
/* OSPI erase types */
#define BSP_OSPI_NOR_ERASE_4K MX25UM51245G_ERASE_4K
#define BSP_OSPI_NOR_ERASE_64K MX25UM51245G_ERASE_64K
#define BSP_OSPI_NOR_ERASE_CHIP MX25UM51245G_ERASE_BULK
/* OSPI block sizes */
#define BSP_OSPI_NOR_BLOCK_4K MX25UM51245G_SUBSECTOR_4K
#define BSP_OSPI_NOR_BLOCK_64K MX25UM51245G_SECTOR_64K
/**
* @}
*/
/* Exported variables --------------------------------------------------------*/
/** @defgroup STM32U5x9J_DISCOVERY_OSPI_NOR_Exported_Variables OSPI NOR Exported Variables
* @{
*/
extern XSPI_HandleTypeDef hospi_nor[OSPI_NOR_INSTANCES_NUMBER];
extern OSPI_NOR_Ctx_t Ospi_Nor_Ctx[OSPI_NOR_INSTANCES_NUMBER];
/**
* @}
*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup STM32U5x9J_DISCOVERY_OSPI_NOR_Exported_Functions OSPI NOR Exported Functions
* @{
*/
int32_t BSP_OSPI_NOR_Init(uint32_t Instance, BSP_OSPI_NOR_Init_t *Init);
int32_t BSP_OSPI_NOR_DeInit(uint32_t Instance);
#if (USE_HAL_OSPI_REGISTER_CALLBACKS == 1)
int32_t BSP_OSPI_NOR_RegisterMspCallbacks(uint32_t Instance, BSP_OSPI_Cb_t *CallBacks);
int32_t BSP_OSPI_NOR_RegisterDefaultMspCallbacks(uint32_t Instance);
#endif /* (USE_HAL_OSPI_REGISTER_CALLBACKS == 1) */
int32_t BSP_OSPI_NOR_Read(uint32_t Instance, uint8_t *pData, uint32_t ReadAddr, uint32_t Size);
int32_t BSP_OSPI_NOR_Write(uint32_t Instance, uint8_t *pData, uint32_t WriteAddr, uint32_t Size);
int32_t BSP_OSPI_NOR_Erase_Block(uint32_t Instance, uint32_t BlockAddress, BSP_OSPI_NOR_Erase_t BlockSize);
int32_t BSP_OSPI_NOR_Erase_Chip(uint32_t Instance);
int32_t BSP_OSPI_NOR_GetStatus(uint32_t Instance);
int32_t BSP_OSPI_NOR_GetInfo(uint32_t Instance, BSP_OSPI_NOR_Info_t *pInfo);
int32_t BSP_OSPI_NOR_EnableMemoryMappedMode(uint32_t Instance);
int32_t BSP_OSPI_NOR_DisableMemoryMappedMode(uint32_t Instance);
int32_t BSP_OSPI_NOR_ReadID(uint32_t Instance, uint8_t *Id);
int32_t BSP_OSPI_NOR_ConfigFlash(uint32_t Instance, BSP_OSPI_NOR_Interface_t Mode, BSP_OSPI_NOR_Transfer_t Rate);
int32_t BSP_OSPI_NOR_SuspendErase(uint32_t Instance);
int32_t BSP_OSPI_NOR_ResumeErase(uint32_t Instance);
int32_t BSP_OSPI_NOR_EnterDeepPowerDown(uint32_t Instance);
int32_t BSP_OSPI_NOR_LeaveDeepPowerDown(uint32_t Instance);
/* These functions can be modified in case the current settings
need to be changed for specific application needs */
HAL_StatusTypeDef MX_OSPI_NOR_Init(XSPI_HandleTypeDef *hospi, MX_OSPI_InitTypeDef *Init);
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* STM32U5x9J_DISCOVERY_OSPI_H */