]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpress.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
MdeModulePkg BootManagerUiLib: Remove invalid keyword "bds".
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / NvmExpressDxe / NvmExpress.h
CommitLineData
eb290d02
FT		 1/** @file\r
2 NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows\r
3 NVM Express specification.\r
4\r
5db1ac89 5 Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved.<BR>\r
eb290d02
FT		 6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php.\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _EFI_NVM_EXPRESS_H_\r
17#define _EFI_NVM_EXPRESS_H_\r
18\r
19#include <Uefi.h>\r
20\r
21#include <IndustryStandard/Pci.h>\r
22\r
23#include <Protocol/ComponentName.h>\r
24#include <Protocol/ComponentName2.h>\r
25#include <Protocol/DriverBinding.h>\r
26#include <Protocol/LoadedImage.h>\r
27#include <Protocol/DevicePath.h>\r
28#include <Protocol/PciIo.h>\r
d6c55989 29#include <Protocol/NvmExpressPassthru.h>\r
eb290d02
FT		 30#include <Protocol/BlockIo.h>\r
31#include <Protocol/DiskInfo.h>\r
32#include <Protocol/DriverSupportedEfiVersion.h>\r
754b489b 33#include <Protocol/StorageSecurityCommand.h>\r
eb290d02
FT		 34\r
35#include <Library/BaseLib.h>\r
36#include <Library/BaseMemoryLib.h>\r
37#include <Library/DebugLib.h>\r
38#include <Library/PrintLib.h>\r
39#include <Library/UefiLib.h>\r
40#include <Library/DevicePathLib.h>\r
41#include <Library/MemoryAllocationLib.h>\r
42#include <Library/UefiBootServicesTableLib.h>\r
43#include <Library/UefiDriverEntryPoint.h>\r
44\r
45typedef struct _NVME_CONTROLLER_PRIVATE_DATA NVME_CONTROLLER_PRIVATE_DATA;\r
46typedef struct _NVME_DEVICE_PRIVATE_DATA NVME_DEVICE_PRIVATE_DATA;\r
47\r
eb290d02
FT		 48#include "NvmExpressBlockIo.h"\r
49#include "NvmExpressDiskInfo.h"\r
50#include "NvmExpressHci.h"\r
51\r
52extern EFI_DRIVER_BINDING_PROTOCOL gNvmExpressDriverBinding;\r
53extern EFI_COMPONENT_NAME_PROTOCOL gNvmExpressComponentName;\r
54extern EFI_COMPONENT_NAME2_PROTOCOL gNvmExpressComponentName2;\r
55extern EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL gNvmExpressDriverSupportedEfiVersion;\r
56\r
57#define PCI_CLASS_MASS_STORAGE_NVM 0x08 // mass storage sub-class non-volatile memory.\r
58#define PCI_IF_NVMHCI 0x02 // mass storage programming interface NVMHCI.\r
59\r
7b8883c6
FT		 60#define NVME_ASQ_SIZE 1 // Number of admin submission queue entries, which is 0-based\r
61#define NVME_ACQ_SIZE 1 // Number of admin completion queue entries, which is 0-based\r
eb290d02 62\r
7b8883c6
FT		 63#define NVME_CSQ_SIZE 1 // Number of I/O submission queue entries, which is 0-based\r
64#define NVME_CCQ_SIZE 1 // Number of I/O completion queue entries, which is 0-based\r
eb290d02 65\r
d6c55989 66#define NVME_MAX_QUEUES 2 // Number of queues supported by the driver\r
eb290d02
FT		 67\r
68#define NVME_CONTROLLER_ID 0\r
69\r
70//\r
71// Time out value for Nvme transaction execution\r
72//\r
73#define NVME_GENERIC_TIMEOUT EFI_TIMER_PERIOD_SECONDS (5)\r
74\r
75//\r
76// Unique signature for private data structure.\r
77//\r
78#define NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('N','V','M','E')\r
79\r
80//\r
81// Nvme private data structure.\r
82//\r
83struct _NVME_CONTROLLER_PRIVATE_DATA {\r
d6c55989 84 UINT32 Signature;\r
eb290d02 85\r
d6c55989
FT		 86 EFI_HANDLE ControllerHandle;\r
87 EFI_HANDLE ImageHandle;\r
88 EFI_HANDLE DriverBindingHandle;\r
eb290d02 89\r
d6c55989
FT		 90 EFI_PCI_IO_PROTOCOL *PciIo;\r
91 UINT64 PciAttributes;\r
eb290d02 92\r
d6c55989 93 EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
eb290d02 94\r
d6c55989
FT		 95 EFI_NVM_EXPRESS_PASS_THRU_MODE PassThruMode;\r
96 EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL Passthru;\r
eb290d02
FT		 97\r
98 //\r
99 // pointer to identify controller data\r
100 //\r
d6c55989 101 NVME_ADMIN_CONTROLLER_DATA *ControllerData;\r
eb290d02
FT		 102\r
103 //\r
5db1ac89 104 // 4 x 4kB aligned buffers will be carved out of this buffer.\r
eb290d02 105 // 1st 4kB boundary is the start of the admin submission queue.\r
5db1ac89
FT		 106 // 2nd 4kB boundary is the start of the admin completion queue.\r
107 // 3rd 4kB boundary is the start of I/O submission queue #1.\r
108 // 4th 4kB boundary is the start of I/O completion queue #1.\r
eb290d02 109 //\r
d6c55989
FT		 110 UINT8 *Buffer;\r
111 UINT8 *BufferPciAddr;\r
eb290d02
FT		 112\r
113 //\r
114 // Pointers to 4kB aligned submission & completion queues.\r
115 //\r
d6c55989
FT		 116 NVME_SQ *SqBuffer[NVME_MAX_QUEUES];\r
117 NVME_CQ *CqBuffer[NVME_MAX_QUEUES];\r
118 NVME_SQ *SqBufferPciAddr[NVME_MAX_QUEUES];\r
119 NVME_CQ *CqBufferPciAddr[NVME_MAX_QUEUES];\r
eb290d02
FT		 120\r
121 //\r
122 // Submission and completion queue indices.\r
123 //\r
d6c55989
FT		 124 NVME_SQTDBL SqTdbl[NVME_MAX_QUEUES];\r
125 NVME_CQHDBL CqHdbl[NVME_MAX_QUEUES];\r
eb290d02 126\r
d6c55989
FT		 127 UINT8 Pt[NVME_MAX_QUEUES];\r
128 UINT16 Cid[NVME_MAX_QUEUES];\r
eb290d02
FT		 129\r
130 //\r
131 // Nvme controller capabilities\r
132 //\r
d6c55989 133 NVME_CAP Cap;\r
eb290d02 134\r
d6c55989 135 VOID *Mapping;\r
eb290d02
FT		 136};\r
137\r
138#define NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU(a) \\r
139 CR (a, \\r
140 NVME_CONTROLLER_PRIVATE_DATA, \\r
141 Passthru, \\r
142 NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE \\r
143 )\r
144\r
145//\r
146// Unique signature for private data structure.\r
147//\r
148#define NVME_DEVICE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('X','S','S','D')\r
149\r
150//\r
151// Nvme device private data structure\r
152//\r
153struct _NVME_DEVICE_PRIVATE_DATA {\r
754b489b 154 UINT32 Signature;\r
eb290d02 155\r
754b489b
TF		 156 EFI_HANDLE DeviceHandle;\r
157 EFI_HANDLE ControllerHandle;\r
158 EFI_HANDLE DriverBindingHandle;\r
eb290d02 159\r
754b489b 160 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
eb290d02 161\r
754b489b 162 EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
eb290d02 163\r
754b489b
TF		 164 UINT32 NamespaceId;\r
165 UINT64 NamespaceUuid;\r
eb290d02 166\r
754b489b
TF		 167 EFI_BLOCK_IO_MEDIA Media;\r
168 EFI_BLOCK_IO_PROTOCOL BlockIo;\r
169 EFI_DISK_INFO_PROTOCOL DiskInfo;\r
170 EFI_STORAGE_SECURITY_COMMAND_PROTOCOL StorageSecurity;\r
eb290d02 171\r
754b489b 172 EFI_LBA NumBlocks;\r
eb290d02 173\r
754b489b
TF		 174 CHAR16 ModelName[80];\r
175 NVME_ADMIN_NAMESPACE_DATA NamespaceData;\r
eb290d02 176\r
754b489b 177 NVME_CONTROLLER_PRIVATE_DATA *Controller;\r
eb290d02
FT		 178\r
179};\r
180\r
181//\r
182// Statments to retrieve the private data from produced protocols.\r
183//\r
184#define NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO(a) \\r
185 CR (a, \\r
186 NVME_DEVICE_PRIVATE_DATA, \\r
187 BlockIo, \\r
188 NVME_DEVICE_PRIVATE_DATA_SIGNATURE \\r
189 )\r
190\r
191#define NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO(a) \\r
192 CR (a, \\r
193 NVME_DEVICE_PRIVATE_DATA, \\r
194 DiskInfo, \\r
195 NVME_DEVICE_PRIVATE_DATA_SIGNATURE \\r
196 )\r
197\r
754b489b
TF		 198#define NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY(a)\\r
199 CR (a, \\r
200 NVME_DEVICE_PRIVATE_DATA, \\r
201 StorageSecurity, \\r
202 NVME_DEVICE_PRIVATE_DATA_SIGNATURE \\r
203 )\r
204\r
eb290d02
FT		 205/**\r
206 Retrieves a Unicode string that is the user readable name of the driver.\r
207\r
208 This function retrieves the user readable name of a driver in the form of a\r
209 Unicode string. If the driver specified by This has a user readable name in\r
210 the language specified by Language, then a pointer to the driver name is\r
211 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
212 by This does not support the language specified by Language,\r
213 then EFI_UNSUPPORTED is returned.\r
214\r
215 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
216 EFI_COMPONENT_NAME_PROTOCOL instance.\r
217\r
218 @param Language[in] A pointer to a Null-terminated ASCII string\r
219 array indicating the language. This is the\r
220 language of the driver name that the caller is\r
221 requesting, and it must match one of the\r
222 languages specified in SupportedLanguages. The\r
223 number of languages supported by a driver is up\r
224 to the driver writer. Language is specified\r
225 in RFC 4646 or ISO 639-2 language code format.\r
226\r
227 @param DriverName[out] A pointer to the Unicode string to return.\r
228 This Unicode string is the name of the\r
229 driver specified by This in the language\r
230 specified by Language.\r
231\r
232 @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
233 This and the language specified by Language was\r
234 returned in DriverName.\r
235\r
236 @retval EFI_INVALID_PARAMETER Language is NULL.\r
237\r
238 @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
239\r
240 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
241 the language specified by Language.\r
242\r
243**/\r
244EFI_STATUS\r
245EFIAPI\r
246NvmExpressComponentNameGetDriverName (\r
247 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
248 IN CHAR8 *Language,\r
249 OUT CHAR16 **DriverName\r
250 );\r
251\r
252/**\r
253 Retrieves a Unicode string that is the user readable name of the controller\r
254 that is being managed by a driver.\r
255\r
256 This function retrieves the user readable name of the controller specified by\r
257 ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
258 driver specified by This has a user readable name in the language specified by\r
259 Language, then a pointer to the controller name is returned in ControllerName,\r
260 and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
261 managing the controller specified by ControllerHandle and ChildHandle,\r
262 then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
263 support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
264\r
265 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
266 EFI_COMPONENT_NAME_PROTOCOL instance.\r
267\r
268 @param ControllerHandle[in] The handle of a controller that the driver\r
269 specified by This is managing. This handle\r
270 specifies the controller whose name is to be\r
271 returned.\r
272\r
273 @param ChildHandle[in] The handle of the child controller to retrieve\r
274 the name of. This is an optional parameter that\r
275 may be NULL. It will be NULL for device\r
276 drivers. It will also be NULL for a bus drivers\r
277 that wish to retrieve the name of the bus\r
278 controller. It will not be NULL for a bus\r
279 driver that wishes to retrieve the name of a\r
280 child controller.\r
281\r
282 @param Language[in] A pointer to a Null-terminated ASCII string\r
283 array indicating the language. This is the\r
284 language of the driver name that the caller is\r
285 requesting, and it must match one of the\r
286 languages specified in SupportedLanguages. The\r
287 number of languages supported by a driver is up\r
288 to the driver writer. Language is specified in\r
289 RFC 4646 or ISO 639-2 language code format.\r
290\r
291 @param ControllerName[out] A pointer to the Unicode string to return.\r
292 This Unicode string is the name of the\r
293 controller specified by ControllerHandle and\r
294 ChildHandle in the language specified by\r
295 Language from the point of view of the driver\r
296 specified by This.\r
297\r
298 @retval EFI_SUCCESS The Unicode string for the user readable name in\r
299 the language specified by Language for the\r
300 driver specified by This was returned in\r
301 DriverName.\r
302\r
303 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
304\r
305 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
306 EFI_HANDLE.\r
307\r
308 @retval EFI_INVALID_PARAMETER Language is NULL.\r
309\r
310 @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
311\r
312 @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
313 managing the controller specified by\r
314 ControllerHandle and ChildHandle.\r
315\r
316 @retval EFI_UNSUPPORTED The driver specified by This does not support\r
317 the language specified by Language.\r
318\r
319**/\r
320EFI_STATUS\r
321EFIAPI\r
322NvmExpressComponentNameGetControllerName (\r
323 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
324 IN EFI_HANDLE ControllerHandle,\r
325 IN EFI_HANDLE ChildHandle OPTIONAL,\r
326 IN CHAR8 *Language,\r
327 OUT CHAR16 **ControllerName\r
328 );\r
329\r
330/**\r
331 Tests to see if this driver supports a given controller. If a child device is provided,\r
332 it further tests to see if this driver supports creating a handle for the specified child device.\r
333\r
334 This function checks to see if the driver specified by This supports the device specified by\r
335 ControllerHandle. Drivers will typically use the device path attached to\r
336 ControllerHandle and/or the services from the bus I/O abstraction attached to\r
337 ControllerHandle to determine if the driver supports ControllerHandle. This function\r
338 may be called many times during platform initialization. In order to reduce boot times, the tests\r
339 performed by this function must be very small, and take as little time as possible to execute. This\r
340 function must not change the state of any hardware devices, and this function must be aware that the\r
341 device specified by ControllerHandle may already be managed by the same driver or a\r
342 different driver. This function must match its calls to AllocatePages() with FreePages(),\r
343 AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
344 Since ControllerHandle may have been previously started by the same driver, if a protocol is\r
345 already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
346 to guarantee the state of ControllerHandle is not modified by this function.\r
347\r
348 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
349 @param[in] ControllerHandle The handle of the controller to test. This handle\r
350 must support a protocol interface that supplies\r
351 an I/O abstraction to the driver.\r
352 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
353 parameter is ignored by device drivers, and is optional for bus\r
354 drivers. For bus drivers, if this parameter is not NULL, then\r
355 the bus driver must determine if the bus controller specified\r
356 by ControllerHandle and the child controller specified\r
357 by RemainingDevicePath are both supported by this\r
358 bus driver.\r
359\r
360 @retval EFI_SUCCESS The device specified by ControllerHandle and\r
361 RemainingDevicePath is supported by the driver specified by This.\r
362 @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r
363 RemainingDevicePath is already being managed by the driver\r
364 specified by This.\r
365 @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r
366 RemainingDevicePath is already being managed by a different\r
367 driver or an application that requires exclusive access.\r
368 Currently not implemented.\r
369 @retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
370 RemainingDevicePath is not supported by the driver specified by This.\r
371**/\r
372EFI_STATUS\r
373EFIAPI\r
374NvmExpressDriverBindingSupported (\r
375 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
376 IN EFI_HANDLE Controller,\r
377 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
378 );\r
379\r
380/**\r
381 Starts a device controller or a bus controller.\r
382\r
383 The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
384 As a result, much of the error checking on the parameters to Start() has been moved into this\r
385 common boot service. It is legal to call Start() from other locations,\r
386 but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
387 1. ControllerHandle must be a valid EFI_HANDLE.\r
388 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
389 EFI_DEVICE_PATH_PROTOCOL.\r
390 3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
391 have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
392\r
393 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
394 @param[in] ControllerHandle The handle of the controller to start. This handle\r
395 must support a protocol interface that supplies\r
396 an I/O abstraction to the driver.\r
397 @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
398 parameter is ignored by device drivers, and is optional for bus\r
399 drivers. For a bus driver, if this parameter is NULL, then handles\r
400 for all the children of Controller are created by this driver.\r
401 If this parameter is not NULL and the first Device Path Node is\r
402 not the End of Device Path Node, then only the handle for the\r
403 child device specified by the first Device Path Node of\r
404 RemainingDevicePath is created by this driver.\r
405 If the first Device Path Node of RemainingDevicePath is\r
406 the End of Device Path Node, no child handle is created by this\r
407 driver.\r
408\r
409 @retval EFI_SUCCESS The device was started.\r
410 @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.\r
411 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
412 @retval Others The driver failded to start the device.\r
413\r
414**/\r
415EFI_STATUS\r
416EFIAPI\r
417NvmExpressDriverBindingStart (\r
418 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
419 IN EFI_HANDLE Controller,\r
420 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
421 );\r
422\r
423/**\r
424 Stops a device controller or a bus controller.\r
425\r
426 The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
427 As a result, much of the error checking on the parameters to Stop() has been moved\r
428 into this common boot service. It is legal to call Stop() from other locations,\r
429 but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
430 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
431 same driver's Start() function.\r
432 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
433 EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
434 Start() function, and the Start() function must have called OpenProtocol() on\r
435 ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
436\r
437 @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
438 @param[in] ControllerHandle A handle to the device being stopped. The handle must\r
439 support a bus specific I/O protocol for the driver\r
440 to use to stop the device.\r
441 @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
442 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
443 if NumberOfChildren is 0.\r
444\r
445 @retval EFI_SUCCESS The device was stopped.\r
446 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r
447\r
448**/\r
449EFI_STATUS\r
450EFIAPI\r
451NvmExpressDriverBindingStop (\r
452 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
453 IN EFI_HANDLE Controller,\r
454 IN UINTN NumberOfChildren,\r
455 IN EFI_HANDLE *ChildHandleBuffer\r
456 );\r
457\r
458/**\r
459 Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function supports\r
460 both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the nonblocking\r
461 I/O functionality is optional.\r
462\r
d6c55989 463 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.\r
eb290d02
FT		 464 @param[in] NamespaceId Is a 32 bit Namespace ID to which the Express HCI command packet will be sent.\r
465 A value of 0 denotes the NVM Express controller, a value of all 0FFh in the namespace\r
466 ID specifies that the command packet should be sent to all valid namespaces.\r
eb290d02
FT		 467 @param[in,out] Packet A pointer to the NVM Express HCI Command Packet to send to the NVMe namespace specified\r
468 by NamespaceId.\r
469 @param[in] Event If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed.\r
470 If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O\r
471 is supported, then nonblocking I/O is performed, and Event will be signaled when the NVM\r
472 Express Command Packet completes.\r
473\r
474 @retval EFI_SUCCESS The NVM Express Command Packet was sent by the host. TransferLength bytes were transferred\r
475 to, or from DataBuffer.\r
476 @retval EFI_BAD_BUFFER_SIZE The NVM Express Command Packet was not executed. The number of bytes that could be transferred\r
477 is returned in TransferLength.\r
478 @retval EFI_NOT_READY The NVM Express Command Packet could not be sent because the controller is not ready. The caller\r
479 may retry again later.\r
480 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the NVM Express Command Packet.\r
d6c55989 481 @retval EFI_INVALID_PARAMETER Namespace, or the contents of EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET are invalid. The NVM\r
eb290d02
FT		 482 Express Command Packet was not sent, so no additional status information is available.\r
483 @retval EFI_UNSUPPORTED The command described by the NVM Express Command Packet is not supported by the host adapter.\r
484 The NVM Express Command Packet was not sent, so no additional status information is available.\r
485 @retval EFI_TIMEOUT A timeout occurred while waiting for the NVM Express Command Packet to execute.\r
486\r
487**/\r
488EFI_STATUS\r
489EFIAPI\r
490NvmExpressPassThru (\r
d6c55989 491 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This,\r
eb290d02 492 IN UINT32 NamespaceId,\r
d6c55989 493 IN OUT EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET *Packet,\r
eb290d02
FT		 494 IN EFI_EVENT Event OPTIONAL\r
495 );\r
496\r
497/**\r
d6c55989
FT		 498 Used to retrieve the next namespace ID for this NVM Express controller.\r
499\r
500 The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNextNamespace() function retrieves the next valid\r
501 namespace ID on this NVM Express controller.\r
eb290d02 502\r
d6c55989
FT		 503 If on input the value pointed to by NamespaceId is 0xFFFFFFFF, then the first valid namespace\r
504 ID defined on the NVM Express controller is returned in the location pointed to by NamespaceId\r
505 and a status of EFI_SUCCESS is returned.\r
eb290d02 506\r
d6c55989
FT		 507 If on input the value pointed to by NamespaceId is an invalid namespace ID other than 0xFFFFFFFF,\r
508 then EFI_INVALID_PARAMETER is returned.\r
eb290d02 509\r
d6c55989
FT		 510 If on input the value pointed to by NamespaceId is a valid namespace ID, then the next valid\r
511 namespace ID on the NVM Express controller is returned in the location pointed to by NamespaceId,\r
512 and EFI_SUCCESS is returned.\r
eb290d02 513\r
d6c55989
FT		 514 If the value pointed to by NamespaceId is the namespace ID of the last namespace on the NVM\r
515 Express controller, then EFI_NOT_FOUND is returned.\r
eb290d02 516\r
d6c55989 517 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.\r
eb290d02
FT		 518 @param[in,out] NamespaceId On input, a pointer to a legal NamespaceId for an NVM Express\r
519 namespace present on the NVM Express controller. On output, a\r
520 pointer to the next NamespaceId of an NVM Express namespace on\r
521 an NVM Express controller. An input value of 0xFFFFFFFF retrieves\r
522 the first NamespaceId for an NVM Express namespace present on an\r
523 NVM Express controller.\r
eb290d02 524\r
d6c55989 525 @retval EFI_SUCCESS The Namespace ID of the next Namespace was returned.\r
eb290d02 526 @retval EFI_NOT_FOUND There are no more namespaces defined on this controller.\r
d6c55989 527 @retval EFI_INVALID_PARAMETER NamespaceId is an invalid value other than 0xFFFFFFFF.\r
eb290d02
FT		 528\r
529**/\r
530EFI_STATUS\r
531EFIAPI\r
532NvmExpressGetNextNamespace (\r
d6c55989
FT		 533 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This,\r
534 IN OUT UINT32 *NamespaceId\r
eb290d02
FT		 535 );\r
536\r
537/**\r
d6c55989
FT		 538 Used to translate a device path node to a namespace ID.\r
539\r
540 The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNamespace() function determines the namespace ID associated with the\r
541 namespace described by DevicePath.\r
542\r
543 If DevicePath is a device path node type that the NVM Express Pass Thru driver supports, then the NVM Express\r
544 Pass Thru driver will attempt to translate the contents DevicePath into a namespace ID.\r
eb290d02 545\r
d6c55989 546 If this translation is successful, then that namespace ID is returned in NamespaceId, and EFI_SUCCESS is returned\r
eb290d02 547\r
d6c55989 548 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.\r
eb290d02
FT		 549 @param[in] DevicePath A pointer to the device path node that describes an NVM Express namespace on\r
550 the NVM Express controller.\r
551 @param[out] NamespaceId The NVM Express namespace ID contained in the device path node.\r
eb290d02 552\r
d6c55989
FT		 553 @retval EFI_SUCCESS DevicePath was successfully translated to NamespaceId.\r
554 @retval EFI_INVALID_PARAMETER If DevicePath or NamespaceId are NULL, then EFI_INVALID_PARAMETER is returned.\r
eb290d02
FT		 555 @retval EFI_UNSUPPORTED If DevicePath is not a device path node type that the NVM Express Pass Thru driver\r
556 supports, then EFI_UNSUPPORTED is returned.\r
d6c55989
FT		 557 @retval EFI_NOT_FOUND If DevicePath is a device path node type that the NVM Express Pass Thru driver\r
558 supports, but there is not a valid translation from DevicePath to a namespace ID,\r
559 then EFI_NOT_FOUND is returned.\r
eb290d02
FT		 560**/\r
561EFI_STATUS\r
562EFIAPI\r
563NvmExpressGetNamespace (\r
d6c55989 564 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This,\r
eb290d02 565 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
d6c55989 566 OUT UINT32 *NamespaceId\r
eb290d02
FT		 567 );\r
568\r
569/**\r
570 Used to allocate and build a device path node for an NVM Express namespace on an NVM Express controller.\r
571\r
d6c55989 572 The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.BuildDevicePath() function allocates and builds a single device\r
eb290d02
FT		 573 path node for the NVM Express namespace specified by NamespaceId.\r
574\r
d6c55989 575 If the NamespaceId is not valid, then EFI_NOT_FOUND is returned.\r
eb290d02
FT		 576\r
577 If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned.\r
578\r
579 If there are not enough resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.\r
580\r
581 Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of DevicePath are\r
582 initialized to describe the NVM Express namespace specified by NamespaceId, and EFI_SUCCESS is returned.\r
583\r
d6c55989 584 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.\r
eb290d02
FT		 585 @param[in] NamespaceId The NVM Express namespace ID for which a device path node is to be\r
586 allocated and built. Caller must set the NamespaceId to zero if the\r
587 device path node will contain a valid UUID.\r
eb290d02
FT		 588 @param[in,out] DevicePath A pointer to a single device path node that describes the NVM Express\r
589 namespace specified by NamespaceId. This function is responsible for\r
590 allocating the buffer DevicePath with the boot service AllocatePool().\r
591 It is the caller's responsibility to free DevicePath when the caller\r
592 is finished with DevicePath.\r
593 @retval EFI_SUCCESS The device path node that describes the NVM Express namespace specified\r
594 by NamespaceId was allocated and returned in DevicePath.\r
d6c55989 595 @retval EFI_NOT_FOUND The NamespaceId is not valid.\r
eb290d02
FT		 596 @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r
597 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the DevicePath node.\r
598\r
599**/\r
600EFI_STATUS\r
601EFIAPI\r
602NvmExpressBuildDevicePath (\r
d6c55989 603 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This,\r
eb290d02 604 IN UINT32 NamespaceId,\r
eb290d02
FT		 605 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r
606 );\r
607\r
608#endif\r
EFI Development Kit II mirror for PVE