include/media/vsp1.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * vsp1.h  --  R-Car VSP1 API
   4  *
   5  * Copyright (C) 2015 Renesas Electronics Corporation
   6  *
   7  * Contact: Laurent Pinchart (laurent.pinchart@ideasonboard.com)
   8  */
   9 #ifndef __MEDIA_VSP1_H__
  10 #define __MEDIA_VSP1_H__
  11
  12 #include <linux/scatterlist.h>
  13 #include <linux/types.h>
  14 #include <linux/videodev2.h>
  15
  16 struct device;
  17
  18 int vsp1_du_init(struct device *dev);
  19
  20 /**
  21  * struct vsp1_du_lif_config - VSP LIF configuration
  22  * @width: output frame width
  23  * @height: output frame height
  24  * @interlaced: true for interlaced pipelines
  25  * @callback: frame completion callback function (optional). When a callback
  26  *            is provided, the VSP driver guarantees that it will be called once
  27  *            and only once for each vsp1_du_atomic_flush() call.
  28  * @callback_data: data to be passed to the frame completion callback
  29  */
  30 struct vsp1_du_lif_config {
  31         unsigned int width;
  32         unsigned int height;
  33         bool interlaced;
  34
  35         void (*callback)(void *data, bool completed, u32 crc);
  36         void *callback_data;
  37 };
  38
  39 int vsp1_du_setup_lif(struct device *dev, unsigned int pipe_index,
  40                       const struct vsp1_du_lif_config *cfg);
  41
  42 /**
  43  * struct vsp1_du_atomic_config - VSP atomic configuration parameters
  44  * @pixelformat: plane pixel format (V4L2 4CC)
  45  * @pitch: line pitch in bytes for the first plane
  46  * @mem: DMA memory address for each plane of the frame buffer
  47  * @src: source rectangle in the frame buffer (integer coordinates)
  48  * @dst: destination rectangle on the display (integer coordinates)
  49  * @alpha: alpha value (0: fully transparent, 255: fully opaque)
  50  * @zpos: Z position of the plane (from 0 to number of planes minus 1)
  51  */
  52 struct vsp1_du_atomic_config {
  53         u32 pixelformat;
  54         unsigned int pitch;
  55         dma_addr_t mem[3];
  56         struct v4l2_rect src;
  57         struct v4l2_rect dst;
  58         unsigned int alpha;
  59         unsigned int zpos;
  60 };
  61
  62 /**
  63  * enum vsp1_du_crc_source - Source used for CRC calculation
  64  * @VSP1_DU_CRC_NONE: CRC calculation disabled
  65  * @VSP1_DU_CRC_PLANE: Perform CRC calculation on an input plane
  66  * @VSP1_DU_CRC_OUTPUT: Perform CRC calculation on the composed output
  67  */
  68 enum vsp1_du_crc_source {
  69         VSP1_DU_CRC_NONE,
  70         VSP1_DU_CRC_PLANE,
  71         VSP1_DU_CRC_OUTPUT,
  72 };
  73
  74 /**
  75  * struct vsp1_du_crc_config - VSP CRC computation configuration parameters
  76  * @source: source for CRC calculation
  77  * @index: index of the CRC source plane (when source is set to plane)
  78  */
  79 struct vsp1_du_crc_config {
  80         enum vsp1_du_crc_source source;
  81         unsigned int index;
  82 };
  83
  84 /**
  85  * struct vsp1_du_atomic_pipe_config - VSP atomic pipe configuration parameters
  86  * @crc: CRC computation configuration
  87  */
  88 struct vsp1_du_atomic_pipe_config {
  89         struct vsp1_du_crc_config crc;
  90 };
  91
  92 void vsp1_du_atomic_begin(struct device *dev, unsigned int pipe_index);
  93 int vsp1_du_atomic_update(struct device *dev, unsigned int pipe_index,
  94                           unsigned int rpf,
  95                           const struct vsp1_du_atomic_config *cfg);
  96 void vsp1_du_atomic_flush(struct device *dev, unsigned int pipe_index,
  97                           const struct vsp1_du_atomic_pipe_config *cfg);
  98 int vsp1_du_map_sg(struct device *dev, struct sg_table *sgt);
  99 void vsp1_du_unmap_sg(struct device *dev, struct sg_table *sgt);
 100
 101 #endif /* __MEDIA_VSP1_H__ */