From: Simon Glass <sjg@chromium.org>
Date: Tue, 29 Dec 2020 03:34:55 +0000 (-0700)
Subject: dm: Rename DM_GET_DEVICE() to DM_DRVINFO_GET()
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=8629d30a32e7b4ff8323292364116c08033bd57b;p=u-boot.git

dm: Rename DM_GET_DEVICE() to DM_DRVINFO_GET()

This does not get a device (struct udevice *) but a struct driver_info *
so the name is confusing.

Rename it accordingly. Since we plan to have several various of these
macros, put GET at the end instead of the middle, so it is easier to spot
the related macros.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

diff --git a/doc/driver-model/of-plat.rst b/doc/driver-model/of-plat.rst
index 39e6295aa0..21b45f6a7e 100644
--- a/doc/driver-model/of-plat.rst
+++ b/doc/driver-model/of-plat.rst
@@ -339,7 +339,7 @@ prevents them being used inadvertently. All usage must be bracketed with
 The dt-plat.c file contains the device declarations and is is built in
 spl/dt-plat.c. It additionally contains the definition of
 dm_populate_phandle_data() which is responsible of filling the phandle
-information by adding references to U_BOOT_DRVINFO by using DM_GET_DEVICE
+information by adding references to U_BOOT_DRVINFO by using DM_DRVINFO_GET
 
 The pylibfdt Python module is used to access the devicetree.
 
diff --git a/include/dm/platdata.h b/include/dm/platdata.h
index e2b16ce6e4..df1f6abcc7 100644
--- a/include/dm/platdata.h
+++ b/include/dm/platdata.h
@@ -74,27 +74,23 @@ struct driver_rt {
 /**
  * Get a pointer to a given device info given its name
  *
- * With the declaration U_BOOT_DRVINFO(name), DM_GET_DEVICE(name) will return a
+ * With the declaration U_BOOT_DRVINFO(name), DM_DRVINFO_GET(name) will return a
  * pointer to the struct driver_info created by that declaration.
  *
  * if OF_PLATDATA is enabled, from this it is possible to use the @dev member of
  * struct driver_info to find the device pointer itself.
  *
- * TODO(sjg@chromium.org): U_BOOT_DRVINFO() tells U-Boot to create a device, so
- * the naming seems sensible, but DM_GET_DEVICE() is a bit of misnomer, since it
- * finds the driver_info record, not the device.
- *
  * @__name: Driver name (C identifier, not a string. E.g. gpio7_at_ff7e0000)
  * @return struct driver_info * to the driver that created the device
  */
-#define DM_GET_DEVICE(__name)						\
+#define DM_DRVINFO_GET(__name)						\
 	ll_entry_get(struct driver_info, __name, driver_info)
 
 /**
  * dm_populate_phandle_data() - Populates phandle data in platda
  *
  * This populates phandle data with an U_BOOT_DRVINFO entry get by
- * DM_GET_DEVICE. The implementation of this function will be done
+ * DM_DRVINFO_GET. The implementation of this function will be done
  * by dtoc when parsing dtb.
  */
 void dm_populate_phandle_data(void);
diff --git a/tools/dtoc/dtb_platdata.py b/tools/dtoc/dtb_platdata.py
index ebe5132e14..1a6a511b01 100644
--- a/tools/dtoc/dtb_platdata.py
+++ b/tools/dtoc/dtb_platdata.py
@@ -811,8 +811,8 @@ class DtbPlatdata():
             nodes_to_output.remove(node)
 
         # Define dm_populate_phandle_data() which will add the linking between
-        # nodes using DM_GET_DEVICE
-        # dtv_dmc_at_xxx.clocks[0].node = DM_GET_DEVICE(clock_controller_at_xxx)
+        # nodes using DM_DRVINFO_GET
+        # dtv_dmc_at_xxx.clocks[0].node = DM_DRVINFO_GET(clock_controller_at_xxx)
         self.buf('void dm_populate_phandle_data(void) {\n')
         self.buf('}\n')