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