[mirror_ubuntu-artful-kernel.git] / sound / x86 / intel_hdmi_audio.h

/*
 * Copyright (C) 2016 Intel Corporation
 *  Authors:	Sailaja Bandarupalli <sailaja.bandarupalli@intel.com>
 *		Ramesh Babu K V	<ramesh.babu@intel.com>
 *		Vaibhav Agarwal <vaibhav.agarwal@intel.com>
 *		Jerome Anand <jerome.anand@intel.com>
 *
 * 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, sublicense, 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
 * NONINFRINGEMENT.  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 _INTEL_HDMI_AUDIO_H_
#define _INTEL_HDMI_AUDIO_H_

#include "intel_hdmi_lpe_audio.h"

#define PCM_INDEX		0
#define MAX_PB_STREAMS		1
#define MAX_CAP_STREAMS		0
#define BYTES_PER_WORD		0x4
#define INTEL_HAD		"HdmiLpeAudio"

/*
 *	CEA speaker placement:
 *
 *	FL  FLC   FC   FRC   FR
 *
 *						LFE
 *
 *	RL  RLC   RC   RRC   RR
 *
 *	The Left/Right Surround channel _notions_ LS/RS in SMPTE 320M
 *	corresponds to CEA RL/RR; The SMPTE channel _assignment_ C/LFE is
 *	swapped to CEA LFE/FC.
 */
enum cea_speaker_placement {
	FL  = (1 <<  0),        /* Front Left           */
	FC  = (1 <<  1),        /* Front Center         */
	FR  = (1 <<  2),        /* Front Right          */
	FLC = (1 <<  3),        /* Front Left Center    */
	FRC = (1 <<  4),        /* Front Right Center   */
	RL  = (1 <<  5),        /* Rear Left            */
	RC  = (1 <<  6),        /* Rear Center          */
	RR  = (1 <<  7),        /* Rear Right           */
	RLC = (1 <<  8),        /* Rear Left Center     */
	RRC = (1 <<  9),        /* Rear Right Center    */
	LFE = (1 << 10),        /* Low Frequency Effect */
};

struct cea_channel_speaker_allocation {
	int ca_index;
	int speakers[8];

	/* derived values, just for convenience */
	int channels;
	int spk_mask;
};

struct channel_map_table {
	unsigned char map;              /* ALSA API channel map position */
	unsigned char cea_slot;         /* CEA slot value */
	int spk_mask;                   /* speaker position bit mask */
};

struct pcm_stream_info {
	struct snd_pcm_substream *substream;
	int substream_refcount;
};

/*
 * struct snd_intelhad - intelhad driver structure
 *
 * @card: ptr to hold card details
 * @connected: the monitor connection status
 * @stream_info: stream information
 * @eld: holds ELD info
 * @curr_buf: pointer to hold current active ring buf
 * @valid_buf_cnt: ring buffer count for stream
 * @had_spinlock: driver lock
 * @aes_bits: IEC958 status bits
 * @buff_done: id of current buffer done intr
 * @dev: platoform device handle
 * @chmap: holds channel map info
 */
struct snd_intelhad {
	struct snd_card	*card;
	bool		connected;
	struct		pcm_stream_info stream_info;
	unsigned char	eld[HDMI_MAX_ELD_BYTES];
	bool dp_output;
	unsigned int	aes_bits;
	spinlock_t had_spinlock;
	struct device *dev;
	struct snd_pcm_chmap *chmap;
	int tmds_clock_speed;
	int link_rate;

	/* ring buffer (BD) position index */
	unsigned int bd_head;
	/* PCM buffer position indices */
	unsigned int pcmbuf_head;	/* being processed */
	unsigned int pcmbuf_filled;	/* to be filled */

	unsigned int num_bds;		/* number of BDs */
	unsigned int period_bytes;	/* PCM period size in bytes */

	/* internal stuff */
	int irq;
	void __iomem *mmio_start;
	unsigned int had_config_offset;
	union aud_cfg aud_config;	/* AUD_CONFIG reg value cache */
	struct work_struct hdmi_audio_wq;
	struct mutex mutex; /* for protecting chmap and eld */
	bool need_reset;
	struct snd_jack *jack;
};

