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

/* SPDX-License-Identifier: GPL-2.0 */
#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
#define CAPTURE_3_FROM_I2S_3	0x0400
#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);

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