[PATCH v2 0/3] Add Renesas SoC identification driver support

This patch series aims to support Renesas SoC identification driver.
Added a helper function of_match_node to find the matching of_match structure. This helper function can be used to replace the following code in u-boot [1] and [2] [1] https://elixir.bootlin.com/u-boot/latest/source/drivers/serial/serial_uniphi... [2] https://elixir.bootlin.com/u-boot/latest/source/drivers/usb/phy/rockchip_usb...
Also added soc_id attribute support in UCLASS_SOC which is required for Renesas SoC identification driver similar to mainline linux.
Biju Das (3): dm: core: Add of_match_node helper function dm: soc: Add SoC id for attribute matching dm: soc: SoC identification driver for Renesas SoC's
drivers/core/device.c | 21 ++++ drivers/soc/Kconfig | 7 ++ drivers/soc/Makefile | 1 + drivers/soc/soc-uclass.c | 19 ++- drivers/soc/soc_renesas.c | 239 ++++++++++++++++++++++++++++++++++++++ drivers/soc/soc_sandbox.c | 8 ++ include/dm/device.h | 13 +++ include/soc.h | 39 ++++++- test/dm/soc.c | 8 ++ 9 files changed, 348 insertions(+), 7 deletions(-) create mode 100644 drivers/soc/soc_renesas.c

