[mirror_ubuntu-artful-kernel.git] / sound / pci / oxygen / oxygen.h

#ifndef OXYGEN_H_INCLUDED
#define OXYGEN_H_INCLUDED

#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/workqueue.h>
#include "oxygen_regs.h"

/* 1 << PCM_x == OXYGEN_CHANNEL_x */
#define PCM_A		0
#define PCM_B		1
#define PCM_C		2
#define PCM_SPDIF	3
#define PCM_MULTICH	4
#define PCM_AC97	5
#define PCM_COUNT	6

/* model-specific configuration of outputs/inputs */
#define PLAYBACK_0_TO_I2S	0x001
#define PLAYBACK_1_TO_SPDIF	0x004
#define PLAYBACK_2_TO_AC97_1	0x008
#define CAPTURE_0_FROM_I2S_1	0x010
#define CAPTURE_0_FROM_I2S_2	0x020
#define CAPTURE_1_FROM_SPDIF	0x080
#define CAPTURE_2_FROM_I2S_2	0x100
#define CAPTURE_2_FROM_AC97_1	0x200

enum {
	CONTROL_SPDIF_PCM,
	CONTROL_SPDIF_INPUT_BITS,
	CONTROL_MIC_CAPTURE_SWITCH,
	CONTROL_LINE_CAPTURE_SWITCH,
	CONTROL_CD_CAPTURE_SWITCH,
	CONTROL_AUX_CAPTURE_SWITCH,
	CONTROL_COUNT
};

#define OXYGEN_PCI_SUBID(sv, sd) \
	.vendor = PCI_VENDOR_ID_CMEDIA, \
	.device = 0x8788, \
	.subvendor = sv, \
	.subdevice = sd

struct pci_dev;
struct snd_card;
struct snd_pcm_substream;
struct snd_pcm_hardware;
struct snd_pcm_hw_params;
struct snd_kcontrol_new;
struct snd_rawmidi;
struct oxygen_model;

struct oxygen {
	unsigned long addr;
	spinlock_t reg_lock;
	struct mutex mutex;
	struct snd_card *card;
	struct pci_dev *pci;
	struct snd_rawmidi *midi;
	int irq;
	const struct oxygen_model *model;
	void *model_data;
	unsigned int interrupt_mask;
	u8 dac_volume[8];
	u8 dac_mute;
	u8 pcm_active;
	u8 pcm_running;
	u8 dac_routing;
	u8 spdif_playback_enable;
	u8 revision;
	u8 has_ac97_0;
	u8 has_ac97_1;
	u32 spdif_bits;
	u32 spdif_pcm_bits;
	struct snd_pcm_substream *streams[PCM_COUNT];
	struct snd_kcontrol *controls[CONTROL_COUNT];
	struct work_struct spdif_input_bits_work;
	struct work_struct gpio_work;
	wait_queue_head_t ac97_waitqueue;
};

struct oxygen_model {
	const char *shortname;
	const char *longname;
	const char *chip;
	struct module *owner;
	void (*init)(struct oxygen *chip);
	int (*control_filter)(struct snd_kcontrol_new *template);
	int (*mixer_init)(struct oxygen *chip);
	void (*cleanup)(struct oxygen *chip);
	void (*pcm_hardware_filter)(unsigned int channel,
				    struct snd_pcm_hardware *hardware);
	void (*set_dac_params)(struct oxygen *chip,
			       struct snd_pcm_hw_params *params);
	void (*set_adc_params)(struct oxygen *chip,
			       struct snd_pcm_hw_params *params);
	void (*update_dac_volume)(struct oxygen *chip);
	void (*update_dac_mute)(struct oxygen *chip);
	void (*gpio_changed)(struct oxygen *chip);
	size_t model_data_size;
	unsigned int pcm_dev_cfg;
	u8 dac_channels;
	u8 misc_flags;
	u8 function_flags;
	u16 dac_i2s_format;
	u16 adc_i2s_format;
};

/* oxygen_lib.c */

int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
		     const struct oxygen_model *model);
void oxygen_pci_remove(struct pci_dev *pci);

/* oxygen_mixer.c */

int oxygen_mixer_init(struct oxygen *chip);
void oxygen_update_dac_routing(struct oxygen *chip);
void oxygen_update_spdif_source(struct oxygen *chip);

/* oxygen_pcm.c */

int oxygen_pcm_init(struct oxygen *chip);

/* oxygen_io.c */

u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
			  u8 value, u8 mask);
void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
			   u16 value, u16 mask);
void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
			   u32 value, u32 mask);

u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
		     unsigned int index);
void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
		       unsigned int index, u16 data);
void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
			      unsigned int index, u16 data, u16 mask);

void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);

