Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

mtd: onenand: onenand_base: Fix expected kernel-doc formatting

Fixes the following W=1 kernel build warning(s):

drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'mtd' not described in 'onenand_ooblayout_32_64_ecc'
drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'section' not described in 'onenand_ooblayout_32_64_ecc'
drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'oobregion' not described in 'onenand_ooblayout_32_64_ecc'
drivers/mtd/nand/onenand/onenand_base.c:200: warning: Function parameter or member 'addr' not described in 'onenand_readw'
drivers/mtd/nand/onenand/onenand_base.c:212: warning: Function parameter or member 'value' not described in 'onenand_writew'
drivers/mtd/nand/onenand/onenand_base.c:212: warning: Function parameter or member 'addr' not described in 'onenand_writew'
drivers/mtd/nand/onenand/onenand_base.c:225: warning: Function parameter or member 'this' not described in 'onenand_block_address'
drivers/mtd/nand/onenand/onenand_base.c:225: warning: Function parameter or member 'block' not described in 'onenand_block_address'
drivers/mtd/nand/onenand/onenand_base.c:242: warning: Function parameter or member 'this' not described in 'onenand_bufferram_address'
drivers/mtd/nand/onenand/onenand_base.c:242: warning: Function parameter or member 'block' not described in 'onenand_bufferram_address'

NB: Snipped 200 lines for brevity.

Cc: Kyungmin Park <kyungmin.park@samsung.com>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Richard Weinberger <richard@nod.at>
Cc: Vignesh Raghavendra <vigneshr@ti.com>
Cc: Adrian Hunter <ext-adrian.hunter@nokia.com>
Cc: linux-mtd@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20201109182206.3037326-4-lee.jones@linaro.org

authored by

Lee Jones and committed by
Miquel Raynal
720ae74d 5fddeda7

