[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_MCLKS(f_single, f_double, f_quad) ((MCLK_##f_single << 0) | \
						  (MCLK_##f_double << 2) | \
						  (MCLK_##f_quad   << 4))

#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 snd_info_buffer;
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);
	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);
	unsigned int (*adjust_dac_routing)(struct oxygen *chip,
					   unsigned int play_routing);
	void (*gpio_changed)(struct oxygen *chip);
	void (*uart_input)(struct oxygen *chip);
	void (*ac97_switch)(struct oxygen *chip,
			    unsigned int reg, unsigned int mute);
	void (*dump_registers)(struct oxygen *chip,
			       struct snd_info_buffer *buffer);
	const unsigned int *dac_tlv;
	size_t model_data_size;
	unsigned int device_config;
	u8 dac_channels_pcm;
	u8 dac_channels_mixer;
	u8 dac_volume_min;
	u8 dac_volume_max;
	u8 misc_flags;
	u8 function_flags;
	u8 dac_mclks;
	u8 adc_mclks;
	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 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_SLEEP
extern const struct dev_pm_ops oxygen_pci_pm;
#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);

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