16494d708SSimon Glass /* 26494d708SSimon Glass * Copyright (c) 2013 Google, Inc 36494d708SSimon Glass * 46494d708SSimon Glass * (C) Copyright 2012 56494d708SSimon Glass * Pavel Herrmann <morpheus.ibis@gmail.com> 66494d708SSimon Glass * 76494d708SSimon Glass * SPDX-License-Identifier: GPL-2.0+ 86494d708SSimon Glass */ 96494d708SSimon Glass 106494d708SSimon Glass #include <common.h> 116494d708SSimon Glass #include <errno.h> 126494d708SSimon Glass #include <malloc.h> 136494d708SSimon Glass #include <dm/device.h> 146494d708SSimon Glass #include <dm/device-internal.h> 156494d708SSimon Glass #include <dm/lists.h> 166494d708SSimon Glass #include <dm/uclass.h> 176494d708SSimon Glass #include <dm/uclass-internal.h> 186494d708SSimon Glass #include <dm/util.h> 196494d708SSimon Glass 206494d708SSimon Glass DECLARE_GLOBAL_DATA_PTR; 216494d708SSimon Glass 226494d708SSimon Glass struct uclass *uclass_find(enum uclass_id key) 236494d708SSimon Glass { 246494d708SSimon Glass struct uclass *uc; 256494d708SSimon Glass 26c910e2e2SSimon Glass if (!gd->dm_root) 27c910e2e2SSimon Glass return NULL; 286494d708SSimon Glass /* 296494d708SSimon Glass * TODO(sjg@chromium.org): Optimise this, perhaps moving the found 306494d708SSimon Glass * node to the start of the list, or creating a linear array mapping 316494d708SSimon Glass * id to node. 326494d708SSimon Glass */ 336494d708SSimon Glass list_for_each_entry(uc, &gd->uclass_root, sibling_node) { 346494d708SSimon Glass if (uc->uc_drv->id == key) 356494d708SSimon Glass return uc; 366494d708SSimon Glass } 376494d708SSimon Glass 386494d708SSimon Glass return NULL; 396494d708SSimon Glass } 406494d708SSimon Glass 416494d708SSimon Glass /** 426494d708SSimon Glass * uclass_add() - Create new uclass in list 436494d708SSimon Glass * @id: Id number to create 446494d708SSimon Glass * @ucp: Returns pointer to uclass, or NULL on error 456494d708SSimon Glass * @return 0 on success, -ve on error 466494d708SSimon Glass * 476494d708SSimon Glass * The new uclass is added to the list. There must be only one uclass for 486494d708SSimon Glass * each id. 496494d708SSimon Glass */ 506494d708SSimon Glass static int uclass_add(enum uclass_id id, struct uclass **ucp) 516494d708SSimon Glass { 526494d708SSimon Glass struct uclass_driver *uc_drv; 536494d708SSimon Glass struct uclass *uc; 546494d708SSimon Glass int ret; 556494d708SSimon Glass 566494d708SSimon Glass *ucp = NULL; 576494d708SSimon Glass uc_drv = lists_uclass_lookup(id); 586494d708SSimon Glass if (!uc_drv) { 596494d708SSimon Glass dm_warn("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n", 606494d708SSimon Glass id); 616494d708SSimon Glass return -ENOENT; 626494d708SSimon Glass } 636494d708SSimon Glass uc = calloc(1, sizeof(*uc)); 646494d708SSimon Glass if (!uc) 656494d708SSimon Glass return -ENOMEM; 666494d708SSimon Glass if (uc_drv->priv_auto_alloc_size) { 676494d708SSimon Glass uc->priv = calloc(1, uc_drv->priv_auto_alloc_size); 686494d708SSimon Glass if (!uc->priv) { 696494d708SSimon Glass ret = -ENOMEM; 706494d708SSimon Glass goto fail_mem; 716494d708SSimon Glass } 726494d708SSimon Glass } 736494d708SSimon Glass uc->uc_drv = uc_drv; 746494d708SSimon Glass INIT_LIST_HEAD(&uc->sibling_node); 756494d708SSimon Glass INIT_LIST_HEAD(&uc->dev_head); 7689876a55SSimon Glass list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST); 776494d708SSimon Glass 786494d708SSimon Glass if (uc_drv->init) { 796494d708SSimon Glass ret = uc_drv->init(uc); 806494d708SSimon Glass if (ret) 816494d708SSimon Glass goto fail; 826494d708SSimon Glass } 836494d708SSimon Glass 846494d708SSimon Glass *ucp = uc; 856494d708SSimon Glass 866494d708SSimon Glass return 0; 876494d708SSimon Glass fail: 886494d708SSimon Glass if (uc_drv->priv_auto_alloc_size) { 896494d708SSimon Glass free(uc->priv); 906494d708SSimon Glass uc->priv = NULL; 916494d708SSimon Glass } 926494d708SSimon Glass list_del(&uc->sibling_node); 936494d708SSimon Glass fail_mem: 946494d708SSimon Glass free(uc); 956494d708SSimon Glass 966494d708SSimon Glass return ret; 976494d708SSimon Glass } 986494d708SSimon Glass 996494d708SSimon Glass int uclass_destroy(struct uclass *uc) 1006494d708SSimon Glass { 1016494d708SSimon Glass struct uclass_driver *uc_drv; 10254c5d08aSHeiko Schocher struct udevice *dev, *tmp; 1036494d708SSimon Glass int ret; 1046494d708SSimon Glass 1056494d708SSimon Glass list_for_each_entry_safe(dev, tmp, &uc->dev_head, uclass_node) { 1066494d708SSimon Glass ret = device_remove(dev); 1076494d708SSimon Glass if (ret) 1086494d708SSimon Glass return ret; 1096494d708SSimon Glass ret = device_unbind(dev); 1106494d708SSimon Glass if (ret) 1116494d708SSimon Glass return ret; 1126494d708SSimon Glass } 1136494d708SSimon Glass 1146494d708SSimon Glass uc_drv = uc->uc_drv; 1156494d708SSimon Glass if (uc_drv->destroy) 1166494d708SSimon Glass uc_drv->destroy(uc); 1176494d708SSimon Glass list_del(&uc->sibling_node); 1186494d708SSimon Glass if (uc_drv->priv_auto_alloc_size) 1196494d708SSimon Glass free(uc->priv); 1206494d708SSimon Glass free(uc); 1216494d708SSimon Glass 1226494d708SSimon Glass return 0; 1236494d708SSimon Glass } 1246494d708SSimon Glass 1256494d708SSimon Glass int uclass_get(enum uclass_id id, struct uclass **ucp) 1266494d708SSimon Glass { 1276494d708SSimon Glass struct uclass *uc; 1286494d708SSimon Glass 1296494d708SSimon Glass *ucp = NULL; 1306494d708SSimon Glass uc = uclass_find(id); 1316494d708SSimon Glass if (!uc) 1326494d708SSimon Glass return uclass_add(id, ucp); 1336494d708SSimon Glass *ucp = uc; 1346494d708SSimon Glass 1356494d708SSimon Glass return 0; 1366494d708SSimon Glass } 1376494d708SSimon Glass 13854c5d08aSHeiko Schocher int uclass_find_device(enum uclass_id id, int index, struct udevice **devp) 1396494d708SSimon Glass { 1406494d708SSimon Glass struct uclass *uc; 14154c5d08aSHeiko Schocher struct udevice *dev; 1426494d708SSimon Glass int ret; 1436494d708SSimon Glass 1446494d708SSimon Glass *devp = NULL; 1456494d708SSimon Glass ret = uclass_get(id, &uc); 1466494d708SSimon Glass if (ret) 1476494d708SSimon Glass return ret; 1486494d708SSimon Glass 1496494d708SSimon Glass list_for_each_entry(dev, &uc->dev_head, uclass_node) { 1506494d708SSimon Glass if (!index--) { 1516494d708SSimon Glass *devp = dev; 1526494d708SSimon Glass return 0; 1536494d708SSimon Glass } 1546494d708SSimon Glass } 1556494d708SSimon Glass 1566494d708SSimon Glass return -ENODEV; 1576494d708SSimon Glass } 1586494d708SSimon Glass 1595a66a8ffSSimon Glass int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 1605a66a8ffSSimon Glass bool find_req_seq, struct udevice **devp) 1615a66a8ffSSimon Glass { 1625a66a8ffSSimon Glass struct uclass *uc; 1635a66a8ffSSimon Glass struct udevice *dev; 1645a66a8ffSSimon Glass int ret; 1655a66a8ffSSimon Glass 1665a66a8ffSSimon Glass *devp = NULL; 1675a66a8ffSSimon Glass debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 1685a66a8ffSSimon Glass if (seq_or_req_seq == -1) 1695a66a8ffSSimon Glass return -ENODEV; 1705a66a8ffSSimon Glass ret = uclass_get(id, &uc); 1715a66a8ffSSimon Glass if (ret) 1725a66a8ffSSimon Glass return ret; 1735a66a8ffSSimon Glass 1745a66a8ffSSimon Glass list_for_each_entry(dev, &uc->dev_head, uclass_node) { 1755a66a8ffSSimon Glass debug(" - %d %d\n", dev->req_seq, dev->seq); 1765a66a8ffSSimon Glass if ((find_req_seq ? dev->req_seq : dev->seq) == 1775a66a8ffSSimon Glass seq_or_req_seq) { 1785a66a8ffSSimon Glass *devp = dev; 1795a66a8ffSSimon Glass debug(" - found\n"); 1805a66a8ffSSimon Glass return 0; 1815a66a8ffSSimon Glass } 1825a66a8ffSSimon Glass } 1835a66a8ffSSimon Glass debug(" - not found\n"); 1845a66a8ffSSimon Glass 1855a66a8ffSSimon Glass return -ENODEV; 1865a66a8ffSSimon Glass } 1875a66a8ffSSimon Glass 188f4cdead2SSimon Glass static int uclass_find_device_by_of_offset(enum uclass_id id, int node, 189f4cdead2SSimon Glass struct udevice **devp) 190f4cdead2SSimon Glass { 191f4cdead2SSimon Glass struct uclass *uc; 192f4cdead2SSimon Glass struct udevice *dev; 193f4cdead2SSimon Glass int ret; 194f4cdead2SSimon Glass 195f4cdead2SSimon Glass *devp = NULL; 196f4cdead2SSimon Glass if (node < 0) 197f4cdead2SSimon Glass return -ENODEV; 198f4cdead2SSimon Glass ret = uclass_get(id, &uc); 199f4cdead2SSimon Glass if (ret) 200f4cdead2SSimon Glass return ret; 201f4cdead2SSimon Glass 202f4cdead2SSimon Glass list_for_each_entry(dev, &uc->dev_head, uclass_node) { 203f4cdead2SSimon Glass if (dev->of_offset == node) { 204f4cdead2SSimon Glass *devp = dev; 205f4cdead2SSimon Glass return 0; 206f4cdead2SSimon Glass } 207f4cdead2SSimon Glass } 208f4cdead2SSimon Glass 209f4cdead2SSimon Glass return -ENODEV; 210f4cdead2SSimon Glass } 211f4cdead2SSimon Glass 2129ca296a1SSimon Glass /** 2139ca296a1SSimon Glass * uclass_get_device_tail() - handle the end of a get_device call 2149ca296a1SSimon Glass * 2159ca296a1SSimon Glass * This handles returning an error or probing a device as needed. 2169ca296a1SSimon Glass * 2179ca296a1SSimon Glass * @dev: Device that needs to be probed 2189ca296a1SSimon Glass * @ret: Error to return. If non-zero then the device is not probed 2199ca296a1SSimon Glass * @devp: Returns the value of 'dev' if there is no error 2209ca296a1SSimon Glass * @return ret, if non-zero, else the result of the device_probe() call 2219ca296a1SSimon Glass */ 2229ca296a1SSimon Glass static int uclass_get_device_tail(struct udevice *dev, int ret, 2239ca296a1SSimon Glass struct udevice **devp) 2246494d708SSimon Glass { 2256494d708SSimon Glass if (ret) 2266494d708SSimon Glass return ret; 2276494d708SSimon Glass 2286494d708SSimon Glass ret = device_probe(dev); 2296494d708SSimon Glass if (ret) 2306494d708SSimon Glass return ret; 2316494d708SSimon Glass 2326494d708SSimon Glass *devp = dev; 2336494d708SSimon Glass 2346494d708SSimon Glass return 0; 2356494d708SSimon Glass } 2366494d708SSimon Glass 2379ca296a1SSimon Glass int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 2389ca296a1SSimon Glass { 2399ca296a1SSimon Glass struct udevice *dev; 2409ca296a1SSimon Glass int ret; 2419ca296a1SSimon Glass 2429ca296a1SSimon Glass *devp = NULL; 2439ca296a1SSimon Glass ret = uclass_find_device(id, index, &dev); 2449ca296a1SSimon Glass return uclass_get_device_tail(dev, ret, devp); 2459ca296a1SSimon Glass } 2469ca296a1SSimon Glass 2475a66a8ffSSimon Glass int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 2485a66a8ffSSimon Glass { 2495a66a8ffSSimon Glass struct udevice *dev; 2505a66a8ffSSimon Glass int ret; 2515a66a8ffSSimon Glass 2525a66a8ffSSimon Glass *devp = NULL; 2535a66a8ffSSimon Glass ret = uclass_find_device_by_seq(id, seq, false, &dev); 2545a66a8ffSSimon Glass if (ret == -ENODEV) { 2555a66a8ffSSimon Glass /* 2565a66a8ffSSimon Glass * We didn't find it in probed devices. See if there is one 2575a66a8ffSSimon Glass * that will request this seq if probed. 2585a66a8ffSSimon Glass */ 2595a66a8ffSSimon Glass ret = uclass_find_device_by_seq(id, seq, true, &dev); 2605a66a8ffSSimon Glass } 2615a66a8ffSSimon Glass return uclass_get_device_tail(dev, ret, devp); 2625a66a8ffSSimon Glass } 2635a66a8ffSSimon Glass 264f4cdead2SSimon Glass int uclass_get_device_by_of_offset(enum uclass_id id, int node, 265f4cdead2SSimon Glass struct udevice **devp) 266f4cdead2SSimon Glass { 267f4cdead2SSimon Glass struct udevice *dev; 268f4cdead2SSimon Glass int ret; 269f4cdead2SSimon Glass 270f4cdead2SSimon Glass *devp = NULL; 271f4cdead2SSimon Glass ret = uclass_find_device_by_of_offset(id, node, &dev); 272f4cdead2SSimon Glass return uclass_get_device_tail(dev, ret, devp); 273f4cdead2SSimon Glass } 274f4cdead2SSimon Glass 27554c5d08aSHeiko Schocher int uclass_first_device(enum uclass_id id, struct udevice **devp) 2766494d708SSimon Glass { 2776494d708SSimon Glass struct uclass *uc; 27854c5d08aSHeiko Schocher struct udevice *dev; 2796494d708SSimon Glass int ret; 2806494d708SSimon Glass 2816494d708SSimon Glass *devp = NULL; 2826494d708SSimon Glass ret = uclass_get(id, &uc); 2836494d708SSimon Glass if (ret) 2846494d708SSimon Glass return ret; 2856494d708SSimon Glass if (list_empty(&uc->dev_head)) 2866494d708SSimon Glass return 0; 2876494d708SSimon Glass 28854c5d08aSHeiko Schocher dev = list_first_entry(&uc->dev_head, struct udevice, uclass_node); 2896494d708SSimon Glass ret = device_probe(dev); 2906494d708SSimon Glass if (ret) 2916494d708SSimon Glass return ret; 2926494d708SSimon Glass *devp = dev; 2936494d708SSimon Glass 2946494d708SSimon Glass return 0; 2956494d708SSimon Glass } 2966494d708SSimon Glass 29754c5d08aSHeiko Schocher int uclass_next_device(struct udevice **devp) 2986494d708SSimon Glass { 29954c5d08aSHeiko Schocher struct udevice *dev = *devp; 3006494d708SSimon Glass int ret; 3016494d708SSimon Glass 3026494d708SSimon Glass *devp = NULL; 3036494d708SSimon Glass if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head)) 3046494d708SSimon Glass return 0; 3056494d708SSimon Glass 30654c5d08aSHeiko Schocher dev = list_entry(dev->uclass_node.next, struct udevice, 30754c5d08aSHeiko Schocher uclass_node); 3086494d708SSimon Glass ret = device_probe(dev); 3096494d708SSimon Glass if (ret) 3106494d708SSimon Glass return ret; 3116494d708SSimon Glass *devp = dev; 3126494d708SSimon Glass 3136494d708SSimon Glass return 0; 3146494d708SSimon Glass } 3156494d708SSimon Glass 31654c5d08aSHeiko Schocher int uclass_bind_device(struct udevice *dev) 3176494d708SSimon Glass { 3186494d708SSimon Glass struct uclass *uc; 3196494d708SSimon Glass int ret; 3206494d708SSimon Glass 3216494d708SSimon Glass uc = dev->uclass; 3226494d708SSimon Glass list_add_tail(&dev->uclass_node, &uc->dev_head); 3236494d708SSimon Glass 324*081f2fcbSSimon Glass if (dev->parent) { 325*081f2fcbSSimon Glass struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv; 326*081f2fcbSSimon Glass 327*081f2fcbSSimon Glass if (uc_drv->child_post_bind) { 328*081f2fcbSSimon Glass ret = uc_drv->child_post_bind(dev); 329*081f2fcbSSimon Glass if (ret) 330*081f2fcbSSimon Glass goto err; 331*081f2fcbSSimon Glass } 332*081f2fcbSSimon Glass } 3336494d708SSimon Glass if (uc->uc_drv->post_bind) { 3346494d708SSimon Glass ret = uc->uc_drv->post_bind(dev); 335*081f2fcbSSimon Glass if (ret) 336*081f2fcbSSimon Glass goto err; 3376494d708SSimon Glass } 3386494d708SSimon Glass 3396494d708SSimon Glass return 0; 340*081f2fcbSSimon Glass err: 341*081f2fcbSSimon Glass /* There is no need to undo the parent's post_bind call */ 342*081f2fcbSSimon Glass list_del(&dev->uclass_node); 343*081f2fcbSSimon Glass 344*081f2fcbSSimon Glass return ret; 3456494d708SSimon Glass } 3466494d708SSimon Glass 34754c5d08aSHeiko Schocher int uclass_unbind_device(struct udevice *dev) 3486494d708SSimon Glass { 3496494d708SSimon Glass struct uclass *uc; 3506494d708SSimon Glass int ret; 3516494d708SSimon Glass 3526494d708SSimon Glass uc = dev->uclass; 3536494d708SSimon Glass if (uc->uc_drv->pre_unbind) { 3546494d708SSimon Glass ret = uc->uc_drv->pre_unbind(dev); 3556494d708SSimon Glass if (ret) 3566494d708SSimon Glass return ret; 3576494d708SSimon Glass } 3586494d708SSimon Glass 3596494d708SSimon Glass list_del(&dev->uclass_node); 3606494d708SSimon Glass return 0; 3616494d708SSimon Glass } 3626494d708SSimon Glass 3635a66a8ffSSimon Glass int uclass_resolve_seq(struct udevice *dev) 3645a66a8ffSSimon Glass { 3655a66a8ffSSimon Glass struct udevice *dup; 3665a66a8ffSSimon Glass int seq; 3675a66a8ffSSimon Glass int ret; 3685a66a8ffSSimon Glass 3695a66a8ffSSimon Glass assert(dev->seq == -1); 3705a66a8ffSSimon Glass ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 3715a66a8ffSSimon Glass false, &dup); 3725a66a8ffSSimon Glass if (!ret) { 3735a66a8ffSSimon Glass dm_warn("Device '%s': seq %d is in use by '%s'\n", 3745a66a8ffSSimon Glass dev->name, dev->req_seq, dup->name); 3755a66a8ffSSimon Glass } else if (ret == -ENODEV) { 3765a66a8ffSSimon Glass /* Our requested sequence number is available */ 3775a66a8ffSSimon Glass if (dev->req_seq != -1) 3785a66a8ffSSimon Glass return dev->req_seq; 3795a66a8ffSSimon Glass } else { 3805a66a8ffSSimon Glass return ret; 3815a66a8ffSSimon Glass } 3825a66a8ffSSimon Glass 3835a66a8ffSSimon Glass for (seq = 0; seq < DM_MAX_SEQ; seq++) { 3845a66a8ffSSimon Glass ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 3855a66a8ffSSimon Glass false, &dup); 3865a66a8ffSSimon Glass if (ret == -ENODEV) 3875a66a8ffSSimon Glass break; 3885a66a8ffSSimon Glass if (ret) 3895a66a8ffSSimon Glass return ret; 3905a66a8ffSSimon Glass } 3915a66a8ffSSimon Glass return seq; 3925a66a8ffSSimon Glass } 3935a66a8ffSSimon Glass 39454c5d08aSHeiko Schocher int uclass_post_probe_device(struct udevice *dev) 3956494d708SSimon Glass { 3966494d708SSimon Glass struct uclass_driver *uc_drv = dev->uclass->uc_drv; 3976494d708SSimon Glass 3986494d708SSimon Glass if (uc_drv->post_probe) 3996494d708SSimon Glass return uc_drv->post_probe(dev); 4006494d708SSimon Glass 4016494d708SSimon Glass return 0; 4026494d708SSimon Glass } 4036494d708SSimon Glass 40454c5d08aSHeiko Schocher int uclass_pre_remove_device(struct udevice *dev) 4056494d708SSimon Glass { 4066494d708SSimon Glass struct uclass_driver *uc_drv; 4076494d708SSimon Glass struct uclass *uc; 4086494d708SSimon Glass int ret; 4096494d708SSimon Glass 4106494d708SSimon Glass uc = dev->uclass; 4116494d708SSimon Glass uc_drv = uc->uc_drv; 4126494d708SSimon Glass if (uc->uc_drv->pre_remove) { 4136494d708SSimon Glass ret = uc->uc_drv->pre_remove(dev); 4146494d708SSimon Glass if (ret) 4156494d708SSimon Glass return ret; 4166494d708SSimon Glass } 4176494d708SSimon Glass if (uc_drv->per_device_auto_alloc_size) { 4186494d708SSimon Glass free(dev->uclass_priv); 4196494d708SSimon Glass dev->uclass_priv = NULL; 4206494d708SSimon Glass } 4215a66a8ffSSimon Glass dev->seq = -1; 4226494d708SSimon Glass 4236494d708SSimon Glass return 0; 4246494d708SSimon Glass } 425