diff options
author | Stefan Richter <stefanr@s5r6.in-berlin.de> | 2010-06-20 16:54:22 -0400 |
---|---|---|
committer | Stefan Richter <stefanr@s5r6.in-berlin.de> | 2010-06-20 17:11:56 -0400 |
commit | 3b2b65d68fc87b02ac393a031a4ebb3de84a8218 (patch) | |
tree | 6adbd37cdaa63922d9f36c9a75e51c0178dd308d /include/linux/firewire-cdev.h | |
parent | e205597d188a9ea69ce43f740a14f07b3f5b996a (diff) |
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.h | 19 |
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 { | |||
204 | * @header: Stripped headers, if any | 204 | * @header: Stripped headers, if any |
205 | * | 205 | * |
206 | * This event is sent when the controller has completed an &fw_cdev_iso_packet | 206 | * This event is sent when the controller has completed an &fw_cdev_iso_packet |
207 | * with the %FW_CDEV_ISO_INTERRUPT bit set. In the receive case, the headers | 207 | * with the %FW_CDEV_ISO_INTERRUPT bit set. |
208 | * stripped of all packets up until and including the interrupt packet are | 208 | * |
209 | * returned in the @header field. The amount of header data per packet is as | 209 | * Isochronous transmit events: |
210 | * specified at iso context creation by &fw_cdev_create_iso_context.header_size. | 210 | * |
211 | * In version 1 of the ABI, &header_length is 0. In version 3 and some | ||
212 | * implementations of version 2 of the ABI, &header_length is a multiple of 4 | ||
213 | * and &header contains timestamps of all packets up until the interrupt packet. | ||
214 | * The format of the timestamps is as described below for isochronous reception. | ||
215 | * | ||
216 | * Isochronous receive events: | ||
217 | * | ||
218 | * The headers stripped of all packets up until and including the interrupt | ||
219 | * packet are returned in the @header field. The amount of header data per | ||
220 | * packet is as specified at iso context creation by | ||
221 | * &fw_cdev_create_iso_context.header_size. | ||
211 | * | 222 | * |
212 | * In version 1 of this ABI, header data consisted of the 1394 isochronous | 223 | * In version 1 of this ABI, header data consisted of the 1394 isochronous |
213 | * packet header, followed by quadlets from the packet payload if | 224 | * packet header, followed by quadlets from the packet payload if |