Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

mtd: spear_smi: fix kernel-doc warnings <linux/mtd/spear_smi.h> 

Correct most kernel-doc warnings in include/linux/mtd/spear_smi.h
by adding a leading '@' to the description of struct members.
Add a new description for the missing @np member.

Warning: spear_smi.h:48 struct member 'name' not described
 in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'mem_base' not described
 in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'size' not described
 in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'partitions' not described
 in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'nr_partitions' not described
 in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'fast_mode' not described
 in 'spear_smi_flash_info'
Warning: spear_smi.h:62 struct member 'clk_rate' not described
 in 'spear_smi_plat_data'
Warning: spear_smi.h:62 struct member 'num_flashes' not described
 in 'spear_smi_plat_data'
Warning: spear_smi.h:62 struct member 'board_flash_info' not described
 in 'spear_smi_plat_data'
Warning: spear_smi.h:62 struct member 'np' not described
 in 'spear_smi_plat_data'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
This commit is contained in:
Randy Dunlap 2025-10-30 22:41:18 -07:00 committed by Miquel Raynal
parent 3e9c49d4c3
commit c95de73da1
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/linux/mtd/spear_smi.h
View File

@ -31,12 +31,12 @@
* struct spear_smi_flash_info - platform structure for passing flash * struct spear_smi_flash_info - platform structure for passing flash
* information * information
* *
* name: name of the serial nor flash for identification * @name: name of the serial nor flash for identification
* mem_base: the memory base on which the flash is mapped * @mem_base: the memory base on which the flash is mapped
* size: size of the flash in bytes * @size: size of the flash in bytes
* partitions: parition details * @partitions: parition details
* nr_partitions: number of partitions * @nr_partitions: number of partitions
* fast_mode: whether flash supports fast mode * @fast_mode: whether flash supports fast mode
*/ */
struct spear_smi_flash_info { struct spear_smi_flash_info {
@ -51,9 +51,10 @@ struct spear_smi_flash_info {
/** /**
* struct spear_smi_plat_data - platform structure for configuring smi * struct spear_smi_plat_data - platform structure for configuring smi
* *
* clk_rate: clk rate at which SMI must operate * @clk_rate: clk rate at which SMI must operate
* num_flashes: number of flashes present on board * @num_flashes: number of flashes present on board
* board_flash_info: specific details of each flash present on board * @board_flash_info: specific details of each flash present on board
* @np: array of DT node pointers for all possible flash chip devices
*/ */
struct spear_smi_plat_data { struct spear_smi_plat_data {
unsigned long clk_rate; unsigned long clk_rate;