GNU Linux-libre 4.19.245-gnu1
[releases.git] / drivers / media / platform / ti-vpe / vpdma.h
1 /*
2  * Copyright (c) 2013 Texas Instruments Inc.
3  *
4  * David Griego, <dagriego@biglakesoftware.com>
5  * Dale Farnsworth, <dale@farnsworth.org>
6  * Archit Taneja, <archit@ti.com>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License version 2 as published by
10  * the Free Software Foundation.
11  */
12
13 #ifndef __TI_VPDMA_H_
14 #define __TI_VPDMA_H_
15
16 #define VPDMA_MAX_NUM_LIST              8
17 /*
18  * A vpdma_buf tracks the size, DMA address and mapping status of each
19  * driver DMA area.
20  */
21 struct vpdma_buf {
22         void                    *addr;
23         dma_addr_t              dma_addr;
24         size_t                  size;
25         bool                    mapped;
26 };
27
28 struct vpdma_desc_list {
29         struct vpdma_buf buf;
30         void *next;
31         int type;
32 };
33
34 struct vpdma_data {
35         void __iomem            *base;
36
37         struct platform_device  *pdev;
38
39         spinlock_t              lock;
40         bool                    hwlist_used[VPDMA_MAX_NUM_LIST];
41         void                    *hwlist_priv[VPDMA_MAX_NUM_LIST];
42         /* callback to VPE driver when the firmware is loaded */
43         void (*cb)(struct platform_device *pdev);
44 };
45
46 enum vpdma_data_format_type {
47         VPDMA_DATA_FMT_TYPE_YUV,
48         VPDMA_DATA_FMT_TYPE_RGB,
49         VPDMA_DATA_FMT_TYPE_MISC,
50 };
51
52 struct vpdma_data_format {
53         enum vpdma_data_format_type type;
54         int data_type;
55         u8 depth;
56 };
57
58 #define VPDMA_DESC_ALIGN                16      /* 16-byte descriptor alignment */
59 #define VPDMA_STRIDE_ALIGN              16      /*
60                                                  * line stride of source and dest
61                                                  * buffers should be 16 byte aligned
62                                                  */
63 #define VPDMA_MAX_STRIDE                65520   /* Max line stride 16 byte aligned */
64 #define VPDMA_DTD_DESC_SIZE             32      /* 8 words */
65 #define VPDMA_CFD_CTD_DESC_SIZE         16      /* 4 words */
66
67 #define VPDMA_LIST_TYPE_NORMAL          0
68 #define VPDMA_LIST_TYPE_SELF_MODIFYING  1
69 #define VPDMA_LIST_TYPE_DOORBELL        2
70
71 enum vpdma_yuv_formats {
72         VPDMA_DATA_FMT_Y444 = 0,
73         VPDMA_DATA_FMT_Y422,
74         VPDMA_DATA_FMT_Y420,
75         VPDMA_DATA_FMT_C444,
76         VPDMA_DATA_FMT_C422,
77         VPDMA_DATA_FMT_C420,
78         VPDMA_DATA_FMT_YCR422,
79         VPDMA_DATA_FMT_YC444,
80         VPDMA_DATA_FMT_CRY422,
81         VPDMA_DATA_FMT_CBY422,
82         VPDMA_DATA_FMT_YCB422,
83 };
84
85 enum vpdma_rgb_formats {
86         VPDMA_DATA_FMT_RGB565 = 0,
87         VPDMA_DATA_FMT_ARGB16_1555,
88         VPDMA_DATA_FMT_ARGB16,
89         VPDMA_DATA_FMT_RGBA16_5551,
90         VPDMA_DATA_FMT_RGBA16,
91         VPDMA_DATA_FMT_ARGB24,
92         VPDMA_DATA_FMT_RGB24,
93         VPDMA_DATA_FMT_ARGB32,
94         VPDMA_DATA_FMT_RGBA24,
95         VPDMA_DATA_FMT_RGBA32,
96         VPDMA_DATA_FMT_BGR565,
97         VPDMA_DATA_FMT_ABGR16_1555,
98         VPDMA_DATA_FMT_ABGR16,
99         VPDMA_DATA_FMT_BGRA16_5551,
100         VPDMA_DATA_FMT_BGRA16,
101         VPDMA_DATA_FMT_ABGR24,
102         VPDMA_DATA_FMT_BGR24,
103         VPDMA_DATA_FMT_ABGR32,
104         VPDMA_DATA_FMT_BGRA24,
105         VPDMA_DATA_FMT_BGRA32,
106 };
107
108 enum vpdma_raw_formats {
109         VPDMA_DATA_FMT_RAW8 = 0,
110         VPDMA_DATA_FMT_RAW16,
111 };
112
113 enum vpdma_misc_formats {
114         VPDMA_DATA_FMT_MV = 0,
115 };
116
117 extern const struct vpdma_data_format vpdma_yuv_fmts[];
118 extern const struct vpdma_data_format vpdma_rgb_fmts[];
119 extern const struct vpdma_data_format vpdma_raw_fmts[];
120 extern const struct vpdma_data_format vpdma_misc_fmts[];
121
122 enum vpdma_frame_start_event {
123         VPDMA_FSEVENT_HDMI_FID = 0,
124         VPDMA_FSEVENT_DVO2_FID,
125         VPDMA_FSEVENT_HDCOMP_FID,
126         VPDMA_FSEVENT_SD_FID,
127         VPDMA_FSEVENT_LM_FID0,
128         VPDMA_FSEVENT_LM_FID1,
129         VPDMA_FSEVENT_LM_FID2,
130         VPDMA_FSEVENT_CHANNEL_ACTIVE,
131 };
132
133 /* max width configurations */
134 enum vpdma_max_width {
135         MAX_OUT_WIDTH_UNLIMITED = 0,
136         MAX_OUT_WIDTH_REG1,
137         MAX_OUT_WIDTH_REG2,
138         MAX_OUT_WIDTH_REG3,
139         MAX_OUT_WIDTH_352,
140         MAX_OUT_WIDTH_768,
141         MAX_OUT_WIDTH_1280,
142         MAX_OUT_WIDTH_1920,
143 };
144
145 /* max height configurations */
146 enum vpdma_max_height {
147         MAX_OUT_HEIGHT_UNLIMITED = 0,
148         MAX_OUT_HEIGHT_REG1,
149         MAX_OUT_HEIGHT_REG2,
150         MAX_OUT_HEIGHT_REG3,
151         MAX_OUT_HEIGHT_288,
152         MAX_OUT_HEIGHT_576,
153         MAX_OUT_HEIGHT_720,
154         MAX_OUT_HEIGHT_1080,
155 };
156
157 /*
158  * VPDMA channel numbers
159  */
160 enum vpdma_channel {
161         VPE_CHAN_LUMA1_IN,
162         VPE_CHAN_CHROMA1_IN,
163         VPE_CHAN_LUMA2_IN,
164         VPE_CHAN_CHROMA2_IN,
165         VPE_CHAN_LUMA3_IN,
166         VPE_CHAN_CHROMA3_IN,
167         VPE_CHAN_MV_IN,
168         VPE_CHAN_MV_OUT,
169         VPE_CHAN_LUMA_OUT,
170         VPE_CHAN_CHROMA_OUT,
171         VPE_CHAN_RGB_OUT,
172 };
173
174 #define VIP_CHAN_VIP2_OFFSET            70
175 #define VIP_CHAN_MULT_PORTB_OFFSET      16
176 #define VIP_CHAN_YUV_PORTB_OFFSET       2
177 #define VIP_CHAN_RGB_PORTB_OFFSET       1
178
179 #define VPDMA_MAX_CHANNELS              256
180
181 /* flags for VPDMA data descriptors */
182 #define VPDMA_DATA_ODD_LINE_SKIP        (1 << 0)
183 #define VPDMA_DATA_EVEN_LINE_SKIP       (1 << 1)
184 #define VPDMA_DATA_FRAME_1D             (1 << 2)
185 #define VPDMA_DATA_MODE_TILED           (1 << 3)
186
187 /*
188  * client identifiers used for configuration descriptors
189  */
190 #define CFD_MMR_CLIENT          0
191 #define CFD_SC_CLIENT           4
192
193 /* Address data block header format */
194 struct vpdma_adb_hdr {
195         u32                     offset;
196         u32                     nwords;
197         u32                     reserved0;
198         u32                     reserved1;
199 };
200
201 /* helpers for creating ADB headers for config descriptors MMRs as client */
202 #define ADB_ADDR(dma_buf, str, fld)     ((dma_buf)->addr + offsetof(str, fld))
203 #define MMR_ADB_ADDR(buf, str, fld)     ADB_ADDR(&(buf), struct str, fld)
204
205 #define VPDMA_SET_MMR_ADB_HDR(buf, str, hdr, regs, offset_a)    \
206         do {                                                    \
207                 struct vpdma_adb_hdr *h;                        \
208                 struct str *adb = NULL;                         \
209                 h = MMR_ADB_ADDR(buf, str, hdr);                \
210                 h->offset = (offset_a);                         \
211                 h->nwords = sizeof(adb->regs) >> 2;             \
212         } while (0)
213
214 /* vpdma descriptor buffer allocation and management */
215 int vpdma_alloc_desc_buf(struct vpdma_buf *buf, size_t size);
216 void vpdma_free_desc_buf(struct vpdma_buf *buf);
217 int vpdma_map_desc_buf(struct vpdma_data *vpdma, struct vpdma_buf *buf);
218 void vpdma_unmap_desc_buf(struct vpdma_data *vpdma, struct vpdma_buf *buf);
219
220 /* vpdma descriptor list funcs */
221 int vpdma_create_desc_list(struct vpdma_desc_list *list, size_t size, int type);
222 void vpdma_reset_desc_list(struct vpdma_desc_list *list);
223 void vpdma_free_desc_list(struct vpdma_desc_list *list);
224 int vpdma_submit_descs(struct vpdma_data *vpdma, struct vpdma_desc_list *list,
225                        int list_num);
226 bool vpdma_list_busy(struct vpdma_data *vpdma, int list_num);
227 void vpdma_update_dma_addr(struct vpdma_data *vpdma,
228         struct vpdma_desc_list *list, dma_addr_t dma_addr,
229         void *write_dtd, int drop, int idx);
230
231 /* VPDMA hardware list funcs */
232 int vpdma_hwlist_alloc(struct vpdma_data *vpdma, void *priv);
233 void *vpdma_hwlist_get_priv(struct vpdma_data *vpdma, int list_num);
234 void *vpdma_hwlist_release(struct vpdma_data *vpdma, int list_num);
235
236 /* helpers for creating vpdma descriptors */
237 void vpdma_add_cfd_block(struct vpdma_desc_list *list, int client,
238                 struct vpdma_buf *blk, u32 dest_offset);
239 void vpdma_add_cfd_adb(struct vpdma_desc_list *list, int client,
240                 struct vpdma_buf *adb);
241 void vpdma_add_sync_on_channel_ctd(struct vpdma_desc_list *list,
242                 enum vpdma_channel chan);
243 void vpdma_add_abort_channel_ctd(struct vpdma_desc_list *list,
244                 int chan_num);
245 void vpdma_add_out_dtd(struct vpdma_desc_list *list, int width,
246                 int stride, const struct v4l2_rect *c_rect,
247                 const struct vpdma_data_format *fmt, dma_addr_t dma_addr,
248                 int max_w, int max_h, enum vpdma_channel chan, u32 flags);
249 void vpdma_rawchan_add_out_dtd(struct vpdma_desc_list *list, int width,
250                 int stride, const struct v4l2_rect *c_rect,
251                 const struct vpdma_data_format *fmt, dma_addr_t dma_addr,
252                 int max_w, int max_h, int raw_vpdma_chan, u32 flags);
253
254 void vpdma_add_in_dtd(struct vpdma_desc_list *list, int width,
255                 int stride, const struct v4l2_rect *c_rect,
256                 const struct vpdma_data_format *fmt, dma_addr_t dma_addr,
257                 enum vpdma_channel chan, int field, u32 flags, int frame_width,
258                 int frame_height, int start_h, int start_v);
259 int vpdma_list_cleanup(struct vpdma_data *vpdma, int list_num,
260                 int *channels, int size);
261
262 /* vpdma list interrupt management */
263 void vpdma_enable_list_complete_irq(struct vpdma_data *vpdma, int irq_num,
264                 int list_num, bool enable);
265 void vpdma_clear_list_stat(struct vpdma_data *vpdma, int irq_num,
266                            int list_num);
267 unsigned int vpdma_get_list_stat(struct vpdma_data *vpdma, int irq_num);
268 unsigned int vpdma_get_list_mask(struct vpdma_data *vpdma, int irq_num);
269
270 /* vpdma client configuration */
271 void vpdma_set_line_mode(struct vpdma_data *vpdma, int line_mode,
272                 enum vpdma_channel chan);
273 void vpdma_set_frame_start_event(struct vpdma_data *vpdma,
274                 enum vpdma_frame_start_event fs_event, enum vpdma_channel chan);
275 void vpdma_set_max_size(struct vpdma_data *vpdma, int reg_addr,
276                         u32 width, u32 height);
277
278 void vpdma_set_bg_color(struct vpdma_data *vpdma,
279                         struct vpdma_data_format *fmt, u32 color);
280 void vpdma_dump_regs(struct vpdma_data *vpdma);
281
282 /* initialize vpdma, passed with VPE's platform device pointer */
283 int vpdma_create(struct platform_device *pdev, struct vpdma_data *vpdma,
284                 void (*cb)(struct platform_device *pdev));
285
286 #endif