From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr0-f196.google.com (mail-wr0-f196.google.com [209.85.128.196]) by dpdk.org (Postfix) with ESMTP id BA37B1B31B for ; Wed, 17 Jan 2018 00:19:48 +0100 (CET) Received: by mail-wr0-f196.google.com with SMTP id f11so6515632wre.4 for ; Tue, 16 Jan 2018 15:19:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to :user-agent; bh=k2qcKEHlwqV6aSBJlcksJbI/vkDJE4qGfwsr95CK7yU=; b=k9buALnHQQxlfPPKJYHpwcoxDtni8iJbmHKUjMsAaa6VSuEyEuGydKDQjfAue3RGBe 56oANuIacZCxlUNDNkLS0fwGK6DCnWOl4KQibjiyvF0yj2TpjhE1cod5PjZeCBlXAbHS 7Hpg3iut7y5J4tV8o9vw51mZmcJZ3ovRkW/uHYp/D1wkDGajE+gy9eh320Fhxv6tymv2 k8CeE9ZEtG+amFf+6XanFYD66f2Z3tkXpqXGPIy0BQMHwdty+KPGYq1z9BXYaMILBMva aLefT8UYrurpwM29mPDqYTg09UrXXyVW35o6e9r0CDj9sBMaACI+ijf5i7RoXW5gzVJs QqBA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to:user-agent; bh=k2qcKEHlwqV6aSBJlcksJbI/vkDJE4qGfwsr95CK7yU=; b=FGH1zcZL7sJu48K6DyayWBf6gqUMn4VnD2/TJN1FIt4zI2dkJKpz+dpOcKuX+A9L2S /7KiYPm/mV3APobUiHFF9o5bodvZSYEJDOLTkHzGb0HIrUVR5olGj2uMkc9Au1kWhx6y z+nWFQI92L2puMyw4xOaLrxUtDRFGaEYiot39Lrj7fHY2miT2hncQKxcVhSPgF7vqud1 E7LU3OhOiseuhw5R0DTP0F0zpTdnI43M05iO4hEuNtux5hCVDpdvRlqHYjdFnpunCQRJ U1xJhxCfvcOfWscIPWEZGyK8h+BGEUNoMzIsR7uq/PBSIZC1Q2gc4KCDyDwgAxtdziaz K35A== X-Gm-Message-State: AKwxytcFF2LFrZ3ZzMOFxLOwhdPGiTSk6iD/WO5XQoPSOXavO/hDP/aT OC5zbu7heYKRAtSuj1acGr+bklOG X-Google-Smtp-Source: ACJfBot9BTDfGZPWk/wdHEXMcFs3HxLOBqyeL7GGZwmZR7SZUTqTbwnujO9KxBNSwrt3Fsh1e0YFsw== X-Received: by 10.223.135.59 with SMTP id a56mr686256wra.121.1516144788171; Tue, 16 Jan 2018 15:19:48 -0800 (PST) Received: from bidouze.vm.6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id d10sm3446456wmh.15.2018.01.16.15.19.47 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 16 Jan 2018 15:19:47 -0800 (PST) Date: Wed, 17 Jan 2018 00:19:35 +0100 From: =?iso-8859-1?Q?Ga=EBtan?= Rivet To: Yuanhan Liu Cc: dev@dpdk.org, Thomas Monjalon Message-ID: <20180116231935.pucguvf4u6umvwgu@bidouze.vm.6wind.com> References: <1516114218-21501-1-git-send-email-yliu@fridaylinux.org> MIME-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <1516114218-21501-1-git-send-email-yliu@fridaylinux.org> User-Agent: NeoMutt/20170113 (1.7.2) Subject: Re: [dpdk-dev] [PATCH] doc: document the new devargs syntax X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 16 Jan 2018 23:19:48 -0000 Hi Yuanhan, On Tue, Jan 16, 2018 at 10:50:18PM +0800, Yuanhan Liu wrote: > This patch documents the new devargs syntax, which is going to be > implemented in DPDK v18.05. > > The new devargs proposal is introduced for having a consistent > interface for: > > - whitelisting/blacklisting devices > - identifying ports > - attaching/detaching devices > > Please check the patch content for the details. Also, here is link > for the background: > http://dpdk.org/ml/archives/dev/2017-November/082600.html > > This syntax is suggestd by Thomas: > http://dpdk.org/ml/archives/dev/2017-December/084234.html > > Signed-off-by: Yuanhan Liu > --- > doc/guides/prog_guide/env_abstraction_layer.rst | 34 +++++++++++++++++++++++++ > 1 file changed, 34 insertions(+) > > diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst > index 34d871c..12f37f2 100644 > --- a/doc/guides/prog_guide/env_abstraction_layer.rst > +++ b/doc/guides/prog_guide/env_abstraction_layer.rst > @@ -213,6 +213,40 @@ device having emitted a Device Removal Event. In such case, calling > callback. Care must be taken not to close the device from the interrupt handler > context. It is necessary to reschedule such closing operation. > > +Devargs > +~~~~~~~ > + > +The ``devargs`` can be used for whitelisting/blacklisting devices, identifying > +DPDK ports and attaching/deatching devices. They all share the same syntax. > + > +It is split in 3 categories, where almost everything is optional key/value 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=pci, must be placed before > +id=0000: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=pci,id=0000:01:00.0/class=eth,mac=00:11:22:33:44:55/driver=PMD_NAME,driverspecificproperty=VALUE > + 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. There could be a note that after the comma past the eventual "driver=xxxx" pair, the syntax is driver-specific and might not follow the equal-separated key/value pair syntax. -- Gaëtan Rivet 6WIND