firewire: cdev: fix documentation of FW_CDEV_IOC_GET_INFO
PATCH 1/1 firewire: cdev: fix documentation of FW_CDEV_IOC_GET_INFO
The FW_CDEV_IOC_GET_INFO ioctl looks at client->device->config_rom, not at the local node's config ROM.
We could fix the implementation or the documentation. I believe the way how it is currently implemented is more useful than the way how it is currently documented, hence let's change only the documentation.
--- include/linux/firewire-cdev.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/firewire-cdev.h +1 -1
@@ -194,21 +194,21 @@ union fw_cdev_event {/** * struct fw_cdev_get_info - General purpose information ioctl * @version: The version field is just a running serial number. * We never break backwards compatibility, but may add more * structs and ioctls in later revisions. * @rom_length: If @rom is non-zero, at most rom_length bytes of configuration * ROM will be copied into that user space address. In either * case, @rom_length is updated with the actual length of the * configuration ROM. * @rom: If non-zero, address of a buffer to be filled by a copy of the -* local node's configuration ROM +* device's configuration ROM * @bus_reset: If non-zero, address of a buffer to be filled by a * &struct fw_cdev_event_bus_reset with the current state * of the bus. This does not cause a bus reset to happen. * @bus_reset_closure: Value of &closure in this and subsequent bus reset events * @card: The index of the card this device belongs to */ struct fw_cdev_get_info {__u32 version;__u32 rom_length;__u64 rom;
Signature · 3 lines
Stefan Richter -=====-==--= ---= ---=- http://arcgraph.de/sr/
Quoted 6 lines · I wrote:
The
FW_CDEV_IOC_GET_INFOioctl looks atclient->device->config_rom, not at the local node's config ROM.We could fix the implementation or the documentation. I believe the way how it is currently implemented is more useful than the way how it is currently documented, hence let's change only the documentation.
...
Quoted 1 line
* struct
fw_cdev_get_info- General purpose information ioctl
...
Quoted 3 lines
* @rom: If non-zero, address of a buffer to be filled by a copy of the
- * local node's configuration ROM
+ * device's configuration ROM
Of course libdc1394 uses the ABI already as implemented, not as documented.
Signature · 3 lines
Stefan Richter -=====-==--= ---= --=-- http://arcgraph.de/sr/