static inline void oxygen_set_bits8(struct oxygen *chip,
				    unsigned int reg, u8 value)
{
	oxygen_write8_masked(chip, reg, value, value);
}

static inline void oxygen_set_bits16(struct oxygen *chip,
				     unsigned int reg, u16 value)
{
	oxygen_write16_masked(chip, reg, value, value);
}

static inline void oxygen_set_bits32(struct oxygen *chip,
				     unsigned int reg, u32 value)
{
	oxygen_write32_masked(chip, reg, value, value);
}

static inline void oxygen_clear_bits8(struct oxygen *chip,
				      unsigned int reg, u8 value)
{
	oxygen_write8_masked(chip, reg, 0, value);
}

static inline void oxygen_clear_bits16(struct oxygen *chip,
				       unsigned int reg, u16 value)
{
	oxygen_write16_masked(chip, reg, 0, value);
}

static inline void oxygen_clear_bits32(struct oxygen *chip,
				       unsigned int reg, u32 value)
{
	oxygen_write32_masked(chip, reg, 0, value);
}

static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
					unsigned int index, u16 value)
{
	oxygen_write_ac97_masked(chip, codec, index, value, value);
}

static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
					  unsigned int codec,
					  unsigned int index, u16 value)
{
	oxygen_write_ac97_masked(chip, codec, index, 0, value);
}

#endif
Commit	Line	Data
d0ce9946 CL	1	#ifndef OXYGEN_H_INCLUDED
	2	#define OXYGEN_H_INCLUDED
	3
	4	#include <linux/mutex.h>
	5	#include <linux/spinlock.h>
1e821dd2	6	#include <linux/wait.h>
d0ce9946 CL	7	#include <linux/workqueue.h>
	8	#include "oxygen_regs.h"
	9
	10	/* 1 << PCM_x == OXYGEN_CHANNEL_x */
	11	#define PCM_A 0
	12	#define PCM_B 1
	13	#define PCM_C 2
	14	#define PCM_SPDIF 3
	15	#define PCM_MULTICH 4
	16	#define PCM_AC97 5
	17	#define PCM_COUNT 6
	18
f009ad9b CL	19	/* model-specific configuration of outputs/inputs */
	20	#define PLAYBACK_0_TO_I2S 0x001
	21	#define PLAYBACK_1_TO_SPDIF 0x004
	22	#define PLAYBACK_2_TO_AC97_1 0x008
	23	#define CAPTURE_0_FROM_I2S_1 0x010
	24	#define CAPTURE_0_FROM_I2S_2 0x020
	25	#define CAPTURE_1_FROM_SPDIF 0x080
	26	#define CAPTURE_2_FROM_I2S_2 0x100
	27	#define CAPTURE_2_FROM_AC97_1 0x200
	28
01a3affb CL	29	enum {
	30	CONTROL_SPDIF_PCM,
	31	CONTROL_SPDIF_INPUT_BITS,
893e44ba CL	32	CONTROL_MIC_CAPTURE_SWITCH,
	33	CONTROL_LINE_CAPTURE_SWITCH,
	34	CONTROL_CD_CAPTURE_SWITCH,
	35	CONTROL_AUX_CAPTURE_SWITCH,
01a3affb CL	36	CONTROL_COUNT
	37	};
	38
d0ce9946 CL	39	#define OXYGEN_PCI_SUBID(sv, sd) \
	40	.vendor = PCI_VENDOR_ID_CMEDIA, \
	41	.device = 0x8788, \
	42	.subvendor = sv, \
	43	.subdevice = sd
	44
	45	struct pci_dev;
	46	struct snd_card;
	47	struct snd_pcm_substream;
