1 /* 2 * Device manager 3 * 4 * Copyright (c) 2013 Google, Inc 5 * 6 * (C) Copyright 2012 7 * Pavel Herrmann <morpheus.ibis@gmail.com> 8 * 9 * SPDX-License-Identifier: GPL-2.0+ 10 */ 11 12 #include <common.h> 13 #include <fdtdec.h> 14 #include <malloc.h> 15 #include <dm/device.h> 16 #include <dm/device-internal.h> 17 #include <dm/lists.h> 18 #include <dm/platdata.h> 19 #include <dm/uclass.h> 20 #include <dm/uclass-internal.h> 21 #include <dm/util.h> 22 #include <linux/err.h> 23 #include <linux/list.h> 24 25 DECLARE_GLOBAL_DATA_PTR; 26 27 int device_bind(struct udevice *parent, struct driver *drv, const char *name, 28 void *platdata, int of_offset, struct udevice **devp) 29 { 30 struct udevice *dev; 31 struct uclass *uc; 32 int ret = 0; 33 34 *devp = NULL; 35 if (!name) 36 return -EINVAL; 37 38 ret = uclass_get(drv->id, &uc); 39 if (ret) 40 return ret; 41 42 dev = calloc(1, sizeof(struct udevice)); 43 if (!dev) 44 return -ENOMEM; 45 46 INIT_LIST_HEAD(&dev->sibling_node); 47 INIT_LIST_HEAD(&dev->child_head); 48 INIT_LIST_HEAD(&dev->uclass_node); 49 dev->platdata = platdata; 50 dev->name = name; 51 dev->of_offset = of_offset; 52 dev->parent = parent; 53 dev->driver = drv; 54 dev->uclass = uc; 55 56 dev->seq = -1; 57 dev->req_seq = -1; 58 #ifdef CONFIG_OF_CONTROL 59 /* 60 * Some devices, such as a SPI bus, I2C bus and serial ports are 61 * numbered using aliases. 62 * 63 * This is just a 'requested' sequence, and will be 64 * resolved (and ->seq updated) when the device is probed. 65 */ 66 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) { 67 if (uc->uc_drv->name && of_offset != -1) { 68 fdtdec_get_alias_seq(gd->fdt_blob, uc->uc_drv->name, 69 of_offset, &dev->req_seq); 70 } 71 } 72 #endif 73 if (!dev->platdata && drv->platdata_auto_alloc_size) { 74 dev->flags |= DM_FLAG_ALLOC_PDATA; 75 dev->platdata = calloc(1, drv->platdata_auto_alloc_size); 76 if (!dev->platdata) { 77 ret = -ENOMEM; 78 goto fail_alloc1; 79 } 80 } 81 if (parent) { 82 int size = parent->driver->per_child_platdata_auto_alloc_size; 83 84 if (!size) { 85 size = parent->uclass->uc_drv-> 86 per_child_platdata_auto_alloc_size; 87 } 88 if (size) { 89 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA; 90 dev->parent_platdata = calloc(1, size); 91 if (!dev->parent_platdata) { 92 ret = -ENOMEM; 93 goto fail_alloc2; 94 } 95 } 96 } 97 98 /* put dev into parent's successor list */ 99 if (parent) 100 list_add_tail(&dev->sibling_node, &parent->child_head); 101 102 ret = uclass_bind_device(dev); 103 if (ret) 104 goto fail_uclass_bind; 105 106 /* if we fail to bind we remove device from successors and free it */ 107 if (drv->bind) { 108 ret = drv->bind(dev); 109 if (ret) 110 goto fail_bind; 111 } 112 if (parent && parent->driver->child_post_bind) { 113 ret = parent->driver->child_post_bind(dev); 114 if (ret) 115 goto fail_child_post_bind; 116 } 117 118 if (parent) 119 dm_dbg("Bound device %s to %s\n", dev->name, parent->name); 120 *devp = dev; 121 122 return 0; 123 124 fail_child_post_bind: 125 if (drv->unbind && drv->unbind(dev)) { 126 dm_warn("unbind() method failed on dev '%s' on error path\n", 127 dev->name); 128 } 129 130 fail_bind: 131 if (uclass_unbind_device(dev)) { 132 dm_warn("Failed to unbind dev '%s' on error path\n", 133 dev->name); 134 } 135 fail_uclass_bind: 136 list_del(&dev->sibling_node); 137 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) { 138 free(dev->parent_platdata); 139 dev->parent_platdata = NULL; 140 } 141 fail_alloc2: 142 if (dev->flags & DM_FLAG_ALLOC_PDATA) { 143 free(dev->platdata); 144 dev->platdata = NULL; 145 } 146 fail_alloc1: 147 free(dev); 148 149 return ret; 150 } 151 152 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, 153 const struct driver_info *info, struct udevice **devp) 154 { 155 struct driver *drv; 156 157 drv = lists_driver_lookup_name(info->name); 158 if (!drv) 159 return -ENOENT; 160 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC)) 161 return -EPERM; 162 163 return device_bind(parent, drv, info->name, (void *)info->platdata, 164 -1, devp); 165 } 166 167 int device_probe_child(struct udevice *dev, void *parent_priv) 168 { 169 struct driver *drv; 170 int size = 0; 171 int ret; 172 int seq; 173 174 if (!dev) 175 return -EINVAL; 176 177 if (dev->flags & DM_FLAG_ACTIVATED) 178 return 0; 179 180 drv = dev->driver; 181 assert(drv); 182 183 /* Allocate private data if requested */ 184 if (drv->priv_auto_alloc_size) { 185 dev->priv = calloc(1, drv->priv_auto_alloc_size); 186 if (!dev->priv) { 187 ret = -ENOMEM; 188 goto fail; 189 } 190 } 191 /* Allocate private data if requested */ 192 size = dev->uclass->uc_drv->per_device_auto_alloc_size; 193 if (size) { 194 dev->uclass_priv = calloc(1, size); 195 if (!dev->uclass_priv) { 196 ret = -ENOMEM; 197 goto fail; 198 } 199 } 200 201 /* Ensure all parents are probed */ 202 if (dev->parent) { 203 size = dev->parent->driver->per_child_auto_alloc_size; 204 if (!size) { 205 size = dev->parent->uclass->uc_drv-> 206 per_child_auto_alloc_size; 207 } 208 if (size) { 209 dev->parent_priv = calloc(1, size); 210 if (!dev->parent_priv) { 211 ret = -ENOMEM; 212 goto fail; 213 } 214 if (parent_priv) 215 memcpy(dev->parent_priv, parent_priv, size); 216 } 217 218 ret = device_probe(dev->parent); 219 if (ret) 220 goto fail; 221 } 222 223 seq = uclass_resolve_seq(dev); 224 if (seq < 0) { 225 ret = seq; 226 goto fail; 227 } 228 dev->seq = seq; 229 230 ret = uclass_pre_probe_child(dev); 231 if (ret) 232 goto fail; 233 234 if (dev->parent && dev->parent->driver->child_pre_probe) { 235 ret = dev->parent->driver->child_pre_probe(dev); 236 if (ret) 237 goto fail; 238 } 239 240 if (drv->ofdata_to_platdata && dev->of_offset >= 0) { 241 ret = drv->ofdata_to_platdata(dev); 242 if (ret) 243 goto fail; 244 } 245 246 if (drv->probe) { 247 ret = drv->probe(dev); 248 if (ret) 249 goto fail; 250 } 251 252 dev->flags |= DM_FLAG_ACTIVATED; 253 254 ret = uclass_post_probe_device(dev); 255 if (ret) { 256 dev->flags &= ~DM_FLAG_ACTIVATED; 257 goto fail_uclass; 258 } 259 260 return 0; 261 fail_uclass: 262 if (device_remove(dev)) { 263 dm_warn("%s: Device '%s' failed to remove on error path\n", 264 __func__, dev->name); 265 } 266 fail: 267 dev->seq = -1; 268 device_free(dev); 269 270 return ret; 271 } 272 273 int device_probe(struct udevice *dev) 274 { 275 return device_probe_child(dev, NULL); 276 } 277 278 void *dev_get_platdata(struct udevice *dev) 279 { 280 if (!dev) { 281 dm_warn("%s: null device\n", __func__); 282 return NULL; 283 } 284 285 return dev->platdata; 286 } 287 288 void *dev_get_parent_platdata(struct udevice *dev) 289 { 290 if (!dev) { 291 dm_warn("%s: null device", __func__); 292 return NULL; 293 } 294 295 return dev->parent_platdata; 296 } 297 298 void *dev_get_priv(struct udevice *dev) 299 { 300 if (!dev) { 301 dm_warn("%s: null device\n", __func__); 302 return NULL; 303 } 304 305 return dev->priv; 306 } 307 308 void *dev_get_parentdata(struct udevice *dev) 309 { 310 if (!dev) { 311 dm_warn("%s: null device\n", __func__); 312 return NULL; 313 } 314 315 return dev->parent_priv; 316 } 317 318 static int device_get_device_tail(struct udevice *dev, int ret, 319 struct udevice **devp) 320 { 321 if (ret) 322 return ret; 323 324 ret = device_probe(dev); 325 if (ret) 326 return ret; 327 328 *devp = dev; 329 330 return 0; 331 } 332 333 int device_get_child(struct udevice *parent, int index, struct udevice **devp) 334 { 335 struct udevice *dev; 336 337 list_for_each_entry(dev, &parent->child_head, sibling_node) { 338 if (!index--) 339 return device_get_device_tail(dev, 0, devp); 340 } 341 342 return -ENODEV; 343 } 344 345 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq, 346 bool find_req_seq, struct udevice **devp) 347 { 348 struct udevice *dev; 349 350 *devp = NULL; 351 if (seq_or_req_seq == -1) 352 return -ENODEV; 353 354 list_for_each_entry(dev, &parent->child_head, sibling_node) { 355 if ((find_req_seq ? dev->req_seq : dev->seq) == 356 seq_or_req_seq) { 357 *devp = dev; 358 return 0; 359 } 360 } 361 362 return -ENODEV; 363 } 364 365 int device_get_child_by_seq(struct udevice *parent, int seq, 366 struct udevice **devp) 367 { 368 struct udevice *dev; 369 int ret; 370 371 *devp = NULL; 372 ret = device_find_child_by_seq(parent, seq, false, &dev); 373 if (ret == -ENODEV) { 374 /* 375 * We didn't find it in probed devices. See if there is one 376 * that will request this seq if probed. 377 */ 378 ret = device_find_child_by_seq(parent, seq, true, &dev); 379 } 380 return device_get_device_tail(dev, ret, devp); 381 } 382 383 int device_find_child_by_of_offset(struct udevice *parent, int of_offset, 384 struct udevice **devp) 385 { 386 struct udevice *dev; 387 388 *devp = NULL; 389 390 list_for_each_entry(dev, &parent->child_head, sibling_node) { 391 if (dev->of_offset == of_offset) { 392 *devp = dev; 393 return 0; 394 } 395 } 396 397 return -ENODEV; 398 } 399 400 int device_get_child_by_of_offset(struct udevice *parent, int seq, 401 struct udevice **devp) 402 { 403 struct udevice *dev; 404 int ret; 405 406 *devp = NULL; 407 ret = device_find_child_by_of_offset(parent, seq, &dev); 408 return device_get_device_tail(dev, ret, devp); 409 } 410 411 int device_find_first_child(struct udevice *parent, struct udevice **devp) 412 { 413 if (list_empty(&parent->child_head)) { 414 *devp = NULL; 415 } else { 416 *devp = list_first_entry(&parent->child_head, struct udevice, 417 sibling_node); 418 } 419 420 return 0; 421 } 422 423 int device_find_next_child(struct udevice **devp) 424 { 425 struct udevice *dev = *devp; 426 struct udevice *parent = dev->parent; 427 428 if (list_is_last(&dev->sibling_node, &parent->child_head)) { 429 *devp = NULL; 430 } else { 431 *devp = list_entry(dev->sibling_node.next, struct udevice, 432 sibling_node); 433 } 434 435 return 0; 436 } 437 438 struct udevice *dev_get_parent(struct udevice *child) 439 { 440 return child->parent; 441 } 442 443 ulong dev_get_of_data(struct udevice *dev) 444 { 445 return dev->of_id->data; 446 } 447 448 enum uclass_id device_get_uclass_id(struct udevice *dev) 449 { 450 return dev->uclass->uc_drv->id; 451 } 452 453 #ifdef CONFIG_OF_CONTROL 454 fdt_addr_t dev_get_addr(struct udevice *dev) 455 { 456 return fdtdec_get_addr(gd->fdt_blob, dev->of_offset, "reg"); 457 } 458 #else 459 fdt_addr_t dev_get_addr(struct udevice *dev) 460 { 461 return FDT_ADDR_T_NONE; 462 } 463 #endif 464