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