]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
pinctrl: tegra: Add descriptions for SoC data fields
authorPrathamesh Shete <pshete@nvidia.com>
Wed, 5 Mar 2025 10:49:38 +0000 (16:19 +0530)
committerLinus Walleij <linus.walleij@linaro.org>
Fri, 14 Mar 2025 10:03:49 +0000 (11:03 +0100)
Add detailed descriptions for the remaining fields in the
tegra_pinctrl_soc_data structure. This improves code documentation
and clarifies the purpose of each field, particularly for the
pin-specific configuration options.

Signed-off-by: Prathamesh Shete <pshete@nvidia.com>
Link: https://lore.kernel.org/20250305104939.15168-1-pshete@nvidia.com
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
drivers/pinctrl/tegra/pinctrl-tegra.h

index 216cc59b62b4ba4e5f433eec17a132d0e1e7f9f6..be9268ddb83de64faca756031883ade1f0a4ec5b 100644 (file)
@@ -178,16 +178,22 @@ struct tegra_pingroup {
 
 /**
  * struct tegra_pinctrl_soc_data - Tegra pin controller driver configuration
- * @ngpios:    The number of GPIO pins the pin controller HW affects.
- * @pins:      An array describing all pins the pin controller affects.
- *             All pins which are also GPIOs must be listed first within the
- *             array, and be numbered identically to the GPIO controller's
- *             numbering.
- * @npins:     The numbmer of entries in @pins.
- * @functions: An array describing all mux functions the SoC supports.
- * @nfunctions:        The numbmer of entries in @functions.
- * @groups:    An array describing all pin groups the pin SoC supports.
- * @ngroups:   The numbmer of entries in @groups.
+ * @ngpios:            The number of GPIO pins the pin controller HW affects.
+ * @gpio_compatible:   Device-tree GPIO compatible string.
+ * @pins:              An array describing all pins the pin controller affects.
+ *                     All pins which are also GPIOs must be listed first within the
+ *                     array, and be numbered identically to the GPIO controller's
+ *                     numbering.
+ * @npins:             The number of entries in @pins.
+ * @functions:         An array describing all mux functions the SoC supports.
+ * @nfunctions:                The number of entries in @functions.
+ * @groups:            An array describing all pin groups the pin SoC supports.
+ * @ngroups:           The number of entries in @groups.
+ * @hsm_in_mux:                High-speed mode field. Only applicable to devices with one pin per group.
+ * @schmitt_in_mux:    Schmitt trigger field. Only applicable to devices with one pin per group.
+ * @drvtype_in_mux:    Drivetype field. Only applicable to devices with one pin per group.
+ * @sfsel_in_mux:      Special function selection field.
+ *                     Only applicable to devices with one pin per group.
  */
 struct tegra_pinctrl_soc_data {
        unsigned ngpios;