Skip to content

Commit 7b71392

Browse files
committed
firewire: core: fulfill documentation of fw_iso_context_flush_completions()
The fw_iso_context_flush_completions() is the counterpart of fw_iso_context_schedule_work() to process isochronous context in current process context. This commit fulfills its documentation. Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Takashi Sakamoto <[email protected]>
1 parent 446216b commit 7b71392

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

drivers/firewire/core-iso.c

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,17 @@ void fw_iso_context_queue_flush(struct fw_iso_context *ctx)
209209
}
210210
EXPORT_SYMBOL(fw_iso_context_queue_flush);
211211

212+
/**
213+
* fw_iso_context_flush_completions() - process isochronous context in current process context.
214+
* @ctx: the isochronous context
215+
*
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.
220+
*
221+
* Context: Process context. May sleep due to disable_work_sync().
222+
*/
212223
int fw_iso_context_flush_completions(struct fw_iso_context *ctx)
213224
{
214225
int err;

0 commit comments

Comments
 (0)