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>

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>
Randy Dunlap · Linus Torvalds
1 parent 06b2e9886e
Showing 3 changed files with 13 additions and 5 deletions Side-by-side Diff
drivers/rapidio/rio-scan.c
drivers/rapidio/rio.c
include/linux/rio.h
@@ -1124,7 +1124,7 @@
  
 /**
  * rio_init_em - Initializes RIO Error Management (for switches)
- * @port: Master port associated with the RIO network
+ * @rdev: RIO device
  *
  * For each enumerated switch, call device-specific error management
  * initialization routine (if supplied by the switch driver).
@@ -338,7 +338,7 @@
  
 /**
  * rio_request_inb_pwrite - request inbound port-write message service
- * @mport: RIO device to which register inbound port-write callback routine
+ * @rdev: RIO device to which register inbound port-write callback routine
  * @pwcback: Callback routine to execute when port-write is received
  *
  * Binds a port-write callback function to the RapidIO device.
@@ -385,7 +385,10 @@
 /**
  * rio_mport_get_physefb - Helper function that returns register offset
  *                      for Physical Layer Extended Features Block.
- * @rdev: RIO device
+ * @port: Master port to issue transaction
+ * @local: Indicate a local master port or remote device access
+ * @destid: Destination ID of the device
+ * @hopcount: Number of switch hops to the device
  */
 u32
 rio_mport_get_physefb(struct rio_mport *port, int local,
@@ -430,7 +433,7 @@
  
 /**
  * rio_get_comptag - Begin or continue searching for a RIO device by component tag
- * @comp_tag: RIO component tad to match
+ * @comp_tag: RIO component tag to match
  * @from: Previous RIO device found in search, or %NULL for new search
  *
  * Iterates through the list of known RIO devices. If a RIO device is
@@ -835,7 +838,6 @@
  * rio_std_route_clr_table - Clear swotch route table using standard registers
  *   defined in RIO specification rev.1.3.
  * @mport: Master port to issue transaction
- * @local: Indicate a local master port or remote device access
  * @destid: Destination ID of the device
  * @hopcount: Number of switch hops to the device
  * @table: routing table ID (global or port-specific)
@@ -88,11 +88,15 @@
  * @swpinfo: Switch port info
  * @src_ops: Source operation capabilities
  * @dst_ops: Destination operation capabilities
+ * @comp_tag: RIO component tag
+ * @phys_efptr: RIO device extended features pointer
+ * @em_efptr: RIO Error Management features pointer
  * @dma_mask: Mask of bits of RIO address this device implements
  * @rswitch: Pointer to &struct rio_switch if valid for this device
  * @driver: Driver claiming this device
  * @dev: Device model device
  * @riores: RIO resources this device owns
+ * @pwcback: port-write callback function for this device
  * @destid: Network destination ID
  */
 struct rio_dev {
@@ -222,6 +226,8 @@
  * @add_entry: Callback for switch-specific route add function
  * @get_entry: Callback for switch-specific route get function
  * @clr_table: Callback for switch-specific clear route table function
+ * @set_domain: Callback for switch-specific domain setting function
+ * @get_domain: Callback for switch-specific domain get function
  * @em_init: Callback for switch-specific error management initialization function
  * @em_handle: Callback for switch-specific error management handler function
  */
...	...	@@ -1124,7 +1124,7 @@
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).
...	...	@@ -338,7 +338,7 @@
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,7 +385,10 @@
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,
...	...	@@ -430,7 +433,7 @@
430	433
431	434	/**
432	435	* rio_get_comptag - Begin or continue searching for a RIO device by component tag
433		- * @comp_tag: RIO component tad to match
	436	+ * @comp_tag: RIO component tag to match
434	437	* @from: Previous RIO device found in search, or %NULL for new search
435	438	*
436	439	* Iterates through the list of known RIO devices. If a RIO device is
...	...	@@ -835,7 +838,6 @@
835	838	* rio_std_route_clr_table - Clear swotch route table using standard registers
836	839	* defined in RIO specification rev.1.3.
837	840	* @mport: Master port to issue transaction
838		- * @local: Indicate a local master port or remote device access
839	841	* @destid: Destination ID of the device
840	842	* @hopcount: Number of switch hops to the device
841	843	* @table: routing table ID (global or port-specific)
...	...	@@ -88,11 +88,15 @@
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 {
...	...	@@ -222,6 +226,8 @@
222	226	* @add_entry: Callback for switch-specific route add function
223	227	* @get_entry: Callback for switch-specific route get function
224	228	* @clr_table: Callback for switch-specific clear route table function
	229	+ * @set_domain: Callback for switch-specific domain setting function
	230	+ * @get_domain: Callback for switch-specific domain get function
225	231	* @em_init: Callback for switch-specific error management initialization function
226	232	* @em_handle: Callback for switch-specific error management handler function
227	233	*/