spelling: doc
Part of #2256 * accessible * bstatic * example * initiator * obvious * privileged * scenario * transparent Change-Id: I15f30f56e3bb18443c829830454360945878012a Signed-off-by: Josh Soref <jsoref@gmail.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10401 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
parent
70b16d445f
commit
a82b365b90
@ -1515,7 +1515,7 @@ EXT_LINKS_IN_WINDOW = NO
|
|||||||
|
|
||||||
FORMULA_FONTSIZE = 10
|
FORMULA_FONTSIZE = 10
|
||||||
|
|
||||||
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
|
||||||
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
||||||
# supported properly for IE 6.0, but are supported on all modern browsers.
|
# supported properly for IE 6.0, but are supported on all modern browsers.
|
||||||
#
|
#
|
||||||
|
@ -51,7 +51,7 @@ way needs to be certain that the underlying hardware exists everywhere that it r
|
|||||||
The low level library for IOAT is located in `/lib/ioat`. The low level library
|
The low level library for IOAT is located in `/lib/ioat`. The low level library
|
||||||
for DSA is in `/lib/idxd` (IDXD stands for Intel(R) Data Acceleration Driver).
|
for DSA is in `/lib/idxd` (IDXD stands for Intel(R) Data Acceleration Driver).
|
||||||
In `/lib/idxd` folder, SPDK supports to leverage both user space and kernel space driver
|
In `/lib/idxd` folder, SPDK supports to leverage both user space and kernel space driver
|
||||||
to drive DSA devices. And the following describes each usage scenerio:
|
to drive DSA devices. And the following describes each usage scenario:
|
||||||
|
|
||||||
Leveraging user space idxd driver: The DSA devices are managed by the user space
|
Leveraging user space idxd driver: The DSA devices are managed by the user space
|
||||||
driver in a dedicated SPDK process, then the device cannot be shared by another
|
driver in a dedicated SPDK process, then the device cannot be shared by another
|
||||||
@ -59,7 +59,7 @@ process. The benefit of this usage is no kernel dependency.
|
|||||||
|
|
||||||
Leveraging kernel space driver: The DSA devices are managed by kernel
|
Leveraging kernel space driver: The DSA devices are managed by kernel
|
||||||
space drivers. And the Work queues inside the DSA device can be shared among
|
space drivers. And the Work queues inside the DSA device can be shared among
|
||||||
different processes. Naturally, it can be used in cloud native scenerio. The drawback of
|
different processes. Naturally, it can be used in cloud native scenario. The drawback of
|
||||||
this usage is the kernel dependency, i.e., idxd driver must be supported and loaded
|
this usage is the kernel dependency, i.e., idxd driver must be supported and loaded
|
||||||
in the kernel.
|
in the kernel.
|
||||||
|
|
||||||
|
@ -160,7 +160,7 @@ starting gdb is type "spdk_load_macros".
|
|||||||
.gdbinit can also be used in order to run automatically run the manual steps
|
.gdbinit can also be used in order to run automatically run the manual steps
|
||||||
above prior to starting gdb.
|
above prior to starting gdb.
|
||||||
|
|
||||||
Exmaple .gdbinit:
|
Example .gdbinit:
|
||||||
|
|
||||||
~~~{.sh}
|
~~~{.sh}
|
||||||
source /opt/km/install/tools/gdb_macros/gdb_macros.py
|
source /opt/km/install/tools/gdb_macros/gdb_macros.py
|
||||||
|
@ -316,7 +316,7 @@ portal group may optionally have a redirect portal for non-discovery logins for
|
|||||||
each associated target. This redirect portal must be from a private portal group.
|
each associated target. This redirect portal must be from a private portal group.
|
||||||
|
|
||||||
Initiators configure portals in public portal groups as target portals. When an
|
Initiators configure portals in public portal groups as target portals. When an
|
||||||
initator logs in to a target through a portal in an associated public portal group,
|
initiator logs in to a target through a portal in an associated public portal group,
|
||||||
the target sends a temporary redirection response with a redirect portal. Then the
|
the target sends a temporary redirection response with a redirect portal. Then the
|
||||||
initiator logs in to the target again through the redirect portal.
|
initiator logs in to the target again through the redirect portal.
|
||||||
|
|
||||||
|
@ -8473,7 +8473,7 @@ Example response:
|
|||||||
|
|
||||||
Request notifications. Returns array of notifications that happend since the specified id (or first that is available).
|
Request notifications. Returns array of notifications that happend since the specified id (or first that is available).
|
||||||
|
|
||||||
Notice: Notifications are kept in circular buffer with limited size. Older notifications might be inaccesible
|
Notice: Notifications are kept in circular buffer with limited size. Older notifications might be inaccessible
|
||||||
due to being overwritten by new ones.
|
due to being overwritten by new ones.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
@ -204,7 +204,7 @@ NVMe transports.
|
|||||||
Due to the lack of versioning semantics, it is not recommended to install static libraries system wide.
|
Due to the lack of versioning semantics, it is not recommended to install static libraries system wide.
|
||||||
Instead the path to these static libraries should be added as argument at compile time using
|
Instead the path to these static libraries should be added as argument at compile time using
|
||||||
`-L/path/to/static/libs`. The use of static objects instead of shared objects can also be forced
|
`-L/path/to/static/libs`. The use of static objects instead of shared objects can also be forced
|
||||||
through `-Wl,-Bsatic`, otherwise some compilers might prefer to use the shared objects if both
|
through `-Wl,-Bstatic`, otherwise some compilers might prefer to use the shared objects if both
|
||||||
are available.
|
are available.
|
||||||
|
|
||||||
~~~{.sh}
|
~~~{.sh}
|
||||||
|
@ -21,7 +21,7 @@ version they are using has a bug where `uio_pci_generic` [fails to bind to NVMe
|
|||||||
In these cases, users can build the `igb_uio` kernel module which can be found in dpdk-kmods repository.
|
In these cases, users can build the `igb_uio` kernel module which can be found in dpdk-kmods repository.
|
||||||
To ensure that the driver is properly bound, users should specify `DRIVER_OVERRIDE=/path/to/igb_uio.ko`.
|
To ensure that the driver is properly bound, users should specify `DRIVER_OVERRIDE=/path/to/igb_uio.ko`.
|
||||||
|
|
||||||
## Running SPDK as non-priviledged user {#system_configuration_nonroot}
|
## Running SPDK as non-privileged user {#system_configuration_nonroot}
|
||||||
|
|
||||||
One of the benefits of using the `VFIO` Linux kernel driver is the ability to
|
One of the benefits of using the `VFIO` Linux kernel driver is the ability to
|
||||||
perform DMA operations with peripheral devices as unprivileged user. The
|
perform DMA operations with peripheral devices as unprivileged user. The
|
||||||
|
@ -47,7 +47,7 @@ Some questions to consider when authoring this section:
|
|||||||
|
|
||||||
Here is where you want to highlight things they need to think about in *their* design. If you have written test code
|
Here is where you want to highlight things they need to think about in *their* design. If you have written test code
|
||||||
for this module think about the things that you needed to go learn about to properly interact with this module. Think
|
for this module think about the things that you needed to go learn about to properly interact with this module. Think
|
||||||
about how they need to consider initialization options, threading, limitations, any sort of quirky or non-obious
|
about how they need to consider initialization options, threading, limitations, any sort of quirky or non-obvious
|
||||||
interactions or module behaviors that might save them some time and effort by thinking about before they start their
|
interactions or module behaviors that might save them some time and effort by thinking about before they start their
|
||||||
design.
|
design.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user