net/ionic: add skeleton
[dpdk.git] / doc / guides / nics / ionic.rst
1 ..  SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
2     Copyright(c) 2018-2019 Pensando Systems, Inc. All rights reserved.
3
4 IONIC Driver
5 ============
6
7 The ionic driver provides support for Pensando server adapters.
8 It currently supports the below models:
9
10 - `Naples DSC-25 <https://pensando.io/assets/documents/Naples-25_ProductBrief_10-2019.pdf>`_
11 - `Naples DSC-100 <https://pensando.io/assets/documents/Naples_100_ProductBrief-10-2019.pdf>`_
12
13 Please visit https://pensando.io for more information.
14
15 Identifying the Adapter
16 -----------------------
17
18 To find if one or more Pensando PCI Ethernet devices are installed
19 on the host, check for the PCI devices:
20
21    .. code-block:: console
22
23       lspci -d 1dd8:
24       b5:00.0 Ethernet controller: Device 1dd8:1002
25       b6:00.0 Ethernet controller: Device 1dd8:1002
26
27 Pre-Installation Configuration
28 ------------------------------
29
30 The following options can be modified in the ``config`` file.
31
32 - ``CONFIG_RTE_LIBRTE_IONIC_PMD`` (default ``y``)
33
34   Toggle compilation of ionic PMD.
35
36 Building DPDK
37 -------------
38
39 The ionic PMD driver supports UIO and VFIO, please refer to the
40 :ref:`DPDK documentation that comes with the DPDK suite <linux_gsg>`
41 for instructions on how to build DPDK.