No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

ES3000 V3 NVMe PCIe SSD User Guide 20

This document provides the product information about the Huawei ES3000 V3 PCIe SSD (ES3000 V3 for short) and describes how to install, configure, operate, and maintain the ES3000 V3.
Rate and give feedback :
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Query Commands

Query Commands

The commands use the PRP1, PRP2, and Dword10 to Dword13 fields.

Table A-7  PRP1

Bit

Description

63:00

PRP Entry 1 (PRP1): indicates the storage of data buffer. This buffer can be configured only in a physical discontinuity. The minimum unit is 4 KB.

Table A-8  PRP 2

Bit

Description

63:00

PRP Entry 2 (PRP2): This domain indicates the second PRP entry. If data transmission needs only one PRP entry, then reserve the field. If data transmission has two PRP entry, then this field represents the second PRP entry address.

Table A-9  Command Dword 10

Bit

Description

31:00

Data_Len: The length of data transmission is in the unit of Dword. If data transmission is not needed, then the value is 0 h.

Table A-10  Command Dword 12

Bit

Description

31:16

Sub_OpType: Subcommand Processing Type

15:00

Sub_OpCode: Subcommand Number

This command currently supports the custom Sub_Opcode as follow:

Table A-11  Sub_Opcode

Sub_OpCode

Description

01h

Obtain logs.

02h

Obtain SSD ID parameters.

03h

Obtain the function enablement status.

20h

Query the maximum available capacity of the SSD.

21h

Obtain the vendor-defined log length.

25h

Query the PCB version.

29h

Obtain the self-diagnosis result.

Obtaining the Enablement Status of User Functions

This command is used to obtain the enablement status of a customized function through the controller in PF and VF mode. Sub_OpType indicates the function type.

Table A-12  Sub_OpType

Sub_OpType

Description

0h

Reserved

1h

SRIOV enablement status.

The enablement status of each function is returned through CQ Dword0.

Table A-13  Completion Queue Entry Dword 0

Bit

Description

00

Enable Status: 1 indicates that the function is enabled. 0 indicates that the function is disabled.

31:01

Reserved

Obtaining Logs

This command is used to obtain vendor logs from the SSD. Each command sent from the host can obtain a maximum of 4KB of logs. The host obtains the total log size through the vendor log length query command (SubOpCode 0x21h) and then sends commands repeatedly to obtain all logs. Besides the total data size, the commands must also specify an offset value, where 1 indicates 4 KB.

Sub_OpType indicates the log type.

Table A-14  Sub_OpType

Sub_OpType

Description

0h

Log parsing package

1h

All logs

2h

Key logs

3h

CoreDump information

This command uses the command domains of PRP1, PRP2 and Dword10 to Dword13.

Table A-15  PRP1

Bit

Description

63:00

PRP Entry 1 (PRP1): indicates the data buffer. This buffer cannot have more than one physical discontinuity. The minimum unit is 4 KB.

Table A-16  PRP 2

Bit

Description

63:00

PRP Entry 2 (PRP2): This field indicates the second PRP entry. If PRP Entry 1 specifies enough space for the data structure, this field is reserved. If the data structure requires two PRP entries, this field represents the second PRP entry address. If data of more than two PRP entries is transferred, this field points to a PRP list.

Table A-17  Command Dword 10

Bit

Description

31:00

Data_Len: The length of data transmission is in the unit of Dword. If the length of the package is not 4-byte aligned, then round up the result. The actual returned length will be shown in the Dword0 of CQ.

Table A-18  Command Dword 13

Bit

Description

31:00

Offset: Log offset. 1 indicates 4 KB.

The valid log length and offset are returned to the host through Dword0 of the CQ.

Table A-19  Completion Queue Entry Dword 0

Bit

Description

31:16

Log_Length: Obtained log length

15:00

Offset: obtained log offset value.

NOTE:
Each command sent from the host can obtain a maximum of 4KB of logs. If the size exceeds 4KB, the firmware returns the status code "NVME_SC_INVALID_FIELD = 0x2".

Obtaining SSD ID Parameters

