History

MTD: kernel-doc fixes + additions

Fix some kernel-doc typos/spellos. Use kernel-doc syntax in places where it was almost used. Correct/add struct, struct field, and function param names where needed.

Randy Dunlap committed 20 years ago

Commit ea9b6dc1 parent 844d3b46 files · +69 −59Browse files

Showing the changes to include/linux/mtd (4 of 6 files). Show all

Unified · Split

4 files
  1. include/linux/mtd/bbm.h +19 −16
  2. include/linux/mtd/mtd.h +2 −2
  3. include/linux/mtd/nand.h +0 −3
  4. include/linux/mtd/onenand.h +44 −33
include/linux/mtd/bbm.h+19−16
@@ -19,21 +19,21 @@ · 18 unmodified lines
1919
2020 /**
2121 * struct nand_bbt_descr - bad block table descriptor
22− * @param options options for this descriptor
23− * @param pages the page(s) where we find the bbt, used with
22+ * @options: options for this descriptor
23+ * @pages: the page(s) where we find the bbt, used with
2424 * option BBT_ABSPAGE when bbt is searched,
2525 * then we store the found bbts pages here.
2626 * Its an array and supports up to 8 chips now
27− * @param offs offset of the pattern in the oob area of the page
28− * @param veroffs offset of the bbt version counter in the oob are of the page
29− * @param version version read from the bbt page during scan
30− * @param len length of the pattern, if 0 no pattern check is performed
31− * @param maxblocks maximum number of blocks to search for a bbt. This number of
32− * blocks is reserved at the end of the device
27+ * @offs: offset of the pattern in the oob area of the page
28+ * @veroffs: offset of the bbt version counter in the oob area of the page
29+ * @version: version read from the bbt page during scan
30+ * @len: length of the pattern, if 0 no pattern check is performed
31+ * @maxblocks: maximum number of blocks to search for a bbt. This
32+ * number of blocks is reserved at the end of the device
3333 * where the tables are written.
34− * @param reserved_block_code if non-0, this pattern denotes a reserved
34+ * @reserved_block_code: if non-0, this pattern denotes a reserved
3535 * (rather than bad) block in the stored bbt
36− * @param pattern pattern to identify bad block table or factory marked
36+ * @pattern: pattern to identify bad block table or factory marked
3737 * good / bad blocks, can be NULL, if len = 0
3838 *
3939 * Descriptor for the bad block table marker and the descriptor for the
@@ -93,12 +93,15 @@ struct nand_bbt_descr { · 53 unmodified lines
9393 #define ONENAND_BADBLOCK_POS 0
9494
9595 /**
96− * struct bbt_info - [GENERIC] Bad Block Table data structure
97− * @param bbt_erase_shift [INTERN] number of address bits in a bbt entry
98− * @param badblockpos [INTERN] position of the bad block marker in the oob area
99− * @param bbt [INTERN] bad block table pointer
100− * @param badblock_pattern [REPLACEABLE] bad block scan pattern used for initial bad block scan
101− * @param priv [OPTIONAL] pointer to private bbm date
96+ * struct bbm_info - [GENERIC] Bad Block Table data structure
97+ * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
98+ * @badblockpos: [INTERN] position of the bad block marker in the oob area
99+ * @options: options for this descriptor
100+ * @bbt: [INTERN] bad block table pointer
101+ * @isbad_bbt: function to determine if a block is bad
102+ * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for
103+ * initial bad block scan
104+ * @priv: [OPTIONAL] pointer to private bbm date
102105 */
103106 struct bbm_info {
104107 int bbt_erase_shift;
include/linux/mtd/mtd.h+2−2
@@ -77,11 +77,11 @@ typedef enum { · 76 unmodified lines
7777 *
7878 * @len: number of bytes to write/read. When a data buffer is given
7979 * (datbuf != NULL) this is the number of data bytes. When
80− + no data buffer is available this is the number of oob bytes.
80+ * no data buffer is available this is the number of oob bytes.
8181 *
8282 * @retlen: number of bytes written/read. When a data buffer is given
8383 * (datbuf != NULL) this is the number of data bytes. When
84− + no data buffer is available this is the number of oob bytes.
84+ * no data buffer is available this is the number of oob bytes.
8585 *
8686 * @ooblen: number of oob bytes per page
8787 * @ooboffs: offset of oob data in the oob area (only relevant when
include/linux/mtd/nand.h+0−3
@@ -407,7 +407,6 @@ struct nand_chip { · 406 unmodified lines
407407
408408 /**
409409 * struct nand_flash_dev - NAND Flash Device ID Structure
410− *
411410 * @name: Identify the device type
412411 * @id: device ID code
413412 * @pagesize: Pagesize in bytes. Either 256 or 512 or 0
@@ -526,7 +525,6 @@ extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len, · 112 unmodified lines
526525
527526 /**
528527 * struct platform_nand_chip - chip level device structure
529− *
530528 * @nr_chips: max. number of chips to scan for
531529 * @chip_offset: chip number offset
532530 * @nr_partitions: number of partitions pointed to by partitions (or zero)
@@ -549,7 +547,6 @@ struct platform_nand_chip { · 16 unmodified lines
549547
550548 /**
551549 * struct platform_nand_ctrl - controller level device structure
552− *
553550 * @hwcontrol: platform specific hardware control structure
554551 * @dev_ready: platform specific function to read ready/busy pin
555552 * @select_chip: platform specific chip select function
include/linux/mtd/onenand.h+44−33
@@ -23,7 +23,7 @@ extern int onenand_scan(struct mtd_info *mtd, int max_chips); · 22 unmodified lines
2323 /* Free resources held by the OneNAND device */
2424 extern void onenand_release(struct mtd_info *mtd);
2525
26−/**
26+/*
2727 * onenand_state_t - chip states
2828 * Enumeration for OneNAND flash chip state
2929 */
@@ -42,9 +42,9 @@ typedef enum { · 12 unmodified lines
4242
4343 /**
4444 * struct onenand_bufferram - OneNAND BufferRAM Data
45− * @param block block address in BufferRAM
46− * @param page page address in BufferRAM
47− * @param valid valid flag
45+ * @block: block address in BufferRAM
46+ * @page: page address in BufferRAM
47+ * @valid: valid flag
4848 */
4949 struct onenand_bufferram {
5050 int block;
@@ -54,32 +54,43 @@ struct onenand_bufferram { · 3 unmodified lines
5454
5555 /**
5656 * struct onenand_chip - OneNAND Private Flash Chip Data
57− * @param base [BOARDSPECIFIC] address to access OneNAND
58− * @param chipsize [INTERN] the size of one chip for multichip arrays
59− * @param device_id [INTERN] device ID
60− * @param verstion_id [INTERN] version ID
61− * @param options [BOARDSPECIFIC] various chip options. They can partly be set to inform onenand_scan about
62− * @param erase_shift [INTERN] number of address bits in a block
63− * @param page_shift [INTERN] number of address bits in a page
64− * @param ppb_shift [INTERN] number of address bits in a pages per block
65− * @param page_mask [INTERN] a page per block mask
66− * @param bufferam_index [INTERN] BufferRAM index
67− * @param bufferam [INTERN] BufferRAM info
68− * @param readw [REPLACEABLE] hardware specific function for read short
69− * @param writew [REPLACEABLE] hardware specific function for write short
70− * @param command [REPLACEABLE] hardware specific function for writing commands to the chip
71− * @param wait [REPLACEABLE] hardware specific function for wait on ready
72− * @param read_bufferram [REPLACEABLE] hardware specific function for BufferRAM Area
73− * @param write_bufferram [REPLACEABLE] hardware specific function for BufferRAM Area
74− * @param read_word [REPLACEABLE] hardware specific function for read register of OneNAND
75− * @param write_word [REPLACEABLE] hardware specific function for write register of OneNAND
76− * @param scan_bbt [REPLACEALBE] hardware specific function for scaning Bad block Table
77− * @param chip_lock [INTERN] spinlock used to protect access to this structure and the chip
78− * @param wq [INTERN] wait queue to sleep on if a OneNAND operation is in progress
79− * @param state [INTERN] the current state of the OneNAND device
80− * @param ecclayout [REPLACEABLE] the default ecc placement scheme
81− * @param bbm [REPLACEABLE] pointer to Bad Block Management
82− * @param priv [OPTIONAL] pointer to private chip date
57+ * @base: [BOARDSPECIFIC] address to access OneNAND
58+ * @chipsize: [INTERN] the size of one chip for multichip arrays
59+ * @device_id: [INTERN] device ID
60+ * @density_mask: chip density, used for DDP devices
61+ * @verstion_id: [INTERN] version ID
62+ * @options: [BOARDSPECIFIC] various chip options. They can
63+ * partly be set to inform onenand_scan about
64+ * @erase_shift: [INTERN] number of address bits in a block
65+ * @page_shift: [INTERN] number of address bits in a page
66+ * @ppb_shift: [INTERN] number of address bits in a pages per block
67+ * @page_mask: [INTERN] a page per block mask
68+ * @bufferram_index: [INTERN] BufferRAM index
69+ * @bufferram: [INTERN] BufferRAM info
70+ * @readw: [REPLACEABLE] hardware specific function for read short
71+ * @writew: [REPLACEABLE] hardware specific function for write short
72+ * @command: [REPLACEABLE] hardware specific function for writing
73+ * commands to the chip
74+ * @wait: [REPLACEABLE] hardware specific function for wait on ready
75+ * @read_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area
76+ * @write_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area
77+ * @read_word: [REPLACEABLE] hardware specific function for read
78+ * register of OneNAND
79+ * @write_word: [REPLACEABLE] hardware specific function for write
80+ * register of OneNAND
81+ * @mmcontrol: sync burst read function
82+ * @block_markbad: function to mark a block as bad
83+ * @scan_bbt: [REPLACEALBE] hardware specific function for scanning
84+ * Bad block Table
85+ * @chip_lock: [INTERN] spinlock used to protect access to this
86+ * structure and the chip
87+ * @wq: [INTERN] wait queue to sleep on if a OneNAND
88+ * operation is in progress
89+ * @state: [INTERN] the current state of the OneNAND device
90+ * @page_buf: data buffer
91+ * @ecclayout: [REPLACEABLE] the default ecc placement scheme
92+ * @bbm: [REPLACEABLE] pointer to Bad Block Management
93+ * @priv: [OPTIONAL] pointer to private chip date
8394 */
8495 struct onenand_chip {
8596 void __iomem *base;
@@ -147,9 +158,9 @@ struct onenand_chip { · 61 unmodified lines
147158 #define ONENAND_MFR_SAMSUNG 0xec
148159
149160 /**
150− * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
151− * @param name: Manufacturer name
152− * @param id: manufacturer ID code of device.
161+ * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure
162+ * @name: Manufacturer name
163+ * @id: manufacturer ID code of device.
153164 */
154165 struct onenand_manufacturers {
155166 int id;

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t