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_name(enum uclass_id id, const char *name, 190 struct udevice **devp) 191 { 192 struct uclass *uc; 193 struct udevice *dev; 194 int ret; 195 196 *devp = NULL; 197 if (!name) 198 return -EINVAL; 199 ret = uclass_get(id, &uc); 200 if (ret) 201 return ret; 202 203 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 204 if (!strncmp(dev->name, name, strlen(name))) { 205 *devp = dev; 206 return 0; 207 } 208 } 209 210 return -ENODEV; 211 } 212 213 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 214 bool find_req_seq, struct udevice **devp) 215 { 216 struct uclass *uc; 217 struct udevice *dev; 218 int ret; 219 220 *devp = NULL; 221 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 222 if (seq_or_req_seq == -1) 223 return -ENODEV; 224 ret = uclass_get(id, &uc); 225 if (ret) 226 return ret; 227 228 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 229 debug(" - %d %d\n", dev->req_seq, dev->seq); 230 if ((find_req_seq ? dev->req_seq : dev->seq) == 231 seq_or_req_seq) { 232 *devp = dev; 233 debug(" - found\n"); 234 return 0; 235 } 236 } 237 debug(" - not found\n"); 238 239 return -ENODEV; 240 } 241 242 static int uclass_find_device_by_of_offset(enum uclass_id id, int node, 243 struct udevice **devp) 244 { 245 struct uclass *uc; 246 struct udevice *dev; 247 int ret; 248 249 *devp = NULL; 250 if (node < 0) 251 return -ENODEV; 252 ret = uclass_get(id, &uc); 253 if (ret) 254 return ret; 255 256 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 257 if (dev->of_offset == node) { 258 *devp = dev; 259 return 0; 260 } 261 } 262 263 return -ENODEV; 264 } 265 266 /** 267 * uclass_get_device_tail() - handle the end of a get_device call 268 * 269 * This handles returning an error or probing a device as needed. 270 * 271 * @dev: Device that needs to be probed 272 * @ret: Error to return. If non-zero then the device is not probed 273 * @devp: Returns the value of 'dev' if there is no error 274 * @return ret, if non-zero, else the result of the device_probe() call 275 */ 276 static int uclass_get_device_tail(struct udevice *dev, int ret, 277 struct udevice **devp) 278 { 279 if (ret) 280 return ret; 281 282 ret = device_probe(dev); 283 if (ret) 284 return ret; 285 286 *devp = dev; 287 288 return 0; 289 } 290 291 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 292 { 293 struct udevice *dev; 294 int ret; 295 296 *devp = NULL; 297 ret = uclass_find_device(id, index, &dev); 298 return uclass_get_device_tail(dev, ret, devp); 299 } 300 301 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 302 { 303 struct udevice *dev; 304 int ret; 305 306 *devp = NULL; 307 ret = uclass_find_device_by_seq(id, seq, false, &dev); 308 if (ret == -ENODEV) { 309 /* 310 * We didn't find it in probed devices. See if there is one 311 * that will request this seq if probed. 312 */ 313 ret = uclass_find_device_by_seq(id, seq, true, &dev); 314 } 315 return uclass_get_device_tail(dev, ret, devp); 316 } 317 318 int uclass_get_device_by_of_offset(enum uclass_id id, int node, 319 struct udevice **devp) 320 { 321 struct udevice *dev; 322 int ret; 323 324 *devp = NULL; 325 ret = uclass_find_device_by_of_offset(id, node, &dev); 326 return uclass_get_device_tail(dev, ret, devp); 327 } 328 329 int uclass_first_device(enum uclass_id id, struct udevice **devp) 330 { 331 struct udevice *dev; 332 int ret; 333 334 *devp = NULL; 335 ret = uclass_find_first_device(id, &dev); 336 return uclass_get_device_tail(dev, ret, devp); 337 } 338 339 int uclass_next_device(struct udevice **devp) 340 { 341 struct udevice *dev = *devp; 342 int ret; 343 344 *devp = NULL; 345 ret = uclass_find_next_device(&dev); 346 return uclass_get_device_tail(dev, ret, devp); 347 } 348 349 int uclass_bind_device(struct udevice *dev) 350 { 351 struct uclass *uc; 352 int ret; 353 354 uc = dev->uclass; 355 list_add_tail(&dev->uclass_node, &uc->dev_head); 356 357 if (dev->parent) { 358 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv; 359 360 if (uc_drv->child_post_bind) { 361 ret = uc_drv->child_post_bind(dev); 362 if (ret) 363 goto err; 364 } 365 } 366 if (uc->uc_drv->post_bind) { 367 ret = uc->uc_drv->post_bind(dev); 368 if (ret) 369 goto err; 370 } 371 372 return 0; 373 err: 374 /* There is no need to undo the parent's post_bind call */ 375 list_del(&dev->uclass_node); 376 377 return ret; 378 } 379 380 int uclass_unbind_device(struct udevice *dev) 381 { 382 struct uclass *uc; 383 int ret; 384 385 uc = dev->uclass; 386 if (uc->uc_drv->pre_unbind) { 387 ret = uc->uc_drv->pre_unbind(dev); 388 if (ret) 389 return ret; 390 } 391 392 list_del(&dev->uclass_node); 393 return 0; 394 } 395 396 int uclass_resolve_seq(struct udevice *dev) 397 { 398 struct udevice *dup; 399 int seq; 400 int ret; 401 402 assert(dev->seq == -1); 403 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 404 false, &dup); 405 if (!ret) { 406 dm_warn("Device '%s': seq %d is in use by '%s'\n", 407 dev->name, dev->req_seq, dup->name); 408 } else if (ret == -ENODEV) { 409 /* Our requested sequence number is available */ 410 if (dev->req_seq != -1) 411 return dev->req_seq; 412 } else { 413 return ret; 414 } 415 416 for (seq = 0; seq < DM_MAX_SEQ; seq++) { 417 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 418 false, &dup); 419 if (ret == -ENODEV) 420 break; 421 if (ret) 422 return ret; 423 } 424 return seq; 425 } 426 427 int uclass_pre_probe_device(struct udevice *dev) 428 { 429 struct uclass_driver *uc_drv; 430 int ret; 431 432 uc_drv = dev->uclass->uc_drv; 433 if (uc_drv->pre_probe) { 434 ret = uc_drv->pre_probe(dev); 435 if (ret) 436 return ret; 437 } 438 439 if (!dev->parent) 440 return 0; 441 uc_drv = dev->parent->uclass->uc_drv; 442 if (uc_drv->child_pre_probe) 443 return uc_drv->child_pre_probe(dev); 444 445 return 0; 446 } 447 448 int uclass_post_probe_device(struct udevice *dev) 449 { 450 struct uclass_driver *uc_drv = dev->uclass->uc_drv; 451 452 if (uc_drv->post_probe) 453 return uc_drv->post_probe(dev); 454 455 return 0; 456 } 457 458 int uclass_pre_remove_device(struct udevice *dev) 459 { 460 struct uclass_driver *uc_drv; 461 struct uclass *uc; 462 int ret; 463 464 uc = dev->uclass; 465 uc_drv = uc->uc_drv; 466 if (uc->uc_drv->pre_remove) { 467 ret = uc->uc_drv->pre_remove(dev); 468 if (ret) 469 return ret; 470 } 471 if (uc_drv->per_device_auto_alloc_size) { 472 free(dev->uclass_priv); 473 dev->uclass_priv = NULL; 474 } 475 dev->seq = -1; 476 477 return 0; 478 } 479