Commit 189645ba authored by Randy Dunlap's avatar Randy Dunlap Committed by Bartosz Golaszewski
Browse files

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260301014811.3133250-1-rdunlap@infradead.org


Signed-off-by: default avatarBartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
parent 8a9ebe8c

include/linux/gpio/gpio-nomadik.h

+5 −7
Original line number Diff line number Diff line
@@ -114,8 +114,7 @@ struct nmk_gpio_chip { 
}



/**

 * enum prcm_gpiocr_reg_index

 * Used to reference an PRCM GPIOCR register address.

 * enum prcm_gpiocr_reg_index - Used to reference a PRCM GPIOCR register address.

 */

enum prcm_gpiocr_reg_index {

	PRCM_IDX_GPIOCR1,
@@ -123,8 +122,7 @@ enum prcm_gpiocr_reg_index { 
	PRCM_IDX_GPIOCR3

};

/**

 * enum prcm_gpiocr_altcx_index

 * Used to reference an Other alternate-C function.

 * enum prcm_gpiocr_altcx_index - Used to reference an Other alternate-C function.

 */

enum prcm_gpiocr_altcx_index {

	PRCM_IDX_GPIOCR_ALTC1,
@@ -135,7 +133,7 @@ enum prcm_gpiocr_altcx_index { 
};



/**

 * struct prcm_gpio_altcx - Other alternate-C function

 * struct prcm_gpiocr_altcx - Other alternate-C function

 * @used: other alternate-C function availability

 * @reg_index: PRCM GPIOCR register index used to control the function

 * @control_bit: PRCM GPIOCR bit used to control the function
@@ -147,7 +145,7 @@ struct prcm_gpiocr_altcx { 
} __packed;



/**

 * struct prcm_gpio_altcx_pin_desc - Other alternate-C pin

 * struct prcm_gpiocr_altcx_pin_desc - Other alternate-C pin

 * @pin: The pin number

 * @altcx: array of other alternate-C[1-4] functions

 */
@@ -193,7 +191,7 @@ struct nmk_pingroup { 
 *		numbering.

 * @npins:	The number of entries in @pins.

 * @functions:	The functions supported on this SoC.

 * @nfunction:	The number of entries in @functions.

 * @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.

 * @altcx_pins:	The pins that support Other alternate-C function on this SoC