vivid-core.h (17052B)
1/* SPDX-License-Identifier: GPL-2.0-only */ 2/* 3 * vivid-core.h - core datastructures 4 * 5 * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved. 6 */ 7 8#ifndef _VIVID_CORE_H_ 9#define _VIVID_CORE_H_ 10 11#include <linux/fb.h> 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" 21 22#define dprintk(dev, level, fmt, arg...) \ 23 v4l2_dbg(level, vivid_debug, &dev->v4l2_dev, fmt, ## arg) 24 25/* The maximum number of clip rectangles */ 26#define MAX_CLIPS 16 27/* The maximum number of inputs */ 28#define MAX_INPUTS 16 29/* The maximum number of outputs */ 30#define MAX_OUTPUTS 16 31/* The maximum up or down scaling factor is 4 */ 32#define MAX_ZOOM 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 */ 37#define MIN_WIDTH 16 38#define MIN_HEIGHT 16 39/* The data_offset of plane 0 for the multiplanar formats */ 40#define PLANE0_DATA_OFFSET 128 41 42/* The supported TV frequency range in MHz */ 43#define MIN_TV_FREQ (44U * 16U) 44#define MAX_TV_FREQ (958U * 16U) 45 46/* The number of samples returned in every SDR buffer */ 47#define SDR_CAP_SAMPLES_PER_BUF 0x4000 48 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)) 52 53extern const struct v4l2_rect vivid_min_rect; 54extern const struct v4l2_rect vivid_max_rect; 55extern unsigned vivid_debug; 56 57struct vivid_fmt { 58 u32 fourcc; /* v4l2 format id */ 59 enum tgp_color_enc color_enc; 60 bool can_do_overlay; 61 u8 vdownsampling[TPG_MAX_PLANES]; 62 u32 alpha_mask; 63 u8 planes; 64 u8 buffers; 65 u32 data_offset[TPG_MAX_PLANES]; 66 u32 bit_depth[TPG_MAX_PLANES]; 67}; 68 69extern struct vivid_fmt vivid_formats[]; 70 71/* buffer for one video frame */ 72struct vivid_buffer { 73 /* common v4l buffer stuff -- must be first */ 74 struct vb2_v4l2_buffer vb; 75 struct list_head list; 76}; 77 78enum vivid_input { 79 WEBCAM, 80 TV, 81 SVID, 82 HDMI, 83}; 84 85enum vivid_signal_mode { 86 CURRENT_DV_TIMINGS, 87 CURRENT_STD = CURRENT_DV_TIMINGS, 88 NO_SIGNAL, 89 NO_LOCK, 90 OUT_OF_RANGE, 91 SELECTED_DV_TIMINGS, 92 SELECTED_STD = SELECTED_DV_TIMINGS, 93 CYCLE_DV_TIMINGS, 94 CYCLE_STD = CYCLE_DV_TIMINGS, 95 CUSTOM_DV_TIMINGS, 96}; 97 98enum vivid_colorspace { 99 VIVID_CS_170M, 100 VIVID_CS_709, 101 VIVID_CS_SRGB, 102 VIVID_CS_OPRGB, 103 VIVID_CS_2020, 104 VIVID_CS_DCI_P3, 105 VIVID_CS_240M, 106 VIVID_CS_SYS_M, 107 VIVID_CS_SYS_BG, 108}; 109 110#define VIVID_INVALID_SIGNAL(mode) \ 111 ((mode) == NO_SIGNAL || (mode) == NO_LOCK || (mode) == OUT_OF_RANGE) 112 113struct vivid_cec_xfer { 114 struct cec_adapter *adap; 115 u8 msg[CEC_MAX_MSG_SIZE]; 116 u32 len; 117 u32 sft; 118}; 119 120struct vivid_dev { 121 unsigned inst; 122 struct v4l2_device v4l2_dev; 123#ifdef CONFIG_MEDIA_CONTROLLER 124 struct media_device mdev; 125 struct media_pad vid_cap_pad; 126 struct media_pad vid_out_pad; 127 struct media_pad vbi_cap_pad; 128 struct media_pad vbi_out_pad; 129 struct media_pad sdr_cap_pad; 130 struct media_pad meta_cap_pad; 131 struct media_pad meta_out_pad; 132 struct media_pad touch_cap_pad; 133#endif 134 struct v4l2_ctrl_handler ctrl_hdl_user_gen; 135 struct v4l2_ctrl_handler ctrl_hdl_user_vid; 136 struct v4l2_ctrl_handler ctrl_hdl_user_aud; 137 struct v4l2_ctrl_handler ctrl_hdl_streaming; 138 struct v4l2_ctrl_handler ctrl_hdl_sdtv_cap; 139 struct v4l2_ctrl_handler ctrl_hdl_loop_cap; 140 struct v4l2_ctrl_handler ctrl_hdl_fb; 141 struct video_device vid_cap_dev; 142 struct v4l2_ctrl_handler ctrl_hdl_vid_cap; 143 struct video_device vid_out_dev; 144 struct v4l2_ctrl_handler ctrl_hdl_vid_out; 145 struct video_device vbi_cap_dev; 146 struct v4l2_ctrl_handler ctrl_hdl_vbi_cap; 147 struct video_device vbi_out_dev; 148 struct v4l2_ctrl_handler ctrl_hdl_vbi_out; 149 struct video_device radio_rx_dev; 150 struct v4l2_ctrl_handler ctrl_hdl_radio_rx; 151 struct video_device radio_tx_dev; 152 struct v4l2_ctrl_handler ctrl_hdl_radio_tx; 153 struct video_device sdr_cap_dev; 154 struct v4l2_ctrl_handler ctrl_hdl_sdr_cap; 155 struct video_device meta_cap_dev; 156 struct v4l2_ctrl_handler ctrl_hdl_meta_cap; 157 struct video_device meta_out_dev; 158 struct v4l2_ctrl_handler ctrl_hdl_meta_out; 159 struct video_device touch_cap_dev; 160 struct v4l2_ctrl_handler ctrl_hdl_touch_cap; 161 162 spinlock_t slock; 163 struct mutex mutex; 164 165 /* capabilities */ 166 u32 vid_cap_caps; 167 u32 vid_out_caps; 168 u32 vbi_cap_caps; 169 u32 vbi_out_caps; 170 u32 sdr_cap_caps; 171 u32 radio_rx_caps; 172 u32 radio_tx_caps; 173 u32 meta_cap_caps; 174 u32 meta_out_caps; 175 u32 touch_cap_caps; 176 177 /* supported features */ 178 bool multiplanar; 179 unsigned num_inputs; 180 unsigned int num_hdmi_inputs; 181 u8 input_type[MAX_INPUTS]; 182 u8 input_name_counter[MAX_INPUTS]; 183 unsigned num_outputs; 184 unsigned int num_hdmi_outputs; 185 u8 output_type[MAX_OUTPUTS]; 186 u8 output_name_counter[MAX_OUTPUTS]; 187 bool has_audio_inputs; 188 bool has_audio_outputs; 189 bool has_vid_cap; 190 bool has_vid_out; 191 bool has_vbi_cap; 192 bool has_raw_vbi_cap; 193 bool has_sliced_vbi_cap; 194 bool has_vbi_out; 195 bool has_raw_vbi_out; 196 bool has_sliced_vbi_out; 197 bool has_radio_rx; 198 bool has_radio_tx; 199 bool has_sdr_cap; 200 bool has_fb; 201 bool has_meta_cap; 202 bool has_meta_out; 203 bool has_tv_tuner; 204 bool has_touch_cap; 205 206 bool can_loop_video; 207 208 /* controls */ 209 struct v4l2_ctrl *brightness; 210 struct v4l2_ctrl *contrast; 211 struct v4l2_ctrl *saturation; 212 struct v4l2_ctrl *hue; 213 struct { 214 /* autogain/gain cluster */ 215 struct v4l2_ctrl *autogain; 216 struct v4l2_ctrl *gain; 217 }; 218 struct v4l2_ctrl *volume; 219 struct v4l2_ctrl *mute; 220 struct v4l2_ctrl *alpha; 221 struct v4l2_ctrl *button; 222 struct v4l2_ctrl *boolean; 223 struct v4l2_ctrl *int32; 224 struct v4l2_ctrl *int64; 225 struct v4l2_ctrl *menu; 226 struct v4l2_ctrl *string; 227 struct v4l2_ctrl *bitmask; 228 struct v4l2_ctrl *int_menu; 229 struct v4l2_ctrl *ro_int32; 230 struct v4l2_ctrl *test_pattern; 231 struct v4l2_ctrl *colorspace; 232 struct v4l2_ctrl *rgb_range_cap; 233 struct v4l2_ctrl *real_rgb_range_cap; 234 struct { 235 /* std_signal_mode/standard cluster */ 236 struct v4l2_ctrl *ctrl_std_signal_mode; 237 struct v4l2_ctrl *ctrl_standard; 238 }; 239 struct { 240 /* dv_timings_signal_mode/timings cluster */ 241 struct v4l2_ctrl *ctrl_dv_timings_signal_mode; 242 struct v4l2_ctrl *ctrl_dv_timings; 243 }; 244 struct v4l2_ctrl *ctrl_display_present; 245 struct v4l2_ctrl *ctrl_has_crop_cap; 246 struct v4l2_ctrl *ctrl_has_compose_cap; 247 struct v4l2_ctrl *ctrl_has_scaler_cap; 248 struct v4l2_ctrl *ctrl_has_crop_out; 249 struct v4l2_ctrl *ctrl_has_compose_out; 250 struct v4l2_ctrl *ctrl_has_scaler_out; 251 struct v4l2_ctrl *ctrl_tx_mode; 252 struct v4l2_ctrl *ctrl_tx_rgb_range; 253 struct v4l2_ctrl *ctrl_tx_edid_present; 254 struct v4l2_ctrl *ctrl_tx_hotplug; 255 struct v4l2_ctrl *ctrl_tx_rxsense; 256 257 struct v4l2_ctrl *ctrl_rx_power_present; 258 259 struct v4l2_ctrl *radio_tx_rds_pi; 260 struct v4l2_ctrl *radio_tx_rds_pty; 261 struct v4l2_ctrl *radio_tx_rds_mono_stereo; 262 struct v4l2_ctrl *radio_tx_rds_art_head; 263 struct v4l2_ctrl *radio_tx_rds_compressed; 264 struct v4l2_ctrl *radio_tx_rds_dyn_pty; 265 struct v4l2_ctrl *radio_tx_rds_ta; 266 struct v4l2_ctrl *radio_tx_rds_tp; 267 struct v4l2_ctrl *radio_tx_rds_ms; 268 struct v4l2_ctrl *radio_tx_rds_psname; 269 struct v4l2_ctrl *radio_tx_rds_radiotext; 270 271 struct v4l2_ctrl *radio_rx_rds_pty; 272 struct v4l2_ctrl *radio_rx_rds_ta; 273 struct v4l2_ctrl *radio_rx_rds_tp; 274 struct v4l2_ctrl *radio_rx_rds_ms; 275 struct v4l2_ctrl *radio_rx_rds_psname; 276 struct v4l2_ctrl *radio_rx_rds_radiotext; 277 278 unsigned input_brightness[MAX_INPUTS]; 279 unsigned osd_mode; 280 unsigned button_pressed; 281 bool sensor_hflip; 282 bool sensor_vflip; 283 bool hflip; 284 bool vflip; 285 bool vbi_cap_interlaced; 286 bool loop_video; 287 bool reduced_fps; 288 289 /* Framebuffer */ 290 unsigned long video_pbase; 291 void *video_vbase; 292 u32 video_buffer_size; 293 int display_width; 294 int display_height; 295 int display_byte_stride; 296 int bits_per_pixel; 297 int bytes_per_pixel; 298 struct fb_info fb_info; 299 struct fb_var_screeninfo fb_defined; 300 struct fb_fix_screeninfo fb_fix; 301 302 /* Error injection */ 303 bool disconnect_error; 304 bool queue_setup_error; 305 bool buf_prepare_error; 306 bool start_streaming_error; 307 bool dqbuf_error; 308 bool req_validate_error; 309 bool seq_wrap; 310 u64 time_wrap; 311 u64 time_wrap_offset; 312 unsigned perc_dropped_buffers; 313 enum vivid_signal_mode std_signal_mode[MAX_INPUTS]; 314 unsigned int query_std_last[MAX_INPUTS]; 315 v4l2_std_id query_std[MAX_INPUTS]; 316 enum tpg_video_aspect std_aspect_ratio[MAX_INPUTS]; 317 318 enum vivid_signal_mode dv_timings_signal_mode[MAX_INPUTS]; 319 char **query_dv_timings_qmenu; 320 char *query_dv_timings_qmenu_strings; 321 unsigned query_dv_timings_size; 322 unsigned int query_dv_timings_last[MAX_INPUTS]; 323 unsigned int query_dv_timings[MAX_INPUTS]; 324 enum tpg_video_aspect dv_timings_aspect_ratio[MAX_INPUTS]; 325 326 /* Input */ 327 unsigned input; 328 v4l2_std_id std_cap[MAX_INPUTS]; 329 struct v4l2_dv_timings dv_timings_cap[MAX_INPUTS]; 330 int dv_timings_cap_sel[MAX_INPUTS]; 331 u32 service_set_cap; 332 struct vivid_vbi_gen_data vbi_gen; 333 u8 *edid; 334 unsigned edid_blocks; 335 unsigned edid_max_blocks; 336 unsigned webcam_size_idx; 337 unsigned webcam_ival_idx; 338 unsigned tv_freq; 339 unsigned tv_audmode; 340 unsigned tv_field_cap; 341 unsigned tv_audio_input; 342 343 u32 power_present; 344 345 /* Capture Overlay */ 346 struct v4l2_framebuffer fb_cap; 347 struct v4l2_fh *overlay_cap_owner; 348 void *fb_vbase_cap; 349 int overlay_cap_top, overlay_cap_left; 350 enum v4l2_field overlay_cap_field; 351 void *bitmap_cap; 352 struct v4l2_clip clips_cap[MAX_CLIPS]; 353 struct v4l2_clip try_clips_cap[MAX_CLIPS]; 354 unsigned clipcount_cap; 355 356 /* Output */ 357 unsigned output; 358 v4l2_std_id std_out; 359 struct v4l2_dv_timings dv_timings_out; 360 u32 colorspace_out; 361 u32 ycbcr_enc_out; 362 u32 hsv_enc_out; 363 u32 quantization_out; 364 u32 xfer_func_out; 365 u32 service_set_out; 366 unsigned bytesperline_out[TPG_MAX_PLANES]; 367 unsigned tv_field_out; 368 unsigned tv_audio_output; 369 bool vbi_out_have_wss; 370 u8 vbi_out_wss[2]; 371 bool vbi_out_have_cc[2]; 372 u8 vbi_out_cc[2][2]; 373 bool dvi_d_out; 374 u8 *scaled_line; 375 u8 *blended_line; 376 unsigned cur_scaled_line; 377 bool display_present[MAX_OUTPUTS]; 378 379 /* Output Overlay */ 380 void *fb_vbase_out; 381 bool overlay_out_enabled; 382 int overlay_out_top, overlay_out_left; 383 void *bitmap_out; 384 struct v4l2_clip clips_out[MAX_CLIPS]; 385 struct v4l2_clip try_clips_out[MAX_CLIPS]; 386 unsigned clipcount_out; 387 unsigned fbuf_out_flags; 388 u32 chromakey_out; 389 u8 global_alpha_out; 390 391 /* video capture */ 392 struct tpg_data tpg; 393 unsigned ms_vid_cap; 394 bool must_blank[VIDEO_MAX_FRAME]; 395 396 const struct vivid_fmt *fmt_cap; 397 struct v4l2_fract timeperframe_vid_cap; 398 enum v4l2_field field_cap; 399 struct v4l2_rect src_rect; 400 struct v4l2_rect fmt_cap_rect; 401 struct v4l2_rect crop_cap; 402 struct v4l2_rect compose_cap; 403 struct v4l2_rect crop_bounds_cap; 404 struct vb2_queue vb_vid_cap_q; 405 struct list_head vid_cap_active; 406 struct vb2_queue vb_vbi_cap_q; 407 struct list_head vbi_cap_active; 408 struct vb2_queue vb_meta_cap_q; 409 struct list_head meta_cap_active; 410 struct vb2_queue vb_touch_cap_q; 411 struct list_head touch_cap_active; 412 413 /* thread for generating video capture stream */ 414 struct task_struct *kthread_vid_cap; 415 unsigned long jiffies_vid_cap; 416 u64 cap_stream_start; 417 u64 cap_frame_period; 418 u64 cap_frame_eof_offset; 419 u32 cap_seq_offset; 420 u32 cap_seq_count; 421 bool cap_seq_resync; 422 u32 vid_cap_seq_start; 423 u32 vid_cap_seq_count; 424 bool vid_cap_streaming; 425 u32 vbi_cap_seq_start; 426 u32 vbi_cap_seq_count; 427 bool vbi_cap_streaming; 428 u32 meta_cap_seq_start; 429 u32 meta_cap_seq_count; 430 bool meta_cap_streaming; 431 432 /* Touch capture */ 433 struct task_struct *kthread_touch_cap; 434 unsigned long jiffies_touch_cap; 435 u64 touch_cap_stream_start; 436 u32 touch_cap_seq_offset; 437 bool touch_cap_seq_resync; 438 u32 touch_cap_seq_start; 439 u32 touch_cap_seq_count; 440 u32 touch_cap_with_seq_wrap_count; 441 bool touch_cap_streaming; 442 struct v4l2_fract timeperframe_tch_cap; 443 struct v4l2_pix_format tch_format; 444 int tch_pat_random; 445 446 /* video output */ 447 const struct vivid_fmt *fmt_out; 448 struct v4l2_fract timeperframe_vid_out; 449 enum v4l2_field field_out; 450 struct v4l2_rect sink_rect; 451 struct v4l2_rect fmt_out_rect; 452 struct v4l2_rect crop_out; 453 struct v4l2_rect compose_out; 454 struct v4l2_rect compose_bounds_out; 455 struct vb2_queue vb_vid_out_q; 456 struct list_head vid_out_active; 457 struct vb2_queue vb_vbi_out_q; 458 struct list_head vbi_out_active; 459 struct vb2_queue vb_meta_out_q; 460 struct list_head meta_out_active; 461 462 /* video loop precalculated rectangles */ 463 464 /* 465 * Intersection between what the output side composes and the capture side 466 * crops. I.e., what actually needs to be copied from the output buffer to 467 * the capture buffer. 468 */ 469 struct v4l2_rect loop_vid_copy; 470 /* The part of the output buffer that (after scaling) corresponds to loop_vid_copy. */ 471 struct v4l2_rect loop_vid_out; 472 /* The part of the capture buffer that (after scaling) corresponds to loop_vid_copy. */ 473 struct v4l2_rect loop_vid_cap; 474 /* 475 * The intersection of the framebuffer, the overlay output window and 476 * loop_vid_copy. I.e., the part of the framebuffer that actually should be 477 * blended with the compose_out rectangle. This uses the framebuffer origin. 478 */ 479 struct v4l2_rect loop_fb_copy; 480 /* The same as loop_fb_copy but with compose_out origin. */ 481 struct v4l2_rect loop_vid_overlay; 482 /* 483 * The part of the capture buffer that (after scaling) corresponds 484 * to loop_vid_overlay. 485 */ 486 struct v4l2_rect loop_vid_overlay_cap; 487 488 /* thread for generating video output stream */ 489 struct task_struct *kthread_vid_out; 490 unsigned long jiffies_vid_out; 491 u32 out_seq_offset; 492 u32 out_seq_count; 493 bool out_seq_resync; 494 u32 vid_out_seq_start; 495 u32 vid_out_seq_count; 496 bool vid_out_streaming; 497 u32 vbi_out_seq_start; 498 u32 vbi_out_seq_count; 499 bool vbi_out_streaming; 500 bool stream_sliced_vbi_out; 501 u32 meta_out_seq_start; 502 u32 meta_out_seq_count; 503 bool meta_out_streaming; 504 505 /* SDR capture */ 506 struct vb2_queue vb_sdr_cap_q; 507 struct list_head sdr_cap_active; 508 u32 sdr_pixelformat; /* v4l2 format id */ 509 unsigned sdr_buffersize; 510 unsigned sdr_adc_freq; 511 unsigned sdr_fm_freq; 512 unsigned sdr_fm_deviation; 513 int sdr_fixp_src_phase; 514 int sdr_fixp_mod_phase; 515 516 bool tstamp_src_is_soe; 517 bool has_crop_cap; 518 bool has_compose_cap; 519 bool has_scaler_cap; 520 bool has_crop_out; 521 bool has_compose_out; 522 bool has_scaler_out; 523 524 /* thread for generating SDR stream */ 525 struct task_struct *kthread_sdr_cap; 526 unsigned long jiffies_sdr_cap; 527 u32 sdr_cap_seq_offset; 528 u32 sdr_cap_seq_start; 529 u32 sdr_cap_seq_count; 530 u32 sdr_cap_with_seq_wrap_count; 531 bool sdr_cap_seq_resync; 532 533 /* RDS generator */ 534 struct vivid_rds_gen rds_gen; 535 536 /* Radio receiver */ 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; 547 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; 554 555 /* Shared between radio receiver and transmitter */ 556 bool radio_rds_loop; 557 ktime_t radio_rds_init_time; 558 559 /* CEC */ 560 struct cec_adapter *cec_rx_adap; 561 struct cec_adapter *cec_tx_adap[MAX_OUTPUTS]; 562 u8 cec_output2bus_map[MAX_OUTPUTS]; 563 struct task_struct *kthread_cec; 564 wait_queue_head_t kthread_waitq_cec; 565 struct vivid_cec_xfer xfers[MAX_OUTPUTS]; 566 spinlock_t cec_xfers_slock; /* read and write cec messages */ 567 u32 cec_sft; /* bus signal free time, in bit periods */ 568 u8 last_initiator; 569 570 /* CEC OSD String */ 571 char osd[14]; 572 unsigned long osd_jiffies; 573 574 bool meta_pts; 575 bool meta_scr; 576}; 577 578static inline bool vivid_is_webcam(const struct vivid_dev *dev) 579{ 580 return dev->input_type[dev->input] == WEBCAM; 581} 582 583static inline bool vivid_is_tv_cap(const struct vivid_dev *dev) 584{ 585 return dev->input_type[dev->input] == TV; 586} 587 588static inline bool vivid_is_svid_cap(const struct vivid_dev *dev) 589{ 590 return dev->input_type[dev->input] == SVID; 591} 592 593static inline bool vivid_is_hdmi_cap(const struct vivid_dev *dev) 594{ 595 return dev->input_type[dev->input] == HDMI; 596} 597 598static inline bool vivid_is_sdtv_cap(const struct vivid_dev *dev) 599{ 600 return vivid_is_tv_cap(dev) || vivid_is_svid_cap(dev); 601} 602 603static inline bool vivid_is_svid_out(const struct vivid_dev *dev) 604{ 605 return dev->output_type[dev->output] == SVID; 606} 607 608static inline bool vivid_is_hdmi_out(const struct vivid_dev *dev) 609{ 610 return dev->output_type[dev->output] == HDMI; 611} 612 613#endif