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:46 +0900 |
| commit | 8b528d2616705de8f170dcb5f1bdfd9be7b3e786 (patch) | |
| tree | 1d9525a0a45a2f008399bde0ff050a8ed687821e | |
| parent | e4f916685103d78936d0b64b9c92ec0c0c44954e (diff) | |
| download | libhinoko-8b528d2616705de8f170dcb5f1bdfd9be7b3e786.tar.gz | |
fw_iso_ctx_single: add function comment for context header parameter
According to the design of Linux FireWire subsystem.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
| -rw-r--r-- | src/fw_iso_rx_single.c | 10 | ||||
| -rw-r--r-- | src/fw_iso_rx_single.h | 3 |
2 files changed, 10 insertions, 3 deletions
diff --git a/src/fw_iso_rx_single.c b/src/fw_iso_rx_single.c index d4f944a..fa2963c 100644 --- a/src/fw_iso_rx_single.c +++ b/src/fw_iso_rx_single.c @@ -62,7 +62,8 @@ static void hinoko_fw_iso_rx_single_class_init(HinokoFwIsoRxSingleClass *klass) * @sec: sec part of isochronous cycle when interrupt occurs, up to 7. * @cycle: cycle part of of isochronous cycle when interrupt occurs, up to 7999. * @header: (array length=header_length) (element-type guint8): The headers of IR context - * for handled packets. + * for packets handled in the event of interrupt. The content is different + * depending on header_size parameter of [method@FwIsoRxSingle.allocate]. * @header_length: the number of bytes for @header. * @count: the number of packets to handle. * @@ -241,13 +242,18 @@ HinokoFwIsoRxSingle *hinoko_fw_iso_rx_single_new(void) * @path: A path to any Linux FireWire character device. * @channel: An isochronous channel to listen, up to 63. * @header_size: The number of bytes for header of IR context, greater than 4 at least to include - * isochronous header. + * isochronous packet header in header parameter of [signal@FwIsoRxSingle::interrupted]. * @error: A [struct@GLib.Error]. * * Allocate an IR context to 1394 OHCI controller for packet-per-buffer mode. A local node of the * node corresponding to the given path is used as the controller, thus any path is accepted as * long as process has enough permission for the path. * + * The header_size parameter has an effect for the content of header parameter in + * [signal@FwIsoRxSingle::interrupted]. When it's greater than 8, header includes the series of two + * quadlets for isochronous packet header and timestamp per isochronous packet. When it's greater + * than 12, header includes the part of isochronous packet data per packet. + * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * * Since: 0.7. diff --git a/src/fw_iso_rx_single.h b/src/fw_iso_rx_single.h index a06b510..f2cf221 100644 --- a/src/fw_iso_rx_single.h +++ b/src/fw_iso_rx_single.h @@ -20,7 +20,8 @@ struct _HinokoFwIsoRxSingleClass { * @sec: The sec part of isochronous cycle when interrupt occurs, up to 7. * @cycle: The cycle part of of isochronous cycle when interrupt occurs, up to 7999. * @header: (array length=header_length) (element-type guint8): The headers of IR context - * for handled packets. + * for packets handled in the event of interrupt. The content is different + * depending on header_size parameter of [method@FwIsoRxSingle.allocate]. * @header_length: the number of bytes for header. * @count: the number of packets to handle. * |