1 /* 2 * Copyright (C) 2012 Avionic Design GmbH 3 * (C) Copyright 2008-2017 Fuzhou Rockchip Electronics Co., Ltd 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining a 6 * copy of this software and associated documentation files (the "Software"), 7 * to deal in the Software without restriction, including without limitation 8 * the rights to use, copy, modify, merge, publish, distribute, sub license, 9 * and/or sell copies of the Software, and to permit persons to whom the 10 * Software is furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice (including the 13 * next paragraph) shall be included in all copies or substantial portions 14 * of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 22 * DEALINGS IN THE SOFTWARE. 23 */ 24 25 #ifndef __LINUX_HDMI_H_ 26 #define __LINUX_HDMI_H_ 27 28 #include <linux/types.h> 29 #include <drm_modes.h> 30 31 enum hdmi_infoframe_type { 32 HDMI_INFOFRAME_TYPE_VENDOR = 0x81, 33 HDMI_INFOFRAME_TYPE_AVI = 0x82, 34 HDMI_INFOFRAME_TYPE_SPD = 0x83, 35 HDMI_INFOFRAME_TYPE_AUDIO = 0x84, 36 HDMI_INFOFRAME_TYPE_DRM = 0x87, 37 }; 38 39 #define HDMI_IEEE_OUI 0x000c03 40 #define HDMI_FORUM_IEEE_OUI 0xc45dd8 41 #define HDMI_INFOFRAME_HEADER_SIZE 4 42 #define HDMI_AVI_INFOFRAME_SIZE 13 43 #define HDMI_SPD_INFOFRAME_SIZE 25 44 #define HDMI_AUDIO_INFOFRAME_SIZE 10 45 46 #define HDMI_INFOFRAME_SIZE(type) \ 47 (HDMI_INFOFRAME_HEADER_SIZE + HDMI_ ## type ## _INFOFRAME_SIZE) 48 49 struct hdmi_any_infoframe { 50 enum hdmi_infoframe_type type; 51 unsigned char version; 52 unsigned char length; 53 }; 54 55 enum hdmi_colorspace { 56 HDMI_COLORSPACE_RGB, 57 HDMI_COLORSPACE_YUV422, 58 HDMI_COLORSPACE_YUV444, 59 HDMI_COLORSPACE_YUV420, 60 HDMI_COLORSPACE_RESERVED4, 61 HDMI_COLORSPACE_RESERVED5, 62 HDMI_COLORSPACE_RESERVED6, 63 HDMI_COLORSPACE_IDO_DEFINED, 64 }; 65 66 enum hdmi_scan_mode { 67 HDMI_SCAN_MODE_NONE, 68 HDMI_SCAN_MODE_OVERSCAN, 69 HDMI_SCAN_MODE_UNDERSCAN, 70 HDMI_SCAN_MODE_RESERVED, 71 }; 72 73 enum hdmi_colorimetry { 74 HDMI_COLORIMETRY_NONE, 75 HDMI_COLORIMETRY_ITU_601, 76 HDMI_COLORIMETRY_ITU_709, 77 HDMI_COLORIMETRY_EXTENDED, 78 }; 79 80 enum hdmi_picture_aspect { 81 HDMI_PICTURE_ASPECT_NONE, 82 HDMI_PICTURE_ASPECT_4_3, 83 HDMI_PICTURE_ASPECT_16_9, 84 HDMI_PICTURE_ASPECT_64_27, 85 HDMI_PICTURE_ASPECT_256_135, 86 HDMI_PICTURE_ASPECT_RESERVED, 87 }; 88 89 enum hdmi_active_aspect { 90 HDMI_ACTIVE_ASPECT_16_9_TOP = 2, 91 HDMI_ACTIVE_ASPECT_14_9_TOP = 3, 92 HDMI_ACTIVE_ASPECT_16_9_CENTER = 4, 93 HDMI_ACTIVE_ASPECT_PICTURE = 8, 94 HDMI_ACTIVE_ASPECT_4_3 = 9, 95 HDMI_ACTIVE_ASPECT_16_9 = 10, 96 HDMI_ACTIVE_ASPECT_14_9 = 11, 97 HDMI_ACTIVE_ASPECT_4_3_SP_14_9 = 13, 98 HDMI_ACTIVE_ASPECT_16_9_SP_14_9 = 14, 99 HDMI_ACTIVE_ASPECT_16_9_SP_4_3 = 15, 100 }; 101 102 enum hdmi_extended_colorimetry { 103 HDMI_EXTENDED_COLORIMETRY_XV_YCC_601, 104 HDMI_EXTENDED_COLORIMETRY_XV_YCC_709, 105 HDMI_EXTENDED_COLORIMETRY_S_YCC_601, 106 HDMI_EXTENDED_COLORIMETRY_ADOBE_YCC_601, 107 HDMI_EXTENDED_COLORIMETRY_ADOBE_RGB, 108 109 /* The following EC values are only defined in CEA-861-F. */ 110 HDMI_EXTENDED_COLORIMETRY_BT2020_CONST_LUM, 111 HDMI_EXTENDED_COLORIMETRY_BT2020, 112 HDMI_EXTENDED_COLORIMETRY_RESERVED, 113 }; 114 115 enum hdmi_quantization_range { 116 HDMI_QUANTIZATION_RANGE_DEFAULT, 117 HDMI_QUANTIZATION_RANGE_LIMITED, 118 HDMI_QUANTIZATION_RANGE_FULL, 119 HDMI_QUANTIZATION_RANGE_RESERVED, 120 }; 121 122 /* non-uniform picture scaling */ 123 enum hdmi_nups { 124 HDMI_NUPS_UNKNOWN, 125 HDMI_NUPS_HORIZONTAL, 126 HDMI_NUPS_VERTICAL, 127 HDMI_NUPS_BOTH, 128 }; 129 130 enum hdmi_ycc_quantization_range { 131 HDMI_YCC_QUANTIZATION_RANGE_LIMITED, 132 HDMI_YCC_QUANTIZATION_RANGE_FULL, 133 }; 134 135 enum hdmi_content_type { 136 HDMI_CONTENT_TYPE_GRAPHICS, 137 HDMI_CONTENT_TYPE_PHOTO, 138 HDMI_CONTENT_TYPE_CINEMA, 139 HDMI_CONTENT_TYPE_GAME, 140 }; 141 142 struct hdmi_avi_infoframe { 143 enum hdmi_infoframe_type type; 144 unsigned char version; 145 unsigned char length; 146 enum hdmi_colorspace colorspace; 147 enum hdmi_scan_mode scan_mode; 148 enum hdmi_colorimetry colorimetry; 149 enum hdmi_picture_aspect picture_aspect; 150 enum hdmi_active_aspect active_aspect; 151 bool itc; 152 enum hdmi_extended_colorimetry extended_colorimetry; 153 enum hdmi_quantization_range quantization_range; 154 enum hdmi_nups nups; 155 unsigned char video_code; 156 enum hdmi_ycc_quantization_range ycc_quantization_range; 157 enum hdmi_content_type content_type; 158 unsigned char pixel_repeat; 159 unsigned short top_bar; 160 unsigned short bottom_bar; 161 unsigned short left_bar; 162 unsigned short right_bar; 163 }; 164 165 struct hdmi_drm_infoframe { 166 enum hdmi_infoframe_type type; 167 unsigned char version; 168 unsigned char length; 169 uint16_t eotf; 170 uint16_t metadata_type; 171 uint16_t display_primaries_x[3]; 172 uint16_t display_primaries_y[3]; 173 uint16_t white_point_x; 174 uint16_t white_point_y; 175 uint16_t max_mastering_display_luminance; 176 uint16_t min_mastering_display_luminance; 177 uint16_t max_fall; 178 uint16_t max_cll; 179 uint16_t min_cll; 180 }; 181 182 int hdmi_avi_infoframe_init(struct hdmi_avi_infoframe *frame); 183 ssize_t hdmi_avi_infoframe_pack(struct hdmi_avi_infoframe *frame, void *buffer, 184 size_t size); 185 186 int hdmi_drm_infoframe_init(struct hdmi_drm_infoframe *frame); 187 188 enum hdmi_spd_sdi { 189 HDMI_SPD_SDI_UNKNOWN, 190 HDMI_SPD_SDI_DSTB, 191 HDMI_SPD_SDI_DVDP, 192 HDMI_SPD_SDI_DVHS, 193 HDMI_SPD_SDI_HDDVR, 194 HDMI_SPD_SDI_DVC, 195 HDMI_SPD_SDI_DSC, 196 HDMI_SPD_SDI_VCD, 197 HDMI_SPD_SDI_GAME, 198 HDMI_SPD_SDI_PC, 199 HDMI_SPD_SDI_BD, 200 HDMI_SPD_SDI_SACD, 201 HDMI_SPD_SDI_HDDVD, 202 HDMI_SPD_SDI_PMP, 203 }; 204 205 struct hdmi_spd_infoframe { 206 enum hdmi_infoframe_type type; 207 unsigned char version; 208 unsigned char length; 209 char vendor[8]; 210 char product[16]; 211 enum hdmi_spd_sdi sdi; 212 }; 213 214 int hdmi_spd_infoframe_init(struct hdmi_spd_infoframe *frame, 215 const char *vendor, const char *product); 216 ssize_t hdmi_spd_infoframe_pack(struct hdmi_spd_infoframe *frame, void *buffer, 217 size_t size); 218 219 enum hdmi_audio_coding_type { 220 HDMI_AUDIO_CODING_TYPE_STREAM, 221 HDMI_AUDIO_CODING_TYPE_PCM, 222 HDMI_AUDIO_CODING_TYPE_AC3, 223 HDMI_AUDIO_CODING_TYPE_MPEG1, 224 HDMI_AUDIO_CODING_TYPE_MP3, 225 HDMI_AUDIO_CODING_TYPE_MPEG2, 226 HDMI_AUDIO_CODING_TYPE_AAC_LC, 227 HDMI_AUDIO_CODING_TYPE_DTS, 228 HDMI_AUDIO_CODING_TYPE_ATRAC, 229 HDMI_AUDIO_CODING_TYPE_DSD, 230 HDMI_AUDIO_CODING_TYPE_EAC3, 231 HDMI_AUDIO_CODING_TYPE_DTS_HD, 232 HDMI_AUDIO_CODING_TYPE_MLP, 233 HDMI_AUDIO_CODING_TYPE_DST, 234 HDMI_AUDIO_CODING_TYPE_WMA_PRO, 235 HDMI_AUDIO_CODING_TYPE_CXT, 236 }; 237 238 enum hdmi_audio_sample_size { 239 HDMI_AUDIO_SAMPLE_SIZE_STREAM, 240 HDMI_AUDIO_SAMPLE_SIZE_16, 241 HDMI_AUDIO_SAMPLE_SIZE_20, 242 HDMI_AUDIO_SAMPLE_SIZE_24, 243 }; 244 245 enum hdmi_audio_sample_frequency { 246 HDMI_AUDIO_SAMPLE_FREQUENCY_STREAM, 247 HDMI_AUDIO_SAMPLE_FREQUENCY_32000, 248 HDMI_AUDIO_SAMPLE_FREQUENCY_44100, 249 HDMI_AUDIO_SAMPLE_FREQUENCY_48000, 250 HDMI_AUDIO_SAMPLE_FREQUENCY_88200, 251 HDMI_AUDIO_SAMPLE_FREQUENCY_96000, 252 HDMI_AUDIO_SAMPLE_FREQUENCY_176400, 253 HDMI_AUDIO_SAMPLE_FREQUENCY_192000, 254 }; 255 256 enum hdmi_audio_coding_type_ext { 257 /* Refer to Audio Coding Type (CT) field in Data Byte 1 */ 258 HDMI_AUDIO_CODING_TYPE_EXT_CT, 259 260 /* 261 * The next three CXT values are defined in CEA-861-E only. 262 * They do not exist in older versions, and in CEA-861-F they are 263 * defined as 'Not in use'. 264 */ 265 HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC, 266 HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC_V2, 267 HDMI_AUDIO_CODING_TYPE_EXT_MPEG_SURROUND, 268 269 /* The following CXT values are only defined in CEA-861-F. */ 270 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC, 271 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_V2, 272 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC, 273 HDMI_AUDIO_CODING_TYPE_EXT_DRA, 274 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_SURROUND, 275 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC_SURROUND = 10, 276 }; 277 278 struct hdmi_audio_infoframe { 279 enum hdmi_infoframe_type type; 280 unsigned char version; 281 unsigned char length; 282 unsigned char channels; 283 enum hdmi_audio_coding_type coding_type; 284 enum hdmi_audio_sample_size sample_size; 285 enum hdmi_audio_sample_frequency sample_frequency; 286 enum hdmi_audio_coding_type_ext coding_type_ext; 287 unsigned char channel_allocation; 288 unsigned char level_shift_value; 289 bool downmix_inhibit; 290 291 }; 292 293 int hdmi_audio_infoframe_init(struct hdmi_audio_infoframe *frame); 294 ssize_t hdmi_audio_infoframe_pack(struct hdmi_audio_infoframe *frame, 295 void *buffer, size_t size); 296 297 enum hdmi_3d_structure { 298 HDMI_3D_STRUCTURE_INVALID = -1, 299 HDMI_3D_STRUCTURE_FRAME_PACKING = 0, 300 HDMI_3D_STRUCTURE_FIELD_ALTERNATIVE, 301 HDMI_3D_STRUCTURE_LINE_ALTERNATIVE, 302 HDMI_3D_STRUCTURE_SIDE_BY_SIDE_FULL, 303 HDMI_3D_STRUCTURE_L_DEPTH, 304 HDMI_3D_STRUCTURE_L_DEPTH_GFX_GFX_DEPTH, 305 HDMI_3D_STRUCTURE_TOP_AND_BOTTOM, 306 HDMI_3D_STRUCTURE_SIDE_BY_SIDE_HALF = 8, 307 }; 308 309 struct hdmi_vendor_infoframe { 310 enum hdmi_infoframe_type type; 311 unsigned char version; 312 unsigned char length; 313 unsigned int oui; 314 u8 vic; 315 enum hdmi_3d_structure s3d_struct; 316 unsigned int s3d_ext_data; 317 }; 318 319 int hdmi_vendor_infoframe_init(struct hdmi_vendor_infoframe *frame); 320 ssize_t hdmi_vendor_infoframe_pack(struct hdmi_vendor_infoframe *frame, 321 void *buffer, size_t size); 322 323 union hdmi_vendor_any_infoframe { 324 struct { 325 enum hdmi_infoframe_type type; 326 unsigned char version; 327 unsigned char length; 328 unsigned int oui; 329 } any; 330 struct hdmi_vendor_infoframe hdmi; 331 }; 332 333 /** 334 * union hdmi_infoframe: overall union of all abstract infoframe representations 335 * @any: generic infoframe 336 * @avi: avi infoframe 337 * @spd: spd infoframe 338 * @vendor: union of all vendor infoframes 339 * @audio: audio infoframe 340 * 341 * This is used by the generic pack function. This works since all infoframes 342 * have the same header which also indicates which type of infoframe should be 343 * packed. 344 */ 345 union hdmi_infoframe { 346 struct hdmi_any_infoframe any; 347 struct hdmi_avi_infoframe avi; 348 struct hdmi_spd_infoframe spd; 349 union hdmi_vendor_any_infoframe vendor; 350 struct hdmi_audio_infoframe audio; 351 struct hdmi_drm_infoframe drm; 352 }; 353 354 ssize_t 355 hdmi_infoframe_pack(union hdmi_infoframe *frame, void *buffer, size_t size); 356 int hdmi_infoframe_unpack(union hdmi_infoframe *frame, void *buffer); 357 358 ssize_t hdmi_vendor_infoframe_pack(struct hdmi_vendor_infoframe *frame, 359 void *buffer, size_t size); 360 int 361 drm_hdmi_vendor_infoframe_from_display_mode(struct hdmi_vendor_infoframe *frame, 362 struct drm_display_mode *mode); 363 ssize_t hdmi_avi_infoframe_pack_only(const struct hdmi_avi_infoframe *frame, 364 void *buffer, size_t size); 365 int 366 drm_hdmi_avi_infoframe_from_display_mode(struct hdmi_avi_infoframe *frame, 367 struct drm_display_mode *mode, 368 bool is_hdmi2_sink); 369 void 370 drm_hdmi_avi_infoframe_quant_range(struct hdmi_avi_infoframe *frame, 371 struct drm_display_mode *mode, 372 enum hdmi_quantization_range rgb_quant_range, 373 bool rgb_quant_range_selectable); 374 u8 drm_match_cea_mode(struct drm_display_mode *to_match); 375 376 #endif /* _DRM_HDMI_H */ 377