From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 9CDD595C5 for ; Fri, 13 Nov 2015 17:52:28 +0100 (CET) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga101.fm.intel.com with ESMTP; 13 Nov 2015 08:52:26 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,288,1444719600"; d="scan'208";a="684741689" Received: from irsmsx101.ger.corp.intel.com ([163.33.3.153]) by orsmga003.jf.intel.com with ESMTP; 13 Nov 2015 08:52:26 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.13]) by IRSMSX101.ger.corp.intel.com ([163.33.3.153]) with mapi id 14.03.0248.002; Fri, 13 Nov 2015 16:52:25 +0000 From: "Mcnamara, John" To: "Horton, Remy" , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v6 2/2] doc: add user-space ethtool sample app guide Thread-Index: AQHRGK3mQfsvXEcd6EC7Lpp5xoKqhJ6aMVXQ Date: Fri, 13 Nov 2015 16:52:24 +0000 Message-ID: References: <1446826271-5703-1-git-send-email-remy.horton@intel.com> <1446826271-5703-3-git-send-email-remy.horton@intel.com> In-Reply-To: <1446826271-5703-3-git-send-email-remy.horton@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v6 2/2] doc: add user-space ethtool sample app guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 13 Nov 2015 16:52:29 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Remy Horton > Sent: Friday, November 6, 2015 4:11 PM > To: dev@dpdk.org > Subject: [dpdk-dev] [PATCH v6 2/2] doc: add user-space ethtool sample app > guide Hi, Thanks for this. A few minor comments below: > +EthTool Sample Application > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D > + > +The Ethtool sample application shows an implementation of an > +EthTool-like API and provides a console environment that allows its use > +to query and change Ethernet card parameters. The sample is based upon > +a simple L2 frame reflector. In some place the app is called EthTool and in some Ethtool. Use one or the= other. Although "EthTool-like" should probably be "ethtool-like" since it is like = "ethtool" and that is usually written in lowercase.=20 > + > +Compiling the Application > +------------------------- > + > +To compile the application: > + > +#. Go to the sample application directory: > + > + .. code-block:: console > + > + export RTE_SDK=3D/path/to/rte_sdk cd ${RTE_SD}/examples/ethtool Split the two commands onto two lines. > +Running the Application > +----------------------- > + > +The application requires an available core for each port, plus one. > +The only available options are the standard ones for the EAL: > + > +.. code-block:: console > + > + ./ethtool-app/ethtool-app/${RTE_TARGET}/ethtool [EAL options] > + > +Refer to the *DPDK Getting Started Guide* for general information on > +running applications and the Environment Abstraction Layer (EAL) > +options. > + > +Using the application > +--------------------- > + > +The application is console-driven using the cmdline DPDK interface: > + > +.. code-block:: console > + > + EthApp> > + > +From this interface the available commands and descriptions of what > +they do as as follows: > + > +drvinfo > + Print driver info > +eeprom > + Dump EEPROM to file This definition list doesn't render very well. Maybe better as: * ``drvinfo``: Print driver info. * ``eeprom``: Dump EEPROM to file. * ``link``: Print port link states. * ``macaddr``: Gets/sets MAC address. * ``mtu``: Set NIC MTU. * ``open``: Open port. * ``pause``: Get/set port pause state. * ``portstats``: Print port statistics. * ``regs``: Dump port register(s) to file. * ``ringparam``: Get/set ring parameters. * ``rxmode``: Toggle port Rx mode. * ``stop``: Stop port. * ``validate``: Check that given MAC address is valid unicast address. * ``vlan``: Add/remove VLAN id. * ``quit``: Exit program. > +Explaination > +------------ Typo here: Explanation ----------- > +EthTool interface > +----------------- > + > +The EthTool interface is built as a separate library, and implements > +the following functions: > + > +- rte_ethtool_get_drvinfo > +- rte_ethtool_get_regs_len > +- rte_ethtool_get_regs Maybe better as fixed width text: - ``rte_ethtool_get_drvinfo()`` - ``rte_ethtool_get_regs_len()`` - ``rte_ethtool_get_regs()`` - ``rte_ethtool_get_link()`` - ``rte_ethtool_get_eeprom_len()`` - ``rte_ethtool_get_eeprom()`` - ``rte_ethtool_set_eeprom()`` - ``rte_ethtool_get_pauseparam()`` - ``rte_ethtool_set_pauseparam()`` - ``rte_ethtool_net_open()`` - ``rte_ethtool_net_stop()`` - ``rte_ethtool_net_get_mac_addr()`` - ``rte_ethtool_net_set_mac_addr()`` - ``rte_ethtool_net_validate_addr()`` - ``rte_ethtool_net_change_mtu()`` - ``rte_ethtool_net_get_stats64()`` - ``rte_ethtool_net_vlan_rx_add_vid()`` - ``rte_ethtool_net_vlan_rx_kill_vid()`` - ``rte_ethtool_net_set_rx_mode()`` - ``rte_ethtool_get_ringparam()`` - ``rte_ethtool_set_ringparam()`` John. --=20