drivers/of/device.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/string.h>
   3 #include <linux/kernel.h>
   4 #include <linux/of.h>
   5 #include <linux/of_device.h>
   6 #include <linux/of_address.h>
   7 #include <linux/of_iommu.h>
   8 #include <linux/of_reserved_mem.h>
   9 #include <linux/dma-direct.h> /* for bus_dma_region */
  10 #include <linux/dma-map-ops.h>
  11 #include <linux/init.h>
  12 #include <linux/module.h>
  13 #include <linux/mod_devicetable.h>
  14 #include <linux/slab.h>
  15 #include <linux/platform_device.h>
  16
  17 #include <asm/errno.h>
  18 #include "of_private.h"
  19
  20 /**
  21  * of_match_device - Tell if a struct device matches an of_device_id list
  22  * @matches: array of of device match structures to search in
  23  * @dev: the of device structure to match against
  24  *
  25  * Used by a driver to check whether an platform_device present in the
  26  * system is in its list of supported devices.
  27  */
  28 const struct of_device_id *of_match_device(const struct of_device_id *matches,
  29                                            const struct device *dev)
  30 {
  31         if ((!matches) || (!dev->of_node))
  32                 return NULL;
  33         return of_match_node(matches, dev->of_node);
  34 }
  35 EXPORT_SYMBOL(of_match_device);
  36
  37 int of_device_add(struct platform_device *ofdev)
  38 {
  39         BUG_ON(ofdev->dev.of_node == NULL);
  40
  41         /* name and id have to be set so that the platform bus doesn't get
  42          * confused on matching */
  43         ofdev->name = dev_name(&ofdev->dev);
  44         ofdev->id = PLATFORM_DEVID_NONE;
  45
  46         /*
  47          * If this device has not binding numa node in devicetree, that is
  48          * of_node_to_nid returns NUMA_NO_NODE. device_add will assume that this
  49          * device is on the same node as the parent.
  50          */
  51         set_dev_node(&ofdev->dev, of_node_to_nid(ofdev->dev.of_node));
  52
  53         return device_add(&ofdev->dev);
  54 }
  55
  56 static int
  57 of_dma_set_restricted_buffer(struct device *dev, struct device_node *np)
  58 {
  59         struct device_node *node, *of_node = dev->of_node;
  60         int count, i;
  61
  62         count = of_property_count_elems_of_size(of_node, "memory-region",
  63                                                 sizeof(u32));
  64         /*
  65          * If dev->of_node doesn't exist or doesn't contain memory-region, try
  66          * the OF node having DMA configuration.
  67          */
  68         if (count <= 0) {
  69                 of_node = np;
  70                 count = of_property_count_elems_of_size(
  71                         of_node, "memory-region", sizeof(u32));
  72         }
  73
  74         for (i = 0; i < count; i++) {
  75                 node = of_parse_phandle(of_node, "memory-region", i);
  76                 /*
  77                  * There might be multiple memory regions, but only one
  78                  * restricted-dma-pool region is allowed.
  79                  */
  80                 if (of_device_is_compatible(node, "restricted-dma-pool") &&
  81                     of_device_is_available(node))
  82                         return of_reserved_mem_device_init_by_idx(dev, of_node,
  83                                                                   i);
  84         }
  85
  86         return 0;
  87 }
  88
  89 /**
  90  * of_dma_configure_id - Setup DMA configuration
  91  * @dev:        Device to apply DMA configuration
  92  * @np:         Pointer to OF node having DMA configuration
  93  * @force_dma:  Whether device is to be set up by of_dma_configure() even if
  94  *              DMA capability is not explicitly described by firmware.
  95  * @id:         Optional const pointer value input id
  96  *
  97  * Try to get devices's DMA configuration from DT and update it
  98  * accordingly.
  99  *
 100  * If platform code needs to use its own special DMA configuration, it
 101  * can use a platform bus notifier and handle BUS_NOTIFY_ADD_DEVICE events
 102  * to fix up DMA configuration.
 103  */
 104 int of_dma_configure_id(struct device *dev, struct device_node *np,
 105                         bool force_dma, const u32 *id)
 106 {
 107         const struct iommu_ops *iommu;
 108         const struct bus_dma_region *map = NULL;
 109         u64 dma_start = 0;
 110         u64 mask, end, size = 0;
 111         bool coherent;
 112         int ret;
 113
 114         ret = of_dma_get_range(np, &map);
 115         if (ret < 0) {
 116                 /*
 117                  * For legacy reasons, we have to assume some devices need
 118                  * DMA configuration regardless of whether "dma-ranges" is
 119                  * correctly specified or not.
 120                  */
 121                 if (!force_dma)
 122                         return ret == -ENODEV ? 0 : ret;
 123         } else {
 124                 const struct bus_dma_region *r = map;
 125                 u64 dma_end = 0;
 126
 127                 /* Determine the overall bounds of all DMA regions */
 128                 for (dma_start = ~0; r->size; r++) {
 129                         /* Take lower and upper limits */
 130                         if (r->dma_start < dma_start)
 131                                 dma_start = r->dma_start;
 132                         if (r->dma_start + r->size > dma_end)
 133                                 dma_end = r->dma_start + r->size;
 134                 }
 135                 size = dma_end - dma_start;
 136
 137                 /*
 138                  * Add a work around to treat the size as mask + 1 in case
 139                  * it is defined in DT as a mask.
 140                  */
 141                 if (size & 1) {
 142                         dev_warn(dev, "Invalid size 0x%llx for dma-range(s)\n",
 143                                  size);
 144                         size = size + 1;
 145                 }
 146
 147                 if (!size) {
 148                         dev_err(dev, "Adjusted size 0x%llx invalid\n", size);
 149                         kfree(map);
 150                         return -EINVAL;
 151                 }
 152         }
 153
 154         /*
 155          * If @dev is expected to be DMA-capable then the bus code that created
 156          * it should have initialised its dma_mask pointer by this point. For
 157          * now, we'll continue the legacy behaviour of coercing it to the
 158          * coherent mask if not, but we'll no longer do so quietly.
 159          */
 160         if (!dev->dma_mask) {
 161                 dev_warn(dev, "DMA mask not set\n");
 162                 dev->dma_mask = &dev->coherent_dma_mask;
 163         }
 164
 165         if (!size && dev->coherent_dma_mask)
 166                 size = max(dev->coherent_dma_mask, dev->coherent_dma_mask + 1);
 167         else if (!size)
 168                 size = 1ULL << 32;
 169
 170         /*
 171          * Limit coherent and dma mask based on size and default mask
 172          * set by the driver.
 173          */
 174         end = dma_start + size - 1;
 175         mask = DMA_BIT_MASK(ilog2(end) + 1);
 176         dev->coherent_dma_mask &= mask;
 177         *dev->dma_mask &= mask;
 178         /* ...but only set bus limit and range map if we found valid dma-ranges earlier */
 179         if (!ret) {
 180                 dev->bus_dma_limit = end;
 181                 dev->dma_range_map = map;
 182         }
 183
 184         coherent = of_dma_is_coherent(np);
 185         dev_dbg(dev, "device is%sdma coherent\n",
 186                 coherent ? " " : " not ");
 187
 188         iommu = of_iommu_configure(dev, np, id);
 189         if (PTR_ERR(iommu) == -EPROBE_DEFER) {
 190                 /* Don't touch range map if it wasn't set from a valid dma-ranges */
 191                 if (!ret)
 192                         dev->dma_range_map = NULL;
 193                 kfree(map);
 194                 return -EPROBE_DEFER;
 195         }
 196
 197         dev_dbg(dev, "device is%sbehind an iommu\n",
 198                 iommu ? " " : " not ");
 199
 200         arch_setup_dma_ops(dev, dma_start, size, iommu, coherent);
 201
 202         if (!iommu)
 203                 return of_dma_set_restricted_buffer(dev, np);
 204
 205         return 0;
 206 }
 207 EXPORT_SYMBOL_GPL(of_dma_configure_id);
 208
 209 int of_device_register(struct platform_device *pdev)
 210 {
 211         device_initialize(&pdev->dev);
 212         return of_device_add(pdev);
 213 }
 214 EXPORT_SYMBOL(of_device_register);
 215
 216 void of_device_unregister(struct platform_device *ofdev)
 217 {
 218         device_unregister(&ofdev->dev);
 219 }
 220 EXPORT_SYMBOL(of_device_unregister);
 221
 222 const void *of_device_get_match_data(const struct device *dev)
 223 {
 224         const struct of_device_id *match;
 225
 226         match = of_match_device(dev->driver->of_match_table, dev);
 227         if (!match)
 228                 return NULL;
 229
 230         return match->data;
 231 }
 232 EXPORT_SYMBOL(of_device_get_match_data);
 233
 234 static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len)
 235 {
 236         const char *compat;
 237         char *c;
 238         struct property *p;
 239         ssize_t csize;
 240         ssize_t tsize;
 241
 242         if ((!dev) || (!dev->of_node))
 243                 return -ENODEV;
 244
 245         /* Name & Type */
 246         /* %p eats all alphanum characters, so %c must be used here */
 247         csize = snprintf(str, len, "of:N%pOFn%c%s", dev->of_node, 'T',
 248                          of_node_get_device_type(dev->of_node));
 249         tsize = csize;
 250         len -= csize;
 251         if (str)
 252                 str += csize;
 253
 254         of_property_for_each_string(dev->of_node, "compatible", p, compat) {
 255                 csize = strlen(compat) + 1;
 256                 tsize += csize;
 257                 if (csize > len)
 258                         continue;
 259
 260                 csize = snprintf(str, len, "C%s", compat);
 261                 for (c = str; c; ) {
 262                         c = strchr(c, ' ');
 263                         if (c)
 264                                 *c++ = '_';
 265                 }
 266                 len -= csize;
 267                 str += csize;
 268         }
 269
 270         return tsize;
 271 }
 272
 273 int of_device_request_module(struct device *dev)
 274 {
 275         char *str;
 276         ssize_t size;
 277         int ret;
 278
 279         size = of_device_get_modalias(dev, NULL, 0);
 280         if (size < 0)
 281                 return size;
 282
 283         str = kmalloc(size + 1, GFP_KERNEL);
 284         if (!str)
 285                 return -ENOMEM;
 286
 287         of_device_get_modalias(dev, str, size);
 288         str[size] = '\0';
 289         ret = request_module(str);
 290         kfree(str);
 291
 292         return ret;
 293 }
 294 EXPORT_SYMBOL_GPL(of_device_request_module);
 295
 296 /**
 297  * of_device_modalias - Fill buffer with newline terminated modalias string
 298  * @dev:        Calling device
 299  * @str:        Modalias string
 300  * @len:        Size of @str
 301  */
 302 ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
 303 {
 304         ssize_t sl = of_device_get_modalias(dev, str, len - 2);
 305         if (sl < 0)
 306                 return sl;
 307         if (sl > len - 2)
 308                 return -ENOMEM;
 309
 310         str[sl++] = '\n';
 311         str[sl] = 0;
 312         return sl;
 313 }
 314 EXPORT_SYMBOL_GPL(of_device_modalias);
 315
 316 /**
 317  * of_device_uevent - Display OF related uevent information
 318  * @dev:        Device to apply DMA configuration
 319  * @env:        Kernel object's userspace event reference
 320  */
 321 void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
 322 {
 323         const char *compat, *type;
 324         struct alias_prop *app;
 325         struct property *p;
 326         int seen = 0;
 327
 328         if ((!dev) || (!dev->of_node))
 329                 return;
 330
 331         add_uevent_var(env, "OF_NAME=%pOFn", dev->of_node);
 332         add_uevent_var(env, "OF_FULLNAME=%pOF", dev->of_node);
 333         type = of_node_get_device_type(dev->of_node);
 334         if (type)
 335                 add_uevent_var(env, "OF_TYPE=%s", type);
 336
 337         /* Since the compatible field can contain pretty much anything
 338          * it's not really legal to split it out with commas. We split it
 339          * up using a number of environment variables instead. */
 340         of_property_for_each_string(dev->of_node, "compatible", p, compat) {
 341                 add_uevent_var(env, "OF_COMPATIBLE_%d=%s", seen, compat);
 342                 seen++;
 343         }
 344         add_uevent_var(env, "OF_COMPATIBLE_N=%d", seen);
 345
 346         seen = 0;
 347         mutex_lock(&of_mutex);
 348         list_for_each_entry(app, &aliases_lookup, link) {
 349                 if (dev->of_node == app->np) {
 350                         add_uevent_var(env, "OF_ALIAS_%d=%s", seen,
 351                                        app->alias);
 352                         seen++;
 353                 }
 354         }
 355         mutex_unlock(&of_mutex);
 356 }
 357
 358 int of_device_uevent_modalias(struct device *dev, struct kobj_uevent_env *env)
 359 {
 360         int sl;
 361
 362         if ((!dev) || (!dev->of_node))
 363                 return -ENODEV;
 364
 365         /* Devicetree modalias is tricky, we add it in 2 steps */
 366         if (add_uevent_var(env, "MODALIAS="))
 367                 return -ENOMEM;
 368
 369         sl = of_device_get_modalias(dev, &env->buf[env->buflen-1],
 370                                     sizeof(env->buf) - env->buflen);
 371         if (sl >= (sizeof(env->buf) - env->buflen))
 372                 return -ENOMEM;
 373         env->buflen += sl;
 374
 375         return 0;
 376 }
 377 EXPORT_SYMBOL_GPL(of_device_uevent_modalias);