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
16struct device;
17
18int vsp1_du_init(struct device *dev);
19
20#define VSP1_DU_STATUS_COMPLETE BIT(0)
21#define VSP1_DU_STATUS_WRITEBACK BIT(1)
22
23/**
24 * struct vsp1_du_lif_config - VSP LIF configuration
25 * @width: output frame width
26 * @height: output frame height
27 * @interlaced: true for interlaced pipelines
28 * @callback: frame completion callback function (optional). When a callback
29 * is provided, the VSP driver guarantees that it will be called once
30 * and only once for each vsp1_du_atomic_flush() call.
31 * @callback_data: data to be passed to the frame completion callback
32 */
33struct vsp1_du_lif_config {
34 unsigned int width;
35 unsigned int height;
36 bool interlaced;
37
38 void (*callback)(void *data, unsigned int status, u32 crc);
39 void *callback_data;
40};
41
42int vsp1_du_setup_lif(struct device *dev, unsigned int pipe_index,
43 const struct vsp1_du_lif_config *cfg);
44
45/**
46 * struct vsp1_du_atomic_config - VSP atomic configuration parameters
47 * @pixelformat: plane pixel format (V4L2 4CC)
48 * @pitch: line pitch in bytes for the first plane
49 * @mem: DMA memory address for each plane of the frame buffer
50 * @src: source rectangle in the frame buffer (integer coordinates)
51 * @dst: destination rectangle on the display (integer coordinates)
52 * @alpha: alpha value (0: fully transparent, 255: fully opaque)
53 * @zpos: Z position of the plane (from 0 to number of planes minus 1)
54 * @premult: true for premultiplied alpha
55 */
56struct vsp1_du_atomic_config {
57 u32 pixelformat;
58 unsigned int pitch;
59 dma_addr_t mem[3];
60 struct v4l2_rect src;
61 struct v4l2_rect dst;
62 unsigned int alpha;
63 unsigned int zpos;
64 bool premult;
65};
66
67/**
68 * enum vsp1_du_crc_source - Source used for CRC calculation
69 * @VSP1_DU_CRC_NONE: CRC calculation disabled
70 * @VSP1_DU_CRC_PLANE: Perform CRC calculation on an input plane
71 * @VSP1_DU_CRC_OUTPUT: Perform CRC calculation on the composed output
72 */
73enum vsp1_du_crc_source {
74 VSP1_DU_CRC_NONE,
75 VSP1_DU_CRC_PLANE,
76 VSP1_DU_CRC_OUTPUT,
77};
78
79/**
80 * struct vsp1_du_crc_config - VSP CRC computation configuration parameters
81 * @source: source for CRC calculation
82 * @index: index of the CRC source plane (when source is set to plane)
83 */
84struct vsp1_du_crc_config {
85 enum vsp1_du_crc_source source;
86 unsigned int index;
87};
88
89/**
90 * struct vsp1_du_writeback_config - VSP writeback configuration parameters
91 * @pixelformat: plane pixel format (V4L2 4CC)
92 * @pitch: line pitch in bytes for the first plane
93 * @mem: DMA memory address for each plane of the frame buffer
94 */
95struct vsp1_du_writeback_config {
96 u32 pixelformat;
97 unsigned int pitch;
98 dma_addr_t mem[3];
99};
100
101/**
102 * struct vsp1_du_atomic_pipe_config - VSP atomic pipe configuration parameters
103 * @crc: CRC computation configuration
104 * @writeback: writeback configuration
105 */
106struct vsp1_du_atomic_pipe_config {
107 struct vsp1_du_crc_config crc;
108 struct vsp1_du_writeback_config writeback;
109};
110
111void vsp1_du_atomic_begin(struct device *dev, unsigned int pipe_index);
112int vsp1_du_atomic_update(struct device *dev, unsigned int pipe_index,
113 unsigned int rpf,
114 const struct vsp1_du_atomic_config *cfg);
115void vsp1_du_atomic_flush(struct device *dev, unsigned int pipe_index,
116 const struct vsp1_du_atomic_pipe_config *cfg);
117int vsp1_du_map_sg(struct device *dev, struct sg_table *sgt);
118void vsp1_du_unmap_sg(struct device *dev, struct sg_table *sgt);
119
120#endif /* __MEDIA_VSP1_H__ */
121

source code of linux/include/media/vsp1.h