1.. BSD LICENSE 2 Copyright(c) 2010-2014 Intel Corporation. All rights reserved. 3 All rights reserved. 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 * Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 * Redistributions in binary form must reproduce the above copyright 12 notice, this list of conditions and the following disclaimer in 13 the documentation and/or other materials provided with the 14 distribution. 15 * Neither the name of Intel Corporation nor the names of its 16 contributors may be used to endorse or promote products derived 17 from this software without specific prior written permission. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31Introduction 32============ 33 34This document contains instructions for installing and configuring the 35Data Plane Development Kit (DPDK) software. It is designed to get customers 36up and running quickly and describes how to compile and run a 37DPDK application in a FreeBSD* application (bsdapp) environment, without going 38deeply into detail. 39 40For a comprehensive guide to installing and using FreeBSD*, the following 41handbook is available from the FreeBSD* Documentation Project: 42 43`http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_ 44 45.. note:: 46 47 The DPDK is now available as part of the FreeBSD ports collection. 48 Installing via the ports collection infrastructure is now the recommended 49 way to install the DPDK on FreeBSD, and is documented in the 50 next chapter, :ref:`install_from_ports`. 51 52Documentation Roadmap 53--------------------- 54 55The following is a list of DPDK documents in the suggested reading order: 56 57* **Release Notes** : Provides release-specific information, including supported 58 features, limitations, fixed issues, known issues and so on. Also, provides the 59 answers to frequently asked questions in FAQ format. 60 61* **Getting Started Guide** (this document): Describes how to install and 62 configure the DPDK; designed to get users up and running quickly with the 63 software. 64 65* **Programmer's Guide**: Describes: 66 67 * The software architecture and how to use it (through examples), 68 specifically in a Linux* application (linuxapp) environment 69 70 * The content of the DPDK, the build system (including the commands 71 that can be used in the root DPDK Makefile to build the development 72 kit and an application) and guidelines for porting an application 73 74 * Optimizations used in the software and those that should be considered 75 for new development 76 77 A glossary of terms is also provided. 78 79* **API Reference**: Provides detailed information about DPDK functions, 80 data structures and other programming constructs. 81 82* **Sample Applications User Guide**: Describes a set of sample applications. 83 Each chapter describes a sample application that showcases specific functionality 84 and provides instructions on how to compile, run and use the sample application. 85 86.. note:: 87 88 These documents are available for download as a separate documentation 89 package at the same location as the DPDK code package. 90