xref: /linux/sound/pci/cs5535audio/cs5535audio.h (revision bfd5bb6f90af092aa345b15cd78143956a13c2a8)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __SOUND_CS5535AUDIO_H
3 #define __SOUND_CS5535AUDIO_H
4 
5 #define cs_writel(cs5535au, reg, val)	outl(val, (cs5535au)->port + reg)
6 #define cs_writeb(cs5535au, reg, val)	outb(val, (cs5535au)->port + reg)
7 #define cs_readl(cs5535au, reg)		inl((cs5535au)->port + reg)
8 #define cs_readw(cs5535au, reg)		inw((cs5535au)->port + reg)
9 #define cs_readb(cs5535au, reg)		inb((cs5535au)->port + reg)
10 
11 #define CS5535AUDIO_MAX_DESCRIPTORS	128
12 
13 /* acc_codec bar0 reg addrs */
14 #define ACC_GPIO_STATUS			0x00
15 #define ACC_CODEC_STATUS		0x08
16 #define ACC_CODEC_CNTL			0x0C
17 #define ACC_IRQ_STATUS			0x12
18 #define ACC_BM0_CMD			0x20
19 #define ACC_BM1_CMD			0x28
20 #define ACC_BM0_PRD			0x24
21 #define ACC_BM1_PRD			0x2C
22 #define ACC_BM0_STATUS			0x21
23 #define ACC_BM1_STATUS			0x29
24 #define ACC_BM0_PNTR			0x60
25 #define ACC_BM1_PNTR			0x64
26 
27 /* acc_codec bar0 reg bits */
28 /* ACC_IRQ_STATUS */
29 #define IRQ_STS 			0
30 #define WU_IRQ_STS 			1
31 #define BM0_IRQ_STS 			2
32 #define BM1_IRQ_STS 			3
33 /* ACC_BMX_STATUS */
34 #define EOP				(1<<0)
35 #define BM_EOP_ERR			(1<<1)
36 /* ACC_BMX_CTL */
37 #define BM_CTL_EN			0x01
38 #define BM_CTL_PAUSE			0x03
39 #define BM_CTL_DIS			0x00
40 #define BM_CTL_BYTE_ORD_LE		0x00
41 #define BM_CTL_BYTE_ORD_BE		0x04
42 /* cs5535 specific ac97 codec register defines */
43 #define CMD_MASK			0xFF00FFFF
44 #define CMD_NEW				0x00010000
45 #define STS_NEW				0x00020000
46 #define PRM_RDY_STS			0x00800000
47 #define ACC_CODEC_CNTL_WR_CMD		(~0x80000000)
48 #define ACC_CODEC_CNTL_RD_CMD		0x80000000
49 #define ACC_CODEC_CNTL_LNK_SHUTDOWN	0x00040000
50 #define ACC_CODEC_CNTL_LNK_WRM_RST	0x00020000
51 #define PRD_JMP				0x2000
52 #define PRD_EOP				0x4000
53 #define PRD_EOT				0x8000
54 
55 enum { CS5535AUDIO_DMA_PLAYBACK, CS5535AUDIO_DMA_CAPTURE, NUM_CS5535AUDIO_DMAS };
56 
57 struct cs5535audio;
58 
59 struct cs5535audio_dma_ops {
60 	int type;
61 	void (*enable_dma)(struct cs5535audio *cs5535au);
62 	void (*disable_dma)(struct cs5535audio *cs5535au);
63 	void (*pause_dma)(struct cs5535audio *cs5535au);
64 	void (*setup_prd)(struct cs5535audio *cs5535au, u32 prd_addr);
65 	u32 (*read_prd)(struct cs5535audio *cs5535au);
66 	u32 (*read_dma_pntr)(struct cs5535audio *cs5535au);
67 };
68 
69 struct cs5535audio_dma_desc {
70 	u32 addr;
71 	u16 size;
72 	u16 ctlreserved;
73 };
74 
75 struct cs5535audio_dma {
76 	const struct cs5535audio_dma_ops *ops;
77 	struct snd_dma_buffer desc_buf;
78 	struct snd_pcm_substream *substream;
79 	unsigned int buf_addr, buf_bytes;
80 	unsigned int period_bytes, periods;
81 	u32 saved_prd;
82 	int pcm_open_flag;
83 };
84 
85 struct cs5535audio {
86 	struct snd_card *card;
87 	struct snd_ac97 *ac97;
88 	struct snd_pcm *pcm;
89 	int irq;
90 	struct pci_dev *pci;
91 	unsigned long port;
92 	spinlock_t reg_lock;
93 	struct snd_pcm_substream *playback_substream;
94 	struct snd_pcm_substream *capture_substream;
95 	struct cs5535audio_dma dmas[NUM_CS5535AUDIO_DMAS];
96 };
97 
98 extern const struct dev_pm_ops snd_cs5535audio_pm;
99 
100 #ifdef CONFIG_OLPC
101 void olpc_prequirks(struct snd_card *card,
102 		    struct snd_ac97_template *ac97);
103 int olpc_quirks(struct snd_card *card, struct snd_ac97 *ac97);
104 void olpc_quirks_cleanup(void);
105 void olpc_analog_input(struct snd_ac97 *ac97, int on);
106 void olpc_mic_bias(struct snd_ac97 *ac97, int on);
107 
108 static inline void olpc_capture_open(struct snd_ac97 *ac97)
109 {
110 	/* default to Analog Input off */
111 	olpc_analog_input(ac97, 0);
112 	/* enable MIC Bias for recording */
113 	olpc_mic_bias(ac97, 1);
114 }
115 
116 static inline void olpc_capture_close(struct snd_ac97 *ac97)
117 {
118 	/* disable Analog Input */
119 	olpc_analog_input(ac97, 0);
120 	/* disable the MIC Bias (so the recording LED turns off) */
121 	olpc_mic_bias(ac97, 0);
122 }
123 #else
124 static inline void olpc_prequirks(struct snd_card *card,
125 		struct snd_ac97_template *ac97) { }
126 static inline int olpc_quirks(struct snd_card *card, struct snd_ac97 *ac97)
127 {
128 	return 0;
129 }
130 static inline void olpc_quirks_cleanup(void) { }
131 static inline void olpc_analog_input(struct snd_ac97 *ac97, int on) { }
132 static inline void olpc_mic_bias(struct snd_ac97 *ac97, int on) { }
133 static inline void olpc_capture_open(struct snd_ac97 *ac97) { }
134 static inline void olpc_capture_close(struct snd_ac97 *ac97) { }
135 #endif
136 
137 int snd_cs5535audio_pcm(struct cs5535audio *cs5535audio);
138 
139 #endif /* __SOUND_CS5535AUDIO_H */
140 
141