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.
Unified · Split
| @@ -109,7 +109,7 @@ · 108 unmodified lines | ||
| 109 | 109 | for most of the implementations. These functions can be replaced by the |
| 110 | 110 | board driver if neccecary. Those functions are called via pointers in the |
| 111 | 111 | NAND chip description structure. The board driver can set the functions which |
| 112 | − should be replaced by board dependend functions before calling nand_scan(). | |
| 112 | + should be replaced by board dependent functions before calling nand_scan(). | |
| 113 | 113 | If the function pointer is NULL on entry to nand_scan() then the pointer |
| 114 | 114 | is set to the default function which is suitable for the detected chip type. |
| 115 | 115 | </para></listitem> |
| @@ -133,7 +133,7 @@ · 17 unmodified lines | ||
| 133 | 133 | [REPLACEABLE]</para><para> |
| 134 | 134 | Replaceable members hold hardware related functions which can be |
| 135 | 135 | provided by the board driver. The board driver can set the functions which |
| 136 | − should be replaced by board dependend functions before calling nand_scan(). | |
| 136 | + should be replaced by board dependent functions before calling nand_scan(). | |
| 137 | 137 | If the function pointer is NULL on entry to nand_scan() then the pointer |
| 138 | 138 | is set to the default function which is suitable for the detected chip type. |
| 139 | 139 | </para></listitem> |
| @@ -156,9 +156,8 @@ · 16 unmodified lines | ||
| 156 | 156 | <title>Basic board driver</title> |
| 157 | 157 | <para> |
| 158 | 158 | For most boards it will be sufficient to provide just the |
| 159 | − basic functions and fill out some really board dependend | |
| 159 | + basic functions and fill out some really board dependent | |
| 160 | 160 | members in the nand chip description structure. |
| 161 | − See drivers/mtd/nand/skeleton for reference. | |
| 162 | 161 | </para> |
| 163 | 162 | <sect1> |
| 164 | 163 | <title>Basic defines</title> |
| @@ -19,21 +19,21 @@ · 18 unmodified lines | ||
| 19 | 19 | |
| 20 | 20 | /** |
| 21 | 21 | * 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 | |
| 24 | 24 | * option BBT_ABSPAGE when bbt is searched, |
| 25 | 25 | * then we store the found bbts pages here. |
| 26 | 26 | * 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 | |
| 33 | 33 | * 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 | |
| 35 | 35 | * (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 | |
| 37 | 37 | * good / bad blocks, can be NULL, if len = 0 |
| 38 | 38 | * |
| 39 | 39 | * Descriptor for the bad block table marker and the descriptor for the |
| @@ -93,12 +93,15 @@ struct nand_bbt_descr { · 53 unmodified lines | ||
| 93 | 93 | #define ONENAND_BADBLOCK_POS 0 |
| 94 | 94 | |
| 95 | 95 | /** |
| 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 | |
| 102 | 105 | */ |
| 103 | 106 | struct bbm_info { |
| 104 | 107 | int bbt_erase_shift; |
| @@ -77,11 +77,11 @@ typedef enum { · 76 unmodified lines | ||
| 77 | 77 | * |
| 78 | 78 | * @len: number of bytes to write/read. When a data buffer is given |
| 79 | 79 | * (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. | |
| 81 | 81 | * |
| 82 | 82 | * @retlen: number of bytes written/read. When a data buffer is given |
| 83 | 83 | * (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. | |
| 85 | 85 | * |
| 86 | 86 | * @ooblen: number of oob bytes per page |
| 87 | 87 | * @ooboffs: offset of oob data in the oob area (only relevant when |
| @@ -407,7 +407,6 @@ struct nand_chip { · 406 unmodified lines | ||
| 407 | 407 | |
| 408 | 408 | /** |
| 409 | 409 | * struct nand_flash_dev - NAND Flash Device ID Structure |
| 410 | − * | |
| 411 | 410 | * @name: Identify the device type |
| 412 | 411 | * @id: device ID code |
| 413 | 412 | * @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 | ||
| 526 | 525 | |
| 527 | 526 | /** |
| 528 | 527 | * struct platform_nand_chip - chip level device structure |
| 529 | − * | |
| 530 | 528 | * @nr_chips: max. number of chips to scan for |
| 531 | 529 | * @chip_offset: chip number offset |
| 532 | 530 | * @nr_partitions: number of partitions pointed to by partitions (or zero) |
| @@ -549,7 +547,6 @@ struct platform_nand_chip { · 16 unmodified lines | ||
| 549 | 547 | |
| 550 | 548 | /** |
| 551 | 549 | * struct platform_nand_ctrl - controller level device structure |
| 552 | − * | |
| 553 | 550 | * @hwcontrol: platform specific hardware control structure |
| 554 | 551 | * @dev_ready: platform specific function to read ready/busy pin |
| 555 | 552 | * @select_chip: platform specific chip select function |
| @@ -23,7 +23,7 @@ extern int onenand_scan(struct mtd_info *mtd, int max_chips); · 22 unmodified lines | ||
| 23 | 23 | /* Free resources held by the OneNAND device */ |
| 24 | 24 | extern void onenand_release(struct mtd_info *mtd); |
| 25 | 25 | |
| 26 | −/** | |
| 26 | +/* | |
| 27 | 27 | * onenand_state_t - chip states |
| 28 | 28 | * Enumeration for OneNAND flash chip state |
| 29 | 29 | */ |
| @@ -42,9 +42,9 @@ typedef enum { · 12 unmodified lines | ||
| 42 | 42 | |
| 43 | 43 | /** |
| 44 | 44 | * 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 | |
| 48 | 48 | */ |
| 49 | 49 | struct onenand_bufferram { |
| 50 | 50 | int block; |
| @@ -54,32 +54,43 @@ struct onenand_bufferram { · 3 unmodified lines | ||
| 54 | 54 | |
| 55 | 55 | /** |
| 56 | 56 | * 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 | |
| 83 | 94 | */ |
| 84 | 95 | struct onenand_chip { |
| 85 | 96 | void __iomem *base; |
| @@ -147,9 +158,9 @@ struct onenand_chip { · 61 unmodified lines | ||
| 147 | 158 | #define ONENAND_MFR_SAMSUNG 0xec |
| 148 | 159 | |
| 149 | 160 | /** |
| 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. | |
| 153 | 164 | */ |
| 154 | 165 | struct onenand_manufacturers { |
| 155 | 166 | int id; |
| @@ -133,7 +133,7 @@ struct nand_ecclayout { · 132 unmodified lines | ||
| 133 | 133 | }; |
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | − * struct mtd_ecc_stats - error correction status | |
| 136 | + * struct mtd_ecc_stats - error correction stats | |
| 137 | 137 | * |
| 138 | 138 | * @corrected: number of corrected bits |
| 139 | 139 | * @failed: number of uncorrectable errors |