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 26*c910e2e2SSimon Glass if (!gd->dm_root) 27*c910e2e2SSimon 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 if (uc_drv->ops) { 646494d708SSimon Glass dm_warn("No ops for uclass id %d\n", id); 656494d708SSimon Glass return -EINVAL; 666494d708SSimon Glass } 676494d708SSimon Glass uc = calloc(1, sizeof(*uc)); 686494d708SSimon Glass if (!uc) 696494d708SSimon Glass return -ENOMEM; 706494d708SSimon Glass if (uc_drv->priv_auto_alloc_size) { 716494d708SSimon Glass uc->priv = calloc(1, uc_drv->priv_auto_alloc_size); 726494d708SSimon Glass if (!uc->priv) { 736494d708SSimon Glass ret = -ENOMEM; 746494d708SSimon Glass goto fail_mem; 756494d708SSimon Glass } 766494d708SSimon Glass } 776494d708SSimon Glass uc->uc_drv = uc_drv; 786494d708SSimon Glass INIT_LIST_HEAD(&uc->sibling_node); 796494d708SSimon Glass INIT_LIST_HEAD(&uc->dev_head); 8089876a55SSimon Glass list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST); 816494d708SSimon Glass 826494d708SSimon Glass if (uc_drv->init) { 836494d708SSimon Glass ret = uc_drv->init(uc); 846494d708SSimon Glass if (ret) 856494d708SSimon Glass goto fail; 866494d708SSimon Glass } 876494d708SSimon Glass 886494d708SSimon Glass *ucp = uc; 896494d708SSimon Glass 906494d708SSimon Glass return 0; 916494d708SSimon Glass fail: 926494d708SSimon Glass if (uc_drv->priv_auto_alloc_size) { 936494d708SSimon Glass free(uc->priv); 946494d708SSimon Glass uc->priv = NULL; 956494d708SSimon Glass } 966494d708SSimon Glass list_del(&uc->sibling_node); 976494d708SSimon Glass fail_mem: 986494d708SSimon Glass free(uc); 996494d708SSimon Glass 1006494d708SSimon Glass return ret; 1016494d708SSimon Glass } 1026494d708SSimon Glass 1036494d708SSimon Glass int uclass_destroy(struct uclass *uc) 1046494d708SSimon Glass { 1056494d708SSimon Glass struct uclass_driver *uc_drv; 10654c5d08aSHeiko Schocher struct udevice *dev, *tmp; 1076494d708SSimon Glass int ret; 1086494d708SSimon Glass 1096494d708SSimon Glass list_for_each_entry_safe(dev, tmp, &uc->dev_head, uclass_node) { 1106494d708SSimon Glass ret = device_remove(dev); 1116494d708SSimon Glass if (ret) 1126494d708SSimon Glass return ret; 1136494d708SSimon Glass ret = device_unbind(dev); 1146494d708SSimon Glass if (ret) 1156494d708SSimon Glass return ret; 1166494d708SSimon Glass } 1176494d708SSimon Glass 1186494d708SSimon Glass uc_drv = uc->uc_drv; 1196494d708SSimon Glass if (uc_drv->destroy) 1206494d708SSimon Glass uc_drv->destroy(uc); 1216494d708SSimon Glass list_del(&uc->sibling_node); 1226494d708SSimon Glass if (uc_drv->priv_auto_alloc_size) 1236494d708SSimon Glass free(uc->priv); 1246494d708SSimon Glass free(uc); 1256494d708SSimon Glass 1266494d708SSimon Glass return 0; 1276494d708SSimon Glass } 1286494d708SSimon Glass 1296494d708SSimon Glass int uclass_get(enum uclass_id id, struct uclass **ucp) 1306494d708SSimon Glass { 1316494d708SSimon Glass struct uclass *uc; 1326494d708SSimon Glass 1336494d708SSimon Glass *ucp = NULL; 1346494d708SSimon Glass uc = uclass_find(id); 1356494d708SSimon Glass if (!uc) 1366494d708SSimon Glass return uclass_add(id, ucp); 1376494d708SSimon Glass *ucp = uc; 1386494d708SSimon Glass 1396494d708SSimon Glass return 0; 1406494d708SSimon Glass } 1416494d708SSimon Glass 14254c5d08aSHeiko Schocher int uclass_find_device(enum uclass_id id, int index, struct udevice **devp) 1436494d708SSimon Glass { 1446494d708SSimon Glass struct uclass *uc; 14554c5d08aSHeiko Schocher struct udevice *dev; 1466494d708SSimon Glass int ret; 1476494d708SSimon Glass 1486494d708SSimon Glass *devp = NULL; 1496494d708SSimon Glass ret = uclass_get(id, &uc); 1506494d708SSimon Glass if (ret) 1516494d708SSimon Glass return ret; 1526494d708SSimon Glass 1536494d708SSimon Glass list_for_each_entry(dev, &uc->dev_head, uclass_node) { 1546494d708SSimon Glass if (!index--) { 1556494d708SSimon Glass *devp = dev; 1566494d708SSimon Glass return 0; 1576494d708SSimon Glass } 1586494d708SSimon Glass } 1596494d708SSimon Glass 1606494d708SSimon Glass return -ENODEV; 1616494d708SSimon Glass } 1626494d708SSimon Glass 1635a66a8ffSSimon Glass int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 1645a66a8ffSSimon Glass bool find_req_seq, struct udevice **devp) 1655a66a8ffSSimon Glass { 1665a66a8ffSSimon Glass struct uclass *uc; 1675a66a8ffSSimon Glass struct udevice *dev; 1685a66a8ffSSimon Glass int ret; 1695a66a8ffSSimon Glass 1705a66a8ffSSimon Glass *devp = NULL; 1715a66a8ffSSimon Glass debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 1725a66a8ffSSimon Glass if (seq_or_req_seq == -1) 1735a66a8ffSSimon Glass return -ENODEV; 1745a66a8ffSSimon Glass ret = uclass_get(id, &uc); 1755a66a8ffSSimon Glass if (ret) 1765a66a8ffSSimon Glass return ret; 1775a66a8ffSSimon Glass 1785a66a8ffSSimon Glass list_for_each_entry(dev, &uc->dev_head, uclass_node) { 1795a66a8ffSSimon Glass debug(" - %d %d\n", dev->req_seq, dev->seq); 1805a66a8ffSSimon Glass if ((find_req_seq ? dev->req_seq : dev->seq) == 1815a66a8ffSSimon Glass seq_or_req_seq) { 1825a66a8ffSSimon Glass *devp = dev; 1835a66a8ffSSimon Glass debug(" - found\n"); 1845a66a8ffSSimon Glass return 0; 1855a66a8ffSSimon Glass } 1865a66a8ffSSimon Glass } 1875a66a8ffSSimon Glass debug(" - not found\n"); 1885a66a8ffSSimon Glass 1895a66a8ffSSimon Glass return -ENODEV; 1905a66a8ffSSimon Glass } 1915a66a8ffSSimon Glass 192f4cdead2SSimon Glass static int uclass_find_device_by_of_offset(enum uclass_id id, int node, 193f4cdead2SSimon Glass struct udevice **devp) 194f4cdead2SSimon Glass { 195f4cdead2SSimon Glass struct uclass *uc; 196f4cdead2SSimon Glass struct udevice *dev; 197f4cdead2SSimon Glass int ret; 198f4cdead2SSimon Glass 199f4cdead2SSimon Glass *devp = NULL; 200f4cdead2SSimon Glass if (node < 0) 201f4cdead2SSimon Glass return -ENODEV; 202f4cdead2SSimon Glass ret = uclass_get(id, &uc); 203f4cdead2SSimon Glass if (ret) 204f4cdead2SSimon Glass return ret; 205f4cdead2SSimon Glass 206f4cdead2SSimon Glass list_for_each_entry(dev, &uc->dev_head, uclass_node) { 207f4cdead2SSimon Glass if (dev->of_offset == node) { 208f4cdead2SSimon Glass *devp = dev; 209f4cdead2SSimon Glass return 0; 210f4cdead2SSimon Glass } 211f4cdead2SSimon Glass } 212f4cdead2SSimon Glass 213f4cdead2SSimon Glass return -ENODEV; 214f4cdead2SSimon Glass } 215f4cdead2SSimon Glass 2169ca296a1SSimon Glass /** 2179ca296a1SSimon Glass * uclass_get_device_tail() - handle the end of a get_device call 2189ca296a1SSimon Glass * 2199ca296a1SSimon Glass * This handles returning an error or probing a device as needed. 2209ca296a1SSimon Glass * 2219ca296a1SSimon Glass * @dev: Device that needs to be probed 2229ca296a1SSimon Glass * @ret: Error to return. If non-zero then the device is not probed 2239ca296a1SSimon Glass * @devp: Returns the value of 'dev' if there is no error 2249ca296a1SSimon Glass * @return ret, if non-zero, else the result of the device_probe() call 2259ca296a1SSimon Glass */ 2269ca296a1SSimon Glass static int uclass_get_device_tail(struct udevice *dev, int ret, 2279ca296a1SSimon Glass struct udevice **devp) 2286494d708SSimon Glass { 2296494d708SSimon Glass if (ret) 2306494d708SSimon Glass return ret; 2316494d708SSimon Glass 2326494d708SSimon Glass ret = device_probe(dev); 2336494d708SSimon Glass if (ret) 2346494d708SSimon Glass return ret; 2356494d708SSimon Glass 2366494d708SSimon Glass *devp = dev; 2376494d708SSimon Glass 2386494d708SSimon Glass return 0; 2396494d708SSimon Glass } 2406494d708SSimon Glass 2419ca296a1SSimon Glass int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 2429ca296a1SSimon Glass { 2439ca296a1SSimon Glass struct udevice *dev; 2449ca296a1SSimon Glass int ret; 2459ca296a1SSimon Glass 2469ca296a1SSimon Glass *devp = NULL; 2479ca296a1SSimon Glass ret = uclass_find_device(id, index, &dev); 2489ca296a1SSimon Glass return uclass_get_device_tail(dev, ret, devp); 2499ca296a1SSimon Glass } 2509ca296a1SSimon Glass 2515a66a8ffSSimon Glass int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 2525a66a8ffSSimon Glass { 2535a66a8ffSSimon Glass struct udevice *dev; 2545a66a8ffSSimon Glass int ret; 2555a66a8ffSSimon Glass 2565a66a8ffSSimon Glass *devp = NULL; 2575a66a8ffSSimon Glass ret = uclass_find_device_by_seq(id, seq, false, &dev); 2585a66a8ffSSimon Glass if (ret == -ENODEV) { 2595a66a8ffSSimon Glass /* 2605a66a8ffSSimon Glass * We didn't find it in probed devices. See if there is one 2615a66a8ffSSimon Glass * that will request this seq if probed. 2625a66a8ffSSimon Glass */ 2635a66a8ffSSimon Glass ret = uclass_find_device_by_seq(id, seq, true, &dev); 2645a66a8ffSSimon Glass } 2655a66a8ffSSimon Glass return uclass_get_device_tail(dev, ret, devp); 2665a66a8ffSSimon Glass } 2675a66a8ffSSimon Glass 268f4cdead2SSimon Glass int uclass_get_device_by_of_offset(enum uclass_id id, int node, 269f4cdead2SSimon Glass struct udevice **devp) 270f4cdead2SSimon Glass { 271f4cdead2SSimon Glass struct udevice *dev; 272f4cdead2SSimon Glass int ret; 273f4cdead2SSimon Glass 274f4cdead2SSimon Glass *devp = NULL; 275f4cdead2SSimon Glass ret = uclass_find_device_by_of_offset(id, node, &dev); 276f4cdead2SSimon Glass return uclass_get_device_tail(dev, ret, devp); 277f4cdead2SSimon Glass } 278f4cdead2SSimon Glass 27954c5d08aSHeiko Schocher int uclass_first_device(enum uclass_id id, struct udevice **devp) 2806494d708SSimon Glass { 2816494d708SSimon Glass struct uclass *uc; 28254c5d08aSHeiko Schocher struct udevice *dev; 2836494d708SSimon Glass int ret; 2846494d708SSimon Glass 2856494d708SSimon Glass *devp = NULL; 2866494d708SSimon Glass ret = uclass_get(id, &uc); 2876494d708SSimon Glass if (ret) 2886494d708SSimon Glass return ret; 2896494d708SSimon Glass if (list_empty(&uc->dev_head)) 2906494d708SSimon Glass return 0; 2916494d708SSimon Glass 29254c5d08aSHeiko Schocher dev = list_first_entry(&uc->dev_head, struct udevice, uclass_node); 2936494d708SSimon Glass ret = device_probe(dev); 2946494d708SSimon Glass if (ret) 2956494d708SSimon Glass return ret; 2966494d708SSimon Glass *devp = dev; 2976494d708SSimon Glass 2986494d708SSimon Glass return 0; 2996494d708SSimon Glass } 3006494d708SSimon Glass 30154c5d08aSHeiko Schocher int uclass_next_device(struct udevice **devp) 3026494d708SSimon Glass { 30354c5d08aSHeiko Schocher struct udevice *dev = *devp; 3046494d708SSimon Glass int ret; 3056494d708SSimon Glass 3066494d708SSimon Glass *devp = NULL; 3076494d708SSimon Glass if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head)) 3086494d708SSimon Glass return 0; 3096494d708SSimon Glass 31054c5d08aSHeiko Schocher dev = list_entry(dev->uclass_node.next, struct udevice, 31154c5d08aSHeiko Schocher uclass_node); 3126494d708SSimon Glass ret = device_probe(dev); 3136494d708SSimon Glass if (ret) 3146494d708SSimon Glass return ret; 3156494d708SSimon Glass *devp = dev; 3166494d708SSimon Glass 3176494d708SSimon Glass return 0; 3186494d708SSimon Glass } 3196494d708SSimon Glass 32054c5d08aSHeiko Schocher int uclass_bind_device(struct udevice *dev) 3216494d708SSimon Glass { 3226494d708SSimon Glass struct uclass *uc; 3236494d708SSimon Glass int ret; 3246494d708SSimon Glass 3256494d708SSimon Glass uc = dev->uclass; 3266494d708SSimon Glass 3276494d708SSimon Glass list_add_tail(&dev->uclass_node, &uc->dev_head); 3286494d708SSimon Glass 3296494d708SSimon Glass if (uc->uc_drv->post_bind) { 3306494d708SSimon Glass ret = uc->uc_drv->post_bind(dev); 3316494d708SSimon Glass if (ret) { 3326494d708SSimon Glass list_del(&dev->uclass_node); 3336494d708SSimon Glass return ret; 3346494d708SSimon Glass } 3356494d708SSimon Glass } 3366494d708SSimon Glass 3376494d708SSimon Glass return 0; 3386494d708SSimon Glass } 3396494d708SSimon Glass 34054c5d08aSHeiko Schocher int uclass_unbind_device(struct udevice *dev) 3416494d708SSimon Glass { 3426494d708SSimon Glass struct uclass *uc; 3436494d708SSimon Glass int ret; 3446494d708SSimon Glass 3456494d708SSimon Glass uc = dev->uclass; 3466494d708SSimon Glass if (uc->uc_drv->pre_unbind) { 3476494d708SSimon Glass ret = uc->uc_drv->pre_unbind(dev); 3486494d708SSimon Glass if (ret) 3496494d708SSimon Glass return ret; 3506494d708SSimon Glass } 3516494d708SSimon Glass 3526494d708SSimon Glass list_del(&dev->uclass_node); 3536494d708SSimon Glass return 0; 3546494d708SSimon Glass } 3556494d708SSimon Glass 3565a66a8ffSSimon Glass int uclass_resolve_seq(struct udevice *dev) 3575a66a8ffSSimon Glass { 3585a66a8ffSSimon Glass struct udevice *dup; 3595a66a8ffSSimon Glass int seq; 3605a66a8ffSSimon Glass int ret; 3615a66a8ffSSimon Glass 3625a66a8ffSSimon Glass assert(dev->seq == -1); 3635a66a8ffSSimon Glass ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 3645a66a8ffSSimon Glass false, &dup); 3655a66a8ffSSimon Glass if (!ret) { 3665a66a8ffSSimon Glass dm_warn("Device '%s': seq %d is in use by '%s'\n", 3675a66a8ffSSimon Glass dev->name, dev->req_seq, dup->name); 3685a66a8ffSSimon Glass } else if (ret == -ENODEV) { 3695a66a8ffSSimon Glass /* Our requested sequence number is available */ 3705a66a8ffSSimon Glass if (dev->req_seq != -1) 3715a66a8ffSSimon Glass return dev->req_seq; 3725a66a8ffSSimon Glass } else { 3735a66a8ffSSimon Glass return ret; 3745a66a8ffSSimon Glass } 3755a66a8ffSSimon Glass 3765a66a8ffSSimon Glass for (seq = 0; seq < DM_MAX_SEQ; seq++) { 3775a66a8ffSSimon Glass ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 3785a66a8ffSSimon Glass false, &dup); 3795a66a8ffSSimon Glass if (ret == -ENODEV) 3805a66a8ffSSimon Glass break; 3815a66a8ffSSimon Glass if (ret) 3825a66a8ffSSimon Glass return ret; 3835a66a8ffSSimon Glass } 3845a66a8ffSSimon Glass return seq; 3855a66a8ffSSimon Glass } 3865a66a8ffSSimon Glass 38754c5d08aSHeiko Schocher int uclass_post_probe_device(struct udevice *dev) 3886494d708SSimon Glass { 3896494d708SSimon Glass struct uclass_driver *uc_drv = dev->uclass->uc_drv; 3906494d708SSimon Glass 3916494d708SSimon Glass if (uc_drv->post_probe) 3926494d708SSimon Glass return uc_drv->post_probe(dev); 3936494d708SSimon Glass 3946494d708SSimon Glass return 0; 3956494d708SSimon Glass } 3966494d708SSimon Glass 39754c5d08aSHeiko Schocher int uclass_pre_remove_device(struct udevice *dev) 3986494d708SSimon Glass { 3996494d708SSimon Glass struct uclass_driver *uc_drv; 4006494d708SSimon Glass struct uclass *uc; 4016494d708SSimon Glass int ret; 4026494d708SSimon Glass 4036494d708SSimon Glass uc = dev->uclass; 4046494d708SSimon Glass uc_drv = uc->uc_drv; 4056494d708SSimon Glass if (uc->uc_drv->pre_remove) { 4066494d708SSimon Glass ret = uc->uc_drv->pre_remove(dev); 4076494d708SSimon Glass if (ret) 4086494d708SSimon Glass return ret; 4096494d708SSimon Glass } 4106494d708SSimon Glass if (uc_drv->per_device_auto_alloc_size) { 4116494d708SSimon Glass free(dev->uclass_priv); 4126494d708SSimon Glass dev->uclass_priv = NULL; 4136494d708SSimon Glass } 4145a66a8ffSSimon Glass dev->seq = -1; 4156494d708SSimon Glass 4166494d708SSimon Glass return 0; 4176494d708SSimon Glass } 418