[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

#define OXYGEN_IO_SIZE	0x100

#define OXYGEN_EEPROM_ID	0x434d	/* "CM" */

/* model-specific configuration of outputs/inputs */
#define PLAYBACK_0_TO_I2S	0x0001
     /* PLAYBACK_0_TO_AC97_0		not implemented */
#define PLAYBACK_1_TO_SPDIF	0x0004
#define PLAYBACK_2_TO_AC97_1	0x0008
#define CAPTURE_0_FROM_I2S_1	0x0010
#define CAPTURE_0_FROM_I2S_2	0x0020
     /* CAPTURE_0_FROM_AC97_0		not implemented */
#define CAPTURE_1_FROM_SPDIF	0x0080
#define CAPTURE_2_FROM_I2S_2	0x0100
#define CAPTURE_2_FROM_AC97_1	0x0200
     /* CAPTURE_3_FROM_I2S_3		not implemented */
#define MIDI_OUTPUT		0x0800
#define MIDI_INPUT		0x1000
#define AC97_CD_INPUT		0x2000
#define AC97_FMIC_SWITCH	0x4000

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

#define BROKEN_EEPROM_DRIVER_DATA ((unsigned long)-1)
#define OXYGEN_PCI_SUBID_BROKEN_EEPROM \
	OXYGEN_PCI_SUBID(PCI_VENDOR_ID_CMEDIA, 0x8788), \
	.driver_data = BROKEN_EEPROM_DRIVER_DATA

struct pci_dev;
struct pci_device_id;
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;

struct oxygen_model {
	const char *shortname;
	const char *longname;
	const char *chip;
	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 (*suspend)(struct oxygen *chip);
	void (*resume)(struct oxygen *chip);
	void (*pcm_hardware_filter)(unsigned int channel,
				    struct snd_pcm_hardware *hardware);
	unsigned int (*get_i2s_mclk)(struct oxygen *chip, unsigned int channel,
				     struct snd_pcm_hw_params *hw_params);
	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 (*update_center_lfe_mix)(struct oxygen *chip, bool mixed);
	void (*gpio_changed)(struct oxygen *chip);
	void (*uart_input)(struct oxygen *chip);
	void (*ac97_switch)(struct oxygen *chip,
			    unsigned int reg, unsigned int mute);
	const unsigned int *dac_tlv;
	unsigned long private_data;
	size_t model_data_size;
	unsigned int device_config;
	u8 dac_channels;
	u8 dac_volume_min;
	u8 dac_volume_max;
	u8 misc_flags;
	u8 function_flags;
	u16 dac_i2s_format;
	u16 adc_i2s_format;
};

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;
	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;
	union {
		u8 _8[OXYGEN_IO_SIZE];
		__le16 _16[OXYGEN_IO_SIZE / 2];
		__le32 _32[OXYGEN_IO_SIZE / 4];
	} saved_registers;
	u16 saved_ac97_registers[2][0x40];
	unsigned int uart_input_count;
	u8 uart_input[32];
	struct oxygen_model model;
};

/* oxygen_lib.c */

int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
		     struct module *owner,
		     const struct pci_device_id *ids,
		     int (*get_model)(struct oxygen *chip,
				      const struct pci_device_id *id
				     )
		    );
void oxygen_pci_remove(struct pci_dev *pci);
#ifdef CONFIG_PM
int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
int oxygen_pci_resume(struct pci_dev *pci);
#endif
void oxygen_pci_shutdown(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);
unsigned int oxygen_default_i2s_mclk(struct oxygen *chip, unsigned int channel,
				     struct snd_pcm_hw_params *hw_params);

/* 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);
void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);

void oxygen_reset_uart(struct oxygen *chip);
void oxygen_write_uart(struct oxygen *chip, u8 data);

u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);

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
c1365007 CL	19	#define OXYGEN_IO_SIZE 0x100
c1365007 CL	20
1275d6f6 CL	21	#define OXYGEN_EEPROM_ID 0x434d /* "CM" */
1275d6f6 CL	22
f009ad9b	23	/* model-specific configuration of outputs/inputs */
dbbbd674 CL	24	#define PLAYBACK_0_TO_I2S 0x0001
	25	/* PLAYBACK_0_TO_AC97_0 not implemented */
	26	#define PLAYBACK_1_TO_SPDIF 0x0004
	27	#define PLAYBACK_2_TO_AC97_1 0x0008
	28	#define CAPTURE_0_FROM_I2S_1 0x0010
	29	#define CAPTURE_0_FROM_I2S_2 0x0020
	30	/* CAPTURE_0_FROM_AC97_0 not implemented */
	31	#define CAPTURE_1_FROM_SPDIF 0x0080
	32	#define CAPTURE_2_FROM_I2S_2 0x0100
	33	#define CAPTURE_2_FROM_AC97_1 0x0200
	34	/* CAPTURE_3_FROM_I2S_3 not implemented */
	35	#define MIDI_OUTPUT 0x0800
	36	#define MIDI_INPUT 0x1000
