From 483eb2f56657e8e7f419ab1a4fab8dce9ade8609 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 20:24:20 +0200 Subject: Adding upstream version 14.2.21. Signed-off-by: Daniel Baumann --- src/spdk/doc/porting.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 src/spdk/doc/porting.md (limited to 'src/spdk/doc/porting.md') diff --git a/src/spdk/doc/porting.md b/src/spdk/doc/porting.md new file mode 100644 index 00000000..b6872bef --- /dev/null +++ b/src/spdk/doc/porting.md @@ -0,0 +1,21 @@ +# SPDK Porting Guide {#porting} + +SPDK is ported to new environments by implementing the *env* +library interface. The *env* interface provides APIs for drivers +to allocate physically contiguous and pinned memory, perform PCI +operations (config cycles and mapping BARs), virtual to physical +address translation and managing memory pools. The *env* API is +defined in include/spdk/env.h. + +SPDK includes a default implementation of the *env* library based +on the Data Plane Development Kit ([DPDK](http://dpdk.org/)). +This DPDK implementation can be found in `lib/env_dpdk`. + +DPDK is currently supported on Linux and FreeBSD only. +Users who want to use SPDK on other operating systems, or in +userspace driver frameworks other than DPDK, will need to implement +a new version of the *env* library. The new implementation can be +integrated into the SPDK build by updating the following line +in CONFIG: + + CONFIG_ENV?=$(SPDK_ROOT_DIR)/lib/env_dpdk -- cgit v1.2.3