summaryrefslogtreecommitdiff
path: root/include/linux/firewire-cdev.h
diff options
context:
space:
mode:
authorStefan Richter <stefanr@s5r6.in-berlin.de>2010-06-21 00:54:22 +0400
committerStefan Richter <stefanr@s5r6.in-berlin.de>2010-06-21 01:11:56 +0400
commit3b2b65d68fc87b02ac393a031a4ebb3de84a8218 (patch)
tree6adbd37cdaa63922d9f36c9a75e51c0178dd308d /include/linux/firewire-cdev.h
parente205597d188a9ea69ce43f740a14f07b3f5b996a (diff)
downloadlinux-3b2b65d68fc87b02ac393a031a4ebb3de84a8218.tar.xz
firewire: cdev: extend fw_cdev_event_iso_interrupt documentation
Add information regarding the 2.6.32 update to the xmit variant of fw_cdev_event_iso_interrupt. Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Diffstat (limited to 'include/linux/firewire-cdev.h')
-rw-r--r--include/linux/firewire-cdev.h19
1 files changed, 15 insertions, 4 deletions
diff --git a/include/linux/firewire-cdev.h b/include/linux/firewire-cdev.h
index 52c7ffe934ad..8b9b27373219 100644
--- a/include/linux/firewire-cdev.h
+++ b/include/linux/firewire-cdev.h
@@ -204,10 +204,21 @@ struct fw_cdev_event_request2 {
* @header: Stripped headers, if any
*
* This event is sent when the controller has completed an &fw_cdev_iso_packet
- * with the %FW_CDEV_ISO_INTERRUPT bit set. In the receive case, the headers
- * stripped of all packets up until and including the interrupt packet are
- * returned in the @header field. The amount of header data per packet is as
- * specified at iso context creation by &fw_cdev_create_iso_context.header_size.
+ * with the %FW_CDEV_ISO_INTERRUPT bit set.
+ *
+ * Isochronous transmit events:
+ *
+ * In version 1 of the ABI, &header_length is 0. In version 3 and some
+ * implementations of version 2 of the ABI, &header_length is a multiple of 4
+ * and &header contains timestamps of all packets up until the interrupt packet.
+ * The format of the timestamps is as described below for isochronous reception.
+ *
+ * Isochronous receive events:
+ *
+ * The headers stripped of all packets up until and including the interrupt
+ * packet are returned in the @header field. The amount of header data per
+ * packet is as specified at iso context creation by
+ * &fw_cdev_create_iso_context.header_size.
*
* In version 1 of this ABI, header data consisted of the 1394 isochronous
* packet header, followed by quadlets from the packet payload if