b6ca8ab3	37	#define AC97_CD_INPUT 0x2000
e96f38f7	38	#define AC97_FMIC_SWITCH 0x4000
f009ad9b	39
01a3affb CL	40	enum {
	41	CONTROL_SPDIF_PCM,
	42	CONTROL_SPDIF_INPUT_BITS,
893e44ba CL	43	CONTROL_MIC_CAPTURE_SWITCH,
	44	CONTROL_LINE_CAPTURE_SWITCH,
	45	CONTROL_CD_CAPTURE_SWITCH,
	46	CONTROL_AUX_CAPTURE_SWITCH,
01a3affb CL	47	CONTROL_COUNT
	48	};
	49
d0ce9946 CL	50	#define OXYGEN_PCI_SUBID(sv, sd) \
	51	.vendor = PCI_VENDOR_ID_CMEDIA, \
	52	.device = 0x8788, \
	53	.subvendor = sv, \
	54	.subdevice = sd
	55
30459d7b CL	56	#define BROKEN_EEPROM_DRIVER_DATA ((unsigned long)-1)
	57	#define OXYGEN_PCI_SUBID_BROKEN_EEPROM \
	58	OXYGEN_PCI_SUBID(PCI_VENDOR_ID_CMEDIA, 0x8788), \
	59	.driver_data = BROKEN_EEPROM_DRIVER_DATA
	60
d0ce9946	61	struct pci_dev;
30459d7b	62	struct pci_device_id;
d0ce9946 CL	63	struct snd_card;
d0ce9946 CL	64	struct snd_pcm_substream;
747c6016	65	struct snd_pcm_hardware;
d0ce9946	66	struct snd_pcm_hw_params;
ccc80fb4	67	struct snd_kcontrol_new;
d0ce9946	68	struct snd_rawmidi;
9bd6a73a	69	struct oxygen;
d0ce9946 CL	70
	71	struct oxygen_model {
	72	const char *shortname;
	73	const char *longname;
	74	const char *chip;
d0ce9946	75	void (init)(struct oxygen chip);
ccc80fb4	76	int (control_filter)(struct snd_kcontrol_new template);
d0ce9946 CL	77	int (mixer_init)(struct oxygen chip);
d0ce9946 CL	78	void (cleanup)(struct oxygen chip);
4a4bc53b CL	79	void (suspend)(struct oxygen chip);
4a4bc53b CL	80	void (resume)(struct oxygen chip);
747c6016 CL	81	void (*pcm_hardware_filter)(unsigned int channel,
747c6016 CL	82	struct snd_pcm_hardware *hardware);
76ffe1e3 CL	83	unsigned int (get_i2s_mclk)(struct oxygen chip, unsigned int channel,
76ffe1e3 CL	84	struct snd_pcm_hw_params *hw_params);
d0ce9946 CL	85	void (set_dac_params)(struct oxygen chip,
	86	struct snd_pcm_hw_params *params);
	87	void (set_adc_params)(struct oxygen chip,
	88	struct snd_pcm_hw_params *params);
	89	void (update_dac_volume)(struct oxygen chip);
	90	void (update_dac_mute)(struct oxygen chip);
3d8bb454	91	void (update_center_lfe_mix)(struct oxygen chip, bool mixed);
7c014159	92	void (gpio_changed)(struct oxygen chip);
397b1dcc	93	void (uart_input)(struct oxygen chip);
11864b4b CL	94	void (ac97_switch)(struct oxygen chip,
11864b4b CL	95	unsigned int reg, unsigned int mute);
4972a177	96	const unsigned int *dac_tlv;
30459d7b	97	unsigned long private_data;
7ef37cd9	98	size_t model_data_size;
d76596b1	99	unsigned int device_config;
976cd627	100	u8 dac_channels;
193e8138 CL	101	u8 dac_volume_min;
193e8138 CL	102	u8 dac_volume_max;
db12b8e3	103	u8 misc_flags;
84aa6b7b	104	u8 function_flags;
05855ba3 CL	105	u16 dac_i2s_format;
05855ba3 CL	106	u16 adc_i2s_format;
d0ce9946 CL	107	};
d0ce9946 CL	108
9bd6a73a CL	109	struct oxygen {
	110	unsigned long addr;
	111	spinlock_t reg_lock;
	112	struct mutex mutex;
	113	struct snd_card *card;
	114	struct pci_dev *pci;
	115	struct snd_rawmidi *midi;
	116	int irq;
	117	void *model_data;
	118	unsigned int interrupt_mask;
	119	u8 dac_volume[8];
	120	u8 dac_mute;
	121	u8 pcm_active;
	122	u8 pcm_running;
	123	u8 dac_routing;
	124	u8 spdif_playback_enable;
	125	u8 revision;
	126	u8 has_ac97_0;
	127	u8 has_ac97_1;
	128	u32 spdif_bits;
	129	u32 spdif_pcm_bits;
	130	struct snd_pcm_substream *streams[PCM_COUNT];
	131	struct snd_kcontrol *controls[CONTROL_COUNT];
	132	struct work_struct spdif_input_bits_work;
	133	struct work_struct gpio_work;
	134	wait_queue_head_t ac97_waitqueue;
	135	union {
	136	u8 _8[OXYGEN_IO_SIZE];
	137	__le16 _16[OXYGEN_IO_SIZE / 2];
	138	__le32 _32[OXYGEN_IO_SIZE / 4];
	139	} saved_registers;
	140	u16 saved_ac97_registers[2][0x40];
397b1dcc CL	141	unsigned int uart_input_count;
397b1dcc CL	142	u8 uart_input[32];
9bd6a73a CL	143	struct oxygen_model model;
	144	};
	145
