1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * vivid-core.h - core datastructures
5 * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
12 #include <linux/workqueue.h>
13 #include <media/cec.h>
14 #include <media/videobuf2-v4l2.h>
15 #include <media/v4l2-device.h>
16 #include <media/v4l2-dev.h>
17 #include <media/v4l2-ctrls.h>
18 #include <media/tpg/v4l2-tpg.h>
19 #include "vivid-rds-gen.h"
20 #include "vivid-vbi-gen.h"
22 #define dprintk(dev, level, fmt, arg...) \
23 v4l2_dbg(level, vivid_debug, &dev->v4l2_dev, fmt, ## arg)
25 /* The maximum number of clip rectangles */
27 /* The maximum number of inputs */
29 /* The maximum number of outputs */
30 #define MAX_OUTPUTS 16
31 /* The maximum up or down scaling factor is 4 */
33 /* The maximum image width/height are set to 4K DMT */
34 #define MAX_WIDTH 4096
35 #define MAX_HEIGHT 2160
36 /* The minimum image width/height */
39 /* The data_offset of plane 0 for the multiplanar formats */
40 #define PLANE0_DATA_OFFSET 128
42 /* The supported TV frequency range in MHz */
43 #define MIN_TV_FREQ (44U * 16U)
44 #define MAX_TV_FREQ (958U * 16U)
46 /* The number of samples returned in every SDR buffer */
47 #define SDR_CAP_SAMPLES_PER_BUF 0x4000
49 /* used by the threads to know when to resync internal counters */
50 #define JIFFIES_PER_DAY (3600U * 24U * HZ)
51 #define JIFFIES_RESYNC (JIFFIES_PER_DAY * (0xf0000000U / JIFFIES_PER_DAY))
53 extern const struct v4l2_rect vivid_min_rect;
54 extern const struct v4l2_rect vivid_max_rect;
55 extern unsigned vivid_debug;
58 u32 fourcc; /* v4l2 format id */
59 enum tgp_color_enc color_enc;
61 u8 vdownsampling[TPG_MAX_PLANES];
65 u32 data_offset[TPG_MAX_PLANES];
66 u32 bit_depth[TPG_MAX_PLANES];
69 extern struct vivid_fmt vivid_formats[];
71 /* buffer for one video frame */
73 /* common v4l buffer stuff -- must be first */
74 struct vb2_v4l2_buffer vb;
75 struct list_head list;
85 enum vivid_signal_mode {
87 CURRENT_STD = CURRENT_DV_TIMINGS,
92 SELECTED_STD = SELECTED_DV_TIMINGS,
94 CYCLE_STD = CYCLE_DV_TIMINGS,
98 enum vivid_colorspace {
110 #define VIVID_INVALID_SIGNAL(mode) \
111 ((mode) == NO_SIGNAL || (mode) == NO_LOCK || (mode) == OUT_OF_RANGE)
113 struct vivid_cec_work {
114 struct list_head list;
115 struct delayed_work work;
116 struct cec_adapter *adap;
117 struct vivid_dev *dev;
119 unsigned int timeout_ms;
126 struct v4l2_device v4l2_dev;
127 #ifdef CONFIG_MEDIA_CONTROLLER
128 struct media_device mdev;
129 struct media_pad vid_cap_pad;
130 struct media_pad vid_out_pad;
131 struct media_pad vbi_cap_pad;
132 struct media_pad vbi_out_pad;
133 struct media_pad sdr_cap_pad;
134 struct media_pad meta_cap_pad;
135 struct media_pad meta_out_pad;
136 struct media_pad touch_cap_pad;
138 struct v4l2_ctrl_handler ctrl_hdl_user_gen;
139 struct v4l2_ctrl_handler ctrl_hdl_user_vid;
140 struct v4l2_ctrl_handler ctrl_hdl_user_aud;
141 struct v4l2_ctrl_handler ctrl_hdl_streaming;
142 struct v4l2_ctrl_handler ctrl_hdl_sdtv_cap;
143 struct v4l2_ctrl_handler ctrl_hdl_loop_cap;
144 struct v4l2_ctrl_handler ctrl_hdl_fb;
145 struct video_device vid_cap_dev;
146 struct v4l2_ctrl_handler ctrl_hdl_vid_cap;
147 struct video_device vid_out_dev;
148 struct v4l2_ctrl_handler ctrl_hdl_vid_out;
149 struct video_device vbi_cap_dev;
150 struct v4l2_ctrl_handler ctrl_hdl_vbi_cap;
151 struct video_device vbi_out_dev;
152 struct v4l2_ctrl_handler ctrl_hdl_vbi_out;
153 struct video_device radio_rx_dev;
154 struct v4l2_ctrl_handler ctrl_hdl_radio_rx;
155 struct video_device radio_tx_dev;
156 struct v4l2_ctrl_handler ctrl_hdl_radio_tx;
157 struct video_device sdr_cap_dev;
158 struct v4l2_ctrl_handler ctrl_hdl_sdr_cap;
159 struct video_device meta_cap_dev;
160 struct v4l2_ctrl_handler ctrl_hdl_meta_cap;
161 struct video_device meta_out_dev;
162 struct v4l2_ctrl_handler ctrl_hdl_meta_out;
163 struct video_device touch_cap_dev;
164 struct v4l2_ctrl_handler ctrl_hdl_touch_cap;
181 /* supported features */
184 unsigned int num_hdmi_inputs;
185 u8 input_type[MAX_INPUTS];
186 u8 input_name_counter[MAX_INPUTS];
187 unsigned num_outputs;
188 unsigned int num_hdmi_outputs;
189 u8 output_type[MAX_OUTPUTS];
190 u8 output_name_counter[MAX_OUTPUTS];
191 bool has_audio_inputs;
192 bool has_audio_outputs;
196 bool has_raw_vbi_cap;
197 bool has_sliced_vbi_cap;
199 bool has_raw_vbi_out;
200 bool has_sliced_vbi_out;
213 struct v4l2_ctrl *brightness;
214 struct v4l2_ctrl *contrast;
215 struct v4l2_ctrl *saturation;
216 struct v4l2_ctrl *hue;
218 /* autogain/gain cluster */
219 struct v4l2_ctrl *autogain;
220 struct v4l2_ctrl *gain;
222 struct v4l2_ctrl *volume;
223 struct v4l2_ctrl *mute;
224 struct v4l2_ctrl *alpha;
225 struct v4l2_ctrl *button;
226 struct v4l2_ctrl *boolean;
227 struct v4l2_ctrl *int32;
228 struct v4l2_ctrl *int64;
229 struct v4l2_ctrl *menu;
230 struct v4l2_ctrl *string;
231 struct v4l2_ctrl *bitmask;
232 struct v4l2_ctrl *int_menu;
233 struct v4l2_ctrl *test_pattern;
234 struct v4l2_ctrl *colorspace;
235 struct v4l2_ctrl *rgb_range_cap;
236 struct v4l2_ctrl *real_rgb_range_cap;
238 /* std_signal_mode/standard cluster */
239 struct v4l2_ctrl *ctrl_std_signal_mode;
240 struct v4l2_ctrl *ctrl_standard;
243 /* dv_timings_signal_mode/timings cluster */
244 struct v4l2_ctrl *ctrl_dv_timings_signal_mode;
245 struct v4l2_ctrl *ctrl_dv_timings;
247 struct v4l2_ctrl *ctrl_display_present;
248 struct v4l2_ctrl *ctrl_has_crop_cap;
249 struct v4l2_ctrl *ctrl_has_compose_cap;
250 struct v4l2_ctrl *ctrl_has_scaler_cap;
251 struct v4l2_ctrl *ctrl_has_crop_out;
252 struct v4l2_ctrl *ctrl_has_compose_out;
253 struct v4l2_ctrl *ctrl_has_scaler_out;
254 struct v4l2_ctrl *ctrl_tx_mode;
255 struct v4l2_ctrl *ctrl_tx_rgb_range;
256 struct v4l2_ctrl *ctrl_tx_edid_present;
257 struct v4l2_ctrl *ctrl_tx_hotplug;
258 struct v4l2_ctrl *ctrl_tx_rxsense;
260 struct v4l2_ctrl *ctrl_rx_power_present;
262 struct v4l2_ctrl *radio_tx_rds_pi;
263 struct v4l2_ctrl *radio_tx_rds_pty;
264 struct v4l2_ctrl *radio_tx_rds_mono_stereo;
265 struct v4l2_ctrl *radio_tx_rds_art_head;
266 struct v4l2_ctrl *radio_tx_rds_compressed;
267 struct v4l2_ctrl *radio_tx_rds_dyn_pty;
268 struct v4l2_ctrl *radio_tx_rds_ta;
269 struct v4l2_ctrl *radio_tx_rds_tp;
270 struct v4l2_ctrl *radio_tx_rds_ms;
271 struct v4l2_ctrl *radio_tx_rds_psname;
272 struct v4l2_ctrl *radio_tx_rds_radiotext;
274 struct v4l2_ctrl *radio_rx_rds_pty;
275 struct v4l2_ctrl *radio_rx_rds_ta;
276 struct v4l2_ctrl *radio_rx_rds_tp;
277 struct v4l2_ctrl *radio_rx_rds_ms;
278 struct v4l2_ctrl *radio_rx_rds_psname;
279 struct v4l2_ctrl *radio_rx_rds_radiotext;
281 unsigned input_brightness[MAX_INPUTS];
283 unsigned button_pressed;
288 bool vbi_cap_interlaced;
293 unsigned long video_pbase;
295 u32 video_buffer_size;
298 int display_byte_stride;
301 struct fb_info fb_info;
302 struct fb_var_screeninfo fb_defined;
303 struct fb_fix_screeninfo fb_fix;
305 /* Error injection */
306 bool queue_setup_error;
307 bool buf_prepare_error;
308 bool start_streaming_error;
310 bool req_validate_error;
313 u64 time_wrap_offset;
314 unsigned perc_dropped_buffers;
315 enum vivid_signal_mode std_signal_mode[MAX_INPUTS];
316 unsigned int query_std_last[MAX_INPUTS];
317 v4l2_std_id query_std[MAX_INPUTS];
318 enum tpg_video_aspect std_aspect_ratio[MAX_INPUTS];
320 enum vivid_signal_mode dv_timings_signal_mode[MAX_INPUTS];
321 char **query_dv_timings_qmenu;
322 char *query_dv_timings_qmenu_strings;
323 unsigned query_dv_timings_size;
324 unsigned int query_dv_timings_last[MAX_INPUTS];
325 unsigned int query_dv_timings[MAX_INPUTS];
326 enum tpg_video_aspect dv_timings_aspect_ratio[MAX_INPUTS];
330 v4l2_std_id std_cap[MAX_INPUTS];
331 struct v4l2_dv_timings dv_timings_cap[MAX_INPUTS];
332 int dv_timings_cap_sel[MAX_INPUTS];
334 struct vivid_vbi_gen_data vbi_gen;
336 unsigned edid_blocks;
337 unsigned edid_max_blocks;
338 unsigned webcam_size_idx;
339 unsigned webcam_ival_idx;
342 unsigned tv_field_cap;
343 unsigned tv_audio_input;
347 /* Capture Overlay */
348 struct v4l2_framebuffer fb_cap;
349 struct v4l2_fh *overlay_cap_owner;
351 int overlay_cap_top, overlay_cap_left;
352 enum v4l2_field overlay_cap_field;
354 struct v4l2_clip clips_cap[MAX_CLIPS];
355 struct v4l2_clip try_clips_cap[MAX_CLIPS];
356 unsigned clipcount_cap;
361 struct v4l2_dv_timings dv_timings_out;
365 u32 quantization_out;
368 unsigned bytesperline_out[TPG_MAX_PLANES];
369 unsigned tv_field_out;
370 unsigned tv_audio_output;
371 bool vbi_out_have_wss;
373 bool vbi_out_have_cc[2];
378 unsigned cur_scaled_line;
379 bool display_present[MAX_OUTPUTS];
383 bool overlay_out_enabled;
384 int overlay_out_top, overlay_out_left;
386 struct v4l2_clip clips_out[MAX_CLIPS];
387 struct v4l2_clip try_clips_out[MAX_CLIPS];
388 unsigned clipcount_out;
389 unsigned fbuf_out_flags;
396 bool must_blank[VIDEO_MAX_FRAME];
398 const struct vivid_fmt *fmt_cap;
399 struct v4l2_fract timeperframe_vid_cap;
400 enum v4l2_field field_cap;
401 struct v4l2_rect src_rect;
402 struct v4l2_rect fmt_cap_rect;
403 struct v4l2_rect crop_cap;
404 struct v4l2_rect compose_cap;
405 struct v4l2_rect crop_bounds_cap;
406 struct vb2_queue vb_vid_cap_q;
407 struct list_head vid_cap_active;
408 struct vb2_queue vb_vbi_cap_q;
409 struct list_head vbi_cap_active;
410 struct vb2_queue vb_meta_cap_q;
411 struct list_head meta_cap_active;
412 struct vb2_queue vb_touch_cap_q;
413 struct list_head touch_cap_active;
415 /* thread for generating video capture stream */
416 struct task_struct *kthread_vid_cap;
417 unsigned long jiffies_vid_cap;
418 u64 cap_stream_start;
419 u64 cap_frame_period;
420 u64 cap_frame_eof_offset;
424 u32 vid_cap_seq_start;
425 u32 vid_cap_seq_count;
426 bool vid_cap_streaming;
427 u32 vbi_cap_seq_start;
428 u32 vbi_cap_seq_count;
429 bool vbi_cap_streaming;
430 bool stream_sliced_vbi_cap;
431 u32 meta_cap_seq_start;
432 u32 meta_cap_seq_count;
433 bool meta_cap_streaming;
436 struct task_struct *kthread_touch_cap;
437 unsigned long jiffies_touch_cap;
438 u64 touch_cap_stream_start;
439 u32 touch_cap_seq_offset;
440 bool touch_cap_seq_resync;
441 u32 touch_cap_seq_start;
442 u32 touch_cap_seq_count;
443 bool touch_cap_streaming;
444 struct v4l2_fract timeperframe_tch_cap;
445 struct v4l2_pix_format tch_format;
449 const struct vivid_fmt *fmt_out;
450 struct v4l2_fract timeperframe_vid_out;
451 enum v4l2_field field_out;
452 struct v4l2_rect sink_rect;
453 struct v4l2_rect fmt_out_rect;
454 struct v4l2_rect crop_out;
455 struct v4l2_rect compose_out;
456 struct v4l2_rect compose_bounds_out;
457 struct vb2_queue vb_vid_out_q;
458 struct list_head vid_out_active;
459 struct vb2_queue vb_vbi_out_q;
460 struct list_head vbi_out_active;
461 struct vb2_queue vb_meta_out_q;
462 struct list_head meta_out_active;
464 /* video loop precalculated rectangles */
467 * Intersection between what the output side composes and the capture side
468 * crops. I.e., what actually needs to be copied from the output buffer to
469 * the capture buffer.
471 struct v4l2_rect loop_vid_copy;
472 /* The part of the output buffer that (after scaling) corresponds to loop_vid_copy. */
473 struct v4l2_rect loop_vid_out;
474 /* The part of the capture buffer that (after scaling) corresponds to loop_vid_copy. */
475 struct v4l2_rect loop_vid_cap;
477 * The intersection of the framebuffer, the overlay output window and
478 * loop_vid_copy. I.e., the part of the framebuffer that actually should be
479 * blended with the compose_out rectangle. This uses the framebuffer origin.
481 struct v4l2_rect loop_fb_copy;
482 /* The same as loop_fb_copy but with compose_out origin. */
483 struct v4l2_rect loop_vid_overlay;
485 * The part of the capture buffer that (after scaling) corresponds
486 * to loop_vid_overlay.
488 struct v4l2_rect loop_vid_overlay_cap;
490 /* thread for generating video output stream */
491 struct task_struct *kthread_vid_out;
492 unsigned long jiffies_vid_out;
496 u32 vid_out_seq_start;
497 u32 vid_out_seq_count;
498 bool vid_out_streaming;
499 u32 vbi_out_seq_start;
500 u32 vbi_out_seq_count;
501 bool vbi_out_streaming;
502 bool stream_sliced_vbi_out;
503 u32 meta_out_seq_start;
504 u32 meta_out_seq_count;
505 bool meta_out_streaming;
508 struct vb2_queue vb_sdr_cap_q;
509 struct list_head sdr_cap_active;
510 u32 sdr_pixelformat; /* v4l2 format id */
511 unsigned sdr_buffersize;
512 unsigned sdr_adc_freq;
513 unsigned sdr_fm_freq;
514 unsigned sdr_fm_deviation;
515 int sdr_fixp_src_phase;
516 int sdr_fixp_mod_phase;
518 bool tstamp_src_is_soe;
520 bool has_compose_cap;
523 bool has_compose_out;
526 /* thread for generating SDR stream */
527 struct task_struct *kthread_sdr_cap;
528 unsigned long jiffies_sdr_cap;
529 u32 sdr_cap_seq_offset;
530 u32 sdr_cap_seq_count;
531 bool sdr_cap_seq_resync;
534 struct vivid_rds_gen rds_gen;
537 unsigned radio_rx_freq;
538 unsigned radio_rx_audmode;
539 int radio_rx_sig_qual;
540 unsigned radio_rx_hw_seek_mode;
541 bool radio_rx_hw_seek_prog_lim;
542 bool radio_rx_rds_controls;
543 bool radio_rx_rds_enabled;
544 unsigned radio_rx_rds_use_alternates;
545 unsigned radio_rx_rds_last_block;
546 struct v4l2_fh *radio_rx_rds_owner;
548 /* Radio transmitter */
549 unsigned radio_tx_freq;
550 unsigned radio_tx_subchans;
551 bool radio_tx_rds_controls;
552 unsigned radio_tx_rds_last_block;
553 struct v4l2_fh *radio_tx_rds_owner;
555 /* Shared between radio receiver and transmitter */
557 ktime_t radio_rds_init_time;
560 struct cec_adapter *cec_rx_adap;
561 struct cec_adapter *cec_tx_adap[MAX_OUTPUTS];
562 struct workqueue_struct *cec_workqueue;
563 spinlock_t cec_slock;
564 struct list_head cec_work_list;
565 unsigned int cec_xfer_time_jiffies;
566 unsigned long cec_xfer_start_jiffies;
567 u8 cec_output2bus_map[MAX_OUTPUTS];
571 unsigned long osd_jiffies;
577 static inline bool vivid_is_webcam(const struct vivid_dev *dev)
579 return dev->input_type[dev->input] == WEBCAM;
582 static inline bool vivid_is_tv_cap(const struct vivid_dev *dev)
584 return dev->input_type[dev->input] == TV;
587 static inline bool vivid_is_svid_cap(const struct vivid_dev *dev)
589 return dev->input_type[dev->input] == SVID;
592 static inline bool vivid_is_hdmi_cap(const struct vivid_dev *dev)
594 return dev->input_type[dev->input] == HDMI;
597 static inline bool vivid_is_sdtv_cap(const struct vivid_dev *dev)
599 return vivid_is_tv_cap(dev) || vivid_is_svid_cap(dev);
602 static inline bool vivid_is_svid_out(const struct vivid_dev *dev)
604 return dev->output_type[dev->output] == SVID;
607 static inline bool vivid_is_hdmi_out(const struct vivid_dev *dev)
609 return dev->output_type[dev->output] == HDMI;
612 bool vivid_validate_fb(const struct v4l2_framebuffer *a);