[deliverable/linux.git] / drivers / media / platform / mtk-vpu / mtk_vpu.h

/*
* Copyright (c) 2016 MediaTek Inc.
* Author: Andrew-CT Chen <andrew-ct.chen@mediatek.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*/

#ifndef _MTK_VPU_H
#define _MTK_VPU_H

#include <linux/platform_device.h>

/**
 * VPU (video processor unit) is a tiny processor controlling video hardware
 * related to video codec, scaling and color format converting.
 * VPU interfaces with other blocks by share memory and interrupt.
 **/

typedef void (*ipi_handler_t) (void *data,
			       unsigned int len,
			       void *priv);

/**
 * enum ipi_id - the id of inter-processor interrupt
 *
 * @IPI_VPU_INIT:	 The interrupt from vpu is to notfiy kernel
			 VPU initialization completed.
			 IPI_VPU_INIT is sent from VPU when firmware is
			 loaded. AP doesn't need to send IPI_VPU_INIT
			 command to VPU.
			 For other IPI below, AP should send the request
			 to VPU to trigger the interrupt.
 * @IPI_VENC_H264:	 The interrupt from vpu is to notify kernel to
			 handle H264 video encoder job, and vice versa.
 * @IPI_VENC_VP8:	 The interrupt fro vpu is to notify kernel to
			 handle VP8 video encoder job,, and vice versa.
 * @IPI_MAX:		 The maximum IPI number
 */

enum ipi_id {
	IPI_VPU_INIT = 0,
	IPI_VENC_H264,
	IPI_VENC_VP8,
	IPI_MAX,
};

/**
 * enum rst_id - reset id to register reset function for VPU watchdog timeout
 *
 * @VPU_RST_ENC: encoder reset id
 * @VPU_RST_MAX: maximum reset id
 */
enum rst_id {
	VPU_RST_ENC,
	VPU_RST_MAX,
};

/**
 * vpu_ipi_register - register an ipi function
 *
 * @pdev:	VPU platform device
 * @id:		IPI ID
 * @handler:	IPI handler
 * @name:	IPI name
 * @priv:	private data for IPI handler
 *
 * Register an ipi function to receive ipi interrupt from VPU.
 *
 * Return: Return 0 if ipi registers successfully, otherwise it is failed.
 */
int vpu_ipi_register(struct platform_device *pdev, enum ipi_id id,
		     ipi_handler_t handler, const char *name, void *priv);

/**
 * vpu_ipi_send - send data from AP to vpu.
 *
 * @pdev:	VPU platform device
 * @id:		IPI ID
 * @buf:	the data buffer
 * @len:	the data buffer length
 *
 * This function is thread-safe. When this function returns,
 * VPU has received the data and starts the processing.
 * When the processing completes, IPI handler registered
 * by vpu_ipi_register will be called in interrupt context.
 *
 * Return: Return 0 if sending data successfully, otherwise it is failed.
 **/
int vpu_ipi_send(struct platform_device *pdev,
		 enum ipi_id id, void *buf,
		 unsigned int len);

/**
 * vpu_get_plat_device - get VPU's platform device
 *
 * @pdev:	the platform device of the module requesting VPU platform
 *		device for using VPU API.
 *
 * Return: Return NULL if it is failed.
 * otherwise it is VPU's platform device
 **/
struct platform_device *vpu_get_plat_device(struct platform_device *pdev);

/**
 * vpu_wdt_reg_handler - register a VPU watchdog handler
 *
 * @pdev:               VPU platform device
 * @vpu_wdt_reset_func:	the callback reset function
 * @private_data:       the private data for reset function
 * @rst_id:		reset id
 *
 * Register a handler performing own tasks when vpu reset by watchdog
 *
 * Return: Return 0 if the handler is added successfully,
 * otherwise it is failed.
 *
 **/
int vpu_wdt_reg_handler(struct platform_device *pdev,
			void vpu_wdt_reset_func(void *),
			void *priv, enum rst_id id);
/**
 * vpu_get_venc_hw_capa - get video encoder hardware capability
 *
 * @pdev:	VPU platform device
 *
 * Return: video encoder hardware capability
 **/
unsigned int vpu_get_venc_hw_capa(struct platform_device *pdev);

/**
 * vpu_load_firmware - download VPU firmware and boot it
 *
 * @pdev:	VPU platform device
 *
 * Return: Return 0 if downloading firmware successfully,
 * otherwise it is failed
 **/
int vpu_load_firmware(struct platform_device *pdev);

/**
 * vpu_mapping_dm_addr - Mapping DTCM/DMEM to kernel virtual address
 *
 * @pdev:	VPU platform device
 * @dmem_addr:	VPU's data memory address
 *
 * Mapping the VPU's DTCM (Data Tightly-Coupled Memory) /
 * DMEM (Data Extended Memory) memory address to
 * kernel virtual address.
 *
 * Return: Return ERR_PTR(-EINVAL) if mapping failed,
 * otherwise the mapped kernel virtual address
 **/
void *vpu_mapping_dm_addr(struct platform_device *pdev,
			  u32 dtcm_dmem_addr);