d0ce9946 CL	146	/* oxygen_lib.c */
d0ce9946 CL	147
db12b8e3	148	int oxygen_pci_probe(struct pci_dev pci, int index, char id,
bb718588	149	struct module *owner,
30459d7b CL	150	const struct pci_device_id *ids,
	151	int (get_model)(struct oxygen chip,
	152	const struct pci_device_id *id
	153	)
	154	);
d0ce9946	155	void oxygen_pci_remove(struct pci_dev *pci);
4a4bc53b CL	156	#ifdef CONFIG_PM
	157	int oxygen_pci_suspend(struct pci_dev *pci, pm_message_t state);
	158	int oxygen_pci_resume(struct pci_dev *pci);
	159	#endif
4c25b932	160	void oxygen_pci_shutdown(struct pci_dev *pci);
d0ce9946 CL	161
	162	/* oxygen_mixer.c */
	163
	164	int oxygen_mixer_init(struct oxygen *chip);
	165	void oxygen_update_dac_routing(struct oxygen *chip);
	166	void oxygen_update_spdif_source(struct oxygen *chip);
	167
	168	/* oxygen_pcm.c */
	169
	170	int oxygen_pcm_init(struct oxygen *chip);
76ffe1e3 CL	171	unsigned int oxygen_default_i2s_mclk(struct oxygen *chip, unsigned int channel,
76ffe1e3 CL	172	struct snd_pcm_hw_params *hw_params);
d0ce9946 CL	173
	174	/* oxygen_io.c */
	175
	176	u8 oxygen_read8(struct oxygen *chip, unsigned int reg);
	177	u16 oxygen_read16(struct oxygen *chip, unsigned int reg);
	178	u32 oxygen_read32(struct oxygen *chip, unsigned int reg);
	179	void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value);
	180	void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value);
	181	void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value);
	182	void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
	183	u8 value, u8 mask);
	184	void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
	185	u16 value, u16 mask);
	186	void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
	187	u32 value, u32 mask);
	188
	189	u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
	190	unsigned int index);
	191	void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
	192	unsigned int index, u16 data);
	193	void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
	194	unsigned int index, u16 data, u16 mask);
	195
	196	void oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data);
10e6d5f9	197	void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data);
d0ce9946	198
397b1dcc CL	199	void oxygen_reset_uart(struct oxygen *chip);
	200	void oxygen_write_uart(struct oxygen *chip, u8 data);
	201
30459d7b	202	u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index);
1275d6f6	203	void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value);
30459d7b	204
d0ce9946 CL	205	static inline void oxygen_set_bits8(struct oxygen *chip,
	206	unsigned int reg, u8 value)
	207	{
	208	oxygen_write8_masked(chip, reg, value, value);
	209	}
	210
	211	static inline void oxygen_set_bits16(struct oxygen *chip,
	212	unsigned int reg, u16 value)
	213	{
	214	oxygen_write16_masked(chip, reg, value, value);
	215	}
	216
	217	static inline void oxygen_set_bits32(struct oxygen *chip,
	218	unsigned int reg, u32 value)
	219	{
	220	oxygen_write32_masked(chip, reg, value, value);
	221	}
	222
	223	static inline void oxygen_clear_bits8(struct oxygen *chip,
	224	unsigned int reg, u8 value)
	225	{
	226	oxygen_write8_masked(chip, reg, 0, value);
	227	}
	228
	229	static inline void oxygen_clear_bits16(struct oxygen *chip,
	230	unsigned int reg, u16 value)
	231	{
	232	oxygen_write16_masked(chip, reg, 0, value);
	233	}
	234
	235	static inline void oxygen_clear_bits32(struct oxygen *chip,
	236	unsigned int reg, u32 value)
	237	{
	238	oxygen_write32_masked(chip, reg, 0, value);
	239	}
	240
	241	static inline void oxygen_ac97_set_bits(struct oxygen *chip, unsigned int codec,
	242	unsigned int index, u16 value)
	243	{
	244	oxygen_write_ac97_masked(chip, codec, index, value, value);
	245	}
	246
	247	static inline void oxygen_ac97_clear_bits(struct oxygen *chip,
	248	unsigned int codec,
	249	unsigned int index, u16 value)
	250	{
	251	oxygen_write_ac97_masked(chip, codec, index, 0, value);
	252	}
	253
	254	#endif