xref: /openbmc/linux/include/sound/hdmi-codec.h (revision 0883c2c0)
1 /*
2  * hdmi-codec.h - HDMI Codec driver API
3  *
4  * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com
5  *
6  * Author: Jyri Sarha <jsarha@ti.com>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  */
17 
18 #ifndef __HDMI_CODEC_H__
19 #define __HDMI_CODEC_H__
20 
21 #include <linux/hdmi.h>
22 #include <drm/drm_edid.h>
23 #include <sound/asoundef.h>
24 #include <uapi/sound/asound.h>
25 
26 /*
27  * Protocol between ASoC cpu-dai and HDMI-encoder
28  */
29 struct hdmi_codec_daifmt {
30 	enum {
31 		HDMI_I2S,
32 		HDMI_RIGHT_J,
33 		HDMI_LEFT_J,
34 		HDMI_DSP_A,
35 		HDMI_DSP_B,
36 		HDMI_AC97,
37 		HDMI_SPDIF,
38 	} fmt;
39 	int bit_clk_inv:1;
40 	int frame_clk_inv:1;
41 	int bit_clk_master:1;
42 	int frame_clk_master:1;
43 };
44 
45 /*
46  * HDMI audio parameters
47  */
48 struct hdmi_codec_params {
49 	struct hdmi_audio_infoframe cea;
50 	struct snd_aes_iec958 iec;
51 	int sample_rate;
52 	int sample_width;
53 	int channels;
54 };
55 
56 struct hdmi_codec_ops {
57 	/*
58 	 * Called when ASoC starts an audio stream setup.
59 	 * Optional
60 	 */
61 	int (*audio_startup)(struct device *dev);
62 
63 	/*
64 	 * Configures HDMI-encoder for audio stream.
65 	 * Mandatory
66 	 */
67 	int (*hw_params)(struct device *dev,
68 			 struct hdmi_codec_daifmt *fmt,
69 			 struct hdmi_codec_params *hparms);
70 
71 	/*
72 	 * Shuts down the audio stream.
73 	 * Mandatory
74 	 */
75 	void (*audio_shutdown)(struct device *dev);
76 
77 	/*
78 	 * Mute/unmute HDMI audio stream.
79 	 * Optional
80 	 */
81 	int (*digital_mute)(struct device *dev, bool enable);
82 
83 	/*
84 	 * Provides EDID-Like-Data from connected HDMI device.
85 	 * Optional
86 	 */
87 	int (*get_eld)(struct device *dev, uint8_t *buf, size_t len);
88 };
89 
90 /* HDMI codec initalization data */
91 struct hdmi_codec_pdata {
92 	const struct hdmi_codec_ops *ops;
93 	uint i2s:1;
94 	uint spdif:1;
95 	int max_i2s_channels;
96 };
97 
98 #define HDMI_CODEC_DRV_NAME "hdmi-audio-codec"
99 
100 #endif /* __HDMI_CODEC_H__ */
101