leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: develop: Convert README.nvme to reST

Browse Source 
This converts the existing README.nvme to reST, and puts it under
the develop/driver-model/ directory.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
This commit is contained in:
Bin Meng 2021-06-22 21:16:22 +08:00
parent 78d5f2011e
commit bf2a28356e
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/develop/driver-model/index.rst
View File

@ -19,6 +19,7 @@ subsystems
i2c-howto
livetree
migration
nvme
of-plat
pci-info
pmic-framework

25
doc/README.nvme → doc/develop/driver-model/nvme.rst
View File

@ -1,10 +1,12 @@
# SPDX-License-Identifier: GPL-2.0+
#
# Copyright (C) 2017 NXP Semiconductors
# Copyright (C) 2017 Bin Meng <bmeng.cn@gmail.com>
.. SPDX-License-Identifier: GPL-2.0+
.. Copyright (C) 2017 NXP Semiconductors
.. Copyright (C) 2017 Bin Meng <bmeng.cn@gmail.com>
NVMe Support
============
What is NVMe
============
------------
NVM Express (NVMe) is a register level interface that allows host software to
communicate with a non-volatile memory subsystem. This interface is optimized
@ -48,6 +50,8 @@ identified.
To list all of the NVMe hard disks, try:
.. code-block:: none
=> nvme info
Device 0: Vendor: 0x8086 Rev: 8DV10131 Prod: CVFT535600LS400BGN
Type: Hard Disk
@ -55,10 +59,14 @@ To list all of the NVMe hard disks, try:
and print out detailed information for controller and namespaces via:
.. code-block:: none
=> nvme detail
Raw block read/write to can be done via the 'nvme read/write' commands:
.. code-block:: none
=> nvme read a0000000 0 11000
=> tftp 80000000 /tftpboot/kernel.itb
@ -66,6 +74,8 @@ Raw block read/write to can be done via the 'nvme read/write' commands:
Of course, file system command can be used on the NVMe hard disk as well:
.. code-block:: none
=> fatls nvme 0:1
32376967 kernel.itb
22929408 100m
@ -81,4 +91,7 @@ QEMU supports NVMe emulation and we can test NVMe driver with QEMU x86 running
U-Boot. Please see README.x86 for how to build u-boot.rom image for QEMU x86.
Example command line to call QEMU x86 below with emulated NVMe device:
$ ./qemu-system-i386 -drive file=nvme.img,if=none,id=drv0 -device nvme,drive=drv0,serial=QEMUNVME0001 -bios u-boot.rom
.. code-block:: bash
$ ./qemu-system-i386 -drive file=nvme.img,if=none,id=drv0 -device nvme,drive=drv0,serial=QEMUNVME0001 -bios u-boot.rom