github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-07 06:17:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

firewire: core: fulfill kerneldoc for fw_cancel_transaction()

Browse Source 
fw_cancel_transaction() has no kerneldoc even though it is exposed.

Add kerneldoc for it.

Link: https://lore.kernel.org/r/20261007093235.175742-6-o-takashi@sakamocchi.jp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
This commit is contained in:
Takashi Sakamoto 2026-10-07 18:32:35 +09:00
parent dd1c6b1518
commit b381407e03
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
drivers/firewire/core-transaction.c
View File

@ -103,12 +103,20 @@ void fw_cancel_pending_transactions(struct fw_card *card)
__t; \
})
/*
* Only valid for transactions that are potentially pending (ie have
* been sent).
/**
* fw_cancel_transaction: cancel transaction.
* @card: interface where the transaction has been requested
* @transaction: transaction instance to be cancelled
*
* Terminate the transaction by either canceling the request subaction or the response subaction
* of the split transaction, then schedule the transaction callback to notify the cancellation.
* The transaction instance should be kept until the callback will be invoked.
*
* Context: Process context.
* Returns: 0 on success, -ENOENT if the transaction instance is not found in the queue for the
* pending transaction.
*/
int fw_cancel_transaction(struct fw_card *card,
struct fw_transaction *transaction)
int fw_cancel_transaction(struct fw_card *card, struct fw_transaction *transaction)
{
// Cancel the packet transmission if it's still queued. That will schedule the packet
// transmission callback which cancels the transaction.