Skip to content

Commit 67c8800

Browse files
Boris Brezillonmiquelraynal
authored andcommitted
mtd: rawnand: sunxi: Fix kernel doc headers
Fix the struct description and use standard kernel-doc header format (even if the file is not parsed by the doc generator). We also replace tabs by a single space. Signed-off-by: Boris Brezillon <[email protected]> Signed-off-by: Miquel Raynal <[email protected]>
1 parent df50579 commit 67c8800

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

drivers/mtd/nand/raw/sunxi_nand.c

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -154,37 +154,36 @@
154154

155155
#define NFC_MAX_CS 7
156156

157-
/*
158-
* Chip Select structure: stores information related to NAND Chip Select
157+
/**
158+
* struct sunxi_nand_chip_sel - stores information related to NAND Chip Select
159159
*
160-
* @cs: the NAND CS id used to communicate with a NAND Chip
161-
* @rb: the Ready/Busy pin ID. -1 means no R/B pin connected to the
162-
* NFC
160+
* @cs: the NAND CS id used to communicate with a NAND Chip
161+
* @rb: the Ready/Busy pin ID. -1 means no R/B pin connected to the NFC
163162
*/
164163
struct sunxi_nand_chip_sel {
165164
u8 cs;
166165
s8 rb;
167166
};
168167

169-
/*
170-
* sunxi HW ECC infos: stores information related to HW ECC support
168+
/**
169+
* struct sunxi_nand_hw_ecc - stores information related to HW ECC support
171170
*
172-
* @mode: the sunxi ECC mode field deduced from ECC requirements
171+
* @mode: the sunxi ECC mode field deduced from ECC requirements
173172
*/
174173
struct sunxi_nand_hw_ecc {
175174
int mode;
176175
};
177176

178-
/*
179-
* NAND chip structure: stores NAND chip device related information
177+
/**
178+
* struct sunxi_nand_chip - stores NAND chip device related information
180179
*
181-
* @node: used to store NAND chips into a list
182-
* @nand: base NAND chip structure
183-
* @mtd: base MTD structure
184-
* @clk_rate: clk_rate required for this NAND chip
185-
* @timing_cfg TIMING_CFG register value for this NAND chip
186-
* @nsels: number of CS lines required by the NAND chip
187-
* @sels: array of CS lines descriptions
180+
* @node: used to store NAND chips into a list
181+
* @nand: base NAND chip structure
182+
* @clk_rate: clk_rate required for this NAND chip
183+
* @timing_cfg: TIMING_CFG register value for this NAND chip
184+
* @timing_ctl: TIMING_CTL register value for this NAND chip
185+
* @nsels: number of CS lines required by the NAND chip
186+
* @sels: array of CS lines descriptions
188187
*/
189188
struct sunxi_nand_chip {
190189
struct list_head node;
@@ -201,20 +200,21 @@ static inline struct sunxi_nand_chip *to_sunxi_nand(struct nand_chip *nand)
201200
return container_of(nand, struct sunxi_nand_chip, nand);
202201
}
203202

204-
/*
205-
* NAND Controller structure: stores sunxi NAND controller information
203+
/**
204+
* struct sunxi_nfc - stores sunxi NAND controller information
206205
*
207-
* @controller: base controller structure
208-
* @dev: parent device (used to print error messages)
209-
* @regs: NAND controller registers
210-
* @ahb_clk: NAND Controller AHB clock
211-
* @mod_clk: NAND Controller mod clock
212-
* @assigned_cs: bitmask describing already assigned CS lines
213-
* @clk_rate: NAND controller current clock rate
214-
* @chips: a list containing all the NAND chips attached to
215-
* this NAND controller
216-
* @complete: a completion object used to wait for NAND
217-
* controller events
206+
* @controller: base controller structure
207+
* @dev: parent device (used to print error messages)
208+
* @regs: NAND controller registers
209+
* @ahb_clk: NAND controller AHB clock
210+
* @mod_clk: NAND controller mod clock
211+
* @reset: NAND controller reset line
212+
* @assigned_cs: bitmask describing already assigned CS lines
213+
* @clk_rate: NAND controller current clock rate
214+
* @chips: a list containing all the NAND chips attached to this NAND
215+
* controller
216+
* @complete: a completion object used to wait for NAND controller events
217+
* @dmac: the DMA channel attached to the NAND controller
218218
*/
219219
struct sunxi_nfc {
220220
struct nand_controller controller;

0 commit comments

Comments
 (0)