include/linux/reset.h

1 /* SPDX-License-Identifier: GPL-2.0 */
14  * struct reset_control_bulk_data - Data used for bulk reset control operations.
16  * @id: reset control consumer ID
17  * @rstc: struct reset_control * to store the associated reset control
19  * The reset APIs provide a series of reset_control_bulk_*() API calls as
20  * a convenience to consumers which require multiple reset controls.
114 	return optional ? 0 : -ENOTSUPP;  in __device_reset()
122 	return optional ? NULL : ERR_PTR(-ENOTSUPP);  in __of_reset_control_get()
130 	return optional ? NULL : ERR_PTR(-ENOTSUPP);  in __reset_control_get()
167 	return optional ? 0 : -EOPNOTSUPP;  in __reset_control_bulk_get()
180 	return optional ? NULL : ERR_PTR(-ENOTSUPP);  in __devm_reset_control_get()
188 	return optional ? 0 : -EOPNOTSUPP;  in __devm_reset_control_bulk_get()
194 	return optional ? NULL : ERR_PTR(-ENOTSUPP);  in devm_reset_control_array_get()
201 	return optional ? NULL : ERR_PTR(-ENOTSUPP);  in of_reset_control_array_get()
206 	return -ENOENT;  in reset_control_get_count()
222  * reset_control_get_exclusive - Lookup and obtain an exclusive reference
223  *                               to a reset controller.
224  * @dev: device to be reset by the controller
225  * @id: reset line name
229  * return -EBUSY.
232  * reset-controls.
243  * reset_control_bulk_get_exclusive - Lookup and obtain exclusive references to
244  *                                    multiple reset controllers.
245  * @dev: device to be reset by the controller
247  * @rstcs: array of struct reset_control_bulk_data with reset line names set
249  * Fills the rstcs array with pointers to exclusive reset controls and
260  * reset_control_get_exclusive_released - Lookup and obtain a temoprarily
261  *                                        exclusive reference to a reset
263  * @dev: device to be reset by the controller
264  * @id: reset line name
267  * reset-controls returned by this function must be acquired via
281  * reset_control_bulk_get_exclusive_released - Lookup and obtain temporarily
282  *                                    exclusive references to multiple reset
284  * @dev: device to be reset by the controller
286  * @rstcs: array of struct reset_control_bulk_data with reset line names set
288  * Fills the rstcs array with pointers to exclusive reset controls and
290  * reset-controls returned by this function must be acquired via
302  * reset_control_bulk_get_optional_exclusive_released - Lookup and obtain optional
304  *                                    reset controllers.
305  * @dev: device to be reset by the controller
307  * @rstcs: array of struct reset_control_bulk_data with reset line names set
310  * requested reset is not specified in the device tree, this function returns 0
323  * reset_control_get_shared - Lookup and obtain a shared reference to a
324  *                            reset controller.
325  * @dev: device to be reset by the controller
326  * @id: reset line name
329  * This function is intended for use with reset-controls which are shared
332  * When a reset-control is shared, the behavior of reset_control_assert /
333  * deassert is changed, the reset-core will keep track of a deassert_count
334  * and only (re-)assert the reset after reset_control_assert has been called
336  * about shared reset-controls in the reset_control_assert docs.
339  * is not allowed on a shared reset control. Calling reset_control_reset is
340  * also not allowed on a shared reset control.
351  * reset_control_bulk_get_shared - Lookup and obtain shared references to
352  *                                 multiple reset controllers.
353  * @dev: device to be reset by the controller
355  * @rstcs: array of struct reset_control_bulk_data with reset line names set
357  * Fills the rstcs array with pointers to shared reset controls and
368  * reset_control_get_optional_exclusive - optional reset_control_get_exclusive()
369  * @dev: device to be reset by the controller
370  * @id: reset line name
372  * Optional variant of reset_control_get_exclusive(). If the requested reset
385  * reset_control_bulk_get_optional_exclusive - optional
387  * @dev: device to be reset by the controller
389  * @rstcs: array of struct reset_control_bulk_data with reset line names set
405  * reset_control_get_optional_shared - optional reset_control_get_shared()
406  * @dev: device to be reset by the controller
407  * @id: reset line name
409  * Optional variant of reset_control_get_shared(). If the requested reset
422  * reset_control_bulk_get_optional_shared - optional
424  * @dev: device to be reset by the controller
426  * @rstcs: array of struct reset_control_bulk_data with reset line names set
442  * of_reset_control_get_exclusive - Lookup and obtain an exclusive reference
443  *                                  to a reset controller.
444  * @node: device to be reset by the controller
445  * @id: reset line name
458  * of_reset_control_get_optional_exclusive - Lookup and obtain an optional exclusive
459  *                                           reference to a reset controller.
460  * @node: device to be reset by the controller
461  * @id: reset line name
463  * Optional variant of of_reset_control_get_exclusive(). If the requested reset
478  * of_reset_control_get_shared - Lookup and obtain a shared reference
479  *                               to a reset controller.
480  * @node: device to be reset by the controller
481  * @id: reset line name
483  * When a reset-control is shared, the behavior of reset_control_assert /
484  * deassert is changed, the reset-core will keep track of a deassert_count
485  * and only (re-)assert the reset after reset_control_assert has been called
487  * about shared reset-controls in the reset_control_assert docs.
490  * is not allowed on a shared reset control. Calling reset_control_reset is
491  * also not allowed on a shared reset control.
503  * of_reset_control_get_exclusive_by_index - Lookup and obtain an exclusive
504  *                                           reference to a reset controller
506  * @node: device to be reset by the controller
507  * @index: index of the reset controller
520  * of_reset_control_get_shared_by_index - Lookup and obtain a shared
521  *                                        reference to a reset controller
523  * @node: device to be reset by the controller
524  * @index: index of the reset controller
526  * When a reset-control is shared, the behavior of reset_control_assert /
527  * deassert is changed, the reset-core will keep track of a deassert_count
528  * and only (re-)assert the reset after reset_control_assert has been called
530  * about shared reset-controls in the reset_control_assert docs.
533  * is not allowed on a shared reset control. Calling reset_control_reset is
534  * also not allowed on a shared reset control.
548  * devm_reset_control_get_exclusive - resource managed
550  * @dev: device to be reset by the controller
551  * @id: reset line name
553  * Managed reset_control_get_exclusive(). For reset controllers returned
567  * devm_reset_control_bulk_get_exclusive - resource managed
569  * @dev: device to be reset by the controller
571  * @rstcs: array of struct reset_control_bulk_data with reset line names set
573  * Managed reset_control_bulk_get_exclusive(). For reset controllers returned
587  * devm_reset_control_get_exclusive_released - resource managed
589  * @dev: device to be reset by the controller
590  * @id: reset line name
592  * Managed reset_control_get_exclusive_released(). For reset controllers
606  * devm_reset_control_bulk_get_exclusive_released - resource managed
608  * @dev: device to be reset by the controller
610  * @rstcs: array of struct reset_control_bulk_data with reset line names set
612  * Managed reset_control_bulk_get_exclusive_released(). For reset controllers
626  * devm_reset_control_get_optional_exclusive_released - resource managed
628  * @dev: device to be reset by the controller
629  * @id: reset line name
631  * Managed-and-optional variant of reset_control_get_exclusive_released(). For
632  * reset controllers returned from this function, reset_control_put() is called
645  * devm_reset_control_bulk_get_optional_exclusive_released - resource managed
647  * @dev: device to be reset by the controller
649  * @rstcs: array of struct reset_control_bulk_data with reset line names set
651  * Managed reset_control_bulk_optional_get_exclusive_released(). For reset
665  * devm_reset_control_get_shared - resource managed reset_control_get_shared()
666  * @dev: device to be reset by the controller
667  * @id: reset line name
669  * Managed reset_control_get_shared(). For reset controllers returned from
680  * devm_reset_control_bulk_get_shared - resource managed
682  * @dev: device to be reset by the controller
684  * @rstcs: array of struct reset_control_bulk_data with reset line names set
686  * Managed reset_control_bulk_get_shared(). For reset controllers returned
700  * devm_reset_control_get_optional_exclusive - resource managed
702  * @dev: device to be reset by the controller
703  * @id: reset line name
705  * Managed reset_control_get_optional_exclusive(). For reset controllers
718  * devm_reset_control_bulk_get_optional_exclusive - resource managed
720  * @dev: device to be reset by the controller
722  * @rstcs: array of struct reset_control_bulk_data with reset line names set
724  * Managed reset_control_bulk_get_optional_exclusive(). For reset controllers
738  * devm_reset_control_get_optional_shared - resource managed
740  * @dev: device to be reset by the controller
741  * @id: reset line name
743  * Managed reset_control_get_optional_shared(). For reset controllers returned
756  * devm_reset_control_bulk_get_optional_shared - resource managed
758  * @dev: device to be reset by the controller
760  * @rstcs: array of struct reset_control_bulk_data with reset line names set
762  * Managed reset_control_bulk_get_optional_shared(). For reset controllers
776  * devm_reset_control_get_exclusive_by_index - resource managed
778  * @dev: device to be reset by the controller
779  * @index: index of the reset controller
781  * Managed reset_control_get_exclusive(). For reset controllers returned from
794  * devm_reset_control_get_shared_by_index - resource managed
796  * @dev: device to be reset by the controller
797  * @index: index of the reset controller
799  * Managed reset_control_get_shared(). For reset controllers returned from
849  * APIs to manage a list of reset controllers