diff mbox series

[net-next] devlink: Improve the port attributes description

Message ID 20241219150158.906064-1-parav@nvidia.com (mailing list archive)
State New
Delegated to: Netdev Maintainers
Headers show
Series [net-next] devlink: Improve the port attributes description | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/build_tools success Errors and warnings before: 0 (+23) this patch: 0 (+23)
netdev/cc_maintainers success CCed 6 of 6 maintainers
netdev/build_clang success Errors and warnings before: 1002 this patch: 1002
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 524 this patch: 524
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 58 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 3 this patch: 3
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-12-20--06-00 (tests: 881)

Commit Message

Parav Pandit Dec. 19, 2024, 3:01 p.m. UTC 
Improve the description of devlink port attributes PF, VF and SF
numbers.

Reviewed-by: Shay Drory <shayd@nvidia.com>
Reviewed-by: Mark Bloch <mbloch@nvidia.com>
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 include/net/devlink.h | 11 ++++++-----
 net/devlink/port.c    | 11 ++++++-----
 2 files changed, 12 insertions(+), 10 deletions(-)

Comments

Samudrala, Sridhar Dec. 20, 2024, 5:13 p.m. UTC | #1 
On 12/19/2024 7:01 AM, Parav Pandit wrote:
> Improve the description of devlink port attributes PF, VF and SF
> numbers.
> 
> Reviewed-by: Shay Drory <shayd@nvidia.com>
> Reviewed-by: Mark Bloch <mbloch@nvidia.com>
> Reviewed-by: Jiri Pirko <jiri@nvidia.com>
> Signed-off-by: Parav Pandit <parav@nvidia.com>

Reviewed-by: Sridhar Samudrala <sridhar.samudrala@intel.com>

