[mirror_ubuntu-bionic-kernel.git] / Documentation / driver-api / w1.rst

======================
W1: Dallas' 1-wire bus
======================

:Author: David Fries

W1 API internal to the kernel
=============================

W1 API internal to the kernel
-----------------------------

include/linux/w1.h
~~~~~~~~~~~~~~~~~~

W1 kernel API functions.

.. kernel-doc:: include/linux/w1.h
   :internal:

drivers/w1/w1.c
~~~~~~~~~~~~~~~

W1 core functions.

.. kernel-doc:: drivers/w1/w1.c
   :internal:

drivers/w1/w1_family.c
~~~~~~~~~~~~~~~~~~~~~~~

Allows registering device family operations.

.. kernel-doc:: drivers/w1/w1_family.c
   :export:

drivers/w1/w1_internal.h
~~~~~~~~~~~~~~~~~~~~~~~~

W1 internal initialization for master devices.

.. kernel-doc:: drivers/w1/w1_internal.h
   :internal:

drivers/w1/w1_int.c
~~~~~~~~~~~~~~~~~~~~

W1 internal initialization for master devices.

.. kernel-doc:: drivers/w1/w1_int.c
   :export:

drivers/w1/w1_netlink.h
~~~~~~~~~~~~~~~~~~~~~~~~

W1 external netlink API structures and commands.

.. kernel-doc:: drivers/w1/w1_netlink.h
   :internal:

drivers/w1/w1_io.c
~~~~~~~~~~~~~~~~~~~

W1 input/output.

.. kernel-doc:: drivers/w1/w1_io.c
   :export:

.. kernel-doc:: drivers/w1/w1_io.c
   :internal:
Commit	Line	Data
b4c1064a MCC	1	======================
	2	W1: Dallas' 1-wire bus
	3	======================
	4
	5	:Author: David Fries
	6
	7	W1 API internal to the kernel
	8	=============================
	9
	10	W1 API internal to the kernel
	11	-----------------------------
	12
650fc870 LT	13	include/linux/w1.h
650fc870 LT	14	~~~~~~~~~~~~~~~~~~
b4c1064a	15
650fc870	16	W1 kernel API functions.
b4c1064a	17
650fc870	18	.. kernel-doc:: include/linux/w1.h
b4c1064a MCC	19	:internal:
	20
	21	drivers/w1/w1.c
	22	~~~~~~~~~~~~~~~
	23
	24	W1 core functions.
	25
	26	.. kernel-doc:: drivers/w1/w1.c
	27	:internal:
	28
b4c1064a MCC	29	drivers/w1/w1_family.c
	30	~~~~~~~~~~~~~~~~~~~~~~~
	31
	32	Allows registering device family operations.
	33
	34	.. kernel-doc:: drivers/w1/w1_family.c
	35	:export:
	36
650fc870 LT	37	drivers/w1/w1_internal.h
	38	~~~~~~~~~~~~~~~~~~~~~~~~
	39
	40	W1 internal initialization for master devices.
	41
	42	.. kernel-doc:: drivers/w1/w1_internal.h
	43	:internal:
	44
b4c1064a MCC	45	drivers/w1/w1_int.c
	46	~~~~~~~~~~~~~~~~~~~~
	47
	48	W1 internal initialization for master devices.
	49
	50	.. kernel-doc:: drivers/w1/w1_int.c
	51	:export:
	52
	53	drivers/w1/w1_netlink.h
	54	~~~~~~~~~~~~~~~~~~~~~~~~
	55
	56	W1 external netlink API structures and commands.
	57
	58	.. kernel-doc:: drivers/w1/w1_netlink.h
	59	:internal:
	60
	61	drivers/w1/w1_io.c
	62	~~~~~~~~~~~~~~~~~~~
	63
	64	W1 input/output.
	65
	66	.. kernel-doc:: drivers/w1/w1_io.c
	67	:export:
	68
	69	.. kernel-doc:: drivers/w1/w1_io.c
	70	:internal: