Commit 01950140 authored by Sebastian Brzezinka's avatar Sebastian Brzezinka Committed by Tomasz Zawadzki
Browse files

doc/nvme.md: describe SPDK_CUSE_GET_TRANSPORT cuse ioctl commnad 



Signed-off-by: default avatarSebastian Brzezinka <sebastian.brzezinka@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/18837

 (master)

(cherry picked from commit 5d66b9d0)
Change-Id: Iaff01061a06ac5363e28ab94770abe97bd57f97e
Signed-off-by: default avatarKrzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/20110


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
parent 5d8b5363

doc/nvme.md

+17 −0
Original line number Diff line number Diff line
@@ -408,6 +408,23 @@ with SPDK NVMe CUSE. 
SCSI to NVMe Translation Layer is not implemented. Tools that are using this layer to

identify, manage or operate device might not work properly or their use may be limited.



### SPDK_CUSE_GET_TRANSPORT ioctl command



nvme-cli mostly uses IOCTLs to obtain information, but transport information is

obtained through sysfs. Since SPDK does not populate sysfs, the SPDK plugin leverages

an SPDK/CUSE specific ioctl to get the information.



~~~{.c}

#define SPDK_CUSE_GET_TRANSPORT _IOWR('n', 0x1, struct cuse_transport)

~~~



~~~{.c}

struct cuse_transport {

	char trstring[SPDK_NVMF_TRSTRING_MAX_LEN + 1];

	char traddr[SPDK_NVMF_TRADDR_MAX_LEN + 1];

} tr;

~~~



## NVMe LED management {#nvme_led}



It is possible to use the ledctl(8) utility to control the state of LEDs in systems supporting