Prepare v2023.10

[platform/kernel/u-boot.git] / include / syscon.h

diff --git a/include/syscon.h b/include/syscon.h
index 4593b6e..7a5ee3f 100644 (file)
--- a/include/syscon.h
+++ b/include/syscon.h
@@ -1,13 +1,15 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (c) 2015 Google, Inc
  * Written by Simon Glass <sjg@chromium.org>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef __SYSCON_H
 #define __SYSCON_H
 
+#include <dm/ofnode.h>
+#include <fdtdec.h>
+
 /**
  * struct syscon_uc_info - Information stored by the syscon UCLASS_UCLASS
  *
@@ -28,7 +30,7 @@ struct syscon_ops {
  *
  * @dev:       Device to check (UCLASS_SCON)
  * @info:      Returns regmap for the device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 struct regmap *syscon_get_regmap(struct udevice *dev);
 
@@ -41,7 +43,7 @@ struct regmap *syscon_get_regmap(struct udevice *dev);
  *
  * @driver_data:       Driver data value to look up
  * @devp:              Returns the controller correponding to @driver_data
- * @return 0 on success, -ENODEV if the ID was not found, or other -ve error
+ * Return: 0 on success, -ENODEV if the ID was not found, or other -ve error
  *        code
  */
 int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
@@ -54,17 +56,37 @@ int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
  * are in use. This function looks up the regmap given this driver data.
  *
  * @driver_data:       Driver data value to look up
- * @return register map correponding to @driver_data, or -ve error code
+ * Return: register map correponding to @driver_data, or -ve error code
  */
 struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data);
 
 /**
+ * syscon_regmap_lookup_by_phandle() - Look up a controller by a phandle
+ *
+ * This operates by looking up the given name in the device (device
+ * tree property) of the device using the system controller.
+ *
+ * @dev:       Device using the system controller
+ * @name:      Name of property referring to the system controller
+ * Return:     A pointer to the regmap if found, ERR_PTR(-ve) on error
+ */
+struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
+                                              const char *name);
+
+/**
  * syscon_get_first_range() - get the first memory range from a syscon regmap
  *
  * @driver_data:       Driver data value to look up
- * @return first region of register map correponding to @driver_data, or
+ * Return: first region of register map correponding to @driver_data, or
  *                     -ve error code
  */
 void *syscon_get_first_range(ulong driver_data);
 
+/**
+ * syscon_node_to_regmap - get regmap from syscon
+ *
+ * @node:              Device node of syscon
+ */
+struct regmap *syscon_node_to_regmap(ofnode node);
+
 #endif