hdmi.h revision 310600
1310600Smmel/* 2310600Smmel * Copyright (C) 2012 Avionic Design GmbH 3310600Smmel * 4310600Smmel * Permission is hereby granted, free of charge, to any person obtaining a 5310600Smmel * copy of this software and associated documentation files (the "Software"), 6310600Smmel * to deal in the Software without restriction, including without limitation 7310600Smmel * the rights to use, copy, modify, merge, publish, distribute, sub license, 8310600Smmel * and/or sell copies of the Software, and to permit persons to whom the 9310600Smmel * Software is furnished to do so, subject to the following conditions: 10310600Smmel * 11310600Smmel * The above copyright notice and this permission notice (including the 12310600Smmel * next paragraph) shall be included in all copies or substantial portions 13310600Smmel * of the Software. 14310600Smmel * 15310600Smmel * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16310600Smmel * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17310600Smmel * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 18310600Smmel * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19310600Smmel * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20310600Smmel * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 21310600Smmel * DEALINGS IN THE SOFTWARE. 22310600Smmel * 23310600Smmel * $FreeBSD: head/sys/arm/nvidia/drm2/hdmi.h 310600 2016-12-26 14:36:05Z mmel $ 24310600Smmel */ 25310600Smmel 26310600Smmel#ifndef _HDMI_H_ 27310600Smmel#define _HDMI_H_ 28310600Smmel 29310600Smmel 30310600Smmelenum hdmi_infoframe_type { 31310600Smmel HDMI_INFOFRAME_TYPE_VENDOR = 0x81, 32310600Smmel HDMI_INFOFRAME_TYPE_AVI = 0x82, 33310600Smmel HDMI_INFOFRAME_TYPE_SPD = 0x83, 34310600Smmel HDMI_INFOFRAME_TYPE_AUDIO = 0x84, 35310600Smmel}; 36310600Smmel 37310600Smmel#define HDMI_IEEE_OUI 0x000c03 38310600Smmel#define HDMI_INFOFRAME_HEADER_SIZE 4 39310600Smmel#define HDMI_AVI_INFOFRAME_SIZE 13 40310600Smmel#define HDMI_SPD_INFOFRAME_SIZE 25 41310600Smmel#define HDMI_AUDIO_INFOFRAME_SIZE 10 42310600Smmel 43310600Smmel#define HDMI_INFOFRAME_SIZE(type) \ 44310600Smmel (HDMI_INFOFRAME_HEADER_SIZE + HDMI_ ## type ## _INFOFRAME_SIZE) 45310600Smmel 46310600Smmelstruct hdmi_any_infoframe { 47310600Smmel enum hdmi_infoframe_type type; 48310600Smmel unsigned char version; 49310600Smmel unsigned char length; 50310600Smmel}; 51310600Smmel 52310600Smmelenum hdmi_colorspace { 53310600Smmel HDMI_COLORSPACE_RGB, 54310600Smmel HDMI_COLORSPACE_YUV422, 55310600Smmel HDMI_COLORSPACE_YUV444, 56310600Smmel HDMI_COLORSPACE_YUV420, 57310600Smmel HDMI_COLORSPACE_RESERVED4, 58310600Smmel HDMI_COLORSPACE_RESERVED5, 59310600Smmel HDMI_COLORSPACE_RESERVED6, 60310600Smmel HDMI_COLORSPACE_IDO_DEFINED, 61310600Smmel}; 62310600Smmel 63310600Smmelenum hdmi_scan_mode { 64310600Smmel HDMI_SCAN_MODE_NONE, 65310600Smmel HDMI_SCAN_MODE_OVERSCAN, 66310600Smmel HDMI_SCAN_MODE_UNDERSCAN, 67310600Smmel HDMI_SCAN_MODE_RESERVED, 68310600Smmel}; 69310600Smmel 70310600Smmelenum hdmi_colorimetry { 71310600Smmel HDMI_COLORIMETRY_NONE, 72310600Smmel HDMI_COLORIMETRY_ITU_601, 73310600Smmel HDMI_COLORIMETRY_ITU_709, 74310600Smmel HDMI_COLORIMETRY_EXTENDED, 75310600Smmel}; 76310600Smmel 77310600Smmelenum hdmi_picture_aspect { 78310600Smmel HDMI_PICTURE_ASPECT_NONE, 79310600Smmel HDMI_PICTURE_ASPECT_4_3, 80310600Smmel HDMI_PICTURE_ASPECT_16_9, 81310600Smmel HDMI_PICTURE_ASPECT_RESERVED, 82310600Smmel}; 83310600Smmel 84310600Smmelenum hdmi_active_aspect { 85310600Smmel HDMI_ACTIVE_ASPECT_16_9_TOP = 2, 86310600Smmel HDMI_ACTIVE_ASPECT_14_9_TOP = 3, 87310600Smmel HDMI_ACTIVE_ASPECT_16_9_CENTER = 4, 88310600Smmel HDMI_ACTIVE_ASPECT_PICTURE = 8, 89310600Smmel HDMI_ACTIVE_ASPECT_4_3 = 9, 90310600Smmel HDMI_ACTIVE_ASPECT_16_9 = 10, 91310600Smmel HDMI_ACTIVE_ASPECT_14_9 = 11, 92310600Smmel HDMI_ACTIVE_ASPECT_4_3_SP_14_9 = 13, 93310600Smmel HDMI_ACTIVE_ASPECT_16_9_SP_14_9 = 14, 94310600Smmel HDMI_ACTIVE_ASPECT_16_9_SP_4_3 = 15, 95310600Smmel}; 96310600Smmel 97310600Smmelenum hdmi_extended_colorimetry { 98310600Smmel HDMI_EXTENDED_COLORIMETRY_XV_YCC_601, 99310600Smmel HDMI_EXTENDED_COLORIMETRY_XV_YCC_709, 100310600Smmel HDMI_EXTENDED_COLORIMETRY_S_YCC_601, 101310600Smmel HDMI_EXTENDED_COLORIMETRY_ADOBE_YCC_601, 102310600Smmel HDMI_EXTENDED_COLORIMETRY_ADOBE_RGB, 103310600Smmel 104310600Smmel /* The following EC values are only defined in CEA-861-F. */ 105310600Smmel HDMI_EXTENDED_COLORIMETRY_BT2020_CONST_LUM, 106310600Smmel HDMI_EXTENDED_COLORIMETRY_BT2020, 107310600Smmel HDMI_EXTENDED_COLORIMETRY_RESERVED, 108310600Smmel}; 109310600Smmel 110310600Smmelenum hdmi_quantization_range { 111310600Smmel HDMI_QUANTIZATION_RANGE_DEFAULT, 112310600Smmel HDMI_QUANTIZATION_RANGE_LIMITED, 113310600Smmel HDMI_QUANTIZATION_RANGE_FULL, 114310600Smmel HDMI_QUANTIZATION_RANGE_RESERVED, 115310600Smmel}; 116310600Smmel 117310600Smmel/* non-uniform picture scaling */ 118310600Smmelenum hdmi_nups { 119310600Smmel HDMI_NUPS_UNKNOWN, 120310600Smmel HDMI_NUPS_HORIZONTAL, 121310600Smmel HDMI_NUPS_VERTICAL, 122310600Smmel HDMI_NUPS_BOTH, 123310600Smmel}; 124310600Smmel 125310600Smmelenum hdmi_ycc_quantization_range { 126310600Smmel HDMI_YCC_QUANTIZATION_RANGE_LIMITED, 127310600Smmel HDMI_YCC_QUANTIZATION_RANGE_FULL, 128310600Smmel}; 129310600Smmel 130310600Smmelenum hdmi_content_type { 131310600Smmel HDMI_CONTENT_TYPE_GRAPHICS, 132310600Smmel HDMI_CONTENT_TYPE_PHOTO, 133310600Smmel HDMI_CONTENT_TYPE_CINEMA, 134310600Smmel HDMI_CONTENT_TYPE_GAME, 135310600Smmel}; 136310600Smmel 137310600Smmelstruct hdmi_avi_infoframe { 138310600Smmel enum hdmi_infoframe_type type; 139310600Smmel unsigned char version; 140310600Smmel unsigned char length; 141310600Smmel enum hdmi_colorspace colorspace; 142310600Smmel enum hdmi_scan_mode scan_mode; 143310600Smmel enum hdmi_colorimetry colorimetry; 144310600Smmel enum hdmi_picture_aspect picture_aspect; 145310600Smmel enum hdmi_active_aspect active_aspect; 146310600Smmel bool itc; 147310600Smmel enum hdmi_extended_colorimetry extended_colorimetry; 148310600Smmel enum hdmi_quantization_range quantization_range; 149310600Smmel enum hdmi_nups nups; 150310600Smmel unsigned char video_code; 151310600Smmel enum hdmi_ycc_quantization_range ycc_quantization_range; 152310600Smmel enum hdmi_content_type content_type; 153310600Smmel unsigned char pixel_repeat; 154310600Smmel unsigned short top_bar; 155310600Smmel unsigned short bottom_bar; 156310600Smmel unsigned short left_bar; 157310600Smmel unsigned short right_bar; 158310600Smmel}; 159310600Smmel 160310600Smmelint hdmi_avi_infoframe_init(struct hdmi_avi_infoframe *frame); 161310600Smmelssize_t hdmi_avi_infoframe_pack(struct hdmi_avi_infoframe *frame, void *buffer, 162310600Smmel size_t size); 163310600Smmel 164310600Smmelenum hdmi_spd_sdi { 165310600Smmel HDMI_SPD_SDI_UNKNOWN, 166310600Smmel HDMI_SPD_SDI_DSTB, 167310600Smmel HDMI_SPD_SDI_DVDP, 168310600Smmel HDMI_SPD_SDI_DVHS, 169310600Smmel HDMI_SPD_SDI_HDDVR, 170310600Smmel HDMI_SPD_SDI_DVC, 171310600Smmel HDMI_SPD_SDI_DSC, 172310600Smmel HDMI_SPD_SDI_VCD, 173310600Smmel HDMI_SPD_SDI_GAME, 174310600Smmel HDMI_SPD_SDI_PC, 175310600Smmel HDMI_SPD_SDI_BD, 176310600Smmel HDMI_SPD_SDI_SACD, 177310600Smmel HDMI_SPD_SDI_HDDVD, 178310600Smmel HDMI_SPD_SDI_PMP, 179310600Smmel}; 180310600Smmel 181310600Smmelstruct hdmi_spd_infoframe { 182310600Smmel enum hdmi_infoframe_type type; 183310600Smmel unsigned char version; 184310600Smmel unsigned char length; 185310600Smmel char vendor[8]; 186310600Smmel char product[16]; 187310600Smmel enum hdmi_spd_sdi sdi; 188310600Smmel}; 189310600Smmel 190310600Smmelint hdmi_spd_infoframe_init(struct hdmi_spd_infoframe *frame, 191310600Smmel const char *vendor, const char *product); 192310600Smmelssize_t hdmi_spd_infoframe_pack(struct hdmi_spd_infoframe *frame, void *buffer, 193310600Smmel size_t size); 194310600Smmel 195310600Smmelenum hdmi_audio_coding_type { 196310600Smmel HDMI_AUDIO_CODING_TYPE_STREAM, 197310600Smmel HDMI_AUDIO_CODING_TYPE_PCM, 198310600Smmel HDMI_AUDIO_CODING_TYPE_AC3, 199310600Smmel HDMI_AUDIO_CODING_TYPE_MPEG1, 200310600Smmel HDMI_AUDIO_CODING_TYPE_MP3, 201310600Smmel HDMI_AUDIO_CODING_TYPE_MPEG2, 202310600Smmel HDMI_AUDIO_CODING_TYPE_AAC_LC, 203310600Smmel HDMI_AUDIO_CODING_TYPE_DTS, 204310600Smmel HDMI_AUDIO_CODING_TYPE_ATRAC, 205310600Smmel HDMI_AUDIO_CODING_TYPE_DSD, 206310600Smmel HDMI_AUDIO_CODING_TYPE_EAC3, 207310600Smmel HDMI_AUDIO_CODING_TYPE_DTS_HD, 208310600Smmel HDMI_AUDIO_CODING_TYPE_MLP, 209310600Smmel HDMI_AUDIO_CODING_TYPE_DST, 210310600Smmel HDMI_AUDIO_CODING_TYPE_WMA_PRO, 211310600Smmel HDMI_AUDIO_CODING_TYPE_CXT, 212310600Smmel}; 213310600Smmel 214310600Smmelenum hdmi_audio_sample_size { 215310600Smmel HDMI_AUDIO_SAMPLE_SIZE_STREAM, 216310600Smmel HDMI_AUDIO_SAMPLE_SIZE_16, 217310600Smmel HDMI_AUDIO_SAMPLE_SIZE_20, 218310600Smmel HDMI_AUDIO_SAMPLE_SIZE_24, 219310600Smmel}; 220310600Smmel 221310600Smmelenum hdmi_audio_sample_frequency { 222310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_STREAM, 223310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_32000, 224310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_44100, 225310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_48000, 226310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_88200, 227310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_96000, 228310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_176400, 229310600Smmel HDMI_AUDIO_SAMPLE_FREQUENCY_192000, 230310600Smmel}; 231310600Smmel 232310600Smmelenum hdmi_audio_coding_type_ext { 233310600Smmel /* Refer to Audio Coding Type (CT) field in Data Byte 1 */ 234310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_CT, 235310600Smmel 236310600Smmel /* 237310600Smmel * The next three CXT values are defined in CEA-861-E only. 238310600Smmel * They do not exist in older versions, and in CEA-861-F they are 239310600Smmel * defined as 'Not in use'. 240310600Smmel */ 241310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC, 242310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC_V2, 243310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_MPEG_SURROUND, 244310600Smmel 245310600Smmel /* The following CXT values are only defined in CEA-861-F. */ 246310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC, 247310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_V2, 248310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC, 249310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_DRA, 250310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_SURROUND, 251310600Smmel HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC_SURROUND = 10, 252310600Smmel}; 253310600Smmel 254310600Smmelstruct hdmi_audio_infoframe { 255310600Smmel enum hdmi_infoframe_type type; 256310600Smmel unsigned char version; 257310600Smmel unsigned char length; 258310600Smmel unsigned char channels; 259310600Smmel enum hdmi_audio_coding_type coding_type; 260310600Smmel enum hdmi_audio_sample_size sample_size; 261310600Smmel enum hdmi_audio_sample_frequency sample_frequency; 262310600Smmel enum hdmi_audio_coding_type_ext coding_type_ext; 263310600Smmel unsigned char channel_allocation; 264310600Smmel unsigned char level_shift_value; 265310600Smmel bool downmix_inhibit; 266310600Smmel 267310600Smmel}; 268310600Smmel 269310600Smmelint hdmi_audio_infoframe_init(struct hdmi_audio_infoframe *frame); 270310600Smmelssize_t hdmi_audio_infoframe_pack(struct hdmi_audio_infoframe *frame, 271310600Smmel void *buffer, size_t size); 272310600Smmel 273310600Smmelenum hdmi_3d_structure { 274310600Smmel HDMI_3D_STRUCTURE_INVALID = -1, 275310600Smmel HDMI_3D_STRUCTURE_FRAME_PACKING = 0, 276310600Smmel HDMI_3D_STRUCTURE_FIELD_ALTERNATIVE, 277310600Smmel HDMI_3D_STRUCTURE_LINE_ALTERNATIVE, 278310600Smmel HDMI_3D_STRUCTURE_SIDE_BY_SIDE_FULL, 279310600Smmel HDMI_3D_STRUCTURE_L_DEPTH, 280310600Smmel HDMI_3D_STRUCTURE_L_DEPTH_GFX_GFX_DEPTH, 281310600Smmel HDMI_3D_STRUCTURE_TOP_AND_BOTTOM, 282310600Smmel HDMI_3D_STRUCTURE_SIDE_BY_SIDE_HALF = 8, 283310600Smmel}; 284310600Smmel 285310600Smmel 286310600Smmelstruct hdmi_vendor_infoframe { 287310600Smmel enum hdmi_infoframe_type type; 288310600Smmel unsigned char version; 289310600Smmel unsigned char length; 290310600Smmel unsigned int oui; 291310600Smmel uint8_t vic; 292310600Smmel enum hdmi_3d_structure s3d_struct; 293310600Smmel unsigned int s3d_ext_data; 294310600Smmel}; 295310600Smmel 296310600Smmelint hdmi_vendor_infoframe_init(struct hdmi_vendor_infoframe *frame); 297310600Smmelssize_t hdmi_vendor_infoframe_pack(struct hdmi_vendor_infoframe *frame, 298310600Smmel void *buffer, size_t size); 299310600Smmel 300310600Smmelunion hdmi_vendor_any_infoframe { 301310600Smmel struct { 302310600Smmel enum hdmi_infoframe_type type; 303310600Smmel unsigned char version; 304310600Smmel unsigned char length; 305310600Smmel unsigned int oui; 306310600Smmel } any; 307310600Smmel struct hdmi_vendor_infoframe hdmi; 308310600Smmel}; 309310600Smmel 310310600Smmel/** 311310600Smmel * union hdmi_infoframe - overall union of all abstract infoframe representations 312310600Smmel * @any: generic infoframe 313310600Smmel * @avi: avi infoframe 314310600Smmel * @spd: spd infoframe 315310600Smmel * @vendor: union of all vendor infoframes 316310600Smmel * @audio: audio infoframe 317310600Smmel * 318310600Smmel * This is used by the generic pack function. This works since all infoframes 319310600Smmel * have the same header which also indicates which type of infoframe should be 320310600Smmel * packed. 321310600Smmel */ 322310600Smmelunion hdmi_infoframe { 323310600Smmel struct hdmi_any_infoframe any; 324310600Smmel struct hdmi_avi_infoframe avi; 325310600Smmel struct hdmi_spd_infoframe spd; 326310600Smmel union hdmi_vendor_any_infoframe vendor; 327310600Smmel struct hdmi_audio_infoframe audio; 328310600Smmel}; 329310600Smmel 330310600Smmelssize_t 331310600Smmelhdmi_infoframe_pack(union hdmi_infoframe *frame, void *buffer, size_t size); 332310600Smmelint hdmi_infoframe_unpack(union hdmi_infoframe *frame, void *buffer); 333310600Smmelvoid hdmi_infoframe_log(union hdmi_infoframe *frame); 334310600Smmel 335310600Smmel#endif /* _HDMI_H */ 336