vhost: add power monitor API

[dpdk.git] / doc / guides / sample_app_ug / ptpclient.rst

diff --git a/doc/guides/sample_app_ug/ptpclient.rst b/doc/guides/sample_app_ug/ptpclient.rst
index d643cf1..d47e942 100644 (file)
--- a/doc/guides/sample_app_ug/ptpclient.rst
+++ b/doc/guides/sample_app_ug/ptpclient.rst
@@ -1,33 +1,5 @@
-..  BSD LICENSE
-    Copyright(c) 2015 Intel Corporation. All rights reserved.
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions
-    are met:
-
-    * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in
-    the documentation and/or other materials provided with the
-    distribution.
-    * Neither the name of Intel Corporation nor the names of its
-    contributors may be used to endorse or promote products derived
-    from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2015 Intel Corporation.

 
 PTP Client Sample Application
 =============================
 
 PTP Client Sample Application
 =============================


@@ -49,7 +21,7 @@ The PTP sample application is intended as a simple reference implementation of
 a PTP client using the DPDK IEEE1588 API.
 In order to keep the application simple the following assumptions are made:
 
 a PTP client using the DPDK IEEE1588 API.
 In order to keep the application simple the following assumptions are made:
 

-* The first discovered master is the master for the session.
+* The first discovered master is the main for the session.

 * Only L2 PTP packets are supported.
 * Only the PTP v2 protocol is supported.
 * Only the slave clock is implemented.
 * Only L2 PTP packets are supported.
 * Only the PTP v2 protocol is supported.
 * Only the slave clock is implemented.


@@ -78,48 +50,22 @@ The adjustment for slave can be represented as:
 If the command line parameter ``-T 1`` is used the application also
 synchronizes the PTP PHC clock with the Linux kernel clock.
 
 If the command line parameter ``-T 1`` is used the application also
 synchronizes the PTP PHC clock with the Linux kernel clock.
 

-

 Compiling the Application
 -------------------------
 
 Compiling the Application
 -------------------------
 

-To compile the application, export the path to the DPDK source tree and edit
-the ``config/common_linuxapp`` configuration file to enable IEEE1588:
-
-.. code-block:: console
-
-    export RTE_SDK=/path/to/rte_sdk
-
-    # Edit  common_linuxapp and set the following options:
-    CONFIG_RTE_LIBRTE_IEEE1588=y
-
-Set the target, for example:
-
-.. code-block:: console
-
-    export RTE_TARGET=x86_64-native-linuxapp-gcc
-
-See the *DPDK Getting Started* Guide for possible ``RTE_TARGET`` values.
-
-Build the application as follows:
-
-.. code-block:: console
+To compile the sample application see :doc:`compiling`.

 
 

-    # Recompile DPDK.
-    make install T=$RTE_TARGET
-
-    # Compile the application.
-    cd ${RTE_SDK}/examples/ptpclient
-    make
+The application is located in the ``ptpclient`` sub-directory.

 
 
 Running the Application
 -----------------------
 
 
 
 Running the Application
 -----------------------
 

-To run the example in a ``linuxapp`` environment:
+To run the example in a ``linux`` environment:

 
 .. code-block:: console
 
 
 .. code-block:: console
 

-    ./build/ptpclient -l 1 -n 4 -- -p 0x1 -T 0
+    ./<build_dir>/examples/dpdk-ptpclient -l 1 -n 4 -- -p 0x1 -T 0

 
 Refer to *DPDK Getting Started Guide* for general information on running
 applications and the Environment Abstraction Layer (EAL) options.
 
 Refer to *DPDK Getting Started Guide* for general information on running
 applications and the Environment Abstraction Layer (EAL) options.


@@ -149,30 +95,28 @@ The first task is to initialize the Environment Abstraction Layer (EAL).  The
 ``argc`` and ``argv`` arguments are provided to the ``rte_eal_init()``
 function. The value returned is the number of parsed arguments:
 
 ``argc`` and ``argv`` arguments are provided to the ``rte_eal_init()``
 function. The value returned is the number of parsed arguments:
 

-.. code-block:: c
-
-    int ret = rte_eal_init(argc, argv);
-    if (ret < 0)
-        rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Initialize the Environment Abstraction Layer (EAL). 8<
+    :end-before: >8 End of initialization of EAL.
+    :dedent: 1

 
 And than we parse application specific arguments
 
 
 And than we parse application specific arguments
 

-.. code-block:: c
-
-    argc -= ret;
-    argv += ret;
-
-    ret = ptp_parse_args(argc, argv);
-    if (ret < 0)
-        rte_exit(EXIT_FAILURE, "Error with PTP initialization\n");
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Parse specific arguments. 8<
+    :end-before: >8 End of parsing specific arguments.
+    :dedent: 1

 
 The ``main()`` also allocates a mempool to hold the mbufs (Message Buffers)
 used by the application:
 
 
 The ``main()`` also allocates a mempool to hold the mbufs (Message Buffers)
 used by the application:
 

