aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/w1/w1.generic
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
commit1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 (patch)
tree0bba044c4ce775e45a88a51686b5d9f90697ea9d /Documentation/w1/w1.generic
Linux-2.6.12-rc2v2.6.12-rc2
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!
Diffstat (limited to 'Documentation/w1/w1.generic')
-rw-r--r--Documentation/w1/w1.generic19
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/w1/w1.generic b/Documentation/w1/w1.generic
new file mode 100644
index 000000000000..eace3046a858
--- /dev/null
+++ b/Documentation/w1/w1.generic
@@ -0,0 +1,19 @@
1Any w1 device must be connected to w1 bus master device - for example
2ds9490 usb device or w1-over-GPIO or RS232 converter.
3Driver for w1 bus master must provide several functions(you can find
4them in struct w1_bus_master definition in w1.h) which then will be
5called by w1 core to send various commands over w1 bus(by default it is
6reset and search commands). When some device is found on the bus, w1 core
7checks if driver for it's family is loaded.
8If driver is loaded w1 core creates new w1_slave object and registers it
9in the system(creates some generic sysfs files(struct w1_family_ops in
10w1_family.h), notifies any registered listener and so on...).
11It is device driver's business to provide any communication method
12upstream.
13For example w1_therm driver(ds18?20 thermal sensor family driver)
14provides temperature reading function which is bound to ->rbin() method
15of the above w1_family_ops structure.
16w1_smem - driver for simple 64bit memory cell provides ID reading
17method.
18
19You can call above methods by reading appropriate sysfs files.