Skip to content

Commit c4bc1ec

Browse files
krzkmiquelraynal
authored andcommitted
mtd: rawnand: marvell: Fix and update kerneldoc
Fix kerneldoc comments and add missing documentation for members to fix W=1 compile warnings like: drivers/mtd/nand/raw/marvell_nand.c:251: warning: cannot understand function prototype: 'struct marvell_hw_ecc_layout ' drivers/mtd/nand/raw/marvell_nand.c:342: warning: Function parameter or member 'layout' not described in 'marvell_nand_chip' Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> Link: https://lore.kernel.org/linux-mtd/20200901142535.12819-5-krzk@kernel.org
1 parent 6ce92fa commit c4bc1ec

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

drivers/mtd/nand/raw/marvell_nand.c

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,8 @@
227227
#define XTYPE_MASK 7
228228

229229
/**
230+
* struct marvell_hw_ecc_layout - layout of Marvell ECC
231+
*
230232
* Marvell ECC engine works differently than the others, in order to limit the
231233
* size of the IP, hardware engineers chose to set a fixed strength at 16 bits
232234
* per subpage, and depending on a the desired strength needed by the NAND chip,
@@ -292,6 +294,8 @@ static const struct marvell_hw_ecc_layout marvell_nfc_layouts[] = {
292294
};
293295

294296
/**
297+
* struct marvell_nand_chip_sel - CS line description
298+
*
295299
* The Nand Flash Controller has up to 4 CE and 2 RB pins. The CE selection
296300
* is made by a field in NDCB0 register, and in another field in NDCB2 register.
297301
* The datasheet describes the logic with an error: ADDR5 field is once
@@ -312,14 +316,15 @@ struct marvell_nand_chip_sel {
312316
};
313317

314318
/**
315-
* NAND chip structure: stores NAND chip device related information
319+
* struct marvell_nand_chip - stores NAND chip device related information
316320
*
317321
* @chip: Base NAND chip structure
318322
* @node: Used to store NAND chips into a list
319-
* @layout NAND layout when using hardware ECC
323+
* @layout: NAND layout when using hardware ECC
320324
* @ndcr: Controller register value for this NAND chip
321325
* @ndtr0: Timing registers 0 value for this NAND chip
322326
* @ndtr1: Timing registers 1 value for this NAND chip
327+
* @addr_cyc: Amount of cycles needed to pass column address
323328
* @selected_die: Current active CS
324329
* @nsels: Number of CS lines required by the NAND chip
325330
* @sels: Array of CS lines descriptions
@@ -349,7 +354,8 @@ static inline struct marvell_nand_chip_sel *to_nand_sel(struct marvell_nand_chip
349354
}
350355

351356
/**
352-
* NAND controller capabilities for distinction between compatible strings
357+
* struct marvell_nfc_caps - NAND controller capabilities for distinction
358+
* between compatible strings
353359
*
354360
* @max_cs_nb: Number of Chip Select lines available
355361
* @max_rb_nb: Number of Ready/Busy lines available
@@ -372,7 +378,7 @@ struct marvell_nfc_caps {
372378
};
373379

374380
/**
375-
* NAND controller structure: stores Marvell NAND controller information
381+
* struct marvell_nfc - stores Marvell NAND controller information
376382
*
377383
* @controller: Base controller structure
378384
* @dev: Parent device (used to print error messages)
@@ -383,7 +389,9 @@ struct marvell_nfc_caps {
383389
* @assigned_cs: Bitmask describing already assigned CS lines
384390
* @chips: List containing all the NAND chips attached to
385391
* this NAND controller
392+
* @selected_chip: Currently selected target chip
386393
* @caps: NAND controller capabilities for each compatible string
394+
* @use_dma: Whetner DMA is used
387395
* @dma_chan: DMA channel (NFCv1 only)
388396
* @dma_buf: 32-bit aligned buffer for DMA transfers (NFCv1 only)
389397
*/
@@ -411,7 +419,8 @@ static inline struct marvell_nfc *to_marvell_nfc(struct nand_controller *ctrl)
411419
}
412420

413421
/**
414-
* NAND controller timings expressed in NAND Controller clock cycles
422+
* struct marvell_nfc_timings - NAND controller timings expressed in NAND
423+
* Controller clock cycles
415424
*
416425
* @tRP: ND_nRE pulse width
417426
* @tRH: ND_nRE high duration
@@ -455,8 +464,8 @@ struct marvell_nfc_timings {
455464
period_ns))
456465

457466
/**
458-
* NAND driver structure filled during the parsing of the ->exec_op() subop
459-
* subset of instructions.
467+
* struct marvell_nfc_op - filled during the parsing of the ->exec_op()
468+
* subop subset of instructions.
460469
*
461470
* @ndcb: Array of values written to NDCBx registers
462471
* @cle_ale_delay_ns: Optional delay after the last CMD or ADDR cycle

0 commit comments

Comments
 (0)