Skip to content

Commit 8ba26aa

Browse files
committed
Update README after proof read.
1 parent 7a4fc0f commit 8ba26aa

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# 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.
33

44
## 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.
66

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.
88

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).
1010

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.
1212

1313
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].
1414

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.
1616

1717
## 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.
1919

2020
Swichtec-nvme-cli supports the following operations for NVMe drives behind PAX:
2121
- Listing all NVMe devices and namespaces
2222
- Creating a namespace
2323
- Deleting a namespace
2424
- Attaching a namespace to requested controller(s)
2525
- Deleting a namespace from the controller
26-
- Sending NVMe Identify Controller command
27-
- Sending NVMe Identify Namespace command, displaying structure
28-
- 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
2929

30-
## Build and Installation
30+
## Building and Installation
3131
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.
3232

3333
To build and install this utility, simply run the following commands:
@@ -137,7 +137,7 @@ Node SN Model
137137
[email protected]:0 SERIALNUMBER VENDOR MODEL 4 2.15 GB / 2.15 GB 512 B + 0 B REVISION
138138
[email protected]:0 SERIALNUMBER VENDOR MODEL 5 2.15 GB / 2.15 GB 512 B + 0 B REVISION
139139
```
140-
2. List controllers of a NVMe drive
140+
2. List controllers of an NVMe drive
141141
```
142142
#sudo ./switchtec-nvme list-ctrl [email protected]:0
143143
[ 0]:0x1
@@ -157,7 +157,7 @@ Node SN Model
157157
[ 14]:0xf
158158
[ 15]:0x21
159159
```
160-
3. List namespaces of a NVMe drive
160+
3. List namespaces of an NVMe drive
161161
```
162162
#sudo ./switchtec-nvme list-ns [email protected]:0
163163
[ 0]:0x1

0 commit comments

Comments
 (0)