This command is used to obtain SSD ID parameters, including electronic label information, part number (PN), World Wide Name (WWN), Model, and serial number (SN). The parameters are returned to the host through PRP1 and PRP2.

Sub_OpType indicates the parameter type.

Table A-20  Sub_OpType

Sub_OpType

Description

00h

Electronic label information

01h

PN

02h

WWN

03h

Model

04h

SN

  • Electronic label information

The subcommand is used to set the electronic label of the SSD. The host uses PRP1 and PRP2 to send electronic label information in the format described in Table A-21.

In the following table, "Field" indicates the combination of the field name, equal sign, field value, and carriage return. For example, "VendorName=Huawei\r\n" is a string, where "VendorName" is the field name and "Huawei" is the field value.

Table A-21  Electronic label information

Area

Description

Maximum Field Length (Bytes)

Maximum Field Value Length (Bytes)

Remarks

Information format area

/$[ArchivesInfo Version]\r\n

26

N/A

If a line starts with /$, the line is not displayed only in the network management system. $ is an ASCII character with the character code 0x24. The data needs to be displayed during query on network elements. The current label version is 3.0, which indicates the number of fields. Usually content changes do not cause version changes.

/$ArchivesInfoVersion=<Version Number>\r\n

30

6

\r\n

2

N/A

Two blank lines are between the information format area and the information description area.

\r\n

2

N/A

Information description area

[Board Properties]\r\n

20

N/A

  

BoardType=<Model>\r\n

30

18

Product model number

BarCode=<SN>\r\n

30

20

SN on the paper label

Item=<BBOM Code>\r\n

30

23

PN on the paper label

Description=<English Description>\r\n

260

246

The line contains a maximum of 260 bytes.

Manufactured=<Manufacturing Date>\r\n

25

10

Format: YYYY-MM-DD.

VendorName=<Manufacturer Name>\r\n

50

37

FRUs made by Huawei or Huawei's outsourced vendors are all branded by Huawei.

IssueNumber=<Issue Number>\r\n

20

6

Item revision (FRU hardware version) on the paper label

CLEICode=<CLEI Code>\r\n

25

14

This field is used by products complying with specifications of Telcordia in North America.

BOM=<BOM Code>\r\n

50

44

Item of a finer granularity. This field is reserved for products whose Huawei item codes are insufficient for customers' asset management.

  • PN

The subcommand is used to set the SSD part number (PN). The host uses PRP1 and PRP2 to send PN information in the format described in Table A-22.

Table A-22  PN

Bytes

Description

23:00

SN

  • WWN

The subcommand is used to set the SSD WWN. The host uses PRP1 and PRP2 to send WWN information in the format described in Table A-23.

Table A-23  WWN

Bytes

Description

15:00

WWN

  • Model

The subcommand is used to set the SSD model number. The host uses PRP1 and PRP2 to send model information in the format described in Table A-24.

Table A-24  Model

Bytes

Description

15:00

Model

  • SN

The subcommand is used to set the SSD SN. The host uses PRP1 and PRP2 to send SN information in the format described in Table A-25.

Table A-25  SN

Bytes

Description

19:00

SN

Obtaining the Enablement Status of Functions.

This command is used to obtain the enablement status of a customized function through the controller. Sub_OpType indicates the function type.

Table A-26  Sub_OpType

Sub_OpType

Description

01h

Flash inspection enablement

02h

Capacitor inspection enablement

03h

DDR inspection enablement

04h

Temperature inspection enablement

05h

Endurance management enablement

06h

CE concurrency enablement

07h

Read Retry enablement

08h

Wear leveling enablement

09h

Inter-chip RAID enablement

0ah

Garbage collection (GC) enablement

0bh

Aging test enablement

The enablement status of each function is returned through CQ Dword0.

Table A-27  CQ-Dword0

Bit

Description

00

Enable Status: 1 indicates that the function is enabled. 0 indicates that the function is disabled.

31:01

Reserved

Querying the Maximum Available Capacity of the SSD

This command is used to query the maximum available capacity that can be set. The command returns the information to the host through PRP1 and PRP2. The format of the returned data is as follow:

Table A-28  Querying the maximum available capacity of the SSD

