SPDX: Convert all of our single license tags to Linux Kernel style
[platform/kernel/u-boot.git] / drivers / core / device.c
index 1935b8d..1a32956 100644 (file)
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Device manager
  *
@@ -5,20 +6,21 @@
  *
  * (C) Copyright 2012
  * Pavel Herrmann <morpheus.ibis@gmail.com>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
 #include <asm/io.h>
+#include <clk.h>
 #include <fdtdec.h>
 #include <fdt_support.h>
 #include <malloc.h>
 #include <dm/device.h>
 #include <dm/device-internal.h>
 #include <dm/lists.h>
+#include <dm/of_access.h>
 #include <dm/pinctrl.h>
 #include <dm/platdata.h>
+#include <dm/read.h>
 #include <dm/uclass.h>
 #include <dm/uclass-internal.h>
 #include <dm/util.h>
@@ -29,7 +31,7 @@ DECLARE_GLOBAL_DATA_PTR;
 
 static int device_bind_common(struct udevice *parent, const struct driver *drv,
                              const char *name, void *platdata,
-                             ulong driver_data, int of_offset,
+                             ulong driver_data, ofnode node,
                              uint of_platdata_size, struct udevice **devp)
 {
        struct udevice *dev;
@@ -60,7 +62,7 @@ static int device_bind_common(struct udevice *parent, const struct driver *drv,
        dev->platdata = platdata;
        dev->driver_data = driver_data;
        dev->name = name;
-       dev->of_offset = of_offset;
+       dev->node = node;
        dev->parent = parent;
        dev->driver = drv;
        dev->uclass = uc;
@@ -76,10 +78,8 @@ static int device_bind_common(struct udevice *parent, const struct driver *drv,
                 * resolved (and ->seq updated) when the device is probed.
                 */
                if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
-                       if (uc->uc_drv->name && of_offset != -1) {
-                               fdtdec_get_alias_seq(gd->fdt_blob,
-                                               uc->uc_drv->name, of_offset,
-                                               &dev->req_seq);
+                       if (uc->uc_drv->name && ofnode_valid(node)) {
+                               dev_read_alias_seq(dev, &dev->req_seq);
                        }
                }
        }
@@ -162,7 +162,7 @@ static int device_bind_common(struct udevice *parent, const struct driver *drv,
        }
 
        if (parent)
-               dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
+               pr_debug("Bound device %s to %s\n", dev->name, parent->name);
        if (devp)
                *devp = dev;
 
@@ -215,19 +215,19 @@ fail_alloc1:
 
 int device_bind_with_driver_data(struct udevice *parent,
                                 const struct driver *drv, const char *name,
-                                ulong driver_data, int of_offset,
+                                ulong driver_data, ofnode node,
                                 struct udevice **devp)
 {
-       return device_bind_common(parent, drv, name, NULL, driver_data,
-                                 of_offset, 0, devp);
+       return device_bind_common(parent, drv, name, NULL, driver_data, node,
+                                 0, devp);
 }
 
 int device_bind(struct udevice *parent, const struct driver *drv,
                const char *name, void *platdata, int of_offset,
                struct udevice **devp)
 {
-       return device_bind_common(parent, drv, name, platdata, 0, of_offset, 0,
-                                 devp);
+       return device_bind_common(parent, drv, name, platdata, 0,
+                                 offset_to_ofnode(of_offset), 0, devp);
 }
 
 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
@@ -246,7 +246,8 @@ int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
        platdata_size = info->platdata_size;
 #endif
        return device_bind_common(parent, drv, info->name,
-                       (void *)info->platdata, 0, -1, platdata_size, devp);
+                       (void *)info->platdata, 0, ofnode_null(), platdata_size,
+                       devp);
 }
 
 static void *alloc_priv(int size, uint flags)
@@ -254,9 +255,38 @@ static void *alloc_priv(int size, uint flags)
        void *priv;
 
        if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
+               size = ROUND(size, ARCH_DMA_MINALIGN);
                priv = memalign(ARCH_DMA_MINALIGN, size);
-               if (priv)
+               if (priv) {
                        memset(priv, '\0', size);
+
+                       /*
+                        * Ensure that the zero bytes are flushed to memory.
+                        * This prevents problems if the driver uses this as
+                        * both an input and an output buffer:
+                        *
+                        * 1. Zeroes written to buffer (here) and sit in the
+                        *      cache
+                        * 2. Driver issues a read command to DMA
+                        * 3. CPU runs out of cache space and evicts some cache
+                        *      data in the buffer, writing zeroes to RAM from
+                        *      the memset() above
+                        * 4. DMA completes
+                        * 5. Buffer now has some DMA data and some zeroes
+                        * 6. Data being read is now incorrect
+                        *
+                        * To prevent this, ensure that the cache is clean
+                        * within this range at the start. The driver can then
+                        * use normal flush-after-write, invalidate-before-read
+                        * procedures.
+                        *
+                        * TODO(sjg@chromium.org): Drop this microblaze
+                        * exception.
+                        */
+#ifndef CONFIG_MICROBLAZE
+                       flush_dcache_range((ulong)priv, (ulong)priv + size);
+#endif
+               }
        } else {
                priv = calloc(1, size);
        }
@@ -355,12 +385,17 @@ int device_probe(struct udevice *dev)
                        goto fail;
        }
 
-       if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
+       if (drv->ofdata_to_platdata && dev_has_of_node(dev)) {
                ret = drv->ofdata_to_platdata(dev);
                if (ret)
                        goto fail;
        }
 
