1 /* 2 * Copyright (c) 2013 Google, Inc 3 * 4 * (C) Copyright 2012 5 * Pavel Herrmann <morpheus.ibis@gmail.com> 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 */ 9 10 #ifndef _DM_UCLASS_H 11 #define _DM_UCLASS_H 12 13 #include <dm/uclass-id.h> 14 #include <linker_lists.h> 15 #include <linux/list.h> 16 17 /** 18 * struct uclass - a U-Boot drive class, collecting together similar drivers 19 * 20 * A uclass provides an interface to a particular function, which is 21 * implemented by one or more drivers. Every driver belongs to a uclass even 22 * if it is the only driver in that uclass. An example uclass is GPIO, which 23 * provides the ability to change read inputs, set and clear outputs, etc. 24 * There may be drivers for on-chip SoC GPIO banks, I2C GPIO expanders and 25 * PMIC IO lines, all made available in a unified way through the uclass. 26 * 27 * @priv: Private data for this uclass 28 * @uc_drv: The driver for the uclass itself, not to be confused with a 29 * 'struct driver' 30 * @dev_head: List of devices in this uclass (devices are attached to their 31 * uclass when their bind method is called) 32 * @sibling_node: Next uclass in the linked list of uclasses 33 */ 34 struct uclass { 35 void *priv; 36 struct uclass_driver *uc_drv; 37 struct list_head dev_head; 38 struct list_head sibling_node; 39 }; 40 41 struct udevice; 42 43 /** 44 * struct uclass_driver - Driver for the uclass 45 * 46 * A uclass_driver provides a consistent interface to a set of related 47 * drivers. 48 * 49 * @name: Name of uclass driver 50 * @id: ID number of this uclass 51 * @post_bind: Called after a new device is bound to this uclass 52 * @pre_unbind: Called before a device is unbound from this uclass 53 * @post_probe: Called after a new device is probed 54 * @pre_remove: Called before a device is removed 55 * @init: Called to set up the uclass 56 * @destroy: Called to destroy the uclass 57 * @priv_auto_alloc_size: If non-zero this is the size of the private data 58 * to be allocated in the uclass's ->priv pointer. If zero, then the uclass 59 * driver is responsible for allocating any data required. 60 * @per_device_auto_alloc_size: Each device can hold private data owned 61 * by the uclass. If required this will be automatically allocated if this 62 * value is non-zero. 63 * @per_child_platdata_auto_alloc_size: A bus likes to store information about 64 * its children. If non-zero this is the size of this data, to be allocated 65 * in the child device's parent_platdata pointer. This value is only used as 66 * a falback if this member is 0 in the driver. 67 * @ops: Uclass operations, providing the consistent interface to devices 68 * within the uclass. 69 */ 70 struct uclass_driver { 71 const char *name; 72 enum uclass_id id; 73 int (*post_bind)(struct udevice *dev); 74 int (*pre_unbind)(struct udevice *dev); 75 int (*post_probe)(struct udevice *dev); 76 int (*pre_remove)(struct udevice *dev); 77 int (*init)(struct uclass *class); 78 int (*destroy)(struct uclass *class); 79 int priv_auto_alloc_size; 80 int per_device_auto_alloc_size; 81 int per_child_platdata_auto_alloc_size; 82 const void *ops; 83 }; 84 85 /* Declare a new uclass_driver */ 86 #define UCLASS_DRIVER(__name) \ 87 ll_entry_declare(struct uclass_driver, __name, uclass) 88 89 /** 90 * uclass_get() - Get a uclass based on an ID, creating it if needed 91 * 92 * Every uclass is identified by an ID, a number from 0 to n-1 where n is 93 * the number of uclasses. This function allows looking up a uclass by its 94 * ID. 95 * 96 * @key: ID to look up 97 * @ucp: Returns pointer to uclass (there is only one per ID) 98 * @return 0 if OK, -ve on error 99 */ 100 int uclass_get(enum uclass_id key, struct uclass **ucp); 101 102 /** 103 * uclass_get_device() - Get a uclass device based on an ID and index 104 * 105 * The device is probed to activate it ready for use. 106 * 107 * @id: ID to look up 108 * @index: Device number within that uclass (0=first) 109 * @devp: Returns pointer to device (there is only one per for each ID) 110 * @return 0 if OK, -ve on error 111 */ 112 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp); 113 114 /** 115 * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence 116 * 117 * If an active device has this sequence it will be returned. If there is no 118 * such device then this will check for a device that is requesting this 119 * sequence. 120 * 121 * The device is probed to activate it ready for use. 122 * 123 * @id: ID to look up 124 * @seq: Sequence number to find (0=first) 125 * @devp: Returns pointer to device (there is only one for each seq) 126 * @return 0 if OK, -ve on error 127 */ 128 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp); 129 130 /** 131 * uclass_get_device_by_of_offset() - Get a uclass device by device tree node 132 * 133 * This searches the devices in the uclass for one attached to the given 134 * device tree node. 135 * 136 * The device is probed to activate it ready for use. 137 * 138 * @id: ID to look up 139 * @node: Device tree offset to search for (if -ve then -ENODEV is returned) 140 * @devp: Returns pointer to device (there is only one for each node) 141 * @return 0 if OK, -ve on error 142 */ 143 int uclass_get_device_by_of_offset(enum uclass_id id, int node, 144 struct udevice **devp); 145 146 /** 147 * uclass_first_device() - Get the first device in a uclass 148 * 149 * The device returned is probed if necessary, and ready for use 150 * 151 * @id: Uclass ID to look up 152 * @devp: Returns pointer to the first device in that uclass, or NULL if none 153 * @return 0 if OK (found or not found), -1 on error 154 */ 155 int uclass_first_device(enum uclass_id id, struct udevice **devp); 156 157 /** 158 * uclass_next_device() - Get the next device in a uclass 159 * 160 * The device returned is probed if necessary, and ready for use 161 * 162 * @devp: On entry, pointer to device to lookup. On exit, returns pointer 163 * to the next device in the same uclass, or NULL if none 164 * @return 0 if OK (found or not found), -1 on error 165 */ 166 int uclass_next_device(struct udevice **devp); 167 168 /** 169 * uclass_resolve_seq() - Resolve a device's sequence number 170 * 171 * On entry dev->seq is -1, and dev->req_seq may be -1 (to allocate a 172 * sequence number automatically, or >= 0 to select a particular number. 173 * If the requested sequence number is in use, then this device will 174 * be allocated another one. 175 * 176 * Note that the device's seq value is not changed by this function. 177 * 178 * @dev: Device for which to allocate sequence number 179 * @return sequence number allocated, or -ve on error 180 */ 181 int uclass_resolve_seq(struct udevice *dev); 182 183 /** 184 * uclass_foreach_dev() - Helper function to iteration through devices 185 * 186 * This creates a for() loop which works through the available devices in 187 * a uclass in order from start to end. 188 * 189 * @pos: struct udevice * to hold the current device. Set to NULL when there 190 * are no more devices. 191 * @uc: uclass to scan 192 */ 193 #define uclass_foreach_dev(pos, uc) \ 194 for (pos = list_entry((&(uc)->dev_head)->next, typeof(*pos), \ 195 uclass_node); \ 196 prefetch(pos->uclass_node.next), \ 197 &pos->uclass_node != (&(uc)->dev_head); \ 198 pos = list_entry(pos->uclass_node.next, typeof(*pos), \ 199 uclass_node)) 200 201 #endif 202