/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2017-2022 NVIDIA Corporation.  All rights reserved.
 */

/**
 * @file include/media/fusa-capture/capture-isp-channel.h
 *
 * @brief ISP channel character device driver header for the T186/T194 Camera
 * RTCPU platform.
 */

#ifndef __FUSA_CAPTURE_ISP_CHANNEL_H__
#define __FUSA_CAPTURE_ISP_CHANNEL_H__

#include <linux/of_platform.h>

struct isp_channel_drv;

/**
 * @brief ISP fops for Host1x syncpt/gos allocations
 *
 * This fops is a HAL for chip/IP generations, see the respective VI platform
 * drivers for the implementations.
 */
struct isp_channel_drv_ops {
	/**
	 * @brief Request a syncpt allocation from Host1x.
	 *
	 * @param[in]	pdev		ISP platform_device
	 * @param[in]	name		syncpt name
	 * @param[out]	syncpt_id	assigned syncpt id
	 *
	 * @returns	0 (success), neg. errno (failure)
	 */
	int (*alloc_syncpt)(
		struct platform_device *pdev,
		const char *name,
		uint32_t *syncpt_id);

	/**
	 * @brief Release a syncpt to Host1x.
	 *
	 * @param[in]	pdev	ISP platform_device
	 * @param[in]	id	syncpt id to free
	 */
	void (*release_syncpt)(
		struct platform_device *pdev,
		uint32_t id);

	/**
	 * @brief Retrieve the GoS table allocated in the ISP-THI carveout.
	 *
	 * @param[in]	pdev	ISP platform_device
	 * @param[out]	table	GoS table pointer
	 */
	uint32_t (*get_gos_table)(
		struct platform_device *pdev,
		const dma_addr_t **table);

	/**
	 * @brief Get a syncpt's GoS backing in the ISP-THI carveout.
	 *
	 * @param[in]	pdev		ISP platform_device
	 * @param[in]	id		syncpt id
	 * @param[out]	gos_index	GoS id
	 * @param[out]	gos_offset	Offset of syncpt within GoS [dword]
	 *
	 * @returns	0 (success), neg. errno (failure)
	 */
	int (*get_syncpt_gos_backing)(
		struct platform_device *pdev,
		uint32_t id,
		dma_addr_t *syncpt_addr,
		uint32_t *gos_index,
		uint32_t *gos_offset);
};

/**
 * @brief ISP channel context (character device).
 */
struct tegra_isp_channel {
	struct device *isp_dev; /**< ISP device */
	struct platform_device *ndev; /**< ISP platform_device */
	struct isp_channel_drv *drv; /**< ISP channel driver context */
	void *priv; /**< ISP channel private context */
	struct isp_capture *capture_data; /**< ISP channel capture context */
	const struct isp_channel_drv_ops *ops; /**< ISP syncpt/gos fops */
};

/**
 * @brief Create the ISP channels driver contexts, and instantiate
 * MAX_ISP_CHANNELS many channel character device nodes.
 *
 * ISP channel nodes appear in the filesystem as:
 * /dev/capture-isp-channel{0..MAX_ISP_CHANNELS-1}
 *
 * @param[in]	ndev	ISP platform_device context
 * @param[in]	ops	isp_channel_drv_ops fops
 *
 * @returns	0 (success), neg. errno (failure)
 */
int isp_channel_drv_register(
	struct platform_device *pdev,
	const struct isp_channel_drv_ops *ops);

/**
 * @brief Destroy the ISP channels driver and all character device nodes.
 *
 * The ISP channels driver and associated channel contexts in memory are freed,
 * rendering the ISP platform driver unusable until re-initialized.
 *
 * @param[in]	dev	ISP device context
 */
void isp_channel_drv_unregister(
	struct device *dev);

int isp_channel_drv_init(void);
void isp_channel_drv_exit(void);
#endif /* __FUSA_CAPTURE_ISP_CHANNEL_H__ */