2009-01-02 11:52:48

by Stefan Richter

[permalink] [raw]
Subject: [PATCH] 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.

Signed-off-by: Stefan Richter <[email protected]>
---
include/linux/firewire-cdev.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Index: linux/include/linux/firewire-cdev.h
===================================================================
--- linux.orig/include/linux/firewire-cdev.h
+++ linux/include/linux/firewire-cdev.h
@@ -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;

--
Stefan Richter
-=====-==--= ---= ---=-
http://arcgraph.de/sr/


2009-01-04 00:53:11

by Stefan Richter

[permalink] [raw]
Subject: Re: [PATCH] firewire: cdev: fix documentation of FW_CDEV_IOC_GET_INFO

I wrote:
> 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.
...
> * struct fw_cdev_get_info - General purpose information ioctl
...
> * @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.
--
Stefan Richter
-=====-==--= ---= --=--
http://arcgraph.de/sr/