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 }; 51 52 #define HDMI_IEEE_OUI 0x000c03 53 #define HDMI_FORUM_IEEE_OUI 0xc45dd8 54 #define HDMI_INFOFRAME_HEADER_SIZE 4 55 #define HDMI_AVI_INFOFRAME_SIZE 13 56 #define HDMI_SPD_INFOFRAME_SIZE 25 57 #define HDMI_AUDIO_INFOFRAME_SIZE 10 58 59 #define HDMI_INFOFRAME_SIZE(type) \ 60 (HDMI_INFOFRAME_HEADER_SIZE + HDMI_ ## type ## _INFOFRAME_SIZE) 61 62 struct hdmi_any_infoframe { 63 enum hdmi_infoframe_type type; 64 unsigned char version; 65 unsigned char length; 66 }; 67 68 enum hdmi_colorspace { 69 HDMI_COLORSPACE_RGB, 70 HDMI_COLORSPACE_YUV422, 71 HDMI_COLORSPACE_YUV444, 72 HDMI_COLORSPACE_YUV420, 73 HDMI_COLORSPACE_RESERVED4, 74 HDMI_COLORSPACE_RESERVED5, 75 HDMI_COLORSPACE_RESERVED6, 76 HDMI_COLORSPACE_IDO_DEFINED, 77 }; 78 79 enum hdmi_scan_mode { 80 HDMI_SCAN_MODE_NONE, 81 HDMI_SCAN_MODE_OVERSCAN, 82 HDMI_SCAN_MODE_UNDERSCAN, 83 HDMI_SCAN_MODE_RESERVED, 84 }; 85 86 enum hdmi_colorimetry { 87 HDMI_COLORIMETRY_NONE, 88 HDMI_COLORIMETRY_ITU_601, 89 HDMI_COLORIMETRY_ITU_709, 90 HDMI_COLORIMETRY_EXTENDED, 91 }; 92 93 enum hdmi_picture_aspect { 94 HDMI_PICTURE_ASPECT_NONE, 95 HDMI_PICTURE_ASPECT_4_3, 96 HDMI_PICTURE_ASPECT_16_9, 97 HDMI_PICTURE_ASPECT_64_27, 98 HDMI_PICTURE_ASPECT_256_135, 99 HDMI_PICTURE_ASPECT_RESERVED, 100 }; 101 102 enum hdmi_active_aspect { 103 HDMI_ACTIVE_ASPECT_16_9_TOP = 2, 104 HDMI_ACTIVE_ASPECT_14_9_TOP = 3, 105 HDMI_ACTIVE_ASPECT_16_9_CENTER = 4, 106 HDMI_ACTIVE_ASPECT_PICTURE = 8, 107 HDMI_ACTIVE_ASPECT_4_3 = 9, 108 HDMI_ACTIVE_ASPECT_16_9 = 10, 109 HDMI_ACTIVE_ASPECT_14_9 = 11, 110 HDMI_ACTIVE_ASPECT_4_3_SP_14_9 = 13, 111 HDMI_ACTIVE_ASPECT_16_9_SP_14_9 = 14, 112 HDMI_ACTIVE_ASPECT_16_9_SP_4_3 = 15, 113 }; 114 115 enum hdmi_extended_colorimetry { 116 HDMI_EXTENDED_COLORIMETRY_XV_YCC_601, 117 HDMI_EXTENDED_COLORIMETRY_XV_YCC_709, 118 HDMI_EXTENDED_COLORIMETRY_S_YCC_601, 119 HDMI_EXTENDED_COLORIMETRY_OPYCC_601, 120 HDMI_EXTENDED_COLORIMETRY_OPRGB, 121 122 /* The following EC values are only defined in CEA-861-F. */ 123 HDMI_EXTENDED_COLORIMETRY_BT2020_CONST_LUM, 124 HDMI_EXTENDED_COLORIMETRY_BT2020, 125 HDMI_EXTENDED_COLORIMETRY_RESERVED, 126 }; 127 128 enum hdmi_quantization_range { 129 HDMI_QUANTIZATION_RANGE_DEFAULT, 130 HDMI_QUANTIZATION_RANGE_LIMITED, 131 HDMI_QUANTIZATION_RANGE_FULL, 132 HDMI_QUANTIZATION_RANGE_RESERVED, 133 }; 134 135 /* non-uniform picture scaling */ 136 enum hdmi_nups { 137 HDMI_NUPS_UNKNOWN, 138 HDMI_NUPS_HORIZONTAL, 139 HDMI_NUPS_VERTICAL, 140 HDMI_NUPS_BOTH, 141 }; 142 143 enum hdmi_ycc_quantization_range { 144 HDMI_YCC_QUANTIZATION_RANGE_LIMITED, 145 HDMI_YCC_QUANTIZATION_RANGE_FULL, 146 }; 147 148 enum hdmi_content_type { 149 HDMI_CONTENT_TYPE_GRAPHICS, 150 HDMI_CONTENT_TYPE_PHOTO, 151 HDMI_CONTENT_TYPE_CINEMA, 152 HDMI_CONTENT_TYPE_GAME, 153 }; 154 155 enum hdmi_metadata_type { 156 HDMI_STATIC_METADATA_TYPE1 = 1, 157 }; 158 159 enum hdmi_eotf { 160 HDMI_EOTF_TRADITIONAL_GAMMA_SDR, 161 HDMI_EOTF_TRADITIONAL_GAMMA_HDR, 162 HDMI_EOTF_SMPTE_ST2084, 163 }; 164 165 struct hdmi_avi_infoframe { 166 enum hdmi_infoframe_type type; 167 unsigned char version; 168 unsigned char length; 169 enum hdmi_colorspace colorspace; 170 enum hdmi_scan_mode scan_mode; 171 enum hdmi_colorimetry colorimetry; 172 enum hdmi_picture_aspect picture_aspect; 173 enum hdmi_active_aspect active_aspect; 174 bool itc; 175 enum hdmi_extended_colorimetry extended_colorimetry; 176 enum hdmi_quantization_range quantization_range; 177 enum hdmi_nups nups; 178 unsigned char video_code; 179 enum hdmi_ycc_quantization_range ycc_quantization_range; 180 enum hdmi_content_type content_type; 181 unsigned char pixel_repeat; 182 unsigned short top_bar; 183 unsigned short bottom_bar; 184 unsigned short left_bar; 185 unsigned short right_bar; 186 }; 187 188 int hdmi_avi_infoframe_init(struct hdmi_avi_infoframe *frame); 189 ssize_t hdmi_avi_infoframe_pack(struct hdmi_avi_infoframe *frame, void *buffer, 190 size_t size); 191 ssize_t hdmi_avi_infoframe_pack_only(const struct hdmi_avi_infoframe *frame, 192 void *buffer, size_t size); 193 int hdmi_avi_infoframe_check(struct hdmi_avi_infoframe *frame); 194 195 enum hdmi_spd_sdi { 196 HDMI_SPD_SDI_UNKNOWN, 197 HDMI_SPD_SDI_DSTB, 198 HDMI_SPD_SDI_DVDP, 199 HDMI_SPD_SDI_DVHS, 200 HDMI_SPD_SDI_HDDVR, 201 HDMI_SPD_SDI_DVC, 202 HDMI_SPD_SDI_DSC, 203 HDMI_SPD_SDI_VCD, 204 HDMI_SPD_SDI_GAME, 205 HDMI_SPD_SDI_PC, 206 HDMI_SPD_SDI_BD, 207 HDMI_SPD_SDI_SACD, 208 HDMI_SPD_SDI_HDDVD, 209 HDMI_SPD_SDI_PMP, 210 }; 211 212 struct hdmi_spd_infoframe { 213 enum hdmi_infoframe_type type; 214 unsigned char version; 215 unsigned char length; 216 char vendor[8]; 217 char product[16]; 218 enum hdmi_spd_sdi sdi; 219 }; 220 221 int hdmi_spd_infoframe_init(struct hdmi_spd_infoframe *frame, 222 const char *vendor, const char *product); 223 ssize_t hdmi_spd_infoframe_pack(struct hdmi_spd_infoframe *frame, void *buffer, 224 size_t size); 225 ssize_t hdmi_spd_infoframe_pack_only(const struct hdmi_spd_infoframe *frame, 226 void *buffer, size_t size); 227 int hdmi_spd_infoframe_check(struct hdmi_spd_infoframe *frame); 228 229 enum hdmi_audio_coding_type { 230 HDMI_AUDIO_CODING_TYPE_STREAM, 231 HDMI_AUDIO_CODING_TYPE_PCM, 232 HDMI_AUDIO_CODING_TYPE_AC3, 233 HDMI_AUDIO_CODING_TYPE_MPEG1, 234 HDMI_AUDIO_CODING_TYPE_MP3, 235 HDMI_AUDIO_CODING_TYPE_MPEG2, 236 HDMI_AUDIO_CODING_TYPE_AAC_LC, 237 HDMI_AUDIO_CODING_TYPE_DTS, 238 HDMI_AUDIO_CODING_TYPE_ATRAC, 239 HDMI_AUDIO_CODING_TYPE_DSD, 240 HDMI_AUDIO_CODING_TYPE_EAC3, 241 HDMI_AUDIO_CODING_TYPE_DTS_HD, 242 HDMI_AUDIO_CODING_TYPE_MLP, 243 HDMI_AUDIO_CODING_TYPE_DST, 244 HDMI_AUDIO_CODING_TYPE_WMA_PRO, 245 HDMI_AUDIO_CODING_TYPE_CXT, 246 }; 247 248 enum hdmi_audio_sample_size { 249 HDMI_AUDIO_SAMPLE_SIZE_STREAM, 250 HDMI_AUDIO_SAMPLE_SIZE_16, 251 HDMI_AUDIO_SAMPLE_SIZE_20, 252 HDMI_AUDIO_SAMPLE_SIZE_24, 253 }; 254 255 enum hdmi_audio_sample_frequency { 256 HDMI_AUDIO_SAMPLE_FREQUENCY_STREAM, 257 HDMI_AUDIO_SAMPLE_FREQUENCY_32000, 258 HDMI_AUDIO_SAMPLE_FREQUENCY_44100, 259 HDMI_AUDIO_SAMPLE_FREQUENCY_48000, 260 HDMI_AUDIO_SAMPLE_FREQUENCY_88200, 261 HDMI_AUDIO_SAMPLE_FREQUENCY_96000, 262 HDMI_AUDIO_SAMPLE_FREQUENCY_176400, 263 HDMI_AUDIO_SAMPLE_FREQUENCY_192000, 264 }; 265 266 enum hdmi_audio_coding_type_ext { 267 /* Refer to Audio Coding Type (CT) field in Data Byte 1 */ 268 HDMI_AUDIO_CODING_TYPE_EXT_CT, 269 270 /* 271 * The next three CXT values are defined in CEA-861-E only. 272 * They do not exist in older versions, and in CEA-861-F they are 273 * defined as 'Not in use'. 274 */ 275 HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC, 276 HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC_V2, 277 HDMI_AUDIO_CODING_TYPE_EXT_MPEG_SURROUND, 278 279 /* The following CXT values are only defined in CEA-861-F. */ 280 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC, 281 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_V2, 282 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC, 283 HDMI_AUDIO_CODING_TYPE_EXT_DRA, 284 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_SURROUND, 285 HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC_SURROUND = 10, 286 }; 287 288 struct hdmi_audio_infoframe { 289 enum hdmi_infoframe_type type; 290 unsigned char version; 291 unsigned char length; 292 unsigned char channels; 293 enum hdmi_audio_coding_type coding_type; 294 enum hdmi_audio_sample_size sample_size; 295 enum hdmi_audio_sample_frequency sample_frequency; 296 enum hdmi_audio_coding_type_ext coding_type_ext; 297 unsigned char channel_allocation; 298 unsigned char level_shift_value; 299 bool downmix_inhibit; 300 301 }; 302 303 int hdmi_audio_infoframe_init(struct hdmi_audio_infoframe *frame); 304 ssize_t hdmi_audio_infoframe_pack(struct hdmi_audio_infoframe *frame, 305 void *buffer, size_t size); 306 ssize_t hdmi_audio_infoframe_pack_only(const struct hdmi_audio_infoframe *frame, 307 void *buffer, size_t size); 308 int hdmi_audio_infoframe_check(struct hdmi_audio_infoframe *frame); 309 310 enum hdmi_3d_structure { 311 HDMI_3D_STRUCTURE_INVALID = -1, 312 HDMI_3D_STRUCTURE_FRAME_PACKING = 0, 313 HDMI_3D_STRUCTURE_FIELD_ALTERNATIVE, 314 HDMI_3D_STRUCTURE_LINE_ALTERNATIVE, 315 HDMI_3D_STRUCTURE_SIDE_BY_SIDE_FULL, 316 HDMI_3D_STRUCTURE_L_DEPTH, 317 HDMI_3D_STRUCTURE_L_DEPTH_GFX_GFX_DEPTH, 318 HDMI_3D_STRUCTURE_TOP_AND_BOTTOM, 319 HDMI_3D_STRUCTURE_SIDE_BY_SIDE_HALF = 8, 320 }; 321 322 323 struct hdmi_vendor_infoframe { 324 enum hdmi_infoframe_type type; 325 unsigned char version; 326 unsigned char length; 327 unsigned int oui; 328 u8 vic; 329 enum hdmi_3d_structure s3d_struct; 330 unsigned int s3d_ext_data; 331 }; 332 333 /* HDR Metadata as per 861.G spec */ 334 struct hdr_static_metadata { 335 __u8 eotf; 336 __u8 metadata_type; 337 __u16 max_cll; 338 __u16 max_fall; 339 __u16 min_cll; 340 }; 341 342 struct hdr_sink_metadata { 343 __u32 metadata_type; 344 union { 345 struct hdr_static_metadata hdmi_type1; 346 }; 347 }; 348 349 int hdmi_vendor_infoframe_init(struct hdmi_vendor_infoframe *frame); 350 ssize_t hdmi_vendor_infoframe_pack(struct hdmi_vendor_infoframe *frame, 351 void *buffer, size_t size); 352 ssize_t hdmi_vendor_infoframe_pack_only(const struct hdmi_vendor_infoframe *frame, 353 void *buffer, size_t size); 354 int hdmi_vendor_infoframe_check(struct hdmi_vendor_infoframe *frame); 355 356 union hdmi_vendor_any_infoframe { 357 struct { 358 enum hdmi_infoframe_type type; 359 unsigned char version; 360 unsigned char length; 361 unsigned int oui; 362 } any; 363 struct hdmi_vendor_infoframe hdmi; 364 }; 365 366 /** 367 * union hdmi_infoframe - overall union of all abstract infoframe representations 368 * @any: generic infoframe 369 * @avi: avi infoframe 370 * @spd: spd infoframe 371 * @vendor: union of all vendor infoframes 372 * @audio: audio infoframe 373 * 374 * This is used by the generic pack function. This works since all infoframes 375 * have the same header which also indicates which type of infoframe should be 376 * packed. 377 */ 378 union hdmi_infoframe { 379 struct hdmi_any_infoframe any; 380 struct hdmi_avi_infoframe avi; 381 struct hdmi_spd_infoframe spd; 382 union hdmi_vendor_any_infoframe vendor; 383 struct hdmi_audio_infoframe audio; 384 }; 385 386 ssize_t hdmi_infoframe_pack(union hdmi_infoframe *frame, void *buffer, 387 size_t size); 388 ssize_t hdmi_infoframe_pack_only(const union hdmi_infoframe *frame, 389 void *buffer, size_t size); 390 int hdmi_infoframe_check(union hdmi_infoframe *frame); 391 int hdmi_infoframe_unpack(union hdmi_infoframe *frame, 392 const void *buffer, size_t size); 393 void hdmi_infoframe_log(const char *level, struct device *dev, 394 const union hdmi_infoframe *frame); 395 396 #endif /* _DRM_HDMI_H */ 397