xref: /openbmc/linux/include/sound/hdmi-codec.h (revision 8dde5715)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * hdmi-codec.h - HDMI Codec driver API
4  *
5  * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com
6  *
7  * Author: Jyri Sarha <jsarha@ti.com>
8  */
9 
10 #ifndef __HDMI_CODEC_H__
11 #define __HDMI_CODEC_H__
12 
13 #include <linux/of_graph.h>
14 #include <linux/hdmi.h>
15 #include <drm/drm_edid.h>
16 #include <sound/asoundef.h>
17 #include <sound/soc.h>
18 #include <uapi/sound/asound.h>
19 
20 /*
21  * Protocol between ASoC cpu-dai and HDMI-encoder
22  */
23 struct hdmi_codec_daifmt {
24 	enum {
25 		HDMI_I2S,
26 		HDMI_RIGHT_J,
27 		HDMI_LEFT_J,
28 		HDMI_DSP_A,
29 		HDMI_DSP_B,
30 		HDMI_AC97,
31 		HDMI_SPDIF,
32 	} fmt;
33 	unsigned int bit_clk_inv:1;
34 	unsigned int frame_clk_inv:1;
35 	unsigned int bit_clk_master:1;
36 	unsigned int frame_clk_master:1;
37 };
38 
39 /*
40  * HDMI audio parameters
41  */
42 struct hdmi_codec_params {
43 	struct hdmi_audio_infoframe cea;
44 	struct snd_aes_iec958 iec;
45 	int sample_rate;
46 	int sample_width;
47 	int channels;
48 };
49 
50 struct hdmi_codec_pdata;
51 struct hdmi_codec_ops {
52 	/*
53 	 * Called when ASoC starts an audio stream setup.
54 	 * Optional
55 	 */
56 	int (*audio_startup)(struct device *dev, void *data);
57 
58 	/*
59 	 * Configures HDMI-encoder for audio stream.
60 	 * Mandatory
61 	 */
62 	int (*hw_params)(struct device *dev, void *data,
63 			 struct hdmi_codec_daifmt *fmt,
64 			 struct hdmi_codec_params *hparms);
65 
66 	/*
67 	 * Shuts down the audio stream.
68 	 * Mandatory
69 	 */
70 	void (*audio_shutdown)(struct device *dev, void *data);
71 
72 	/*
73 	 * Mute/unmute HDMI audio stream.
74 	 * Optional
75 	 */
76 	int (*digital_mute)(struct device *dev, void *data, bool enable);
77 
78 	/*
79 	 * Provides EDID-Like-Data from connected HDMI device.
80 	 * Optional
81 	 */
82 	int (*get_eld)(struct device *dev, void *data,
83 		       uint8_t *buf, size_t len);
84 
85 	/*
86 	 * Getting DAI ID
87 	 * Optional
88 	 */
89 	int (*get_dai_id)(struct snd_soc_component *comment,
90 			  struct device_node *endpoint);
91 };
92 
93 /* HDMI codec initalization data */
94 struct hdmi_codec_pdata {
95 	const struct hdmi_codec_ops *ops;
96 	uint i2s:1;
97 	uint spdif:1;
98 	int max_i2s_channels;
99 	void *data;
100 };
101 
102 #define HDMI_CODEC_DRV_NAME "hdmi-audio-codec"
103 
104 #endif /* __HDMI_CODEC_H__ */
105