> ---
>   include/net/devlink.h | 11 ++++++-----
>   net/devlink/port.c    | 11 ++++++-----
>   2 files changed, 12 insertions(+), 10 deletions(-)
> 
> diff --git a/include/net/devlink.h b/include/net/devlink.h
> index fbb9a2668e24..a1fd37dcdc73 100644
> --- a/include/net/devlink.h
> +++ b/include/net/devlink.h
> @@ -35,7 +35,7 @@ struct devlink_port_phys_attrs {
>   /**
>    * struct devlink_port_pci_pf_attrs - devlink port's PCI PF attributes
>    * @controller: Associated controller number
> - * @pf: Associated PCI PF number for this port.
> + * @pf: associated PCI function number for the devlink port instance
>    * @external: when set, indicates if a port is for an external controller
>    */
>   struct devlink_port_pci_pf_attrs {
> @@ -47,8 +47,9 @@ struct devlink_port_pci_pf_attrs {
>   /**
>    * struct devlink_port_pci_vf_attrs - devlink port's PCI VF attributes
>    * @controller: Associated controller number
> - * @pf: Associated PCI PF number for this port.
> - * @vf: Associated PCI VF for of the PCI PF for this port.
> + * @pf: associated PCI function number for the devlink port instance
> + * @vf: associated PCI VF number of a PF for the devlink port instance;
> + *	VF number starts from 0 for the first PCI virtual function
>    * @external: when set, indicates if a port is for an external controller
>    */
>   struct devlink_port_pci_vf_attrs {
> @@ -61,8 +62,8 @@ struct devlink_port_pci_vf_attrs {
>   /**
>    * struct devlink_port_pci_sf_attrs - devlink port's PCI SF attributes
>    * @controller: Associated controller number
> - * @sf: Associated PCI SF for of the PCI PF for this port.
> - * @pf: Associated PCI PF number for this port.
> + * @sf: associated SF number of a PF for the devlink port instance
> + * @pf: associated PCI function number for the devlink port instance
>    * @external: when set, indicates if a port is for an external controller
>    */
>   struct devlink_port_pci_sf_attrs {
> diff --git a/net/devlink/port.c b/net/devlink/port.c
> index be9158b4453c..939081a0e615 100644
> --- a/net/devlink/port.c
> +++ b/net/devlink/port.c
> @@ -1376,7 +1376,7 @@ EXPORT_SYMBOL_GPL(devlink_port_attrs_set);
>    *
>    *	@devlink_port: devlink port
>    *	@controller: associated controller number for the devlink port instance
> - *	@pf: associated PF for the devlink port instance
> + *	@pf: associated PCI function number for the devlink port instance
>    *	@external: indicates if the port is for an external controller
>    */
>   void devlink_port_attrs_pci_pf_set(struct devlink_port *devlink_port, u32 controller,
> @@ -1402,8 +1402,9 @@ EXPORT_SYMBOL_GPL(devlink_port_attrs_pci_pf_set);
>    *
>    *	@devlink_port: devlink port
>    *	@controller: associated controller number for the devlink port instance
> - *	@pf: associated PF for the devlink port instance
> - *	@vf: associated VF of a PF for the devlink port instance
> + *	@pf: associated PCI function number for the devlink port instance
> + *	@vf: associated PCI VF number of a PF for the devlink port instance;
> + *	     VF number starts from 0 for the first PCI virtual function
>    *	@external: indicates if the port is for an external controller
>    */
>   void devlink_port_attrs_pci_vf_set(struct devlink_port *devlink_port, u32 controller,
> @@ -1430,8 +1431,8 @@ EXPORT_SYMBOL_GPL(devlink_port_attrs_pci_vf_set);
>    *
>    *	@devlink_port: devlink port
>    *	@controller: associated controller number for the devlink port instance
> - *	@pf: associated PF for the devlink port instance
> - *	@sf: associated SF of a PF for the devlink port instance
> + *	@pf: associated PCI function number for the devlink port instance
> + *	@sf: associated SF number of a PF for the devlink port instance
>    *	@external: indicates if the port is for an external controller
>    */
>   void devlink_port_attrs_pci_sf_set(struct devlink_port *devlink_port, u32 controller,
diff mbox series

Patch

diff --git a/include/net/devlink.h b/include/net/devlink.h
index fbb9a2668e24..a1fd37dcdc73 100644
--- a/include/net/devlink.h
+++ b/include/net/devlink.h
@@ -35,7 +35,7 @@  struct devlink_port_phys_attrs {
 /**
  * struct devlink_port_pci_pf_attrs - devlink port's PCI PF attributes
  * @controller: Associated controller number
- * @pf: Associated PCI PF number for this port.
+ * @pf: associated PCI function number for the devlink port instance
  * @external: when set, indicates if a port is for an external controller
  */
 struct devlink_port_pci_pf_attrs {
@@ -47,8 +47,9 @@  struct devlink_port_pci_pf_attrs {
 /**
  * struct devlink_port_pci_vf_attrs - devlink port's PCI VF attributes
  * @controller: Associated controller number
- * @pf: Associated PCI PF number for this port.
- * @vf: Associated PCI VF for of the PCI PF for this port.
+ * @pf: associated PCI function number for the devlink port instance
+ * @vf: associated PCI VF number of a PF for the devlink port instance;
+ *	VF number starts from 0 for the first PCI virtual function
  * @external: when set, indicates if a port is for an external controller
  */
 struct devlink_port_pci_vf_attrs {
@@ -61,8 +62,8 @@  struct devlink_port_pci_vf_attrs {
 /**
  * struct devlink_port_pci_sf_attrs - devlink port's PCI SF attributes
  * @controller: Associated controller number
- * @sf: Associated PCI SF for of the PCI PF for this port.
- * @pf: Associated PCI PF number for this port.
+ * @sf: associated SF number of a PF for the devlink port instance
+ * @pf: associated PCI function number for the devlink port instance
  * @external: when set, indicates if a port is for an external controller
  */
 struct devlink_port_pci_sf_attrs {
diff --git a/net/devlink/port.c b/net/devlink/port.c
index be9158b4453c..939081a0e615 100644
--- a/net/devlink/port.c
+++ b/net/devlink/port.c
@@ -1376,7 +1376,7 @@  EXPORT_SYMBOL_GPL(devlink_port_attrs_set);
  *
  *	@devlink_port: devlink port
  *	@controller: associated controller number for the devlink port instance
- *	@pf: associated PF for the devlink port instance
+ *	@pf: associated PCI function number for the devlink port instance
  *	@external: indicates if the port is for an external controller
  */
 void devlink_port_attrs_pci_pf_set(struct devlink_port *devlink_port, u32 controller,
@@ -1402,8 +1402,9 @@  EXPORT_SYMBOL_GPL(devlink_port_attrs_pci_pf_set);
  *
  *	@devlink_port: devlink port
  *	@controller: associated controller number for the devlink port instance
- *	@pf: associated PF for the devlink port instance
- *	@vf: associated VF of a PF for the devlink port instance
+ *	@pf: associated PCI function number for the devlink port instance
+ *	@vf: associated PCI VF number of a PF for the devlink port instance;
+ *	     VF number starts from 0 for the first PCI virtual function
  *	@external: indicates if the port is for an external controller
  */
 void devlink_port_attrs_pci_vf_set(struct devlink_port *devlink_port, u32 controller,
@@ -1430,8 +1431,8 @@  EXPORT_SYMBOL_GPL(devlink_port_attrs_pci_vf_set);
  *
  *	@devlink_port: devlink port
  *	@controller: associated controller number for the devlink port instance
- *	@pf: associated PF for the devlink port instance
- *	@sf: associated SF of a PF for the devlink port instance
+ *	@pf: associated PCI function number for the devlink port instance
+ *	@sf: associated SF number of a PF for the devlink port instance
  *	@external: indicates if the port is for an external controller
  */
 void devlink_port_attrs_pci_sf_set(struct devlink_port *devlink_port, u32 controller,