Quelle  hantro.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Hantro VPU codec driver
 *
 * Copyright 2018 Google LLC.
 * Tomasz Figa <tfiga@chromium.org>
 *
 * Based on s5p-mfc driver by Samsung Electronics Co., Ltd.
 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
 */

#ifndef HANTRO_H_
#define HANTRO_H_

#include <linux/platform_device.h>
#include <linux/videodev2.h>
#include <linux/wait.h>
#include <linux/clk.h>
#include <linux/reset.h>

#include <media/v4l2-ctrls.h>
#include <media/v4l2-device.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-mem2mem.h>
#include <media/videobuf2-core.h>
#include <media/videobuf2-dma-contig.h>

#include "hantro_hw.h"

struct hantro_ctx;
struct hantro_codec_ops;
struct hantro_postproc_ops;

#define HANTRO_JPEG_ENCODER BIT(0)
#define HANTRO_ENCODERS  0x0000ffff
#define HANTRO_MPEG2_DECODER BIT(16)
#define HANTRO_VP8_DECODER BIT(17)
#define HANTRO_H264_DECODER BIT(18)
#define HANTRO_HEVC_DECODER BIT(19)
#define HANTRO_VP9_DECODER BIT(20)
#define HANTRO_AV1_DECODER BIT(21)
#define HANTRO_DECODERS  0xffff0000

/**
 * struct hantro_irq - irq handler and name
 *
 * @name: irq name for device tree lookup
 * @handler: interrupt handler
 */
struct hantro_irq {
 const char *name;
 irqreturn_t (*handler)(int irq, void *priv);
};

/**
 * struct hantro_variant - information about VPU hardware variant
 *
 * @enc_offset: Offset from VPU base to encoder registers.
 * @dec_offset: Offset from VPU base to decoder registers.
 * @enc_fmts: Encoder formats.
 * @num_enc_fmts: Number of encoder formats.
 * @dec_fmts: Decoder formats.
 * @num_dec_fmts: Number of decoder formats.
 * @postproc_fmts: Post-processor formats.
 * @num_postproc_fmts: Number of post-processor formats.
 * @postproc_ops: Post-processor ops.
 * @codec: Supported codecs
 * @codec_ops: Codec ops.
 * @init: Initialize hardware, optional.
 * @runtime_resume: reenable hardware after power gating, optional.
 * @irqs: array of irq names and interrupt handlers
 * @num_irqs: number of irqs in the array
 * @clk_names: array of clock names
 * @num_clocks: number of clocks in the array
 * @reg_names: array of register range names
 * @num_regs: number of register range names in the array
 * @double_buffer: core needs double buffering
 * @legacy_regs: core uses legacy register set
 * @late_postproc: postproc must be set up at the end of the job
 */
struct hantro_variant {
 unsigned int enc_offset;
 unsigned int dec_offset;
 const struct hantro_fmt *enc_fmts;
 unsigned int num_enc_fmts;
 const struct hantro_fmt *dec_fmts;
 unsigned int num_dec_fmts;
 const struct hantro_fmt *postproc_fmts;
 unsigned int num_postproc_fmts;
 const struct hantro_postproc_ops *postproc_ops;
 unsigned int codec;
 const struct hantro_codec_ops *codec_ops;
 int (*init)(struct hantro_dev *vpu);
 int (*runtime_resume)(struct hantro_dev *vpu);
 const struct hantro_irq *irqs;
 int num_irqs;
 const char * const *clk_names;
 int num_clocks;
 const char * const *reg_names;
 int num_regs;
 unsigned int double_buffer : 1;
 unsigned int legacy_regs : 1;
 unsigned int late_postproc : 1;
};

/**
 * enum hantro_codec_mode - codec operating mode.
 * @HANTRO_MODE_NONE:  No operating mode. Used for RAW video formats.
 * @HANTRO_MODE_JPEG_ENC: JPEG encoder.
 * @HANTRO_MODE_H264_DEC: H264 decoder.
 * @HANTRO_MODE_MPEG2_DEC: MPEG-2 decoder.
 * @HANTRO_MODE_VP8_DEC: VP8 decoder.
 * @HANTRO_MODE_HEVC_DEC: HEVC decoder.
 * @HANTRO_MODE_VP9_DEC: VP9 decoder.
 * @HANTRO_MODE_AV1_DEC: AV1 decoder
 */
enum hantro_codec_mode {
 HANTRO_MODE_NONE = -1,
 HANTRO_MODE_JPEG_ENC,
 HANTRO_MODE_H264_DEC,
 HANTRO_MODE_MPEG2_DEC,
 HANTRO_MODE_VP8_DEC,
 HANTRO_MODE_HEVC_DEC,
 HANTRO_MODE_VP9_DEC,
 HANTRO_MODE_AV1_DEC,
};

