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 is a user guide for the testpmd example application that is shipped as part of the Intel® Data Plane Development Kit. 35 36The testpmd application can be used to test the Intel® DPDK in a packet forwarding mode 37and also to access NIC hardware features such as Flow Director. 38It also serves as a example of how to build a more fully-featured application using the Intel® DPDK SDK. 39 40DocumentationRoadmap 41-------------------- 42 43The following is a list of Intel® DPDK documents in the suggested reading order: 44 45* **Release Notes** : Provides release-specific information, including supported features, 46 limitations, fixed issues, known issues and so on. 47 Also, provides the answers to frequently asked questions in FAQ format. 48 49* **Getting Started Guide** (this document): Describes how to install and configure the Intel® DPDK; 50 designed to get users up and running quickly with the software. 51 52* **Programmer's Guide** : Describes: 53 54 * The software architecture and how to use it (through examples), specifically in a Linux* application (linuxapp) environment 55 56 * The content of the Intel® DPDK, the build system 57 (including the commands that can be used in the root Intel® DPDK Makefile to build the development kit and an application) 58 and guidelines for porting an application 59 60 * Optimizations used in the software and those that should be considered for new development 61 62 A glossary of terms is also provided. 63 64* **API Reference** : Provides detailed information about Intel® DPDK functions, data structures and other programming constructs. 65 66* **Sample Applications User Guide** : Describes a set of sample applications. 67 Each chapter describes a sample application that showcases specific functionality and 68 provides instructions on how to compile, run and use the sample application. 69 70.. note:: 71 72 These documents are available for download as a separate documentation package at the same location as the Intel® DPDK code package. 73