1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *  Generic driver for CS4231 chips
4 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 *  Originally the CS4232/CS4232A driver, modified for use on CS4231 by
6 *  Tugrul Galatali <galatalt@stuy.edu>
7 */
8
9#include <linux/init.h>
10#include <linux/err.h>
11#include <linux/isa.h>
12#include <linux/time.h>
13#include <linux/wait.h>
14#include <linux/module.h>
15#include <sound/core.h>
16#include <sound/wss.h>
17#include <sound/mpu401.h>
18#include <sound/initval.h>
19
20#define CRD_NAME "Generic CS4231"
21#define DEV_NAME "cs4231"
22
23MODULE_DESCRIPTION(CRD_NAME);
24MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
25MODULE_LICENSE("GPL");
26MODULE_SUPPORTED_DEVICE("{{Crystal Semiconductors,CS4231}}");
27
28static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
29static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
30static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;	/* Enable this card */
31static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* PnP setup */
32static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* PnP setup */
33static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 5,7,9,11,12,15 */
34static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 9,11,12,15 */
35static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 0,1,3,5,6,7 */
36static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 0,1,3,5,6,7 */
37
38module_param_array(index, int, NULL, 0444);
39MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard.");
40module_param_array(id, charp, NULL, 0444);
41MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard.");
42module_param_array(enable, bool, NULL, 0444);
43MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard.");
44module_param_hw_array(port, long, ioport, NULL, 0444);
45MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver.");
46module_param_hw_array(mpu_port, long, ioport, NULL, 0444);
47MODULE_PARM_DESC(mpu_port, "MPU-401 port # for " CRD_NAME " driver.");
48module_param_hw_array(irq, int, irq, NULL, 0444);
49MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver.");
50module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
51MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for " CRD_NAME " driver.");
52module_param_hw_array(dma1, int, dma, NULL, 0444);
53MODULE_PARM_DESC(dma1, "DMA1 # for " CRD_NAME " driver.");
54module_param_hw_array(dma2, int, dma, NULL, 0444);
55MODULE_PARM_DESC(dma2, "DMA2 # for " CRD_NAME " driver.");
56
57static int snd_cs4231_match(struct device *dev, unsigned int n)
58{
59	if (!enable[n])
60		return 0;
61
62	if (port[n] == SNDRV_AUTO_PORT) {
63		dev_err(dev, "please specify port\n");
64		return 0;
65	}
66	if (irq[n] == SNDRV_AUTO_IRQ) {
67		dev_err(dev, "please specify irq\n");
68		return 0;
69	}
70	if (dma1[n] == SNDRV_AUTO_DMA) {
71		dev_err(dev, "please specify dma1\n");
72		return 0;
73	}
74	return 1;
75}
76
77static int snd_cs4231_probe(struct device *dev, unsigned int n)
78{
79	struct snd_card *card;
80	struct snd_wss *chip;
81	int error;
82
83	error = snd_card_new(dev, index[n], id[n], THIS_MODULE, 0, &card);
84	if (error < 0)
85		return error;
86
87	error = snd_wss_create(card, port[n], -1, irq[n], dma1[n], dma2[n],
88			WSS_HW_DETECT, 0, &chip);
89	if (error < 0)
90		goto out;
91
92	card->private_data = chip;
93
94	error = snd_wss_pcm(chip, 0);
95	if (error < 0)
96		goto out;
97
98	strlcpy(card->driver, "CS4231", sizeof(card->driver));
99	strlcpy(card->shortname, chip->pcm->name, sizeof(card->shortname));
100
101	if (dma2[n] < 0)
102		snprintf(card->longname, sizeof(card->longname),
103			 "%s at 0x%lx, irq %d, dma %d",
104			 chip->pcm->name, chip->port, irq[n], dma1[n]);
105	else
106		snprintf(card->longname, sizeof(card->longname),
107			 "%s at 0x%lx, irq %d, dma %d&%d",
108			 chip->pcm->name, chip->port, irq[n], dma1[n], dma2[n]);
109
110	error = snd_wss_mixer(chip);
111	if (error < 0)
112		goto out;
113
114	error = snd_wss_timer(chip, 0);
115	if (error < 0)
116		goto out;
117
118	if (mpu_port[n] > 0 && mpu_port[n] != SNDRV_AUTO_PORT) {
119		if (mpu_irq[n] == SNDRV_AUTO_IRQ)
120			mpu_irq[n] = -1;
121		if (snd_mpu401_uart_new(card, 0, MPU401_HW_CS4232,
122					mpu_port[n], 0, mpu_irq[n],
123					NULL) < 0)
124			dev_warn(dev, "MPU401 not detected\n");
125	}
126
127	error = snd_card_register(card);
128	if (error < 0)
129		goto out;
130
131	dev_set_drvdata(dev, card);
132	return 0;
133
134out:	snd_card_free(card);
135	return error;
136}
137
138static int snd_cs4231_remove(struct device *dev, unsigned int n)
139{
140	snd_card_free(dev_get_drvdata(dev));
141	return 0;
142}
143
144#ifdef CONFIG_PM
145static int snd_cs4231_suspend(struct device *dev, unsigned int n, pm_message_t state)
146{
147	struct snd_card *card = dev_get_drvdata(dev);
148	struct snd_wss *chip = card->private_data;
149
150	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
151	chip->suspend(chip);
152	return 0;
153}
154
155static int snd_cs4231_resume(struct device *dev, unsigned int n)
156{
157	struct snd_card *card = dev_get_drvdata(dev);
158	struct snd_wss *chip = card->private_data;
159
160	chip->resume(chip);
161	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
162	return 0;
163}
164#endif
165
166static struct isa_driver snd_cs4231_driver = {
167	.match		= snd_cs4231_match,
168	.probe		= snd_cs4231_probe,
169	.remove		= snd_cs4231_remove,
170#ifdef CONFIG_PM
171	.suspend	= snd_cs4231_suspend,
172	.resume		= snd_cs4231_resume,
173#endif
174	.driver		= {
175		.name	= DEV_NAME
176	}
177};
178
179module_isa_driver(snd_cs4231_driver, SNDRV_CARDS);
180