Documentation/driver-model/interface.txt:8: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:9: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:10: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:11: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:12: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:13: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:14: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:19: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:56: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:74: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:78: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:80: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:82: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:98: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:119: ERROR: trailing whitespace
Documentation/driver-model/interface.txt:128: ERROR: trailing whitespace
Signed-off-by: Andrea Gelmini <andrea.gelmini@xxxxxxxxx>
---
Documentation/driver-model/interface.txt | 33 ++++++++++++++---------------
1 files changed, 16 insertions(+), 17 deletions(-)
diff --git a/Documentation/driver-model/interface.txt b/Documentation/driver-model/interface.txt
index c66912b..6a28cd0 100644
--- a/Documentation/driver-model/interface.txt
+++ b/Documentation/driver-model/interface.txt
@@ -1,22 +1,21 @@
-
Device Interfaces
Introduction
~~~~~~~~~~~~
Device interfaces are the logical interfaces of device classes that correlate
-directly to userspace interfaces, like device nodes.
-
-Each device class may have multiple interfaces through which you can
-access the same device. An input device may support the mouse interface,
-the 'evdev' interface, and the touchscreen interface. A SCSI disk would
-support the disk interface, the SCSI generic interface, and possibly a raw
-device interface.
+directly to userspace interfaces, like device nodes.
+
+Each device class may have multiple interfaces through which you can
+access the same device. An input device may support the mouse interface,
+the 'evdev' interface, and the touchscreen interface. A SCSI disk would
+support the disk interface, the SCSI generic interface, and possibly a raw
+device interface.
Device interfaces are registered with the class they belong to. As devices
are added to the class, they are added to each interface registered with
the class. The interface is responsible for determining whether the device
-supports the interface or not.
+supports the interface or not.
Programming Interface
@@ -53,7 +52,7 @@ Devices
~~~~~~~
Once a device is added to a device class, it is added to each
interface that is registered with the device class. The class
-is expected to place a class-specific data structure in
+is expected to place a class-specific data structure in
struct device::class_data. The interface can use that (along with
other fields of struct device) to determine whether or not the driver
and/or device support that particular interface.
@@ -71,15 +70,15 @@ struct intf_data {
int interface_add_data(struct interface_data *);
-The interface is responsible for allocating and initializing a struct
+The interface is responsible for allocating and initializing a struct
intf_data and calling interface_add_data() to add it to the device's list
of interfaces it belongs to. This list will be iterated over when the device
is removed from the class (instead of all possible interfaces for a class).
-This structure should probably be embedded in whatever per-device data
+This structure should probably be embedded in whatever per-device data
structure the interface is allocating anyway.
-
+
Devices are enumerated within the interface. This happens in interface_add_data()
-and the enumerated value is stored in the struct intf_data for that device.
+and the enumerated value is stored in the struct intf_data for that device.
sysfs
~~~~~
@@ -95,7 +94,7 @@ Interfaces get a directory in the class's directory as well:
|-- mouse
`-- evdev
-When a device is added to the interface, a symlink is created that points
+When a device is added to the interface, a symlink is created that points
to the device's directory in the physical hierarchy:
class/
@@ -116,7 +115,7 @@ A device interface is correlated directly with a userspace interface
for a device, specifically a device node. For instance, a SCSI disk
exposes at least two interfaces to userspace: the standard SCSI disk
interface and the SCSI generic interface. It might also export a raw
-device interface.
+device interface.
Many interfaces have a major number associated with them and each
device gets a minor number. Or, multiple interfaces might share one
@@ -125,5 +124,5 @@ the case of input devices).
These major and minor numbers could be stored in the interface
structure. Major and minor allocations could happen when the interface
-is registered with the class, or via a helper function.
+is registered with the class, or via a helper function.
--
1.7.1.251.gf80a2
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
