2 NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows
3 NVM Express specification.
5 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
6 Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "NvmExpress.h"
20 Dump the execution status from a given completion queue entry.
22 @param[in] Cq A pointer to the NVME_CQ item.
30 DEBUG ((EFI_D_VERBOSE
, "Dump NVMe Completion Entry Status from [0x%x]:\n", Cq
));
32 DEBUG ((EFI_D_VERBOSE
, " SQ Identifier : [0x%x], Phase Tag : [%d], Cmd Identifier : [0x%x]\n", Cq
->Sqid
, Cq
->Pt
, Cq
->Cid
));
34 DEBUG ((EFI_D_VERBOSE
, " NVMe Cmd Execution Result - "));
40 DEBUG ((EFI_D_VERBOSE
, "Successful Completion\n"));
43 DEBUG ((EFI_D_VERBOSE
, "Invalid Command Opcode\n"));
46 DEBUG ((EFI_D_VERBOSE
, "Invalid Field in Command\n"));
49 DEBUG ((EFI_D_VERBOSE
, "Command ID Conflict\n"));
52 DEBUG ((EFI_D_VERBOSE
, "Data Transfer Error\n"));
55 DEBUG ((EFI_D_VERBOSE
, "Commands Aborted due to Power Loss Notification\n"));
58 DEBUG ((EFI_D_VERBOSE
, "Internal Device Error\n"));
61 DEBUG ((EFI_D_VERBOSE
, "Command Abort Requested\n"));
64 DEBUG ((EFI_D_VERBOSE
, "Command Aborted due to SQ Deletion\n"));
67 DEBUG ((EFI_D_VERBOSE
, "Command Aborted due to Failed Fused Command\n"));
70 DEBUG ((EFI_D_VERBOSE
, "Command Aborted due to Missing Fused Command\n"));
73 DEBUG ((EFI_D_VERBOSE
, "Invalid Namespace or Format\n"));
76 DEBUG ((EFI_D_VERBOSE
, "Command Sequence Error\n"));
79 DEBUG ((EFI_D_VERBOSE
, "Invalid SGL Last Segment Descriptor\n"));
82 DEBUG ((EFI_D_VERBOSE
, "Invalid Number of SGL Descriptors\n"));
85 DEBUG ((EFI_D_VERBOSE
, "Data SGL Length Invalid\n"));
88 DEBUG ((EFI_D_VERBOSE
, "Metadata SGL Length Invalid\n"));
91 DEBUG ((EFI_D_VERBOSE
, "SGL Descriptor Type Invalid\n"));
94 DEBUG ((EFI_D_VERBOSE
, "LBA Out of Range\n"));
97 DEBUG ((EFI_D_VERBOSE
, "Capacity Exceeded\n"));
100 DEBUG ((EFI_D_VERBOSE
, "Namespace Not Ready\n"));
103 DEBUG ((EFI_D_VERBOSE
, "Reservation Conflict\n"));
111 DEBUG ((EFI_D_VERBOSE
, "Completion Queue Invalid\n"));
114 DEBUG ((EFI_D_VERBOSE
, "Invalid Queue Identifier\n"));
117 DEBUG ((EFI_D_VERBOSE
, "Maximum Queue Size Exceeded\n"));
120 DEBUG ((EFI_D_VERBOSE
, "Abort Command Limit Exceeded\n"));
123 DEBUG ((EFI_D_VERBOSE
, "Asynchronous Event Request Limit Exceeded\n"));
126 DEBUG ((EFI_D_VERBOSE
, "Invalid Firmware Slot\n"));
129 DEBUG ((EFI_D_VERBOSE
, "Invalid Firmware Image\n"));
132 DEBUG ((EFI_D_VERBOSE
, "Invalid Interrupt Vector\n"));
135 DEBUG ((EFI_D_VERBOSE
, "Invalid Log Page\n"));
138 DEBUG ((EFI_D_VERBOSE
, "Invalid Format\n"));
141 DEBUG ((EFI_D_VERBOSE
, "Firmware Application Requires Conventional Reset\n"));
144 DEBUG ((EFI_D_VERBOSE
, "Invalid Queue Deletion\n"));
147 DEBUG ((EFI_D_VERBOSE
, "Feature Identifier Not Saveable\n"));
150 DEBUG ((EFI_D_VERBOSE
, "Feature Not Changeable\n"));
153 DEBUG ((EFI_D_VERBOSE
, "Feature Not Namespace Specific\n"));
156 DEBUG ((EFI_D_VERBOSE
, "Firmware Application Requires NVM Subsystem Reset\n"));
159 DEBUG ((EFI_D_VERBOSE
, "Conflicting Attributes\n"));
162 DEBUG ((EFI_D_VERBOSE
, "Invalid Protection Information\n"));
165 DEBUG ((EFI_D_VERBOSE
, "Attempted Write to Read Only Range\n"));
173 DEBUG ((EFI_D_VERBOSE
, "Write Fault\n"));
176 DEBUG ((EFI_D_VERBOSE
, "Unrecovered Read Error\n"));
179 DEBUG ((EFI_D_VERBOSE
, "End-to-end Guard Check Error\n"));
182 DEBUG ((EFI_D_VERBOSE
, "End-to-end Application Tag Check Error\n"));
185 DEBUG ((EFI_D_VERBOSE
, "End-to-end Reference Tag Check Error\n"));
188 DEBUG ((EFI_D_VERBOSE
, "Compare Failure\n"));
191 DEBUG ((EFI_D_VERBOSE
, "Access Denied\n"));
202 Create PRP lists for data transfer which is larger than 2 memory pages.
203 Note here we calcuate the number of required PRP lists and allocate them at one time.
205 @param[in] PciIo A pointer to the EFI_PCI_IO_PROTOCOL instance.
206 @param[in] PhysicalAddr The physical base address of data buffer.
207 @param[in] Pages The number of pages to be transfered.
208 @param[out] PrpListHost The host base address of PRP lists.
209 @param[in,out] PrpListNo The number of PRP List.
210 @param[out] Mapping The mapping value returned from PciIo.Map().
212 @retval The pointer to the first PRP List of the PRP lists.
217 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
218 IN EFI_PHYSICAL_ADDRESS PhysicalAddr
,
220 OUT VOID
**PrpListHost
,
221 IN OUT UINTN
*PrpListNo
,
230 EFI_PHYSICAL_ADDRESS PrpListPhyAddr
;
235 // The number of Prp Entry in a memory page.
237 PrpEntryNo
= EFI_PAGE_SIZE
/ sizeof (UINT64
);
240 // Calculate total PrpList number.
242 *PrpListNo
= (UINTN
)DivU64x64Remainder ((UINT64
)Pages
, (UINT64
)PrpEntryNo
- 1, &Remainder
);
243 if (*PrpListNo
== 0) {
245 } else if ((Remainder
!= 0) && (Remainder
!= 1)) {
247 } else if (Remainder
== 1) {
248 Remainder
= PrpEntryNo
;
249 } else if (Remainder
== 0) {
250 Remainder
= PrpEntryNo
- 1;
253 Status
= PciIo
->AllocateBuffer (
262 if (EFI_ERROR (Status
)) {
266 Bytes
= EFI_PAGES_TO_SIZE (*PrpListNo
);
267 Status
= PciIo
->Map (
269 EfiPciIoOperationBusMasterCommonBuffer
,
276 if (EFI_ERROR (Status
) || (Bytes
!= EFI_PAGES_TO_SIZE (*PrpListNo
))) {
277 DEBUG ((EFI_D_ERROR
, "NvmeCreatePrpList: create PrpList failure!\n"));
281 // Fill all PRP lists except of last one.
283 ZeroMem (*PrpListHost
, Bytes
);
284 for (PrpListIndex
= 0; PrpListIndex
< *PrpListNo
- 1; ++PrpListIndex
) {
285 PrpListBase
= *(UINT64
*)PrpListHost
+ PrpListIndex
* EFI_PAGE_SIZE
;
287 for (PrpEntryIndex
= 0; PrpEntryIndex
< PrpEntryNo
; ++PrpEntryIndex
) {
288 if (PrpEntryIndex
!= PrpEntryNo
- 1) {
290 // Fill all PRP entries except of last one.
292 *((UINT64
*)(UINTN
)PrpListBase
+ PrpEntryIndex
) = PhysicalAddr
;
293 PhysicalAddr
+= EFI_PAGE_SIZE
;
296 // Fill last PRP entries with next PRP List pointer.
298 *((UINT64
*)(UINTN
)PrpListBase
+ PrpEntryIndex
) = PrpListPhyAddr
+ (PrpListIndex
+ 1) * EFI_PAGE_SIZE
;
303 // Fill last PRP list.
305 PrpListBase
= *(UINT64
*)PrpListHost
+ PrpListIndex
* EFI_PAGE_SIZE
;
306 for (PrpEntryIndex
= 0; PrpEntryIndex
< Remainder
; ++PrpEntryIndex
) {
307 *((UINT64
*)(UINTN
)PrpListBase
+ PrpEntryIndex
) = PhysicalAddr
;
308 PhysicalAddr
+= EFI_PAGE_SIZE
;
311 return (VOID
*)(UINTN
)PrpListPhyAddr
;
314 PciIo
->FreeBuffer (PciIo
, *PrpListNo
, *PrpListHost
);
320 Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function supports
321 both blocking I/O and non-blocking I/O. The blocking I/O functionality is required, and the non-blocking
322 I/O functionality is optional.
325 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
326 @param[in] NamespaceId A 32 bit namespace ID as defined in the NVMe specification to which the NVM Express Command
327 Packet will be sent. A value of 0 denotes the NVM Express controller, a value of all 0xFF's
328 (all bytes are 0xFF) in the namespace ID specifies that the command packet should be sent to
329 all valid namespaces.
330 @param[in,out] Packet A pointer to the NVM Express Command Packet.
331 @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking I/O is performed.
332 If Event is NULL, then blocking I/O is performed. If Event is not NULL and non-blocking I/O
333 is supported, then non-blocking I/O is performed, and Event will be signaled when the NVM
334 Express Command Packet completes.
336 @retval EFI_SUCCESS The NVM Express Command Packet was sent by the host. TransferLength bytes were transferred
337 to, or from DataBuffer.
338 @retval EFI_BAD_BUFFER_SIZE The NVM Express Command Packet was not executed. The number of bytes that could be transferred
339 is returned in TransferLength.
340 @retval EFI_NOT_READY The NVM Express Command Packet could not be sent because the controller is not ready. The caller
341 may retry again later.
342 @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the NVM Express Command Packet.
343 @retval EFI_INVALID_PARAMETER NamespaceId or the contents of EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET are invalid. The NVM
344 Express Command Packet was not sent, so no additional status information is available.
345 @retval EFI_UNSUPPORTED The command described by the NVM Express Command Packet is not supported by the NVM Express
346 controller. The NVM Express Command Packet was not sent so no additional status information
348 @retval EFI_TIMEOUT A timeout occurred while waiting for the NVM Express Command Packet to execute.
354 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL
*This
,
355 IN UINT32 NamespaceId
,
356 IN OUT EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET
*Packet
,
357 IN EFI_EVENT Event OPTIONAL
360 NVME_CONTROLLER_PRIVATE_DATA
*Private
;
362 EFI_PCI_IO_PROTOCOL
*PciIo
;
368 EFI_EVENT TimerEvent
;
369 EFI_PCI_IO_PROTOCOL_OPERATION Flag
;
370 EFI_PHYSICAL_ADDRESS PhyAddr
;
379 NVME_PASS_THRU_ASYNC_REQ
*AsyncRequest
;
383 // check the data fields in Packet parameter.
385 if ((This
== NULL
) || (Packet
== NULL
)) {
386 return EFI_INVALID_PARAMETER
;
389 if ((Packet
->NvmeCmd
== NULL
) || (Packet
->NvmeCompletion
== NULL
)) {
390 return EFI_INVALID_PARAMETER
;
393 if (Packet
->QueueType
!= NVME_ADMIN_QUEUE
&& Packet
->QueueType
!= NVME_IO_QUEUE
) {
394 return EFI_INVALID_PARAMETER
;
397 Private
= NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU (This
);
398 PciIo
= Private
->PciIo
;
406 Status
= EFI_SUCCESS
;
408 if (Packet
->QueueType
== NVME_ADMIN_QUEUE
) {
417 // Submission queue full check.
419 if ((Private
->SqTdbl
[QueueId
].Sqt
+ 1) % (NVME_ASYNC_CSQ_SIZE
+ 1) ==
420 Private
->AsyncSqHead
) {
421 return EFI_NOT_READY
;
425 Sq
= Private
->SqBuffer
[QueueId
] + Private
->SqTdbl
[QueueId
].Sqt
;
426 Cq
= Private
->CqBuffer
[QueueId
] + Private
->CqHdbl
[QueueId
].Cqh
;
428 if (Packet
->NvmeCmd
->Nsid
!= NamespaceId
) {
429 return EFI_INVALID_PARAMETER
;
432 ZeroMem (Sq
, sizeof (NVME_SQ
));
433 Sq
->Opc
= (UINT8
)Packet
->NvmeCmd
->Cdw0
.Opcode
;
434 Sq
->Fuse
= (UINT8
)Packet
->NvmeCmd
->Cdw0
.FusedOperation
;
435 Sq
->Cid
= Private
->Cid
[QueueId
]++;
436 Sq
->Nsid
= Packet
->NvmeCmd
->Nsid
;
439 // Currently we only support PRP for data transfer, SGL is NOT supported.
441 ASSERT (Sq
->Psdt
== 0);
443 DEBUG ((EFI_D_ERROR
, "NvmExpressPassThru: doesn't support SGL mechanism\n"));
444 return EFI_UNSUPPORTED
;
447 Sq
->Prp
[0] = (UINT64
)(UINTN
)Packet
->TransferBuffer
;
449 // If the NVMe cmd has data in or out, then mapping the user buffer to the PCI controller specific addresses.
450 // Note here we don't handle data buffer for CreateIOSubmitionQueue and CreateIOCompletionQueue cmds because
451 // these two cmds are special which requires their data buffer must support simultaneous access by both the
452 // processor and a PCI Bus Master. It's caller's responsbility to ensure this.
454 if (((Sq
->Opc
& (BIT0
| BIT1
)) != 0) && (Sq
->Opc
!= NVME_ADMIN_CRIOCQ_CMD
) && (Sq
->Opc
!= NVME_ADMIN_CRIOSQ_CMD
)) {
455 if ((Sq
->Opc
& BIT0
) != 0) {
456 Flag
= EfiPciIoOperationBusMasterRead
;
458 Flag
= EfiPciIoOperationBusMasterWrite
;
461 MapLength
= Packet
->TransferLength
;
462 Status
= PciIo
->Map (
465 Packet
->TransferBuffer
,
470 if (EFI_ERROR (Status
) || (Packet
->TransferLength
!= MapLength
)) {
471 return EFI_OUT_OF_RESOURCES
;
474 Sq
->Prp
[0] = PhyAddr
;
477 MapLength
= Packet
->MetadataLength
;
478 if(Packet
->MetadataBuffer
!= NULL
) {
479 MapLength
= Packet
->MetadataLength
;
480 Status
= PciIo
->Map (
483 Packet
->MetadataBuffer
,
488 if (EFI_ERROR (Status
) || (Packet
->MetadataLength
!= MapLength
)) {
494 return EFI_OUT_OF_RESOURCES
;
500 // If the buffer size spans more than two memory pages (page size as defined in CC.Mps),
501 // then build a PRP list in the second PRP submission queue entry.
503 Offset
= ((UINT16
)Sq
->Prp
[0]) & (EFI_PAGE_SIZE
- 1);
504 Bytes
= Packet
->TransferLength
;
506 if ((Offset
+ Bytes
) > (EFI_PAGE_SIZE
* 2)) {
508 // Create PrpList for remaining data buffer.
510 PhyAddr
= (Sq
->Prp
[0] + EFI_PAGE_SIZE
) & ~(EFI_PAGE_SIZE
- 1);
511 Prp
= NvmeCreatePrpList (PciIo
, PhyAddr
, EFI_SIZE_TO_PAGES(Offset
+ Bytes
) - 1, &PrpListHost
, &PrpListNo
, &MapPrpList
);
516 Sq
->Prp
[1] = (UINT64
)(UINTN
)Prp
;
517 } else if ((Offset
+ Bytes
) > EFI_PAGE_SIZE
) {
518 Sq
->Prp
[1] = (Sq
->Prp
[0] + EFI_PAGE_SIZE
) & ~(EFI_PAGE_SIZE
- 1);
521 if(Packet
->NvmeCmd
->Flags
& CDW2_VALID
) {
522 Sq
->Rsvd2
= (UINT64
)Packet
->NvmeCmd
->Cdw2
;
524 if(Packet
->NvmeCmd
->Flags
& CDW3_VALID
) {
525 Sq
->Rsvd2
|= LShiftU64 ((UINT64
)Packet
->NvmeCmd
->Cdw3
, 32);
527 if(Packet
->NvmeCmd
->Flags
& CDW10_VALID
) {
528 Sq
->Payload
.Raw
.Cdw10
= Packet
->NvmeCmd
->Cdw10
;
530 if(Packet
->NvmeCmd
->Flags
& CDW11_VALID
) {
531 Sq
->Payload
.Raw
.Cdw11
= Packet
->NvmeCmd
->Cdw11
;
533 if(Packet
->NvmeCmd
->Flags
& CDW12_VALID
) {
534 Sq
->Payload
.Raw
.Cdw12
= Packet
->NvmeCmd
->Cdw12
;
536 if(Packet
->NvmeCmd
->Flags
& CDW13_VALID
) {
537 Sq
->Payload
.Raw
.Cdw13
= Packet
->NvmeCmd
->Cdw13
;
539 if(Packet
->NvmeCmd
->Flags
& CDW14_VALID
) {
540 Sq
->Payload
.Raw
.Cdw14
= Packet
->NvmeCmd
->Cdw14
;
542 if(Packet
->NvmeCmd
->Flags
& CDW15_VALID
) {
543 Sq
->Payload
.Raw
.Cdw15
= Packet
->NvmeCmd
->Cdw15
;
547 // Ring the submission queue doorbell.
550 Private
->SqTdbl
[QueueId
].Sqt
=
551 (Private
->SqTdbl
[QueueId
].Sqt
+ 1) % (NVME_ASYNC_CSQ_SIZE
+ 1);
553 Private
->SqTdbl
[QueueId
].Sqt
^= 1;
555 Data
= ReadUnaligned32 ((UINT32
*)&Private
->SqTdbl
[QueueId
]);
560 NVME_SQTDBL_OFFSET(QueueId
, Private
->Cap
.Dstrd
),
566 // For non-blocking requests, return directly if the command is placed
567 // in the submission queue.
570 AsyncRequest
= AllocateZeroPool (sizeof (NVME_PASS_THRU_ASYNC_REQ
));
571 if (AsyncRequest
== NULL
) {
572 Status
= EFI_DEVICE_ERROR
;
576 AsyncRequest
->Signature
= NVME_PASS_THRU_ASYNC_REQ_SIG
;
577 AsyncRequest
->Packet
= Packet
;
578 AsyncRequest
->CommandId
= Sq
->Cid
;
579 AsyncRequest
->CallerEvent
= Event
;
581 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
582 InsertTailList (&Private
->AsyncPassThruQueue
, &AsyncRequest
->Link
);
583 gBS
->RestoreTPL (OldTpl
);
588 Status
= gBS
->CreateEvent (
595 if (EFI_ERROR (Status
)) {
599 Status
= gBS
->SetTimer(TimerEvent
, TimerRelative
, Packet
->CommandTimeout
);
601 if (EFI_ERROR(Status
)) {
606 // Wait for completion queue to get filled in.
608 Status
= EFI_TIMEOUT
;
609 while (EFI_ERROR (gBS
->CheckEvent (TimerEvent
))) {
610 if (Cq
->Pt
!= Private
->Pt
[QueueId
]) {
611 Status
= EFI_SUCCESS
;
617 // Check the NVMe cmd execution result
619 if (Status
!= EFI_TIMEOUT
) {
620 if ((Cq
->Sct
== 0) && (Cq
->Sc
== 0)) {
621 Status
= EFI_SUCCESS
;
623 Status
= EFI_DEVICE_ERROR
;
625 // Copy the Respose Queue entry for this command to the callers response buffer
627 CopyMem(Packet
->NvmeCompletion
, Cq
, sizeof(EFI_NVM_EXPRESS_COMPLETION
));
630 // Dump every completion entry status for debugging.
638 if ((Private
->CqHdbl
[QueueId
].Cqh
^= 1) == 0) {
639 Private
->Pt
[QueueId
] ^= 1;
642 Data
= ReadUnaligned32 ((UINT32
*)&Private
->CqHdbl
[QueueId
]);
647 NVME_CQHDBL_OFFSET(QueueId
, Private
->Cap
.Dstrd
),
653 if (MapData
!= NULL
) {
660 if (MapMeta
!= NULL
) {
667 if (MapPrpList
!= NULL
) {
675 PciIo
->FreeBuffer (PciIo
, PrpListNo
, PrpListHost
);
678 if (TimerEvent
!= NULL
) {
679 gBS
->CloseEvent (TimerEvent
);
685 Used to retrieve the next namespace ID for this NVM Express controller.
687 The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNextNamespace() function retrieves the next valid
688 namespace ID on this NVM Express controller.
690 If on input the value pointed to by NamespaceId is 0xFFFFFFFF, then the first valid namespace
691 ID defined on the NVM Express controller is returned in the location pointed to by NamespaceId
692 and a status of EFI_SUCCESS is returned.
694 If on input the value pointed to by NamespaceId is an invalid namespace ID other than 0xFFFFFFFF,
695 then EFI_INVALID_PARAMETER is returned.
697 If on input the value pointed to by NamespaceId is a valid namespace ID, then the next valid
698 namespace ID on the NVM Express controller is returned in the location pointed to by NamespaceId,
699 and EFI_SUCCESS is returned.
701 If the value pointed to by NamespaceId is the namespace ID of the last namespace on the NVM
702 Express controller, then EFI_NOT_FOUND is returned.
704 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
705 @param[in,out] NamespaceId On input, a pointer to a legal NamespaceId for an NVM Express
706 namespace present on the NVM Express controller. On output, a
707 pointer to the next NamespaceId of an NVM Express namespace on
708 an NVM Express controller. An input value of 0xFFFFFFFF retrieves
709 the first NamespaceId for an NVM Express namespace present on an
710 NVM Express controller.
712 @retval EFI_SUCCESS The Namespace ID of the next Namespace was returned.
713 @retval EFI_NOT_FOUND There are no more namespaces defined on this controller.
714 @retval EFI_INVALID_PARAMETER NamespaceId is an invalid value other than 0xFFFFFFFF.
719 NvmExpressGetNextNamespace (
720 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL
*This
,
721 IN OUT UINT32
*NamespaceId
724 NVME_CONTROLLER_PRIVATE_DATA
*Private
;
725 NVME_ADMIN_NAMESPACE_DATA
*NamespaceData
;
726 UINT32 NextNamespaceId
;
729 if ((This
== NULL
) || (NamespaceId
== NULL
)) {
730 return EFI_INVALID_PARAMETER
;
733 NamespaceData
= NULL
;
734 Status
= EFI_NOT_FOUND
;
736 Private
= NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU (This
);
738 // If the NamespaceId input value is 0xFFFFFFFF, then get the first valid namespace ID
740 if (*NamespaceId
== 0xFFFFFFFF) {
742 // Start with the first namespace ID
746 // Allocate buffer for Identify Namespace data.
748 NamespaceData
= (NVME_ADMIN_NAMESPACE_DATA
*)AllocateZeroPool (sizeof (NVME_ADMIN_NAMESPACE_DATA
));
750 if (NamespaceData
== NULL
) {
751 return EFI_NOT_FOUND
;
754 Status
= NvmeIdentifyNamespace (Private
, NextNamespaceId
, NamespaceData
);
755 if (EFI_ERROR(Status
)) {
759 *NamespaceId
= NextNamespaceId
;
761 if (*NamespaceId
>= Private
->ControllerData
->Nn
) {
762 return EFI_INVALID_PARAMETER
;
765 NextNamespaceId
= *NamespaceId
+ 1;
767 // Allocate buffer for Identify Namespace data.
769 NamespaceData
= (NVME_ADMIN_NAMESPACE_DATA
*)AllocateZeroPool (sizeof (NVME_ADMIN_NAMESPACE_DATA
));
770 if (NamespaceData
== NULL
) {
771 return EFI_NOT_FOUND
;
774 Status
= NvmeIdentifyNamespace (Private
, NextNamespaceId
, NamespaceData
);
775 if (EFI_ERROR(Status
)) {
779 *NamespaceId
= NextNamespaceId
;
783 if (NamespaceData
!= NULL
) {
784 FreePool(NamespaceData
);
791 Used to translate a device path node to a namespace ID.
793 The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNamespace() function determines the namespace ID associated with the
794 namespace described by DevicePath.
796 If DevicePath is a device path node type that the NVM Express Pass Thru driver supports, then the NVM Express
797 Pass Thru driver will attempt to translate the contents DevicePath into a namespace ID.
799 If this translation is successful, then that namespace ID is returned in NamespaceId, and EFI_SUCCESS is returned
801 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
802 @param[in] DevicePath A pointer to the device path node that describes an NVM Express namespace on
803 the NVM Express controller.
804 @param[out] NamespaceId The NVM Express namespace ID contained in the device path node.
806 @retval EFI_SUCCESS DevicePath was successfully translated to NamespaceId.
807 @retval EFI_INVALID_PARAMETER If DevicePath or NamespaceId are NULL, then EFI_INVALID_PARAMETER is returned.
808 @retval EFI_UNSUPPORTED If DevicePath is not a device path node type that the NVM Express Pass Thru driver
809 supports, then EFI_UNSUPPORTED is returned.
810 @retval EFI_NOT_FOUND If DevicePath is a device path node type that the NVM Express Pass Thru driver
811 supports, but there is not a valid translation from DevicePath to a namespace ID,
812 then EFI_NOT_FOUND is returned.
816 NvmExpressGetNamespace (
817 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL
*This
,
818 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
819 OUT UINT32
*NamespaceId
822 NVME_NAMESPACE_DEVICE_PATH
*Node
;
823 NVME_CONTROLLER_PRIVATE_DATA
*Private
;
825 if ((This
== NULL
) || (DevicePath
== NULL
) || (NamespaceId
== NULL
)) {
826 return EFI_INVALID_PARAMETER
;
829 if (DevicePath
->Type
!= MESSAGING_DEVICE_PATH
) {
830 return EFI_UNSUPPORTED
;
833 Node
= (NVME_NAMESPACE_DEVICE_PATH
*)DevicePath
;
834 Private
= NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU (This
);
836 if (DevicePath
->SubType
== MSG_NVME_NAMESPACE_DP
) {
837 if (DevicePathNodeLength(DevicePath
) != sizeof(NVME_NAMESPACE_DEVICE_PATH
)) {
838 return EFI_NOT_FOUND
;
842 // Check NamespaceId in the device path node is valid or not.
844 if ((Node
->NamespaceId
== 0) ||
845 (Node
->NamespaceId
> Private
->ControllerData
->Nn
)) {
846 return EFI_NOT_FOUND
;
849 *NamespaceId
= Node
->NamespaceId
;
853 return EFI_UNSUPPORTED
;
858 Used to allocate and build a device path node for an NVM Express namespace on an NVM Express controller.
860 The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.BuildDevicePath() function allocates and builds a single device
861 path node for the NVM Express namespace specified by NamespaceId.
863 If the NamespaceId is not valid, then EFI_NOT_FOUND is returned.
865 If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned.
867 If there are not enough resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.
869 Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of DevicePath are
870 initialized to describe the NVM Express namespace specified by NamespaceId, and EFI_SUCCESS is returned.
872 @param[in] This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
873 @param[in] NamespaceId The NVM Express namespace ID for which a device path node is to be
874 allocated and built. Caller must set the NamespaceId to zero if the
875 device path node will contain a valid UUID.
876 @param[in,out] DevicePath A pointer to a single device path node that describes the NVM Express
877 namespace specified by NamespaceId. This function is responsible for
878 allocating the buffer DevicePath with the boot service AllocatePool().
879 It is the caller's responsibility to free DevicePath when the caller
880 is finished with DevicePath.
881 @retval EFI_SUCCESS The device path node that describes the NVM Express namespace specified
882 by NamespaceId was allocated and returned in DevicePath.
883 @retval EFI_NOT_FOUND The NamespaceId is not valid.
884 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
885 @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the DevicePath node.
890 NvmExpressBuildDevicePath (
891 IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL
*This
,
892 IN UINT32 NamespaceId
,
893 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
896 NVME_NAMESPACE_DEVICE_PATH
*Node
;
897 NVME_CONTROLLER_PRIVATE_DATA
*Private
;
899 NVME_ADMIN_NAMESPACE_DATA
*NamespaceData
;
902 // Validate parameters
904 if ((This
== NULL
) || (DevicePath
== NULL
)) {
905 return EFI_INVALID_PARAMETER
;
908 Status
= EFI_SUCCESS
;
909 Private
= NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU (This
);
912 // Check NamespaceId is valid or not.
914 if ((NamespaceId
== 0) ||
915 (NamespaceId
> Private
->ControllerData
->Nn
)) {
916 return EFI_NOT_FOUND
;
919 Node
= (NVME_NAMESPACE_DEVICE_PATH
*)AllocateZeroPool (sizeof (NVME_NAMESPACE_DEVICE_PATH
));
921 return EFI_OUT_OF_RESOURCES
;
924 Node
->Header
.Type
= MESSAGING_DEVICE_PATH
;
925 Node
->Header
.SubType
= MSG_NVME_NAMESPACE_DP
;
926 SetDevicePathNodeLength (&Node
->Header
, sizeof (NVME_NAMESPACE_DEVICE_PATH
));
927 Node
->NamespaceId
= NamespaceId
;
930 // Allocate a buffer for Identify Namespace data.
932 NamespaceData
= NULL
;
933 NamespaceData
= AllocateZeroPool(sizeof (NVME_ADMIN_NAMESPACE_DATA
));
934 if(NamespaceData
== NULL
) {
935 Status
= EFI_OUT_OF_RESOURCES
;
940 // Get UUID from specified Identify Namespace data.
942 Status
= NvmeIdentifyNamespace (
945 (VOID
*)NamespaceData
948 if (EFI_ERROR(Status
)) {
952 Node
->NamespaceUuid
= NamespaceData
->Eui64
;
954 *DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*)Node
;
957 if(NamespaceData
!= NULL
) {
958 FreePool (NamespaceData
);
961 if (EFI_ERROR (Status
)) {