kevin/linux
1
Fork 0
Code

firewire: core: update documentation of kernel APIs for flushing completions

Browse Source 
There is a slight difference between fw_iso_context_flush_completions() and
fw_iso_context_schedule_flush_completions().

This commit updates the documentations for them.

Link: https://lore.kernel.org/r/20240912133038.238786-5-o-takashi@sakamocchi.jp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
This commit is contained in:
Takashi Sakamoto 2024-09-12 22:30:37 +09:00
parent 5d567654be
commit 4010cb1efd
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
drivers/firewire/core-iso.c
View File

@ -214,9 +214,12 @@ EXPORT_SYMBOL(fw_iso_context_queue_flush);
* @ctx: the isochronous context * @ctx: the isochronous context
* *
* Process the isochronous context in the current process context. The registered callback function * Process the isochronous context in the current process context. The registered callback function
* is called if some packets have been already transferred since the last time. If it is required * is called when a queued packet buffer with the interrupt flag is completed, either after
* to process the context asynchronously, fw_iso_context_schedule_flush_completions() is available * transmission in the IT context or after being filled in the IR context. Additionally, the
* instead. * callback function is also called for the packet buffer completed at last. Furthermore, the
* callback function is called as well when the header buffer in the context becomes full. If it is
* required to process the context asynchronously, fw_iso_context_schedule_flush_completions() is
* available instead.
* *
* Context: Process context. May sleep due to disable_work_sync(). * Context: Process context. May sleep due to disable_work_sync().
*/ */

8
include/linux/firewire.h
View File

@ -537,9 +537,11 @@ int fw_iso_context_flush_completions(struct fw_iso_context *ctx);
* @ctx: the isochronous context * @ctx: the isochronous context
* *
* Schedule a work item on workqueue to process the isochronous context. The registered callback * Schedule a work item on workqueue to process the isochronous context. The registered callback
* function is called in the worker if some packets have been already transferred since the last * function is called by the worker when a queued packet buffer with the interrupt flag is
* time. If it is required to process the context in the current context, * completed, either after transmission in the IT context or after being filled in the IR context.
* fw_iso_context_flush_completions() is available instead. * The callback function is also called when the header buffer in the context becomes full, If it
* is required to process the context in the current context, fw_iso_context_flush_completions() is
* available instead.
* *
* Context: Any context. * Context: Any context.
*/ */