Skip to content

Commit

Permalink
FireWire: clean up core-transaction.c kernel-doc
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Randy Dunlap authored and Jonathan Corbet committed Sep 6, 2018
1 parent 48f02b8 commit 226b18a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions drivers/firewire/core-transaction.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
*
Expand Down Expand Up @@ -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)
{
Expand Down

0 comments on commit 226b18a

Please sign in to comment.