es1688.c 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Driver for generic ESS AudioDrive ESx688 soundcards
  4. * Copyright (c) by Jaroslav Kysela <[email protected]>
  5. */
  6. #include <linux/init.h>
  7. #include <linux/err.h>
  8. #include <linux/isa.h>
  9. #include <linux/isapnp.h>
  10. #include <linux/time.h>
  11. #include <linux/wait.h>
  12. #include <linux/module.h>
  13. #include <asm/dma.h>
  14. #include <sound/core.h>
  15. #include <sound/es1688.h>
  16. #include <sound/mpu401.h>
  17. #include <sound/opl3.h>
  18. #define SNDRV_LEGACY_FIND_FREE_IRQ
  19. #define SNDRV_LEGACY_FIND_FREE_DMA
  20. #include <sound/initval.h>
  21. #define CRD_NAME "Generic ESS ES1688/ES688 AudioDrive"
  22. #define DEV_NAME "es1688"
  23. MODULE_DESCRIPTION(CRD_NAME);
  24. MODULE_AUTHOR("Jaroslav Kysela <[email protected]>");
  25. MODULE_LICENSE("GPL");
  26. MODULE_ALIAS("snd_es968");
  27. static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
  28. static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
  29. #ifdef CONFIG_PNP
  30. static bool isapnp[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP;
  31. #endif
  32. static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
  33. static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x240,0x260 */
  34. static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* Usually 0x388 */
  35. static long mpu_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -1};
  36. static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,10 */
  37. static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,10 */
  38. static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3 */
  39. module_param_array(index, int, NULL, 0444);
  40. MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard.");
  41. module_param_array(id, charp, NULL, 0444);
  42. MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard.");
  43. module_param_array(enable, bool, NULL, 0444);
  44. #ifdef CONFIG_PNP
  45. module_param_array(isapnp, bool, NULL, 0444);
  46. MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
  47. #endif
  48. MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard.");
  49. module_param_hw_array(port, long, ioport, NULL, 0444);
  50. MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver.");
  51. module_param_hw_array(mpu_port, long, ioport, NULL, 0444);
  52. MODULE_PARM_DESC(mpu_port, "MPU-401 port # for " CRD_NAME " driver.");
  53. module_param_hw_array(irq, int, irq, NULL, 0444);
  54. module_param_hw_array(fm_port, long, ioport, NULL, 0444);
  55. MODULE_PARM_DESC(fm_port, "FM port # for ES1688 driver.");
  56. MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver.");
  57. module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
  58. MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for " CRD_NAME " driver.");
  59. module_param_hw_array(dma8, int, dma, NULL, 0444);
  60. MODULE_PARM_DESC(dma8, "8-bit DMA # for " CRD_NAME " driver.");
  61. #ifdef CONFIG_PNP
  62. #define is_isapnp_selected(dev) isapnp[dev]
  63. #else
  64. #define is_isapnp_selected(dev) 0
  65. #endif
  66. static int snd_es1688_match(struct device *dev, unsigned int n)
  67. {
  68. return enable[n] && !is_isapnp_selected(n);
  69. }
  70. static int snd_es1688_legacy_create(struct snd_card *card,
  71. struct device *dev, unsigned int n)
  72. {
  73. struct snd_es1688 *chip = card->private_data;
  74. static const long possible_ports[] = {0x220, 0x240, 0x260};
  75. static const int possible_irqs[] = {5, 9, 10, 7, -1};
  76. static const int possible_dmas[] = {1, 3, 0, -1};
  77. int i, error;
  78. if (irq[n] == SNDRV_AUTO_IRQ) {
  79. irq[n] = snd_legacy_find_free_irq(possible_irqs);
  80. if (irq[n] < 0) {
  81. dev_err(dev, "unable to find a free IRQ\n");
  82. return -EBUSY;
  83. }
  84. }
  85. if (dma8[n] == SNDRV_AUTO_DMA) {
  86. dma8[n] = snd_legacy_find_free_dma(possible_dmas);
  87. if (dma8[n] < 0) {
  88. dev_err(dev, "unable to find a free DMA\n");
  89. return -EBUSY;
  90. }
  91. }
  92. if (port[n] != SNDRV_AUTO_PORT)
  93. return snd_es1688_create(card, chip, port[n], mpu_port[n],
  94. irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO);
  95. i = 0;
  96. do {
  97. port[n] = possible_ports[i];
  98. error = snd_es1688_create(card, chip, port[n], mpu_port[n],
  99. irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO);
  100. } while (error < 0 && ++i < ARRAY_SIZE(possible_ports));
  101. return error;
  102. }
  103. static int snd_es1688_probe(struct snd_card *card, unsigned int n)
  104. {
  105. struct snd_es1688 *chip = card->private_data;
  106. struct snd_opl3 *opl3;
  107. int error;
  108. error = snd_es1688_pcm(card, chip, 0);
  109. if (error < 0)
  110. return error;
  111. error = snd_es1688_mixer(card, chip);
  112. if (error < 0)
  113. return error;
  114. strscpy(card->driver, "ES1688", sizeof(card->driver));
  115. strscpy(card->shortname, chip->pcm->name, sizeof(card->shortname));
  116. snprintf(card->longname, sizeof(card->longname),
  117. "%s at 0x%lx, irq %i, dma %i", chip->pcm->name, chip->port,
  118. chip->irq, chip->dma8);
  119. if (fm_port[n] == SNDRV_AUTO_PORT)
  120. fm_port[n] = port[n]; /* share the same port */
  121. if (fm_port[n] > 0) {
  122. if (snd_opl3_create(card, fm_port[n], fm_port[n] + 2,
  123. OPL3_HW_OPL3, 0, &opl3) < 0)
  124. dev_warn(card->dev,
  125. "opl3 not detected at 0x%lx\n", fm_port[n]);
  126. else {
  127. error = snd_opl3_hwdep_new(opl3, 0, 1, NULL);
  128. if (error < 0)
  129. return error;
  130. }
  131. }
  132. if (mpu_irq[n] >= 0 && mpu_irq[n] != SNDRV_AUTO_IRQ &&
  133. chip->mpu_port > 0) {
  134. error = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688,
  135. chip->mpu_port, 0,
  136. mpu_irq[n], NULL);
  137. if (error < 0)
  138. return error;
  139. }
  140. return snd_card_register(card);
  141. }
  142. static int snd_es1688_isa_probe(struct device *dev, unsigned int n)
  143. {
  144. struct snd_card *card;
  145. int error;
  146. error = snd_devm_card_new(dev, index[n], id[n], THIS_MODULE,
  147. sizeof(struct snd_es1688), &card);
  148. if (error < 0)
  149. return error;
  150. error = snd_es1688_legacy_create(card, dev, n);
  151. if (error < 0)
  152. return error;
  153. error = snd_es1688_probe(card, n);
  154. if (error < 0)
  155. return error;
  156. dev_set_drvdata(dev, card);
  157. return 0;
  158. }
  159. static struct isa_driver snd_es1688_driver = {
  160. .match = snd_es1688_match,
  161. .probe = snd_es1688_isa_probe,
  162. #if 0 /* FIXME */
  163. .suspend = snd_es1688_suspend,
  164. .resume = snd_es1688_resume,
  165. #endif
  166. .driver = {
  167. .name = DEV_NAME
  168. }
  169. };
  170. static int snd_es968_pnp_is_probed;
  171. #ifdef CONFIG_PNP
  172. static int snd_card_es968_pnp(struct snd_card *card, unsigned int n,
  173. struct pnp_card_link *pcard,
  174. const struct pnp_card_device_id *pid)
  175. {
  176. struct snd_es1688 *chip = card->private_data;
  177. struct pnp_dev *pdev;
  178. int error;
  179. pdev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
  180. if (pdev == NULL)
  181. return -ENODEV;
  182. error = pnp_activate_dev(pdev);
  183. if (error < 0) {
  184. snd_printk(KERN_ERR "ES968 pnp configure failure\n");
  185. return error;
  186. }
  187. port[n] = pnp_port_start(pdev, 0);
  188. dma8[n] = pnp_dma(pdev, 0);
  189. irq[n] = pnp_irq(pdev, 0);
  190. return snd_es1688_create(card, chip, port[n], mpu_port[n], irq[n],
  191. mpu_irq[n], dma8[n], ES1688_HW_AUTO);
  192. }
  193. static int snd_es968_pnp_detect(struct pnp_card_link *pcard,
  194. const struct pnp_card_device_id *pid)
  195. {
  196. struct snd_card *card;
  197. static unsigned int dev;
  198. int error;
  199. if (snd_es968_pnp_is_probed)
  200. return -EBUSY;
  201. for ( ; dev < SNDRV_CARDS; dev++) {
  202. if (enable[dev] && isapnp[dev])
  203. break;
  204. }
  205. if (dev == SNDRV_CARDS)
  206. return -ENODEV;
  207. error = snd_devm_card_new(&pcard->card->dev,
  208. index[dev], id[dev], THIS_MODULE,
  209. sizeof(struct snd_es1688), &card);
  210. if (error < 0)
  211. return error;
  212. error = snd_card_es968_pnp(card, dev, pcard, pid);
  213. if (error < 0)
  214. return error;
  215. error = snd_es1688_probe(card, dev);
  216. if (error < 0)
  217. return error;
  218. pnp_set_card_drvdata(pcard, card);
  219. snd_es968_pnp_is_probed = 1;
  220. return 0;
  221. }
  222. static void snd_es968_pnp_remove(struct pnp_card_link *pcard)
  223. {
  224. snd_es968_pnp_is_probed = 0;
  225. }
  226. #ifdef CONFIG_PM
  227. static int snd_es968_pnp_suspend(struct pnp_card_link *pcard,
  228. pm_message_t state)
  229. {
  230. struct snd_card *card = pnp_get_card_drvdata(pcard);
  231. snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
  232. return 0;
  233. }
  234. static int snd_es968_pnp_resume(struct pnp_card_link *pcard)
  235. {
  236. struct snd_card *card = pnp_get_card_drvdata(pcard);
  237. struct snd_es1688 *chip = card->private_data;
  238. snd_es1688_reset(chip);
  239. snd_power_change_state(card, SNDRV_CTL_POWER_D0);
  240. return 0;
  241. }
  242. #endif
  243. static const struct pnp_card_device_id snd_es968_pnpids[] = {
  244. { .id = "ESS0968", .devs = { { "@@@0968" }, } },
  245. { .id = "ESS0968", .devs = { { "ESS0968" }, } },
  246. { .id = "", } /* end */
  247. };
  248. MODULE_DEVICE_TABLE(pnp_card, snd_es968_pnpids);
  249. static struct pnp_card_driver es968_pnpc_driver = {
  250. .flags = PNP_DRIVER_RES_DISABLE,
  251. .name = DEV_NAME " PnP",
  252. .id_table = snd_es968_pnpids,
  253. .probe = snd_es968_pnp_detect,
  254. .remove = snd_es968_pnp_remove,
  255. #ifdef CONFIG_PM
  256. .suspend = snd_es968_pnp_suspend,
  257. .resume = snd_es968_pnp_resume,
  258. #endif
  259. };
  260. #endif
  261. static int __init alsa_card_es1688_init(void)
  262. {
  263. #ifdef CONFIG_PNP
  264. pnp_register_card_driver(&es968_pnpc_driver);
  265. if (snd_es968_pnp_is_probed)
  266. return 0;
  267. pnp_unregister_card_driver(&es968_pnpc_driver);
  268. #endif
  269. return isa_register_driver(&snd_es1688_driver, SNDRV_CARDS);
  270. }
  271. static void __exit alsa_card_es1688_exit(void)
  272. {
  273. if (!snd_es968_pnp_is_probed) {
  274. isa_unregister_driver(&snd_es1688_driver);
  275. return;
  276. }
  277. #ifdef CONFIG_PNP
  278. pnp_unregister_card_driver(&es968_pnpc_driver);
  279. #endif
  280. }
  281. module_init(alsa_card_es1688_init);
  282. module_exit(alsa_card_es1688_exit);