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
|
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file n25q_flash.h
* @brief Micron N25Q serial flash driver header.
*
* @addtogroup MICRON_N25Q
* @ingroup M25Q
* @{
*/
#ifndef MICRON_N25Q_H
#define MICRON_N25Q_H
#include "hal_jesd216_flash.h"
#include "m25q_flash.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/**
* @name Device identification
* @{
*/
#define M25Q_SUPPORTED_MANUFACTURE_IDS {0x20}
#define M25Q_SUPPORTED_MEMORY_TYPE_IDS {0xBA, 0xBB}
/** @} */
/**
* @name Command codes
* @{
*/
#define M25Q_CMD_RESET_ENABLE 0x66
#define M25Q_CMD_RESET_MEMORY 0x99
#define M25Q_CMD_READ_ID 0x9F
#define M25Q_CMD_MULTIPLE_IO_READ_ID 0xAF
#define M25Q_CMD_READ_DISCOVERY_PARAMETER 0x5A
#define M25Q_CMD_READ 0x03
#define M25Q_CMD_FAST_READ 0x0B
#define M25Q_CMD_WRITE_ENABLE 0x06
#define M25Q_CMD_WRITE_DISABLE 0x04
#define M25Q_CMD_READ_STATUS_REGISTER 0x05
#define M25Q_CMD_WRITE_STATUS_REGISTER 0x01
#define M25Q_CMD_READ_LOCK_REGISTER 0xE8
#define M25Q_CMD_WRITE_LOCK_REGISTER 0xE5
#define M25Q_CMD_READ_FLAG_STATUS_REGISTER 0x70
#define M25Q_CMD_CLEAR_FLAG_STATUS_REGISTER 0x50
#define M25Q_CMD_READ_NV_CONFIGURATION_REGISTER 0xB5
#define M25Q_CMD_WRITE_NV_CONFIGURATION_REGISTER 0xB1
#define M25Q_CMD_READ_V_CONF_REGISTER 0x85
#define M25Q_CMD_WRITE_V_CONF_REGISTER 0x81
#define M25Q_CMD_READ_ENHANCED_V_CONF_REGISTER 0x65
#define M25Q_CMD_WRITE_ENHANCED_V_CONF_REGISTER 0x61
#define M25Q_CMD_PAGE_PROGRAM 0x02
#define M25Q_CMD_SUBSECTOR_ERASE 0x20
#define M25Q_CMD_SECTOR_ERASE 0xD8
#define M25Q_CMD_BULK_ERASE 0xC7
#define M25Q_CMD_PROGRAM_ERASE_RESUME 0x7A
#define M25Q_CMD_PROGRAM_ERASE_SUSPEND 0x75
#define M25Q_CMD_READ_OTP_ARRAY 0x4B
#define M25Q_CMD_PROGRAM_OTP_ARRAY 0x42
/** @} */
/**
* @name Flags status register bits
* @{
*/
#define M25Q_FLAGS_PROGRAM_ERASE 0x80U
#define M25Q_FLAGS_ERASE_SUSPEND 0x40U
#define M25Q_FLAGS_ERASE_ERROR 0x20U
#define M25Q_FLAGS_PROGRAM_ERROR 0x10U
#define M25Q_FLAGS_VPP_ERROR 0x08U
#define M25Q_FLAGS_PROGRAM_SUSPEND 0x04U
#define M25Q_FLAGS_PROTECTION_ERROR 0x02U
#define M25Q_FLAGS_RESERVED 0x01U
#define M25Q_FLAGS_ALL_ERRORS (M25Q_FLAGS_ERASE_ERROR | \
M25Q_FLAGS_PROGRAM_ERROR | \
M25Q_FLAGS_VPP_ERROR | \
M25Q_FLAGS_PROTECTION_ERROR)
/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if !defined(__DOXYGEN__)
extern flash_descriptor_t m25q_descriptor;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void m25q_device_init(M25QDriver *devp);
const flash_descriptor_t *m25q_get_descriptor(void *instance);
flash_error_t m25q_device_read(M25QDriver *devp, flash_offset_t offset,
size_t n, uint8_t *rp);
flash_error_t m25q_device_program(M25QDriver *devp, flash_offset_t offset,
size_t n, const uint8_t *pp);
flash_error_t m25q_device_start_erase_all(M25QDriver *devp);
flash_error_t m25q_device_start_erase_sector(M25QDriver *devp,
flash_sector_t sector);
flash_error_t m25q_device_verify_erase(M25QDriver *devp,
flash_sector_t sector);
flash_error_t m25q_device_query_erase(M25QDriver *devp, uint32_t *msec);
flash_error_t m25q_device_read_sfdp(M25QDriver *devp, flash_offset_t offset,
size_t n, uint8_t *rp);
#if JESD216_BUS_MODE != JESD216_BUS_MODE_SPI
void m25q_activate_xip(M25QDriver *devp);
void m25q_reset_xip(M25QDriver *devp);
#endif
#ifdef __cplusplus
}
#endif
#endif /* MICRON_N25Q_H */
/** @} */
|