/*
 * struct hantro_ctrl - helper type to declare supported controls
 * @codec: codec id this control belong to (HANTRO_JPEG_ENCODER, etc.)
 * @cfg: control configuration
 */
struct hantro_ctrl {
 unsigned int codec;
 struct v4l2_ctrl_config cfg;
};

/*
 * struct hantro_func - Hantro VPU functionality
 *
 * @id: processing functionality ID (can be
 * %MEDIA_ENT_F_PROC_VIDEO_ENCODER or
 * %MEDIA_ENT_F_PROC_VIDEO_DECODER)
 * @vdev: &struct video_device that exposes the encoder or
 * decoder functionality
 * @source_pad: &struct media_pad with the source pad.
 * @sink: &struct media_entity pointer with the sink entity
 * @sink_pad: &struct media_pad with the sink pad.
 * @proc: &struct media_entity pointer with the M2M device itself.
 * @proc_pads: &struct media_pad with the @proc pads.
 * @intf_devnode: &struct media_intf devnode pointer with the interface
 * with controls the M2M device.
 *
 * Contains everything needed to attach the video device to the media device.
 */
struct hantro_func {
 unsigned int id;
 struct video_device vdev;
 struct media_pad source_pad;
 struct media_entity sink;
 struct media_pad sink_pad;
 struct media_entity proc;
 struct media_pad proc_pads[2];
 struct media_intf_devnode *intf_devnode;
};

static inline struct hantro_func *
hantro_vdev_to_func(struct video_device *vdev)
{
 return container_of(vdev, struct hantro_func, vdev);
}

/**
 * struct hantro_dev - driver data
 * @v4l2_dev: V4L2 device to register video devices for.
 * @m2m_dev: mem2mem device associated to this device.
 * @mdev: media device associated to this device.
 * @encoder: encoder functionality.
 * @decoder: decoder functionality.
 * @pdev: Pointer to VPU platform device.
 * @dev: Pointer to device for convenient logging using
 * dev_ macros.
 * @clocks: Array of clock handles.
 * @resets: Array of reset handles.
 * @reg_bases: Mapped addresses of VPU registers.
 * @enc_base: Mapped address of VPU encoder register for convenience.
 * @dec_base: Mapped address of VPU decoder register for convenience.
 * @ctrl_base: Mapped address of VPU control block.
 * @vpu_mutex: Mutex to synchronize V4L2 calls.
 * @irqlock: Spinlock to synchronize access to data structures
 * shared with interrupt handlers.
 * @variant: Hardware variant-specific parameters.
 * @watchdog_work: Delayed work for hardware timeout handling.
 */
struct hantro_dev {
 struct v4l2_device v4l2_dev;
 struct v4l2_m2m_dev *m2m_dev;
 struct media_device mdev;
 struct hantro_func *encoder;
 struct hantro_func *decoder;
 struct platform_device *pdev;
 struct device *dev;
 struct clk_bulk_data *clocks;
 struct reset_control *resets;
 void __iomem **reg_bases;
 void __iomem *enc_base;
 void __iomem *dec_base;
 void __iomem *ctrl_base;

 struct mutex vpu_mutex; /* video_device lock */
 spinlock_t irqlock;
 const struct hantro_variant *variant;
 struct delayed_work watchdog_work;
};

/**
 * struct hantro_ctx - Context (instance) private data.
 *
 * @dev: VPU driver data to which the context belongs.
 * @fh: V4L2 file handler.
 * @is_encoder: Decoder or encoder context?
 *
 * @sequence_cap:       Sequence counter for capture queue
 * @sequence_out:       Sequence counter for output queue
 *
 * @vpu_src_fmt: Descriptor of active source format.
 * @src_fmt: V4L2 pixel format of active source format.
 * @vpu_dst_fmt: Descriptor of active destination format.
 * @dst_fmt: V4L2 pixel format of active destination format.
 * @ref_fmt: V4L2 pixel format of the reference frames format.
 *
 * @ctrl_handler: Control handler used to register controls.
 * @jpeg_quality: User-specified JPEG compression quality.
 * @bit_depth: Bit depth of current frame
 * @need_postproc: Set to true if the bitstream features require to
 * use the post-processor.
 *
 * @codec_ops: Set of operations related to codec mode.
 * @postproc: Post-processing context.
 * @h264_dec: H.264-decoding context.
 * @mpeg2_dec: MPEG-2-decoding context.
 * @vp8_dec: VP8-decoding context.
 * @hevc_dec: HEVC-decoding context.
 * @vp9_dec: VP9-decoding context.
 * @av1_dec: AV1-decoding context.
 */
