Commit be585c07 authored by Jay Fenlason's avatar Jay Fenlason Committed by Stefan Richter

firewire: Add more documentation to firewire-cdev.h

Signed-off-by: default avatarJay Fenlason <fenlason@redhat.com>
Signed-off-by: default avatarStefan Richter <stefanr@s5r6.in-berlin.de>
parent 99692f71
...@@ -154,8 +154,13 @@ struct fw_cdev_event_iso_interrupt { ...@@ -154,8 +154,13 @@ struct fw_cdev_event_iso_interrupt {
* @request: Valid if @common.type == %FW_CDEV_EVENT_REQUEST * @request: Valid if @common.type == %FW_CDEV_EVENT_REQUEST
* @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT * @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT
* *
* Convenience union for userspace use. Events could be read(2) into a char * Convenience union for userspace use. Events could be read(2) into an
* buffer and then cast to this union for further processing. * appropriately aligned char buffer and then cast to this union for further
* processing. Note that for a request, response or iso_interrupt event,
* the data[] or header[] may make the size of the full event larger than
* sizeof(union fw_cdev_event). Also note that if you attempt to read(2)
* an event into a buffer that is not large enough for it, the data that does
* not fit will be discarded so that the next read(2) will return a new event.
*/ */
union fw_cdev_event { union fw_cdev_event {
struct fw_cdev_event_common common; struct fw_cdev_event_common common;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment