u-boot/include/reset.h

13  * A reset is a hardware signal indicating that a HW module (or IP block, or
14  * sometimes an entire off-CPU chip) reset all of its internal state to some
15  * known-good initial state. Drivers will often reset HW modules when they
17  * or in response to some error condition. Reset signals are often controlled
18  * externally to the HW module being reset, by an entity this API calls a reset
20  * reset controllers set or clear reset signals.
22  * A driver that implements UCLASS_RESET is a reset controller or provider. A
23  * controller will often implement multiple separate reset signals, since the
24  * hardware it manages often has this capability. reset-uclass.h describes the
25  * interface which reset controllers must implement.
27  * Reset consumers/clients are the HW modules affected by reset signals. This
34  * struct reset_ctl - A handle to (allowing control of) a single reset signal.
36  * Clients provide storage for reset control handles. The content of the
37  * structure is managed solely by the reset API and reset drivers. A reset
38  * control struct is initialized by "get"ing the reset control struct. The
39  * reset control struct is passed to all other reset APIs to identify which
40  * reset signal to operate upon.
42  * @dev: The device which implements the reset signal.
43  * @id: The reset signal ID within the provider.
45  * Currently, the reset API assumes that a single integer ID is enough to
46  * identify and configure any reset signal for any reset provider. If this
48  * either (a) add more fields to allow reset providers to store additional
64  * struct reset_ctl_bulk - A handle to (allowing control of) a bulk of reset
67  * Clients provide storage for the reset control bulk. The content of the
68  * structure is managed solely by the reset API. A reset control bulk struct is
69  * initialized by "get"ing the reset control bulk struct.
70  * The reset control bulk struct is passed to all other bulk reset APIs to apply
71  * the API to all the reset signals in the bulk struct.
73  * @resets: An array of reset signal handles handles.
74  * @count: The number of reset signal handles in the reset array.
83  * reset_get_by_index - Get/request a reset signal by integer index.
85  * This looks up and requests a reset signal. The index is relative to the
86  * client device; each device is assumed to have n reset signals associated
88  * mapping of client device reset signal indices to provider reset signals may
93  * @index:	The index of the reset signal to request, within the client's
94  *		list of reset signals.
95  * @reset_ctl	A pointer to a reset control struct to initialize.
102  * reset_get_bulk - Get/request all reset signals of a device.
104  * This looks up and requests all reset signals of the client device; each
105  * device is assumed to have n reset signals associated with it somehow,
107  * The mapping of client device reset signals indices to provider reset signals
112  * @bulk	A pointer to a reset control bulk struct to initialize.
118  * reset_get_by_name - Get/request a reset signal by name.
120  * This looks up and requests a reset signal. The name is relative to the
121  * client device; each device is assumed to have n reset signals associated
123  * mapping of client device reset signal names to provider reset signal may be
128  * @name:	The name of the reset signal to request, within the client's
129  *		list of reset signals.
130  * @reset_ctl:	A pointer to a reset control struct to initialize.
137  * reset_request - Request a reset signal.
139  * @reset_ctl:	A reset control struct.
146  * reset_free - Free a previously requested reset signal.
148  * @reset_ctl:	A reset control struct that was previously successfully
155  * reset_assert - Assert a reset signal.
157  * This function will assert the specified reset signal, thus resetting the
158  * affected HW module(s). Depending on the reset controller hardware, the reset
160  * hardware may autonomously clear the reset signal itself.
162  * @reset_ctl:	A reset control struct that was previously successfully
169  * reset_assert_bulk - Assert all reset signals in a reset control bulk struct.
171  * This function will assert the specified reset signals in a reset control
173  * reset controller hardware, the reset signals will either stay asserted
175  * clear the reset signals itself.
177  * @bulk:	A reset control bulk struct that was previously successfully
184  * reset_deassert - Deassert a reset signal.
186  * This function will deassert the specified reset signal, thus releasing the
187  * affected HW modules() from reset, and allowing them to continue normal
190  * @reset_ctl:	A reset control struct that was previously successfully
197  * reset_deassert_bulk - Deassert all reset signals in a reset control bulk
200  * This function will deassert the specified reset signals in a reset control
201  * bulk struct, thus releasing the affected HW modules() from reset, and
204  * @bulk:	A reset control bulk struct that was previously successfully
213  * For each reset contained in the reset array, this function will check if
214  * reset has been previously requested and then will assert and free it.
216  * @reset_ctl:	A reset struct array that was previously successfully
218  * @count	Number of reset contained in the array
224  * reset_release_bulk - Assert/Free an array of previously requested reset
225  * signals in a reset control bulk struct.
227  * For each reset contained in the reset control bulk struct, this function
228  * will check if reset has been previously requested and then will assert
231  * @bulk:	A reset control bulk struct that was previously successfully