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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * hdmi-codec.h - HDMI Codec driver API
 *
 * Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com
 *
 * Author: Jyri Sarha <jsarha@ti.com>
 */

#ifndef __HDMI_CODEC_H__
#define __HDMI_CODEC_H__

#include <linux/of_graph.h>
#include <linux/hdmi.h>
#include <sound/asoundef.h>
#include <sound/soc.h>
#include <uapi/sound/asound.h>

/*
 * Protocol between ASoC cpu-dai and HDMI-encoder
 */
struct hdmi_codec_daifmt {
	enum {
		HDMI_I2S,
		HDMI_RIGHT_J,
		HDMI_LEFT_J,
		HDMI_DSP_A,
		HDMI_DSP_B,
		HDMI_AC97,
		HDMI_SPDIF,
	} fmt;
	unsigned int bit_clk_inv:1;
	unsigned int frame_clk_inv:1;
	unsigned int bit_clk_provider:1;
	unsigned int frame_clk_provider:1;
	/* bit_fmt could be standard PCM format or
	 * IEC958 encoded format. ALSA IEC958 plugin will pass
	 * IEC958_SUBFRAME format to the underneath driver.
	 */
	snd_pcm_format_t bit_fmt;
};

/*
 * HDMI audio parameters
 */
struct hdmi_codec_params {
	struct hdmi_audio_infoframe cea;
	struct snd_aes_iec958 iec;
	int sample_rate;
	int sample_width;
	int channels;
};

typedef void (*hdmi_codec_plugged_cb)(struct device *dev,
				      bool plugged);

struct hdmi_codec_pdata;
struct hdmi_codec_ops {
	/*
	 * Called when ASoC starts an audio stream setup.
	 * Optional
	 */
	int (*audio_startup)(struct device *dev, void *data);

	/*
	 * Configures HDMI-encoder for audio stream.
	 * Having either prepare or hw_params is mandatory.
	 */
	int (*hw_params)(struct device *dev, void *data,
			 struct hdmi_codec_daifmt *fmt,
			 struct hdmi_codec_params *hparms);

	/*
	 * Configures HDMI-encoder for audio stream. Can be called
	 * multiple times for each setup.
	 *
	 * Having either prepare or hw_params is mandatory.
	 */
	int (*prepare)(struct device *dev, void *data,
		       struct hdmi_codec_daifmt *fmt,
		       struct hdmi_codec_params *hparms);

	/*
	 * Shuts down the audio stream.
	 * Mandatory
	 */
	void (*audio_shutdown)(struct device *dev, void *data);

	/*
	 * Mute/unmute HDMI audio stream.
	 * Optional
	 */
	int (*mute_stream)(struct device *dev, void *data,
			   bool enable, int direction);

	/*
	 * Provides EDID-Like-Data from connected HDMI device.
	 * Optional
	 */
	int (*get_eld)(struct device *dev, void *data,
		       uint8_t *buf, size_t len);

	/*
	 * Getting DAI ID
	 * Optional
	 */
	int (*get_dai_id)(struct snd_soc_component *comment,
			  struct device_node *endpoint);

	/*
	 * Hook callback function to handle connector plug event.
	 * Optional
	 */
	int (*hook_plugged_cb)(struct device *dev, void *data,
			       hdmi_codec_plugged_cb fn,
			       struct device *codec_dev);

	/* bit field */
	unsigned int no_capture_mute:1;
};

/* HDMI codec initalization data */
struct hdmi_codec_pdata {
	const struct hdmi_codec_ops *ops;
	uint i2s:1;
	uint no_i2s_playback:1;
	uint no_i2s_capture:1;
	uint spdif:1;
	uint no_spdif_playback:1;
	uint no_spdif_capture:1;
	int max_i2s_channels;
	void *data;
};

struct snd_soc_component;
struct snd_soc_jack;

#define HDMI_CODEC_DRV_NAME "hdmi-audio-codec"

#endif /* __HDMI_CODEC_H__ */
Commit	Line	Data
1802d0be	1	/* SPDX-License-Identifier: GPL-2.0-only */
09184118 JS	2	/*
	3	* hdmi-codec.h - HDMI Codec driver API
	4	*
7ed33ea6	5	* Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com
09184118 JS	6	*
09184118 JS	7	* Author: Jyri Sarha <jsarha@ti.com>
09184118 JS	8	*/
	9
	10	#ifndef __HDMI_CODEC_H__
	11	#define __HDMI_CODEC_H__
	12