-.. code-block:: c
-
-    mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL", NUM_MBUFS * nb_ports,
-           MBUF_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Creates a new mempool in memory to hold the mbufs. 8<
+    :end-before:  >8 End of a new mempool in memory to hold the mbufs.
+    :dedent: 1

 
 Mbufs are the packet buffer structure used by DPDK. They are explained in
 detail in the "Mbuf Library" section of the *DPDK Programmer's Guide*.
 
 Mbufs are the packet buffer structure used by DPDK. They are explained in
 detail in the "Mbuf Library" section of the *DPDK Programmer's Guide*.


@@ -180,19 +124,11 @@ detail in the "Mbuf Library" section of the *DPDK Programmer's Guide*.
 The ``main()`` function also initializes all the ports using the user defined
 ``port_init()`` function with portmask provided by user:
 
 The ``main()`` function also initializes all the ports using the user defined
 ``port_init()`` function with portmask provided by user:
 

-.. code-block:: c
-
-    for (portid = 0; portid < nb_ports; portid++)
-        if ((ptp_enabled_port_mask & (1 << portid)) != 0) {
-
-            if (port_init(portid, mbuf_pool) == 0) {
-                ptp_enabled_ports[ptp_enabled_port_nb] = portid;
-                ptp_enabled_port_nb++;
-            } else {
-                rte_exit(EXIT_FAILURE, "Cannot init port %"PRIu8 "\n",
-                        portid);
-            }
-        }
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Initialize all ports. 8<
+    :end-before: >8 End of initialization of all ports.
+    :dedent: 1

 
 
 Once the initialization is complete, the application is ready to launch a
 
 
 Once the initialization is complete, the application is ready to launch a


@@ -214,21 +150,11 @@ available lcores.
 
 The main work of the application is done within the loop:
 
 
 The main work of the application is done within the loop:
 

-.. code-block:: c
-
-        for (portid = 0; portid < ptp_enabled_port_nb; portid++) {
-
-            portid = ptp_enabled_ports[portid];
-            nb_rx = rte_eth_rx_burst(portid, 0, &m, 1);
-
-            if (likely(nb_rx == 0))
-                continue;
-
-            if (m->ol_flags & PKT_RX_IEEE1588_PTP)
-                parse_ptp_frames(portid, m);
-
-            rte_pktmbuf_free(m);
-        }
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Read packet from RX queues. 8<
+    :end-before: >8 End of read packets from RX queues.
+    :dedent: 2

 
 Packets are received one by one on the RX ports and, if required, PTP response
 packets are transmitted on the TX ports.
 
 Packets are received one by one on the RX ports and, if required, PTP response
 packets are transmitted on the TX ports.


@@ -236,10 +162,11 @@ packets are transmitted on the TX ports.
 If the offload flags in the mbuf indicate that the packet is a PTP packet then
 the packet is parsed to determine which type:
 
 If the offload flags in the mbuf indicate that the packet is a PTP packet then
 the packet is parsed to determine which type:
 

-.. code-block:: c
-
-            if (m->ol_flags & PKT_RX_IEEE1588_PTP)
-                 parse_ptp_frames(portid, m);
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Packet is parsed to determine which type. 8<
+    :end-before: >8 End of packet is parsed to determine which type.
+    :dedent: 3

 
 
 All packets are freed explicitly using ``rte_pktmbuf_free()``.
 
 
 All packets are freed explicitly using ``rte_pktmbuf_free()``.


@@ -254,39 +181,10 @@ PTP parsing
 The ``parse_ptp_frames()`` function processes PTP packets, implementing slave
 PTP IEEE1588 L2 functionality.
 
 The ``parse_ptp_frames()`` function processes PTP packets, implementing slave
 PTP IEEE1588 L2 functionality.
 

-.. code-block:: c
-
-    void
-    parse_ptp_frames(uint16_t portid, struct rte_mbuf *m) {
-        struct ptp_header *ptp_hdr;
-        struct ether_hdr *eth_hdr;
-        uint16_t eth_type;
-
-        eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
-        eth_type = rte_be_to_cpu_16(eth_hdr->ether_type);
-
-        if (eth_type == PTP_PROTOCOL) {
-            ptp_data.m = m;
-            ptp_data.portid = portid;
-            ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(m, char *)
-                        + sizeof(struct ether_hdr));
-
-            switch (ptp_hdr->msgtype) {
-            case SYNC:
-                parse_sync(&ptp_data);
-                break;
-            case FOLLOW_UP:
-                parse_fup(&ptp_data);
-                break;
-            case DELAY_RESP:
-                parse_drsp(&ptp_data);
-                print_clock_info(&ptp_data);
-                break;
-            default:
-                break;
-            }
-        }
-    }
+.. literalinclude:: ../../../examples/ptpclient/ptpclient.c
+    :language: c
+    :start-after: Parse ptp frames. 8<
+    :end-before:  >8 End of function processes PTP packets.

 
 There are 3 types of packets on the RX path which we must parse to create a minimal
 implementation of the PTP slave client:
 
 There are 3 types of packets on the RX path which we must parse to create a minimal
 implementation of the PTP slave client: