/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2020-2021, The Linux Foundation. All rights reserved.
 * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
 */

#ifndef _QCOM_DT_PARSER_H
#define _QCOM_DT_PARSER_H

#include <linux/device.h>
#include <linux/platform_device.h>

/**
 * struct platform_heap - defines a heap in the given platform
 * @type:	type of the heap
 * @name:	used for debug purposes
 * @base:	base address of heap in physical memory if applicable
 * @size:	size of the heap in bytes if applicable
 * @dev:	the device associated with the heap's DT node
 * @is_dynamic:	indicates if memory can be added or removed from carveout heaps
 * is_nomap:	indicates if this heap is assosicated with a memory region which is
 *		which has no-map property.
 * is_uncached:	indicates if this heap provides uncached memory or not
 * @token:	the end points to which memory for secure carveout memory is
 *		assigned to
 * @max_align:  page order of the maximum alignment. Used by cma heap.
 *
 * Provided by the board file.
 */
struct platform_heap {
	u32 type;
	const char *name;
	phys_addr_t base;
	size_t size;
	struct device *dev;
	bool is_uncached;
	bool is_nomap;
	u32 token;
	u32 max_align;
};

/**
 * struct platform_data - array of platform heaps passed from board file
 * @nr:    number of structures in the array
 * @heaps: array of platform_heap structions
 *
 * Provided by the board file in the form of platform data to a platform device.
 */
struct platform_data {
	int nr;
	struct platform_heap *heaps;
};

struct platform_data *parse_heap_dt(struct platform_device *pdev);
void free_pdata(const struct platform_data *pdata);

#endif /* _QCOM_DT_PARSER_H */