Commit Graph

23 Commits

Author SHA1 Message Date
Ben Walker
988e88c82a docs: Update README.md to reflect NVMf target
Change-Id: Iadf635cb018baa1cfbd56fc11714a662aa8c9c3c
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-06-08 16:18:56 -07:00
Daniel Verkamp
4de0491a1b readme: add NVMf dependencies
Change-Id: I013a466089b48459f3bff3b9fc1b7e966efa6f3c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-06-07 10:16:08 -07:00
Daniel Verkamp
a60b63ad65 README: update to DPDK 16.04
Change-Id: Ic969a1d3362bb132eb6d4e5f032ebb6e71d3cee0
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-05-11 10:50:55 -07:00
Ben Walker
f92c0daa53 Update doxygen link in README.md
Change-Id: I5b1cd8d48bf62279710ce7b80bd3c398e532c628
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-05-06 15:28:23 -07:00
Daniel Verkamp
c83f9378da scripts: merge hugepage config into setup.sh
For now, drop the option to configure the number of hugepages (just use
the default 1024).

Change-Id: I686b6151e4a32ffa4ae9a9cf2694693369e03f49
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-04-14 13:36:44 -07:00
Ben Walker
badade1eed Update the README to point users at the examples.
This is very minimal and needs to be expanded, but
at least point the users at the examples as the next
place to go.

Change-Id: I74025f7addb994f97d01accb89d2e9bc870740bf
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-03-11 10:23:03 -07:00
Ben Walker
add1515c86 Clarifications to README.md
* List the components in the development kit
* Mention the examples directory
* Add installation commands for dependencies

Change-Id: I31302b3cd2e5df4f24b8da30af66f9f1daa11eaa
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-03-11 10:08:16 -07:00
Daniel Verkamp
04cde460cf Add a changelog
Import the release notes from previous releases and fill out the major
features for the next release.

Change-Id: I5050d6cc83a92fac4f1dbed5f7ef039cca208765
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-03-09 07:25:09 -07:00
Ben Walker
03a0af30c8 Add the mailing list to README.md.
Change-Id: Iac2c600095042c86a51bad28038bc4b6c2f31ed2
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-02-26 15:50:59 -07:00
Ben Walker
89ce43646f Add gitter link to README.md
Change-Id: I1f5858ddacdee9cc182aae627454bc146f44fa1d
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-02-26 14:36:53 -07:00
Daniel Verkamp
add9186f73 README: cd to DPDK dir in a subshell
Tweak the build instructions slightly to make them simpler to follow.

If someone is reading the instructions top to bottom, the section about
how to build SPDK assumes the current directory is the top-level SPDK
repository, but if the reader just finished building DPDK, they would be
in the DPDK directory.

Change-Id: Ie3dd587bcf1ac41ac3579a75f9b329b0eeaafd7a
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-02-23 12:24:52 -07:00
Ben Walker
55dc5f2131 Add vfio support to scripts.
cleanup.sh and unbind.sh have been combined into a single
setup.sh that takes one optional parameter (reset). If no
parameter is given, the script will automatically bind
all NVMe and IOAT devices to either uio_pci_generic
or vfio-pci, as appropriate based on IOMMU settings. If
the reset parameter is given, the devices will be bound back
to the appropriate kernel drivers.

Change-Id: I25db3234f1ecfb352a281e5093f4c1aa455152ae
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-02-22 11:30:47 -07:00
Daniel Verkamp
a7c6c3cc18 README: add libaio dependency
libaio is required by examples/nvme/perf on Linux, so add it to the list
of dependencies to install before building.

Change-Id: Iae590153f54327711081f9e81538dae4b2ef3f71
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-01-21 10:47:55 -07:00
Daniel Verkamp
b663d3c669 README: update to DPDK 2.2.0
DPDK's install target now requires DESTDIR to be set, so change the
build instructions to set DESTDIR=. to match previous behavior.

Change-Id: Ib697c2f54704210a5b60278ba1a5b20a16f517be
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-01-05 13:18:21 -07:00
Daniel Verkamp
d4ab30ba33 ioat: add user-mode Intel I/OAT driver
The ioat driver supports DMA engine copy offload hardware available on
Intel Xeon platforms.

Change-Id: Ida0b17b25816576948ddb1b0443587e0f09574d4
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-12-09 10:14:15 -07:00
Ben Walker
af2a731de3 build: Allow relative path for DPDK_DIR
This is very convenient. It also works from subdirectories, as
long as you adjust the relative path you pass appropriately.

Change-Id: I8cfeac380ccb5fad4389ee1feb838f986a837f11
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2015-12-07 14:08:28 -07:00
Daniel Verkamp
4d7b500ade README: add link to Doxygen API docs
Change-Id: I0b91e14ccce642079537abc09d92682ee5598c2d
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-11-04 15:07:46 -07:00
Daniel Verkamp
f04508a30c README: add Travis CI build status image
Change-Id: I2555c069bc9f0847636dc662639ad13e589a28f2
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-11-04 14:39:38 -07:00
Jim Harris
f0649be5a0 Add porting guide.
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Ic028d9d776b094fc2fa048c23424aec2c8434cc6
2015-09-28 09:07:19 -07:00
Jim Harris
4ac57251d5 README.md: add build instructions for FreeBSD
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I4500366475ffbaa9c91ea62a07522c2f82a9a372
2015-09-25 12:45:04 -07:00
Jim Harris
5e95ec6f47 README.md: add more detailed quick start instructions
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I267f27edb8797c794dc732334b557f44dc677015
2015-09-24 09:59:56 -07:00
Daniel Verkamp
a56f73febb README: fix Markdown link syntax
Change-Id: I69ab57ee6307355c925c30cb379bcefe0bd90fc7
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-09-21 14:11:31 -07:00
Daniel Verkamp
7c77021c51 Add extremely basic README.md
Change-Id: I4e41e63a075ef53a9cf93fe07dcd56a68809b73c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-09-21 11:32:05 -07:00