struct hantro_ctx {
 struct hantro_dev *dev;
 struct v4l2_fh fh;
 bool is_encoder;

 u32 sequence_cap;
 u32 sequence_out;

 const struct hantro_fmt *vpu_src_fmt;
 struct v4l2_pix_format_mplane src_fmt;
 const struct hantro_fmt *vpu_dst_fmt;
 struct v4l2_pix_format_mplane dst_fmt;
 struct v4l2_pix_format_mplane ref_fmt;

 struct v4l2_ctrl_handler ctrl_handler;
 int jpeg_quality;
 int bit_depth;

 const struct hantro_codec_ops *codec_ops;
 struct hantro_postproc_ctx postproc;
 bool need_postproc;

 /* Specific for particular codec modes. */
 union {
  struct hantro_h264_dec_hw_ctx h264_dec;
  struct hantro_mpeg2_dec_hw_ctx mpeg2_dec;
  struct hantro_vp8_dec_hw_ctx vp8_dec;
  struct hantro_hevc_dec_hw_ctx hevc_dec;
  struct hantro_vp9_dec_hw_ctx vp9_dec;
  struct hantro_av1_dec_hw_ctx av1_dec;
 };
};

/**
 * struct hantro_fmt - information about supported video formats.
 * @name: Human readable name of the format.
 * @fourcc: FourCC code of the format. See V4L2_PIX_FMT_*.
 * @codec_mode: Codec mode related to this format. See
 * enum hantro_codec_mode.
 * @header_size: Optional header size. Currently used by JPEG encoder.
 * @max_depth: Maximum depth, for bitstream formats
 * @enc_fmt: Format identifier for encoder registers.
 * @frmsize: Supported range of frame sizes (only for bitstream formats).
 * @postprocessed: Indicates if this format needs the post-processor.
 * @match_depth: Indicates if format bit depth must match video bit depth
 */
struct hantro_fmt {
 char *name;
 u32 fourcc;
 enum hantro_codec_mode codec_mode;
 int header_size;
 int max_depth;
 enum hantro_enc_fmt enc_fmt;
 struct v4l2_frmsize_stepwise frmsize;
 bool postprocessed;
 bool match_depth;
};

struct hantro_reg {
 u32 base;
 u32 shift;
 u32 mask;
};

struct hantro_postproc_regs {
 struct hantro_reg pipeline_en;
 struct hantro_reg max_burst;
 struct hantro_reg clk_gate;
 struct hantro_reg out_swap32;
 struct hantro_reg out_endian;
 struct hantro_reg out_luma_base;
 struct hantro_reg input_width;
 struct hantro_reg input_height;
 struct hantro_reg output_width;
 struct hantro_reg output_height;
 struct hantro_reg input_fmt;
 struct hantro_reg output_fmt;
 struct hantro_reg orig_width;
 struct hantro_reg display_width;
 struct hantro_reg input_width_ext;
 struct hantro_reg input_height_ext;
};

struct hantro_vp9_decoded_buffer_info {
 /* Info needed when the decoded frame serves as a reference frame. */
 unsigned short width;
 unsigned short height;
 size_t chroma_offset;
 size_t mv_offset;
 u32 bit_depth : 4;
};

struct hantro_av1_decoded_buffer_info {
 /* Info needed when the decoded frame serves as a reference frame. */
 size_t chroma_offset;
 size_t mv_offset;
};

struct hantro_decoded_buffer {
 /* Must be the first field in this struct. */
 struct v4l2_m2m_buffer base;

 union {
  struct hantro_vp9_decoded_buffer_info vp9;
  struct hantro_av1_decoded_buffer_info av1;
 };
};

/* Logging helpers */

/**
 * DOC: hantro_debug: Module parameter to control level of debugging messages.
 *
 * Level of debugging messages can be controlled by bits of
 * module parameter called "debug". Meaning of particular
 * bits is as follows:
 *
 * bit 0 - global information: mode, size, init, release
 * bit 1 - each run start/result information
 * bit 2 - contents of small controls from userspace
 * bit 3 - contents of big controls from userspace
 * bit 4 - detail fmt, ctrl, buffer q/dq information
 * bit 5 - detail function enter/leave trace information
 * bit 6 - register write/read information
 */
extern int hantro_debug;

