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