Add of_match_node() helper function to iterate over the device tree and tell if a device_node has a matching of_match structure.
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar prabhakar.mahadev-lad.rj@bp.renesas.com --- v1->v2: * No Change. Ref: https://patchwork.ozlabs.org/project/uboot/patch/20201030140303.11773-1-biju... --- drivers/core/device.c | 21 +++++++++++++++++++++ include/dm/device.h | 13 +++++++++++++ 2 files changed, 34 insertions(+)
diff --git a/drivers/core/device.c b/drivers/core/device.c index 4b3dcb3b37..348d63dc59 100644 --- a/drivers/core/device.c +++ b/drivers/core/device.c @@ -1010,6 +1010,27 @@ bool of_machine_is_compatible(const char *compat) return !fdt_node_check_compatible(fdt, 0, compat); }
+static +const struct udevice_id *__of_match_node(const struct udevice_id *matches, + const ofnode node) +{ + if (!matches) + return NULL; + + for (; matches && matches->compatible; matches++) { + if (ofnode_device_is_compatible(node, matches->compatible)) + return matches; + } + + return NULL; +} + +const struct udevice_id *of_match_node(const struct udevice_id *matches, + const ofnode node) +{ + return __of_match_node(matches, node); +} + int dev_disable_by_path(const char *path) { struct uclass *uc; diff --git a/include/dm/device.h b/include/dm/device.h index 5bef484247..4c357d46ec 100644 --- a/include/dm/device.h +++ b/include/dm/device.h @@ -754,6 +754,19 @@ bool device_is_compatible(const struct udevice *dev, const char *compat); */ bool of_machine_is_compatible(const char *compat);
+/** + * of_match_node() - Tell if a device_node has a matching of_match structure + * + * + * Low level utility function used by device matching. + * + * @matches: array of of device match structures to search in + * @node: the of device structure to match against + * @return matching structure on success, NULL if the match is not found + */ +const struct udevice_id *of_match_node(const struct udevice_id *matches, + const ofnode node); + /** * dev_disable_by_path() - Disable a device given its device tree path *

On Mon, 2 Nov 2020 at 08:10, Biju Das biju.das.jz@bp.renesas.com wrote:
Add of_match_node() helper function to iterate over the device tree and tell if a device_node has a matching of_match structure.
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar prabhakar.mahadev-lad.rj@bp.renesas.com
v1->v2:
- No Change.
Ref: https://patchwork.ozlabs.org/project/uboot/patch/20201030140303.11773-1-biju...
drivers/core/device.c | 21 +++++++++++++++++++++ include/dm/device.h | 13 +++++++++++++ 2 files changed, 34 insertions(+)
Please do add a test for this, perhaps in test/dm/core.c
Regards, Simon

Hi Simon,
Thanks for the feedback.
Subject: Re: [PATCH v2 1/3] dm: core: Add of_match_node helper function
On Mon, 2 Nov 2020 at 08:10, Biju Das biju.das.jz@bp.renesas.com wrote:
Add of_match_node() helper function to iterate over the device tree and tell if a device_node has a matching of_match structure.
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar <prabhakar.mahadev-
lad.rj@bp.renesas.com>
v1->v2:
- No Change.
drivers/core/device.c | 21 +++++++++++++++++++++ include/dm/device.h | 13 +++++++++++++ 2 files changed, 34 insertions(+)
Please do add a test for this, perhaps in test/dm/core.c
OK, Will post v3 including the test.
Regards, Biju
Regards, Simon

Add SoC identification string for attribute matching. Also changed the comments from "an SOC" to "an SoC".
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar prabhakar.mahadev-lad.rj@bp.renesas.com --- v1->v2: Changed the comments from "a SoC" to "an SoC" Ref: https://patchwork.ozlabs.org/project/uboot/patch/20201030140724.12773-1-biju... --- drivers/soc/soc-uclass.c | 19 ++++++++++++++++++- drivers/soc/soc_sandbox.c | 8 ++++++++ include/soc.h | 39 +++++++++++++++++++++++++++++++++------ test/dm/soc.c | 8 ++++++++ 4 files changed, 67 insertions(+), 7 deletions(-)
diff --git a/drivers/soc/soc-uclass.c b/drivers/soc/soc-uclass.c index c32d647864..a3f8be841b 100644 --- a/drivers/soc/soc-uclass.c +++ b/drivers/soc/soc-uclass.c @@ -46,6 +46,16 @@ int soc_get_revision(struct udevice *dev, char *buf, int size) return ops->get_revision(dev, buf, size); }
+int soc_get_soc_id(struct udevice *dev, char *buf, int size) +{ + struct soc_ops *ops = soc_get_ops(dev); + + if (!ops->get_soc_id) + return -ENOSYS; + + return ops->get_soc_id(dev, buf, size); +} + const struct soc_attr * soc_device_match(const struct soc_attr *matches) { @@ -61,7 +71,7 @@ soc_device_match(const struct soc_attr *matches)
while (1) { if (!(matches->machine || matches->family || - matches->revision)) + matches->revision || matches->soc_id)) break;
match = true; @@ -87,6 +97,13 @@ soc_device_match(const struct soc_attr *matches) } }
+ if (matches->soc_id) { + if (!soc_get_soc_id(soc, str, SOC_MAX_STR_SIZE)) { + if (strcmp(matches->soc_id, str)) + match = false; + } + } + if (match) return matches;
diff --git a/drivers/soc/soc_sandbox.c b/drivers/soc/soc_sandbox.c index 5c82ad84fc..1a81d3562a 100644 --- a/drivers/soc/soc_sandbox.c +++ b/drivers/soc/soc_sandbox.c @@ -31,10 +31,18 @@ int soc_sandbox_get_revision(struct udevice *dev, char *buf, int size) return 0; }
+int soc_sandbox_get_soc_id(struct udevice *dev, char *buf, int size) +{ + snprintf(buf, size, "r8a774a1"); + + return 0; +} + static const struct soc_ops soc_sandbox_ops = { .get_family = soc_sandbox_get_family, .get_revision = soc_sandbox_get_revision, .get_machine = soc_sandbox_get_machine, + .get_soc_id = soc_sandbox_get_soc_id, };
int soc_sandbox_probe(struct udevice *dev) diff --git a/include/soc.h b/include/soc.h index a55eb1b572..db0e8880d1 100644 --- a/include/soc.h +++ b/include/soc.h @@ -20,18 +20,20 @@ * variants. Example: am33 * @machine - Name of a specific SoC. Example: am3352 * @revision - Name of a specific SoC revision. Example: SR1.1 + * @soc_id - SoC identification string. Example: r8a774a1 * @data - A pointer to user data for the SoC variant */ struct soc_attr { const char *family; const char *machine; const char *revision; + const char *soc_id; const void *data; };
struct soc_ops { /** - * get_machine() - Get machine name of an SOC + * get_machine() - Get machine name of an SoC * * @dev: Device to check (UCLASS_SOC) * @buf: Buffer to place string @@ -41,7 +43,7 @@ struct soc_ops { int (*get_machine)(struct udevice *dev, char *buf, int size);
/** - * get_revision() - Get revision name of a SOC + * get_revision() - Get revision name of an SoC * * @dev: Device to check (UCLASS_SOC) * @buf: Buffer to place string @@ -51,7 +53,7 @@ struct soc_ops { int (*get_revision)(struct udevice *dev, char *buf, int size);
/** - * get_family() - Get family name of an SOC + * get_family() - Get family name of an SoC * * @dev: Device to check (UCLASS_SOC) * @buf: Buffer to place string @@ -59,6 +61,16 @@ struct soc_ops { * @return 0 if OK, -ENOSPC if buffer is too small, other -ve on error */ int (*get_family)(struct udevice *dev, char *buf, int size); + + /** + * get_soc_id() - Get SoC identification name of an SoC + * + * @dev: Device to check (UCLASS_SOC) + * @buf: Buffer to place string + * @size: Size of string space + * @return 0 if OK, -ENOSPC if buffer is too small, other -ve on error + */ + int (*get_soc_id)(struct udevice *dev, char *buf, int size); };
#define soc_get_ops(dev) ((struct soc_ops *)(dev)->driver->ops) @@ -76,7 +88,7 @@ struct soc_ops { int soc_get(struct udevice **devp);
/** - * soc_get_machine() - Get machine name of an SOC + * soc_get_machine() - Get machine name of an SoC * @dev: Device to check (UCLASS_SOC) * @buf: Buffer to place string * @size: Size of string space @@ -86,7 +98,7 @@ int soc_get(struct udevice **devp); int soc_get_machine(struct udevice *dev, char *buf, int size);
/** - * soc_get_revision() - Get revision name of an SOC + * soc_get_revision() - Get revision name of an SoC * @dev: Device to check (UCLASS_SOC) * @buf: Buffer to place string * @size: Size of string space @@ -96,7 +108,7 @@ int soc_get_machine(struct udevice *dev, char *buf, int size); int soc_get_revision(struct udevice *dev, char *buf, int size);
/** - * soc_get_family() - Get family name of an SOC + * soc_get_family() - Get family name of an SoC * @dev: Device to check (UCLASS_SOC) * @buf: Buffer to place string * @size: Size of string space @@ -105,6 +117,16 @@ int soc_get_revision(struct udevice *dev, char *buf, int size); */ int soc_get_family(struct udevice *dev, char *buf, int size);
+/** + * soc_get_soc_id() - Get SoC identification name of an SoC + * @dev: Device to check (UCLASS_SOC) + * @buf: Buffer to place string + * @size: Size of string space + * + * Return: 0 if OK, -ENOSPC if buffer is too small, other -ve on error + */ +int soc_get_soc_id(struct udevice *dev, char *buf, int size); + /** * soc_device_match() - Return match from an array of soc_attr * @matches: Array with any combination of family, revision or machine set @@ -136,6 +158,11 @@ static inline int soc_get_family(struct udevice *dev, char *buf, int size) return -ENOSYS; }
+static inline int soc_get_soc_id(struct udevice *dev, char *buf, int size) +{ + return -ENOSYS; +} + static inline const struct soc_attr * soc_device_match(const struct soc_attr *matches) { diff --git a/test/dm/soc.c b/test/dm/soc.c index 17e1b5ba01..82cd53ff29 100644 --- a/test/dm/soc.c +++ b/test/dm/soc.c @@ -32,24 +32,28 @@ static int dm_test_soc(struct unit_test_state *uts) .family = "SANDBOX0xx", .machine = "SANDBOX012", .revision = "1.0", + .soc_id = "r8a774a1", .data = NULL, }, { .family = "SANDBOX1xx", .machine = "SANDBOX107", .revision = "1.0", + .soc_id = "r8a774a1", .data = NULL, }, { .family = "SANDBOX1xx", .machine = "SANDBOX123", .revision = "1.0", + .soc_id = "r8a774a1", .data = &soc_sandbox123_data, }, { .family = "SANDBOX1xx", .machine = "SANDBOX131", .revision = "2.0", + .soc_id = "r8a774a1", .data = NULL, }, { /* sentinel */ } @@ -78,6 +82,7 @@ static int dm_test_soc(struct unit_test_state *uts) { .family = "SANDBOX0xx", .revision = "1.0", + .soc_id = "r8a774b1", .data = NULL, }, { @@ -99,6 +104,9 @@ static int dm_test_soc(struct unit_test_state *uts) ut_assertok(soc_get_revision(dev, text, sizeof(text))); ut_asserteq_str(text, "1.0");
+ ut_assertok(soc_get_soc_id(dev, text, sizeof(text))); + ut_asserteq_str(text, "r8a774a1"); + soc_data = soc_device_match(sb_soc_devices_full); ut_assert(soc_data);

Hi Biju,
On Mon, 2 Nov 2020 at 08:10, Biju Das biju.das.jz@bp.renesas.com wrote:
Add SoC identification string for attribute matching. Also changed the comments from "an SOC" to "an SoC".
Please put this second bit in a separate patch, perhaps before this one in the series.
Otherwise it looks good to me.
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar prabhakar.mahadev-lad.rj@bp.renesas.com
v1->v2: Changed the comments from "a SoC" to "an SoC" Ref: https://patchwork.ozlabs.org/project/uboot/patch/20201030140724.12773-1-biju...
drivers/soc/soc-uclass.c | 19 ++++++++++++++++++- drivers/soc/soc_sandbox.c | 8 ++++++++ include/soc.h | 39 +++++++++++++++++++++++++++++++++------ test/dm/soc.c | 8 ++++++++ 4 files changed, 67 insertions(+), 7 deletions(-)

Hi Simon,
Thanks for the feedback.
Subject: Re: [PATCH v2 2/3] dm: soc: Add SoC id for attribute matching
Hi Biju,
On Mon, 2 Nov 2020 at 08:10, Biju Das biju.das.jz@bp.renesas.com wrote:
Add SoC identification string for attribute matching. Also changed the comments from "an SOC" to "an SoC".
Please put this second bit in a separate patch, perhaps before this one in the series.
OK. Will split the patch into two and post v3.
Regards, Biju
Otherwise it looks good to me.
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar <prabhakar.mahadev-
lad.rj@bp.renesas.com>
v1->v2: Changed the comments from "a SoC" to "an SoC"
drivers/soc/soc-uclass.c | 19 ++++++++++++++++++- drivers/soc/soc_sandbox.c | 8 ++++++++ include/soc.h | 39 +++++++++++++++++++++++++++++++++------ test/dm/soc.c | 8 ++++++++ 4 files changed, 67 insertions(+), 7 deletions(-)

Add SoC identification driver for Renesas SoC's. This allows to identify the SoC type and revision based on Product Register.
This can be checked where needed using soc_device_match().
Signed-off-by: Biju Das biju.das.jz@bp.renesas.com Reviewed-by: Lad Prabhakar prabhakar.mahadev-lad.rj@bp.renesas.com --- v2: New patch --- drivers/soc/Kconfig | 7 ++ drivers/soc/Makefile | 1 + drivers/soc/soc_renesas.c | 239 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 247 insertions(+) create mode 100644 drivers/soc/soc_renesas.c
diff --git a/drivers/soc/Kconfig b/drivers/soc/Kconfig index 864d00a885..475e94cd77 100644 --- a/drivers/soc/Kconfig +++ b/drivers/soc/Kconfig @@ -16,6 +16,13 @@ config SOC_DEVICE_TI_K3 This allows Texas Instruments Keystone 3 SoCs to identify specifics about the SoC in use.
+config SOC_DEVICE_RENESAS + depends on SOC_DEVICE + bool "Enable SoC driver for Renesas SoCs" + help + This allows Renesas SoCs to identify specifics about the + SoC in use. + source "drivers/soc/ti/Kconfig"
endmenu diff --git a/drivers/soc/Makefile b/drivers/soc/Makefile index 9ef20ca506..b143eac5fd 100644 --- a/drivers/soc/Makefile +++ b/drivers/soc/Makefile @@ -4,5 +4,6 @@
obj-$(CONFIG_SOC_TI) += ti/ obj-$(CONFIG_SOC_DEVICE) += soc-uclass.o +obj-$(CONFIG_$(SPL_)SOC_DEVICE_RENESAS) += soc_renesas.o obj-$(CONFIG_SOC_DEVICE_TI_K3) += soc_ti_k3.o obj-$(CONFIG_SANDBOX) += soc_sandbox.o diff --git a/drivers/soc/soc_renesas.c b/drivers/soc/soc_renesas.c new file mode 100644 index 0000000000..4543e0dbfd --- /dev/null +++ b/drivers/soc/soc_renesas.c @@ -0,0 +1,239 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Copyright (C) 2020 Renesas Electronics Corp. + * + */ + +#include <common.h> +#include <dm.h> +#include <dm/device-internal.h> +#include <soc.h> + +#include <asm/io.h> + +struct soc_renesas_priv { + const char *family; + const char *soc_id; + char revision[6]; +}; + +struct renesas_family { + const char name[16]; + u32 reg; /* CCCR or PRR, if not in DT */ +}; + +static const struct renesas_family fam_rcar_gen3 __maybe_unused = { + .name = "R-Car Gen3", + .reg = 0xfff00044, /* PRR (Product Register) */ +}; + +static const struct renesas_family fam_rzg2 __maybe_unused = { + .name = "RZ/G2", + .reg = 0xfff00044, /* PRR (Product Register) */ +}; + +struct renesas_soc { + const struct renesas_family *family; + u8 id; +}; + +#ifdef CONFIG_R8A774A1 +static const struct renesas_soc soc_rz_g2m = { + .family = &fam_rzg2, + .id = 0x52, +}; +#endif + +#ifdef CONFIG_R8A774B1 +static const struct renesas_soc soc_rz_g2n = { + .family = &fam_rzg2, + .id = 0x55, +}; +#endif + +#ifdef CONFIG_R8A774C0 +static const struct renesas_soc soc_rz_g2e = { + .family = &fam_rzg2, + .id = 0x57, +}; +#endif + +#ifdef CONFIG_R8A774E1 +static const struct renesas_soc soc_rz_g2h = { + .family = &fam_rzg2, + .id = 0x4f, +}; +#endif + +#ifdef CONFIG_R8A7795 +static const struct renesas_soc soc_rcar_h3 = { + .family = &fam_rcar_gen3, + .id = 0x4f, +}; +#endif + +#ifdef CONFIG_R8A7796 +static const struct renesas_soc soc_rcar_m3_w = { + .family = &fam_rcar_gen3, + .id = 0x52, +}; +#endif + +#ifdef CONFIG_R8A77965 +static const struct renesas_soc soc_rcar_m3_n = { + .family = &fam_rcar_gen3, + .id = 0x55, +}; +#endif + +#ifdef CONFIG_R8A77970 +static const struct renesas_soc soc_rcar_v3m = { + .family = &fam_rcar_gen3, + .id = 0x54, +}; +#endif + +#ifdef CONFIG_R8A77980 +static const struct renesas_soc soc_rcar_v3h = { + .family = &fam_rcar_gen3, + .id = 0x56, +}; +#endif + +#ifdef CONFIG_R8A77990 +static const struct renesas_soc soc_rcar_e3 = { + .family = &fam_rcar_gen3, + .id = 0x57, +}; +#endif + +#ifdef CONFIG_R8A77995 +static const struct renesas_soc soc_rcar_d3 = { + .family = &fam_rcar_gen3, + .id = 0x58, +}; +#endif + +static int soc_renesas_get_family(struct udevice *dev, char *buf, int size) +{ + struct soc_renesas_priv *priv = dev_get_priv(dev); + + snprintf(buf, size, "%s", priv->family); + + return 0; +} + +static int soc_renesas_get_revision(struct udevice *dev, char *buf, int size) +{ + struct soc_renesas_priv *priv = dev_get_priv(dev); + + snprintf(buf, size, "%s", priv->revision); + + return 0; +} + +static int soc_renesas_get_soc_id(struct udevice *dev, char *buf, int size) +{ + struct soc_renesas_priv *priv = dev_get_priv(dev); + + snprintf(buf, size, "%s", priv->soc_id); + + return 0; +} + +static const struct udevice_id renesas_socs[] = { +#ifdef CONFIG_R8A774A1 + { .compatible = "renesas,r8a774a1", .data = (ulong)&soc_rz_g2m, }, +#endif +#ifdef CONFIG_R8A774B1 + { .compatible = "renesas,r8a774b1", .data = (ulong)&soc_rz_g2n, }, +#endif +#ifdef CONFIG_R8A774C0 + { .compatible = "renesas,r8a774c0", .data = (ulong)&soc_rz_g2e, }, +#endif +#ifdef CONFIG_R8A774E1 + { .compatible = "renesas,r8a774e1", .data = (ulong)&soc_rz_g2h, }, +#endif +#ifdef CONFIG_R8A7795 + { .compatible = "renesas,r8a7795", .data = (ulong)&soc_rcar_h3, }, +#endif +#ifdef CONFIG_R8A7796 + { .compatible = "renesas,r8a7796", .data = (ulong)&soc_rcar_m3_w, }, +#endif +#ifdef CONFIG_R8A77965 + { .compatible = "renesas,r8a77965", .data = (ulong)&soc_rcar_m3_n, }, +#endif +#ifdef CONFIG_R8A77970 + { .compatible = "renesas,r8a77970", .data = (ulong)&soc_rcar_v3m, }, +#endif +#ifdef CONFIG_R8A77980 + { .compatible = "renesas,r8a77980", .data = (ulong)&soc_rcar_v3h, }, +#endif +#ifdef CONFIG_R8A77990 + { .compatible = "renesas,r8a77990", .data = (ulong)&soc_rcar_e3, }, +#endif +#ifdef CONFIG_R8A77995 + { .compatible = "renesas,r8a77995", .data = (ulong)&soc_rcar_d3, }, +#endif + { /* sentinel */ } +}; + +static const struct udevice_id prr_ids[] = { + { .compatible = "renesas,prr" }, + { /* sentinel */ } +}; + +static const struct soc_ops soc_renesas_ops = { + .get_family = soc_renesas_get_family, + .get_revision = soc_renesas_get_revision, + .get_soc_id = soc_renesas_get_soc_id, +}; + +int soc_renesas_probe(struct udevice *dev) +{ + struct soc_renesas_priv *priv = dev_get_priv(dev); + const struct renesas_family *family; + const struct udevice_id *match; + struct renesas_soc *soc; + unsigned int product, eshi = 0, eslo; + ofnode root_node; + + root_node = ofnode_path("/"); + match = of_match_node(renesas_socs, root_node); + if (!match) { + printf("SoC entry is missing in DT\n"); + return 0; + } + + soc = (struct renesas_soc *)match->data; + family = soc->family; + + product = readl(0xFFF00044); + /* R-Car M3-W ES1.1 incorrectly identifies as ES2.0 */ + if ((product & 0x7fff) == 0x5210) + product ^= 0x11; + /* R-Car M3-W ES1.3 incorrectly identifies as ES2.1 */ + if ((product & 0x7fff) == 0x5211) + product ^= 0x12; + if (soc->id && ((product >> 8) & 0xff) != soc->id) { + printf("SoC mismatch (product = 0x%x)\n", product); + return 0; + } + eshi = ((product >> 4) & 0x0f) + 1; + eslo = product & 0xf; + + priv->family = family->name; + priv->soc_id = strchr(match->compatible, ',') + 1; + snprintf(priv->revision, sizeof(priv->revision), "ES%u.%u", eshi, eslo); + + return 0; +} + +U_BOOT_DRIVER(soc_renesas) = { + .name = "soc_renesas", + .id = UCLASS_SOC, + .ops = &soc_renesas_ops, + .of_match = prr_ids, + .probe = soc_renesas_probe, + .priv_auto_alloc_size = sizeof(struct soc_renesas_priv), +};
participants (2)
-
Biju Das
-
Simon Glass