#define vpu_debug(level, fmt, args...)    \
 do {       \
  if (hantro_debug & BIT(level))  \
   pr_info("%s:%d: " fmt,                 \
     __func__, __LINE__, ##args); \
 } while (0)

#define vpu_err(fmt, args...)     \
 pr_err("%s:%d: " fmt, __func__, __LINE__, ##args)

/* Structure access helpers. */
static __always_inline struct hantro_ctx *fh_to_ctx(struct v4l2_fh *fh)
{
 return container_of(fh, struct hantro_ctx, fh);
}

/* Register accessors. */
static __always_inline void vepu_write_relaxed(struct hantro_dev *vpu,
            u32 val, u32 reg)
{
 vpu_debug(6, "0x%04x = 0x%08x\n", reg / 4, val);
 writel_relaxed(val, vpu->enc_base + reg);
}

static __always_inline void vepu_write(struct hantro_dev *vpu, u32 val, u32 reg)
{
 vpu_debug(6, "0x%04x = 0x%08x\n", reg / 4, val);
 writel(val, vpu->enc_base + reg);
}

static __always_inline u32 vepu_read(struct hantro_dev *vpu, u32 reg)
{
 u32 val = readl(vpu->enc_base + reg);

 vpu_debug(6, "0x%04x = 0x%08x\n", reg / 4, val);
 return val;
}

static __always_inline void vdpu_write_relaxed(struct hantro_dev *vpu,
            u32 val, u32 reg)
{
 vpu_debug(6, "0x%04x = 0x%08x\n", reg / 4, val);
 writel_relaxed(val, vpu->dec_base + reg);
}

static __always_inline void vdpu_write(struct hantro_dev *vpu, u32 val, u32 reg)
{
 vpu_debug(6, "0x%04x = 0x%08x\n", reg / 4, val);
 writel(val, vpu->dec_base + reg);
}

static __always_inline void hantro_write_addr(struct hantro_dev *vpu,
           unsigned long offset,
           dma_addr_t addr)
{
 vdpu_write(vpu, addr & 0xffffffff, offset);
}

static __always_inline u32 vdpu_read(struct hantro_dev *vpu, u32 reg)
{
 u32 val = readl(vpu->dec_base + reg);

 vpu_debug(6, "0x%04x = 0x%08x\n", reg / 4, val);
 return val;
}

static __always_inline u32 vdpu_read_mask(struct hantro_dev *vpu,
       const struct hantro_reg *reg,
       u32 val)
{
 u32 v;

 v = vdpu_read(vpu, reg->base);
 v &= ~(reg->mask << reg->shift);
 v |= ((val & reg->mask) << reg->shift);
 return v;
}

static __always_inline void hantro_reg_write(struct hantro_dev *vpu,
          const struct hantro_reg *reg,
          u32 val)
{
 vdpu_write(vpu, vdpu_read_mask(vpu, reg, val), reg->base);
}

static __always_inline void hantro_reg_write_relaxed(struct hantro_dev *vpu,
           const struct hantro_reg *reg,
           u32 val)
{
 vdpu_write_relaxed(vpu, vdpu_read_mask(vpu, reg, val), reg->base);
}

void *hantro_get_ctrl(struct hantro_ctx *ctx, u32 id);
dma_addr_t hantro_get_ref(struct hantro_ctx *ctx, u64 ts);

static inline struct vb2_v4l2_buffer *
hantro_get_src_buf(struct hantro_ctx *ctx)
{
 return v4l2_m2m_next_src_buf(ctx->fh.m2m_ctx);
}

static inline struct vb2_v4l2_buffer *
hantro_get_dst_buf(struct hantro_ctx *ctx)
{
 return v4l2_m2m_next_dst_buf(ctx->fh.m2m_ctx);
}

bool hantro_needs_postproc(const struct hantro_ctx *ctx,
      const struct hantro_fmt *fmt);

dma_addr_t
hantro_postproc_get_dec_buf_addr(struct hantro_ctx *ctx, int index);

static inline dma_addr_t
hantro_get_dec_buf_addr(struct hantro_ctx *ctx, struct vb2_buffer *vb)
{
 if (hantro_needs_postproc(ctx, ctx->vpu_dst_fmt))
  return hantro_postproc_get_dec_buf_addr(ctx, vb->index);
 return vb2_dma_contig_plane_dma_addr(vb, 0);
}

static inline struct hantro_decoded_buffer *
vb2_to_hantro_decoded_buf(struct vb2_buffer *buf)
{
 return container_of(buf, struct hantro_decoded_buffer, base.vb.vb2_buf);
}

void hantro_postproc_disable(struct hantro_ctx *ctx);
void hantro_postproc_enable(struct hantro_ctx *ctx);
int hantro_postproc_init(struct hantro_ctx *ctx);
void hantro_postproc_free(struct hantro_ctx *ctx);
int hanto_postproc_enum_framesizes(struct hantro_ctx *ctx,
       struct v4l2_frmsizeenum *fsize);

#endif /* HANTRO_H_ */