+       /* Process 'assigned-{clocks/clock-parents/clock-rates}' properties */
+       ret = clk_set_defaults(dev);
+       if (ret)
+               goto fail;
+
        if (drv->probe) {
                ret = drv->probe(dev);
                if (ret) {
@@ -378,7 +413,7 @@ int device_probe(struct udevice *dev)
 
        return 0;
 fail_uclass:
-       if (device_remove(dev)) {
+       if (device_remove(dev, DM_REMOVE_NORMAL)) {
                dm_warn("%s: Device '%s' failed to remove on error path\n",
                        __func__, dev->name);
        }
@@ -524,7 +559,7 @@ int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
        *devp = NULL;
 
        list_for_each_entry(dev, &parent->child_head, sibling_node) {
-               if (dev->of_offset == of_offset) {
+               if (dev_of_offset(dev) == of_offset) {
                        *devp = dev;
                        return 0;
                }
@@ -549,7 +584,7 @@ static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
 {
        struct udevice *dev, *found;
 
-       if (parent->of_offset == of_offset)
+       if (dev_of_offset(parent) == of_offset)
                return parent;
 
        list_for_each_entry(dev, &parent->child_head, sibling_node) {
@@ -627,108 +662,6 @@ const char *dev_get_uclass_name(struct udevice *dev)
        return dev->uclass->uc_drv->name;
 }
 
-fdt_addr_t dev_get_addr_index(struct udevice *dev, int index)
-{
-#if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
-       fdt_addr_t addr;
-
-       if (CONFIG_IS_ENABLED(OF_TRANSLATE)) {
-               const fdt32_t *reg;
-               int len = 0;
-               int na, ns;
-
-               na = fdt_address_cells(gd->fdt_blob, dev->parent->of_offset);
-               if (na < 1) {
-                       debug("bad #address-cells\n");
-                       return FDT_ADDR_T_NONE;
-               }
-
-               ns = fdt_size_cells(gd->fdt_blob, dev->parent->of_offset);
-               if (ns < 0) {
-                       debug("bad #size-cells\n");
-                       return FDT_ADDR_T_NONE;
-               }
-
-               reg = fdt_getprop(gd->fdt_blob, dev->of_offset, "reg", &len);
-               if (!reg || (len <= (index * sizeof(fdt32_t) * (na + ns)))) {
-                       debug("Req index out of range\n");
-                       return FDT_ADDR_T_NONE;
-               }
-
-               reg += index * (na + ns);
-
-               /*
-                * Use the full-fledged translate function for complex
-                * bus setups.
-                */
-               addr = fdt_translate_address((void *)gd->fdt_blob,
-                                            dev->of_offset, reg);
-       } else {
-               /*
-                * Use the "simple" translate function for less complex
-                * bus setups.
-                */
-               addr = fdtdec_get_addr_size_auto_parent(gd->fdt_blob,
-                                                       dev->parent->of_offset,
-                                                       dev->of_offset, "reg",
-                                                       index, NULL, false);
-               if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) {
-                       if (device_get_uclass_id(dev->parent) ==
-                           UCLASS_SIMPLE_BUS)
-                               addr = simple_bus_translate(dev->parent, addr);
-               }
-       }
-
-       /*
-        * Some platforms need a special address translation. Those
-        * platforms (e.g. mvebu in SPL) can configure a translation
-        * offset in the DM by calling dm_set_translation_offset() that
-        * will get added to all addresses returned by dev_get_addr().
-        */
-       addr += dm_get_translation_offset();
-
-       return addr;
-#else
-       return FDT_ADDR_T_NONE;
-#endif
-}
-
-fdt_addr_t dev_get_addr_name(struct udevice *dev, const char *name)
-{
-#if CONFIG_IS_ENABLED(OF_CONTROL)
-       int index;
-
-       index = fdt_stringlist_search(gd->fdt_blob, dev->of_offset, "reg-names",
-                               name);
-       if (index < 0)
-               return index;
-
-       return dev_get_addr_index(dev, index);
-#else
-       return FDT_ADDR_T_NONE;
-#endif
-}
-
-fdt_addr_t dev_get_addr(struct udevice *dev)
-{
-       return dev_get_addr_index(dev, 0);
-}
-
-void *dev_get_addr_ptr(struct udevice *dev)
-{
-       return (void *)(uintptr_t)dev_get_addr_index(dev, 0);
-}
-
-void *dev_map_physmem(struct udevice *dev, unsigned long size)
-{
-       fdt_addr_t addr = dev_get_addr(dev);
-
-       if (addr == FDT_ADDR_T_NONE)
-               return NULL;
-
-       return map_physmem(addr, size, MAP_NOCACHE);
-}
-
 bool device_has_children(struct udevice *dev)
 {
        return !list_empty(&dev->child_head);
@@ -773,11 +706,15 @@ int device_set_name(struct udevice *dev, const char *name)
        return 0;
 }
 
-bool of_device_is_compatible(struct udevice *dev, const char *compat)
+bool device_is_compatible(struct udevice *dev, const char *compat)
 {
        const void *fdt = gd->fdt_blob;
+       ofnode node = dev_ofnode(dev);
 
-       return !fdt_node_check_compatible(fdt, dev->of_offset, compat);
+       if (ofnode_is_np(node))
+               return of_device_is_compatible(ofnode_to_np(node), compat, NULL, NULL);
+       else
+               return !fdt_node_check_compatible(fdt, ofnode_to_offset(node), compat);
 }
 
 bool of_machine_is_compatible(const char *compat)