From b381407e03b844d1e836b5a96badb62a0bf159b2 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Wed, 7 Oct 2026 18:32:35 +0900 Subject: [PATCH] firewire: core: fulfill kerneldoc for fw_cancel_transaction() 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 --- drivers/firewire/core-transaction.c | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/drivers/firewire/core-transaction.c b/drivers/firewire/core-transaction.c index 617df7ecb12e..770c44f17ec6 100644 --- a/drivers/firewire/core-transaction.c +++ b/drivers/firewire/core-transaction.c @@ -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.