Re: [PATCH v4 net-next 8/9] devlink: Add Documentation/networking/devlink-params.txt

Vasundhara Volam
2018-10-09T14:02:50Z

On Tue, Oct 9, 2018 at 11:51 AM Saeed Mahameed <saeedm@mellanox.com> wrote:
>
> On Thu, 2018-10-04 at 11:13 +0530, Vasundhara Volam wrote:
> > This patch adds a new file to add information about some of the
> > generic configuration parameters set via devlink.
> >
> > Cc: "David S. Miller" <davem@davemloft.net>
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: linux-doc@vger.kernel.org
> > Cc: Jiri Pirko <jiri@mellanox.com>
> > Cc: Michael Chan <michael.chan@broadcom.com>
> > Signed-off-by: Vasundhara Volam <vasundhara-v.volam@broadcom.com>
> > ---
> > Documentation/networking/devlink-params.txt | 42
> > +++++++++++++++++++++++++++++
> > 1 file changed, 42 insertions(+)
> > create mode 100644 Documentation/networking/devlink-params.txt
> >
> > diff --git a/Documentation/networking/devlink-params.txt
> > b/Documentation/networking/devlink-params.txt
> > new file mode 100644
> > index 0000000..ae444ff
> > --- /dev/null
> > +++ b/Documentation/networking/devlink-params.txt
> > @@ -0,0 +1,42 @@
> > +Devlink configuration parameters
> > +================================
> > +Following is the list of configuration parameters via devlink
> > interface.
> > +Each parameter can be generic or driver specific and are device
> > level
> > +parameters.
> > +
> > +Note that the driver-specific files should contain the generic
> > params
> > +they support to, with supported config modes.
> > +
> > +Each parameter can be set in different configuration modes:
> > + runtime - set while driver is running, no reset
> > required.
> > + driverinit - applied while driver initializes, requires
> > restart
> > + driver by devlink reload command.
> > + permanent - written to device's non-volatile memory, hard reset
> > + required.
> > +
> > +Following is the list of parameters:
> > +====================================
> > +enable_sriov [DEVICE, GENERIC]
> > + Enable Single Root I/O Virtualisation (SRIOV)
> > in
> > + the device.
> > + Type: Boolean
> > +
> > +ignore_ari [DEVICE, GENERIC]
> > + Ignore Alternative Routing-ID Interpretation
> > (ARI)
> > + capability. If enabled, adapter will ignore ARI
> > + capability even when platforms has the support
> > + enabled and creates same number of partitions
> > when
> > + platform does not support ARI.
> > + Type: Boolean
> > +
> > +msix_vec_per_pf_max [DEVICE, GENERIC]
> > + Provides the maximum number of MSIX interrupts
> > that
> > + a device can create. Value is same across all
> > + physical functions (PFs) in the device.
> > + Type: u32
> > +
> > +msix_vec_per_pf_min [DEVICE, GENERIC]
> > + Provides the minimum number of MSIX interrupts
> > required
> > + for the device initialization. Value is same
> > across all
> > + physical functions (PFs) in the device.
> > + Type: u32
>
> some parameters can't be dynamic, meaning they can't support all
> configuration modes listed above, for example msix min/max can only be
> satisfied at driver boot, so runtime configuration doesn't make sense.
> shouldn't we have this documented in here ? i mean which parameters
> support which modes ?
All three configuration modes are not applicable for each parameter.
Driver which uses the parameter, will list the configuration mode used in
that driver and also is updated in individual driver devlink parameter
documentation.