109c434b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 29ab4d072SStas Sergeev /* 39ab4d072SStas Sergeev * PC-Speaker driver for Linux 49ab4d072SStas Sergeev * 59ab4d072SStas Sergeev * Copyright (C) 1997-2001 David Woodhouse 69ab4d072SStas Sergeev * Copyright (C) 2001-2008 Stas Sergeev 79ab4d072SStas Sergeev */ 89ab4d072SStas Sergeev 99ab4d072SStas Sergeev #include <linux/init.h> 1065a77217SPaul Gortmaker #include <linux/module.h> 119ab4d072SStas Sergeev #include <linux/platform_device.h> 129ab4d072SStas Sergeev #include <sound/core.h> 139ab4d072SStas Sergeev #include <sound/initval.h> 149ab4d072SStas Sergeev #include <sound/pcm.h> 159ab4d072SStas Sergeev #include <linux/input.h> 169ecaedaeSMariusz Kozlowski #include <linux/delay.h> 17976412fbSTakashi Iwai #include <linux/bitops.h> 18505f6d22SJoonsoo Kim #include <linux/mm.h> 199ab4d072SStas Sergeev #include "pcsp_input.h" 209ab4d072SStas Sergeev #include "pcsp.h" 219ab4d072SStas Sergeev 229ab4d072SStas Sergeev MODULE_AUTHOR("Stas Sergeev <stsp@users.sourceforge.net>"); 239ab4d072SStas Sergeev MODULE_DESCRIPTION("PC-Speaker driver"); 249ab4d072SStas Sergeev MODULE_LICENSE("GPL"); 259ab4d072SStas Sergeev MODULE_ALIAS("platform:pcspkr"); 269ab4d072SStas Sergeev 279ab4d072SStas Sergeev static int index = SNDRV_DEFAULT_IDX1; /* Index 0-MAX */ 289ab4d072SStas Sergeev static char *id = SNDRV_DEFAULT_STR1; /* ID for this card */ 29a67ff6a5SRusty Russell static bool enable = SNDRV_DEFAULT_ENABLE1; /* Enable this card */ 30a67ff6a5SRusty Russell static bool nopcm; /* Disable PCM capability of the driver */ 319ab4d072SStas Sergeev 329ab4d072SStas Sergeev module_param(index, int, 0444); 339ab4d072SStas Sergeev MODULE_PARM_DESC(index, "Index value for pcsp soundcard."); 349ab4d072SStas Sergeev module_param(id, charp, 0444); 359ab4d072SStas Sergeev MODULE_PARM_DESC(id, "ID string for pcsp soundcard."); 369ab4d072SStas Sergeev module_param(enable, bool, 0444); 3752337310SStas Sergeev MODULE_PARM_DESC(enable, "Enable PC-Speaker sound."); 38bcc2c6b7SStas Sergeev module_param(nopcm, bool, 0444); 39bcc2c6b7SStas Sergeev MODULE_PARM_DESC(nopcm, "Disable PC-Speaker PCM sound. Only beeps remain."); 409ab4d072SStas Sergeev 419ab4d072SStas Sergeev struct snd_pcsp pcsp_chip; 429ab4d072SStas Sergeev 43fbbb01a1SBill Pemberton static int snd_pcsp_create(struct snd_card *card) 449ab4d072SStas Sergeev { 45447fbbdcSThomas Gleixner unsigned int resolution = hrtimer_resolution; 463a1e341cSTakashi Iwai int div, min_div, order; 4775415df8STakashi Iwai 4875415df8STakashi Iwai if (!nopcm) { 49447fbbdcSThomas Gleixner if (resolution > PCSP_MAX_PERIOD_NS) { 509ab4d072SStas Sergeev printk(KERN_ERR "PCSP: Timer resolution is not sufficient " 51c78c8818SThomas Gleixner "(%unS)\n", resolution); 529ab4d072SStas Sergeev printk(KERN_ERR "PCSP: Make sure you have HPET and ACPI " 539ab4d072SStas Sergeev "enabled.\n"); 54bcc2c6b7SStas Sergeev printk(KERN_ERR "PCSP: Turned into nopcm mode.\n"); 55bcc2c6b7SStas Sergeev nopcm = 1; 56bcc2c6b7SStas Sergeev } 579ab4d072SStas Sergeev } 589ab4d072SStas Sergeev 59447fbbdcSThomas Gleixner if (loops_per_jiffy >= PCSP_MIN_LPJ && resolution <= PCSP_MIN_PERIOD_NS) 609ab4d072SStas Sergeev min_div = MIN_DIV; 619ab4d072SStas Sergeev else 629ab4d072SStas Sergeev min_div = MAX_DIV; 639ab4d072SStas Sergeev #if PCSP_DEBUG 64c78c8818SThomas Gleixner printk(KERN_DEBUG "PCSP: lpj=%li, min_div=%i, res=%u\n", 65447fbbdcSThomas Gleixner loops_per_jiffy, min_div, resolution); 669ab4d072SStas Sergeev #endif 679ab4d072SStas Sergeev 689ab4d072SStas Sergeev div = MAX_DIV / min_div; 699ab4d072SStas Sergeev order = fls(div) - 1; 709ab4d072SStas Sergeev 719ab4d072SStas Sergeev pcsp_chip.max_treble = min(order, PCSP_MAX_TREBLE); 729ab4d072SStas Sergeev pcsp_chip.treble = min(pcsp_chip.max_treble, PCSP_DEFAULT_TREBLE); 739ab4d072SStas Sergeev pcsp_chip.playback_ptr = 0; 749ab4d072SStas Sergeev pcsp_chip.period_ptr = 0; 759ab4d072SStas Sergeev atomic_set(&pcsp_chip.timer_active, 0); 769ab4d072SStas Sergeev pcsp_chip.enable = 1; 779ab4d072SStas Sergeev pcsp_chip.pcspkr = 1; 789ab4d072SStas Sergeev 799ab4d072SStas Sergeev spin_lock_init(&pcsp_chip.substream_lock); 809ab4d072SStas Sergeev 819ab4d072SStas Sergeev pcsp_chip.card = card; 829ab4d072SStas Sergeev pcsp_chip.port = 0x61; 839ab4d072SStas Sergeev pcsp_chip.irq = -1; 849ab4d072SStas Sergeev pcsp_chip.dma = -1; 853a1e341cSTakashi Iwai card->private_data = &pcsp_chip; 869ab4d072SStas Sergeev 879ab4d072SStas Sergeev return 0; 889ab4d072SStas Sergeev } 899ab4d072SStas Sergeev 903a1e341cSTakashi Iwai static void pcsp_stop_beep(struct snd_pcsp *chip); 913a1e341cSTakashi Iwai 923a1e341cSTakashi Iwai static void alsa_card_pcsp_free(struct snd_card *card) 933a1e341cSTakashi Iwai { 943a1e341cSTakashi Iwai pcsp_stop_beep(card->private_data); 953a1e341cSTakashi Iwai } 963a1e341cSTakashi Iwai 97fbbb01a1SBill Pemberton static int snd_card_pcsp_probe(int devnum, struct device *dev) 989ab4d072SStas Sergeev { 999ab4d072SStas Sergeev struct snd_card *card; 1009ab4d072SStas Sergeev int err; 1019ab4d072SStas Sergeev 1029ab4d072SStas Sergeev if (devnum != 0) 1039ab4d072SStas Sergeev return -EINVAL; 1049ab4d072SStas Sergeev 1059ab4d072SStas Sergeev hrtimer_init(&pcsp_chip.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL); 1069ab4d072SStas Sergeev pcsp_chip.timer.function = pcsp_do_timer; 1079ab4d072SStas Sergeev 1083a1e341cSTakashi Iwai err = snd_devm_card_new(dev, index, id, THIS_MODULE, 0, &card); 109bd7dd77cSTakashi Iwai if (err < 0) 110bd7dd77cSTakashi Iwai return err; 1119ab4d072SStas Sergeev 1129ab4d072SStas Sergeev err = snd_pcsp_create(card); 1132cded8c8SMarkus Elfring if (err < 0) 1143a1e341cSTakashi Iwai return err; 1152cded8c8SMarkus Elfring 116bcc2c6b7SStas Sergeev if (!nopcm) { 1179ab4d072SStas Sergeev err = snd_pcsp_new_pcm(&pcsp_chip); 1182cded8c8SMarkus Elfring if (err < 0) 1193a1e341cSTakashi Iwai return err; 120bcc2c6b7SStas Sergeev } 121bcc2c6b7SStas Sergeev err = snd_pcsp_new_mixer(&pcsp_chip, nopcm); 1222cded8c8SMarkus Elfring if (err < 0) 1233a1e341cSTakashi Iwai return err; 1249ab4d072SStas Sergeev 1259ab4d072SStas Sergeev strcpy(card->driver, "PC-Speaker"); 1269ab4d072SStas Sergeev strcpy(card->shortname, "pcsp"); 1279ab4d072SStas Sergeev sprintf(card->longname, "Internal PC-Speaker at port 0x%x", 1289ab4d072SStas Sergeev pcsp_chip.port); 1299ab4d072SStas Sergeev 1309ab4d072SStas Sergeev err = snd_card_register(card); 1312cded8c8SMarkus Elfring if (err < 0) 1323a1e341cSTakashi Iwai return err; 1333a1e341cSTakashi Iwai card->private_free = alsa_card_pcsp_free; 1349ab4d072SStas Sergeev 1359ab4d072SStas Sergeev return 0; 1369ab4d072SStas Sergeev } 1379ab4d072SStas Sergeev 138fbbb01a1SBill Pemberton static int alsa_card_pcsp_init(struct device *dev) 1399ab4d072SStas Sergeev { 14052337310SStas Sergeev int err; 14152337310SStas Sergeev 14252337310SStas Sergeev err = snd_card_pcsp_probe(0, dev); 14352337310SStas Sergeev if (err) { 14452337310SStas Sergeev printk(KERN_ERR "PC-Speaker initialization failed.\n"); 14552337310SStas Sergeev return err; 14652337310SStas Sergeev } 1479ab4d072SStas Sergeev 1489ab4d072SStas Sergeev /* Well, CONFIG_DEBUG_PAGEALLOC makes the sound horrible. Lets alert */ 149505f6d22SJoonsoo Kim if (debug_pagealloc_enabled()) { 150efd89d9dSStas Sergeev printk(KERN_WARNING "PCSP: CONFIG_DEBUG_PAGEALLOC is enabled, " 151efd89d9dSStas Sergeev "which may make the sound noisy.\n"); 152505f6d22SJoonsoo Kim } 1539ab4d072SStas Sergeev 1549ab4d072SStas Sergeev return 0; 1559ab4d072SStas Sergeev } 1569ab4d072SStas Sergeev 157fbbb01a1SBill Pemberton static int pcsp_probe(struct platform_device *dev) 1589ab4d072SStas Sergeev { 1599ab4d072SStas Sergeev int err; 16052337310SStas Sergeev 1619ab4d072SStas Sergeev err = pcspkr_input_init(&pcsp_chip.input_dev, &dev->dev); 1629ab4d072SStas Sergeev if (err < 0) 1639ab4d072SStas Sergeev return err; 1649ab4d072SStas Sergeev 1659ab4d072SStas Sergeev err = alsa_card_pcsp_init(&dev->dev); 1663a1e341cSTakashi Iwai if (err < 0) 1679ab4d072SStas Sergeev return err; 1689ab4d072SStas Sergeev 1699ab4d072SStas Sergeev platform_set_drvdata(dev, &pcsp_chip); 1709ab4d072SStas Sergeev return 0; 1719ab4d072SStas Sergeev } 1729ab4d072SStas Sergeev 1739ab4d072SStas Sergeev static void pcsp_stop_beep(struct snd_pcsp *chip) 1749ab4d072SStas Sergeev { 17596c7d478STakashi Iwai pcsp_sync_stop(chip); 1769ab4d072SStas Sergeev pcspkr_stop_sound(); 1779ab4d072SStas Sergeev } 1789ab4d072SStas Sergeev 179284e7ca7STakashi Iwai static int pcsp_suspend(struct device *dev) 1809ab4d072SStas Sergeev { 181284e7ca7STakashi Iwai struct snd_pcsp *chip = dev_get_drvdata(dev); 1829ab4d072SStas Sergeev pcsp_stop_beep(chip); 1839ab4d072SStas Sergeev return 0; 1849ab4d072SStas Sergeev } 185284e7ca7STakashi Iwai 186*19e332e5STakashi Iwai static DEFINE_SIMPLE_DEV_PM_OPS(pcsp_pm, pcsp_suspend, NULL); 1879ab4d072SStas Sergeev 1889ab4d072SStas Sergeev static void pcsp_shutdown(struct platform_device *dev) 1899ab4d072SStas Sergeev { 1909ab4d072SStas Sergeev struct snd_pcsp *chip = platform_get_drvdata(dev); 1919ab4d072SStas Sergeev pcsp_stop_beep(chip); 1929ab4d072SStas Sergeev } 1939ab4d072SStas Sergeev 1949ab4d072SStas Sergeev static struct platform_driver pcsp_platform_driver = { 1959ab4d072SStas Sergeev .driver = { 1969ab4d072SStas Sergeev .name = "pcspkr", 197*19e332e5STakashi Iwai .pm = &pcsp_pm, 1989ab4d072SStas Sergeev }, 1999ab4d072SStas Sergeev .probe = pcsp_probe, 2009ab4d072SStas Sergeev .shutdown = pcsp_shutdown, 2019ab4d072SStas Sergeev }; 2029ab4d072SStas Sergeev 2039ab4d072SStas Sergeev static int __init pcsp_init(void) 2049ab4d072SStas Sergeev { 20552337310SStas Sergeev if (!enable) 20652337310SStas Sergeev return -ENODEV; 2079ab4d072SStas Sergeev return platform_driver_register(&pcsp_platform_driver); 2089ab4d072SStas Sergeev } 2099ab4d072SStas Sergeev 2109ab4d072SStas Sergeev static void __exit pcsp_exit(void) 2119ab4d072SStas Sergeev { 2129ab4d072SStas Sergeev platform_driver_unregister(&pcsp_platform_driver); 2139ab4d072SStas Sergeev } 2149ab4d072SStas Sergeev 2159ab4d072SStas Sergeev module_init(pcsp_init); 2169ab4d072SStas Sergeev module_exit(pcsp_exit); 217