[PATCH] usb: typec: Document priority and mode_selection fields in struct typec_altmode

[PATCH] usb: typec: Document priority and mode_selection fields in struct typec_altmode

[Aldo Conte]

The fields 'priority' and 'mode_selection' in struct typec_altmode are
missing from the kernel-doc comment, which results in warnings when
building the documentation with 'make htmldocs'.

WARNING: ./include/linux/usb/typec_altmode.h:44 struct member 'priority' not described in 'typec_altmode'
WARNING: ./include/linux/usb/typec_altmode.h:44 struct member 'mode_selection' not described in 'typec_altmode'

Document both fields to keep the kernel-doc comment aligned with the
structure definition.

Signed-off-by: Aldo Conte <aldocontelk@gmail.com>
---
 include/linux/usb/typec_altmode.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/linux/usb/typec_altmode.h b/include/linux/usb/typec_altmode.h
index 0513d333b797..b90cc5cfff8d 100644
--- a/include/linux/usb/typec_altmode.h
+++ b/include/linux/usb/typec_altmode.h
@@ -26,6 +26,9 @@ struct typec_altmode_ops;
  * @mode: Index of the Mode
  * @vdo: VDO returned by Discover Modes USB PD command
  * @active: Tells has the mode been entered or not
+ * @priority: Priority used by the automatic alternate mode selection process
+ * @mode_selection: Whether entry to this alternate mode is managed by the
+ * automatic alternate mode selection process or by the specific driver
  * @desc: Optional human readable description of the mode
  * @ops: Operations vector from the driver
  * @cable_ops: Cable operations vector from the driver.
-- 
2.53.0

Re: [PATCH] usb: typec: Document priority and mode_selection fields in struct typec_altmode

[Heikki Krogerus]

Wed, Mar 11, 2026 at 05:33:20PM +0100, Aldo Conte kirjoitti:
> The fields 'priority' and 'mode_selection' in struct typec_altmode are
> missing from the kernel-doc comment, which results in warnings when
> building the documentation with 'make htmldocs'.
> 
> WARNING: ./include/linux/usb/typec_altmode.h:44 struct member 'priority' not described in 'typec_altmode'
> WARNING: ./include/linux/usb/typec_altmode.h:44 struct member 'mode_selection' not described in 'typec_altmode'
> 
> Document both fields to keep the kernel-doc comment aligned with the
> structure definition.
> 
> Signed-off-by: Aldo Conte <aldocontelk@gmail.com>

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  include/linux/usb/typec_altmode.h | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/include/linux/usb/typec_altmode.h b/include/linux/usb/typec_altmode.h
> index 0513d333b797..b90cc5cfff8d 100644
> --- a/include/linux/usb/typec_altmode.h
> +++ b/include/linux/usb/typec_altmode.h
> @@ -26,6 +26,9 @@ struct typec_altmode_ops;
>   * @mode: Index of the Mode
>   * @vdo: VDO returned by Discover Modes USB PD command
>   * @active: Tells has the mode been entered or not
> + * @priority: Priority used by the automatic alternate mode selection process
> + * @mode_selection: Whether entry to this alternate mode is managed by the
> + * automatic alternate mode selection process or by the specific driver
>   * @desc: Optional human readable description of the mode
>   * @ops: Operations vector from the driver
>   * @cable_ops: Cable operations vector from the driver.
> -- 
> 2.53.0

-- 
heikki