#endif /* _INTEL_HDMI_AUDIO_ */
Commit	Line	Data
5dab11d8 JA	1	/*
	2	* Copyright (C) 2016 Intel Corporation
	3	* Authors: Sailaja Bandarupalli <sailaja.bandarupalli@intel.com>
	4	* Ramesh Babu K V <ramesh.babu@intel.com>
	5	* Vaibhav Agarwal <vaibhav.agarwal@intel.com>
	6	* Jerome Anand <jerome.anand@intel.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining
	9	* a copy of this software and associated documentation files
	10	* (the "Software"), to deal in the Software without restriction,
	11	* including without limitation the rights to use, copy, modify, merge,
	12	* publish, distribute, sublicense, and/or sell copies of the Software,
	13	* and to permit persons to whom the Software is furnished to do so,
	14	* subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice (including the
	17	* next paragraph) shall be included in all copies or substantial
	18	* portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	21	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	22	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	23	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	24	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	25	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	26	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#ifndef _INTEL_HDMI_AUDIO_H_
	31	#define _INTEL_HDMI_AUDIO_H_
	32
5dab11d8 JA	33	#include "intel_hdmi_lpe_audio.h"
	34
	35	#define PCM_INDEX 0
	36	#define MAX_PB_STREAMS 1
	37	#define MAX_CAP_STREAMS 0
5dab11d8	38	#define BYTES_PER_WORD 0x4
77531bee TI	39	#define INTEL_HAD "HdmiLpeAudio"
	40
	41	/*
	42	* CEA speaker placement:
	43	*
	44	* FL FLC FC FRC FR
	45	*
	46	* LFE
	47	*
	48	* RL RLC RC RRC RR
	49	*
	50	* The Left/Right Surround channel _notions_ LS/RS in SMPTE 320M
	51	* corresponds to CEA RL/RR; The SMPTE channel _assignment_ C/LFE is
	52	* swapped to CEA LFE/FC.
	53	*/
	54	enum cea_speaker_placement {
	55	FL = (1 << 0), /* Front Left */
	56	FC = (1 << 1), /* Front Center */
	57	FR = (1 << 2), /* Front Right */
	58	FLC = (1 << 3), /* Front Left Center */
	59	FRC = (1 << 4), /* Front Right Center */
	60	RL = (1 << 5), /* Rear Left */
	61	RC = (1 << 6), /* Rear Center */
	62	RR = (1 << 7), /* Rear Right */
	63	RLC = (1 << 8), /* Rear Left Center */
	64	RRC = (1 << 9), /* Rear Right Center */
	65	LFE = (1 << 10), /* Low Frequency Effect */
	66	};
5dab11d8	67
77531bee TI	68	struct cea_channel_speaker_allocation {
	69	int ca_index;
	70	int speakers[8];
5dab11d8	71
77531bee TI	72	/* derived values, just for convenience */
	73	int channels;
	74	int spk_mask;
	75	};
	76
	77	struct channel_map_table {
	78	unsigned char map; /* ALSA API channel map position */
	79	unsigned char cea_slot; /* CEA slot value */
	80	int spk_mask; /* speaker position bit mask */
	81	};
5dab11d8 JA	82
5dab11d8 JA	83	struct pcm_stream_info {
313d9f28	84	struct snd_pcm_substream *substream;
313d9f28	85	int substream_refcount;
5dab11d8 JA	86	};
5dab11d8 JA	87
03c34377	88	/*
5dab11d8 JA	89	* struct snd_intelhad - intelhad driver structure
	90	*
	91	* @card: ptr to hold card details
91b0cb0c	92	* @connected: the monitor connection status
5dab11d8	93	* @stream_info: stream information
da864809	94	* @eld: holds ELD info
5dab11d8 JA	95	* @curr_buf: pointer to hold current active ring buf
	96	* @valid_buf_cnt: ring buffer count for stream
	97	* @had_spinlock: driver lock
	98	* @aes_bits: IEC958 status bits
	99	* @buff_done: id of current buffer done intr
	100	* @dev: platoform device handle
5dab11d8	101	* @chmap: holds channel map info
5dab11d8 JA	102	*/
	103	struct snd_intelhad {
	104	struct snd_card *card;
91b0cb0c	105	bool connected;
5dab11d8	106	struct pcm_stream_info stream_info;
df0435db	107	unsigned char eld[HDMI_MAX_ELD_BYTES];
964ca808	108	bool dp_output;
5dab11d8	109	unsigned int aes_bits;
5dab11d8	110	spinlock_t had_spinlock;
5dab11d8	111	struct device *dev;
5dab11d8	112	struct snd_pcm_chmap *chmap;
da864809 TI	113	int tmds_clock_speed;
	114	int link_rate;
	115
e1b239f3 TI	116	/* ring buffer (BD) position index */
	117	unsigned int bd_head;
	118	/* PCM buffer position indices */
	119	unsigned int pcmbuf_head; /* being processed */
	120	unsigned int pcmbuf_filled; /* to be filled */
	121
	122	unsigned int num_bds; /* number of BDs */
	123	unsigned int period_bytes; /* PCM period size in bytes */
	124
da864809 TI	125	/* internal stuff */
	126	int irq;
	127	void __iomem *mmio_start;
	128	unsigned int had_config_offset;
40ce4b5d	129	union aud_cfg aud_config; /* AUD_CONFIG reg value cache */
da864809	130	struct work_struct hdmi_audio_wq;
0e9c67d7	131	struct mutex mutex; /* for protecting chmap and eld */
e2acecf2	132	bool need_reset;
b9bacf27	133	struct snd_jack *jack;
5dab11d8 JA	134	};
5dab11d8 JA	135
5dab11d8	136	#endif /* _INTEL_HDMI_AUDIO_ */