[deliverable/linux.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

/* 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;

struct oxygen_model {
	const char *shortname;
	const char *longname;
	const char *chip;
	struct module *owner;
	int (*probe)(struct oxygen *chip, unsigned long driver_data);
	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);
	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);
	void (*ac97_switch)(struct oxygen *chip,
			    unsigned int reg, unsigned int mute);
	const unsigned int *dac_tlv;
	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];
	struct oxygen_model model;
};

/* oxygen_lib.c */

int oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
		     const struct oxygen_model *model,
		     unsigned long driver_data);
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

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