diff options
| author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-05-08 17:59:04 +0900 |
|---|---|---|
| committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-05-08 17:59:48 +0900 |
| commit | 4d31d69552ee854d3ffb104ff74789b83a243672 (patch) | |
| tree | 74748220d1a719883eef45f2d74a06a81d909ec7 | |
| parent | 8b528d2616705de8f170dcb5f1bdfd9be7b3e786 (diff) | |
| download | libhinoko-4d31d69552ee854d3ffb104ff74789b83a243672.tar.gz | |
fw_iso_tx: add function comment for header of packet registration
According to the design of Linux FireWire subsystem.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
| -rw-r--r-- | src/fw_iso_tx.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/fw_iso_tx.c b/src/fw_iso_tx.c index 55b21ec..67508d2 100644 --- a/src/fw_iso_tx.c +++ b/src/fw_iso_tx.c @@ -312,7 +312,9 @@ gboolean hinoko_fw_iso_tx_start(HinokoFwIsoTx *self, const guint16 *cycle_match, * @self: A [class@FwIsoTx]. * @tags: The value of tag field for isochronous packet to register. * @sync_code: The value of sync field in isochronous packet header for packet processing, up to 15. - * @header: (array length=header_length)(nullable): The header of IT context for isochronous packet. + * @header: (array length=header_length) (nullable): The header of IT context for isochronous + * packet. The length of header should be the same as the size of header indicated in + * allocation if it's not null. * @header_length: The number of bytes for the @header. * @payload: (array length=payload_length)(nullable): The payload of IT context for isochronous * packet. @@ -320,8 +322,9 @@ gboolean hinoko_fw_iso_tx_start(HinokoFwIsoTx *self, const guint16 *cycle_match, * @schedule_interrupt: Whether to schedule hardware interrupt at isochronous cycle for the packet. * @error: A [struct@GLib.Error]. * - * Register packet data with header and payload for IT context. The caller can schedule hardware - * interrupt to generate interrupt event. In detail, please refer to documentation about + * Register packet data with header and payload for IT context. The content of given header and + * payload is appended into data field of isochronous packet to be sent. The caller can schedule + * hardware interrupt to generate interrupt event. In detail, please refer to documentation about * [signal@FwIsoTx::interrupted]. * * Returns: TRUE if the overall operation finishes successful, otherwise FALSE. |