drivers/core/uclass.c

   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 int uclass_get_device_tail(struct udevice *dev, int ret,
 267                                   struct udevice **devp)
 268 {
 269         if (ret)
 270                 return ret;
 271
 272         ret = device_probe(dev);
 273         if (ret)
 274                 return ret;
 275
 276         *devp = dev;
 277
 278         return 0;
 279 }
 280
 281 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
 282 {
 283         struct udevice *dev;
 284         int ret;
 285
 286         *devp = NULL;
 287         ret = uclass_find_device(id, index, &dev);
 288         return uclass_get_device_tail(dev, ret, devp);
 289 }
 290
 291 int uclass_get_device_by_name(enum uclass_id id, const char *name,
 292                               struct udevice **devp)
 293 {
 294         struct udevice *dev;
 295         int ret;
 296
 297         *devp = NULL;
 298         ret = uclass_find_device_by_name(id, name, &dev);
 299         return uclass_get_device_tail(dev, ret, devp);
 300 }
 301
 302 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
 303 {
 304         struct udevice *dev;
 305         int ret;
 306
 307         *devp = NULL;
 308         ret = uclass_find_device_by_seq(id, seq, false, &dev);
 309         if (ret == -ENODEV) {
 310                 /*
 311                  * We didn't find it in probed devices. See if there is one
 312                  * that will request this seq if probed.
 313                  */
 314                 ret = uclass_find_device_by_seq(id, seq, true, &dev);
 315         }
 316         return uclass_get_device_tail(dev, ret, devp);
 317 }
 318
 319 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
 320                                    struct udevice **devp)
 321 {
 322         struct udevice *dev;
 323         int ret;
 324
 325         *devp = NULL;
 326         ret = uclass_find_device_by_of_offset(id, node, &dev);
 327         return uclass_get_device_tail(dev, ret, devp);
 328 }
 329
 330 int uclass_first_device(enum uclass_id id, struct udevice **devp)
 331 {
 332         struct udevice *dev;
 333         int ret;
 334
 335         *devp = NULL;
 336         ret = uclass_find_first_device(id, &dev);
 337         return uclass_get_device_tail(dev, ret, devp);
 338 }
 339
 340 int uclass_next_device(struct udevice **devp)
 341 {
 342         struct udevice *dev = *devp;
 343         int ret;
 344
 345         *devp = NULL;
 346         ret = uclass_find_next_device(&dev);
 347         return uclass_get_device_tail(dev, ret, devp);
 348 }
 349
 350 int uclass_bind_device(struct udevice *dev)
 351 {
 352         struct uclass *uc;
 353         int ret;
 354
 355         uc = dev->uclass;
 356         list_add_tail(&dev->uclass_node, &uc->dev_head);
 357
 358         if (dev->parent) {
 359                 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
 360
 361                 if (uc_drv->child_post_bind) {
 362                         ret = uc_drv->child_post_bind(dev);
 363                         if (ret)
 364                                 goto err;
 365                 }
 366         }
 367         if (uc->uc_drv->post_bind) {
 368                 ret = uc->uc_drv->post_bind(dev);
 369                 if (ret)
 370                         goto err;
 371         }
 372
 373         return 0;
 374 err:
 375         /* There is no need to undo the parent's post_bind call */
 376         list_del(&dev->uclass_node);
 377
 378         return ret;
 379 }
 380
 381 int uclass_unbind_device(struct udevice *dev)
 382 {
 383         struct uclass *uc;
 384         int ret;
 385
 386         uc = dev->uclass;
 387         if (uc->uc_drv->pre_unbind) {
 388                 ret = uc->uc_drv->pre_unbind(dev);
 389                 if (ret)
 390                         return ret;
 391         }
 392
 393         list_del(&dev->uclass_node);
 394         return 0;
 395 }
 396
 397 int uclass_resolve_seq(struct udevice *dev)
 398 {
 399         struct udevice *dup;
 400         int seq;
 401         int ret;
 402
 403         assert(dev->seq == -1);
 404         ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
 405                                         false, &dup);
 406         if (!ret) {
 407                 dm_warn("Device '%s': seq %d is in use by '%s'\n",
 408                         dev->name, dev->req_seq, dup->name);
 409         } else if (ret == -ENODEV) {
 410                 /* Our requested sequence number is available */
 411                 if (dev->req_seq != -1)
 412                         return dev->req_seq;
 413         } else {
 414                 return ret;
 415         }
 416
 417         for (seq = 0; seq < DM_MAX_SEQ; seq++) {
 418                 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
 419                                                 false, &dup);
 420                 if (ret == -ENODEV)
 421                         break;
 422                 if (ret)
 423                         return ret;
 424         }
 425         return seq;
 426 }
 427
 428 int uclass_pre_probe_device(struct udevice *dev)
 429 {
 430         struct uclass_driver *uc_drv;
 431         int ret;
 432
 433         uc_drv = dev->uclass->uc_drv;
 434         if (uc_drv->pre_probe) {
 435                 ret = uc_drv->pre_probe(dev);
 436                 if (ret)
 437                         return ret;
 438         }
 439
 440         if (!dev->parent)
 441                 return 0;
 442         uc_drv = dev->parent->uclass->uc_drv;
 443         if (uc_drv->child_pre_probe)
 444                 return uc_drv->child_pre_probe(dev);
 445
 446         return 0;
 447 }
 448
 449 int uclass_post_probe_device(struct udevice *dev)
 450 {
 451         struct uclass_driver *uc_drv = dev->uclass->uc_drv;
 452
 453         if (uc_drv->post_probe)
 454                 return uc_drv->post_probe(dev);
 455
 456         return 0;
 457 }
 458
 459 int uclass_pre_remove_device(struct udevice *dev)
 460 {
 461         struct uclass_driver *uc_drv;
 462         struct uclass *uc;
 463         int ret;
 464
 465         uc = dev->uclass;
 466         uc_drv = uc->uc_drv;
 467         if (uc->uc_drv->pre_remove) {
 468                 ret = uc->uc_drv->pre_remove(dev);
 469                 if (ret)
 470                         return ret;
 471         }
 472         if (uc_drv->per_device_auto_alloc_size) {
 473                 free(dev->uclass_priv);
 474                 dev->uclass_priv = NULL;
 475         }
 476         dev->seq = -1;
 477
 478         return 0;
 479 }