Bytes

Description

7:0

Maximum available capacity of the SSD (unit: byte)

Obtaining the Vendor Log Length

This command is used to obtain the length of vendor logs (including the log parsing package, full logs, and key logs). Sub_OpType indicates the log type.

Table A-29  Sub_OpType

Sub_OpType

Description

0h

Log parsing package

1h

Full logs

2h

Key logs

3h

CoreDump information

The obtained valid log length is returned to the host software as Dword0 in the CQ.

Table A-30  Completion Queue Entry Dword 0

Bit

Description

31:0

Valid log length (unit: byte)

Querying the PCB Version

This command is used to obtain the PCB version, which is returned to the host as Dword0 in the CQ.

Table A-31  Dword0 in the CQ

Bit

Description

31:0

PCB version

Obtaining Self-Diagnosis Result

If a bit value is 1, the corresponding item has a fault. If a bit value is 0, the corresponding item is passed.

Table A-32  CQ-Dword0

Bit

Description

0

Overall test result

1

Firmware error test (front-end error check: whether the disk is in the controller disk mode, whether the disk is in read-only mode, and whether the available space is below the threshold)

2

NAND test

3

NOR connectivity test

4

DDR uncorrectable error test

5

IBUF uncorrectable error test

6

Capacitor test

7

Blank block test: insufficient blank blocks

8

Life test

9

NOR patrol test

10

Firmware uncorrectable error test : four invalid firmware backups

11

System area test too many bad blocks in the NAND system area

12

Bad block test: too many bad blocks in the NAND data area

13

Controller test: invalid controller

14

Power down fast interrupt request (FIQ) test

15

Formatting failure test

Obtaining the DIEID of a Chip

This command is used to obtain the DIEID, which is the unique identifier of a chip and is used to track and manage information of the entire lifecycle (including chip manufacturing, chip test, board processing, server test, and live network operation).

Test results are returned to the host through the host's physical memory that PRP1 and PRP2 point to. The data structure is defined in the following table.

Table A-33  DIEID structure

Bit

Description

3:0

Whether the DIEID is obtained successfully. 0 indicates a success and the DIEID is displayed in bytes 4 to 27. Otherwise, the error code is displayed in bytes 0 to 3.

7:4

Chip ID

11:8

The DIEID is displayed in bytes 0 to 3.

……

-

27:24

The DIEID is displayed in bytes 16 to 19.

31:28

Reserved

Obtaining Virtualization Information

This command is used to obtain VF information. This command can be issued only in PF mode. The data volume is 4096 bytes. The following table describes the command syntax.

Table A-34  Command Dword10

Bit

Description

07:00

Controller or disk structure (CNS)

15:08

Reserved

31:16

Controller ID (CNTID)

The following table describes the CNS field.

Table A-35  CNS

Bit

Description

13:00

Reserved

14

This field obtains the resources assigned to the primary controller for supporting virtualization functions.

15

The field returns the command controller in the NVM subsystem, and returns the VFs whose controller ID is greater than or equal to the value of CNTID (CDW10.CNTID). A maximum of 127 VFs can be returned.

ff:16

Reserved

The command obtains the virtual resource information, and the data size is 4096 bytes. The following table describes the structure body.

Table A-36  Obtaining the virtual resource data structure

Bytes

Description

1:0

Controller Identifier (CNTLID): ID of the primary controller.

3:2

Port Identifier (PORTID): Port ID of the primary controller in the NVM subsystem. The port ID for a PCIe port is the same as the Port Number field in the link capability register in the PCIe capability structure.

31:4

Reserved

35:32

VQ Resources Flexible Total (VQFRT): flexible resources of the primary and secondary controllers.

39:36

VQ Resources Flexible Assigned (VQRFA): Number of flexible resources assigned to the primary and secondary controllers.

41:40

VQ Resources Flexible Assigned to Primary (VQRFAP): Number of flexible resources assigned to the primary controller.

43:42

VQ Resources Private Total (VQPRT): Number of private resources of the primary controller.

45:44

VQ Resources Flexible Primary Default Max (VQFRDM): Maximum number of flexible resources that the virtualization management command allocates to the primary controller.

