u-boot/include/reset.h

12  * A reset is a hardware signal indicating that a HW module (or IP block, or
13  * sometimes an entire off-CPU chip) reset all of its internal state to some
14  * known-good initial state. Drivers will often reset HW modules when they
16  * or in response to some error condition. Reset signals are often controlled
17  * externally to the HW module being reset, by an entity this API calls a reset
19  * reset controllers set or clear reset signals.
21  * A driver that implements UCLASS_RESET is a reset controller or provider. A
22  * controller will often implement multiple separate reset signals, since the
23  * hardware it manages often has this capability. reset-uclass.h describes the
24  * interface which reset controllers must implement.
26  * Reset consumers/clients are the HW modules affected by reset signals. This
33  * struct reset_ctl - A handle to (allowing control of) a single reset signal.
35  * Clients provide storage for reset control handles. The content of the
36  * structure is managed solely by the reset API and reset drivers. A reset
37  * control struct is initialized by "get"ing the reset control struct. The
38  * reset control struct is passed to all other reset APIs to identify which
39  * reset signal to operate upon.
41  * @dev: The device which implements the reset signal.
42  * @id: The reset signal ID within the provider.
45  *	  processed during the various reset ops.
47  * Should additional information to identify and configure any reset signal
49  * either (a) add more fields to allow reset providers to store additional
65  * struct reset_ctl_bulk - A handle to (allowing control of) a bulk of reset
68  * Clients provide storage for the reset control bulk. The content of the
69  * structure is managed solely by the reset API. A reset control bulk struct is
70  * initialized by "get"ing the reset control bulk struct.
71  * The reset control bulk struct is passed to all other bulk reset APIs to apply
72  * the API to all the reset signals in the bulk struct.
74  * @resets: An array of reset signal handles handles.
75  * @count: The number of reset signal handles in the reset array.
84  * reset_get_by_index - Get/request a reset signal by integer index.
86  * This looks up and requests a reset signal. The index is relative to the
87  * client device; each device is assumed to have n reset signals associated
89  * mapping of client device reset signal indices to provider reset signals may
94  * @index:	The index of the reset signal to request, within the client's
95  *		list of reset signals.
96  * @reset_ctl	A pointer to a reset control struct to initialize.
103  * reset_get_bulk - Get/request all reset signals of a device.
105  * This looks up and requests all reset signals of the client device; each
106  * device is assumed to have n reset signals associated with it somehow,
108  * The mapping of client device reset signals indices to provider reset signals
113  * @bulk	A pointer to a reset control bulk struct to initialize.
119  * reset_get_by_name - Get/request a reset signal by name.
121  * This looks up and requests a reset signal. The name is relative to the
122  * client device; each device is assumed to have n reset signals associated
124  * mapping of client device reset signal names to provider reset signal may be
129  * @name:	The name of the reset signal to request, within the client's
130  *		list of reset signals.
131  * @reset_ctl:	A pointer to a reset control struct to initialize.
138  * reset_request - Request a reset signal.
140  * @reset_ctl:	A reset control struct.
147  * reset_free - Free a previously requested reset signal.
149  * @reset_ctl:	A reset control struct that was previously successfully
156  * reset_assert - Assert a reset signal.
158  * This function will assert the specified reset signal, thus resetting the
159  * affected HW module(s). Depending on the reset controller hardware, the reset
161  * hardware may autonomously clear the reset signal itself.
163  * @reset_ctl:	A reset control struct that was previously successfully
170  * reset_assert_bulk - Assert all reset signals in a reset control bulk struct.
172  * This function will assert the specified reset signals in a reset control
174  * reset controller hardware, the reset signals will either stay asserted
176  * clear the reset signals itself.
178  * @bulk:	A reset control bulk struct that was previously successfully
185  * reset_deassert - Deassert a reset signal.
187  * This function will deassert the specified reset signal, thus releasing the
188  * affected HW modules() from reset, and allowing them to continue normal
191  * @reset_ctl:	A reset control struct that was previously successfully
198  * reset_deassert_bulk - Deassert all reset signals in a reset control bulk
201  * This function will deassert the specified reset signals in a reset control
202  * bulk struct, thus releasing the affected HW modules() from reset, and
205  * @bulk:	A reset control bulk struct that was previously successfully
212  * rst_status - Check reset signal status.
214  * @reset_ctl:	The reset signal to check.
223  * For each reset contained in the reset array, this function will check if
224  * reset has been previously requested and then will assert and free it.
226  * @reset_ctl:	A reset struct array that was previously successfully
228  * @count	Number of reset contained in the array
234  * reset_release_bulk - Assert/Free an array of previously requested reset
235  * signals in a reset control bulk struct.
237  * For each reset contained in the reset control bulk struct, this function
238  * will check if reset has been previously requested and then will assert
241  * @bulk:	A reset control bulk struct that was previously successfully
310  * reset_valid() - check if reset is valid
312  * @reset_ctl:		the reset to check