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