Skip to content

Commit 189645b

Browse files
rddunlapBartosz Golaszewski
authored andcommitted
gpio: nomadik: repair some kernel-doc comments
Avoid these kernel-doc warnings by: - adding short descriptions for enums - using correct (matching) struct names in kernel-doc short descriptions - using the correct struct member name for @nfunctions Warning: include/linux/gpio/gpio-nomadik.h:116 missing initial short description on line: * enum prcm_gpiocr_reg_index Warning: include/linux/gpio/gpio-nomadik.h:125 missing initial short description on line: * enum prcm_gpiocr_altcx_index Warning: include/linux/gpio/gpio-nomadik.h:146 expecting prototype for struct prcm_gpio_altcx. Prototype was for struct prcm_gpiocr_altcx instead Warning: include/linux/gpio/gpio-nomadik.h:156 expecting prototype for struct prcm_gpio_altcx_pin_desc. Prototype was for struct prcm_gpiocr_altcx_pin_desc instead Warning: include/linux/gpio/gpio-nomadik.h:212 struct member 'nfunctions' not described in 'nmk_pinctrl_soc_data' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://patch.msgid.link/20260301014811.3133250-1-rdunlap@infradead.org Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
1 parent 8a9ebe8 commit 189645b

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

include/linux/gpio/gpio-nomadik.h

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,17 +114,15 @@ struct nmk_gpio_chip {
114114
}
115115

116116
/**
117-
* enum prcm_gpiocr_reg_index
118-
* Used to reference an PRCM GPIOCR register address.
117+
* enum prcm_gpiocr_reg_index - Used to reference a PRCM GPIOCR register address.
119118
*/
120119
enum prcm_gpiocr_reg_index {
121120
PRCM_IDX_GPIOCR1,
122121
PRCM_IDX_GPIOCR2,
123122
PRCM_IDX_GPIOCR3
124123
};
125124
/**
126-
* enum prcm_gpiocr_altcx_index
127-
* Used to reference an Other alternate-C function.
125+
* enum prcm_gpiocr_altcx_index - Used to reference an Other alternate-C function.
128126
*/
129127
enum prcm_gpiocr_altcx_index {
130128
PRCM_IDX_GPIOCR_ALTC1,
@@ -135,7 +133,7 @@ enum prcm_gpiocr_altcx_index {
135133
};
136134

137135
/**
138-
* struct prcm_gpio_altcx - Other alternate-C function
136+
* struct prcm_gpiocr_altcx - Other alternate-C function
139137
* @used: other alternate-C function availability
140138
* @reg_index: PRCM GPIOCR register index used to control the function
141139
* @control_bit: PRCM GPIOCR bit used to control the function
@@ -147,7 +145,7 @@ struct prcm_gpiocr_altcx {
147145
} __packed;
148146

149147
/**
150-
* struct prcm_gpio_altcx_pin_desc - Other alternate-C pin
148+
* struct prcm_gpiocr_altcx_pin_desc - Other alternate-C pin
151149
* @pin: The pin number
152150
* @altcx: array of other alternate-C[1-4] functions
153151
*/
@@ -193,7 +191,7 @@ struct nmk_pingroup {
193191
* numbering.
194192
* @npins: The number of entries in @pins.
195193
* @functions: The functions supported on this SoC.
196-
* @nfunction: The number of entries in @functions.
194+
* @nfunctions: The number of entries in @functions.
197195
* @groups: An array describing all pin groups the pin SoC supports.
198196
* @ngroups: The number of entries in @groups.
199197
* @altcx_pins: The pins that support Other alternate-C function on this SoC

0 commit comments

Comments
 (0)