xref: /openbmc/linux/Documentation/driver-api/w1.rst (revision ead5d1f4d877e92c051e1a1ade623d0d30e71619)
1b4c1064aSMauro Carvalho Chehab======================
2b4c1064aSMauro Carvalho ChehabW1: Dallas' 1-wire bus
3b4c1064aSMauro Carvalho Chehab======================
4b4c1064aSMauro Carvalho Chehab
5b4c1064aSMauro Carvalho Chehab:Author: David Fries
6b4c1064aSMauro Carvalho Chehab
7b4c1064aSMauro Carvalho ChehabW1 API internal to the kernel
8b4c1064aSMauro Carvalho Chehab=============================
9b4c1064aSMauro Carvalho Chehab
10*650fc870SLinus Torvaldsinclude/linux/w1.h
11*650fc870SLinus Torvalds~~~~~~~~~~~~~~~~~~
12b4c1064aSMauro Carvalho Chehab
13*650fc870SLinus TorvaldsW1 kernel API functions.
14b4c1064aSMauro Carvalho Chehab
15*650fc870SLinus Torvalds.. kernel-doc:: include/linux/w1.h
16b4c1064aSMauro Carvalho Chehab   :internal:
17b4c1064aSMauro Carvalho Chehab
18b4c1064aSMauro Carvalho Chehabdrivers/w1/w1.c
19b4c1064aSMauro Carvalho Chehab~~~~~~~~~~~~~~~
20b4c1064aSMauro Carvalho Chehab
21b4c1064aSMauro Carvalho ChehabW1 core functions.
22b4c1064aSMauro Carvalho Chehab
23b4c1064aSMauro Carvalho Chehab.. kernel-doc:: drivers/w1/w1.c
24b4c1064aSMauro Carvalho Chehab   :internal:
25b4c1064aSMauro Carvalho Chehab
26b4c1064aSMauro Carvalho Chehabdrivers/w1/w1_family.c
27b4c1064aSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~
28b4c1064aSMauro Carvalho Chehab
29b4c1064aSMauro Carvalho ChehabAllows registering device family operations.
30b4c1064aSMauro Carvalho Chehab
31b4c1064aSMauro Carvalho Chehab.. kernel-doc:: drivers/w1/w1_family.c
32b4c1064aSMauro Carvalho Chehab   :export:
33b4c1064aSMauro Carvalho Chehab
34*650fc870SLinus Torvaldsdrivers/w1/w1_internal.h
35*650fc870SLinus Torvalds~~~~~~~~~~~~~~~~~~~~~~~~
36*650fc870SLinus Torvalds
37*650fc870SLinus TorvaldsW1 internal initialization for master devices.
38*650fc870SLinus Torvalds
39*650fc870SLinus Torvalds.. kernel-doc:: drivers/w1/w1_internal.h
40*650fc870SLinus Torvalds   :internal:
41*650fc870SLinus Torvalds
42b4c1064aSMauro Carvalho Chehabdrivers/w1/w1_int.c
43b4c1064aSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~
44b4c1064aSMauro Carvalho Chehab
45b4c1064aSMauro Carvalho ChehabW1 internal initialization for master devices.
46b4c1064aSMauro Carvalho Chehab
47b4c1064aSMauro Carvalho Chehab.. kernel-doc:: drivers/w1/w1_int.c
48b4c1064aSMauro Carvalho Chehab   :export:
49b4c1064aSMauro Carvalho Chehab
50b4c1064aSMauro Carvalho Chehabdrivers/w1/w1_netlink.h
51b4c1064aSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~
52b4c1064aSMauro Carvalho Chehab
53b4c1064aSMauro Carvalho ChehabW1 external netlink API structures and commands.
54b4c1064aSMauro Carvalho Chehab
55b4c1064aSMauro Carvalho Chehab.. kernel-doc:: drivers/w1/w1_netlink.h
56b4c1064aSMauro Carvalho Chehab   :internal:
57b4c1064aSMauro Carvalho Chehab
58b4c1064aSMauro Carvalho Chehabdrivers/w1/w1_io.c
59b4c1064aSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~
60b4c1064aSMauro Carvalho Chehab
61b4c1064aSMauro Carvalho ChehabW1 input/output.
62b4c1064aSMauro Carvalho Chehab
63b4c1064aSMauro Carvalho Chehab.. kernel-doc:: drivers/w1/w1_io.c
64b4c1064aSMauro Carvalho Chehab   :export:
65b4c1064aSMauro Carvalho Chehab
66b4c1064aSMauro Carvalho Chehab.. kernel-doc:: drivers/w1/w1_io.c
67b4c1064aSMauro Carvalho Chehab   :internal:
68