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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
/* SPDX-License-Identifier: BSD-3-Clause */
/**
******************************************************************************
* @file MT25TL01G.h
* @author MCD Application Team
* @brief This file contains all the description of the MT25TL01G QSPI memory.
******************************************************************************
* @attention
*
* <h2><center>© Copyright (c) 2016 STMicroelectronics.
* All rights reserved.</center></h2>
*
* This software component is licensed by ST under BSD 3-Clause license,
* the "License"; You may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
* opensource.org/licenses/BSD-3-Clause
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef MT25TL01G_H
#define MT25TL01G_H
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
#include "mt25tl01g_conf.h"
/** @addtogroup BSP
* @{
*/
/** @addtogroup Components
* @{
*/
/** @addtogroup MT25TL01G
* @{
*/
/** @defgroup MT25TL01G_Exported_Types
* @{
*/
typedef struct {
uint32_t FlashSize; /*!< Size of the flash */
uint32_t EraseSectorSize; /*!< Size of sectors for the erase operation */
uint32_t EraseSectorsNumber; /*!< Number of sectors for the erase operation */
uint32_t ProgPageSize; /*!< Size of pages for the program operation */
uint32_t ProgPagesNumber; /*!< Number of pages for the program operation */
} MT25TL01G_Info;
/* MT25TL01G Component Error codes *********************************************/
#define MT25TL01G_OK 0
#define MT25TL01G_ERROR_INIT -1
#define MT25TL01G_ERROR_COMMAND -2
#define MT25TL01G_ERROR_TRANSMIT -3
#define MT25TL01G_ERROR_RECEIVE -4
#define MT25TL01G_ERROR_AUTOPOLLING -5
#define MT25TL01G_ERROR_MEMORYMAPPED -6
/**exported type **/
/******************MT25TL01G_Info_t**********************/
typedef struct
{
uint32_t FlashSize; /*!< Size of the flash */
uint32_t EraseSectorSize; /*!< Size of sectors for the erase operation */
uint32_t EraseSectorsNumber; /*!< Number of sectors for the erase operation */
uint32_t ProgPageSize; /*!< Size of pages for the program operation */
uint32_t ProgPagesNumber; /*!< Number of pages for the program operation */
} MT25TL01G_Info_t;
/******************MT25TL01G_Transfer_t**********************/
typedef enum
{
MT25TL01G_SPI_MODE = 0, /*!< 1-1-1 commands, Power on H/W default setting */
MT25TL01G_SPI_2IO_MODE, /*!< 1-1-2, 1-2-2 read commands */
MT25TL01G_SPI_4IO_MODE, /*!< 1-1-4, 1-4-4 read commands */
MT25TL01G_QPI_MODE /*!< 4-4-4 commands */
} MT25TL01G_Interface_t;
/******************MT25TL01G_Transfer_t**********************/
typedef enum
{
MT25TL01G_STR_TRANSFER = 0, /* Single Transfer Rate */
MT25TL01G_DTR_TRANSFER /* Double Transfer Rate */
} MT25TL01G_Transfer_t;
/******************MT25TL01G_DualFlash_t**********************/
typedef enum
{
MT25TL01G_DUALFLASH_DISABLE = QSPI_DUALFLASH_DISABLE, /*!< Single flash mode */
MT25TL01G_DUALFLASH_ENABLE =QSPI_DUALFLASH_ENABLE
} MT25TL01G_DualFlash_t;
/******************MT25TL01G_Erase_t**********************/
typedef enum
{
MT25TL01G_ERASE_4K = 0, /*!< 4K size Sector erase */
MT25TL01G_ERASE_32K, /*!< 32K size Block erase */
MT25TL01G_ERASE_64K, /*!< 64K size Block erase */
MT25TL01G_ERASE_CHIP /*!< Whole chip erase */
} MT25TL01G_Erase_t;
/**
* @}
*/
/** @defgroup MT25TL01G_Exported_Constants
* @{
*/
/**
* @brief MT25TL01G Configuration
*/
#define MT25TL01G_FLASH_SIZE 0x8000000 /* 2 * 512 MBits => 2 * 64MBytes => 128MBytes*/
#define MT25TL01G_SECTOR_SIZE 0x10000 /* 2 * 1024 sectors of 64KBytes */
#define MT25TL01G_SUBSECTOR_SIZE 0x1000 /* 2 * 16384 subsectors of 4kBytes */
#define MT25TL01G_PAGE_SIZE 0x100 /* 2 * 262144 pages of 256 bytes */
#define MT25TL01G_DIE_ERASE_MAX_TIME 460000
#define MT25TL01G_SECTOR_ERASE_MAX_TIME 1000
#define MT25TL01G_SUBSECTOR_ERASE_MAX_TIME 400
/**
* @brief MT25TL01G Commands
*/
/* Reset Operations */
#define MT25TL01G_RESET_ENABLE_CMD 0x66
#define MT25TL01G_RESET_MEMORY_CMD 0x99
/* Identification Operations */
#define MT25TL01G_READ_ID_CMD 0x9E
#define MT25TL01G_READ_ID_CMD2 0x9F
#define MT25TL01G_MULTIPLE_IO_READ_ID_CMD 0xAF
#define MT25TL01G_READ_SERIAL_FLASH_DISCO_PARAM_CMD 0x5A
/* Read Operations */
#define MT25TL01G_READ_CMD 0x03
#define MT25TL01G_READ_4_BYTE_ADDR_CMD 0x13
#define MT25TL01G_FAST_READ_CMD 0x0B
#define MT25TL01G_FAST_READ_DTR_CMD 0x0D
#define MT25TL01G_FAST_READ_4_BYTE_ADDR_CMD 0x0C
#define MT25TL01G_FAST_READ_4_BYTE_DTR_CMD 0x0E
#define MT25TL01G_DUAL_OUT_FAST_READ_CMD 0x3B
#define MT25TL01G_DUAL_OUT_FAST_READ_DTR_CMD 0x3D
#define MT25TL01G_DUAL_OUT_FAST_READ_4_BYTE_ADDR_CMD 0x3C
#define MT25TL01G_DUAL_INOUT_FAST_READ_CMD 0xBB
#define MT25TL01G_DUAL_INOUT_FAST_READ_DTR_CMD 0xBD
#define MT25TL01G_DUAL_INOUT_FAST_READ_4_BYTE_ADDR_CMD 0xBC
#define MT25TL01G_QUAD_OUT_FAST_READ_CMD 0x6B
#define MT25TL01G_QUAD_OUT_FAST_READ_DTR_CMD 0x6D
#define MT25TL01G_QUAD_OUT_FAST_READ_4_BYTE_ADDR_CMD 0x6C
#define MT25TL01G_QUAD_INOUT_FAST_READ_CMD 0xEB
#define MT25TL01G_QUAD_INOUT_FAST_READ_DTR_CMD 0xED
#define MT25TL01G_QUAD_INOUT_FAST_READ_4_BYTE_ADDR_CMD 0xEC
#define MT25TL01G_QUAD_INOUT_FAST_READ_4_BYTE_DTR_CMD 0xEE
/* Write Operations */
#define MT25TL01G_WRITE_ENABLE_CMD 0x06
#define MT25TL01G_WRITE_DISABLE_CMD 0x04
/* Register Operations */
#define MT25TL01G_READ_STATUS_REG_CMD 0x05
#define MT25TL01G_WRITE_STATUS_REG_CMD 0x01
#define MT25TL01G_READ_LOCK_REG_CMD 0xE8
#define MT25TL01G_WRITE_LOCK_REG_CMD 0xE5
#define MT25TL01G_READ_FLAG_STATUS_REG_CMD 0x70
#define MT25TL01G_CLEAR_FLAG_STATUS_REG_CMD 0x50
#define MT25TL01G_READ_NONVOL_CFG_REG_CMD 0xB5
#define MT25TL01G_WRITE_NONVOL_CFG_REG_CMD 0xB1
#define MT25TL01G_READ_VOL_CFG_REG_CMD 0x85
#define MT25TL01G_WRITE_VOL_CFG_REG_CMD 0x81
#define MT25TL01G_READ_ENHANCED_VOL_CFG_REG_CMD 0x65
#define MT25TL01G_WRITE_ENHANCED_VOL_CFG_REG_CMD 0x61
#define MT25TL01G_READ_EXT_ADDR_REG_CMD 0xC8
#define MT25TL01G_WRITE_EXT_ADDR_REG_CMD 0xC5
/* Program Operations */
#define MT25TL01G_PAGE_PROG_CMD 0x02
#define MT25TL01G_PAGE_PROG_4_BYTE_ADDR_CMD 0x12
#define MT25TL01G_DUAL_IN_FAST_PROG_CMD 0xA2
#define MT25TL01G_EXT_DUAL_IN_FAST_PROG_CMD 0xD2
#define MT25TL01G_QUAD_IN_FAST_PROG_CMD 0x32
#define MT25TL01G_EXT_QUAD_IN_FAST_PROG_CMD 0x38
#define MT25TL01G_QUAD_IN_FAST_PROG_4_BYTE_ADDR_CMD 0x34
/* Erase Operations */
#define MT25TL01G_SUBSECTOR_ERASE_CMD_4K 0x20
#define MT25TL01G_SUBSECTOR_ERASE_4_BYTE_ADDR_CMD_4K 0x21
#define MT25TL01G_SUBSECTOR_ERASE_CMD_32K 0x52
#define MT25TL01G_SECTOR_ERASE_CMD 0xD8
#define MT25TL01G_SECTOR_ERASE_4_BYTE_ADDR_CMD 0xDC
#define MT25TL01G_DIE_ERASE_CMD 0xC7
#define MT25TL01G_PROG_ERASE_RESUME_CMD 0x7A
#define MT25TL01G_PROG_ERASE_SUSPEND_CMD 0x75
/* One-Time Programmable Operations */
#define MT25TL01G_READ_OTP_ARRAY_CMD 0x4B
#define MT25TL01G_PROG_OTP_ARRAY_CMD 0x42
/* 4-byte Address Mode Operations */
#define MT25TL01G_ENTER_4_BYTE_ADDR_MODE_CMD 0xB7
#define MT25TL01G_EXIT_4_BYTE_ADDR_MODE_CMD 0xE9
/* Quad Operations */
#define MT25TL01G_ENTER_QUAD_CMD 0x35
#define MT25TL01G_EXIT_QUAD_CMD 0xF5
#define MT25TL01G_ENTER_DEEP_POWER_DOWN 0xB9
#define MT25TL01G_RELEASE_FROM_DEEP_POWER_DOWN 0xAB
/*ADVANCED SECTOR PROTECTION Operations*/
#define MT25TL01G_READ_SECTOR_PROTECTION_CMD 0x2D
#define MT25TL01G_PROGRAM_SECTOR_PROTECTION 0x2C
#define MT25TL01G_READ_PASSWORD_CMD 0x27
#define MT25TL01G_WRITE_PASSWORD_CMD 0x28
#define MT25TL01G_UNLOCK_PASSWORD_CMD 0x29
#define MT25TL01G_READ_GLOBAL_FREEZE_BIT 0xA7
#define MT25TL01G_READ_VOLATILE_LOCK_BITS 0xE8
#define MT25TL01G_WRITE_VOLATILE_LOCK_BITS 0xE5
/*ADVANCED SECTOR PROTECTION Operations with 4-Byte Address*/
#define MT25TL01G_WRITE_4_BYTE_VOLATILE_LOCK_BITS 0xE1
#define MT25TL01G_READ_4_BYTE_VOLATILE_LOCK_BITS 0xE0
/*One Time Programmable Operations */
#define MT25TL01G_READ_OTP_ARRAY 0x4B
#define MT25TL01G_PROGRAM_OTP_ARRAY 0x42
/**
* @brief MT25TL01G Registers
*/
/* Status Register */
#define MT25TL01G_SR_WIP ((uint8_t)0x01) /*!< Write in progress */
#define MT25TL01G_SR_WREN ((uint8_t)0x02) /*!< Write enable latch */
#define MT25TL01G_SR_BLOCKPR ((uint8_t)0x5C) /*!< Block protected against program and erase operations */
#define MT25TL01G_SR_PRBOTTOM ((uint8_t)0x20) /*!< Protected memory area defined by BLOCKPR starts from top or bottom */
#define MT25TL01G_SR_SRWREN ((uint8_t)0x80) /*!< Status register write enable/disable */
/* Non volatile Configuration Register */
#define MT25TL01G_NVCR_NBADDR ((uint16_t)0x0001) /*!< 3-bytes or 4-bytes addressing */
#define MT25TL01G_NVCR_SEGMENT ((uint16_t)0x0002) /*!< Upper or lower 128Mb segment selected by default */
#define MT25TL01G_NVCR_DUAL ((uint16_t)0x0004) /*!< Dual I/O protocol */
#define MT25TL01G_NVCR_QUAB ((uint16_t)0x0008) /*!< Quad I/O protocol */
#define MT25TL01G_NVCR_RH ((uint16_t)0x0010) /*!< Reset/hold */
#define MT25TL01G_NVCR_DTRP ((uint16_t)0x0020) /*!< Double transfer rate protocol */
#define MT25TL01G_NVCR_ODS ((uint16_t)0x01C0) /*!< Output driver strength */
#define MT25TL01G_NVCR_XIP ((uint16_t)0x0E00) /*!< XIP mode at power-on reset */
#define MT25TL01G_NVCR_NB_DUMMY ((uint16_t)0xF000) /*!< Number of dummy clock cycles */
/* Volatile Configuration Register */
#define MT25TL01G_VCR_WRAP ((uint8_t)0x03) /*!< Wrap */
#define MT25TL01G_VCR_XIP ((uint8_t)0x08) /*!< XIP */
#define MT25TL01G_VCR_NB_DUMMY ((uint8_t)0xF0) /*!< Number of dummy clock cycles */
/* Extended Address Register */
#define MT25TL01G_EAR_HIGHEST_SE ((uint8_t)0x03) /*!< Select the Highest 128Mb segment */
#define MT25TL01G_EAR_THIRD_SEG ((uint8_t)0x02) /*!< Select the Third 128Mb segment */
#define MT25TL01G_EAR_SECOND_SEG ((uint8_t)0x01) /*!< Select the Second 128Mb segment */
#define MT25TL01G_EAR_LOWEST_SEG ((uint8_t)0x00) /*!< Select the Lowest 128Mb segment (default) */
/* Enhanced Volatile Configuration Register */
#define MT25TL01G_EVCR_ODS ((uint8_t)0x07) /*!< Output driver strength */
#define MT25TL01G_EVCR_RH ((uint8_t)0x10) /*!< Reset/hold */
#define MT25TL01G_EVCR_DTRP ((uint8_t)0x20) /*!< Double transfer rate protocol */
#define MT25TL01G_EVCR_DUAL ((uint8_t)0x40) /*!< Dual I/O protocol */
#define MT25TL01G_EVCR_QUAD ((uint8_t)0x80) /*!< Quad I/O protocol */
/* Flag Status Register */
#define MT25TL01G_FSR_NBADDR ((uint8_t)0x01) /*!< 3-bytes or 4-bytes addressing */
#define MT25TL01G_FSR_PRERR ((uint8_t)0x02) /*!< Protection error */
#define MT25TL01G_FSR_PGSUS ((uint8_t)0x04) /*!< Program operation suspended */
#define MT25TL01G_FSR_PGERR ((uint8_t)0x10) /*!< Program error */
#define MT25TL01G_FSR_ERERR ((uint8_t)0x20) /*!< Erase error */
#define MT25TL01G_FSR_ERSUS ((uint8_t)0x40) /*!< Erase operation suspended */
#define MT25TL01G_FSR_READY ((uint8_t)0x80) /*!< Ready or command in progress */
/**
* @}
*/
/** @defgroup MT25TL01G_Exported_Functions
* @{
*/
int32_t MT25TL01G_GetFlashInfo(MT25TL01G_Info_t *pInfo);
int32_t MT25TL01G_Enter4BytesAddressMode(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_Exit4BytesAddressMode(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_AutoPollingMemReady(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
/* Register/Setting Commands *************************************************/
int32_t MT25TL01G_WriteEnable(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_BlockErase(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint32_t BlockAddress, MT25TL01G_Erase_t BlockSize);
int32_t MT25TL01G_ChipErase(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_PageProgram(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint8_t *pData, uint32_t WriteAddr, uint32_t Size);
int32_t MT25TL01G_ReadSTR(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint8_t *pData, uint32_t ReadAddr, uint32_t Size);
int32_t MT25TL01G_ReadDTR(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint8_t *pData, uint32_t ReadAddr, uint32_t Size);
int32_t MT25TL01G_ReadStatusRegister(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint8_t *Value);
int32_t MT25TL01G_EnterQPIMode(QSPI_HandleTypeDef *Ctx);
int32_t MT25TL01G_ExitQPIMode(QSPI_HandleTypeDef *Ctx);
int32_t MT25TL01G_EnableMemoryMappedModeSTR(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_EnableMemoryMappedModeDTR(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_WriteDisable(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_ReadID(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint8_t *ID);
int32_t MT25TL01G_ResetMemory(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_ResetEnable(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_ReadSPBLockRegister(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode, uint8_t *SPBRegister);
int32_t MT25TL01G_ReleaseFromDeepPowerDown(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_EnterDeepPowerDown(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_ProgEraseResume(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
int32_t MT25TL01G_ProgEraseSuspend(QSPI_HandleTypeDef *Ctx, MT25TL01G_Interface_t Mode);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __MT25TL01G_H */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