96203fb4	13	#include <linux/of_graph.h>
09184118	14	#include <linux/hdmi.h>
09184118	15	#include <sound/asoundef.h>
96203fb4	16	#include <sound/soc.h>
09184118 JS	17	#include <uapi/sound/asound.h>
	18
	19	/*
	20	* Protocol between ASoC cpu-dai and HDMI-encoder
	21	*/
	22	struct hdmi_codec_daifmt {
	23	enum {
	24	HDMI_I2S,
	25	HDMI_RIGHT_J,
	26	HDMI_LEFT_J,
	27	HDMI_DSP_A,
	28	HDMI_DSP_B,
	29	HDMI_AC97,
	30	HDMI_SPDIF,
	31	} fmt;
9e4d59ad TS	32	unsigned int bit_clk_inv:1;
9e4d59ad TS	33	unsigned int frame_clk_inv:1;
9f1c8677 MB	34	unsigned int bit_clk_provider:1;
9f1c8677 MB	35	unsigned int frame_clk_provider:1;
28785f54 SJH	36	/* bit_fmt could be standard PCM format or
	37	* IEC958 encoded format. ALSA IEC958 plugin will pass
	38	* IEC958_SUBFRAME format to the underneath driver.
	39	*/
	40	snd_pcm_format_t bit_fmt;
09184118 JS	41	};
	42
	43	/*
	44	* HDMI audio parameters
	45	*/
	46	struct hdmi_codec_params {
	47	struct hdmi_audio_infoframe cea;
	48	struct snd_aes_iec958 iec;
	49	int sample_rate;
	50	int sample_width;
	51	int channels;
	52	};
	53
6fa5963c CYC	54	typedef void (hdmi_codec_plugged_cb)(struct device dev,
	55	bool plugged);
	56
efc9194b	57	struct hdmi_codec_pdata;
09184118 JS	58	struct hdmi_codec_ops {
	59	/*
	60	* Called when ASoC starts an audio stream setup.
	61	* Optional
	62	*/
efc9194b	63	int (audio_startup)(struct device dev, void *data);
09184118 JS	64
	65	/*
	66	* Configures HDMI-encoder for audio stream.
2fef64ee	67	* Having either prepare or hw_params is mandatory.
09184118	68	*/
efc9194b	69	int (hw_params)(struct device dev, void *data,
09184118 JS	70	struct hdmi_codec_daifmt *fmt,
	71	struct hdmi_codec_params *hparms);
	72
2fef64ee MR	73	/*
	74	* Configures HDMI-encoder for audio stream. Can be called
	75	* multiple times for each setup.
	76	*
	77	* Having either prepare or hw_params is mandatory.
	78	*/
	79	int (prepare)(struct device dev, void *data,
	80	struct hdmi_codec_daifmt *fmt,
	81	struct hdmi_codec_params *hparms);
	82
09184118 JS	83	/*
	84	* Shuts down the audio stream.
	85	* Mandatory
	86	*/
efc9194b	87	void (audio_shutdown)(struct device dev, void *data);
09184118 JS	88
	89	/*
	90	* Mute/unmute HDMI audio stream.
	91	* Optional
	92	*/
d789710f KM	93	int (mute_stream)(struct device dev, void *data,
d789710f KM	94	bool enable, int direction);
09184118 JS	95
	96	/*
	97	* Provides EDID-Like-Data from connected HDMI device.
	98	* Optional
	99	*/
efc9194b KM	100	int (get_eld)(struct device dev, void *data,
efc9194b KM	101	uint8_t *buf, size_t len);
96203fb4 KM	102
	103	/*
	104	* Getting DAI ID
	105	* Optional
	106	*/
	107	int (get_dai_id)(struct snd_soc_component comment,
	108	struct device_node *endpoint);
6fa5963c CYC	109
	110	/*
	111	* Hook callback function to handle connector plug event.
	112	* Optional
	113	*/
	114	int (hook_plugged_cb)(struct device dev, void *data,
	115	hdmi_codec_plugged_cb fn,
	116	struct device *codec_dev);
d789710f KM	117
	118	/* bit field */
	119	unsigned int no_capture_mute:1;
09184118 JS	120	};
	121
	122	/* HDMI codec initalization data */
	123	struct hdmi_codec_pdata {
	124	const struct hdmi_codec_ops *ops;
	125	uint i2s:1;
f77a066f MB	126	uint no_i2s_playback:1;
f77a066f MB	127	uint no_i2s_capture:1;
09184118	128	uint spdif:1;
f77a066f MB	129	uint no_spdif_playback:1;
f77a066f MB	130	uint no_spdif_capture:1;
09184118	131	int max_i2s_channels;
efc9194b	132	void *data;
09184118 JS	133	};
09184118 JS	134
6fa5963c CYC	135	struct snd_soc_component;
	136	struct snd_soc_jack;
	137
09184118 JS	138	#define HDMI_CODEC_DRV_NAME "hdmi-audio-codec"
	139
	140	#endif /* __HDMI_CODEC_H__ */