firewire: cdev: some clarifications to the API documentation
authorStefan Richter <stefanr@s5r6.in-berlin.de>
Sat, 17 Jul 2010 19:36:02 +0000 (21:36 +0200)
committerStefan Richter <stefanr@s5r6.in-berlin.de>
Fri, 23 Jul 2010 11:36:27 +0000 (13:36 +0200)
commitd505e6e87127d4dbdaa5d91561eed810c180ca23
tree590f16144d1d125f745610baae4503e2e0ae8901
parent18d0cdfd1a4cc9028c0ef80f94538b31541f8fe5
firewire: cdev: some clarifications to the API documentation

Response events:
  - are generated on more occasions than their documentation claimed.

CSR allocation:
  - An already occupied CSR can be determined from errno==EBUSY.

Bus resets:
  - Note that FW_CDEV_IOC_INITIATE_BUS_RESET is nonblocking and that the
    client is not required to observe a grace period since kernels
    2.6.36+ will enforce it now (commit 02d37bed).

  - The possible values of fw_cdev_initiate_bus_reset.type are listed in
    the kerneldoc comment already.

  - Clarify that an application that uses FW_CDEV_IOC_ADD_DESCRIPTOR and
    FW_CDEV_IOC_REMOVE_DESCRIPTOR does not have to issue a bus reset.

Isochronous I/O contexts:
  - At most one can be created per open file descriptor.

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
include/linux/firewire-cdev.h