2 * Copyright (c) 2013 Google, Inc
5 * Pavel Herrmann <morpheus.ibis@gmail.com>
7 * SPDX-License-Identifier: GPL-2.0+
10 #ifndef _DM_UCLASS_INTERNAL_H
11 #define _DM_UCLASS_INTERNAL_H
14 * uclass_find_device() - Return n-th child of uclass
15 * @id: Id number of the uclass
16 * @index: Position of the child in uclass's list
17 * #devp: Returns pointer to device, or NULL on error
19 * The device is not prepared for use - this is an internal function
21 * @return the uclass pointer of a child at the given index or
22 * return NULL on error.
24 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp);
27 * uclass_bind_device() - Associate device with a uclass
29 * Connect the device into uclass's list of devices.
31 * @dev: Pointer to the device
32 * #return 0 on success, -ve on error
34 int uclass_bind_device(struct udevice *dev);
37 * uclass_unbind_device() - Deassociate device with a uclass
39 * Disconnect the device from uclass's list of devices.
41 * @dev: Pointer to the device
42 * #return 0 on success, -ve on error
44 int uclass_unbind_device(struct udevice *dev);
47 * uclass_pre_probe_device() - Deal with a device that is about to be probed
49 * Perform any pre-processing that is needed by the uclass before it can be
50 * probed. This includes the uclass' pre-probe() method and the parent
51 * uclass' child_pre_probe() method.
53 * @dev: Pointer to the device
54 * #return 0 on success, -ve on error
56 int uclass_pre_probe_device(struct udevice *dev);
59 * uclass_post_probe_device() - Deal with a device that has just been probed
61 * Perform any post-processing of a probed device that is needed by the
64 * @dev: Pointer to the device
65 * #return 0 on success, -ve on error
67 int uclass_post_probe_device(struct udevice *dev);
70 * uclass_pre_remove_device() - Handle a device which is about to be removed
72 * Perform any pre-processing of a device that is about to be removed.
74 * @dev: Pointer to the device
75 * #return 0 on success, -ve on error
77 int uclass_pre_remove_device(struct udevice *dev);
80 * uclass_find() - Find uclass by its id
82 * @id: Id to serach for
83 * @return pointer to uclass, or NULL if not found
85 struct uclass *uclass_find(enum uclass_id key);
88 * uclass_destroy() - Destroy a uclass
90 * Destroy a uclass and all its devices
92 * @uc: uclass to destroy
93 * @return 0 on success, -ve on error
95 int uclass_destroy(struct uclass *uc);
98 * uclass_find_device_by_seq() - Find uclass device based on ID and sequence
100 * This searches for a device with the given seq or req_seq.
102 * For seq, if an active device has this sequence it will be returned.
103 * If there is no such device then this will return -ENODEV.
105 * For req_seq, if a device (whether activated or not) has this req_seq
106 * value, that device will be returned. This is a strong indication that
107 * the device will receive that sequence when activated.
109 * The device is NOT probed, it is merely returned.
112 * @seq_or_req_seq: Sequence number to find (0=first)
113 * @find_req_seq: true to find req_seq, false to find seq
114 * @devp: Returns pointer to device (there is only one per for each seq)
115 * @return 0 if OK, -ve on error
117 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
118 bool find_req_seq, struct udevice **devp);