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