Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

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>

+11 -6
+6 -3
drivers/firewire/core-iso.c
··· 214 214 * @ctx: the isochronous context 215 215 * 216 216 * Process the isochronous context in the current process context. The registered callback function 217 - * is called if some packets have been already transferred since the last time. If it is required 218 - * to process the context asynchronously, fw_iso_context_schedule_flush_completions() is available 219 - * instead. 217 + * is called when a queued packet buffer with the interrupt flag is completed, either after 218 + * transmission in the IT context or after being filled in the IR context. Additionally, the 219 + * callback function is also called for the packet buffer completed at last. Furthermore, the 220 + * callback function is called as well when the header buffer in the context becomes full. If it is 221 + * required to process the context asynchronously, fw_iso_context_schedule_flush_completions() is 222 + * available instead. 220 223 * 221 224 * Context: Process context. May sleep due to disable_work_sync(). 222 225 */
+5 -3
include/linux/firewire.h
··· 537 537 * @ctx: the isochronous context 538 538 * 539 539 * Schedule a work item on workqueue to process the isochronous context. The registered callback 540 - * function is called in the worker if some packets have been already transferred since the last 541 - * time. If it is required to process the context in the current context, 542 - * fw_iso_context_flush_completions() is available instead. 540 + * function is called by the worker when a queued packet buffer with the interrupt flag is 541 + * completed, either after transmission in the IT context or after being filled in the IR context. 542 + * The callback function is also called when the header buffer in the context becomes full, If it 543 + * is required to process the context in the current context, fw_iso_context_flush_completions() is 544 + * available instead. 543 545 * 544 546 * Context: Any context. 545 547 */