+219 -219
+219 -219
drivers/mtd/nand/onenand/onenand_base.c
··· 192 192 193 193 /** 194 194 * onenand_readw - [OneNAND Interface] Read OneNAND register 195 - * @param addr address to read 195 + * @addr: address to read 196 196 * 197 197 * Read OneNAND register 198 198 */ ··· 203 203 204 204 /** 205 205 * onenand_writew - [OneNAND Interface] Write OneNAND register with value 206 - * @param value value to write 207 - * @param addr address to write 206 + * @value: value to write 207 + * @addr: address to write 208 208 * 209 209 * Write OneNAND register with value 210 210 */ ··· 215 215 216 216 /** 217 217 * onenand_block_address - [DEFAULT] Get block address 218 - * @param this onenand chip data structure 219 - * @param block the block 218 + * @this: onenand chip data structure 219 + * @block: the block 220 220 * @return translated block address if DDP, otherwise same 221 221 * 222 222 * Setup Start Address 1 Register (F100h) ··· 232 232 233 233 /** 234 234 * onenand_bufferram_address - [DEFAULT] Get bufferram address 235 - * @param this onenand chip data structure 236 - * @param block the block 235 + * @this: onenand chip data structure 236 + * @block: the block 237 237 * @return set DBS value if DDP, otherwise 0 238 238 * 239 239 * Setup Start Address 2 Register (F101h) for DDP ··· 249 249 250 250 /** 251 251 * onenand_page_address - [DEFAULT] Get page address 252 - * @param page the page address 253 - * @param sector the sector address 252 + * @page: the page address 253 + * @sector: the sector address 254 254 * @return combined page and sector address 255 255 * 256 256 * Setup Start Address 8 Register (F107h) ··· 268 268 269 269 /** 270 270 * onenand_buffer_address - [DEFAULT] Get buffer address 271 - * @param dataram1 DataRAM index 272 - * @param sectors the sector address 273 - * @param count the number of sectors 271 + * @dataram1: DataRAM index 272 + * @sectors: the sector address 273 + * @count: the number of sectors 274 274 * @return the start buffer value 275 275 * 276 276 * Setup Start Buffer Register (F200h) ··· 295 295 296 296 /** 297 297 * flexonenand_block- For given address return block number 298 - * @param this - OneNAND device structure 299 - * @param addr - Address for which block number is needed 298 + * @this: - OneNAND device structure 299 + * @addr: - Address for which block number is needed 300 300 */ 301 301 static unsigned flexonenand_block(struct onenand_chip *this, loff_t addr) 302 302 { ··· 359 359 360 360 /** 361 361 * onenand_get_density - [DEFAULT] Get OneNAND density 362 - * @param dev_id OneNAND device ID 362 + * @dev_id: OneNAND device ID 363 363 * 364 364 * Get OneNAND density from device ID 365 365 */ ··· 371 371 372 372 /** 373 373 * flexonenand_region - [Flex-OneNAND] Return erase region of addr 374 - * @param mtd MTD device structure 375 - * @param addr address whose erase region needs to be identified 374 + * @mtd: MTD device structure 375 + * @addr: address whose erase region needs to be identified 376 376 */ 377 377 int flexonenand_region(struct mtd_info *mtd, loff_t addr) 378 378 { ··· 387 387 388 388 /** 389 389 * onenand_command - [DEFAULT] Send command to OneNAND device 390 - * @param mtd MTD device structure 391 - * @param cmd the command to be sent 392 - * @param addr offset to read from or write to 393 - * @param len number of bytes to read or write 390 + * @mtd: MTD device structure 391 + * @cmd: the command to be sent 392 + * @addr: offset to read from or write to 393 + * @len: number of bytes to read or write 394 394 * 395 395 * Send command to OneNAND device. This function is used for middle/large page 396 396 * devices (1KB/2KB Bytes per page) ··· 519 519 520 520 /** 521 521 * onenand_read_ecc - return ecc status 522 - * @param this onenand chip structure 522 + * @this: onenand chip structure 523 523 */ 524 524 static inline int onenand_read_ecc(struct onenand_chip *this) 525 525 { ··· 543 543 544 544 /** 545 545 * onenand_wait - [DEFAULT] wait until the command is done 546 - * @param mtd MTD device structure 547 - * @param state state to select the max. timeout value 546 + * @mtd: MTD device structure 547 + * @state: state to select the max. timeout value 548 548 * 549 549 * Wait for command done. This applies to all OneNAND command 550 550 * Read can take up to 30us, erase up to 2ms and program up to 350us ··· 625 625 626 626 /* 627 627 * onenand_interrupt - [DEFAULT] onenand interrupt handler 628 - * @param irq onenand interrupt number 629 - * @param dev_id interrupt data 628 + * @irq: onenand interrupt number 629 + * @dev_id: interrupt data 630 630 * 631 631 * complete the work 632 632 */ ··· 643 643 644 644 /* 645 645 * onenand_interrupt_wait - [DEFAULT] wait until the command is done 646 - * @param mtd MTD device structure 647 - * @param state state to select the max. timeout value 646 + * @mtd: MTD device structure 647 + * @state: state to select the max. timeout value 648 648 * 649 649 * Wait for command done. 650 650 */ ··· 659 659 660 660 /* 661 661 * onenand_try_interrupt_wait - [DEFAULT] try interrupt wait 662 - * @param mtd MTD device structure 663 - * @param state state to select the max. timeout value 662 + * @mtd: MTD device structure 663 + * @state: state to select the max. timeout value 664 664 * 665 665 * Try interrupt based wait (It is used one-time) 666 666 */ ··· 689 689 690 690 /* 691 691 * onenand_setup_wait - [OneNAND Interface] setup onenand wait method 692 - * @param mtd MTD device structure 692 + * @mtd: MTD device structure 693 693 * 694 694 * There's two method to wait onenand work 695 695 * 1. polling - read interrupt status register ··· 724 724 725 725 /** 726 726 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset 727 - * @param mtd MTD data structure 728 - * @param area BufferRAM area 727 + * @mtd: MTD data structure 728 + * @area: BufferRAM area 729 729 * @return offset given area 730 730 * 731 731 * Return BufferRAM offset given area ··· 747 747 748 748 /** 749 749 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area 750 - * @param mtd MTD data structure 751 - * @param area BufferRAM area 752 - * @param buffer the databuffer to put/get data 753 - * @param offset offset to read from or write to 754 - * @param count number of bytes to read/write 750 + * @mtd: MTD data structure 751 + * @area: BufferRAM area 752 + * @buffer: the databuffer to put/get data 753 + * @offset: offset to read from or write to 754 + * @count: number of bytes to read/write 755 755 * 756 756 * Read the BufferRAM area 757 757 */ ··· 783 783 784 784 /** 785 785 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode 786 - * @param mtd MTD data structure 787 - * @param area BufferRAM area 788 - * @param buffer the databuffer to put/get data 789 - * @param offset offset to read from or write to 790 - * @param count number of bytes to read/write 786 + * @mtd: MTD data structure 787 + * @area: BufferRAM area 788 + * @buffer: the databuffer to put/get data 789 + * @offset: offset to read from or write to 790 + * @count: number of bytes to read/write 791 791 * 792 792 * Read the BufferRAM area with Sync. Burst Mode 793 793 */ ··· 823 823 824 824 /** 825 825 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area 826 - * @param mtd MTD data structure 827 - * @param area BufferRAM area 828 - * @param buffer the databuffer to put/get data 829 - * @param offset offset to read from or write to 830 - * @param count number of bytes to read/write 826 + * @mtd: MTD data structure 827 + * @area: BufferRAM area 828 + * @buffer: the databuffer to put/get data 829 + * @offset: offset to read from or write to 830 + * @count: number of bytes to read/write 831 831 * 832 832 * Write the BufferRAM area 833 833 */ ··· 864 864 865 865 /** 866 866 * onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode 867 - * @param mtd MTD data structure 868 - * @param addr address to check 867 + * @mtd: MTD data structure 868 + * @addr: address to check 869 869 * @return blockpage address 870 870 * 871 871 * Get blockpage address at 2x program mode ··· 888 888 889 889 /** 890 890 * onenand_check_bufferram - [GENERIC] Check BufferRAM information 891 - * @param mtd MTD data structure 892 - * @param addr address to check 891 + * @mtd: MTD data structure 892 + * @addr: address to check 893 893 * @return 1 if there are valid data, otherwise 0 894 894 * 895 895 * Check bufferram if there is data we required ··· 930 930 931 931 /** 932 932 * onenand_update_bufferram - [GENERIC] Update BufferRAM information 933 - * @param mtd MTD data structure 934 - * @param addr address to update 935 - * @param valid valid flag 933 + * @mtd: MTD data structure 934 + * @addr: address to update 935 + * @valid: valid flag 936 936 * 937 937 * Update BufferRAM information 938 938 */ ··· 963 963 964 964 /** 965 965 * onenand_invalidate_bufferram - [GENERIC] Invalidate BufferRAM information 966 - * @param mtd MTD data structure 967 - * @param addr start address to invalidate 968 - * @param len length to invalidate 966 + * @mtd: MTD data structure 967 + * @addr: start address to invalidate 968 + * @len: length to invalidate 969 969 * 970 970 * Invalidate BufferRAM information 971 971 */ ··· 986 986 987 987 /** 988 988 * onenand_get_device - [GENERIC] Get chip for selected access 989 - * @param mtd MTD device structure 990 - * @param new_state the state which is requested 989 + * @mtd: MTD device structure 990 + * @new_state: the state which is requested 991 991 * 992 992 * Get the device and lock it for exclusive access 993 993 */ ··· 1024 1024 1025 1025 /** 1026 1026 * onenand_release_device - [GENERIC] release chip 1027 - * @param mtd MTD device structure 1027 + * @mtd: MTD device structure 1028 1028 * 1029 1029 * Deselect, release chip lock and wake up anyone waiting on the device 1030 1030 */ ··· 1043 1043 1044 1044 /** 1045 1045 * onenand_transfer_auto_oob - [INTERN] oob auto-placement transfer 1046 - * @param mtd MTD device structure 1047 - * @param buf destination address 1048 - * @param column oob offset to read from 1049 - * @param thislen oob length to read 1046 + * @mtd: MTD device structure 1047 + * @buf: destination address 1048 + * @column: oob offset to read from 1049 + * @thislen: oob length to read 1050 1050 */ 1051 1051 static int onenand_transfer_auto_oob(struct mtd_info *mtd, uint8_t *buf, int column, 1052 1052 int thislen) ··· 1061 1061 1062 1062 /** 1063 1063 * onenand_recover_lsb - [Flex-OneNAND] Recover LSB page data 1064 - * @param mtd MTD device structure 1065 - * @param addr address to recover 1066 - * @param status return value from onenand_wait / onenand_bbt_wait 1064 + * @mtd: MTD device structure 1065 + * @addr: address to recover 1066 + * @status: return value from onenand_wait / onenand_bbt_wait 1067 1067 * 1068 1068 * MLC NAND Flash cell has paired pages - LSB page and MSB page. LSB page has 1069 1069 * lower page address and MSB page has higher page address in paired pages. ··· 1104 1104 1105 1105 /** 1106 1106 * onenand_mlc_read_ops_nolock - MLC OneNAND read main and/or out-of-band 1107 - * @param mtd MTD device structure 1108 - * @param from offset to read from 1109 - * @param ops: oob operation description structure 1107 + * @mtd: MTD device structure 1108 + * @from: offset to read from 1109 + * @ops: oob operation description structure 1110 1110 * 1111 1111 * MLC OneNAND / Flex-OneNAND has 4KB page size and 4KB dataram. 1112 1112 * So, read-while-load is not present. ··· 1206 1206 1207 1207 /** 1208 1208 * onenand_read_ops_nolock - [OneNAND Interface] OneNAND read main and/or out-of-band 1209 - * @param mtd MTD device structure 1210 - * @param from offset to read from 1211 - * @param ops: oob operation description structure 1209 + * @mtd: MTD device structure 1210 + * @from: offset to read from 1211 + * @ops: oob operation description structure 1212 1212 * 1213 1213 * OneNAND read main and/or out-of-band data 1214 1214 */ ··· 1335 1335 1336 1336 /** 1337 1337 * onenand_read_oob_nolock - [MTD Interface] OneNAND read out-of-band 1338 - * @param mtd MTD device structure 1339 - * @param from offset to read from 1340 - * @param ops: oob operation description structure 1338 + * @mtd: MTD device structure 1339 + * @from: offset to read from 1340 + * @ops: oob operation description structure 1341 1341 * 1342 1342 * OneNAND read out-of-band data from the spare area 1343 1343 */ ··· 1430 1430 1431 1431 /** 1432 1432 * onenand_read_oob - [MTD Interface] Read main and/or out-of-band 1433 - * @param mtd: MTD device structure 1434 - * @param from: offset to read from 1435 - * @param ops: oob operation description structure 1433 + * @mtd: MTD device structure 1434 + * @from: offset to read from 1435 + * @ops: oob operation description structure 1436 1436 1437 1437 * Read main and/or out-of-band 1438 1438 */ ··· 1466 1466 1467 1467 /** 1468 1468 * onenand_bbt_wait - [DEFAULT] wait until the command is done 1469 - * @param mtd MTD device structure 1470 - * @param state state to select the max. timeout value 1469 + * @mtd: MTD device structure 1470 + * @state: state to select the max. timeout value 1471 1471 * 1472 1472 * Wait for command done. 1473 1473 */ ··· 1517 1517 1518 1518 /** 1519 1519 * onenand_bbt_read_oob - [MTD Interface] OneNAND read out-of-band for bbt scan 1520 - * @param mtd MTD device structure 1521 - * @param from offset to read from 1522 - * @param ops oob operation description structure 1520 + * @mtd: MTD device structure 1521 + * @from: offset to read from 1522 + * @ops: oob operation description structure 1523 1523 * 1524 1524 * OneNAND read out-of-band data from the spare area for bbt scan 1525 1525 */ ··· 1594 1594 #ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE 1595 1595 /** 1596 1596 * onenand_verify_oob - [GENERIC] verify the oob contents after a write 1597 - * @param mtd MTD device structure 1598 - * @param buf the databuffer to verify 1599 - * @param to offset to read from 1597 + * @mtd: MTD device structure 1598 + * @buf: the databuffer to verify 1599 + * @to: offset to read from 1600 1600 */ 1601 1601 static int onenand_verify_oob(struct mtd_info *mtd, const u_char *buf, loff_t to) 1602 1602 { ··· 1622 1622 1623 1623 /** 1624 1624 * onenand_verify - [GENERIC] verify the chip contents after a write 1625 - * @param mtd MTD device structure 1626 - * @param buf the databuffer to verify 1627 - * @param addr offset to read from 1628 - * @param len number of bytes to read and compare 1625 + * @mtd: MTD device structure 1626 + * @buf: the databuffer to verify 1627 + * @addr: offset to read from 1628 + * @len: number of bytes to read and compare 1629 1629 */ 1630 1630 static int onenand_verify(struct mtd_info *mtd, const u_char *buf, loff_t addr, size_t len) 1631 1631 { ··· 1684 1684 1685 1685 /** 1686 1686 * onenand_panic_write - [MTD Interface] write buffer to FLASH in a panic context 1687 - * @param mtd MTD device structure 1688 - * @param to offset to write to 1689 - * @param len number of bytes to write 1690 - * @param retlen pointer to variable to store the number of written bytes 1691 - * @param buf the data to write 1687 + * @mtd: MTD device structure 1688 + * @to: offset to write to 1689 + * @len: number of bytes to write 1690 + * @retlen: pointer to variable to store the number of written bytes 1691 + * @buf: the data to write 1692 1692 * 1693 1693 * Write with ECC 1694 1694 */ ··· 1762 1762 1763 1763 /** 1764 1764 * onenand_fill_auto_oob - [INTERN] oob auto-placement transfer 1765 - * @param mtd MTD device structure 1766 - * @param oob_buf oob buffer 1767 - * @param buf source address 1768 - * @param column oob offset to write to 1769 - * @param thislen oob length to write 1765 + * @mtd: MTD device structure 1766 + * @oob_buf: oob buffer 1767 + * @buf: source address 1768 + * @column: oob offset to write to 1769 + * @thislen: oob length to write 1770 1770 */ 1771 1771 static int onenand_fill_auto_oob(struct mtd_info *mtd, u_char *oob_buf, 1772 1772 const u_char *buf, int column, int thislen) ··· 1776 1776 1777 1777 /** 1778 1778 * onenand_write_ops_nolock - [OneNAND Interface] write main and/or out-of-band 1779 - * @param mtd MTD device structure 1780 - * @param to offset to write to 1781 - * @param ops oob operation description structure 1779 + * @mtd: MTD device structure 1780 + * @to: offset to write to 1781 + * @ops: oob operation description structure 1782 1782 * 1783 1783 * Write main and/or oob with ECC 1784 1784 */ ··· 1957 1957 1958 1958 /** 1959 1959 * onenand_write_oob_nolock - [INTERN] OneNAND write out-of-band 1960 - * @param mtd MTD device structure 1961 - * @param to offset to write to 1962 - * @param len number of bytes to write 1963 - * @param retlen pointer to variable to store the number of written bytes 1964 - * @param buf the data to write 1965 - * @param mode operation mode 1960 + * @mtd: MTD device structure 1961 + * @to: offset to write to 1962 + * @len: number of bytes to write 1963 + * @retlen: pointer to variable to store the number of written bytes 1964 + * @buf: the data to write 1965 + * @mode: operation mode 1966 1966 * 1967 1967 * OneNAND write out-of-band 1968 1968 */ ··· 2070 2070 2071 2071 /** 2072 2072 * onenand_write_oob - [MTD Interface] NAND write data and/or out-of-band 2073 - * @param mtd: MTD device structure 2074 - * @param to: offset to write 2075 - * @param ops: oob operation description structure 2073 + * @mtd: MTD device structure 2074 + * @to: offset to write 2075 + * @ops: oob operation description structure 2076 2076 */ 2077 2077 static int onenand_write_oob(struct mtd_info *mtd, loff_t to, 2078 2078 struct mtd_oob_ops *ops) ··· 2101 2101 2102 2102 /** 2103 2103 * onenand_block_isbad_nolock - [GENERIC] Check if a block is marked bad 2104 - * @param mtd MTD device structure 2105 - * @param ofs offset from device start 2106 - * @param allowbbt 1, if its allowed to access the bbt area 2104 + * @mtd: MTD device structure 2105 + * @ofs: offset from device start 2106 + * @allowbbt: 1, if its allowed to access the bbt area 2107 2107 * 2108 2108 * Check, if the block is bad. Either by reading the bad block table or 2109 2109 * calling of the scan function. ··· 2144 2144 2145 2145 /** 2146 2146 * onenand_multiblock_erase - [INTERN] erase block(s) using multiblock erase 2147 - * @param mtd MTD device structure 2148 - * @param instr erase instruction 2149 - * @param region erase region 2147 + * @mtd: MTD device structure 2148 + * @instr: erase instruction 2149 + * @region: erase region 2150 2150 * 2151 2151 * Erase one or more blocks up to 64 block at a time 2152 2152 */ ··· 2254 2254 2255 2255 /** 2256 2256 * onenand_block_by_block_erase - [INTERN] erase block(s) using regular erase 2257 - * @param mtd MTD device structure 2258 - * @param instr erase instruction 2259 - * @param region erase region 2260 - * @param block_size erase block size 2257 + * @mtd: MTD device structure 2258 + * @instr: erase instruction 2259 + * @region: erase region 2260 + * @block_size: erase block size 2261 2261 * 2262 2262 * Erase one or more blocks one block at a time 2263 2263 */ ··· 2326 2326 2327 2327 /** 2328 2328 * onenand_erase - [MTD Interface] erase block(s) 2329 - * @param mtd MTD device structure 2330 - * @param instr erase instruction 2329 + * @mtd: MTD device structure 2330 + * @instr: erase instruction 2331 2331 * 2332 2332 * Erase one or more blocks 2333 2333 */ ··· 2391 2391 2392 2392 /** 2393 2393 * onenand_sync - [MTD Interface] sync 2394 - * @param mtd MTD device structure 2394 + * @mtd: MTD device structure 2395 2395 * 2396 2396 * Sync is actually a wait for chip ready function 2397 2397 */ ··· 2408 2408 2409 2409 /** 2410 2410 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad 2411 - * @param mtd MTD device structure 2412 - * @param ofs offset relative to mtd start 2411 + * @mtd: MTD device structure 2412 + * @ofs: offset relative to mtd start 2413 2413 * 2414 2414 * Check whether the block is bad 2415 2415 */ ··· 2425 2425 2426 2426 /** 2427 2427 * onenand_default_block_markbad - [DEFAULT] mark a block bad 2428 - * @param mtd MTD device structure 2429 - * @param ofs offset from device start 2428 + * @mtd: MTD device structure 2429 + * @ofs: offset from device start 2430 2430 * 2431 2431 * This is the default implementation, which can be overridden by 2432 2432 * a hardware specific driver. ··· 2460 2460 2461 2461 /** 2462 2462 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad 2463 - * @param mtd MTD device structure 2464 - * @param ofs offset relative to mtd start 2463 + * @mtd: MTD device structure 2464 + * @ofs: offset relative to mtd start 2465 2465 * 2466 2466 * Mark the block as bad 2467 2467 */ ··· 2486 2486 2487 2487 /** 2488 2488 * onenand_do_lock_cmd - [OneNAND Interface] Lock or unlock block(s) 2489 - * @param mtd MTD device structure 2490 - * @param ofs offset relative to mtd start 2491 - * @param len number of bytes to lock or unlock 2492 - * @param cmd lock or unlock command 2489 + * @mtd: MTD device structure 2490 + * @ofs: offset relative to mtd start 2491 + * @len: number of bytes to lock or unlock 2492 + * @cmd: lock or unlock command 2493 2493 * 2494 2494 * Lock or unlock one or more blocks 2495 2495 */ ··· 2566 2566 2567 2567 /** 2568 2568 * onenand_lock - [MTD Interface] Lock block(s) 2569 - * @param mtd MTD device structure 2570 - * @param ofs offset relative to mtd start 2571 - * @param len number of bytes to unlock 2569 + * @mtd: MTD device structure 2570 + * @ofs: offset relative to mtd start 2571 + * @len: number of bytes to unlock 2572 2572 * 2573 2573 * Lock one or more blocks 2574 2574 */ ··· 2584 2584 2585 2585 /** 2586 2586 * onenand_unlock - [MTD Interface] Unlock block(s) 2587 - * @param mtd MTD device structure 2588 - * @param ofs offset relative to mtd start 2589 - * @param len number of bytes to unlock 2587 + * @mtd: MTD device structure 2588 + * @ofs: offset relative to mtd start 2589 + * @len: number of bytes to unlock 2590 2590 * 2591 2591 * Unlock one or more blocks 2592 2592 */ ··· 2602 2602 2603 2603 /** 2604 2604 * onenand_check_lock_status - [OneNAND Interface] Check lock status 2605 - * @param this onenand chip data structure 2605 + * @this: onenand chip data structure 2606 2606 * 2607 2607 * Check lock status 2608 2608 */ ··· 2636 2636 2637 2637 /** 2638 2638 * onenand_unlock_all - [OneNAND Interface] unlock all blocks 2639 - * @param mtd MTD device structure 2639 + * @mtd: MTD device structure 2640 2640 * 2641 2641 * Unlock all blocks 2642 2642 */ ··· 2683 2683 2684 2684 /** 2685 2685 * onenand_otp_command - Send OTP specific command to OneNAND device 2686 - * @param mtd MTD device structure 2687 - * @param cmd the command to be sent 2688 - * @param addr offset to read from or write to 2689 - * @param len number of bytes to read or write 2686 + * @mtd: MTD device structure 2687 + * @cmd: the command to be sent 2688 + * @addr: offset to read from or write to 2689 + * @len: number of bytes to read or write 2690 2690 */ 2691 2691 static int onenand_otp_command(struct mtd_info *mtd, int cmd, loff_t addr, 2692 2692 size_t len) ··· 2758 2758 2759 2759 /** 2760 2760 * onenand_otp_write_oob_nolock - [INTERN] OneNAND write out-of-band, specific to OTP 2761 - * @param mtd MTD device structure 2762 - * @param to offset to write to 2763 - * @param len number of bytes to write 2764 - * @param retlen pointer to variable to store the number of written bytes 2765 - * @param buf the data to write 2761 + * @mtd: MTD device structure 2762 + * @to: offset to write to 2763 + * @len: number of bytes to write 2764 + * @retlen: pointer to variable to store the number of written bytes 2765 + * @buf: the data to write 2766 2766 * 2767 2767 * OneNAND write out-of-band only for OTP 2768 2768 */ ··· 2889 2889 2890 2890 /** 2891 2891 * do_otp_read - [DEFAULT] Read OTP block area 2892 - * @param mtd MTD device structure 2893 - * @param from The offset to read 2894 - * @param len number of bytes to read 2895 - * @param retlen pointer to variable to store the number of readbytes 2896 - * @param buf the databuffer to put/get data 2892 + * @mtd: MTD device structure 2893 + * @from: The offset to read 2894 + * @len: number of bytes to read 2895 + * @retlen: pointer to variable to store the number of readbytes 2896 + * @buf: the databuffer to put/get data 2897 2897 * 2898 2898 * Read OTP block area. 2899 2899 */ ··· 2926 2926 2927 2927 /** 2928 2928 * do_otp_write - [DEFAULT] Write OTP block area 2929 - * @param mtd MTD device structure 2930 - * @param to The offset to write 2931 - * @param len number of bytes to write 2932 - * @param retlen pointer to variable to store the number of write bytes 2933 - * @param buf the databuffer to put/get data 2929 + * @mtd: MTD device structure 2930 + * @to: The offset to write 2931 + * @len: number of bytes to write 2932 + * @retlen: pointer to variable to store the number of write bytes 2933 + * @buf: the databuffer to put/get data 2934 2934 * 2935 2935 * Write OTP block area. 2936 2936 */ ··· 2970 2970 2971 2971 /** 2972 2972 * do_otp_lock - [DEFAULT] Lock OTP block area 2973 - * @param mtd MTD device structure 2974 - * @param from The offset to lock 2975 - * @param len number of bytes to lock 2976 - * @param retlen pointer to variable to store the number of lock bytes 2977 - * @param buf the databuffer to put/get data 2973 + * @mtd: MTD device structure 2974 + * @from: The offset to lock 2975 + * @len: number of bytes to lock 2976 + * @retlen: pointer to variable to store the number of lock bytes 2977 + * @buf: the databuffer to put/get data 2978 2978 * 2979 2979 * Lock OTP block area. 2980 2980 */ ··· 3018 3018 3019 3019 /** 3020 3020 * onenand_otp_walk - [DEFAULT] Handle OTP operation 3021 - * @param mtd MTD device structure 3022 - * @param from The offset to read/write 3023 - * @param len number of bytes to read/write 3024 - * @param retlen pointer to variable to store the number of read bytes 3025 - * @param buf the databuffer to put/get data 3026 - * @param action do given action 3027 - * @param mode specify user and factory 3021 + * @mtd: MTD device structure 3022 + * @from: The offset to read/write 3023 + * @len: number of bytes to read/write 3024 + * @retlen: pointer to variable to store the number of read bytes 3025 + * @buf: the databuffer to put/get data 3026 + * @action: do given action 3027 + * @mode: specify user and factory 3028 3028 * 3029 3029 * Handle OTP operation. 3030 3030 */ ··· 3099 3099 3100 3100 /** 3101 3101 * onenand_get_fact_prot_info - [MTD Interface] Read factory OTP info 3102 - * @param mtd MTD device structure 3103 - * @param len number of bytes to read 3104 - * @param retlen pointer to variable to store the number of read bytes 3105 - * @param buf the databuffer to put/get data 3102 + * @mtd: MTD device structure 3103 + * @len: number of bytes to read 3104 + * @retlen: pointer to variable to store the number of read bytes 3105 + * @buf: the databuffer to put/get data 3106 3106 * 3107 3107 * Read factory OTP info. 3108 3108 */ ··· 3115 3115 3116 3116 /** 3117 3117 * onenand_read_fact_prot_reg - [MTD Interface] Read factory OTP area 3118 - * @param mtd MTD device structure 3119 - * @param from The offset to read 3120 - * @param len number of bytes to read 3121 - * @param retlen pointer to variable to store the number of read bytes 3122 - * @param buf the databuffer to put/get data 3118 + * @mtd: MTD device structure 3119 + * @from: The offset to read 3120 + * @len: number of bytes to read 3121 + * @retlen: pointer to variable to store the number of read bytes 3122 + * @buf: the databuffer to put/get data 3123 3123 * 3124 3124 * Read factory OTP area. 3125 3125 */ ··· 3131 3131 3132 3132 /** 3133 3133 * onenand_get_user_prot_info - [MTD Interface] Read user OTP info 3134 - * @param mtd MTD device structure 3135 - * @param retlen pointer to variable to store the number of read bytes 3136 - * @param len number of bytes to read 3137 - * @param buf the databuffer to put/get data 3134 + * @mtd: MTD device structure 3135 + * @retlen: pointer to variable to store the number of read bytes 3136 + * @len: number of bytes to read 3137 + * @buf: the databuffer to put/get data 3138 3138 * 3139 3139 * Read user OTP info. 3140 3140 */ ··· 3147 3147 3148 3148 /** 3149 3149 * onenand_read_user_prot_reg - [MTD Interface] Read user OTP area 3150 - * @param mtd MTD device structure 3151 - * @param from The offset to read 3152 - * @param len number of bytes to read 3153 - * @param retlen pointer to variable to store the number of read bytes 3154 - * @param buf the databuffer to put/get data 3150 + * @mtd: MTD device structure 3151 + * @from: The offset to read 3152 + * @len: number of bytes to read 3153 + * @retlen: pointer to variable to store the number of read bytes 3154 + * @buf: the databuffer to put/get data 3155 3155 * 3156 3156 * Read user OTP area. 3157 3157 */ ··· 3163 3163 3164 3164 /** 3165 3165 * onenand_write_user_prot_reg - [MTD Interface] Write user OTP area 3166 - * @param mtd MTD device structure 3167 - * @param from The offset to write 3168 - * @param len number of bytes to write 3169 - * @param retlen pointer to variable to store the number of write bytes 3170 - * @param buf the databuffer to put/get data 3166 + * @mtd: MTD device structure 3167 + * @from: The offset to write 3168 + * @len: number of bytes to write 3169 + * @retlen: pointer to variable to store the number of write bytes 3170 + * @buf: the databuffer to put/get data 3171 3171 * 3172 3172 * Write user OTP area. 3173 3173 */ ··· 3179 3179 3180 3180 /** 3181 3181 * onenand_lock_user_prot_reg - [MTD Interface] Lock user OTP area 3182 - * @param mtd MTD device structure 3183 - * @param from The offset to lock 3184 - * @param len number of bytes to unlock 3182 + * @mtd: MTD device structure 3183 + * @from: The offset to lock 3184 + * @len: number of bytes to unlock 3185 3185 * 3186 3186 * Write lock mark on spare area in page 0 in OTP block 3187 3187 */ ··· 3234 3234 3235 3235 /** 3236 3236 * onenand_check_features - Check and set OneNAND features 3237 - * @param mtd MTD data structure 3237 + * @mtd: MTD data structure 3238 3238 * 3239 3239 * Check and set OneNAND features 3240 3240 * - lock scheme ··· 3324 3324 3325 3325 /** 3326 3326 * onenand_print_device_info - Print device & version ID 3327 - * @param device device ID 3328 - * @param version version ID 3327 + * @device: device ID 3328 + * @version: version ID 3329 3329 * 3330 3330 * Print device & version ID 3331 3331 */ ··· 3355 3355 3356 3356 /** 3357 3357 * onenand_check_maf - Check manufacturer ID 3358 - * @param manuf manufacturer ID 3358 + * @manuf: manufacturer ID 3359 3359 * 3360 3360 * Check manufacturer ID 3361 3361 */ ··· 3381 3381 3382 3382 /** 3383 3383 * flexonenand_get_boundary - Reads the SLC boundary 3384 - * @param onenand_info - onenand info structure 3384 + * @onenand_info: - onenand info structure 3385 3385 **/ 3386 3386 static int flexonenand_get_boundary(struct mtd_info *mtd) 3387 3387 { ··· 3422 3422 /** 3423 3423 * flexonenand_get_size - Fill up fields in onenand_chip and mtd_info 3424 3424 * boundary[], diesize[], mtd->size, mtd->erasesize 3425 - * @param mtd - MTD device structure 3425 + * @mtd: - MTD device structure 3426 3426 */ 3427 3427 static void flexonenand_get_size(struct mtd_info *mtd) 3428 3428 { ··· 3493 3493 3494 3494 /** 3495 3495 * flexonenand_check_blocks_erased - Check if blocks are erased 3496 - * @param mtd_info - mtd info structure 3497 - * @param start - first erase block to check 3498 - * @param end - last erase block to check 3496 + * @mtd_info: - mtd info structure 3497 + * @start: - first erase block to check 3498 + * @end: - last erase block to check 3499 3499 * 3500 3500 * Converting an unerased block from MLC to SLC 3501 3501 * causes byte values to change. Since both data and its ECC ··· 3550 3550 3551 3551 /** 3552 3552 * flexonenand_set_boundary - Writes the SLC boundary 3553 - * @param mtd - mtd info structure 3553 + * @mtd: - mtd info structure 3554 3554 */ 3555 3555 static int flexonenand_set_boundary(struct mtd_info *mtd, int die, 3556 3556 int boundary, int lock) ··· 3640 3640 3641 3641 /** 3642 3642 * onenand_chip_probe - [OneNAND Interface] The generic chip probe 3643 - * @param mtd MTD device structure 3643 + * @mtd: MTD device structure 3644 3644 * 3645 3645 * OneNAND detection method: 3646 3646 * Compare the values from command with ones from register ··· 3688 3688 3689 3689 /** 3690 3690 * onenand_probe - [OneNAND Interface] Probe the OneNAND device 3691 - * @param mtd MTD device structure 3691 + * @mtd: MTD device structure 3692 3692 */ 3693 3693 static int onenand_probe(struct mtd_info *mtd) 3694 3694 { ··· 3783 3783 3784 3784 /** 3785 3785 * onenand_suspend - [MTD Interface] Suspend the OneNAND flash 3786 - * @param mtd MTD device structure 3786 + * @mtd: MTD device structure 3787 3787 */ 3788 3788 static int onenand_suspend(struct mtd_info *mtd) 3789 3789 { ··· 3792 3792 3793 3793 /** 3794 3794 * onenand_resume - [MTD Interface] Resume the OneNAND flash 3795 - * @param mtd MTD device structure 3795 + * @mtd: MTD device structure 3796 3796 */ 3797 3797 static void onenand_resume(struct mtd_info *mtd) 3798 3798 { ··· 3807 3807 3808 3808 /** 3809 3809 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device 3810 - * @param mtd MTD device structure 3811 - * @param maxchips Number of chips to scan for 3810 + * @mtd: MTD device structure 3811 + * @maxchips: Number of chips to scan for 3812 3812 * 3813 3813 * This fills out all the not initialized function pointers 3814 3814 * with the defaults. ··· 3985 3985 3986 3986 /** 3987 3987 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device 3988 - * @param mtd MTD device structure 3988 + * @mtd: MTD device structure 3989 3989 */ 3990 3990 void onenand_release(struct mtd_info *mtd) 3991 3991 {