1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *   ALSA modem driver for VIA VT82xx (South Bridge)
4 *
5 *   VT82C686A/B/C, VT8233A/C, VT8235
6 *
7 *	Copyright (c) 2000 Jaroslav Kysela <perex@perex.cz>
8 *	                   Tjeerd.Mulder <Tjeerd.Mulder@fujitsu-siemens.com>
9 *                    2002 Takashi Iwai <tiwai@suse.de>
10 */
11
12/*
13 * Changes:
14 *
15 * Sep. 2,  2004  Sasha Khapyorsky <sashak@alsa-project.org>
16 *      Modified from original audio driver 'via82xx.c' to support AC97
17 *      modems.
18 */
19
20#include <linux/io.h>
21#include <linux/delay.h>
22#include <linux/interrupt.h>
23#include <linux/init.h>
24#include <linux/pci.h>
25#include <linux/slab.h>
26#include <linux/module.h>
27#include <sound/core.h>
28#include <sound/pcm.h>
29#include <sound/pcm_params.h>
30#include <sound/info.h>
31#include <sound/ac97_codec.h>
32#include <sound/initval.h>
33
34#if 0
35#define POINTER_DEBUG
36#endif
37
38MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
39MODULE_DESCRIPTION("VIA VT82xx modem");
40MODULE_LICENSE("GPL");
41
42static int index = -2; /* Exclude the first card */
43static char *id = SNDRV_DEFAULT_STR1;	/* ID for this card */
44static int ac97_clock = 48000;
45
46module_param(index, int, 0444);
47MODULE_PARM_DESC(index, "Index value for VIA 82xx bridge.");
48module_param(id, charp, 0444);
49MODULE_PARM_DESC(id, "ID string for VIA 82xx bridge.");
50module_param(ac97_clock, int, 0444);
51MODULE_PARM_DESC(ac97_clock, "AC'97 codec clock (default 48000Hz).");
52
53/* just for backward compatibility */
54static bool enable;
55module_param(enable, bool, 0444);
56
57
58/*
59 *  Direct registers
60 */
61
62#define VIAREG(via, x) ((via)->port + VIA_REG_##x)
63#define VIADEV_REG(viadev, x) ((viadev)->port + VIA_REG_##x)
64
65/* common offsets */
66#define VIA_REG_OFFSET_STATUS		0x00	/* byte - channel status */
67#define   VIA_REG_STAT_ACTIVE		0x80	/* RO */
68#define   VIA_REG_STAT_PAUSED		0x40	/* RO */
69#define   VIA_REG_STAT_TRIGGER_QUEUED	0x08	/* RO */
70#define   VIA_REG_STAT_STOPPED		0x04	/* RWC */
71#define   VIA_REG_STAT_EOL		0x02	/* RWC */
72#define   VIA_REG_STAT_FLAG		0x01	/* RWC */
73#define VIA_REG_OFFSET_CONTROL		0x01	/* byte - channel control */
74#define   VIA_REG_CTRL_START		0x80	/* WO */
75#define   VIA_REG_CTRL_TERMINATE	0x40	/* WO */
76#define   VIA_REG_CTRL_AUTOSTART	0x20
77#define   VIA_REG_CTRL_PAUSE		0x08	/* RW */
78#define   VIA_REG_CTRL_INT_STOP		0x04
79#define   VIA_REG_CTRL_INT_EOL		0x02
80#define   VIA_REG_CTRL_INT_FLAG		0x01
81#define   VIA_REG_CTRL_RESET		0x01	/* RW - probably reset? undocumented */
82#define   VIA_REG_CTRL_INT (VIA_REG_CTRL_INT_FLAG | VIA_REG_CTRL_INT_EOL | VIA_REG_CTRL_AUTOSTART)
83#define VIA_REG_OFFSET_TYPE		0x02	/* byte - channel type (686 only) */
84#define   VIA_REG_TYPE_AUTOSTART	0x80	/* RW - autostart at EOL */
85#define   VIA_REG_TYPE_16BIT		0x20	/* RW */
86#define   VIA_REG_TYPE_STEREO		0x10	/* RW */
87#define   VIA_REG_TYPE_INT_LLINE	0x00
88#define   VIA_REG_TYPE_INT_LSAMPLE	0x04
89#define   VIA_REG_TYPE_INT_LESSONE	0x08
90#define   VIA_REG_TYPE_INT_MASK		0x0c
91#define   VIA_REG_TYPE_INT_EOL		0x02
92#define   VIA_REG_TYPE_INT_FLAG		0x01
93#define VIA_REG_OFFSET_TABLE_PTR	0x04	/* dword - channel table pointer */
94#define VIA_REG_OFFSET_CURR_PTR		0x04	/* dword - channel current pointer */
95#define VIA_REG_OFFSET_STOP_IDX		0x08	/* dword - stop index, channel type, sample rate */
96#define VIA_REG_OFFSET_CURR_COUNT	0x0c	/* dword - channel current count (24 bit) */
97#define VIA_REG_OFFSET_CURR_INDEX	0x0f	/* byte - channel current index (for via8233 only) */
98
99#define DEFINE_VIA_REGSET(name,val) \
100enum {\
101	VIA_REG_##name##_STATUS		= (val),\
102	VIA_REG_##name##_CONTROL	= (val) + 0x01,\
103	VIA_REG_##name##_TYPE		= (val) + 0x02,\
104	VIA_REG_##name##_TABLE_PTR	= (val) + 0x04,\
105	VIA_REG_##name##_CURR_PTR	= (val) + 0x04,\
106	VIA_REG_##name##_STOP_IDX	= (val) + 0x08,\
107	VIA_REG_##name##_CURR_COUNT	= (val) + 0x0c,\
108}
109
110/* modem block */
111DEFINE_VIA_REGSET(MO, 0x40);
112DEFINE_VIA_REGSET(MI, 0x50);
113
114/* AC'97 */
115#define VIA_REG_AC97			0x80	/* dword */
116#define   VIA_REG_AC97_CODEC_ID_MASK	(3<<30)
117#define   VIA_REG_AC97_CODEC_ID_SHIFT	30
118#define   VIA_REG_AC97_CODEC_ID_PRIMARY	0x00
119#define   VIA_REG_AC97_CODEC_ID_SECONDARY 0x01
120#define   VIA_REG_AC97_SECONDARY_VALID	(1<<27)
121#define   VIA_REG_AC97_PRIMARY_VALID	(1<<25)
122#define   VIA_REG_AC97_BUSY		(1<<24)
123#define   VIA_REG_AC97_READ		(1<<23)
124#define   VIA_REG_AC97_CMD_SHIFT	16
125#define   VIA_REG_AC97_CMD_MASK		0x7e
126#define   VIA_REG_AC97_DATA_SHIFT	0
127#define   VIA_REG_AC97_DATA_MASK	0xffff
128
129#define VIA_REG_SGD_SHADOW		0x84	/* dword */
130#define   VIA_REG_SGD_STAT_PB_FLAG	(1<<0)
131#define   VIA_REG_SGD_STAT_CP_FLAG	(1<<1)
132#define   VIA_REG_SGD_STAT_FM_FLAG	(1<<2)
133#define   VIA_REG_SGD_STAT_PB_EOL	(1<<4)
134#define   VIA_REG_SGD_STAT_CP_EOL	(1<<5)
135#define   VIA_REG_SGD_STAT_FM_EOL	(1<<6)
136#define   VIA_REG_SGD_STAT_PB_STOP	(1<<8)
137#define   VIA_REG_SGD_STAT_CP_STOP	(1<<9)
138#define   VIA_REG_SGD_STAT_FM_STOP	(1<<10)
139#define   VIA_REG_SGD_STAT_PB_ACTIVE	(1<<12)
140#define   VIA_REG_SGD_STAT_CP_ACTIVE	(1<<13)
141#define   VIA_REG_SGD_STAT_FM_ACTIVE	(1<<14)
142#define   VIA_REG_SGD_STAT_MR_FLAG      (1<<16)
143#define   VIA_REG_SGD_STAT_MW_FLAG      (1<<17)
144#define   VIA_REG_SGD_STAT_MR_EOL       (1<<20)
145#define   VIA_REG_SGD_STAT_MW_EOL       (1<<21)
146#define   VIA_REG_SGD_STAT_MR_STOP      (1<<24)
147#define   VIA_REG_SGD_STAT_MW_STOP      (1<<25)
148#define   VIA_REG_SGD_STAT_MR_ACTIVE    (1<<28)
149#define   VIA_REG_SGD_STAT_MW_ACTIVE    (1<<29)
150
151#define VIA_REG_GPI_STATUS		0x88
152#define VIA_REG_GPI_INTR		0x8c
153
154#define VIA_TBL_BIT_FLAG	0x40000000
155#define VIA_TBL_BIT_EOL		0x80000000
156
157/* pci space */
158#define VIA_ACLINK_STAT		0x40
159#define  VIA_ACLINK_C11_READY	0x20
160#define  VIA_ACLINK_C10_READY	0x10
161#define  VIA_ACLINK_C01_READY	0x04 /* secondary codec ready */
162#define  VIA_ACLINK_LOWPOWER	0x02 /* low-power state */
163#define  VIA_ACLINK_C00_READY	0x01 /* primary codec ready */
164#define VIA_ACLINK_CTRL		0x41
165#define  VIA_ACLINK_CTRL_ENABLE	0x80 /* 0: disable, 1: enable */
166#define  VIA_ACLINK_CTRL_RESET	0x40 /* 0: assert, 1: de-assert */
167#define  VIA_ACLINK_CTRL_SYNC	0x20 /* 0: release SYNC, 1: force SYNC hi */
168#define  VIA_ACLINK_CTRL_SDO	0x10 /* 0: release SDO, 1: force SDO hi */
169#define  VIA_ACLINK_CTRL_VRA	0x08 /* 0: disable VRA, 1: enable VRA */
170#define  VIA_ACLINK_CTRL_PCM	0x04 /* 0: disable PCM, 1: enable PCM */
171#define  VIA_ACLINK_CTRL_FM	0x02 /* via686 only */
172#define  VIA_ACLINK_CTRL_SB	0x01 /* via686 only */
173#define  VIA_ACLINK_CTRL_INIT	(VIA_ACLINK_CTRL_ENABLE|\
174				 VIA_ACLINK_CTRL_RESET|\
175				 VIA_ACLINK_CTRL_PCM)
176#define VIA_FUNC_ENABLE		0x42
177#define  VIA_FUNC_MIDI_PNP	0x80 /* FIXME: it's 0x40 in the datasheet! */
178#define  VIA_FUNC_MIDI_IRQMASK	0x40 /* FIXME: not documented! */
179#define  VIA_FUNC_RX2C_WRITE	0x20
180#define  VIA_FUNC_SB_FIFO_EMPTY	0x10
181#define  VIA_FUNC_ENABLE_GAME	0x08
182#define  VIA_FUNC_ENABLE_FM	0x04
183#define  VIA_FUNC_ENABLE_MIDI	0x02
184#define  VIA_FUNC_ENABLE_SB	0x01
185#define VIA_PNP_CONTROL		0x43
186#define VIA_MC97_CTRL		0x44
187#define  VIA_MC97_CTRL_ENABLE   0x80
188#define  VIA_MC97_CTRL_SECONDARY 0x40
189#define  VIA_MC97_CTRL_INIT     (VIA_MC97_CTRL_ENABLE|\
190                                 VIA_MC97_CTRL_SECONDARY)
191
192
193/*
194 * pcm stream
195 */
196
197struct snd_via_sg_table {
198	unsigned int offset;
199	unsigned int size;
200} ;
201
202#define VIA_TABLE_SIZE	255
203
204struct viadev {
205	unsigned int reg_offset;
206	unsigned long port;
207	int direction;	/* playback = 0, capture = 1 */
208        struct snd_pcm_substream *substream;
209	int running;
210	unsigned int tbl_entries; /* # descriptors */
211	struct snd_dma_buffer table;
212	struct snd_via_sg_table *idx_table;
213	/* for recovery from the unexpected pointer */
214	unsigned int lastpos;
215	unsigned int bufsize;
216	unsigned int bufsize2;
217};
218
219enum { TYPE_CARD_VIA82XX_MODEM = 1 };
220
221#define VIA_MAX_MODEM_DEVS	2
222
223struct via82xx_modem {
224	int irq;
225
226	unsigned long port;
227
228	unsigned int intr_mask; /* SGD_SHADOW mask to check interrupts */
229
230	struct pci_dev *pci;
231	struct snd_card *card;
232
233	unsigned int num_devs;
234	unsigned int playback_devno, capture_devno;
235	struct viadev devs[VIA_MAX_MODEM_DEVS];
236
237	struct snd_pcm *pcms[2];
238
239	struct snd_ac97_bus *ac97_bus;
240	struct snd_ac97 *ac97;
241	unsigned int ac97_clock;
242	unsigned int ac97_secondary;	/* secondary AC'97 codec is present */
243
244	spinlock_t reg_lock;
245	struct snd_info_entry *proc_entry;
246};
247
248static const struct pci_device_id snd_via82xx_modem_ids[] = {
249	{ PCI_VDEVICE(VIA, 0x3068), TYPE_CARD_VIA82XX_MODEM, },
250	{ 0, }
251};
252
253MODULE_DEVICE_TABLE(pci, snd_via82xx_modem_ids);
254
255/*
256 */
257
258/*
259 * allocate and initialize the descriptor buffers
260 * periods = number of periods
261 * fragsize = period size in bytes
262 */
263static int build_via_table(struct viadev *dev, struct snd_pcm_substream *substream,
264			   struct pci_dev *pci,
265			   unsigned int periods, unsigned int fragsize)
266{
267	unsigned int i, idx, ofs, rest;
268	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
269	__le32 *pgtbl;
270
271	if (dev->table.area == NULL) {
272		/* the start of each lists must be aligned to 8 bytes,
273		 * but the kernel pages are much bigger, so we don't care
274		 */
275		if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, &chip->pci->dev,
276					PAGE_ALIGN(VIA_TABLE_SIZE * 2 * 8),
277					&dev->table) < 0)
278			return -ENOMEM;
279	}
280	if (! dev->idx_table) {
281		dev->idx_table = kmalloc_array(VIA_TABLE_SIZE,
282					       sizeof(*dev->idx_table),
283					       GFP_KERNEL);
284		if (! dev->idx_table)
285			return -ENOMEM;
286	}
287
288	/* fill the entries */
289	idx = 0;
290	ofs = 0;
291	pgtbl = (__le32 *)dev->table.area;
292	for (i = 0; i < periods; i++) {
293		rest = fragsize;
294		/* fill descriptors for a period.
295		 * a period can be split to several descriptors if it's
296		 * over page boundary.
297		 */
298		do {
299			unsigned int r;
300			unsigned int flag;
301			unsigned int addr;
302
303			if (idx >= VIA_TABLE_SIZE) {
304				dev_err(&pci->dev, "too much table size!\n");
305				return -EINVAL;
306			}
307			addr = snd_pcm_sgbuf_get_addr(substream, ofs);
308			pgtbl[idx << 1] = cpu_to_le32(addr);
309			r = PAGE_SIZE - (ofs % PAGE_SIZE);
310			if (rest < r)
311				r = rest;
312			rest -= r;
313			if (! rest) {
314				if (i == periods - 1)
315					flag = VIA_TBL_BIT_EOL; /* buffer boundary */
316				else
317					flag = VIA_TBL_BIT_FLAG; /* period boundary */
318			} else
319				flag = 0; /* period continues to the next */
320			/*
321			dev_dbg(&pci->dev,
322				"tbl %d: at %d  size %d (rest %d)\n",
323				idx, ofs, r, rest);
324			*/
325			pgtbl[(idx<<1) + 1] = cpu_to_le32(r | flag);
326			dev->idx_table[idx].offset = ofs;
327			dev->idx_table[idx].size = r;
328			ofs += r;
329			idx++;
330		} while (rest > 0);
331	}
332	dev->tbl_entries = idx;
333	dev->bufsize = periods * fragsize;
334	dev->bufsize2 = dev->bufsize / 2;
335	return 0;
336}
337
338
339static int clean_via_table(struct viadev *dev, struct snd_pcm_substream *substream,
340			   struct pci_dev *pci)
341{
342	if (dev->table.area) {
343		snd_dma_free_pages(&dev->table);
344		dev->table.area = NULL;
345	}
346	kfree(dev->idx_table);
347	dev->idx_table = NULL;
348	return 0;
349}
350
351/*
352 *  Basic I/O
353 */
354
355static inline unsigned int snd_via82xx_codec_xread(struct via82xx_modem *chip)
356{
357	return inl(VIAREG(chip, AC97));
358}
359
360static inline void snd_via82xx_codec_xwrite(struct via82xx_modem *chip, unsigned int val)
361{
362	outl(val, VIAREG(chip, AC97));
363}
364
365static int snd_via82xx_codec_ready(struct via82xx_modem *chip, int secondary)
366{
367	unsigned int timeout = 1000;	/* 1ms */
368	unsigned int val;
369
370	while (timeout-- > 0) {
371		udelay(1);
372		val = snd_via82xx_codec_xread(chip);
373		if (!(val & VIA_REG_AC97_BUSY))
374			return val & 0xffff;
375	}
376	dev_err(chip->card->dev, "codec_ready: codec %i is not ready [0x%x]\n",
377		   secondary, snd_via82xx_codec_xread(chip));
378	return -EIO;
379}
380
381static int snd_via82xx_codec_valid(struct via82xx_modem *chip, int secondary)
382{
383	unsigned int timeout = 1000;	/* 1ms */
384	unsigned int val, val1;
385	unsigned int stat = !secondary ? VIA_REG_AC97_PRIMARY_VALID :
386					 VIA_REG_AC97_SECONDARY_VALID;
387
388	while (timeout-- > 0) {
389		val = snd_via82xx_codec_xread(chip);
390		val1 = val & (VIA_REG_AC97_BUSY | stat);
391		if (val1 == stat)
392			return val & 0xffff;
393		udelay(1);
394	}
395	return -EIO;
396}
397
398static void snd_via82xx_codec_wait(struct snd_ac97 *ac97)
399{
400	struct via82xx_modem *chip = ac97->private_data;
401	__always_unused int err;
402	err = snd_via82xx_codec_ready(chip, ac97->num);
403	/* here we need to wait fairly for long time.. */
404	msleep(500);
405}
406
407static void snd_via82xx_codec_write(struct snd_ac97 *ac97,
408				    unsigned short reg,
409				    unsigned short val)
410{
411	struct via82xx_modem *chip = ac97->private_data;
412	unsigned int xval;
413	if(reg == AC97_GPIO_STATUS) {
414		outl(val, VIAREG(chip, GPI_STATUS));
415		return;
416	}
417	xval = !ac97->num ? VIA_REG_AC97_CODEC_ID_PRIMARY : VIA_REG_AC97_CODEC_ID_SECONDARY;
418	xval <<= VIA_REG_AC97_CODEC_ID_SHIFT;
419	xval |= reg << VIA_REG_AC97_CMD_SHIFT;
420	xval |= val << VIA_REG_AC97_DATA_SHIFT;
421	snd_via82xx_codec_xwrite(chip, xval);
422	snd_via82xx_codec_ready(chip, ac97->num);
423}
424
425static unsigned short snd_via82xx_codec_read(struct snd_ac97 *ac97, unsigned short reg)
426{
427	struct via82xx_modem *chip = ac97->private_data;
428	unsigned int xval, val = 0xffff;
429	int again = 0;
430
431	xval = ac97->num << VIA_REG_AC97_CODEC_ID_SHIFT;
432	xval |= ac97->num ? VIA_REG_AC97_SECONDARY_VALID : VIA_REG_AC97_PRIMARY_VALID;
433	xval |= VIA_REG_AC97_READ;
434	xval |= (reg & 0x7f) << VIA_REG_AC97_CMD_SHIFT;
435      	while (1) {
436      		if (again++ > 3) {
437			dev_err(chip->card->dev,
438				"codec_read: codec %i is not valid [0x%x]\n",
439				   ac97->num, snd_via82xx_codec_xread(chip));
440		      	return 0xffff;
441		}
442		snd_via82xx_codec_xwrite(chip, xval);
443		udelay (20);
444		if (snd_via82xx_codec_valid(chip, ac97->num) >= 0) {
445			udelay(25);
446			val = snd_via82xx_codec_xread(chip);
447			break;
448		}
449	}
450	return val & 0xffff;
451}
452
453static void snd_via82xx_channel_reset(struct via82xx_modem *chip, struct viadev *viadev)
454{
455	outb(VIA_REG_CTRL_PAUSE | VIA_REG_CTRL_TERMINATE | VIA_REG_CTRL_RESET,
456	     VIADEV_REG(viadev, OFFSET_CONTROL));
457	inb(VIADEV_REG(viadev, OFFSET_CONTROL));
458	udelay(50);
459	/* disable interrupts */
460	outb(0x00, VIADEV_REG(viadev, OFFSET_CONTROL));
461	/* clear interrupts */
462	outb(0x03, VIADEV_REG(viadev, OFFSET_STATUS));
463	outb(0x00, VIADEV_REG(viadev, OFFSET_TYPE)); /* for via686 */
464	// outl(0, VIADEV_REG(viadev, OFFSET_CURR_PTR));
465	viadev->lastpos = 0;
466}
467
468
469/*
470 *  Interrupt handler
471 */
472
473static irqreturn_t snd_via82xx_interrupt(int irq, void *dev_id)
474{
475	struct via82xx_modem *chip = dev_id;
476	unsigned int status;
477	unsigned int i;
478
479	status = inl(VIAREG(chip, SGD_SHADOW));
480	if (! (status & chip->intr_mask)) {
481		return IRQ_NONE;
482	}
483// _skip_sgd:
484
485	/* check status for each stream */
486	spin_lock(&chip->reg_lock);
487	for (i = 0; i < chip->num_devs; i++) {
488		struct viadev *viadev = &chip->devs[i];
489		unsigned char c_status = inb(VIADEV_REG(viadev, OFFSET_STATUS));
490		c_status &= (VIA_REG_STAT_EOL|VIA_REG_STAT_FLAG|VIA_REG_STAT_STOPPED);
491		if (! c_status)
492			continue;
493		if (viadev->substream && viadev->running) {
494			spin_unlock(&chip->reg_lock);
495			snd_pcm_period_elapsed(viadev->substream);
496			spin_lock(&chip->reg_lock);
497		}
498		outb(c_status, VIADEV_REG(viadev, OFFSET_STATUS)); /* ack */
499	}
500	spin_unlock(&chip->reg_lock);
501	return IRQ_HANDLED;
502}
503
504/*
505 *  PCM callbacks
506 */
507
508/*
509 * trigger callback
510 */
511static int snd_via82xx_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
512{
513	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
514	struct viadev *viadev = substream->runtime->private_data;
515	unsigned char val = 0;
516
517	switch (cmd) {
518	case SNDRV_PCM_TRIGGER_START:
519	case SNDRV_PCM_TRIGGER_SUSPEND:
520		val |= VIA_REG_CTRL_START;
521		viadev->running = 1;
522		break;
523	case SNDRV_PCM_TRIGGER_STOP:
524		val = VIA_REG_CTRL_TERMINATE;
525		viadev->running = 0;
526		break;
527	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
528		val |= VIA_REG_CTRL_PAUSE;
529		viadev->running = 0;
530		break;
531	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
532		viadev->running = 1;
533		break;
534	default:
535		return -EINVAL;
536	}
537	outb(val, VIADEV_REG(viadev, OFFSET_CONTROL));
538	if (cmd == SNDRV_PCM_TRIGGER_STOP)
539		snd_via82xx_channel_reset(chip, viadev);
540	return 0;
541}
542
543/*
544 * pointer callbacks
545 */
546
547/*
548 * calculate the linear position at the given sg-buffer index and the rest count
549 */
550
551#define check_invalid_pos(viadev,pos) \
552	((pos) < viadev->lastpos && ((pos) >= viadev->bufsize2 ||\
553				     viadev->lastpos < viadev->bufsize2))
554
555static inline unsigned int calc_linear_pos(struct via82xx_modem *chip,
556					   struct viadev *viadev,
557					   unsigned int idx,
558					   unsigned int count)
559{
560	unsigned int size, res;
561
562	size = viadev->idx_table[idx].size;
563	res = viadev->idx_table[idx].offset + size - count;
564
565	/* check the validity of the calculated position */
566	if (size < count) {
567		dev_err(chip->card->dev,
568			"invalid via82xx_cur_ptr (size = %d, count = %d)\n",
569			   (int)size, (int)count);
570		res = viadev->lastpos;
571	} else if (check_invalid_pos(viadev, res)) {
572#ifdef POINTER_DEBUG
573		dev_dbg(chip->card->dev,
574			"fail: idx = %i/%i, lastpos = 0x%x, bufsize2 = 0x%x, offsize = 0x%x, size = 0x%x, count = 0x%x\n",
575			idx, viadev->tbl_entries, viadev->lastpos,
576		       viadev->bufsize2, viadev->idx_table[idx].offset,
577		       viadev->idx_table[idx].size, count);
578#endif
579		if (count && size < count) {
580			dev_dbg(chip->card->dev,
581				"invalid via82xx_cur_ptr, using last valid pointer\n");
582			res = viadev->lastpos;
583		} else {
584			if (! count)
585				/* bogus count 0 on the DMA boundary? */
586				res = viadev->idx_table[idx].offset;
587			else
588				/* count register returns full size
589				 * when end of buffer is reached
590				 */
591				res = viadev->idx_table[idx].offset + size;
592			if (check_invalid_pos(viadev, res)) {
593				dev_dbg(chip->card->dev,
594					"invalid via82xx_cur_ptr (2), using last valid pointer\n");
595				res = viadev->lastpos;
596			}
597		}
598	}
599	viadev->lastpos = res; /* remember the last position */
600	if (res >= viadev->bufsize)
601		res -= viadev->bufsize;
602	return res;
603}
604
605/*
606 * get the current pointer on via686
607 */
608static snd_pcm_uframes_t snd_via686_pcm_pointer(struct snd_pcm_substream *substream)
609{
610	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
611	struct viadev *viadev = substream->runtime->private_data;
612	unsigned int idx, ptr, count, res;
613
614	if (snd_BUG_ON(!viadev->tbl_entries))
615		return 0;
616	if (!(inb(VIADEV_REG(viadev, OFFSET_STATUS)) & VIA_REG_STAT_ACTIVE))
617		return 0;
618
619	spin_lock(&chip->reg_lock);
620	count = inl(VIADEV_REG(viadev, OFFSET_CURR_COUNT)) & 0xffffff;
621	/* The via686a does not have the current index register,
622	 * so we need to calculate the index from CURR_PTR.
623	 */
624	ptr = inl(VIADEV_REG(viadev, OFFSET_CURR_PTR));
625	if (ptr <= (unsigned int)viadev->table.addr)
626		idx = 0;
627	else /* CURR_PTR holds the address + 8 */
628		idx = ((ptr - (unsigned int)viadev->table.addr) / 8 - 1) %
629			viadev->tbl_entries;
630	res = calc_linear_pos(chip, viadev, idx, count);
631	spin_unlock(&chip->reg_lock);
632
633	return bytes_to_frames(substream->runtime, res);
634}
635
636/*
637 * hw_params callback:
638 * allocate the buffer and build up the buffer description table
639 */
640static int snd_via82xx_hw_params(struct snd_pcm_substream *substream,
641				 struct snd_pcm_hw_params *hw_params)
642{
643	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
644	struct viadev *viadev = substream->runtime->private_data;
645	int err;
646
647	err = build_via_table(viadev, substream, chip->pci,
648			      params_periods(hw_params),
649			      params_period_bytes(hw_params));
650	if (err < 0)
651		return err;
652
653	snd_ac97_write(chip->ac97, AC97_LINE1_RATE, params_rate(hw_params));
654	snd_ac97_write(chip->ac97, AC97_LINE1_LEVEL, 0);
655
656	return 0;
657}
658
659/*
660 * hw_free callback:
661 * clean up the buffer description table and release the buffer
662 */
663static int snd_via82xx_hw_free(struct snd_pcm_substream *substream)
664{
665	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
666	struct viadev *viadev = substream->runtime->private_data;
667
668	clean_via_table(viadev, substream, chip->pci);
669	return 0;
670}
671
672
673/*
674 * set up the table pointer
675 */
676static void snd_via82xx_set_table_ptr(struct via82xx_modem *chip, struct viadev *viadev)
677{
678	snd_via82xx_codec_ready(chip, chip->ac97_secondary);
679	outl((u32)viadev->table.addr, VIADEV_REG(viadev, OFFSET_TABLE_PTR));
680	udelay(20);
681	snd_via82xx_codec_ready(chip, chip->ac97_secondary);
682}
683
684/*
685 * prepare callback for playback and capture
686 */
687static int snd_via82xx_pcm_prepare(struct snd_pcm_substream *substream)
688{
689	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
690	struct viadev *viadev = substream->runtime->private_data;
691
692	snd_via82xx_channel_reset(chip, viadev);
693	/* this must be set after channel_reset */
694	snd_via82xx_set_table_ptr(chip, viadev);
695	outb(VIA_REG_TYPE_AUTOSTART|VIA_REG_TYPE_INT_EOL|VIA_REG_TYPE_INT_FLAG,
696	     VIADEV_REG(viadev, OFFSET_TYPE));
697	return 0;
698}
699
700/*
701 * pcm hardware definition, identical for both playback and capture
702 */
703static const struct snd_pcm_hardware snd_via82xx_hw =
704{
705	.info =			(SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
706				 SNDRV_PCM_INFO_BLOCK_TRANSFER |
707				 SNDRV_PCM_INFO_MMAP_VALID |
708				 /* SNDRV_PCM_INFO_RESUME | */
709				 SNDRV_PCM_INFO_PAUSE),
710	.formats =		SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE,
711	.rates =		SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_KNOT,
712	.rate_min =		8000,
713	.rate_max =		16000,
714	.channels_min =		1,
715	.channels_max =		1,
716	.buffer_bytes_max =	128 * 1024,
717	.period_bytes_min =	32,
718	.period_bytes_max =	128 * 1024,
719	.periods_min =		2,
720	.periods_max =		VIA_TABLE_SIZE / 2,
721	.fifo_size =		0,
722};
723
724
725/*
726 * open callback skeleton
727 */
728static int snd_via82xx_modem_pcm_open(struct via82xx_modem *chip, struct viadev *viadev,
729				      struct snd_pcm_substream *substream)
730{
731	struct snd_pcm_runtime *runtime = substream->runtime;
732	int err;
733	static const unsigned int rates[] = { 8000,  9600, 12000, 16000 };
734	static const struct snd_pcm_hw_constraint_list hw_constraints_rates = {
735                .count = ARRAY_SIZE(rates),
736                .list = rates,
737                .mask = 0,
738        };
739
740	runtime->hw = snd_via82xx_hw;
741
742	err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
743					 &hw_constraints_rates);
744	if (err < 0)
745                return err;
746
747	/* we may remove following constaint when we modify table entries
748	   in interrupt */
749	err = snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
750	if (err < 0)
751		return err;
752
753	runtime->private_data = viadev;
754	viadev->substream = substream;
755
756	return 0;
757}
758
759
760/*
761 * open callback for playback
762 */
763static int snd_via82xx_playback_open(struct snd_pcm_substream *substream)
764{
765	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
766	struct viadev *viadev = &chip->devs[chip->playback_devno + substream->number];
767
768	return snd_via82xx_modem_pcm_open(chip, viadev, substream);
769}
770
771/*
772 * open callback for capture
773 */
774static int snd_via82xx_capture_open(struct snd_pcm_substream *substream)
775{
776	struct via82xx_modem *chip = snd_pcm_substream_chip(substream);
777	struct viadev *viadev = &chip->devs[chip->capture_devno + substream->pcm->device];
778
779	return snd_via82xx_modem_pcm_open(chip, viadev, substream);
780}
781
782/*
783 * close callback
784 */
785static int snd_via82xx_pcm_close(struct snd_pcm_substream *substream)
786{
787	struct viadev *viadev = substream->runtime->private_data;
788
789	viadev->substream = NULL;
790	return 0;
791}
792
793
794/* via686 playback callbacks */
795static const struct snd_pcm_ops snd_via686_playback_ops = {
796	.open =		snd_via82xx_playback_open,
797	.close =	snd_via82xx_pcm_close,
798	.hw_params =	snd_via82xx_hw_params,
799	.hw_free =	snd_via82xx_hw_free,
800	.prepare =	snd_via82xx_pcm_prepare,
801	.trigger =	snd_via82xx_pcm_trigger,
802	.pointer =	snd_via686_pcm_pointer,
803};
804
805/* via686 capture callbacks */
806static const struct snd_pcm_ops snd_via686_capture_ops = {
807	.open =		snd_via82xx_capture_open,
808	.close =	snd_via82xx_pcm_close,
809	.hw_params =	snd_via82xx_hw_params,
810	.hw_free =	snd_via82xx_hw_free,
811	.prepare =	snd_via82xx_pcm_prepare,
812	.trigger =	snd_via82xx_pcm_trigger,
813	.pointer =	snd_via686_pcm_pointer,
814};
815
816
817static void init_viadev(struct via82xx_modem *chip, int idx, unsigned int reg_offset,
818			int direction)
819{
820	chip->devs[idx].reg_offset = reg_offset;
821	chip->devs[idx].direction = direction;
822	chip->devs[idx].port = chip->port + reg_offset;
823}
824
825/*
826 * create a pcm instance for via686a/b
827 */
828static int snd_via686_pcm_new(struct via82xx_modem *chip)
829{
830	struct snd_pcm *pcm;
831	int err;
832
833	chip->playback_devno = 0;
834	chip->capture_devno = 1;
835	chip->num_devs = 2;
836	chip->intr_mask = 0x330000; /* FLAGS | EOL for MR, MW */
837
838	err = snd_pcm_new(chip->card, chip->card->shortname, 0, 1, 1, &pcm);
839	if (err < 0)
840		return err;
841	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_via686_playback_ops);
842	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_via686_capture_ops);
843	pcm->dev_class = SNDRV_PCM_CLASS_MODEM;
844	pcm->private_data = chip;
845	strcpy(pcm->name, chip->card->shortname);
846	chip->pcms[0] = pcm;
847	init_viadev(chip, 0, VIA_REG_MO_STATUS, 0);
848	init_viadev(chip, 1, VIA_REG_MI_STATUS, 1);
849
850	snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
851				       &chip->pci->dev, 64*1024, 128*1024);
852	return 0;
853}
854
855
856/*
857 *  Mixer part
858 */
859
860
861static void snd_via82xx_mixer_free_ac97_bus(struct snd_ac97_bus *bus)
862{
863	struct via82xx_modem *chip = bus->private_data;
864	chip->ac97_bus = NULL;
865}
866
867static void snd_via82xx_mixer_free_ac97(struct snd_ac97 *ac97)
868{
869	struct via82xx_modem *chip = ac97->private_data;
870	chip->ac97 = NULL;
871}
872
873
874static int snd_via82xx_mixer_new(struct via82xx_modem *chip)
875{
876	struct snd_ac97_template ac97;
877	int err;
878	static const struct snd_ac97_bus_ops ops = {
879		.write = snd_via82xx_codec_write,
880		.read = snd_via82xx_codec_read,
881		.wait = snd_via82xx_codec_wait,
882	};
883
884	err = snd_ac97_bus(chip->card, 0, &ops, chip, &chip->ac97_bus);
885	if (err < 0)
886		return err;
887	chip->ac97_bus->private_free = snd_via82xx_mixer_free_ac97_bus;
888	chip->ac97_bus->clock = chip->ac97_clock;
889
890	memset(&ac97, 0, sizeof(ac97));
891	ac97.private_data = chip;
892	ac97.private_free = snd_via82xx_mixer_free_ac97;
893	ac97.pci = chip->pci;
894	ac97.scaps = AC97_SCAP_SKIP_AUDIO | AC97_SCAP_POWER_SAVE;
895	ac97.num = chip->ac97_secondary;
896
897	err = snd_ac97_mixer(chip->ac97_bus, &ac97, &chip->ac97);
898	if (err < 0)
899		return err;
900
901	return 0;
902}
903
904
905/*
906 * proc interface
907 */
908static void snd_via82xx_proc_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
909{
910	struct via82xx_modem *chip = entry->private_data;
911	int i;
912
913	snd_iprintf(buffer, "%s\n\n", chip->card->longname);
914	for (i = 0; i < 0xa0; i += 4) {
915		snd_iprintf(buffer, "%02x: %08x\n", i, inl(chip->port + i));
916	}
917}
918
919static void snd_via82xx_proc_init(struct via82xx_modem *chip)
920{
921	snd_card_ro_proc_new(chip->card, "via82xx", chip,
922			     snd_via82xx_proc_read);
923}
924
925/*
926 *
927 */
928
929static int snd_via82xx_chip_init(struct via82xx_modem *chip)
930{
931	unsigned int val;
932	unsigned long end_time;
933	unsigned char pval;
934
935	pci_read_config_byte(chip->pci, VIA_MC97_CTRL, &pval);
936	if((pval & VIA_MC97_CTRL_INIT) != VIA_MC97_CTRL_INIT) {
937		pci_write_config_byte(chip->pci, 0x44, pval|VIA_MC97_CTRL_INIT);
938		udelay(100);
939	}
940
941	pci_read_config_byte(chip->pci, VIA_ACLINK_STAT, &pval);
942	if (! (pval & VIA_ACLINK_C00_READY)) { /* codec not ready? */
943		/* deassert ACLink reset, force SYNC */
944		pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL,
945				      VIA_ACLINK_CTRL_ENABLE |
946				      VIA_ACLINK_CTRL_RESET |
947				      VIA_ACLINK_CTRL_SYNC);
948		udelay(100);
949#if 1 /* FIXME: should we do full reset here for all chip models? */
950		pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL, 0x00);
951		udelay(100);
952#else
953		/* deassert ACLink reset, force SYNC (warm AC'97 reset) */
954		pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL,
955				      VIA_ACLINK_CTRL_RESET|VIA_ACLINK_CTRL_SYNC);
956		udelay(2);
957#endif
958		/* ACLink on, deassert ACLink reset, VSR, SGD data out */
959		pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL, VIA_ACLINK_CTRL_INIT);
960		udelay(100);
961	}
962
963	pci_read_config_byte(chip->pci, VIA_ACLINK_CTRL, &pval);
964	if ((pval & VIA_ACLINK_CTRL_INIT) != VIA_ACLINK_CTRL_INIT) {
965		/* ACLink on, deassert ACLink reset, VSR, SGD data out */
966		pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL, VIA_ACLINK_CTRL_INIT);
967		udelay(100);
968	}
969
970	/* wait until codec ready */
971	end_time = jiffies + msecs_to_jiffies(750);
972	do {
973		pci_read_config_byte(chip->pci, VIA_ACLINK_STAT, &pval);
974		if (pval & VIA_ACLINK_C00_READY) /* primary codec ready */
975			break;
976		schedule_timeout_uninterruptible(1);
977	} while (time_before(jiffies, end_time));
978
979	val = snd_via82xx_codec_xread(chip);
980	if (val & VIA_REG_AC97_BUSY)
981		dev_err(chip->card->dev,
982			"AC'97 codec is not ready [0x%x]\n", val);
983
984	snd_via82xx_codec_xwrite(chip, VIA_REG_AC97_READ |
985				 VIA_REG_AC97_SECONDARY_VALID |
986				 (VIA_REG_AC97_CODEC_ID_SECONDARY << VIA_REG_AC97_CODEC_ID_SHIFT));
987	end_time = jiffies + msecs_to_jiffies(750);
988	snd_via82xx_codec_xwrite(chip, VIA_REG_AC97_READ |
989				 VIA_REG_AC97_SECONDARY_VALID |
990				 (VIA_REG_AC97_CODEC_ID_SECONDARY << VIA_REG_AC97_CODEC_ID_SHIFT));
991	do {
992		val = snd_via82xx_codec_xread(chip);
993		if (val & VIA_REG_AC97_SECONDARY_VALID) {
994			chip->ac97_secondary = 1;
995			goto __ac97_ok2;
996		}
997		schedule_timeout_uninterruptible(1);
998	} while (time_before(jiffies, end_time));
999	/* This is ok, the most of motherboards have only one codec */
1000
1001      __ac97_ok2:
1002
1003	/* route FM trap to IRQ, disable FM trap */
1004	// pci_write_config_byte(chip->pci, VIA_FM_NMI_CTRL, 0);
1005	/* disable all GPI interrupts */
1006	outl(0, VIAREG(chip, GPI_INTR));
1007
1008	return 0;
1009}
1010
1011#ifdef CONFIG_PM_SLEEP
1012/*
1013 * power management
1014 */
1015static int snd_via82xx_suspend(struct device *dev)
1016{
1017	struct snd_card *card = dev_get_drvdata(dev);
1018	struct via82xx_modem *chip = card->private_data;
1019	int i;
1020
1021	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
1022	for (i = 0; i < chip->num_devs; i++)
1023		snd_via82xx_channel_reset(chip, &chip->devs[i]);
1024	snd_ac97_suspend(chip->ac97);
1025	return 0;
1026}
1027
1028static int snd_via82xx_resume(struct device *dev)
1029{
1030	struct snd_card *card = dev_get_drvdata(dev);
1031	struct via82xx_modem *chip = card->private_data;
1032	int i;
1033
1034	snd_via82xx_chip_init(chip);
1035
1036	snd_ac97_resume(chip->ac97);
1037
1038	for (i = 0; i < chip->num_devs; i++)
1039		snd_via82xx_channel_reset(chip, &chip->devs[i]);
1040
1041	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
1042	return 0;
1043}
1044
1045static SIMPLE_DEV_PM_OPS(snd_via82xx_pm, snd_via82xx_suspend, snd_via82xx_resume);
1046#define SND_VIA82XX_PM_OPS	&snd_via82xx_pm
1047#else
1048#define SND_VIA82XX_PM_OPS	NULL
1049#endif /* CONFIG_PM_SLEEP */
1050
1051static void snd_via82xx_free(struct snd_card *card)
1052{
1053	struct via82xx_modem *chip = card->private_data;
1054	unsigned int i;
1055
1056	/* disable interrupts */
1057	for (i = 0; i < chip->num_devs; i++)
1058		snd_via82xx_channel_reset(chip, &chip->devs[i]);
1059}
1060
1061static int snd_via82xx_create(struct snd_card *card,
1062			      struct pci_dev *pci,
1063			      int chip_type,
1064			      int revision,
1065			      unsigned int ac97_clock)
1066{
1067	struct via82xx_modem *chip = card->private_data;
1068	int err;
1069
1070	err = pcim_enable_device(pci);
1071	if (err < 0)
1072		return err;
1073
1074	spin_lock_init(&chip->reg_lock);
1075	chip->card = card;
1076	chip->pci = pci;
1077	chip->irq = -1;
1078
1079	err = pci_request_regions(pci, card->driver);
1080	if (err < 0)
1081		return err;
1082	chip->port = pci_resource_start(pci, 0);
1083	if (devm_request_irq(&pci->dev, pci->irq, snd_via82xx_interrupt,
1084			     IRQF_SHARED, KBUILD_MODNAME, chip)) {
1085		dev_err(card->dev, "unable to grab IRQ %d\n", pci->irq);
1086		return -EBUSY;
1087	}
1088	chip->irq = pci->irq;
1089	card->sync_irq = chip->irq;
1090	card->private_free = snd_via82xx_free;
1091	if (ac97_clock >= 8000 && ac97_clock <= 48000)
1092		chip->ac97_clock = ac97_clock;
1093
1094	err = snd_via82xx_chip_init(chip);
1095	if (err < 0)
1096		return err;
1097
1098	/* The 8233 ac97 controller does not implement the master bit
1099	 * in the pci command register. IMHO this is a violation of the PCI spec.
1100	 * We call pci_set_master here because it does not hurt. */
1101	pci_set_master(pci);
1102	return 0;
1103}
1104
1105
1106static int __snd_via82xx_probe(struct pci_dev *pci,
1107			       const struct pci_device_id *pci_id)
1108{
1109	struct snd_card *card;
1110	struct via82xx_modem *chip;
1111	int chip_type = 0, card_type;
1112	unsigned int i;
1113	int err;
1114
1115	err = snd_devm_card_new(&pci->dev, index, id, THIS_MODULE,
1116				sizeof(*chip), &card);
1117	if (err < 0)
1118		return err;
1119	chip = card->private_data;
1120
1121	card_type = pci_id->driver_data;
1122	switch (card_type) {
1123	case TYPE_CARD_VIA82XX_MODEM:
1124		strcpy(card->driver, "VIA82XX-MODEM");
1125		sprintf(card->shortname, "VIA 82XX modem");
1126		break;
1127	default:
1128		dev_err(card->dev, "invalid card type %d\n", card_type);
1129		return -EINVAL;
1130	}
1131
1132	err = snd_via82xx_create(card, pci, chip_type, pci->revision,
1133				 ac97_clock);
1134	if (err < 0)
1135		return err;
1136	err = snd_via82xx_mixer_new(chip);
1137	if (err < 0)
1138		return err;
1139
1140	err = snd_via686_pcm_new(chip);
1141	if (err < 0)
1142		return err;
1143
1144	/* disable interrupts */
1145	for (i = 0; i < chip->num_devs; i++)
1146		snd_via82xx_channel_reset(chip, &chip->devs[i]);
1147
1148	sprintf(card->longname, "%s at 0x%lx, irq %d",
1149		card->shortname, chip->port, chip->irq);
1150
1151	snd_via82xx_proc_init(chip);
1152
1153	err = snd_card_register(card);
1154	if (err < 0)
1155		return err;
1156	pci_set_drvdata(pci, card);
1157	return 0;
1158}
1159
1160static int snd_via82xx_probe(struct pci_dev *pci,
1161			     const struct pci_device_id *pci_id)
1162{
1163	return snd_card_free_on_error(&pci->dev, __snd_via82xx_probe(pci, pci_id));
1164}
1165
1166static struct pci_driver via82xx_modem_driver = {
1167	.name = KBUILD_MODNAME,
1168	.id_table = snd_via82xx_modem_ids,
1169	.probe = snd_via82xx_probe,
1170	.driver = {
1171		.pm = SND_VIA82XX_PM_OPS,
1172	},
1173};
1174
1175module_pci_driver(via82xx_modem_driver);
1176