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
|
/** @file
This file defines the SPI NOR Flash Protocol.
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD
License which accompanies this distribution. The full text of the license may
be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@par Revision Reference:
This Protocol was introduced in UEFI PI Specification 1.6.
**/
#ifndef __SPI_NOR_FLASH_PROTOCOL_H__
#define __SPI_NOR_FLASH_PROTOCOL_H__
#include <Protocol/SpiConfiguration.h>
///
/// Global ID for the SPI NOR Flash Protocol
///
#define EFI_SPI_NOR_FLASH_PROTOCOL_GUID \
{ 0xb57ec3fe, 0xf833, 0x4ba6, \
{ 0x85, 0x78, 0x2a, 0x7d, 0x6a, 0x87, 0x44, 0x4b }}
typedef struct _EFI_SPI_NOR_FLASH_PROTOCOL EFI_SPI_NOR_FLASH_PROTOCOL;
/**
Read the 3 byte manufacture and device ID from the SPI flash.
This routine must be called at or below TPL_NOTIFY.
This routine reads the 3 byte manufacture and device ID from the flash part
filling the buffer provided.
@param[in] This Pointer to an EFI_SPI_NOR_FLASH_PROTOCOL data structure.
@param[out] Buffer Pointer to a 3 byte buffer to receive the manufacture and
device ID.
@retval EFI_SUCCESS The manufacture and device ID was read
successfully.
@retval EFI_INVALID_PARAMETER Buffer is NULL
@retval EFI_DEVICE_ERROR Invalid data received from SPI flash part.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_NOR_FLASH_PROTOCOL_GET_FLASH_ID) (
IN CONST EFI_SPI_NOR_FLASH_PROTOCOL *This,
OUT UINT8 *Buffer
);
/**
Read data from the SPI flash.
This routine must be called at or below TPL_NOTIFY.
This routine reads data from the SPI part in the buffer provided.
@param[in] This Pointer to an EFI_SPI_NOR_FLASH_PROTOCOL data
structure.
@param[in] FlashAddress Address in the flash to start reading
@param[in] LengthInBytes Read length in bytes
@param[out] Buffer Address of a buffer to receive the data
@retval EFI_SUCCESS The data was read successfully.
@retval EFI_INVALID_PARAMETER Buffer is NULL, or
FlashAddress >= This->FlashSize, or
LengthInBytes > This->FlashSize - FlashAddress
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_NOR_FLASH_PROTOCOL_READ_DATA) (
IN CONST EFI_SPI_NOR_FLASH_PROTOCOL *This,
IN UINT32 FlashAddress,
IN UINT32 LengthInBytes,
OUT UINT8 *Buffer
);
/**
Read the flash status register.
This routine must be called at or below TPL_NOTIFY.
This routine reads the flash part status register.
@param[in] This Pointer to an EFI_SPI_NOR_FLASH_PROTOCOL data
structure.
@param[in] LengthInBytes Number of status bytes to read.
@param[out] FlashStatus Pointer to a buffer to receive the flash status.
@retval EFI_SUCCESS The status register was read successfully.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_NOR_FLASH_PROTOCOL_READ_STATUS) (
IN CONST EFI_SPI_NOR_FLASH_PROTOCOL *This,
IN UINT32 LengthInBytes,
OUT UINT8 *FlashStatus
);
/**
Write the flash status register.
This routine must be called at or below TPL_N OTIFY.
This routine writes the flash part status register.
@param[in] This Pointer to an EFI_SPI_NOR_FLASH_PROTOCOL data
structure.
@param[in] LengthInBytes Number of status bytes to write.
@param[in] FlashStatus Pointer to a buffer containing the new status.
@retval EFI_SUCCESS The status write was successful.
@retval EFI_OUT_OF_RESOURCES Failed to allocate the write buffer.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_NOR_FLASH_PROTOCOL_WRITE_STATUS) (
IN CONST EFI_SPI_NOR_FLASH_PROTOCOL *This,
IN UINT32 LengthInBytes,
IN UINT8 *FlashStatus
);
/**
Write data to the SPI flash.
This routine must be called at or below TPL_NOTIFY.
This routine breaks up the write operation as necessary to write the data to
the SPI part.
@param[in] This Pointer to an EFI_SPI_NOR_FLASH_PROTOCOL data
structure.
@param[in] FlashAddress Address in the flash to start writing
@param[in] LengthInBytes Write length in bytes
@param[in] Buffer Address of a buffer containing the data
@retval EFI_SUCCESS The data was written successfully.
@retval EFI_INVALID_PARAMETER Buffer is NULL, or
FlashAddress >= This->FlashSize, or
LengthInBytes > This->FlashSize - FlashAddress
@retval EFI_OUT_OF_RESOURCES Insufficient memory to copy buffer.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_NOR_FLASH_PROTOCOL_WRITE_DATA) (
IN CONST EFI_SPI_NOR_FLASH_PROTOCOL *This,
IN UINT32 FlashAddress,
IN UINT32 LengthInBytes,
IN UINT8 *Buffer
);
/**
Efficiently erases one or more 4KiB regions in the SPI flash.
This routine must be called at or below TPL_NOTIFY.
This routine uses a combination of 4 KiB and larger blocks to erase the
specified area.
@param[in] This Pointer to an EFI_SPI_NOR_FLASH_PROTOCOL data
structure.
@param[in] FlashAddress Address within a 4 KiB block to start erasing
@param[in] BlockCount Number of 4 KiB blocks to erase
@retval EFI_SUCCESS The erase was completed successfully.
@retval EFI_INVALID_PARAMETER FlashAddress >= This->FlashSize, or
BlockCount * 4 KiB
> This->FlashSize - FlashAddress
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_NOR_FLASH_PROTOCOL_ERASE) (
IN CONST EFI_SPI_NOR_FLASH_PROTOCOL *This,
IN UINT32 FlashAddress,
IN UINT32 BlockCount
);
///
/// The EFI_SPI_NOR_FLASH_PROTOCOL exists in the SPI peripheral layer.
/// This protocol manipulates the SPI NOR flash parts using a common set of
/// commands. The board layer provides the interconnection and configuration
/// details for the SPI NOR flash part. The SPI NOR flash driver uses this
/// configuration data to expose a generic interface which provides the
/// following APls:
/// * Read manufacture and device ID
/// * Read data
/// * Read data using low frequency
/// * Read status
/// * Write data
/// * Erase 4 KiB blocks
/// * Erase 32 or 64 KiB blocks
/// * Write status
/// The EFI_SPI_NOR_FLASH_PROTOCOL also exposes some APls to set the security
/// features on the legacy SPI flash controller.
///
struct _EFI_SPI_NOR_FLASH_PROTOCOL {
///
/// Pointer to an EFI_SPI_PERIPHERAL data structure
///
CONST EFI_SPI_PERIPHERAL *SpiPeripheral;
///
/// Flash size in bytes
///
UINT32 FlashSize;
///
/// Manufacture and Device ID
///
UINT8 Deviceid[3];
///
/// Erase block size in bytes
///
UINT32 EraseBlockBytes;
///
/// Read the 3 byte manufacture and device ID from the SPI flash.
///
EFI_SPI_NOR_FLASH_PROTOCOL_GET_FLASH_ID GetFlashid;
///
/// Read data from the SPI flash.
///
EFI_SPI_NOR_FLASH_PROTOCOL_READ_DATA ReadData;
///
/// Low frequency read data from the SPI flash.
///
EFI_SPI_NOR_FLASH_PROTOCOL_READ_DATA LfReadData;
///
/// Read the flash status register.
///
EFI_SPI_NOR_FLASH_PROTOCOL_READ_STATUS ReadStatus;
///
/// Write the flash status register.
///
EFI_SPI_NOR_FLASH_PROTOCOL_WRITE_STATUS WriteStatus;
///
/// Write data to the SPI flash.
///
EFI_SPI_NOR_FLASH_PROTOCOL_WRITE_DATA WriteData;
///
/// Efficiently erases one or more 4KiB regions in the SPI flash.
///
EFI_SPI_NOR_FLASH_PROTOCOL_ERASE Erase;
};
extern EFI_GUID gEfiSpiNorFlashProtocolGuid;
#endif // __SPI_NOR_FLASH_PROTOCOL_H__
|
