blob: e5f47cec75f34e046b15efbc5bcdc50073eff5c0 [file] [log] [blame]
Stephen Rothwellf85ff302007-05-01 16:40:36 +10001#include <linux/string.h>
2#include <linux/kernel.h>
3#include <linux/of.h>
Stephen Rothwellf898f8d2007-05-01 16:49:51 +10004#include <linux/of_device.h>
Murali Karicheri1f5c69a2015-03-03 12:52:09 -05005#include <linux/of_address.h>
6#include <linux/of_iommu.h>
7#include <linux/dma-mapping.h>
Stephen Rothwellf85ff302007-05-01 16:40:36 +10008#include <linux/init.h>
9#include <linux/module.h>
10#include <linux/mod_devicetable.h>
11#include <linux/slab.h>
12
13#include <asm/errno.h>
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -080014#include "of_private.h"
Stephen Rothwellf85ff302007-05-01 16:40:36 +100015
16/**
Grant Likely44504b22010-04-13 16:13:22 -070017 * of_match_device - Tell if a struct device matches an of_device_id list
Stephen Rothwellf85ff302007-05-01 16:40:36 +100018 * @ids: array of of device match structures to search in
19 * @dev: the of device structure to match against
20 *
Grant Likely2dc11582010-08-06 09:25:50 -060021 * Used by a driver to check whether an platform_device present in the
Stephen Rothwellf85ff302007-05-01 16:40:36 +100022 * system is in its list of supported devices.
23 */
24const struct of_device_id *of_match_device(const struct of_device_id *matches,
Grant Likely44504b22010-04-13 16:13:22 -070025 const struct device *dev)
Stephen Rothwellf85ff302007-05-01 16:40:36 +100026{
Grant Likely8cec0e72010-06-08 07:48:17 -060027 if ((!matches) || (!dev->of_node))
Stephen Rothwellf85ff302007-05-01 16:40:36 +100028 return NULL;
Grant Likely44504b22010-04-13 16:13:22 -070029 return of_match_node(matches, dev->of_node);
Stephen Rothwellf85ff302007-05-01 16:40:36 +100030}
31EXPORT_SYMBOL(of_match_device);
32
Grant Likely94a0cb12010-07-22 13:59:23 -060033struct platform_device *of_dev_get(struct platform_device *dev)
Stephen Rothwellf85ff302007-05-01 16:40:36 +100034{
35 struct device *tmp;
36
37 if (!dev)
38 return NULL;
39 tmp = get_device(&dev->dev);
40 if (tmp)
Grant Likely94a0cb12010-07-22 13:59:23 -060041 return to_platform_device(tmp);
Stephen Rothwellf85ff302007-05-01 16:40:36 +100042 else
43 return NULL;
44}
45EXPORT_SYMBOL(of_dev_get);
46
Grant Likely94a0cb12010-07-22 13:59:23 -060047void of_dev_put(struct platform_device *dev)
Stephen Rothwellf85ff302007-05-01 16:40:36 +100048{
49 if (dev)
50 put_device(&dev->dev);
51}
52EXPORT_SYMBOL(of_dev_put);
53
Grant Likely7096d042010-10-20 11:45:13 -060054int of_device_add(struct platform_device *ofdev)
Stephen Rothwellf85ff302007-05-01 16:40:36 +100055{
Grant Likely61c7a082010-04-13 16:12:29 -070056 BUG_ON(ofdev->dev.of_node == NULL);
Jeremy Kerr6098e2e2008-10-26 21:51:25 +000057
Grant Likelyeca39302010-06-08 07:48:21 -060058 /* name and id have to be set so that the platform bus doesn't get
59 * confused on matching */
60 ofdev->name = dev_name(&ofdev->dev);
61 ofdev->id = -1;
62
Zhen Lei56f2de82015-08-25 12:08:22 +080063 /*
64 * If this device has not binding numa node in devicetree, that is
65 * of_node_to_nid returns NUMA_NO_NODE. device_add will assume that this
66 * device is on the same node as the parent.
67 */
68 set_dev_node(&ofdev->dev, of_node_to_nid(ofdev->dev.of_node));
Jeremy Kerr6098e2e2008-10-26 21:51:25 +000069
70 return device_add(&ofdev->dev);
Stephen Rothwellf85ff302007-05-01 16:40:36 +100071}
Grant Likely7096d042010-10-20 11:45:13 -060072
Murali Karicheri1f5c69a2015-03-03 12:52:09 -050073/**
74 * of_dma_configure - Setup DMA configuration
75 * @dev: Device to apply DMA configuration
76 * @np: Pointer to OF node having DMA configuration
77 *
78 * Try to get devices's DMA configuration from DT and update it
79 * accordingly.
80 *
81 * If platform code needs to use its own special DMA configuration, it
82 * can use a platform bus notifier and handle BUS_NOTIFY_ADD_DEVICE events
83 * to fix up DMA configuration.
84 */
85void of_dma_configure(struct device *dev, struct device_node *np)
86{
87 u64 dma_addr, paddr, size;
88 int ret;
89 bool coherent;
90 unsigned long offset;
91 struct iommu_ops *iommu;
92
93 /*
Murali Karicheri9a6d7292015-03-03 14:44:57 -060094 * Set default coherent_dma_mask to 32 bit. Drivers are expected to
95 * setup the correct supported mask.
Murali Karicheri1f5c69a2015-03-03 12:52:09 -050096 */
Murali Karicheri9a6d7292015-03-03 14:44:57 -060097 if (!dev->coherent_dma_mask)
98 dev->coherent_dma_mask = DMA_BIT_MASK(32);
Murali Karicheri1f5c69a2015-03-03 12:52:09 -050099
100 /*
101 * Set it to coherent_dma_mask by default if the architecture
102 * code has not set it.
103 */
104 if (!dev->dma_mask)
105 dev->dma_mask = &dev->coherent_dma_mask;
106
107 ret = of_dma_get_range(np, &dma_addr, &paddr, &size);
108 if (ret < 0) {
109 dma_addr = offset = 0;
Murali Karicheri0c79c812015-03-03 12:52:10 -0500110 size = dev->coherent_dma_mask + 1;
Murali Karicheri1f5c69a2015-03-03 12:52:09 -0500111 } else {
112 offset = PFN_DOWN(paddr - dma_addr);
Murali Karicheri0c79c812015-03-03 12:52:10 -0500113
114 /*
115 * Add a work around to treat the size as mask + 1 in case
116 * it is defined in DT as a mask.
117 */
118 if (size & 1) {
119 dev_warn(dev, "Invalid size 0x%llx for dma-range\n",
120 size);
121 size = size + 1;
122 }
123
124 if (!size) {
125 dev_err(dev, "Adjusted size 0x%llx invalid\n", size);
126 return;
127 }
Murali Karicheri1f5c69a2015-03-03 12:52:09 -0500128 dev_dbg(dev, "dma_pfn_offset(%#08lx)\n", offset);
129 }
130
131 dev->dma_pfn_offset = offset;
132
Murali Karicheri9a6d7292015-03-03 14:44:57 -0600133 /*
134 * Limit coherent and dma mask based on size and default mask
135 * set by the driver.
136 */
137 dev->coherent_dma_mask = min(dev->coherent_dma_mask,
138 DMA_BIT_MASK(ilog2(dma_addr + size)));
139 *dev->dma_mask = min((*dev->dma_mask),
140 DMA_BIT_MASK(ilog2(dma_addr + size)));
141
Murali Karicheri1f5c69a2015-03-03 12:52:09 -0500142 coherent = of_dma_is_coherent(np);
143 dev_dbg(dev, "device is%sdma coherent\n",
144 coherent ? " " : " not ");
145
146 iommu = of_iommu_configure(dev, np);
147 dev_dbg(dev, "device is%sbehind an iommu\n",
148 iommu ? " " : " not ");
149
150 arch_setup_dma_ops(dev, dma_addr, size, iommu, coherent);
151}
152EXPORT_SYMBOL_GPL(of_dma_configure);
153
Grant Likely7096d042010-10-20 11:45:13 -0600154int of_device_register(struct platform_device *pdev)
155{
156 device_initialize(&pdev->dev);
157 return of_device_add(pdev);
158}
Stephen Rothwellf85ff302007-05-01 16:40:36 +1000159EXPORT_SYMBOL(of_device_register);
160
Grant Likely94a0cb12010-07-22 13:59:23 -0600161void of_device_unregister(struct platform_device *ofdev)
Stephen Rothwellf85ff302007-05-01 16:40:36 +1000162{
Stephen Rothwellf85ff302007-05-01 16:40:36 +1000163 device_unregister(&ofdev->dev);
164}
165EXPORT_SYMBOL(of_device_unregister);
Stephen Rothwell09e67ca2008-05-16 11:57:45 +1000166
Joachim Eastwood3386e0f2015-05-06 20:09:09 +0200167const void *of_device_get_match_data(const struct device *dev)
168{
169 const struct of_device_id *match;
170
171 match = of_match_device(dev->driver->of_match_table, dev);
172 if (!match)
173 return NULL;
174
175 return match->data;
176}
177EXPORT_SYMBOL(of_device_get_match_data);
178
Grant Likely34a1c1e2010-06-08 07:48:13 -0600179ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len)
Stephen Rothwell09e67ca2008-05-16 11:57:45 +1000180{
181 const char *compat;
182 int cplen, i;
183 ssize_t tsize, csize, repend;
184
Zhang Ruib9f73062014-01-14 16:46:38 +0800185 if ((!dev) || (!dev->of_node))
186 return -ENODEV;
187
Stephen Rothwell09e67ca2008-05-16 11:57:45 +1000188 /* Name & Type */
Grant Likely34a1c1e2010-06-08 07:48:13 -0600189 csize = snprintf(str, len, "of:N%sT%s", dev->of_node->name,
190 dev->of_node->type);
Stephen Rothwell09e67ca2008-05-16 11:57:45 +1000191
192 /* Get compatible property if any */
Grant Likely34a1c1e2010-06-08 07:48:13 -0600193 compat = of_get_property(dev->of_node, "compatible", &cplen);
Stephen Rothwell09e67ca2008-05-16 11:57:45 +1000194 if (!compat)
195 return csize;
196
197 /* Find true end (we tolerate multiple \0 at the end */
198 for (i = (cplen - 1); i >= 0 && !compat[i]; i--)
199 cplen--;
200 if (!cplen)
201 return csize;
202 cplen++;
203
204 /* Check space (need cplen+1 chars including final \0) */
205 tsize = csize + cplen;
206 repend = tsize;
207
208 if (csize >= len) /* @ the limit, all is already filled */
209 return tsize;
210
211 if (tsize >= len) { /* limit compat list */
212 cplen = len - csize - 1;
213 repend = len;
214 }
215
216 /* Copy and do char replacement */
217 memcpy(&str[csize + 1], compat, cplen);
218 for (i = csize; i < repend; i++) {
219 char c = str[i];
220 if (c == '\0')
221 str[i] = 'C';
222 else if (c == ' ')
223 str[i] = '_';
224 }
225
226 return tsize;
227}
Grant Likelydd27dcd2010-06-08 07:48:12 -0600228
229/**
230 * of_device_uevent - Display OF related uevent information
231 */
Grant Likely07d57a32012-02-01 11:22:22 -0700232void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
Grant Likelydd27dcd2010-06-08 07:48:12 -0600233{
234 const char *compat;
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -0800235 struct alias_prop *app;
Grant Likelydd27dcd2010-06-08 07:48:12 -0600236 int seen = 0, cplen, sl;
237
238 if ((!dev) || (!dev->of_node))
Grant Likely07d57a32012-02-01 11:22:22 -0700239 return;
Grant Likelydd27dcd2010-06-08 07:48:12 -0600240
Grant Likely07d57a32012-02-01 11:22:22 -0700241 add_uevent_var(env, "OF_NAME=%s", dev->of_node->name);
242 add_uevent_var(env, "OF_FULLNAME=%s", dev->of_node->full_name);
243 if (dev->of_node->type && strcmp("<NULL>", dev->of_node->type) != 0)
244 add_uevent_var(env, "OF_TYPE=%s", dev->of_node->type);
Grant Likelydd27dcd2010-06-08 07:48:12 -0600245
246 /* Since the compatible field can contain pretty much anything
247 * it's not really legal to split it out with commas. We split it
248 * up using a number of environment variables instead. */
Grant Likelydd27dcd2010-06-08 07:48:12 -0600249 compat = of_get_property(dev->of_node, "compatible", &cplen);
250 while (compat && *compat && cplen > 0) {
Grant Likely07d57a32012-02-01 11:22:22 -0700251 add_uevent_var(env, "OF_COMPATIBLE_%d=%s", seen, compat);
Grant Likelydd27dcd2010-06-08 07:48:12 -0600252 sl = strlen(compat) + 1;
253 compat += sl;
254 cplen -= sl;
255 seen++;
256 }
Grant Likely07d57a32012-02-01 11:22:22 -0700257 add_uevent_var(env, "OF_COMPATIBLE_N=%d", seen);
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -0800258
259 seen = 0;
Pantelis Antoniouc05aba22014-07-04 19:58:03 +0300260 mutex_lock(&of_mutex);
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -0800261 list_for_each_entry(app, &aliases_lookup, link) {
262 if (dev->of_node == app->np) {
263 add_uevent_var(env, "OF_ALIAS_%d=%s", seen,
264 app->alias);
265 seen++;
266 }
267 }
Pantelis Antoniouc05aba22014-07-04 19:58:03 +0300268 mutex_unlock(&of_mutex);
Grant Likely07d57a32012-02-01 11:22:22 -0700269}
Grant Likelydd27dcd2010-06-08 07:48:12 -0600270
Grant Likely07d57a32012-02-01 11:22:22 -0700271int of_device_uevent_modalias(struct device *dev, struct kobj_uevent_env *env)
272{
273 int sl;
Grant Likelydd27dcd2010-06-08 07:48:12 -0600274
Grant Likely07d57a32012-02-01 11:22:22 -0700275 if ((!dev) || (!dev->of_node))
276 return -ENODEV;
277
278 /* Devicetree modalias is tricky, we add it in 2 steps */
Grant Likelydd27dcd2010-06-08 07:48:12 -0600279 if (add_uevent_var(env, "MODALIAS="))
280 return -ENOMEM;
281
Grant Likely34a1c1e2010-06-08 07:48:13 -0600282 sl = of_device_get_modalias(dev, &env->buf[env->buflen-1],
Grant Likelydd27dcd2010-06-08 07:48:12 -0600283 sizeof(env->buf) - env->buflen);
284 if (sl >= (sizeof(env->buf) - env->buflen))
285 return -ENOMEM;
286 env->buflen += sl;
287
288 return 0;
289}