include/linux/firmware/qcom/qcom_tzmem.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2023-2024 Linaro Ltd.
 */

#ifndef __QCOM_TZMEM_H
#define __QCOM_TZMEM_H

#include <linux/cleanup.h>
#include <linux/gfp.h>
#include <linux/types.h>

struct device;
struct qcom_tzmem_pool;

/**
 * enum qcom_tzmem_policy - Policy for pool growth.
 */
enum qcom_tzmem_policy {
	/**
	 * @QCOM_TZMEM_POLICY_STATIC: Static pool,
	 * never grow above initial size.
	 */
	QCOM_TZMEM_POLICY_STATIC = 1,
	/**
	 * @QCOM_TZMEM_POLICY_MULTIPLIER: When out of memory,
	 * add increment * current size of memory.
	 */
	QCOM_TZMEM_POLICY_MULTIPLIER,
	/**
	 * @QCOM_TZMEM_POLICY_ON_DEMAND: When out of memory
	 * add as much as is needed until max_size.
	 */
	QCOM_TZMEM_POLICY_ON_DEMAND,
};

/**
 * struct qcom_tzmem_pool_config - TZ memory pool configuration.
 * @initial_size: Number of bytes to allocate for the pool during its creation.
 * @policy: Pool size growth policy.
 * @increment: Used with policies that allow pool growth.
 * @max_size: Size above which the pool will never grow.
 */
struct qcom_tzmem_pool_config {
	size_t initial_size;
	enum qcom_tzmem_policy policy;
	size_t increment;
	size_t max_size;
};

struct qcom_tzmem_pool *
qcom_tzmem_pool_new(const struct qcom_tzmem_pool_config *config);
void qcom_tzmem_pool_free(struct qcom_tzmem_pool *pool);
struct qcom_tzmem_pool *
devm_qcom_tzmem_pool_new(struct device *dev,
			 const struct qcom_tzmem_pool_config *config);

void *qcom_tzmem_alloc(struct qcom_tzmem_pool *pool, size_t size, gfp_t gfp);
void qcom_tzmem_free(void *ptr);

DEFINE_FREE(qcom_tzmem, void *, if (_T) qcom_tzmem_free(_T))

phys_addr_t qcom_tzmem_to_phys(void *ptr);

#if IS_ENABLED(CONFIG_QCOM_TZMEM_MODE_SHMBRIDGE)
int qcom_tzmem_shm_bridge_create(phys_addr_t paddr, size_t size, u64 *handle);
void qcom_tzmem_shm_bridge_delete(u64 handle);
#else
static inline int qcom_tzmem_shm_bridge_create(phys_addr_t paddr,
					       size_t size, u64 *handle)
{
	return 0;
}

static inline void qcom_tzmem_shm_bridge_delete(u64 handle)
{
}
#endif

#endif /* __QCOM_TZMEM */