Commit 6d3faf6f431bafb25f4b9926c50a7e5c267738c6
1 parent
e300839da4
Exists in
master
and in
7 other branches
firewire: cdev: add_descriptor documentation fix
struct fw_cdev_add_descriptor.length is in quadlets, not in bytes. Also remove any doubts about the endianess of descriptor data. Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Showing 1 changed file with 3 additions and 1 deletions Side-by-side Diff
include/linux/firewire-cdev.h
... | ... | @@ -380,7 +380,7 @@ |
380 | 380 | * @immediate: If non-zero, immediate key to insert before pointer |
381 | 381 | * @key: Upper 8 bits of root directory pointer |
382 | 382 | * @data: Userspace pointer to contents of descriptor block |
383 | - * @length: Length of descriptor block data, in bytes | |
383 | + * @length: Length of descriptor block data, in quadlets | |
384 | 384 | * @handle: Handle to the descriptor, written by the kernel |
385 | 385 | * |
386 | 386 | * Add a descriptor block and optionally a preceding immediate key to the local |
... | ... | @@ -393,6 +393,8 @@ |
393 | 393 | * |
394 | 394 | * If not 0, the @immediate field specifies an immediate key which will be |
395 | 395 | * inserted before the root directory pointer. |
396 | + * | |
397 | + * @immediate, @key, and @data array elements are CPU-endian quadlets. | |
396 | 398 | * |
397 | 399 | * If successful, the kernel adds the descriptor and writes back a handle to the |
398 | 400 | * kernel-side object to be used for later removal of the descriptor block and |