mirror of
https://github.com/torvalds/linux.git
synced 2026-11-07 06:17:02 +01:00
firewire: core: update kerneldoc for fw_send_request() and its variants
Some error paths invoke the transaction callback in process context using a workqueue. All transaction callbacks are now invoked in process context. Update kerneldoc to reflect this behavior. Link: https://lore.kernel.org/r/20260921031931.287429-4-o-takashi@sakamocchi.jp Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
This commit is contained in:
parent
382ec29406
commit
f95344968c
|
|
@ -378,8 +378,8 @@ __must_hold(&card->transactions.lock)
|
|||
*
|
||||
* In case of request types without payload, @data is NULL and @length is 0.
|
||||
*
|
||||
* After the transaction is completed successfully or unsuccessfully, the
|
||||
* @callback will be called. Among its parameters is the response code which
|
||||
* After the transaction is completed successfully or unsuccessfully, the @callback will be called
|
||||
* in process context. Among its parameters is the response code which
|
||||
* is either one of the rcodes per IEEE 1394 or, in case of internal errors,
|
||||
* the firewire-core specific %RCODE_SEND_ERROR. The other firewire-core
|
||||
* specific rcodes (%RCODE_CANCELLED, %RCODE_BUSY, %RCODE_GENERATION,
|
||||
|
|
|
|||
|
|
@ -427,9 +427,8 @@ void __fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode
|
|||
* A variation of __fw_send_request() to generate callback for response subaction without time
|
||||
* stamp.
|
||||
*
|
||||
* The callback is invoked in the workqueue context in most cases. However, if an error is detected
|
||||
* before queueing or the destination address refers to the local node, it is invoked in the
|
||||
* current context instead.
|
||||
* After the transaction is completed successfully or unsuccessfully, the @callback will be called
|
||||
* in process context.
|
||||
*/
|
||||
static inline void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode,
|
||||
int destination_id, int generation, int speed,
|
||||
|
|
@ -460,9 +459,8 @@ static inline void fw_send_request(struct fw_card *card, struct fw_transaction *
|
|||
*
|
||||
* A variation of __fw_send_request() to generate callback for response subaction with time stamp.
|
||||
*
|
||||
* The callback is invoked in the workqueue context in most cases. However, if an error is detected
|
||||
* before queueing or the destination address refers to the local node, it is invoked in the current
|
||||
* context instead.
|
||||
* After the transaction is completed successfully or unsuccessfully, the @callback will be called
|
||||
* in process context.
|
||||
*/
|
||||
static inline void fw_send_request_with_tstamp(struct fw_card *card, struct fw_transaction *t,
|
||||
int tcode, int destination_id, int generation, int speed, unsigned long long offset,
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user