[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	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

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 (*uart_input)(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];
	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,
		     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);

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