Documentation/driver-api/reset.rst

1 .. SPDX-License-Identifier: GPL-2.0-only
13 the `consumer driver interface <#consumer-driver-interface>`__ (`API reference
14 <#reset-consumer-api>`__), which allows peripheral drivers to request control
16 <#reset-controller-driver-interface>`__ (`API reference
17 <#reset-controller-driver-api>`__), which is used by drivers for reset
22 functionality, restart handlers are out of scope for the reset controller API.
25 --------
39     is self-clearing and can be used to trigger a predetermined pulse on the
60 Functions are provided to assert and deassert the controlled reset lines,
71 ---------------------------
92 -------------------------
95 functions to assert and deassert reset lines.
96 For shared reset controls, calls to the two functions must be balanced.
107 ----------
110 self-deasserting reset control.
115 The reset controller API allows requesting self-deasserting reset controls as
120 For shared reset controls, calls to the two functions must be balanced.
125 --------
129 If supported, this function returns a positive non-zero value if the given
132 `reset control array <#reset-control-arrays>`__ handle as its input parameter.
135 ---------------
141 These functions return a NULL pointer instead of an error when the requested
143 Passing a NULL pointer to the reset_control functions causes them to return
147 --------------------
161 All functions are optional.
164 --------------
168 The actual functionality is implemented in callback functions via a struct
175 the `reset consumer API <#reset-consumer-api>`__ and the `reset controller
176 driver API <#reset-controller-driver-api>`__.
179 ------------------
188 .. kernel-doc:: include/linux/reset.h
191 .. kernel-doc:: drivers/reset/core.c
192    :functions: reset_control_reset
206 ---------------------------
208 Reset controller drivers are supposed to implement the necessary functions in
209 a static constant structure :c:type:`reset_control_ops`, allocate and fill out
213 .. kernel-doc:: include/linux/reset-controller.h
216 .. kernel-doc:: drivers/reset/core.c
217    :functions: of_reset_simple_xlate