diff options
author | Randy Dunlap <rdunlap@infradead.org> | 2018-09-04 17:02:23 -0700 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2018-09-06 09:41:09 -0600 |
commit | 226b18ad5589550e989afce6b293580abc880a79 (patch) | |
tree | 46c859f0e781b72902ebcb83d5b8b7c16b783a05 /drivers/firewire | |
parent | 48f02b88c82b5aaf51adbce0932e47a3044e35d4 (diff) | |
download | linux-stable-226b18ad5589550e989afce6b293580abc880a79.tar.gz linux-stable-226b18ad5589550e989afce6b293580abc880a79.tar.bz2 linux-stable-226b18ad5589550e989afce6b293580abc880a79.zip |
FireWire: clean up core-transaction.c kernel-doc
Clean up kernel-doc warnings in <drivers/firewire/core-transaction.c>
so that it can be added to a Firewire/IEEE 1394 driver-api chapter
without adding lots of noisy warnings to the documentation build.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Cc: linux-doc@vger.kernel.org
Cc: linux-scsi@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'drivers/firewire')
-rw-r--r-- | drivers/firewire/core-transaction.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/drivers/firewire/core-transaction.c b/drivers/firewire/core-transaction.c index 4372f9e4b0da..50bf1fe1775f 100644 --- a/drivers/firewire/core-transaction.c +++ b/drivers/firewire/core-transaction.c @@ -410,6 +410,14 @@ static void transaction_callback(struct fw_card *card, int rcode, /** * fw_run_transaction() - send request and sleep until transaction is completed + * @card: card interface for this request + * @tcode: transaction code + * @destination_id: destination node ID, consisting of bus_ID and phy_ID + * @generation: bus generation in which request and response are valid + * @speed: transmission speed + * @offset: 48bit wide offset into destination's address space + * @payload: data payload for the request subaction + * @length: length of the payload, in bytes * * Returns the RCODE. See fw_send_request() for parameter documentation. * Unlike fw_send_request(), @data points to the payload of the request or/and @@ -604,6 +612,7 @@ EXPORT_SYMBOL(fw_core_add_address_handler); /** * fw_core_remove_address_handler() - unregister an address handler + * @handler: callback * * To be called in process context. * @@ -828,6 +837,7 @@ EXPORT_SYMBOL(fw_send_response); /** * fw_get_request_speed() - returns speed at which the @request was received + * @request: firewire request data */ int fw_get_request_speed(struct fw_request *request) { |