tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * vivid-core.h - core datastructures
3 *
4 * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
5 *
6 * This program is free software; you may redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
11 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
12 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
13 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
14 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
15 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
16 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17 * SOFTWARE.
18 */
19
20#ifndef _VIVID_CORE_H_
21#define _VIVID_CORE_H_
22
23#include <linux/fb.h>
24#include <media/videobuf2-core.h>
25#include <media/v4l2-device.h>
26#include <media/v4l2-dev.h>
27#include <media/v4l2-ctrls.h>
28#include "vivid-tpg.h"
29#include "vivid-rds-gen.h"
30#include "vivid-vbi-gen.h"
31
32#define dprintk(dev, level, fmt, arg...) \
33 v4l2_dbg(level, vivid_debug, &dev->v4l2_dev, fmt, ## arg)
34
35/* Maximum allowed frame rate
36 *
37 * vivid will allow setting timeperframe in [1/FPS_MAX - FPS_MAX/1] range.
38 *
39 * Ideally FPS_MAX should be infinity, i.e. practically UINT_MAX, but that
40 * might hit application errors when they manipulate these values.
41 *
42 * Besides, for tpf < 10ms image-generation logic should be changed, to avoid
43 * producing frames with equal content.
44 */
45#define FPS_MAX 100
46
47/* The maximum number of clip rectangles */
48#define MAX_CLIPS 16
49/* The maximum number of inputs */
50#define MAX_INPUTS 16
51/* The maximum number of outputs */
52#define MAX_OUTPUTS 16
53/* The maximum up or down scaling factor is 4 */
54#define MAX_ZOOM 4
55/* The maximum image width/height are set to 4K DMT */
56#define MAX_WIDTH 4096
57#define MAX_HEIGHT 2160
58/* The minimum image width/height */
59#define MIN_WIDTH 16
60#define MIN_HEIGHT 16
61/* The data_offset of plane 0 for the multiplanar formats */
62#define PLANE0_DATA_OFFSET 128
63
64/* The supported TV frequency range in MHz */
65#define MIN_TV_FREQ (44U * 16U)
66#define MAX_TV_FREQ (958U * 16U)
67
68/* The number of samples returned in every SDR buffer */
69#define SDR_CAP_SAMPLES_PER_BUF 0x4000
70
71/* used by the threads to know when to resync internal counters */
72#define JIFFIES_PER_DAY (3600U * 24U * HZ)
73#define JIFFIES_RESYNC (JIFFIES_PER_DAY * (0xf0000000U / JIFFIES_PER_DAY))
74
75extern const struct v4l2_rect vivid_min_rect;
76extern const struct v4l2_rect vivid_max_rect;
77extern unsigned vivid_debug;
78
79struct vivid_fmt {
80 const char *name;
81 u32 fourcc; /* v4l2 format id */
82 u8 depth;
83 bool is_yuv;
84 bool can_do_overlay;
85 u32 alpha_mask;
86 u8 planes;
87 u32 data_offset[2];
88};
89
90extern struct vivid_fmt vivid_formats[];
91
92/* buffer for one video frame */
93struct vivid_buffer {
94 /* common v4l buffer stuff -- must be first */
95 struct vb2_buffer vb;
96 struct list_head list;
97};
98
99enum vivid_input {
100 WEBCAM,
101 TV,
102 SVID,
103 HDMI,
104};
105
106enum vivid_signal_mode {
107 CURRENT_DV_TIMINGS,
108 CURRENT_STD = CURRENT_DV_TIMINGS,
109 NO_SIGNAL,
110 NO_LOCK,
111 OUT_OF_RANGE,
112 SELECTED_DV_TIMINGS,
113 SELECTED_STD = SELECTED_DV_TIMINGS,
114 CYCLE_DV_TIMINGS,
115 CYCLE_STD = CYCLE_DV_TIMINGS,
116 CUSTOM_DV_TIMINGS,
117};
118
119enum vivid_colorspace {
120 VIVID_CS_170M,
121 VIVID_CS_709,
122 VIVID_CS_SRGB,
123 VIVID_CS_ADOBERGB,
124 VIVID_CS_2020,
125 VIVID_CS_240M,
126 VIVID_CS_SYS_M,
127 VIVID_CS_SYS_BG,
128};
129
130#define VIVID_INVALID_SIGNAL(mode) \
131 ((mode) == NO_SIGNAL || (mode) == NO_LOCK || (mode) == OUT_OF_RANGE)
132
133struct vivid_dev {
134 unsigned inst;
135 struct v4l2_device v4l2_dev;
136 struct v4l2_ctrl_handler ctrl_hdl_user_gen;
137 struct v4l2_ctrl_handler ctrl_hdl_user_vid;
138 struct v4l2_ctrl_handler ctrl_hdl_user_aud;
139 struct v4l2_ctrl_handler ctrl_hdl_streaming;
140 struct v4l2_ctrl_handler ctrl_hdl_sdtv_cap;
141 struct v4l2_ctrl_handler ctrl_hdl_loop_out;
142 struct video_device vid_cap_dev;
143 struct v4l2_ctrl_handler ctrl_hdl_vid_cap;
144 struct video_device vid_out_dev;
145 struct v4l2_ctrl_handler ctrl_hdl_vid_out;
146 struct video_device vbi_cap_dev;
147 struct v4l2_ctrl_handler ctrl_hdl_vbi_cap;
148 struct video_device vbi_out_dev;
149 struct v4l2_ctrl_handler ctrl_hdl_vbi_out;
150 struct video_device radio_rx_dev;
151 struct v4l2_ctrl_handler ctrl_hdl_radio_rx;
152 struct video_device radio_tx_dev;
153 struct v4l2_ctrl_handler ctrl_hdl_radio_tx;
154 struct video_device sdr_cap_dev;
155 struct v4l2_ctrl_handler ctrl_hdl_sdr_cap;
156 spinlock_t slock;
157 struct mutex mutex;
158
159 /* capabilities */
160 u32 vid_cap_caps;
161 u32 vid_out_caps;
162 u32 vbi_cap_caps;
163 u32 vbi_out_caps;
164 u32 sdr_cap_caps;
165 u32 radio_rx_caps;
166 u32 radio_tx_caps;
167
168 /* supported features */
169 bool multiplanar;
170 unsigned num_inputs;
171 u8 input_type[MAX_INPUTS];
172 u8 input_name_counter[MAX_INPUTS];
173 unsigned num_outputs;
174 u8 output_type[MAX_OUTPUTS];
175 u8 output_name_counter[MAX_OUTPUTS];
176 bool has_audio_inputs;
177 bool has_audio_outputs;
178 bool has_vid_cap;
179 bool has_vid_out;
180 bool has_vbi_cap;
181 bool has_raw_vbi_cap;
182 bool has_sliced_vbi_cap;
183 bool has_vbi_out;
184 bool has_raw_vbi_out;
185 bool has_sliced_vbi_out;
186 bool has_radio_rx;
187 bool has_radio_tx;
188 bool has_sdr_cap;
189 bool has_fb;
190
191 bool can_loop_video;
192
193 /* controls */
194 struct v4l2_ctrl *brightness;
195 struct v4l2_ctrl *contrast;
196 struct v4l2_ctrl *saturation;
197 struct v4l2_ctrl *hue;
198 struct {
199 /* autogain/gain cluster */
200 struct v4l2_ctrl *autogain;
201 struct v4l2_ctrl *gain;
202 };
203 struct v4l2_ctrl *volume;
204 struct v4l2_ctrl *mute;
205 struct v4l2_ctrl *alpha;
206 struct v4l2_ctrl *button;
207 struct v4l2_ctrl *boolean;
208 struct v4l2_ctrl *int32;
209 struct v4l2_ctrl *int64;
210 struct v4l2_ctrl *menu;
211 struct v4l2_ctrl *string;
212 struct v4l2_ctrl *bitmask;
213 struct v4l2_ctrl *int_menu;
214 struct v4l2_ctrl *test_pattern;
215 struct v4l2_ctrl *colorspace;
216 struct v4l2_ctrl *rgb_range_cap;
217 struct v4l2_ctrl *real_rgb_range_cap;
218 struct {
219 /* std_signal_mode/standard cluster */
220 struct v4l2_ctrl *ctrl_std_signal_mode;
221 struct v4l2_ctrl *ctrl_standard;
222 };
223 struct {
224 /* dv_timings_signal_mode/timings cluster */
225 struct v4l2_ctrl *ctrl_dv_timings_signal_mode;
226 struct v4l2_ctrl *ctrl_dv_timings;
227 };
228 struct v4l2_ctrl *ctrl_has_crop_cap;
229 struct v4l2_ctrl *ctrl_has_compose_cap;
230 struct v4l2_ctrl *ctrl_has_scaler_cap;
231 struct v4l2_ctrl *ctrl_has_crop_out;
232 struct v4l2_ctrl *ctrl_has_compose_out;
233 struct v4l2_ctrl *ctrl_has_scaler_out;
234 struct v4l2_ctrl *ctrl_tx_mode;
235 struct v4l2_ctrl *ctrl_tx_rgb_range;
236
237 struct v4l2_ctrl *radio_tx_rds_pi;
238 struct v4l2_ctrl *radio_tx_rds_pty;
239 struct v4l2_ctrl *radio_tx_rds_mono_stereo;
240 struct v4l2_ctrl *radio_tx_rds_art_head;
241 struct v4l2_ctrl *radio_tx_rds_compressed;
242 struct v4l2_ctrl *radio_tx_rds_dyn_pty;
243 struct v4l2_ctrl *radio_tx_rds_ta;
244 struct v4l2_ctrl *radio_tx_rds_tp;
245 struct v4l2_ctrl *radio_tx_rds_ms;
246 struct v4l2_ctrl *radio_tx_rds_psname;
247 struct v4l2_ctrl *radio_tx_rds_radiotext;
248
249 struct v4l2_ctrl *radio_rx_rds_pty;
250 struct v4l2_ctrl *radio_rx_rds_ta;
251 struct v4l2_ctrl *radio_rx_rds_tp;
252 struct v4l2_ctrl *radio_rx_rds_ms;
253 struct v4l2_ctrl *radio_rx_rds_psname;
254 struct v4l2_ctrl *radio_rx_rds_radiotext;
255
256 unsigned input_brightness[MAX_INPUTS];
257 unsigned osd_mode;
258 unsigned button_pressed;
259 bool sensor_hflip;
260 bool sensor_vflip;
261 bool hflip;
262 bool vflip;
263 bool vbi_cap_interlaced;
264 bool loop_video;
265
266 /* Framebuffer */
267 unsigned long video_pbase;
268 void *video_vbase;
269 u32 video_buffer_size;
270 int display_width;
271 int display_height;
272 int display_byte_stride;
273 int bits_per_pixel;
274 int bytes_per_pixel;
275 struct fb_info fb_info;
276 struct fb_var_screeninfo fb_defined;
277 struct fb_fix_screeninfo fb_fix;
278
279 /* Error injection */
280 bool queue_setup_error;
281 bool buf_prepare_error;
282 bool start_streaming_error;
283 bool dqbuf_error;
284 bool seq_wrap;
285 bool time_wrap;
286 __kernel_time_t time_wrap_offset;
287 unsigned perc_dropped_buffers;
288 enum vivid_signal_mode std_signal_mode;
289 unsigned query_std_last;
290 v4l2_std_id query_std;
291 enum tpg_video_aspect std_aspect_ratio;
292
293 enum vivid_signal_mode dv_timings_signal_mode;
294 char **query_dv_timings_qmenu;
295 unsigned query_dv_timings_size;
296 unsigned query_dv_timings_last;
297 unsigned query_dv_timings;
298 enum tpg_video_aspect dv_timings_aspect_ratio;
299
300 /* Input */
301 unsigned input;
302 v4l2_std_id std_cap;
303 struct v4l2_dv_timings dv_timings_cap;
304 u32 service_set_cap;
305 struct vivid_vbi_gen_data vbi_gen;
306 u8 *edid;
307 unsigned edid_blocks;
308 unsigned edid_max_blocks;
309 unsigned webcam_size_idx;
310 unsigned webcam_ival_idx;
311 unsigned tv_freq;
312 unsigned tv_audmode;
313 unsigned tv_field_cap;
314 unsigned tv_audio_input;
315
316 /* Capture Overlay */
317 struct v4l2_framebuffer fb_cap;
318 struct v4l2_fh *overlay_cap_owner;
319 void *fb_vbase_cap;
320 int overlay_cap_top, overlay_cap_left;
321 enum v4l2_field overlay_cap_field;
322 void *bitmap_cap;
323 struct v4l2_clip clips_cap[MAX_CLIPS];
324 struct v4l2_clip try_clips_cap[MAX_CLIPS];
325 unsigned clipcount_cap;
326
327 /* Output */
328 unsigned output;
329 v4l2_std_id std_out;
330 struct v4l2_dv_timings dv_timings_out;
331 u32 colorspace_out;
332 u32 ycbcr_enc_out;
333 u32 quantization_out;
334 u32 service_set_out;
335 u32 bytesperline_out[2];
336 unsigned tv_field_out;
337 unsigned tv_audio_output;
338 bool vbi_out_have_wss;
339 u8 vbi_out_wss[2];
340 bool vbi_out_have_cc[2];
341 u8 vbi_out_cc[2][2];
342 bool dvi_d_out;
343 u8 *scaled_line;
344 u8 *blended_line;
345 unsigned cur_scaled_line;
346
347 /* Output Overlay */
348 void *fb_vbase_out;
349 bool overlay_out_enabled;
350 int overlay_out_top, overlay_out_left;
351 void *bitmap_out;
352 struct v4l2_clip clips_out[MAX_CLIPS];
353 struct v4l2_clip try_clips_out[MAX_CLIPS];
354 unsigned clipcount_out;
355 unsigned fbuf_out_flags;
356 u32 chromakey_out;
357 u8 global_alpha_out;
358
359 /* video capture */
360 struct tpg_data tpg;
361 unsigned ms_vid_cap;
362 bool must_blank[VIDEO_MAX_FRAME];
363
364 const struct vivid_fmt *fmt_cap;
365 struct v4l2_fract timeperframe_vid_cap;
366 enum v4l2_field field_cap;
367 struct v4l2_rect src_rect;
368 struct v4l2_rect fmt_cap_rect;
369 struct v4l2_rect crop_cap;
370 struct v4l2_rect compose_cap;
371 struct v4l2_rect crop_bounds_cap;
372 struct vb2_queue vb_vid_cap_q;
373 struct list_head vid_cap_active;
374 struct vb2_queue vb_vbi_cap_q;
375 struct list_head vbi_cap_active;
376
377 /* thread for generating video capture stream */
378 struct task_struct *kthread_vid_cap;
379 unsigned long jiffies_vid_cap;
380 u32 cap_seq_offset;
381 u32 cap_seq_count;
382 bool cap_seq_resync;
383 u32 vid_cap_seq_start;
384 u32 vid_cap_seq_count;
385 bool vid_cap_streaming;
386 u32 vbi_cap_seq_start;
387 u32 vbi_cap_seq_count;
388 bool vbi_cap_streaming;
389 bool stream_sliced_vbi_cap;
390
391 /* video output */
392 const struct vivid_fmt *fmt_out;
393 struct v4l2_fract timeperframe_vid_out;
394 enum v4l2_field field_out;
395 struct v4l2_rect sink_rect;
396 struct v4l2_rect fmt_out_rect;
397 struct v4l2_rect crop_out;
398 struct v4l2_rect compose_out;
399 struct v4l2_rect compose_bounds_out;
400 struct vb2_queue vb_vid_out_q;
401 struct list_head vid_out_active;
402 struct vb2_queue vb_vbi_out_q;
403 struct list_head vbi_out_active;
404
405 /* video loop precalculated rectangles */
406
407 /*
408 * Intersection between what the output side composes and the capture side
409 * crops. I.e., what actually needs to be copied from the output buffer to
410 * the capture buffer.
411 */
412 struct v4l2_rect loop_vid_copy;
413 /* The part of the output buffer that (after scaling) corresponds to loop_vid_copy. */
414 struct v4l2_rect loop_vid_out;
415 /* The part of the capture buffer that (after scaling) corresponds to loop_vid_copy. */
416 struct v4l2_rect loop_vid_cap;
417 /*
418 * The intersection of the framebuffer, the overlay output window and
419 * loop_vid_copy. I.e., the part of the framebuffer that actually should be
420 * blended with the compose_out rectangle. This uses the framebuffer origin.
421 */
422 struct v4l2_rect loop_fb_copy;
423 /* The same as loop_fb_copy but with compose_out origin. */
424 struct v4l2_rect loop_vid_overlay;
425 /*
426 * The part of the capture buffer that (after scaling) corresponds
427 * to loop_vid_overlay.
428 */
429 struct v4l2_rect loop_vid_overlay_cap;
430
431 /* thread for generating video output stream */
432 struct task_struct *kthread_vid_out;
433 unsigned long jiffies_vid_out;
434 u32 out_seq_offset;
435 u32 out_seq_count;
436 bool out_seq_resync;
437 u32 vid_out_seq_start;
438 u32 vid_out_seq_count;
439 bool vid_out_streaming;
440 u32 vbi_out_seq_start;
441 u32 vbi_out_seq_count;
442 bool vbi_out_streaming;
443 bool stream_sliced_vbi_out;
444
445 /* SDR capture */
446 struct vb2_queue vb_sdr_cap_q;
447 struct list_head sdr_cap_active;
448 unsigned sdr_adc_freq;
449 unsigned sdr_fm_freq;
450 int sdr_fixp_src_phase;
451 int sdr_fixp_mod_phase;
452
453 bool tstamp_src_is_soe;
454 bool has_crop_cap;
455 bool has_compose_cap;
456 bool has_scaler_cap;
457 bool has_crop_out;
458 bool has_compose_out;
459 bool has_scaler_out;
460
461 /* thread for generating SDR stream */
462 struct task_struct *kthread_sdr_cap;
463 unsigned long jiffies_sdr_cap;
464 u32 sdr_cap_seq_offset;
465 u32 sdr_cap_seq_count;
466 bool sdr_cap_seq_resync;
467
468 /* RDS generator */
469 struct vivid_rds_gen rds_gen;
470
471 /* Radio receiver */
472 unsigned radio_rx_freq;
473 unsigned radio_rx_audmode;
474 int radio_rx_sig_qual;
475 unsigned radio_rx_hw_seek_mode;
476 bool radio_rx_hw_seek_prog_lim;
477 bool radio_rx_rds_controls;
478 bool radio_rx_rds_enabled;
479 unsigned radio_rx_rds_use_alternates;
480 unsigned radio_rx_rds_last_block;
481 struct v4l2_fh *radio_rx_rds_owner;
482
483 /* Radio transmitter */
484 unsigned radio_tx_freq;
485 unsigned radio_tx_subchans;
486 bool radio_tx_rds_controls;
487 unsigned radio_tx_rds_last_block;
488 struct v4l2_fh *radio_tx_rds_owner;
489
490 /* Shared between radio receiver and transmitter */
491 bool radio_rds_loop;
492 struct timespec radio_rds_init_ts;
493};
494
495static inline bool vivid_is_webcam(const struct vivid_dev *dev)
496{
497 return dev->input_type[dev->input] == WEBCAM;
498}
499
500static inline bool vivid_is_tv_cap(const struct vivid_dev *dev)
501{
502 return dev->input_type[dev->input] == TV;
503}
504
505static inline bool vivid_is_svid_cap(const struct vivid_dev *dev)
506{
507 return dev->input_type[dev->input] == SVID;
508}
509
510static inline bool vivid_is_hdmi_cap(const struct vivid_dev *dev)
511{
512 return dev->input_type[dev->input] == HDMI;
513}
514
515static inline bool vivid_is_sdtv_cap(const struct vivid_dev *dev)
516{
517 return vivid_is_tv_cap(dev) || vivid_is_svid_cap(dev);
518}
519
520static inline bool vivid_is_svid_out(const struct vivid_dev *dev)
521{
522 return dev->output_type[dev->output] == SVID;
523}
524
525static inline bool vivid_is_hdmi_out(const struct vivid_dev *dev)
526{
527 return dev->output_type[dev->output] == HDMI;
528}
529
530#endif