summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-model/device.txt
diff options
context:
space:
mode:
authorDavid Brownell <david-b@pacbell.net>2005-05-16 17:19:55 -0700
committerGreg Kroah-Hartman <gregkh@suse.de>2005-06-20 15:15:29 -0700
commit4109aca06cb7b042ea791d0f9d3c9615bc3bf5cd (patch)
tree36312d5fe016d507ec0682de914e1ac6b66c3246 /Documentation/driver-model/device.txt
parent4b45099b75832434c5113b9aed1499f8a69d13d5 (diff)
downloadkernel-crypto-4109aca06cb7b042ea791d0f9d3c9615bc3bf5cd.tar.gz
kernel-crypto-4109aca06cb7b042ea791d0f9d3c9615bc3bf5cd.tar.xz
kernel-crypto-4109aca06cb7b042ea791d0f9d3c9615bc3bf5cd.zip
[PATCH] Driver Core: driver model doc update
This updates some driver data documentation: - removes references to some fields that haven't been there for a long time now, e.g. pre-kobject or even older; - giving more information about the probe() method; - adding an example of how platform_data is used Signed-off-by: David Brownell <dbrownell@users.sourceforge.net> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'Documentation/driver-model/device.txt')
-rw-r--r--Documentation/driver-model/device.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/driver-model/device.txt b/Documentation/driver-model/device.txt
index 58cc5dc8fd3..a05ec50f800 100644
--- a/Documentation/driver-model/device.txt
+++ b/Documentation/driver-model/device.txt
@@ -76,6 +76,14 @@ driver_data: Driver-specific data.
platform_data: Platform data specific to the device.
+ Example: for devices on custom boards, as typical of embedded
+ and SOC based hardware, Linux often uses platform_data to point
+ to board-specific structures describing devices and how they
+ are wired. That can include what ports are available, chip
+ variants, which GPIO pins act in what additional roles, and so
+ on. This shrinks the "Board Support Packages" (BSPs) and
+ minimizes board-specific #ifdefs in drivers.
+
current_state: Current power state of the device.
saved_state: Pointer to saved state of the device. This is usable by