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