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

rapidio: fix new kernel-doc warnings

Fix a bunch of new rapidio kernel-doc warnings:

Warning(include/linux/rio.h:123): No description found for parameter 'comp_tag'
Warning(include/linux/rio.h:123): No description found for parameter 'phys_efptr'
Warning(include/linux/rio.h:123): No description found for parameter 'em_efptr'
Warning(include/linux/rio.h:123): No description found for parameter 'pwcback'
Warning(include/linux/rio.h:247): No description found for parameter 'set_domain'
Warning(include/linux/rio.h:247): No description found for parameter 'get_domain'
Warning(drivers/rapidio/rio-scan.c:1133): No description found for parameter 'rdev'
Warning(drivers/rapidio/rio-scan.c:1133): Excess function parameter 'port' description in 'rio_init_em'
Warning(drivers/rapidio/rio.c:349): No description found for parameter 'rdev'
Warning(drivers/rapidio/rio.c:349): Excess function parameter 'mport' description in 'rio_request_inb_pwrite'
Warning(drivers/rapidio/rio.c:393): No description found for parameter 'port'
Warning(drivers/rapidio/rio.c:393): No description found for parameter 'local'
Warning(drivers/rapidio/rio.c:393): No description found for parameter 'destid'
Warning(drivers/rapidio/rio.c:393): No description found for parameter 'hopcount'
Warning(drivers/rapidio/rio.c:393): Excess function parameter 'rdev' description in 'rio_mport_get_physefb'
Warning(drivers/rapidio/rio.c:845): Excess function parameter 'local' description in 'rio_std_route_clr_table'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Alexandre Bounine <alexandre.bounine@idt.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

Randy Dunlap and committed by
Linus Torvalds
97ef6f74 06b2e988

+13 -5
+1 -1
drivers/rapidio/rio-scan.c
··· 1124 1124 1125 1125 /** 1126 1126 * rio_init_em - Initializes RIO Error Management (for switches) 1127 - * @port: Master port associated with the RIO network 1127 + * @rdev: RIO device 1128 1128 * 1129 1129 * For each enumerated switch, call device-specific error management 1130 1130 * initialization routine (if supplied by the switch driver).
+6 -4
drivers/rapidio/rio.c
··· 338 338 339 339 /** 340 340 * rio_request_inb_pwrite - request inbound port-write message service 341 - * @mport: RIO device to which register inbound port-write callback routine 341 + * @rdev: RIO device to which register inbound port-write callback routine 342 342 * @pwcback: Callback routine to execute when port-write is received 343 343 * 344 344 * Binds a port-write callback function to the RapidIO device. ··· 385 385 /** 386 386 * rio_mport_get_physefb - Helper function that returns register offset 387 387 * for Physical Layer Extended Features Block. 388 - * @rdev: RIO device 388 + * @port: Master port to issue transaction 389 + * @local: Indicate a local master port or remote device access 390 + * @destid: Destination ID of the device 391 + * @hopcount: Number of switch hops to the device 389 392 */ 390 393 u32 391 394 rio_mport_get_physefb(struct rio_mport *port, int local, ··· 433 430 434 431 /** 435 432 * rio_get_comptag - Begin or continue searching for a RIO device by component tag 436 - * @comp_tag: RIO component tad to match 433 + * @comp_tag: RIO component tag to match 437 434 * @from: Previous RIO device found in search, or %NULL for new search 438 435 * 439 436 * Iterates through the list of known RIO devices. If a RIO device is ··· 838 835 * rio_std_route_clr_table - Clear swotch route table using standard registers 839 836 * defined in RIO specification rev.1.3. 840 837 * @mport: Master port to issue transaction 841 - * @local: Indicate a local master port or remote device access 842 838 * @destid: Destination ID of the device 843 839 * @hopcount: Number of switch hops to the device 844 840 * @table: routing table ID (global or port-specific)
+6
include/linux/rio.h
··· 88 88 * @swpinfo: Switch port info 89 89 * @src_ops: Source operation capabilities 90 90 * @dst_ops: Destination operation capabilities 91 + * @comp_tag: RIO component tag 92 + * @phys_efptr: RIO device extended features pointer 93 + * @em_efptr: RIO Error Management features pointer 91 94 * @dma_mask: Mask of bits of RIO address this device implements 92 95 * @rswitch: Pointer to &struct rio_switch if valid for this device 93 96 * @driver: Driver claiming this device 94 97 * @dev: Device model device 95 98 * @riores: RIO resources this device owns 99 + * @pwcback: port-write callback function for this device 96 100 * @destid: Network destination ID 97 101 */ 98 102 struct rio_dev { ··· 226 222 * @add_entry: Callback for switch-specific route add function 227 223 * @get_entry: Callback for switch-specific route get function 228 224 * @clr_table: Callback for switch-specific clear route table function 225 + * @set_domain: Callback for switch-specific domain setting function 226 + * @get_domain: Callback for switch-specific domain get function 229 227 * @em_init: Callback for switch-specific error management initialization function 230 228 * @em_handle: Callback for switch-specific error management handler function 231 229 */