747c6016	48	struct snd_pcm_hardware;
d0ce9946	49	struct snd_pcm_hw_params;
ccc80fb4	50	struct snd_kcontrol_new;
d0ce9946 CL	51	struct snd_rawmidi;
	52	struct oxygen_model;
	53
	54	struct oxygen {
	55	unsigned long addr;
	56	spinlock_t reg_lock;
	57	struct mutex mutex;
	58	struct snd_card *card;
	59	struct pci_dev *pci;
	60	struct snd_rawmidi *midi;
	61	int irq;
	62	const struct oxygen_model *model;
7ef37cd9	63	void *model_data;
d0ce9946 CL	64	unsigned int interrupt_mask;
	65	u8 dac_volume[8];
	66	u8 dac_mute;
	67	u8 pcm_active;
	68	u8 pcm_running;
	69	u8 dac_routing;
	70	u8 spdif_playback_enable;
d0ce9946	71	u8 revision;
31c77643 CL	72	u8 has_ac97_0;
31c77643 CL	73	u8 has_ac97_1;
d0ce9946 CL	74	u32 spdif_bits;
	75	u32 spdif_pcm_bits;
	76	struct snd_pcm_substream *streams[PCM_COUNT];
01a3affb	77	struct snd_kcontrol *controls[CONTROL_COUNT];
d0ce9946	78	struct work_struct spdif_input_bits_work;
7c014159	79	struct work_struct gpio_work;
1e821dd2	80	wait_queue_head_t ac97_waitqueue;
d0ce9946 CL	81	};
	82
	83	struct oxygen_model {
	84	const char *shortname;
	85	const char *longname;
	86	const char *chip;
	87	struct module *owner;
	88	void (init)(struct oxygen chip);
ccc80fb4	89	int (control_filter)(struct snd_kcontrol_new template);
d0ce9946 CL	90	int (mixer_init)(struct oxygen chip);
d0ce9946 CL	91	void (cleanup)(struct oxygen chip);
747c6016 CL	92	void (*pcm_hardware_filter)(unsigned int channel,
747c6016 CL	93	struct snd_pcm_hardware *hardware);
d0ce9946 CL	94	void (set_dac_params)(struct oxygen chip,
	95	struct snd_pcm_hw_params *params);
	96	void (set_adc_params)(struct oxygen chip,
	97	struct snd_pcm_hw_params *params);
	98	void (update_dac_volume)(struct oxygen chip);
	99	void (update_dac_mute)(struct oxygen chip);
7c014159	100	void (gpio_changed)(struct oxygen chip);
7ef37cd9	101	size_t model_data_size;
f009ad9b	102	unsigned int pcm_dev_cfg;
976cd627	103	u8 dac_channels;
db12b8e3	104	u8 misc_flags;
84aa6b7b	105	u8 function_flags;
05855ba3 CL	106	u16 dac_i2s_format;
05855ba3 CL	107	u16 adc_i2s_format;
d0ce9946 CL	108	};
	109
	110	/* oxygen_lib.c */
	111
db12b8e3	112	int oxygen_pci_probe(struct pci_dev pci, int index, char id,
d0ce9946 CL	113	const struct oxygen_model *model);
	114	void oxygen_pci_remove(struct pci_dev *pci);
	115
	116	/* oxygen_mixer.c */
	117
	118	int oxygen_mixer_init(struct oxygen *chip);
	119	void oxygen_update_dac_routing(struct oxygen *chip);
	120	void oxygen_update_spdif_source(struct oxygen *chip);
	121
	122	/* oxygen_pcm.c */
	123
	124	int oxygen_pcm_init(struct oxygen *chip);
	125
	126	/* oxygen_io.c */
	127
	128	u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
	129	u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
	130	u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
	131	void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
	132	void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
	133	void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
	134	void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
	135	u8 value, u8 mask);
	136	void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
	137	u16 value, u16 mask);
	138	void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
	139	u32 value, u32 mask);
	140
	141	u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
	142	unsigned int index);
	143	void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
	144	unsigned int index, u16 data);
	145	void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
	146	unsigned int index, u16 data, u16 mask);
	147
	148	void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
	149
	150	static inline void oxygen_set_bits8(struct oxygen *chip,
	151	unsigned int reg, u8 value)
	152	{
	153	oxygen_write8_masked(chip, reg, value, value);
	154	}
	155
	156	static inline void oxygen_set_bits16(struct oxygen *chip,
	157	unsigned int reg, u16 value)
	158	{
	159	oxygen_write16_masked(chip, reg, value, value);
	160	}
	161
	162	static inline void oxygen_set_bits32(struct oxygen *chip,
	163	unsigned int reg, u32 value)
	164	{
	165	oxygen_write32_masked(chip, reg, value, value);
	166	}
	167
	168	static inline void oxygen_clear_bits8(struct oxygen *chip,
	169	unsigned int reg, u8 value)
	170	{
	171	oxygen_write8_masked(chip, reg, 0, value);
	172	}
	173
	174	static inline void oxygen_clear_bits16(struct oxygen *chip,
	175	unsigned int reg, u16 value)
	176	{
177	oxygen_write16_masked(chip, reg, 0, value);
178	}
179
180	static inline void oxygen_clear_bits32(struct oxygen *chip,
181	unsigned int reg, u32 value)
182	{
183	oxygen_write32_masked(chip, reg, 0, value);
184	}
185
186	static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
187	unsigned int index, u16 value)
188	{
189	oxygen_write_ac97_masked(chip, codec, index, value, value);
190	}
191
192	static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
193	unsigned int codec,
194	unsigned int index, u16 value)
195	{
196	oxygen_write_ac97_masked(chip, codec, index, 0, value);
197	}
198
199	#endif