plat/st/common/stm32mp_dt.c - filogic/atf - Gitiles

 /*
  * Copyright (c) 2017-2020, ARM Limited and Contributors. All rights reserved.
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */

 #include <assert.h>
 #include <errno.h>

 #include <libfdt.h>

 #include <platform_def.h>

 #include <common/debug.h>
 #include <common/fdt_wrappers.h>
 #include <drivers/st/stm32_gpio.h>
 #include <drivers/st/stm32mp1_ddr.h>
 #include <drivers/st/stm32mp1_ram.h>

 #include <stm32mp_dt.h>

 static int fdt_checked;

 static void *fdt = (void *)(uintptr_t)STM32MP_DTB_BASE;

 /*******************************************************************************
  * This function checks device tree file with its header.
  * Returns 0 on success and a negative FDT error code on failure.
  ******************************************************************************/
 int dt_open_and_check(void)
 {
 	int ret = fdt_check_header(fdt);

 	if (ret == 0) {
 		fdt_checked = 1;
 	}

 	return ret;
 }

 /*******************************************************************************
  * This function gets the address of the DT.
  * If DT is OK, fdt_addr is filled with DT address.
  * Returns 1 if success, 0 otherwise.
  ******************************************************************************/
 int fdt_get_address(void **fdt_addr)
 {
 	if (fdt_checked == 1) {
 		*fdt_addr = fdt;
 	}

 	return fdt_checked;
 }

 /*******************************************************************************
  * This function check the presence of a node (generic use of fdt library).
  * Returns true if present, else return false.
  ******************************************************************************/
 bool fdt_check_node(int node)
 {
 	int len;
 	const char *cchar;

 	cchar = fdt_get_name(fdt, node, &len);

 	return (cchar != NULL) && (len >= 0);
 }

 /*******************************************************************************
  * This function return global node status (generic use of fdt library).
  ******************************************************************************/
 uint8_t fdt_get_status(int node)
 {
 	uint8_t status = DT_DISABLED;
 	int len;
 	const char *cchar;

 	cchar = fdt_getprop(fdt, node, "status", &len);
 	if ((cchar == NULL) ||
 	    (strncmp(cchar, "okay", (size_t)len) == 0)) {
 		status |= DT_NON_SECURE;
 	}

 	cchar = fdt_getprop(fdt, node, "secure-status", &len);
 	if (cchar == NULL) {
 		if (status == DT_NON_SECURE) {
 			status |= DT_SECURE;
 		}
 	} else if (strncmp(cchar, "okay", (size_t)len) == 0) {
 		status |= DT_SECURE;
 	}

 	return status;
 }

 #if ENABLE_ASSERTIONS
 /*******************************************************************************
  * This function returns the address cells from the node parent.
  * Returns:
  * - #address-cells value if success.
  * - invalid value if error.
  * - a default value if undefined #address-cells property as per libfdt
  *   implementation.
  ******************************************************************************/
 static int fdt_get_node_parent_address_cells(int node)
 {
 	int parent;

 	parent = fdt_parent_offset(fdt, node);
 	if (parent < 0) {
 		return -FDT_ERR_NOTFOUND;
 	}

 	return fdt_address_cells(fdt, parent);
 }

 /*******************************************************************************
  * This function returns the size cells from the node parent.
  * Returns:
  * - #size-cells value if success.
  * - invalid value if error.
  * - a default value if undefined #size-cells property as per libfdt
  *   implementation.
  ******************************************************************************/
 static int fdt_get_node_parent_size_cells(int node)
 {
 	int parent;

 	parent = fdt_parent_offset(fdt, node);
 	if (parent < 0) {
 		return -FDT_ERR_NOTFOUND;
 	}

 	return fdt_size_cells(fdt, parent);
 }
 #endif

 /*******************************************************************************
  * This function gets the stdout pin configuration information from the DT.
  * And then calls the sub-function to treat it and set GPIO registers.
  * Returns 0 on success and a negative FDT error code on failure.
  ******************************************************************************/
 int dt_set_stdout_pinctrl(void)
 {
 	int node;

 	node = fdt_get_stdout_node_offset(fdt);
 	if (node < 0) {
 		return -FDT_ERR_NOTFOUND;
 	}

 	return dt_set_pinctrl_config(node);
 }

 /*******************************************************************************
  * This function fills the generic information from a given node.
  ******************************************************************************/
 void dt_fill_device_info(struct dt_node_info *info, int node)
 {
 	const fdt32_t *cuint;

 	assert(fdt_get_node_parent_address_cells(node) == 1);

 	cuint = fdt_getprop(fdt, node, "reg", NULL);
 	if (cuint != NULL) {
 		info->base = fdt32_to_cpu(*cuint);
 	} else {
 		info->base = 0;
 	}

 	cuint = fdt_getprop(fdt, node, "clocks", NULL);
 	if (cuint != NULL) {
 		cuint++;
 		info->clock = (int)fdt32_to_cpu(*cuint);
 	} else {
 		info->clock = -1;
 	}

 	cuint = fdt_getprop(fdt, node, "resets", NULL);
 	if (cuint != NULL) {
 		cuint++;
 		info->reset = (int)fdt32_to_cpu(*cuint);
 	} else {
 		info->reset = -1;
 	}

 	info->status = fdt_get_status(node);
 }

 /*******************************************************************************
  * This function retrieve the generic information from DT.
  * Returns node on success and a negative FDT error code on failure.
  ******************************************************************************/
 int dt_get_node(struct dt_node_info *info, int offset, const char *compat)
 {
 	int node;

 	node = fdt_node_offset_by_compatible(fdt, offset, compat);
 	if (node < 0) {
 		return -FDT_ERR_NOTFOUND;
 	}

 	dt_fill_device_info(info, node);

 	return node;
 }

 /*******************************************************************************
  * This function gets the UART instance info of stdout from the DT.
  * Returns node on success and a negative FDT error code on failure.
  ******************************************************************************/
 int dt_get_stdout_uart_info(struct dt_node_info *info)
 {
 	int node;

 	node = fdt_get_stdout_node_offset(fdt);
 	if (node < 0) {
 		return -FDT_ERR_NOTFOUND;
 	}

 	dt_fill_device_info(info, node);

 	return node;
 }

 /*******************************************************************************
  * This function gets DDR size information from the DT.
  * Returns value in bytes on success, and 0 on failure.
  ******************************************************************************/
 uint32_t dt_get_ddr_size(void)
 {
 	int node;

 	node = fdt_node_offset_by_compatible(fdt, -1, DT_DDR_COMPAT);
 	if (node < 0) {
 		INFO("%s: Cannot read DDR node in DT\n", __func__);
 		return 0;
 	}

 	return fdt_read_uint32_default(fdt, node, "st,mem-size", 0);
 }

 /*******************************************************************************
  * This function gets DDRCTRL base address information from the DT.
  * Returns value on success, and 0 on failure.
  ******************************************************************************/
 uintptr_t dt_get_ddrctrl_base(void)
 {
 	int node;
 	uint32_t array[4];

 	node = fdt_node_offset_by_compatible(fdt, -1, DT_DDR_COMPAT);
 	if (node < 0) {
 		INFO("%s: Cannot read DDR node in DT\n", __func__);
 		return 0;
 	}

 	assert((fdt_get_node_parent_address_cells(node) == 1) &&
 	       (fdt_get_node_parent_size_cells(node) == 1));

 	if (fdt_read_uint32_array(fdt, node, "reg", 4, array) < 0) {
 		return 0;
 	}

 	return array[0];
 }

 /*******************************************************************************
  * This function gets DDRPHYC base address information from the DT.
  * Returns value on success, and 0 on failure.
  ******************************************************************************/
 uintptr_t dt_get_ddrphyc_base(void)
 {
 	int node;
 	uint32_t array[4];

 	node = fdt_node_offset_by_compatible(fdt, -1, DT_DDR_COMPAT);
 	if (node < 0) {
 		INFO("%s: Cannot read DDR node in DT\n", __func__);
 		return 0;
 	}

 	assert((fdt_get_node_parent_address_cells(node) == 1) &&
 	       (fdt_get_node_parent_size_cells(node) == 1));

 	if (fdt_read_uint32_array(fdt, node, "reg", 4, array) < 0) {
 		return 0;
 	}

 	return array[2];
 }

 /*******************************************************************************
  * This function gets PWR base address information from the DT.
  * Returns value on success, and 0 on failure.
  ******************************************************************************/
 uintptr_t dt_get_pwr_base(void)
 {
 	int node;
 	const fdt32_t *cuint;

 	node = fdt_node_offset_by_compatible(fdt, -1, DT_PWR_COMPAT);
 	if (node < 0) {
 		INFO("%s: Cannot read PWR node in DT\n", __func__);
 		return 0;
 	}

 	assert(fdt_get_node_parent_address_cells(node) == 1);

 	cuint = fdt_getprop(fdt, node, "reg", NULL);
 	if (cuint == NULL) {
 		return 0;
 	}

 	return fdt32_to_cpu(*cuint);
 }

 /*******************************************************************************
  * This function gets PWR VDD regulator voltage information from the DT.
  * Returns value in microvolts on success, and 0 on failure.
  ******************************************************************************/
 uint32_t dt_get_pwr_vdd_voltage(void)
 {
 	int node, pwr_regulators_node;
 	const fdt32_t *cuint;

 	node = fdt_node_offset_by_compatible(fdt, -1, DT_PWR_COMPAT);
 	if (node < 0) {
 		INFO("%s: Cannot read PWR node in DT\n", __func__);
 		return 0;
 	}

 	pwr_regulators_node = fdt_subnode_offset(fdt, node, "pwr-regulators");
 	if (pwr_regulators_node < 0) {
 		INFO("%s: Cannot read pwr-regulators node in DT\n", __func__);
 		return 0;
 	}

 	cuint = fdt_getprop(fdt, pwr_regulators_node, "vdd-supply", NULL);
 	if (cuint == NULL) {
 		return 0;
 	}

 	node = fdt_node_offset_by_phandle(fdt, fdt32_to_cpu(*cuint));
 	if (node < 0) {
 		return 0;
 	}

 	cuint = fdt_getprop(fdt, node, "regulator-min-microvolt", NULL);
 	if (cuint == NULL) {
 		return 0;
 	}

 	return fdt32_to_cpu(*cuint);
 }

 /*******************************************************************************
  * This function gets SYSCFG base address information from the DT.
  * Returns value on success, and 0 on failure.
  ******************************************************************************/
 uintptr_t dt_get_syscfg_base(void)
 {
 	int node;
 	const fdt32_t *cuint;

 	node = fdt_node_offset_by_compatible(fdt, -1, DT_SYSCFG_COMPAT);
 	if (node < 0) {
 		INFO("%s: Cannot read SYSCFG node in DT\n", __func__);
 		return 0;
 	}

 	assert(fdt_get_node_parent_address_cells(node) == 1);

 	cuint = fdt_getprop(fdt, node, "reg", NULL);
 	if (cuint == NULL) {
 		return 0;
 	}

 	return fdt32_to_cpu(*cuint);
 }

 /*******************************************************************************
  * This function retrieves board model from DT
  * Returns string taken from model node, NULL otherwise
  ******************************************************************************/
 const char *dt_get_board_model(void)
 {
 	int node = fdt_path_offset(fdt, "/");

 	if (node < 0) {
 		return NULL;
 	}

 	return (const char *)fdt_getprop(fdt, node, "model", NULL);
 }

 /*******************************************************************************
  * This function gets the pin count for a GPIO bank based from the FDT.
  * It also checks node consistency.
  ******************************************************************************/
 int fdt_get_gpio_bank_pin_count(unsigned int bank)
 {
 	int pinctrl_node;
 	int node;
 	uint32_t bank_offset;

 	pinctrl_node = stm32_get_gpio_bank_pinctrl_node(fdt, bank);
 	if (pinctrl_node < 0) {
 		return -FDT_ERR_NOTFOUND;
 	}

 	bank_offset = stm32_get_gpio_bank_offset(bank);

 	fdt_for_each_subnode(node, fdt, pinctrl_node) {
 		const fdt32_t *cuint;

 		if (fdt_getprop(fdt, node, "gpio-controller", NULL) == NULL) {
 			continue;
 		}

 		cuint = fdt_getprop(fdt, node, "reg", NULL);
 		if (cuint == NULL) {
 			continue;
 		}

 		if (fdt32_to_cpu(*cuint) != bank_offset) {
 			continue;
 		}

 		if (fdt_get_status(node) == DT_DISABLED) {
 			return 0;
 		}

 		cuint = fdt_getprop(fdt, node, "ngpios", NULL);
 		if (cuint == NULL) {
 			return -FDT_ERR_NOTFOUND;
 		}

 		return (int)fdt32_to_cpu(*cuint);
 	}

 	return 0;
 }
	/*
	* Copyright (c) 2017-2020, ARM Limited and Contributors. All rights reserved.
	*
	* SPDX-License-Identifier: BSD-3-Clause
	*/

	#include <assert.h>
	#include <errno.h>

	#include <libfdt.h>

	#include <platform_def.h>

	#include <common/debug.h>
	#include <common/fdt_wrappers.h>
	#include <drivers/st/stm32_gpio.h>
	#include <drivers/st/stm32mp1_ddr.h>
	#include <drivers/st/stm32mp1_ram.h>

	#include <stm32mp_dt.h>

	static int fdt_checked;

	static void fdt = (void )(uintptr_t)STM32MP_DTB_BASE;

	/*******************************************************************************
	* This function checks device tree file with its header.
	* Returns 0 on success and a negative FDT error code on failure.
	******************************************************************************/
	int dt_open_and_check(void)
	{
	int ret = fdt_check_header(fdt);

	if (ret == 0) {
	fdt_checked = 1;
	}

	return ret;
	}

	/*******************************************************************************
	* This function gets the address of the DT.
	* If DT is OK, fdt_addr is filled with DT address.
	* Returns 1 if success, 0 otherwise.
	******************************************************************************/
	int fdt_get_address(void **fdt_addr)
	{
	if (fdt_checked == 1) {
	*fdt_addr = fdt;
	}

	return fdt_checked;
	}

	/*******************************************************************************
	* This function check the presence of a node (generic use of fdt library).
	* Returns true if present, else return false.
	******************************************************************************/
	bool fdt_check_node(int node)
	{
	int len;
	const char *cchar;

	cchar = fdt_get_name(fdt, node, &len);

	return (cchar != NULL) && (len >= 0);
	}

	/*******************************************************************************
	* This function return global node status (generic use of fdt library).
	******************************************************************************/
	uint8_t fdt_get_status(int node)
	{
	uint8_t status = DT_DISABLED;
	int len;
	const char *cchar;

	cchar = fdt_getprop(fdt, node, "status", &len);
	if ((cchar == NULL) \|\|
	(strncmp(cchar, "okay", (size_t)len) == 0)) {
	status \|= DT_NON_SECURE;
	}

	cchar = fdt_getprop(fdt, node, "secure-status", &len);
	if (cchar == NULL) {
	if (status == DT_NON_SECURE) {
	status \|= DT_SECURE;
	}
	} else if (strncmp(cchar, "okay", (size_t)len) == 0) {
	status \|= DT_SECURE;
	}

	return status;
	}

	#if ENABLE_ASSERTIONS
	/*******************************************************************************
	* This function returns the address cells from the node parent.
	* Returns:
	* - #address-cells value if success.
	* - invalid value if error.
	* - a default value if undefined #address-cells property as per libfdt
	* implementation.
	******************************************************************************/
	static int fdt_get_node_parent_address_cells(int node)
	{
	int parent;

	parent = fdt_parent_offset(fdt, node);
	if (parent < 0) {
	return -FDT_ERR_NOTFOUND;
	}

	return fdt_address_cells(fdt, parent);
	}

	/*******************************************************************************
	* This function returns the size cells from the node parent.
	* Returns:
	* - #size-cells value if success.
	* - invalid value if error.
	* - a default value if undefined #size-cells property as per libfdt
	* implementation.
	******************************************************************************/
	static int fdt_get_node_parent_size_cells(int node)
	{
	int parent;

	parent = fdt_parent_offset(fdt, node);
	if (parent < 0) {
	return -FDT_ERR_NOTFOUND;
	}

	return fdt_size_cells(fdt, parent);
	}
	#endif

	/*******************************************************************************
	* This function gets the stdout pin configuration information from the DT.
	* And then calls the sub-function to treat it and set GPIO registers.
	* Returns 0 on success and a negative FDT error code on failure.
	******************************************************************************/
	int dt_set_stdout_pinctrl(void)
	{
	int node;

	node = fdt_get_stdout_node_offset(fdt);
	if (node < 0) {
	return -FDT_ERR_NOTFOUND;
	}

	return dt_set_pinctrl_config(node);
	}

	/*******************************************************************************
	* This function fills the generic information from a given node.
	******************************************************************************/
	void dt_fill_device_info(struct dt_node_info *info, int node)
	{
	const fdt32_t *cuint;

	assert(fdt_get_node_parent_address_cells(node) == 1);

	cuint = fdt_getprop(fdt, node, "reg", NULL);
	if (cuint != NULL) {
	info->base = fdt32_to_cpu(*cuint);
	} else {
	info->base = 0;
	}

	cuint = fdt_getprop(fdt, node, "clocks", NULL);
	if (cuint != NULL) {
	cuint++;
	info->clock = (int)fdt32_to_cpu(*cuint);
	} else {
	info->clock = -1;
	}

	cuint = fdt_getprop(fdt, node, "resets", NULL);
	if (cuint != NULL) {
	cuint++;
	info->reset = (int)fdt32_to_cpu(*cuint);
	} else {
	info->reset = -1;
	}

	info->status = fdt_get_status(node);
	}

	/*******************************************************************************
	* This function retrieve the generic information from DT.
	* Returns node on success and a negative FDT error code on failure.
	******************************************************************************/
	int dt_get_node(struct dt_node_info info, int offset, const char compat)
	{
	int node;

	node = fdt_node_offset_by_compatible(fdt, offset, compat);
	if (node < 0) {
	return -FDT_ERR_NOTFOUND;
	}

	dt_fill_device_info(info, node);

	return node;
	}

	/*******************************************************************************
	* This function gets the UART instance info of stdout from the DT.
	* Returns node on success and a negative FDT error code on failure.
	******************************************************************************/
	int dt_get_stdout_uart_info(struct dt_node_info *info)
	{
	int node;

	node = fdt_get_stdout_node_offset(fdt);
	if (node < 0) {
	return -FDT_ERR_NOTFOUND;
	}

	dt_fill_device_info(info, node);

	return node;
	}

	/*******************************************************************************
	* This function gets DDR size information from the DT.
	* Returns value in bytes on success, and 0 on failure.
	******************************************************************************/
	uint32_t dt_get_ddr_size(void)
	{
	int node;

	node = fdt_node_offset_by_compatible(fdt, -1, DT_DDR_COMPAT);
	if (node < 0) {
	INFO("%s: Cannot read DDR node in DT\n", __func__);
	return 0;
	}

	return fdt_read_uint32_default(fdt, node, "st,mem-size", 0);
	}

	/*******************************************************************************
	* This function gets DDRCTRL base address information from the DT.
	* Returns value on success, and 0 on failure.
	******************************************************************************/
	uintptr_t dt_get_ddrctrl_base(void)
	{
	int node;
	uint32_t array[4];

	node = fdt_node_offset_by_compatible(fdt, -1, DT_DDR_COMPAT);
	if (node < 0) {
	INFO("%s: Cannot read DDR node in DT\n", __func__);
	return 0;
	}

	assert((fdt_get_node_parent_address_cells(node) == 1) &&
	(fdt_get_node_parent_size_cells(node) == 1));

	if (fdt_read_uint32_array(fdt, node, "reg", 4, array) < 0) {
	return 0;
	}

	return array[0];
	}

	/*******************************************************************************
	* This function gets DDRPHYC base address information from the DT.
	* Returns value on success, and 0 on failure.
	******************************************************************************/
	uintptr_t dt_get_ddrphyc_base(void)
	{
	int node;
	uint32_t array[4];

	node = fdt_node_offset_by_compatible(fdt, -1, DT_DDR_COMPAT);
	if (node < 0) {
	INFO("%s: Cannot read DDR node in DT\n", __func__);
	return 0;
	}

	assert((fdt_get_node_parent_address_cells(node) == 1) &&
	(fdt_get_node_parent_size_cells(node) == 1));

	if (fdt_read_uint32_array(fdt, node, "reg", 4, array) < 0) {
	return 0;
	}

	return array[2];
	}

	/*******************************************************************************
	* This function gets PWR base address information from the DT.
	* Returns value on success, and 0 on failure.
	******************************************************************************/
	uintptr_t dt_get_pwr_base(void)
	{
	int node;
	const fdt32_t *cuint;

	node = fdt_node_offset_by_compatible(fdt, -1, DT_PWR_COMPAT);
	if (node < 0) {
	INFO("%s: Cannot read PWR node in DT\n", __func__);
	return 0;
	}

	assert(fdt_get_node_parent_address_cells(node) == 1);

	cuint = fdt_getprop(fdt, node, "reg", NULL);
	if (cuint == NULL) {
	return 0;
	}

	return fdt32_to_cpu(*cuint);
	}

	/*******************************************************************************
	* This function gets PWR VDD regulator voltage information from the DT.
	* Returns value in microvolts on success, and 0 on failure.
	******************************************************************************/
	uint32_t dt_get_pwr_vdd_voltage(void)
	{
	int node, pwr_regulators_node;
	const fdt32_t *cuint;

	node = fdt_node_offset_by_compatible(fdt, -1, DT_PWR_COMPAT);
	if (node < 0) {
	INFO("%s: Cannot read PWR node in DT\n", __func__);
	return 0;
	}

	pwr_regulators_node = fdt_subnode_offset(fdt, node, "pwr-regulators");
	if (pwr_regulators_node < 0) {
	INFO("%s: Cannot read pwr-regulators node in DT\n", __func__);
	return 0;
	}

	cuint = fdt_getprop(fdt, pwr_regulators_node, "vdd-supply", NULL);
	if (cuint == NULL) {
	return 0;
	}

	node = fdt_node_offset_by_phandle(fdt, fdt32_to_cpu(*cuint));
	if (node < 0) {
	return 0;
	}

	cuint = fdt_getprop(fdt, node, "regulator-min-microvolt", NULL);
	if (cuint == NULL) {
	return 0;
	}

	return fdt32_to_cpu(*cuint);
	}

	/*******************************************************************************
	* This function gets SYSCFG base address information from the DT.
	* Returns value on success, and 0 on failure.
	******************************************************************************/
	uintptr_t dt_get_syscfg_base(void)
	{
	int node;
	const fdt32_t *cuint;

	node = fdt_node_offset_by_compatible(fdt, -1, DT_SYSCFG_COMPAT);
	if (node < 0) {
	INFO("%s: Cannot read SYSCFG node in DT\n", __func__);
	return 0;
	}

	assert(fdt_get_node_parent_address_cells(node) == 1);

	cuint = fdt_getprop(fdt, node, "reg", NULL);
	if (cuint == NULL) {
	return 0;
	}

	return fdt32_to_cpu(*cuint);
	}

	/*******************************************************************************
	* This function retrieves board model from DT
	* Returns string taken from model node, NULL otherwise
	******************************************************************************/
	const char *dt_get_board_model(void)
	{
	int node = fdt_path_offset(fdt, "/");

	if (node < 0) {
	return NULL;
	}

	return (const char *)fdt_getprop(fdt, node, "model", NULL);
	}

	/*******************************************************************************
	* This function gets the pin count for a GPIO bank based from the FDT.
	* It also checks node consistency.
	******************************************************************************/
	int fdt_get_gpio_bank_pin_count(unsigned int bank)
	{
	int pinctrl_node;
	int node;
	uint32_t bank_offset;

	pinctrl_node = stm32_get_gpio_bank_pinctrl_node(fdt, bank);
	if (pinctrl_node < 0) {
	return -FDT_ERR_NOTFOUND;
	}

	bank_offset = stm32_get_gpio_bank_offset(bank);

	fdt_for_each_subnode(node, fdt, pinctrl_node) {
	const fdt32_t *cuint;

	if (fdt_getprop(fdt, node, "gpio-controller", NULL) == NULL) {
	continue;
	}

	cuint = fdt_getprop(fdt, node, "reg", NULL);
	if (cuint == NULL) {
	continue;
	}

	if (fdt32_to_cpu(*cuint) != bank_offset) {
	continue;
	}

	if (fdt_get_status(node) == DT_DISABLED) {
	return 0;
	}

	cuint = fdt_getprop(fdt, node, "ngpios", NULL);
	if (cuint == NULL) {
	return -FDT_ERR_NOTFOUND;
	}

	return (int)fdt32_to_cpu(*cuint);
	}

	return 0;
	}