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 #include <common.h> 11 #include <errno.h> 12 #include <malloc.h> 13 #include <dm/device.h> 14 #include <dm/device-internal.h> 15 #include <dm/lists.h> 16 #include <dm/uclass.h> 17 #include <dm/uclass-internal.h> 18 #include <dm/util.h> 19 20 DECLARE_GLOBAL_DATA_PTR; 21 22 struct uclass *uclass_find(enum uclass_id key) 23 { 24 struct uclass *uc; 25 26 if (!gd->dm_root) 27 return NULL; 28 /* 29 * TODO(sjg@chromium.org): Optimise this, perhaps moving the found 30 * node to the start of the list, or creating a linear array mapping 31 * id to node. 32 */ 33 list_for_each_entry(uc, &gd->uclass_root, sibling_node) { 34 if (uc->uc_drv->id == key) 35 return uc; 36 } 37 38 return NULL; 39 } 40 41 /** 42 * uclass_add() - Create new uclass in list 43 * @id: Id number to create 44 * @ucp: Returns pointer to uclass, or NULL on error 45 * @return 0 on success, -ve on error 46 * 47 * The new uclass is added to the list. There must be only one uclass for 48 * each id. 49 */ 50 static int uclass_add(enum uclass_id id, struct uclass **ucp) 51 { 52 struct uclass_driver *uc_drv; 53 struct uclass *uc; 54 int ret; 55 56 *ucp = NULL; 57 uc_drv = lists_uclass_lookup(id); 58 if (!uc_drv) { 59 dm_warn("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n", 60 id); 61 return -ENOENT; 62 } 63 uc = calloc(1, sizeof(*uc)); 64 if (!uc) 65 return -ENOMEM; 66 if (uc_drv->priv_auto_alloc_size) { 67 uc->priv = calloc(1, uc_drv->priv_auto_alloc_size); 68 if (!uc->priv) { 69 ret = -ENOMEM; 70 goto fail_mem; 71 } 72 } 73 uc->uc_drv = uc_drv; 74 INIT_LIST_HEAD(&uc->sibling_node); 75 INIT_LIST_HEAD(&uc->dev_head); 76 list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST); 77 78 if (uc_drv->init) { 79 ret = uc_drv->init(uc); 80 if (ret) 81 goto fail; 82 } 83 84 *ucp = uc; 85 86 return 0; 87 fail: 88 if (uc_drv->priv_auto_alloc_size) { 89 free(uc->priv); 90 uc->priv = NULL; 91 } 92 list_del(&uc->sibling_node); 93 fail_mem: 94 free(uc); 95 96 return ret; 97 } 98 99 int uclass_destroy(struct uclass *uc) 100 { 101 struct uclass_driver *uc_drv; 102 struct udevice *dev, *tmp; 103 int ret; 104 105 list_for_each_entry_safe(dev, tmp, &uc->dev_head, uclass_node) { 106 ret = device_remove(dev); 107 if (ret) 108 return ret; 109 ret = device_unbind(dev); 110 if (ret) 111 return ret; 112 } 113 114 uc_drv = uc->uc_drv; 115 if (uc_drv->destroy) 116 uc_drv->destroy(uc); 117 list_del(&uc->sibling_node); 118 if (uc_drv->priv_auto_alloc_size) 119 free(uc->priv); 120 free(uc); 121 122 return 0; 123 } 124 125 int uclass_get(enum uclass_id id, struct uclass **ucp) 126 { 127 struct uclass *uc; 128 129 *ucp = NULL; 130 uc = uclass_find(id); 131 if (!uc) 132 return uclass_add(id, ucp); 133 *ucp = uc; 134 135 return 0; 136 } 137 138 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp) 139 { 140 struct uclass *uc; 141 struct udevice *dev; 142 int ret; 143 144 *devp = NULL; 145 ret = uclass_get(id, &uc); 146 if (ret) 147 return ret; 148 149 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 150 if (!index--) { 151 *devp = dev; 152 return 0; 153 } 154 } 155 156 return -ENODEV; 157 } 158 159 int uclass_find_first_device(enum uclass_id id, struct udevice **devp) 160 { 161 struct uclass *uc; 162 int ret; 163 164 *devp = NULL; 165 ret = uclass_get(id, &uc); 166 if (ret) 167 return ret; 168 if (list_empty(&uc->dev_head)) 169 return 0; 170 171 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node); 172 173 return 0; 174 } 175 176 int uclass_find_next_device(struct udevice **devp) 177 { 178 struct udevice *dev = *devp; 179 180 *devp = NULL; 181 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head)) 182 return 0; 183 184 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node); 185 186 return 0; 187 } 188 189 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 190 bool find_req_seq, struct udevice **devp) 191 { 192 struct uclass *uc; 193 struct udevice *dev; 194 int ret; 195 196 *devp = NULL; 197 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 198 if (seq_or_req_seq == -1) 199 return -ENODEV; 200 ret = uclass_get(id, &uc); 201 if (ret) 202 return ret; 203 204 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 205 debug(" - %d %d\n", dev->req_seq, dev->seq); 206 if ((find_req_seq ? dev->req_seq : dev->seq) == 207 seq_or_req_seq) { 208 *devp = dev; 209 debug(" - found\n"); 210 return 0; 211 } 212 } 213 debug(" - not found\n"); 214 215 return -ENODEV; 216 } 217 218 static int uclass_find_device_by_of_offset(enum uclass_id id, int node, 219 struct udevice **devp) 220 { 221 struct uclass *uc; 222 struct udevice *dev; 223 int ret; 224 225 *devp = NULL; 226 if (node < 0) 227 return -ENODEV; 228 ret = uclass_get(id, &uc); 229 if (ret) 230 return ret; 231 232 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 233 if (dev->of_offset == node) { 234 *devp = dev; 235 return 0; 236 } 237 } 238 239 return -ENODEV; 240 } 241 242 /** 243 * uclass_get_device_tail() - handle the end of a get_device call 244 * 245 * This handles returning an error or probing a device as needed. 246 * 247 * @dev: Device that needs to be probed 248 * @ret: Error to return. If non-zero then the device is not probed 249 * @devp: Returns the value of 'dev' if there is no error 250 * @return ret, if non-zero, else the result of the device_probe() call 251 */ 252 static int uclass_get_device_tail(struct udevice *dev, int ret, 253 struct udevice **devp) 254 { 255 if (ret) 256 return ret; 257 258 ret = device_probe(dev); 259 if (ret) 260 return ret; 261 262 *devp = dev; 263 264 return 0; 265 } 266 267 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 268 { 269 struct udevice *dev; 270 int ret; 271 272 *devp = NULL; 273 ret = uclass_find_device(id, index, &dev); 274 return uclass_get_device_tail(dev, ret, devp); 275 } 276 277 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 278 { 279 struct udevice *dev; 280 int ret; 281 282 *devp = NULL; 283 ret = uclass_find_device_by_seq(id, seq, false, &dev); 284 if (ret == -ENODEV) { 285 /* 286 * We didn't find it in probed devices. See if there is one 287 * that will request this seq if probed. 288 */ 289 ret = uclass_find_device_by_seq(id, seq, true, &dev); 290 } 291 return uclass_get_device_tail(dev, ret, devp); 292 } 293 294 int uclass_get_device_by_of_offset(enum uclass_id id, int node, 295 struct udevice **devp) 296 { 297 struct udevice *dev; 298 int ret; 299 300 *devp = NULL; 301 ret = uclass_find_device_by_of_offset(id, node, &dev); 302 return uclass_get_device_tail(dev, ret, devp); 303 } 304 305 int uclass_first_device(enum uclass_id id, struct udevice **devp) 306 { 307 struct udevice *dev; 308 int ret; 309 310 *devp = NULL; 311 ret = uclass_find_first_device(id, &dev); 312 return uclass_get_device_tail(dev, ret, devp); 313 } 314 315 int uclass_next_device(struct udevice **devp) 316 { 317 struct udevice *dev = *devp; 318 int ret; 319 320 *devp = NULL; 321 ret = uclass_find_next_device(&dev); 322 return uclass_get_device_tail(dev, ret, devp); 323 } 324 325 int uclass_bind_device(struct udevice *dev) 326 { 327 struct uclass *uc; 328 int ret; 329 330 uc = dev->uclass; 331 list_add_tail(&dev->uclass_node, &uc->dev_head); 332 333 if (dev->parent) { 334 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv; 335 336 if (uc_drv->child_post_bind) { 337 ret = uc_drv->child_post_bind(dev); 338 if (ret) 339 goto err; 340 } 341 } 342 if (uc->uc_drv->post_bind) { 343 ret = uc->uc_drv->post_bind(dev); 344 if (ret) 345 goto err; 346 } 347 348 return 0; 349 err: 350 /* There is no need to undo the parent's post_bind call */ 351 list_del(&dev->uclass_node); 352 353 return ret; 354 } 355 356 int uclass_unbind_device(struct udevice *dev) 357 { 358 struct uclass *uc; 359 int ret; 360 361 uc = dev->uclass; 362 if (uc->uc_drv->pre_unbind) { 363 ret = uc->uc_drv->pre_unbind(dev); 364 if (ret) 365 return ret; 366 } 367 368 list_del(&dev->uclass_node); 369 return 0; 370 } 371 372 int uclass_resolve_seq(struct udevice *dev) 373 { 374 struct udevice *dup; 375 int seq; 376 int ret; 377 378 assert(dev->seq == -1); 379 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 380 false, &dup); 381 if (!ret) { 382 dm_warn("Device '%s': seq %d is in use by '%s'\n", 383 dev->name, dev->req_seq, dup->name); 384 } else if (ret == -ENODEV) { 385 /* Our requested sequence number is available */ 386 if (dev->req_seq != -1) 387 return dev->req_seq; 388 } else { 389 return ret; 390 } 391 392 for (seq = 0; seq < DM_MAX_SEQ; seq++) { 393 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 394 false, &dup); 395 if (ret == -ENODEV) 396 break; 397 if (ret) 398 return ret; 399 } 400 return seq; 401 } 402 403 int uclass_pre_probe_device(struct udevice *dev) 404 { 405 struct uclass_driver *uc_drv; 406 int ret; 407 408 uc_drv = dev->uclass->uc_drv; 409 if (uc_drv->pre_probe) { 410 ret = uc_drv->pre_probe(dev); 411 if (ret) 412 return ret; 413 } 414 415 if (!dev->parent) 416 return 0; 417 uc_drv = dev->parent->uclass->uc_drv; 418 if (uc_drv->child_pre_probe) 419 return uc_drv->child_pre_probe(dev); 420 421 return 0; 422 } 423 424 int uclass_post_probe_device(struct udevice *dev) 425 { 426 struct uclass_driver *uc_drv = dev->uclass->uc_drv; 427 428 if (uc_drv->post_probe) 429 return uc_drv->post_probe(dev); 430 431 return 0; 432 } 433 434 int uclass_pre_remove_device(struct udevice *dev) 435 { 436 struct uclass_driver *uc_drv; 437 struct uclass *uc; 438 int ret; 439 440 uc = dev->uclass; 441 uc_drv = uc->uc_drv; 442 if (uc->uc_drv->pre_remove) { 443 ret = uc->uc_drv->pre_remove(dev); 444 if (ret) 445 return ret; 446 } 447 if (uc_drv->per_device_auto_alloc_size) { 448 free(dev->uclass_priv); 449 dev->uclass_priv = NULL; 450 } 451 dev->seq = -1; 452 453 return 0; 454 } 455