aboutsummaryrefslogtreecommitdiff
path: root/Documentation/DocBook/w1.tmpl
blob: b0228d4c81bb5ccca176720a9e0846acb8668b4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>

<book id="w1id">
  <bookinfo>
    <title>W1: Dallas' 1-wire bus</title>

    <authorgroup>
      <author>
        <firstname>David</firstname>
        <surname>Fries</surname>
        <affiliation>
          <address>
            <email>David@Fries.net</email>
          </address>
        </affiliation>
      </author>

    </authorgroup>

    <copyright>
      <year>2013</year>
      <!--
      <holder></holder>
      -->
    </copyright>

    <legalnotice>
      <para>
        This documentation is free software; you can redistribute
        it and/or modify it under the terms of the GNU General Public
        License version 2.
      </para>

      <para>
        This program is distributed in the hope that it will be
        useful, but WITHOUT ANY WARRANTY; without even the implied
        warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
        For more details see the file COPYING in the source
        distribution of Linux.
      </para>
    </legalnotice>
  </bookinfo>

  <toc></toc>

  <chapter id="w1_internal">
    <title>W1 API internal to the kernel</title>

    <sect1 id="w1_internal_api">
      <title>W1 API internal to the kernel</title>
      <sect2 id="w1.h">
        <title>drivers/w1/w1.h</title>
        <para>W1 core functions.</para>
!Idrivers/w1/w1.h
      </sect2>

      <sect2 id="w1.c">
        <title>drivers/w1/w1.c</title>
        <para>W1 core functions.</para>
!Idrivers/w1/w1.c
      </sect2>

      <sect2 id="w1_family.h">
        <title>drivers/w1/w1_family.h</title>
        <para>Allows registering device family operations.</para>
!Idrivers/w1/w1_family.h
      </sect2>

      <sect2 id="w1_family.c">
        <title>drivers/w1/w1_family.c</title>
        <para>Allows registering device family operations.</para>
!Edrivers/w1/w1_family.c
      </sect2>

      <sect2 id="w1_int.c">
        <title>drivers/w1/w1_int.c</title>
        <para>W1 internal initialization for master devices.</para>
!Edrivers/w1/w1_int.c
      </sect2>

      <sect2 id="w1_netlink.h">
        <title>drivers/w1/w1_netlink.h</title>
        <para>W1 external netlink API structures and commands.</para>
!Idrivers/w1/w1_netlink.h
      </sect2>

      <sect2 id="w1_io.c">
        <title>drivers/w1/w1_io.c</title>
        <para>W1 input/output.</para>
!Edrivers/w1/w1_io.c
!Idrivers/w1/w1_io.c
      </sect2>

    </sect1>


  </chapter>

</book>