From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH] doc: document the new devargs syntax Date: Wed, 17 Jan 2018 00:22:43 +0100 Message-ID: <5324030.qnTS7Rnbq7@xps> References: <1516114218-21501-1-git-send-email-yliu@fridaylinux.org> <20180116231935.pucguvf4u6umvwgu@bidouze.vm.6wind.com> Mime-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Cc: Yuanhan Liu , dev@dpdk.org To: =?ISO-8859-1?Q?Ga=EBtan?= Rivet Return-path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id 8D7151B315 for ; Wed, 17 Jan 2018 00:23:15 +0100 (CET) In-Reply-To: <20180116231935.pucguvf4u6umvwgu@bidouze.vm.6wind.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 17/01/2018 00:19, Ga=EBtan Rivet: > Hi Yuanhan, >=20 > On Tue, Jan 16, 2018 at 10:50:18PM +0800, Yuanhan Liu wrote: > > +The ``devargs`` can be used for whitelisting/blacklisting devices, ide= ntifying > > +DPDK ports and attaching/deatching devices. They all share the same sy= ntax. > > + > > +It is split in 3 categories, where almost everything is optional key/v= alue pairs: > > + > > +* bus (pci, vdev, vmbus, fslmc, etc) > > +* class (eth, crypto, etc) > > +* driver (i40e, mlx5, virtio, etc) > > + > > +The key/value pair describing the category scope is mandatory and must= be the > > +first pair in the category properties. Example: bus=3Dpci, must be pla= ced before > > +id=3D0000:01:00.0. > > + > > +The syntax has below rules: > > + > > +* Between categories, the separator is a slash. > > +* Inside a category, the separator is a comma. > > +* Inside a key/value pair, the separator is an equal sign. > > +* Each category can be used alone. > > + > > +Here is an example with all categories:: > > + > > + bus=3Dpci,id=3D0000:01:00.0/class=3Deth,mac=3D00:11:22:33:44:55/dr= iver=3DPMD_NAME,driverspecificproperty=3DVALUE > > + >=20 > It might be a nitpick, but the driver specific properties might not > follow the key/value pair syntax. At least for the fail-safe, a custom > parsing needs to happen. I think vdev in general will need flexibility. What is more flexible than key/value? > There could be a note that after the comma past the eventual > "driver=3Dxxxx" pair, the syntax is driver-specific and might not follow > the equal-separated key/value pair syntax. Please give an example.