You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,33 +1,33 @@
1
1
# Switchtec-nvme-cli
2
-
This project is a fork of [nvme-cli][0] project with additional support for using NVMe drives in the Switchtec Gen4 PAX fabric.
2
+
This project is a fork of the [nvme-cli][0] project with additional support for using NVMe drives in the Switchtec Gen4 PAX fabric.
3
3
4
4
## Background
5
-
Switchtec Gen4 PAX is a variant of Microsemi's Switchtec PCIe switch product which enables sharing SR-IOV devices among multiple hosts. Common SR-IOV devices include NICs, HBAs and IB cards, etc. With the support of Switchtec Gen4 PAX switch and this utility, an SR-IOV capable NVMe drive can be managed and configured by a host and then shared among multiple hosts.
5
+
Switchtec Gen4 PAX is a variant of Microsemi's Switchtec PCIe switch product which enables sharing SR-IOV devices among multiple hosts. Common SR-IOV devices include NICs, HBAs, IB cards, etc. With the support of a Switchtec Gen4 PAX switch and this utility, an SR-IOV capable NVMe drive can be managed and configured by a host and then shared among multiple hosts.
6
6
7
-
By default, an NVMe drive in the PAX fabric cannot be enumerated by the host. Using the bind operation provided by the Switchtec Gen4 PAX switch, such VF can be bound to and enumerated by the host.
7
+
By default, an NVMe drive in the PAX fabric cannot be enumerated by the host. Using the bind operation provided by the Switchtec Gen4 PAX switch, such a VF can be bound to and enumerated by the host.
8
8
9
-
Unlike some of the other SR-IOV devices such as NICs, the NVMe drives need to be properly configured before they can be used. Generally, the configurations include creating an namespace and attaching the namespace to a specific VF (NVMe secondary controller).
9
+
Unlike some other SR-IOV devices such as NICs, NVMe drives need to be properly configured before they can be used. Generally, configuration includes creating an namespace and attaching the namespace to a specific VF (NVMe secondary controller).
10
10
11
-
These configurations are done through Fabric Manager using MRPC commands. MRPC interface is a way for a host to send configuration commands to the Switchtec firmware. Switchtec Gen4 PAX provides a special MRPC command to forward NVMe admin commands to the NVMe drives in the PAX fabric.
11
+
The configuration is done through Fabric Manager using MRPC commands. The MRPC interface is a way for a host to send configuration commands to the Switchtec firmware. Switchtec Gen4 PAX provides a special MRPC command to forward NVMe admin commands to the NVMe drives in the PAX fabric.
12
12
13
13
Switchtec-nvme-cli is responsible for creating the NVMe admin commands and delivering them to NVMe drives in the PAX fabric, using the special MRPC command. The special MRPC commands can be sent through one of these two channels: the inband PCIe channel, or the Ethernet channel. Switchtec-nvme-cli is currently based on v1.11.1 of the [nvme-cli][0].
14
14
15
-
Refer to Switchtec PAX device specification for further information on Switchtec PAX, including MRPC, Fabric Manager and other terminologies used in this document.
15
+
Refer to the Switchtec PAX device specification for further information on Switchtec PAX, including MRPC, Fabric Manager and other terminologies used in this document.
16
16
17
17
## Features
18
-
Swichtec-nvme-cli supports all features of nvme-cli for drives connected directly to host.
18
+
Swichtec-nvme-cli supports all features of nvme-cli for drives connected directly to the host.
19
19
20
20
Swichtec-nvme-cli supports the following operations for NVMe drives behind PAX:
21
21
- Listing all NVMe devices and namespaces
22
22
- Creating a namespace
23
23
- Deleting a namespace
24
24
- Attaching a namespace to requested controller(s)
- Sending NVMe Identify List command, displaying structure
26
+
- Sending the NVMe Identify Controller command
27
+
- Sending the NVMe Identify Namespace command, displaying structure
28
+
- Sending the NVMe Identify List command, displaying structure
29
29
30
-
## Build and Installation
30
+
## Building and Installation
31
31
Switchtec-nvme-cli depends on the [switchtec-user][1] library and [switchtec-kernel][2] driver, among others. Please build and install the switchtec-user library and switchtec-kernel driver before building switchtec-nvme-cli.
32
32
33
33
To build and install this utility, simply run the following commands:
@@ -137,7 +137,7 @@ Node SN Model
137
137
[email protected]:0 SERIALNUMBER VENDOR MODEL 4 2.15 GB / 2.15 GB 512 B + 0 B REVISION
138
138
[email protected]:0 SERIALNUMBER VENDOR MODEL 5 2.15 GB / 2.15 GB 512 B + 0 B REVISION
0 commit comments