text: /* SPDX-License-Identifier: GPL-2.0 */
  /*
   * Copyright (c) 2016 MediaTek Inc.
   * Author: PC Chen <pc.chen@mediatek.com>
   */
  
  #ifndef _VDEC_VPU_IF_H_
  #define _VDEC_VPU_IF_H_
  
  #include "mtk_vpu.h"
  
  /**
   * struct vdec_vpu_inst - VPU instance for video codec
   * @ipi_id      : ipi id for each decoder
   * @vsi         : driver structure allocated by VPU side and shared to AP side
   *                for control and info share
   * @failure     : VPU execution result status, 0: success, others: fail
   * @inst_addr	: VPU decoder instance address
   * @signaled    : 1 - Host has received ack message from VPU, 0 - not received
   * @ctx         : context for v4l2 layer integration
   * @dev		: platform device of VPU
   * @wq          : wait queue to wait VPU message ack
   * @handler     : ipi handler for each decoder
   */
  struct vdec_vpu_inst {
  	enum ipi_id id;
  	void *vsi;
  	int32_t failure;
  	uint32_t inst_addr;
  	unsigned int signaled;
  	struct mtk_vcodec_ctx *ctx;
  	struct platform_device *dev;
  	wait_queue_head_t wq;
  	ipi_handler_t handler;
  };
  
  /**
   * vpu_dec_init - init decoder instance and allocate required resource in VPU.
   *
   * @vpu: instance for vdec_vpu_inst
   */
  int vpu_dec_init(struct vdec_vpu_inst *vpu);
  
  /**
   * vpu_dec_start - start decoding, basically the function will be invoked once
   *                 every frame.
   *
   * @vpu : instance for vdec_vpu_inst
   * @data: meta data to pass bitstream info to VPU decoder
   * @len : meta data length
   */
  int vpu_dec_start(struct vdec_vpu_inst *vpu, uint32_t *data, unsigned int len);
  
  /**
   * vpu_dec_end - end decoding, basically the function will be invoked once
   *               when HW decoding done interrupt received successfully. The
   *               decoder in VPU will continue to do reference frame management
   *               and check if there is a new decoded frame available to display.
   *
   * @vpu : instance for vdec_vpu_inst
   */
  int vpu_dec_end(struct vdec_vpu_inst *vpu);
  
  /**
   * vpu_dec_deinit - deinit decoder instance and resource freed in VPU.
   *
   * @vpu: instance for vdec_vpu_inst
   */
  int vpu_dec_deinit(struct vdec_vpu_inst *vpu);
  
  /**
   * vpu_dec_reset - reset decoder, use for flush decoder when end of stream or
   *                 seek. Remainig non displayed frame will be pushed to display.
   *
   * @vpu: instance for vdec_vpu_inst
   */
  int vpu_dec_reset(struct vdec_vpu_inst *vpu);
  
  /**
   * vpu_dec_ipi_handler - Handler for VPU ipi message.
   *
   * @data: ipi message
   * @len : length of ipi message
   * @priv: callback private data which is passed by decoder when register.
   */
  void vpu_dec_ipi_handler(void *data, unsigned int len, void *priv);
  
  #endif
  