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; 103 int ret; 104 105 /* 106 * We cannot use list_for_each_entry_safe() here. If a device in this 107 * uclass has a child device also in this uclass, it will be also be 108 * unbound (by the recursion in the call to device_unbind() below). 109 * We can loop until the list is empty. 110 */ 111 while (!list_empty(&uc->dev_head)) { 112 dev = list_first_entry(&uc->dev_head, struct udevice, 113 uclass_node); 114 ret = device_remove(dev); 115 if (ret) 116 return ret; 117 ret = device_unbind(dev); 118 if (ret) 119 return ret; 120 } 121 122 uc_drv = uc->uc_drv; 123 if (uc_drv->destroy) 124 uc_drv->destroy(uc); 125 list_del(&uc->sibling_node); 126 if (uc_drv->priv_auto_alloc_size) 127 free(uc->priv); 128 free(uc); 129 130 return 0; 131 } 132 133 int uclass_get(enum uclass_id id, struct uclass **ucp) 134 { 135 struct uclass *uc; 136 137 *ucp = NULL; 138 uc = uclass_find(id); 139 if (!uc) 140 return uclass_add(id, ucp); 141 *ucp = uc; 142 143 return 0; 144 } 145 146 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp) 147 { 148 struct uclass *uc; 149 struct udevice *dev; 150 int ret; 151 152 *devp = NULL; 153 ret = uclass_get(id, &uc); 154 if (ret) 155 return ret; 156 157 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 158 if (!index--) { 159 *devp = dev; 160 return 0; 161 } 162 } 163 164 return -ENODEV; 165 } 166 167 int uclass_find_first_device(enum uclass_id id, struct udevice **devp) 168 { 169 struct uclass *uc; 170 int ret; 171 172 *devp = NULL; 173 ret = uclass_get(id, &uc); 174 if (ret) 175 return ret; 176 if (list_empty(&uc->dev_head)) 177 return 0; 178 179 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node); 180 181 return 0; 182 } 183 184 int uclass_find_next_device(struct udevice **devp) 185 { 186 struct udevice *dev = *devp; 187 188 *devp = NULL; 189 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head)) 190 return 0; 191 192 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node); 193 194 return 0; 195 } 196 197 int uclass_find_device_by_name(enum uclass_id id, const char *name, 198 struct udevice **devp) 199 { 200 struct uclass *uc; 201 struct udevice *dev; 202 int ret; 203 204 *devp = NULL; 205 if (!name) 206 return -EINVAL; 207 ret = uclass_get(id, &uc); 208 if (ret) 209 return ret; 210 211 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 212 if (!strncmp(dev->name, name, strlen(name))) { 213 *devp = dev; 214 return 0; 215 } 216 } 217 218 return -ENODEV; 219 } 220 221 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 222 bool find_req_seq, struct udevice **devp) 223 { 224 struct uclass *uc; 225 struct udevice *dev; 226 int ret; 227 228 *devp = NULL; 229 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 230 if (seq_or_req_seq == -1) 231 return -ENODEV; 232 ret = uclass_get(id, &uc); 233 if (ret) 234 return ret; 235 236 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 237 debug(" - %d %d\n", dev->req_seq, dev->seq); 238 if ((find_req_seq ? dev->req_seq : dev->seq) == 239 seq_or_req_seq) { 240 *devp = dev; 241 debug(" - found\n"); 242 return 0; 243 } 244 } 245 debug(" - not found\n"); 246 247 return -ENODEV; 248 } 249 250 static int uclass_find_device_by_of_offset(enum uclass_id id, int node, 251 struct udevice **devp) 252 { 253 struct uclass *uc; 254 struct udevice *dev; 255 int ret; 256 257 *devp = NULL; 258 if (node < 0) 259 return -ENODEV; 260 ret = uclass_get(id, &uc); 261 if (ret) 262 return ret; 263 264 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 265 if (dev->of_offset == node) { 266 *devp = dev; 267 return 0; 268 } 269 } 270 271 return -ENODEV; 272 } 273 274 int uclass_get_device_tail(struct udevice *dev, int ret, 275 struct udevice **devp) 276 { 277 if (ret) 278 return ret; 279 280 ret = device_probe(dev); 281 if (ret) 282 return ret; 283 284 *devp = dev; 285 286 return 0; 287 } 288 289 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 290 { 291 struct udevice *dev; 292 int ret; 293 294 *devp = NULL; 295 ret = uclass_find_device(id, index, &dev); 296 return uclass_get_device_tail(dev, ret, devp); 297 } 298 299 int uclass_get_device_by_name(enum uclass_id id, const char *name, 300 struct udevice **devp) 301 { 302 struct udevice *dev; 303 int ret; 304 305 *devp = NULL; 306 ret = uclass_find_device_by_name(id, name, &dev); 307 return uclass_get_device_tail(dev, ret, devp); 308 } 309 310 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 311 { 312 struct udevice *dev; 313 int ret; 314 315 *devp = NULL; 316 ret = uclass_find_device_by_seq(id, seq, false, &dev); 317 if (ret == -ENODEV) { 318 /* 319 * We didn't find it in probed devices. See if there is one 320 * that will request this seq if probed. 321 */ 322 ret = uclass_find_device_by_seq(id, seq, true, &dev); 323 } 324 return uclass_get_device_tail(dev, ret, devp); 325 } 326 327 int uclass_get_device_by_of_offset(enum uclass_id id, int node, 328 struct udevice **devp) 329 { 330 struct udevice *dev; 331 int ret; 332 333 *devp = NULL; 334 ret = uclass_find_device_by_of_offset(id, node, &dev); 335 return uclass_get_device_tail(dev, ret, devp); 336 } 337 338 int uclass_first_device(enum uclass_id id, struct udevice **devp) 339 { 340 struct udevice *dev; 341 int ret; 342 343 *devp = NULL; 344 ret = uclass_find_first_device(id, &dev); 345 return uclass_get_device_tail(dev, ret, devp); 346 } 347 348 int uclass_next_device(struct udevice **devp) 349 { 350 struct udevice *dev = *devp; 351 int ret; 352 353 *devp = NULL; 354 ret = uclass_find_next_device(&dev); 355 return uclass_get_device_tail(dev, ret, devp); 356 } 357 358 int uclass_bind_device(struct udevice *dev) 359 { 360 struct uclass *uc; 361 int ret; 362 363 uc = dev->uclass; 364 list_add_tail(&dev->uclass_node, &uc->dev_head); 365 366 if (dev->parent) { 367 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv; 368 369 if (uc_drv->child_post_bind) { 370 ret = uc_drv->child_post_bind(dev); 371 if (ret) 372 goto err; 373 } 374 } 375 if (uc->uc_drv->post_bind) { 376 ret = uc->uc_drv->post_bind(dev); 377 if (ret) 378 goto err; 379 } 380 381 return 0; 382 err: 383 /* There is no need to undo the parent's post_bind call */ 384 list_del(&dev->uclass_node); 385 386 return ret; 387 } 388 389 #ifdef CONFIG_DM_DEVICE_REMOVE 390 int uclass_unbind_device(struct udevice *dev) 391 { 392 struct uclass *uc; 393 int ret; 394 395 uc = dev->uclass; 396 if (uc->uc_drv->pre_unbind) { 397 ret = uc->uc_drv->pre_unbind(dev); 398 if (ret) 399 return ret; 400 } 401 402 list_del(&dev->uclass_node); 403 return 0; 404 } 405 #endif 406 407 int uclass_resolve_seq(struct udevice *dev) 408 { 409 struct udevice *dup; 410 int seq; 411 int ret; 412 413 assert(dev->seq == -1); 414 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 415 false, &dup); 416 if (!ret) { 417 dm_warn("Device '%s': seq %d is in use by '%s'\n", 418 dev->name, dev->req_seq, dup->name); 419 } else if (ret == -ENODEV) { 420 /* Our requested sequence number is available */ 421 if (dev->req_seq != -1) 422 return dev->req_seq; 423 } else { 424 return ret; 425 } 426 427 for (seq = 0; seq < DM_MAX_SEQ; seq++) { 428 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 429 false, &dup); 430 if (ret == -ENODEV) 431 break; 432 if (ret) 433 return ret; 434 } 435 return seq; 436 } 437 438 int uclass_pre_probe_device(struct udevice *dev) 439 { 440 struct uclass_driver *uc_drv; 441 int ret; 442 443 uc_drv = dev->uclass->uc_drv; 444 if (uc_drv->pre_probe) { 445 ret = uc_drv->pre_probe(dev); 446 if (ret) 447 return ret; 448 } 449 450 if (!dev->parent) 451 return 0; 452 uc_drv = dev->parent->uclass->uc_drv; 453 if (uc_drv->child_pre_probe) 454 return uc_drv->child_pre_probe(dev); 455 456 return 0; 457 } 458 459 int uclass_post_probe_device(struct udevice *dev) 460 { 461 struct uclass_driver *uc_drv = dev->uclass->uc_drv; 462 463 if (uc_drv->post_probe) 464 return uc_drv->post_probe(dev); 465 466 return 0; 467 } 468 469 #ifdef CONFIG_DM_DEVICE_REMOVE 470 int uclass_pre_remove_device(struct udevice *dev) 471 { 472 struct uclass_driver *uc_drv; 473 struct uclass *uc; 474 int ret; 475 476 uc = dev->uclass; 477 uc_drv = uc->uc_drv; 478 if (uc->uc_drv->pre_remove) { 479 ret = uc->uc_drv->pre_remove(dev); 480 if (ret) 481 return ret; 482 } 483 if (uc_drv->per_device_auto_alloc_size) { 484 free(dev->uclass_priv); 485 dev->uclass_priv = NULL; 486 } 487 dev->seq = -1; 488 489 return 0; 490 } 491 #endif 492