dm: core: Match compatible strings in order of priority
[platform/kernel/u-boot.git] / drivers / core / lists.c
1 /*
2  * Copyright (c) 2013 Google, Inc
3  *
4  * (C) Copyright 2012
5  * Marek Vasut <marex@denx.de>
6  *
7  * SPDX-License-Identifier:     GPL-2.0+
8  */
9
10 #include <common.h>
11 #include <errno.h>
12 #include <dm/device.h>
13 #include <dm/device-internal.h>
14 #include <dm/lists.h>
15 #include <dm/platdata.h>
16 #include <dm/uclass.h>
17 #include <dm/util.h>
18 #include <fdtdec.h>
19 #include <linux/compiler.h>
20
21 struct driver *lists_driver_lookup_name(const char *name)
22 {
23         struct driver *drv =
24                 ll_entry_start(struct driver, driver);
25         const int n_ents = ll_entry_count(struct driver, driver);
26         struct driver *entry;
27
28         for (entry = drv; entry != drv + n_ents; entry++) {
29                 if (!strcmp(name, entry->name))
30                         return entry;
31         }
32
33         /* Not found */
34         return NULL;
35 }
36
37 struct uclass_driver *lists_uclass_lookup(enum uclass_id id)
38 {
39         struct uclass_driver *uclass =
40                 ll_entry_start(struct uclass_driver, uclass);
41         const int n_ents = ll_entry_count(struct uclass_driver, uclass);
42         struct uclass_driver *entry;
43
44         for (entry = uclass; entry != uclass + n_ents; entry++) {
45                 if (entry->id == id)
46                         return entry;
47         }
48
49         return NULL;
50 }
51
52 int lists_bind_drivers(struct udevice *parent, bool pre_reloc_only)
53 {
54         struct driver_info *info =
55                 ll_entry_start(struct driver_info, driver_info);
56         const int n_ents = ll_entry_count(struct driver_info, driver_info);
57         struct driver_info *entry;
58         struct udevice *dev;
59         int result = 0;
60         int ret;
61
62         for (entry = info; entry != info + n_ents; entry++) {
63                 ret = device_bind_by_name(parent, pre_reloc_only, entry, &dev);
64                 if (ret && ret != -EPERM) {
65                         dm_warn("No match for driver '%s'\n", entry->name);
66                         if (!result || ret != -ENOENT)
67                                 result = ret;
68                 }
69         }
70
71         return result;
72 }
73
74 int device_bind_driver(struct udevice *parent, const char *drv_name,
75                        const char *dev_name, struct udevice **devp)
76 {
77         return device_bind_driver_to_node(parent, drv_name, dev_name, -1, devp);
78 }
79
80 int device_bind_driver_to_node(struct udevice *parent, const char *drv_name,
81                                const char *dev_name, int node,
82                                struct udevice **devp)
83 {
84         struct driver *drv;
85         int ret;
86
87         drv = lists_driver_lookup_name(drv_name);
88         if (!drv) {
89                 debug("Cannot find driver '%s'\n", drv_name);
90                 return -ENOENT;
91         }
92         ret = device_bind(parent, drv, dev_name, NULL, node, devp);
93         if (ret) {
94                 debug("Cannot create device named '%s' (err=%d)\n",
95                       dev_name, ret);
96                 return ret;
97         }
98
99         return 0;
100 }
101
102 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
103 /**
104  * driver_check_compatible() - Check if a driver matches a compatible string
105  *
106  * @param of_match:     List of compatible strings to match
107  * @param of_idp:       Returns the match that was found
108  * @param compat:       The compatible string to search for
109  * @return 0 if there is a match, -ENOENT if no match
110  */
111 static int driver_check_compatible(const struct udevice_id *of_match,
112                                    const struct udevice_id **of_idp,
113                                    const char *compat)
114 {
115         if (!of_match)
116                 return -ENOENT;
117
118         while (of_match->compatible) {
119                 if (!strcmp(of_match->compatible, compat)) {
120                         *of_idp = of_match;
121                         return 0;
122                 }
123                 of_match++;
124         }
125
126         return -ENOENT;
127 }
128
129 int lists_bind_fdt(struct udevice *parent, const void *blob, int offset,
130                    struct udevice **devp)
131 {
132         struct driver *driver = ll_entry_start(struct driver, driver);
133         const int n_ents = ll_entry_count(struct driver, driver);
134         const struct udevice_id *id;
135         struct driver *entry;
136         struct udevice *dev;
137         bool found = false;
138         const char *name, *compat_list, *compat;
139         int compat_length, i;
140         int result = 0;
141         int ret = 0;
142
143         name = fdt_get_name(blob, offset, NULL);
144         dm_dbg("bind node %s\n", name);
145         if (devp)
146                 *devp = NULL;
147
148         compat_list = fdt_getprop(blob, offset, "compatible", &compat_length);
149         if (!compat_list) {
150                 if (compat_length == -FDT_ERR_NOTFOUND) {
151                         dm_dbg("Device '%s' has no compatible string\n", name);
152                         return 0;
153                 }
154
155                 dm_warn("Device tree error at offset %d\n", offset);
156                 return compat_length;
157         }
158
159         /*
160          * Walk through the compatible string list, attempting to match each
161          * compatible string in order such that we match in order of priority
162          * from the first string to the last.
163          */
164         for (i = 0; i < compat_length; i += strlen(compat) + 1) {
165                 compat = compat_list + i;
166                 dm_dbg("   - attempt to match compatible string '%s'\n",
167                        compat);
168
169                 for (entry = driver; entry != driver + n_ents; entry++) {
170                         ret = driver_check_compatible(entry->of_match, &id,
171                                                       compat);
172                         if (!ret)
173                                 break;
174                 }
175                 if (entry == driver + n_ents)
176                         continue;
177
178                 dm_dbg("   - found match at '%s'\n", entry->name);
179                 ret = device_bind_with_driver_data(parent, entry, name,
180                                                    id->data, offset, &dev);
181                 if (ret == -ENODEV) {
182                         dm_dbg("Driver '%s' refuses to bind\n", entry->name);
183                         continue;
184                 }
185                 if (ret) {
186                         dm_warn("Error binding driver '%s': %d\n", entry->name,
187                                 ret);
188                         return ret;
189                 } else {
190                         found = true;
191                         if (devp)
192                                 *devp = dev;
193                 }
194                 break;
195         }
196
197         if (!found && !result && ret != -ENODEV)
198                 dm_dbg("No match for node '%s'\n", name);
199
200         return result;
201 }
202 #endif