47:46

VQ Resources Flexible Secondary Maximum (VQFRSM): Maximum number of flexible resources that can be assigned to the secondary controller.

49:48

VQ Flexible Resource Set Size (VQFRSS): Minimum unit that the I/O queue can allocate.

63:44

Reserved

67:64

VI Resources Flexible Total (VIFRT): 0.

71:68

VI Resources Flexible Assigned (VIRFA): 0.

73:72

VI Resources Flexible Assigned to Primary (VIRFAP): 0.

75:74

VI Resources Private Total (VIPRT): 0.

77:76

VI Resources Flexible Primary Default Max (VIFRDM): 0.

79:78

VI Resources Flexible Secondary Maximum (VIFRSM): 0.

81:80

VI Flexible Resource Set Size (VIFRSS): 0.

4095:82

Reserved

Table A-37  Controller information
Bytes Description

0

Number of controller virtualization information entries. The maximum number is 127. The value 0 indicates not entry. (VF only)

31:1

Reserved

63:32

Controller virtualization entry 0: This field contains the first controller topology entry in the list, if present.

95:64

Controller virtualization entry 1: This field contains the second controller topology entry in the list, if present

(N×32+63):(N×32+32)

Controller virtualization entry N: This field contains the N+1 controller topology entry in the list, if present.

Table A-38  Controller virtualization entry
Bytes Description

1:0

Controller Identifier (CNTLID): The value increases from 0 to the maximum number of VFs. 0 indicates the CNTID of the PF entry.

3:2

Primary Controller Identifier (PCID): ID of the primary controller. If the controller is not a secondary controller, the ID must be consistent with CNTLID.

4

Secondary Controller State (SCS): Status of the secondary controller.
Value Definition
00h Reserved
01h Online
02h Offline
03h - FFh Reserved

7:5

Reserved

9:8

Virtual Function Number (VFN): If the secondary controller is SR-IOV VF, this field indicates the VF number. The VF number is greater than 0 and less than the maximum number of VFs. If the secondary controller is not SR-IOV VF, the field value must be 0.

11:10

Reserved

13:12

Number of VQ Flexible Resources Assigned (NVQ): Number of flexible VQ resources assigned to a specified secondary controller.

15:14

Number of VI Flexible Resources Assigned (NVI):Number of flexible VI resources assigned to a specified secondary controller.

31:16

Reserved

Obtaining the Number of SRIOV VFs

This command is used to obtain the effective numVFs value of SRIOV. The number of VFs is returned by Dword0 of CQ.

Table A-39  CQ Command Dword0

Bit

Description

31:00

NumVFs Cnt

Querying the Average DWPD

This interface is used to query the average DWPD in N (N <= 360) days. Dword13 indicates the number of days, and the result is returned by Dword0 of CQ.

Table A-40  Command Dword13

Bit

Description

31:00

Number of days: valid value (1-360)

Table A-41  Cq Command Dword0

Bit

Description

31:00

DWPD value: 100 indicates 1 ((If the average daily written data volume is 0.8 TB and the disk user volume is 1.6 TB, the DWPD value is 0.5 and the interface result is 50).)

Querying UniqueID Information

This interface is used to obtain the UniqueID information. The host issues a command for obtaining the data length, and then issues a command for obtaining the content based on the length. The content obtained is in the string format and the length does not contain '\0' at the end.

Table A-42  SubOpType

SubOpType

Description

0h

Length of data to be obtained.

1h

Content to be obtained.

When SubOpType delivered to obtain the uniqueID length is 0, the length is returned by DWORD0 of CQ.

Table A-43  Cq Command Dword0

Bit

Description

31:00

Length: The unit is byte.

When SubOpType delivered to obtain the uniqueID content is 1, the length is returned by Dword10 and must be the same as the length obtained previously. The UniqueID content is transmitted by the memory that PRP points to, and the content is in the string format.

Table A-44  Command Dword10

Bit

Description

31:00

Length: The unit is Dword.

Translation
Download
Updated: 2019-03-12

Document ID: EDOC1000101091

Views: 57873

Downloads: 1240

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next