[linux-2.6-block.git] / include / linux / hdmi.h

/*
 * Copyright (C) 2012 Avionic Design GmbH
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sub license,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef __LINUX_HDMI_H_
#define __LINUX_HDMI_H_

#include <linux/types.h>
#include <linux/device.h>

enum hdmi_packet_type {
	HDMI_PACKET_TYPE_NULL = 0x00,
	HDMI_PACKET_TYPE_AUDIO_CLOCK_REGEN = 0x01,
	HDMI_PACKET_TYPE_AUDIO_SAMPLE = 0x02,
	HDMI_PACKET_TYPE_GENERAL_CONTROL = 0x03,
	HDMI_PACKET_TYPE_ACP = 0x04,
	HDMI_PACKET_TYPE_ISRC1 = 0x05,
	HDMI_PACKET_TYPE_ISRC2 = 0x06,
	HDMI_PACKET_TYPE_ONE_BIT_AUDIO_SAMPLE = 0x07,
	HDMI_PACKET_TYPE_DST_AUDIO = 0x08,
	HDMI_PACKET_TYPE_HBR_AUDIO_STREAM = 0x09,
	HDMI_PACKET_TYPE_GAMUT_METADATA = 0x0a,
	/* + enum hdmi_infoframe_type */
};

enum hdmi_infoframe_type {
	HDMI_INFOFRAME_TYPE_VENDOR = 0x81,
	HDMI_INFOFRAME_TYPE_AVI = 0x82,
	HDMI_INFOFRAME_TYPE_SPD = 0x83,
	HDMI_INFOFRAME_TYPE_AUDIO = 0x84,
	HDMI_INFOFRAME_TYPE_DRM = 0x87,
};

#define HDMI_IEEE_OUI 0x000c03
#define HDMI_FORUM_IEEE_OUI 0xc45dd8
#define HDMI_INFOFRAME_HEADER_SIZE  4
#define HDMI_AVI_INFOFRAME_SIZE    13
#define HDMI_SPD_INFOFRAME_SIZE    25
#define HDMI_AUDIO_INFOFRAME_SIZE  10
#define HDMI_DRM_INFOFRAME_SIZE    26
#define HDMI_VENDOR_INFOFRAME_SIZE  4

