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