Skip to content

Commit 4fd41e7

Browse files
Prathamesh Shetelinusw
authored andcommitted
pinctrl: tegra: Add descriptions for SoC data fields
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>
1 parent 597b362 commit 4fd41e7

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

drivers/pinctrl/tegra/pinctrl-tegra.h

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -178,16 +178,22 @@ struct tegra_pingroup {
178178

179179
/**
180180
* struct tegra_pinctrl_soc_data - Tegra pin controller driver configuration
181-
* @ngpios: The number of GPIO pins the pin controller HW affects.
182-
* @pins: An array describing all pins the pin controller affects.
183-
* All pins which are also GPIOs must be listed first within the
184-
* array, and be numbered identically to the GPIO controller's
185-
* numbering.
186-
* @npins: The numbmer of entries in @pins.
187-
* @functions: An array describing all mux functions the SoC supports.
188-
* @nfunctions: The numbmer of entries in @functions.
189-
* @groups: An array describing all pin groups the pin SoC supports.
190-
* @ngroups: The numbmer of entries in @groups.
181+
* @ngpios: The number of GPIO pins the pin controller HW affects.
182+
* @gpio_compatible: Device-tree GPIO compatible string.
183+
* @pins: An array describing all pins the pin controller affects.
184+
* All pins which are also GPIOs must be listed first within the
185+
* array, and be numbered identically to the GPIO controller's
186+
* numbering.
187+
* @npins: The number of entries in @pins.
188+
* @functions: An array describing all mux functions the SoC supports.
189+
* @nfunctions: The number of entries in @functions.
190+
* @groups: An array describing all pin groups the pin SoC supports.
191+
* @ngroups: The number of entries in @groups.
192+
* @hsm_in_mux: High-speed mode field. Only applicable to devices with one pin per group.
193+
* @schmitt_in_mux: Schmitt trigger field. Only applicable to devices with one pin per group.
194+
* @drvtype_in_mux: Drivetype field. Only applicable to devices with one pin per group.
195+
* @sfsel_in_mux: Special function selection field.
196+
* Only applicable to devices with one pin per group.
191197
*/
192198
struct tegra_pinctrl_soc_data {
193199
unsigned ngpios;

0 commit comments

Comments
 (0)