1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * PC-Speaker driver for Linux 4 * 5 * Copyright (C) 1997-2001 David Woodhouse 6 * Copyright (C) 2001-2008 Stas Sergeev 7 */ 8 9 #include <linux/init.h> 10 #include <linux/module.h> 11 #include <linux/platform_device.h> 12 #include <sound/core.h> 13 #include <sound/initval.h> 14 #include <sound/pcm.h> 15 #include <linux/input.h> 16 #include <linux/delay.h> 17 #include <linux/bitops.h> 18 #include <linux/mm.h> 19 #include "pcsp_input.h" 20 #include "pcsp.h" 21 22 MODULE_AUTHOR("Stas Sergeev <stsp@users.sourceforge.net>"); 23 MODULE_DESCRIPTION("PC-Speaker driver"); 24 MODULE_LICENSE("GPL"); 25 MODULE_ALIAS("platform:pcspkr"); 26 27 static int index = SNDRV_DEFAULT_IDX1; /* Index 0-MAX */ 28 static char *id = SNDRV_DEFAULT_STR1; /* ID for this card */ 29 static bool enable = SNDRV_DEFAULT_ENABLE1; /* Enable this card */ 30 static bool nopcm; /* Disable PCM capability of the driver */ 31 32 module_param(index, int, 0444); 33 MODULE_PARM_DESC(index, "Index value for pcsp soundcard."); 34 module_param(id, charp, 0444); 35 MODULE_PARM_DESC(id, "ID string for pcsp soundcard."); 36 module_param(enable, bool, 0444); 37 MODULE_PARM_DESC(enable, "Enable PC-Speaker sound."); 38 module_param(nopcm, bool, 0444); 39 MODULE_PARM_DESC(nopcm, "Disable PC-Speaker PCM sound. Only beeps remain."); 40 41 struct snd_pcsp pcsp_chip; 42 43 static int snd_pcsp_create(struct snd_card *card) 44 { 45 static const struct snd_device_ops ops = { }; 46 unsigned int resolution = hrtimer_resolution; 47 int err, div, min_div, order; 48 49 if (!nopcm) { 50 if (resolution > PCSP_MAX_PERIOD_NS) { 51 printk(KERN_ERR "PCSP: Timer resolution is not sufficient " 52 "(%unS)\n", resolution); 53 printk(KERN_ERR "PCSP: Make sure you have HPET and ACPI " 54 "enabled.\n"); 55 printk(KERN_ERR "PCSP: Turned into nopcm mode.\n"); 56 nopcm = 1; 57 } 58 } 59 60 if (loops_per_jiffy >= PCSP_MIN_LPJ && resolution <= PCSP_MIN_PERIOD_NS) 61 min_div = MIN_DIV; 62 else 63 min_div = MAX_DIV; 64 #if PCSP_DEBUG 65 printk(KERN_DEBUG "PCSP: lpj=%li, min_div=%i, res=%u\n", 66 loops_per_jiffy, min_div, resolution); 67 #endif 68 69 div = MAX_DIV / min_div; 70 order = fls(div) - 1; 71 72 pcsp_chip.max_treble = min(order, PCSP_MAX_TREBLE); 73 pcsp_chip.treble = min(pcsp_chip.max_treble, PCSP_DEFAULT_TREBLE); 74 pcsp_chip.playback_ptr = 0; 75 pcsp_chip.period_ptr = 0; 76 atomic_set(&pcsp_chip.timer_active, 0); 77 pcsp_chip.enable = 1; 78 pcsp_chip.pcspkr = 1; 79 80 spin_lock_init(&pcsp_chip.substream_lock); 81 82 pcsp_chip.card = card; 83 pcsp_chip.port = 0x61; 84 pcsp_chip.irq = -1; 85 pcsp_chip.dma = -1; 86 87 /* Register device */ 88 err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, &pcsp_chip, &ops); 89 if (err < 0) 90 return err; 91 92 return 0; 93 } 94 95 static int snd_card_pcsp_probe(int devnum, struct device *dev) 96 { 97 struct snd_card *card; 98 int err; 99 100 if (devnum != 0) 101 return -EINVAL; 102 103 hrtimer_init(&pcsp_chip.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL); 104 pcsp_chip.timer.function = pcsp_do_timer; 105 106 err = snd_card_new(dev, index, id, THIS_MODULE, 0, &card); 107 if (err < 0) 108 return err; 109 110 err = snd_pcsp_create(card); 111 if (err < 0) 112 goto free_card; 113 114 if (!nopcm) { 115 err = snd_pcsp_new_pcm(&pcsp_chip); 116 if (err < 0) 117 goto free_card; 118 } 119 err = snd_pcsp_new_mixer(&pcsp_chip, nopcm); 120 if (err < 0) 121 goto free_card; 122 123 strcpy(card->driver, "PC-Speaker"); 124 strcpy(card->shortname, "pcsp"); 125 sprintf(card->longname, "Internal PC-Speaker at port 0x%x", 126 pcsp_chip.port); 127 128 err = snd_card_register(card); 129 if (err < 0) 130 goto free_card; 131 132 return 0; 133 134 free_card: 135 snd_card_free(card); 136 return err; 137 } 138 139 static int alsa_card_pcsp_init(struct device *dev) 140 { 141 int err; 142 143 err = snd_card_pcsp_probe(0, dev); 144 if (err) { 145 printk(KERN_ERR "PC-Speaker initialization failed.\n"); 146 return err; 147 } 148 149 /* Well, CONFIG_DEBUG_PAGEALLOC makes the sound horrible. Lets alert */ 150 if (debug_pagealloc_enabled()) { 151 printk(KERN_WARNING "PCSP: CONFIG_DEBUG_PAGEALLOC is enabled, " 152 "which may make the sound noisy.\n"); 153 } 154 155 return 0; 156 } 157 158 static void alsa_card_pcsp_exit(struct snd_pcsp *chip) 159 { 160 snd_card_free(chip->card); 161 } 162 163 static int pcsp_probe(struct platform_device *dev) 164 { 165 int err; 166 167 err = pcspkr_input_init(&pcsp_chip.input_dev, &dev->dev); 168 if (err < 0) 169 return err; 170 171 err = alsa_card_pcsp_init(&dev->dev); 172 if (err < 0) { 173 pcspkr_input_remove(pcsp_chip.input_dev); 174 return err; 175 } 176 177 platform_set_drvdata(dev, &pcsp_chip); 178 return 0; 179 } 180 181 static int pcsp_remove(struct platform_device *dev) 182 { 183 struct snd_pcsp *chip = platform_get_drvdata(dev); 184 pcspkr_input_remove(chip->input_dev); 185 alsa_card_pcsp_exit(chip); 186 return 0; 187 } 188 189 static void pcsp_stop_beep(struct snd_pcsp *chip) 190 { 191 pcsp_sync_stop(chip); 192 pcspkr_stop_sound(); 193 } 194 195 #ifdef CONFIG_PM_SLEEP 196 static int pcsp_suspend(struct device *dev) 197 { 198 struct snd_pcsp *chip = dev_get_drvdata(dev); 199 pcsp_stop_beep(chip); 200 return 0; 201 } 202 203 static SIMPLE_DEV_PM_OPS(pcsp_pm, pcsp_suspend, NULL); 204 #define PCSP_PM_OPS &pcsp_pm 205 #else 206 #define PCSP_PM_OPS NULL 207 #endif /* CONFIG_PM_SLEEP */ 208 209 static void pcsp_shutdown(struct platform_device *dev) 210 { 211 struct snd_pcsp *chip = platform_get_drvdata(dev); 212 pcsp_stop_beep(chip); 213 } 214 215 static struct platform_driver pcsp_platform_driver = { 216 .driver = { 217 .name = "pcspkr", 218 .pm = PCSP_PM_OPS, 219 }, 220 .probe = pcsp_probe, 221 .remove = pcsp_remove, 222 .shutdown = pcsp_shutdown, 223 }; 224 225 static int __init pcsp_init(void) 226 { 227 if (!enable) 228 return -ENODEV; 229 return platform_driver_register(&pcsp_platform_driver); 230 } 231 232 static void __exit pcsp_exit(void) 233 { 234 platform_driver_unregister(&pcsp_platform_driver); 235 } 236 237 module_init(pcsp_init); 238 module_exit(pcsp_exit); 239