#endif /* _MTK_VPU_H */
Commit	Line	Data
3003a180 ACC	1	/*
	2	* Copyright (c) 2016 MediaTek Inc.
	3	* Author: Andrew-CT Chen <andrew-ct.chen@mediatek.com>
	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License version 2 as
	7	* published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*/
	14
	15	#ifndef _MTK_VPU_H
	16	#define _MTK_VPU_H
	17
	18	#include <linux/platform_device.h>
	19
	20	/**
	21	* VPU (video processor unit) is a tiny processor controlling video hardware
	22	* related to video codec, scaling and color format converting.
	23	* VPU interfaces with other blocks by share memory and interrupt.
	24	**/
	25
	26	typedef void (ipi_handler_t) (void data,
	27	unsigned int len,
	28	void *priv);
	29
	30	/**
	31	* enum ipi_id - the id of inter-processor interrupt
	32	*
	33	* @IPI_VPU_INIT: The interrupt from vpu is to notfiy kernel
	34	VPU initialization completed.
	35	IPI_VPU_INIT is sent from VPU when firmware is
	36	loaded. AP doesn't need to send IPI_VPU_INIT
	37	command to VPU.
	38	For other IPI below, AP should send the request
	39	to VPU to trigger the interrupt.
	40	* @IPI_VENC_H264: The interrupt from vpu is to notify kernel to
	41	handle H264 video encoder job, and vice versa.
	42	* @IPI_VENC_VP8: The interrupt fro vpu is to notify kernel to
	43	handle VP8 video encoder job,, and vice versa.
	44	* @IPI_MAX: The maximum IPI number
	45	*/
	46
	47	enum ipi_id {
	48	IPI_VPU_INIT = 0,
	49	IPI_VENC_H264,
	50	IPI_VENC_VP8,
	51	IPI_MAX,
	52	};
	53
	54	/**
	55	* enum rst_id - reset id to register reset function for VPU watchdog timeout
	56	*
	57	* @VPU_RST_ENC: encoder reset id
	58	* @VPU_RST_MAX: maximum reset id
	59	*/
	60	enum rst_id {
	61	VPU_RST_ENC,
	62	VPU_RST_MAX,
	63	};
	64
65	/**
66	* vpu_ipi_register - register an ipi function
67	*
68	* @pdev: VPU platform device
69	* @id: IPI ID
70	* @handler: IPI handler
71	* @name: IPI name
72	* @priv: private data for IPI handler
73	*
74	* Register an ipi function to receive ipi interrupt from VPU.
75	*
76	* Return: Return 0 if ipi registers successfully, otherwise it is failed.
77	*/
78	int vpu_ipi_register(struct platform_device *pdev, enum ipi_id id,
79	ipi_handler_t handler, const char name, void priv);
80
81	/**
82	* vpu_ipi_send - send data from AP to vpu.
83	*
84	* @pdev: VPU platform device
85	* @id: IPI ID
86	* @buf: the data buffer
87	* @len: the data buffer length
88	*
89	* This function is thread-safe. When this function returns,
90	* VPU has received the data and starts the processing.
91	* When the processing completes, IPI handler registered
92	* by vpu_ipi_register will be called in interrupt context.
93	*
94	* Return: Return 0 if sending data successfully, otherwise it is failed.
95	**/
96	int vpu_ipi_send(struct platform_device *pdev,
97	enum ipi_id id, void *buf,
98	unsigned int len);
99
100	/**
101	* vpu_get_plat_device - get VPU's platform device
102	*
103	* @pdev: the platform device of the module requesting VPU platform
104	* device for using VPU API.
105	*
106	* Return: Return NULL if it is failed.
107	* otherwise it is VPU's platform device
108	**/
109	struct platform_device vpu_get_plat_device(struct platform_device pdev);
110
111	/**
112	* vpu_wdt_reg_handler - register a VPU watchdog handler
113	*
114	* @pdev: VPU platform device
115	* @vpu_wdt_reset_func: the callback reset function
116	* @private_data: the private data for reset function
117	* @rst_id: reset id
118	*
119	* Register a handler performing own tasks when vpu reset by watchdog
120	*
121	* Return: Return 0 if the handler is added successfully,
122	* otherwise it is failed.
123	*
124	**/
125	int vpu_wdt_reg_handler(struct platform_device *pdev,
126	void vpu_wdt_reset_func(void *),
127	void *priv, enum rst_id id);
128	/**
129	* vpu_get_venc_hw_capa - get video encoder hardware capability
130	*
131	* @pdev: VPU platform device
132	*
133	* Return: video encoder hardware capability
134	**/
135	unsigned int vpu_get_venc_hw_capa(struct platform_device *pdev);
136
137	/**
138	* vpu_load_firmware - download VPU firmware and boot it
139	*
140	* @pdev: VPU platform device
141	*
142	* Return: Return 0 if downloading firmware successfully,
143	* otherwise it is failed
144	**/
145	int vpu_load_firmware(struct platform_device *pdev);
146
147	/**
148	* vpu_mapping_dm_addr - Mapping DTCM/DMEM to kernel virtual address
149	*
150	* @pdev: VPU platform device
151	* @dmem_addr: VPU's data memory address
152	*
153	* Mapping the VPU's DTCM (Data Tightly-Coupled Memory) /
154	* DMEM (Data Extended Memory) memory address to
155	* kernel virtual address.
156	*
157	* Return: Return ERR_PTR(-EINVAL) if mapping failed,
158	* otherwise the mapped kernel virtual address
159	**/
160	void vpu_mapping_dm_addr(struct platform_device pdev,
161	u32 dtcm_dmem_addr);
162	#endif /* _MTK_VPU_H */