#define HDMI_INFOFRAME_SIZE(type)	\
	(HDMI_INFOFRAME_HEADER_SIZE + HDMI_ ## type ## _INFOFRAME_SIZE)

struct hdmi_any_infoframe {
	enum hdmi_infoframe_type type;
	unsigned char version;
	unsigned char length;
};

enum hdmi_colorspace {
	HDMI_COLORSPACE_RGB,
	HDMI_COLORSPACE_YUV422,
	HDMI_COLORSPACE_YUV444,
	HDMI_COLORSPACE_YUV420,
	HDMI_COLORSPACE_RESERVED4,
	HDMI_COLORSPACE_RESERVED5,
	HDMI_COLORSPACE_RESERVED6,
	HDMI_COLORSPACE_IDO_DEFINED,
};

enum hdmi_scan_mode {
	HDMI_SCAN_MODE_NONE,
	HDMI_SCAN_MODE_OVERSCAN,
	HDMI_SCAN_MODE_UNDERSCAN,
	HDMI_SCAN_MODE_RESERVED,
};

enum hdmi_colorimetry {
	HDMI_COLORIMETRY_NONE,
	HDMI_COLORIMETRY_ITU_601,
	HDMI_COLORIMETRY_ITU_709,
	HDMI_COLORIMETRY_EXTENDED,
};

enum hdmi_picture_aspect {
	HDMI_PICTURE_ASPECT_NONE,
	HDMI_PICTURE_ASPECT_4_3,
	HDMI_PICTURE_ASPECT_16_9,
	HDMI_PICTURE_ASPECT_64_27,
	HDMI_PICTURE_ASPECT_256_135,
	HDMI_PICTURE_ASPECT_RESERVED,
};

enum hdmi_active_aspect {
	HDMI_ACTIVE_ASPECT_16_9_TOP = 2,
	HDMI_ACTIVE_ASPECT_14_9_TOP = 3,
	HDMI_ACTIVE_ASPECT_16_9_CENTER = 4,
	HDMI_ACTIVE_ASPECT_PICTURE = 8,
	HDMI_ACTIVE_ASPECT_4_3 = 9,
	HDMI_ACTIVE_ASPECT_16_9 = 10,
	HDMI_ACTIVE_ASPECT_14_9 = 11,
	HDMI_ACTIVE_ASPECT_4_3_SP_14_9 = 13,
	HDMI_ACTIVE_ASPECT_16_9_SP_14_9 = 14,
	HDMI_ACTIVE_ASPECT_16_9_SP_4_3 = 15,
};

enum hdmi_extended_colorimetry {
	HDMI_EXTENDED_COLORIMETRY_XV_YCC_601,
	HDMI_EXTENDED_COLORIMETRY_XV_YCC_709,
	HDMI_EXTENDED_COLORIMETRY_S_YCC_601,
	HDMI_EXTENDED_COLORIMETRY_OPYCC_601,
	HDMI_EXTENDED_COLORIMETRY_OPRGB,

	/* The following EC values are only defined in CEA-861-F. */
	HDMI_EXTENDED_COLORIMETRY_BT2020_CONST_LUM,
	HDMI_EXTENDED_COLORIMETRY_BT2020,
	HDMI_EXTENDED_COLORIMETRY_RESERVED,
};

enum hdmi_quantization_range {
	HDMI_QUANTIZATION_RANGE_DEFAULT,
	HDMI_QUANTIZATION_RANGE_LIMITED,
	HDMI_QUANTIZATION_RANGE_FULL,
	HDMI_QUANTIZATION_RANGE_RESERVED,
};

/* non-uniform picture scaling */
enum hdmi_nups {
	HDMI_NUPS_UNKNOWN,
	HDMI_NUPS_HORIZONTAL,
	HDMI_NUPS_VERTICAL,
	HDMI_NUPS_BOTH,
};

enum hdmi_ycc_quantization_range {
	HDMI_YCC_QUANTIZATION_RANGE_LIMITED,
	HDMI_YCC_QUANTIZATION_RANGE_FULL,
};

enum hdmi_content_type {
	HDMI_CONTENT_TYPE_GRAPHICS,
	HDMI_CONTENT_TYPE_PHOTO,
	HDMI_CONTENT_TYPE_CINEMA,
	HDMI_CONTENT_TYPE_GAME,
};

enum hdmi_metadata_type {
	HDMI_STATIC_METADATA_TYPE1 = 0,
};

enum hdmi_eotf {
	HDMI_EOTF_TRADITIONAL_GAMMA_SDR,
	HDMI_EOTF_TRADITIONAL_GAMMA_HDR,
	HDMI_EOTF_SMPTE_ST2084,
	HDMI_EOTF_BT_2100_HLG,
};

struct hdmi_avi_infoframe {
	enum hdmi_infoframe_type type;
	unsigned char version;
	unsigned char length;
	enum hdmi_colorspace colorspace;
	enum hdmi_scan_mode scan_mode;
	enum hdmi_colorimetry colorimetry;
	enum hdmi_picture_aspect picture_aspect;
	enum hdmi_active_aspect active_aspect;
	bool itc;
	enum hdmi_extended_colorimetry extended_colorimetry;
	enum hdmi_quantization_range quantization_range;
	enum hdmi_nups nups;
	unsigned char video_code;
	enum hdmi_ycc_quantization_range ycc_quantization_range;
	enum hdmi_content_type content_type;
	unsigned char pixel_repeat;
	unsigned short top_bar;
	unsigned short bottom_bar;
	unsigned short left_bar;
	unsigned short right_bar;
};

/* DRM Infoframe as per CTA 861.G spec */
struct hdmi_drm_infoframe {
	enum hdmi_infoframe_type type;
	unsigned char version;
	unsigned char length;
	enum hdmi_eotf eotf;
	enum hdmi_metadata_type metadata_type;
	struct {
		u16 x, y;
	} display_primaries[3];
	struct {
		u16 x, y;
	} white_point;
	u16 max_display_mastering_luminance;
	u16 min_display_mastering_luminance;
	u16 max_cll;
	u16 max_fall;
};

void hdmi_avi_infoframe_init(struct hdmi_avi_infoframe *frame);
ssize_t hdmi_avi_infoframe_pack(struct hdmi_avi_infoframe *frame, void *buffer,
				size_t size);
ssize_t hdmi_avi_infoframe_pack_only(const struct hdmi_avi_infoframe *frame,
				     void *buffer, size_t size);
int hdmi_avi_infoframe_check(struct hdmi_avi_infoframe *frame);
int hdmi_drm_infoframe_init(struct hdmi_drm_infoframe *frame);
ssize_t hdmi_drm_infoframe_pack(struct hdmi_drm_infoframe *frame, void *buffer,
				size_t size);
ssize_t hdmi_drm_infoframe_pack_only(const struct hdmi_drm_infoframe *frame,
				     void *buffer, size_t size);
int hdmi_drm_infoframe_check(struct hdmi_drm_infoframe *frame);
int hdmi_drm_infoframe_unpack_only(struct hdmi_drm_infoframe *frame,
				   const void *buffer, size_t size);

enum hdmi_spd_sdi {
	HDMI_SPD_SDI_UNKNOWN,
	HDMI_SPD_SDI_DSTB,
	HDMI_SPD_SDI_DVDP,
	HDMI_SPD_SDI_DVHS,
	HDMI_SPD_SDI_HDDVR,
	HDMI_SPD_SDI_DVC,
	HDMI_SPD_SDI_DSC,
	HDMI_SPD_SDI_VCD,
	HDMI_SPD_SDI_GAME,
	HDMI_SPD_SDI_PC,
	HDMI_SPD_SDI_BD,
	HDMI_SPD_SDI_SACD,
	HDMI_SPD_SDI_HDDVD,
	HDMI_SPD_SDI_PMP,
};

struct hdmi_spd_infoframe {
	enum hdmi_infoframe_type type;
	unsigned char version;
	unsigned char length;
	char vendor[8];
	char product[16];
	enum hdmi_spd_sdi sdi;
};

int hdmi_spd_infoframe_init(struct hdmi_spd_infoframe *frame,
			    const char *vendor, const char *product);
ssize_t hdmi_spd_infoframe_pack(struct hdmi_spd_infoframe *frame, void *buffer,
				size_t size);
ssize_t hdmi_spd_infoframe_pack_only(const struct hdmi_spd_infoframe *frame,
				     void *buffer, size_t size);
int hdmi_spd_infoframe_check(struct hdmi_spd_infoframe *frame);

enum hdmi_audio_coding_type {
	HDMI_AUDIO_CODING_TYPE_STREAM,
	HDMI_AUDIO_CODING_TYPE_PCM,
	HDMI_AUDIO_CODING_TYPE_AC3,
	HDMI_AUDIO_CODING_TYPE_MPEG1,
	HDMI_AUDIO_CODING_TYPE_MP3,
	HDMI_AUDIO_CODING_TYPE_MPEG2,
	HDMI_AUDIO_CODING_TYPE_AAC_LC,
	HDMI_AUDIO_CODING_TYPE_DTS,
	HDMI_AUDIO_CODING_TYPE_ATRAC,
	HDMI_AUDIO_CODING_TYPE_DSD,
	HDMI_AUDIO_CODING_TYPE_EAC3,
	HDMI_AUDIO_CODING_TYPE_DTS_HD,
	HDMI_AUDIO_CODING_TYPE_MLP,
	HDMI_AUDIO_CODING_TYPE_DST,
	HDMI_AUDIO_CODING_TYPE_WMA_PRO,
	HDMI_AUDIO_CODING_TYPE_CXT,
};

enum hdmi_audio_sample_size {
	HDMI_AUDIO_SAMPLE_SIZE_STREAM,
	HDMI_AUDIO_SAMPLE_SIZE_16,
	HDMI_AUDIO_SAMPLE_SIZE_20,
	HDMI_AUDIO_SAMPLE_SIZE_24,
};

enum hdmi_audio_sample_frequency {
	HDMI_AUDIO_SAMPLE_FREQUENCY_STREAM,
	HDMI_AUDIO_SAMPLE_FREQUENCY_32000,
	HDMI_AUDIO_SAMPLE_FREQUENCY_44100,
	HDMI_AUDIO_SAMPLE_FREQUENCY_48000,
	HDMI_AUDIO_SAMPLE_FREQUENCY_88200,
	HDMI_AUDIO_SAMPLE_FREQUENCY_96000,
	HDMI_AUDIO_SAMPLE_FREQUENCY_176400,
	HDMI_AUDIO_SAMPLE_FREQUENCY_192000,
};

enum hdmi_audio_coding_type_ext {
	/* Refer to Audio Coding Type (CT) field in Data Byte 1 */
	HDMI_AUDIO_CODING_TYPE_EXT_CT,

	/*
	 * The next three CXT values are defined in CEA-861-E only.
	 * They do not exist in older versions, and in CEA-861-F they are
	 * defined as 'Not in use'.
	 */
	HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC,
	HDMI_AUDIO_CODING_TYPE_EXT_HE_AAC_V2,
	HDMI_AUDIO_CODING_TYPE_EXT_MPEG_SURROUND,

	/* The following CXT values are only defined in CEA-861-F. */
	HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC,
	HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_V2,
	HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC,
	HDMI_AUDIO_CODING_TYPE_EXT_DRA,
	HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_HE_AAC_SURROUND,
	HDMI_AUDIO_CODING_TYPE_EXT_MPEG4_AAC_LC_SURROUND = 10,
};

struct hdmi_audio_infoframe {
	enum hdmi_infoframe_type type;
	unsigned char version;
	unsigned char length;
	unsigned char channels;
	enum hdmi_audio_coding_type coding_type;
	enum hdmi_audio_sample_size sample_size;
	enum hdmi_audio_sample_frequency sample_frequency;
	enum hdmi_audio_coding_type_ext coding_type_ext;
	unsigned char channel_allocation;
	unsigned char level_shift_value;
	bool downmix_inhibit;

};

int hdmi_audio_infoframe_init(struct hdmi_audio_infoframe *frame);
ssize_t hdmi_audio_infoframe_pack(struct hdmi_audio_infoframe *frame,
				  void *buffer, size_t size);
ssize_t hdmi_audio_infoframe_pack_only(const struct hdmi_audio_infoframe *frame,
				       void *buffer, size_t size);
int hdmi_audio_infoframe_check(struct hdmi_audio_infoframe *frame);

enum hdmi_3d_structure {
	HDMI_3D_STRUCTURE_INVALID = -1,
	HDMI_3D_STRUCTURE_FRAME_PACKING = 0,
	HDMI_3D_STRUCTURE_FIELD_ALTERNATIVE,
	HDMI_3D_STRUCTURE_LINE_ALTERNATIVE,
	HDMI_3D_STRUCTURE_SIDE_BY_SIDE_FULL,
	HDMI_3D_STRUCTURE_L_DEPTH,
	HDMI_3D_STRUCTURE_L_DEPTH_GFX_GFX_DEPTH,
	HDMI_3D_STRUCTURE_TOP_AND_BOTTOM,
	HDMI_3D_STRUCTURE_SIDE_BY_SIDE_HALF = 8,
};


struct hdmi_vendor_infoframe {
	enum hdmi_infoframe_type type;
	unsigned char version;
	unsigned char length;
	unsigned int oui;
	u8 vic;
	enum hdmi_3d_structure s3d_struct;
	unsigned int s3d_ext_data;
};

/* HDR Metadata as per 861.G spec */
struct hdr_static_metadata {
	__u8 eotf;
	__u8 metadata_type;
	__u16 max_cll;
	__u16 max_fall;
	__u16 min_cll;
};

/**
 * struct hdr_sink_metadata - HDR sink metadata
 *
 * Metadata Information read from Sink's EDID
 */
struct hdr_sink_metadata {
	/**
	 * @metadata_type: Static_Metadata_Descriptor_ID.
	 */
	__u32 metadata_type;
	/**
	 * @hdmi_type1: HDR Metadata Infoframe.
	 */
	union {
		struct hdr_static_metadata hdmi_type1;
	};
};

int hdmi_vendor_infoframe_init(struct hdmi_vendor_infoframe *frame);
ssize_t hdmi_vendor_infoframe_pack(struct hdmi_vendor_infoframe *frame,
				   void *buffer, size_t size);
ssize_t hdmi_vendor_infoframe_pack_only(const struct hdmi_vendor_infoframe *frame,
					void *buffer, size_t size);
int hdmi_vendor_infoframe_check(struct hdmi_vendor_infoframe *frame);

union hdmi_vendor_any_infoframe {
	struct {
		enum hdmi_infoframe_type type;
		unsigned char version;
		unsigned char length;
		unsigned int oui;
	} any;
	struct hdmi_vendor_infoframe hdmi;
};

/**
 * union hdmi_infoframe - overall union of all abstract infoframe representations
 * @any: generic infoframe
 * @avi: avi infoframe
 * @spd: spd infoframe
 * @vendor: union of all vendor infoframes
 * @audio: audio infoframe
 * @drm: Dynamic Range and Mastering infoframe
 *
 * This is used by the generic pack function. This works since all infoframes
 * have the same header which also indicates which type of infoframe should be
 * packed.
 */
union hdmi_infoframe {
	struct hdmi_any_infoframe any;
	struct hdmi_avi_infoframe avi;
	struct hdmi_spd_infoframe spd;
	union hdmi_vendor_any_infoframe vendor;
	struct hdmi_audio_infoframe audio;
	struct hdmi_drm_infoframe drm;
};

ssize_t hdmi_infoframe_pack(union hdmi_infoframe *frame, void *buffer,
			    size_t size);
ssize_t hdmi_infoframe_pack_only(const union hdmi_infoframe *frame,
				 void *buffer, size_t size);
int hdmi_infoframe_check(union hdmi_infoframe *frame);
int hdmi_infoframe_unpack(union hdmi_infoframe *frame,
			  const void *buffer, size_t size);
void hdmi_infoframe_log(const char *level, struct device *dev,
			const union hdmi_infoframe *frame);

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