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 address handler

Browse Source 
The callback for the address handler is now invoked in process context.

Update the kerneldoc for the address handler accordingly.

Link: https://lore.kernel.org/r/20260920083659.191855-2-o-takashi@sakamocchi.jp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
This commit is contained in:
Takashi Sakamoto 2026-09-20 17:36:55 +09:00
parent e64f2d4de1
commit 567a656d92
2 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -641,16 +641,14 @@ static int put_address_handler(struct fw_address_handler *handler)
*
* When a request is received that falls within the specified address range, the specified callback
* is invoked. The parameters passed to the callback give the details of the particular request.
* The callback is invoked in the workqueue context in most cases. However, if the request is
* initiated by the local node, the callback is invoked in the initiator's context.
*
* To be called in process context.
* Return value: 0 on success, non-zero otherwise.
*
* The start offset of the handler's address region is determined by
* fw_core_add_address_handler() and is returned in handler->offset.
*
* Address allocations are exclusive, except for the FCP registers.
*
* Context: Process context.
* Returns: 0 on success, non-zero otherwise.
*/
int fw_core_add_address_handler(struct fw_address_handler *handler,
const struct fw_address_region *region)

22
include/linux/firewire.h
View File

@ -298,17 +298,25 @@ union fw_transaction_callback {
fw_transaction_callback_with_tstamp_t with_tstamp;
};
/*
* This callback handles an inbound request subaction. If the request subaction is initiated from
* the local node (e.g. by unit driver), the execution context depends on the initiator and is
* unspecified. Otherwise, it runs in workqueue context.
/**
* typedef fw_address_callback_t - Function to handle the request of the asynchronous transaction.
* @card: the card instance which receives the request
* @request: the request instance.
* @tcode: the transaction code
* @destination: the destination node ID
* @source: the source node ID
* @generation: the bus generation in which the request was sent
* @offset: the destination offset in source node.
* @data: the request content if available.
* @length: the length of data.
* @callback_data: the data registered with this function.
*
* The callback should not initiate outbound request subactions directly.
* Otherwise there is a danger of recursion of inbound and outbound
* transactions from and to the local node.
* This callback handles an inbound request subaction.
*
* The callback is responsible that fw_send_response() is called on the @request, except for FCP
* registers for which the core takes care of that.
*
* Context: Process context.
*/
typedef void (*fw_address_callback_t)(struct fw_card *card,
struct fw_request *request,