162306a36Sopenharmony_ci// SPDX-License-Identifier: GPL-2.0-or-later
262306a36Sopenharmony_ci/*
362306a36Sopenharmony_ci * Procedures for creating, accessing and interpreting the device tree.
462306a36Sopenharmony_ci *
562306a36Sopenharmony_ci * Paul Mackerras	August 1996.
662306a36Sopenharmony_ci * Copyright (C) 1996-2005 Paul Mackerras.
762306a36Sopenharmony_ci *
862306a36Sopenharmony_ci *  Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
962306a36Sopenharmony_ci *    {engebret|bergner}@us.ibm.com
1062306a36Sopenharmony_ci *
1162306a36Sopenharmony_ci *  Adapted for sparc32 by David S. Miller davem@davemloft.net
1262306a36Sopenharmony_ci */
1362306a36Sopenharmony_ci
1462306a36Sopenharmony_ci#include <linux/kernel.h>
1562306a36Sopenharmony_ci#include <linux/types.h>
1662306a36Sopenharmony_ci#include <linux/string.h>
1762306a36Sopenharmony_ci#include <linux/mm.h>
1862306a36Sopenharmony_ci#include <linux/memblock.h>
1962306a36Sopenharmony_ci
2062306a36Sopenharmony_ci#include <asm/prom.h>
2162306a36Sopenharmony_ci#include <asm/oplib.h>
2262306a36Sopenharmony_ci#include <asm/leon.h>
2362306a36Sopenharmony_ci#include <asm/leon_amba.h>
2462306a36Sopenharmony_ci
2562306a36Sopenharmony_ci#include "prom.h"
2662306a36Sopenharmony_ci
2762306a36Sopenharmony_civoid * __init prom_early_alloc(unsigned long size)
2862306a36Sopenharmony_ci{
2962306a36Sopenharmony_ci	void *ret;
3062306a36Sopenharmony_ci
3162306a36Sopenharmony_ci	ret = memblock_alloc(size, SMP_CACHE_BYTES);
3262306a36Sopenharmony_ci	if (!ret)
3362306a36Sopenharmony_ci		panic("%s: Failed to allocate %lu bytes\n", __func__, size);
3462306a36Sopenharmony_ci
3562306a36Sopenharmony_ci	prom_early_allocated += size;
3662306a36Sopenharmony_ci
3762306a36Sopenharmony_ci	return ret;
3862306a36Sopenharmony_ci}
3962306a36Sopenharmony_ci
4062306a36Sopenharmony_ci/* The following routines deal with the black magic of fully naming a
4162306a36Sopenharmony_ci * node.
4262306a36Sopenharmony_ci *
4362306a36Sopenharmony_ci * Certain well known named nodes are just the simple name string.
4462306a36Sopenharmony_ci *
4562306a36Sopenharmony_ci * Actual devices have an address specifier appended to the base name
4662306a36Sopenharmony_ci * string, like this "foo@addr".  The "addr" can be in any number of
4762306a36Sopenharmony_ci * formats, and the platform plus the type of the node determine the
4862306a36Sopenharmony_ci * format and how it is constructed.
4962306a36Sopenharmony_ci *
5062306a36Sopenharmony_ci * For children of the ROOT node, the naming convention is fixed and
5162306a36Sopenharmony_ci * determined by whether this is a sun4u or sun4v system.
5262306a36Sopenharmony_ci *
5362306a36Sopenharmony_ci * For children of other nodes, it is bus type specific.  So
5462306a36Sopenharmony_ci * we walk up the tree until we discover a "device_type" property
5562306a36Sopenharmony_ci * we recognize and we go from there.
5662306a36Sopenharmony_ci */
5762306a36Sopenharmony_cistatic void __init sparc32_path_component(struct device_node *dp, char *tmp_buf)
5862306a36Sopenharmony_ci{
5962306a36Sopenharmony_ci	const char *name = of_get_property(dp, "name", NULL);
6062306a36Sopenharmony_ci	struct linux_prom_registers *regs;
6162306a36Sopenharmony_ci	struct property *rprop;
6262306a36Sopenharmony_ci
6362306a36Sopenharmony_ci	rprop = of_find_property(dp, "reg", NULL);
6462306a36Sopenharmony_ci	if (!rprop)
6562306a36Sopenharmony_ci		return;
6662306a36Sopenharmony_ci
6762306a36Sopenharmony_ci	regs = rprop->value;
6862306a36Sopenharmony_ci	sprintf(tmp_buf, "%s@%x,%x",
6962306a36Sopenharmony_ci		name,
7062306a36Sopenharmony_ci		regs->which_io, regs->phys_addr);
7162306a36Sopenharmony_ci}
7262306a36Sopenharmony_ci
7362306a36Sopenharmony_ci/* "name@slot,offset"  */
7462306a36Sopenharmony_cistatic void __init sbus_path_component(struct device_node *dp, char *tmp_buf)
7562306a36Sopenharmony_ci{
7662306a36Sopenharmony_ci	const char *name = of_get_property(dp, "name", NULL);
7762306a36Sopenharmony_ci	struct linux_prom_registers *regs;
7862306a36Sopenharmony_ci	struct property *prop;
7962306a36Sopenharmony_ci
8062306a36Sopenharmony_ci	prop = of_find_property(dp, "reg", NULL);
8162306a36Sopenharmony_ci	if (!prop)
8262306a36Sopenharmony_ci		return;
8362306a36Sopenharmony_ci
8462306a36Sopenharmony_ci	regs = prop->value;
8562306a36Sopenharmony_ci	sprintf(tmp_buf, "%s@%x,%x",
8662306a36Sopenharmony_ci		name,
8762306a36Sopenharmony_ci		regs->which_io,
8862306a36Sopenharmony_ci		regs->phys_addr);
8962306a36Sopenharmony_ci}
9062306a36Sopenharmony_ci
9162306a36Sopenharmony_ci/* "name@devnum[,func]" */
9262306a36Sopenharmony_cistatic void __init pci_path_component(struct device_node *dp, char *tmp_buf)
9362306a36Sopenharmony_ci{
9462306a36Sopenharmony_ci	const char *name = of_get_property(dp, "name", NULL);
9562306a36Sopenharmony_ci	struct linux_prom_pci_registers *regs;
9662306a36Sopenharmony_ci	struct property *prop;
9762306a36Sopenharmony_ci	unsigned int devfn;
9862306a36Sopenharmony_ci
9962306a36Sopenharmony_ci	prop = of_find_property(dp, "reg", NULL);
10062306a36Sopenharmony_ci	if (!prop)
10162306a36Sopenharmony_ci		return;
10262306a36Sopenharmony_ci
10362306a36Sopenharmony_ci	regs = prop->value;
10462306a36Sopenharmony_ci	devfn = (regs->phys_hi >> 8) & 0xff;
10562306a36Sopenharmony_ci	if (devfn & 0x07) {
10662306a36Sopenharmony_ci		sprintf(tmp_buf, "%s@%x,%x",
10762306a36Sopenharmony_ci			name,
10862306a36Sopenharmony_ci			devfn >> 3,
10962306a36Sopenharmony_ci			devfn & 0x07);
11062306a36Sopenharmony_ci	} else {
11162306a36Sopenharmony_ci		sprintf(tmp_buf, "%s@%x",
11262306a36Sopenharmony_ci			name,
11362306a36Sopenharmony_ci			devfn >> 3);
11462306a36Sopenharmony_ci	}
11562306a36Sopenharmony_ci}
11662306a36Sopenharmony_ci
11762306a36Sopenharmony_ci/* "name@addrhi,addrlo" */
11862306a36Sopenharmony_cistatic void __init ebus_path_component(struct device_node *dp, char *tmp_buf)
11962306a36Sopenharmony_ci{
12062306a36Sopenharmony_ci	const char *name = of_get_property(dp, "name", NULL);
12162306a36Sopenharmony_ci	struct linux_prom_registers *regs;
12262306a36Sopenharmony_ci	struct property *prop;
12362306a36Sopenharmony_ci
12462306a36Sopenharmony_ci	prop = of_find_property(dp, "reg", NULL);
12562306a36Sopenharmony_ci	if (!prop)
12662306a36Sopenharmony_ci		return;
12762306a36Sopenharmony_ci
12862306a36Sopenharmony_ci	regs = prop->value;
12962306a36Sopenharmony_ci
13062306a36Sopenharmony_ci	sprintf(tmp_buf, "%s@%x,%x",
13162306a36Sopenharmony_ci		name,
13262306a36Sopenharmony_ci		regs->which_io, regs->phys_addr);
13362306a36Sopenharmony_ci}
13462306a36Sopenharmony_ci
13562306a36Sopenharmony_ci/* "name@irq,addrlo" */
13662306a36Sopenharmony_cistatic void __init ambapp_path_component(struct device_node *dp, char *tmp_buf)
13762306a36Sopenharmony_ci{
13862306a36Sopenharmony_ci	const char *name = of_get_property(dp, "name", NULL);
13962306a36Sopenharmony_ci	struct amba_prom_registers *regs;
14062306a36Sopenharmony_ci	unsigned int *intr;
14162306a36Sopenharmony_ci	unsigned int reg0;
14262306a36Sopenharmony_ci	struct property *prop;
14362306a36Sopenharmony_ci	int interrupt = 0;
14462306a36Sopenharmony_ci
14562306a36Sopenharmony_ci	/* In order to get a unique ID in the device tree (multiple AMBA devices
14662306a36Sopenharmony_ci	 * may have the same name) the node number is printed
14762306a36Sopenharmony_ci	 */
14862306a36Sopenharmony_ci	prop = of_find_property(dp, "reg", NULL);
14962306a36Sopenharmony_ci	if (!prop) {
15062306a36Sopenharmony_ci		reg0 = (unsigned int)dp->phandle;
15162306a36Sopenharmony_ci	} else {
15262306a36Sopenharmony_ci		regs = prop->value;
15362306a36Sopenharmony_ci		reg0 = regs->phys_addr;
15462306a36Sopenharmony_ci	}
15562306a36Sopenharmony_ci
15662306a36Sopenharmony_ci	/* Not all cores have Interrupt */
15762306a36Sopenharmony_ci	prop = of_find_property(dp, "interrupts", NULL);
15862306a36Sopenharmony_ci	if (!prop)
15962306a36Sopenharmony_ci		intr = &interrupt; /* IRQ0 does not exist */
16062306a36Sopenharmony_ci	else
16162306a36Sopenharmony_ci		intr = prop->value;
16262306a36Sopenharmony_ci
16362306a36Sopenharmony_ci	sprintf(tmp_buf, "%s@%x,%x", name, *intr, reg0);
16462306a36Sopenharmony_ci}
16562306a36Sopenharmony_ci
16662306a36Sopenharmony_cistatic void __init __build_path_component(struct device_node *dp, char *tmp_buf)
16762306a36Sopenharmony_ci{
16862306a36Sopenharmony_ci	struct device_node *parent = dp->parent;
16962306a36Sopenharmony_ci
17062306a36Sopenharmony_ci	if (parent != NULL) {
17162306a36Sopenharmony_ci		if (of_node_is_type(parent, "pci") ||
17262306a36Sopenharmony_ci		    of_node_is_type(parent, "pciex"))
17362306a36Sopenharmony_ci			return pci_path_component(dp, tmp_buf);
17462306a36Sopenharmony_ci		if (of_node_is_type(parent, "sbus"))
17562306a36Sopenharmony_ci			return sbus_path_component(dp, tmp_buf);
17662306a36Sopenharmony_ci		if (of_node_is_type(parent, "ebus"))
17762306a36Sopenharmony_ci			return ebus_path_component(dp, tmp_buf);
17862306a36Sopenharmony_ci		if (of_node_is_type(parent, "ambapp"))
17962306a36Sopenharmony_ci			return ambapp_path_component(dp, tmp_buf);
18062306a36Sopenharmony_ci
18162306a36Sopenharmony_ci		/* "isa" is handled with platform naming */
18262306a36Sopenharmony_ci	}
18362306a36Sopenharmony_ci
18462306a36Sopenharmony_ci	/* Use platform naming convention.  */
18562306a36Sopenharmony_ci	return sparc32_path_component(dp, tmp_buf);
18662306a36Sopenharmony_ci}
18762306a36Sopenharmony_ci
18862306a36Sopenharmony_cichar * __init build_path_component(struct device_node *dp)
18962306a36Sopenharmony_ci{
19062306a36Sopenharmony_ci	const char *name = of_get_property(dp, "name", NULL);
19162306a36Sopenharmony_ci	char tmp_buf[64], *n;
19262306a36Sopenharmony_ci
19362306a36Sopenharmony_ci	tmp_buf[0] = '\0';
19462306a36Sopenharmony_ci	__build_path_component(dp, tmp_buf);
19562306a36Sopenharmony_ci	if (tmp_buf[0] == '\0')
19662306a36Sopenharmony_ci		strcpy(tmp_buf, name);
19762306a36Sopenharmony_ci
19862306a36Sopenharmony_ci	n = prom_early_alloc(strlen(tmp_buf) + 1);
19962306a36Sopenharmony_ci	strcpy(n, tmp_buf);
20062306a36Sopenharmony_ci
20162306a36Sopenharmony_ci	return n;
20262306a36Sopenharmony_ci}
20362306a36Sopenharmony_ci
20462306a36Sopenharmony_ciextern void restore_current(void);
20562306a36Sopenharmony_ci
20662306a36Sopenharmony_civoid __init of_console_init(void)
20762306a36Sopenharmony_ci{
20862306a36Sopenharmony_ci	char *msg = "OF stdout device is: %s\n";
20962306a36Sopenharmony_ci	struct device_node *dp;
21062306a36Sopenharmony_ci	unsigned long flags;
21162306a36Sopenharmony_ci	const char *type;
21262306a36Sopenharmony_ci	phandle node;
21362306a36Sopenharmony_ci	int skip, tmp, fd;
21462306a36Sopenharmony_ci
21562306a36Sopenharmony_ci	of_console_path = prom_early_alloc(256);
21662306a36Sopenharmony_ci
21762306a36Sopenharmony_ci	switch (prom_vers) {
21862306a36Sopenharmony_ci	case PROM_V0:
21962306a36Sopenharmony_ci		skip = 0;
22062306a36Sopenharmony_ci		switch (*romvec->pv_stdout) {
22162306a36Sopenharmony_ci		case PROMDEV_SCREEN:
22262306a36Sopenharmony_ci			type = "display";
22362306a36Sopenharmony_ci			break;
22462306a36Sopenharmony_ci
22562306a36Sopenharmony_ci		case PROMDEV_TTYB:
22662306a36Sopenharmony_ci			skip = 1;
22762306a36Sopenharmony_ci			fallthrough;
22862306a36Sopenharmony_ci
22962306a36Sopenharmony_ci		case PROMDEV_TTYA:
23062306a36Sopenharmony_ci			type = "serial";
23162306a36Sopenharmony_ci			break;
23262306a36Sopenharmony_ci
23362306a36Sopenharmony_ci		default:
23462306a36Sopenharmony_ci			prom_printf("Invalid PROM_V0 stdout value %u\n",
23562306a36Sopenharmony_ci				    *romvec->pv_stdout);
23662306a36Sopenharmony_ci			prom_halt();
23762306a36Sopenharmony_ci		}
23862306a36Sopenharmony_ci
23962306a36Sopenharmony_ci		tmp = skip;
24062306a36Sopenharmony_ci		for_each_node_by_type(dp, type) {
24162306a36Sopenharmony_ci			if (!tmp--)
24262306a36Sopenharmony_ci				break;
24362306a36Sopenharmony_ci		}
24462306a36Sopenharmony_ci		if (!dp) {
24562306a36Sopenharmony_ci			prom_printf("Cannot find PROM_V0 console node.\n");
24662306a36Sopenharmony_ci			prom_halt();
24762306a36Sopenharmony_ci		}
24862306a36Sopenharmony_ci		of_console_device = dp;
24962306a36Sopenharmony_ci
25062306a36Sopenharmony_ci		sprintf(of_console_path, "%pOF", dp);
25162306a36Sopenharmony_ci		if (!strcmp(type, "serial")) {
25262306a36Sopenharmony_ci			strcat(of_console_path,
25362306a36Sopenharmony_ci			       (skip ? ":b" : ":a"));
25462306a36Sopenharmony_ci		}
25562306a36Sopenharmony_ci		break;
25662306a36Sopenharmony_ci
25762306a36Sopenharmony_ci	default:
25862306a36Sopenharmony_ci	case PROM_V2:
25962306a36Sopenharmony_ci	case PROM_V3:
26062306a36Sopenharmony_ci		fd = *romvec->pv_v2bootargs.fd_stdout;
26162306a36Sopenharmony_ci
26262306a36Sopenharmony_ci		spin_lock_irqsave(&prom_lock, flags);
26362306a36Sopenharmony_ci		node = (*romvec->pv_v2devops.v2_inst2pkg)(fd);
26462306a36Sopenharmony_ci		restore_current();
26562306a36Sopenharmony_ci		spin_unlock_irqrestore(&prom_lock, flags);
26662306a36Sopenharmony_ci
26762306a36Sopenharmony_ci		if (!node) {
26862306a36Sopenharmony_ci			prom_printf("Cannot resolve stdout node from "
26962306a36Sopenharmony_ci				    "instance %08x.\n", fd);
27062306a36Sopenharmony_ci			prom_halt();
27162306a36Sopenharmony_ci		}
27262306a36Sopenharmony_ci		dp = of_find_node_by_phandle(node);
27362306a36Sopenharmony_ci
27462306a36Sopenharmony_ci		if (!of_node_is_type(dp, "display") &&
27562306a36Sopenharmony_ci		    !of_node_is_type(dp, "serial")) {
27662306a36Sopenharmony_ci			prom_printf("Console device_type is neither display "
27762306a36Sopenharmony_ci				    "nor serial.\n");
27862306a36Sopenharmony_ci			prom_halt();
27962306a36Sopenharmony_ci		}
28062306a36Sopenharmony_ci
28162306a36Sopenharmony_ci		of_console_device = dp;
28262306a36Sopenharmony_ci
28362306a36Sopenharmony_ci		if (prom_vers == PROM_V2) {
28462306a36Sopenharmony_ci			sprintf(of_console_path, "%pOF", dp);
28562306a36Sopenharmony_ci			switch (*romvec->pv_stdout) {
28662306a36Sopenharmony_ci			case PROMDEV_TTYA:
28762306a36Sopenharmony_ci				strcat(of_console_path, ":a");
28862306a36Sopenharmony_ci				break;
28962306a36Sopenharmony_ci			case PROMDEV_TTYB:
29062306a36Sopenharmony_ci				strcat(of_console_path, ":b");
29162306a36Sopenharmony_ci				break;
29262306a36Sopenharmony_ci			}
29362306a36Sopenharmony_ci		} else {
29462306a36Sopenharmony_ci			const char *path;
29562306a36Sopenharmony_ci
29662306a36Sopenharmony_ci			dp = of_find_node_by_path("/");
29762306a36Sopenharmony_ci			path = of_get_property(dp, "stdout-path", NULL);
29862306a36Sopenharmony_ci			if (!path) {
29962306a36Sopenharmony_ci				prom_printf("No stdout-path in root node.\n");
30062306a36Sopenharmony_ci				prom_halt();
30162306a36Sopenharmony_ci			}
30262306a36Sopenharmony_ci			strcpy(of_console_path, path);
30362306a36Sopenharmony_ci		}
30462306a36Sopenharmony_ci		break;
30562306a36Sopenharmony_ci	}
30662306a36Sopenharmony_ci
30762306a36Sopenharmony_ci	of_console_options = strrchr(of_console_path, ':');
30862306a36Sopenharmony_ci	if (of_console_options) {
30962306a36Sopenharmony_ci		of_console_options++;
31062306a36Sopenharmony_ci		if (*of_console_options == '\0')
31162306a36Sopenharmony_ci			of_console_options = NULL;
31262306a36Sopenharmony_ci	}
31362306a36Sopenharmony_ci
31462306a36Sopenharmony_ci	printk(msg, of_console_path);
31562306a36Sopenharmony_ci}
31662306a36Sopenharmony_ci
31762306a36Sopenharmony_civoid __init of_fill_in_cpu_data(void)
31862306a36Sopenharmony_ci{
31962306a36Sopenharmony_ci}
32062306a36Sopenharmony_ci
32162306a36Sopenharmony_civoid __init irq_trans_init(struct device_node *dp)
32262306a36Sopenharmony_ci{
32362306a36Sopenharmony_ci}
324