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