Skip to content

Commit c95de73

Browse files
rddunlapmiquelraynal
authored andcommitted
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>
1 parent 3e9c49d commit c95de73

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

include/linux/mtd/spear_smi.h

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
* struct spear_smi_flash_info - platform structure for passing flash
3232
* information
3333
*
34-
* name: name of the serial nor flash for identification
35-
* mem_base: the memory base on which the flash is mapped
36-
* size: size of the flash in bytes
37-
* partitions: parition details
38-
* nr_partitions: number of partitions
39-
* fast_mode: whether flash supports fast mode
34+
* @name: name of the serial nor flash for identification
35+
* @mem_base: the memory base on which the flash is mapped
36+
* @size: size of the flash in bytes
37+
* @partitions: parition details
38+
* @nr_partitions: number of partitions
39+
* @fast_mode: whether flash supports fast mode
4040
*/
4141

4242
struct spear_smi_flash_info {
@@ -51,9 +51,10 @@ struct spear_smi_flash_info {
5151
/**
5252
* struct spear_smi_plat_data - platform structure for configuring smi
5353
*
54-
* clk_rate: clk rate at which SMI must operate
55-
* num_flashes: number of flashes present on board
56-
* board_flash_info: specific details of each flash present on board
54+
* @clk_rate: clk rate at which SMI must operate
55+
* @num_flashes: number of flashes present on board
56+
* @board_flash_info: specific details of each flash present on board
57+
* @np: array of DT node pointers for all possible flash chip devices
5758
*/
5859
struct spear_smi_plat_data {
5960
unsigned long clk_rate;

0 commit comments

Comments
 (0)