hw/audio/pcspk.c

   1 /*
   2  * QEMU PC speaker emulation
   3  *
   4  * Copyright (c) 2006 Joachim Henke
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "qemu/osdep.h"
  26 #include "hw/isa/isa.h"
  27 #include "hw/audio/soundhw.h"
  28 #include "audio/audio.h"
  29 #include "qemu/module.h"
  30 #include "qemu/timer.h"
  31 #include "qemu/error-report.h"
  32 #include "hw/timer/i8254.h"
  33 #include "migration/vmstate.h"
  34 #include "hw/audio/pcspk.h"
  35 #include "qapi/error.h"
  36 #include "qom/object.h"
  37
  38 #define PCSPK_BUF_LEN 1792
  39 #define PCSPK_SAMPLE_RATE 32000
  40 #define PCSPK_MAX_FREQ (PCSPK_SAMPLE_RATE >> 1)
  41 #define PCSPK_MIN_COUNT DIV_ROUND_UP(PIT_FREQ, PCSPK_MAX_FREQ)
  42
  43 typedef struct PCSpkState PCSpkState;
  44 DECLARE_INSTANCE_CHECKER(PCSpkState, PC_SPEAKER,
  45                          TYPE_PC_SPEAKER)
  46
  47 struct PCSpkState {
  48     ISADevice parent_obj;
  49
  50     MemoryRegion ioport;
  51     uint32_t iobase;
  52     uint8_t sample_buf[PCSPK_BUF_LEN];
  53     QEMUSoundCard card;
  54     SWVoiceOut *voice;
  55     void *pit;
  56     unsigned int pit_count;
  57     unsigned int samples;
  58     unsigned int play_pos;
  59     uint8_t data_on;
  60     uint8_t dummy_refresh_clock;
  61     bool migrate;
  62 };
  63
  64 static const char *s_spk = "pcspk";
  65 static PCSpkState *pcspk_state;
  66
  67 static inline void generate_samples(PCSpkState *s)
  68 {
  69     unsigned int i;
  70
  71     if (s->pit_count) {
  72         const uint32_t m = PCSPK_SAMPLE_RATE * s->pit_count;
  73         const uint32_t n = ((uint64_t)PIT_FREQ << 32) / m;
  74
  75         /* multiple of wavelength for gapless looping */
  76         s->samples = (QEMU_ALIGN_DOWN(PCSPK_BUF_LEN * PIT_FREQ, m) / (PIT_FREQ >> 1) + 1) >> 1;
  77         for (i = 0; i < s->samples; ++i)
  78             s->sample_buf[i] = (64 & (n * i >> 25)) - 32;
  79     } else {
  80         s->samples = PCSPK_BUF_LEN;
  81         for (i = 0; i < PCSPK_BUF_LEN; ++i)
  82             s->sample_buf[i] = 128; /* silence */
  83     }
  84 }
  85
  86 static void pcspk_callback(void *opaque, int free)
  87 {
  88     PCSpkState *s = opaque;
  89     PITChannelInfo ch;
  90     unsigned int n;
  91
  92     pit_get_channel_info(s->pit, 2, &ch);
  93
  94     if (ch.mode != 3) {
  95         return;
  96     }
  97
  98     n = ch.initial_count;
  99     /* avoid frequencies that are not reproducible with sample rate */
 100     if (n < PCSPK_MIN_COUNT)
 101         n = 0;
 102
 103     if (s->pit_count != n) {
 104         s->pit_count = n;
 105         s->play_pos = 0;
 106         generate_samples(s);
 107     }
 108
 109     while (free > 0) {
 110         n = MIN(s->samples - s->play_pos, (unsigned int)free);
 111         n = AUD_write(s->voice, &s->sample_buf[s->play_pos], n);
 112         if (!n)
 113             break;
 114         s->play_pos = (s->play_pos + n) % s->samples;
 115         free -= n;
 116     }
 117 }
 118
 119 static int pcspk_audio_init(PCSpkState *s)
 120 {
 121     struct audsettings as = {PCSPK_SAMPLE_RATE, 1, AUDIO_FORMAT_U8, 0};
 122
 123     if (s->voice) {
 124         /* already initialized */
 125         return 0;
 126     }
 127
 128     AUD_register_card(s_spk, &s->card);
 129
 130     s->voice = AUD_open_out(&s->card, s->voice, s_spk, s, pcspk_callback, &as);
 131     if (!s->voice) {
 132         AUD_log(s_spk, "Could not open voice\n");
 133         return -1;
 134     }
 135
 136     return 0;
 137 }
 138
 139 static uint64_t pcspk_io_read(void *opaque, hwaddr addr,
 140                               unsigned size)
 141 {
 142     PCSpkState *s = opaque;
 143     PITChannelInfo ch;
 144
 145     pit_get_channel_info(s->pit, 2, &ch);
 146
 147     s->dummy_refresh_clock ^= (1 << 4);
 148
 149     return ch.gate | (s->data_on << 1) | s->dummy_refresh_clock |
 150        (ch.out << 5);
 151 }
 152
 153 static void pcspk_io_write(void *opaque, hwaddr addr, uint64_t val,
 154                            unsigned size)
 155 {
 156     PCSpkState *s = opaque;
 157     const int gate = val & 1;
 158
 159     s->data_on = (val >> 1) & 1;
 160     pit_set_gate(s->pit, 2, gate);
 161     if (s->voice) {
 162         if (gate) /* restart */
 163             s->play_pos = 0;
 164         AUD_set_active_out(s->voice, gate & s->data_on);
 165     }
 166 }
 167
 168 static const MemoryRegionOps pcspk_io_ops = {
 169     .read = pcspk_io_read,
 170     .write = pcspk_io_write,
 171     .impl = {
 172         .min_access_size = 1,
 173         .max_access_size = 1,
 174     },
 175 };
 176
 177 static void pcspk_initfn(Object *obj)
 178 {
 179     PCSpkState *s = PC_SPEAKER(obj);
 180
 181     memory_region_init_io(&s->ioport, OBJECT(s), &pcspk_io_ops, s, "pcspk", 1);
 182
 183     object_property_add_link(obj, "pit", TYPE_PIT_COMMON,
 184                              (Object **)&s->pit,
 185                              qdev_prop_allow_set_link_before_realize,
 186                              0);
 187 }
 188
 189 static void pcspk_realizefn(DeviceState *dev, Error **errp)
 190 {
 191     ISADevice *isadev = ISA_DEVICE(dev);
 192     PCSpkState *s = PC_SPEAKER(dev);
 193
 194     isa_register_ioport(isadev, &s->ioport, s->iobase);
 195
 196     if (s->card.state) {
 197         pcspk_audio_init(s);
 198     }
 199
 200     pcspk_state = s;
 201 }
 202
 203 static bool migrate_needed(void *opaque)
 204 {
 205     PCSpkState *s = opaque;
 206
 207     return s->migrate;
 208 }
 209
 210 static const VMStateDescription vmstate_spk = {
 211     .name = "pcspk",
 212     .version_id = 1,
 213     .minimum_version_id = 1,
 214     .minimum_version_id_old = 1,
 215     .needed = migrate_needed,
 216     .fields      = (VMStateField[]) {
 217         VMSTATE_UINT8(data_on, PCSpkState),
 218         VMSTATE_UINT8(dummy_refresh_clock, PCSpkState),
 219         VMSTATE_END_OF_LIST()
 220     }
 221 };
 222
 223 static Property pcspk_properties[] = {
 224     DEFINE_AUDIO_PROPERTIES(PCSpkState, card),
 225     DEFINE_PROP_UINT32("iobase", PCSpkState, iobase,  0x61),
 226     DEFINE_PROP_BOOL("migrate", PCSpkState, migrate,  true),
 227     DEFINE_PROP_END_OF_LIST(),
 228 };
 229
 230 static void pcspk_class_initfn(ObjectClass *klass, void *data)
 231 {
 232     DeviceClass *dc = DEVICE_CLASS(klass);
 233
 234     dc->realize = pcspk_realizefn;
 235     set_bit(DEVICE_CATEGORY_SOUND, dc->categories);
 236     dc->vmsd = &vmstate_spk;
 237     device_class_set_props(dc, pcspk_properties);
 238     /* Reason: realize sets global pcspk_state */
 239     /* Reason: pit object link */
 240     dc->user_creatable = false;
 241 }
 242
 243 static const TypeInfo pcspk_info = {
 244     .name           = TYPE_PC_SPEAKER,
 245     .parent         = TYPE_ISA_DEVICE,
 246     .instance_size  = sizeof(PCSpkState),
 247     .instance_init  = pcspk_initfn,
 248     .class_init     = pcspk_class_initfn,
 249 };
 250
 251 static int pcspk_audio_init_soundhw(ISABus *bus)
 252 {
 253     PCSpkState *s = pcspk_state;
 254
 255     warn_report("'-soundhw pcspk' is deprecated, "
 256                 "please set a backend using '-machine pcspk-audiodev=<name>' instead");
 257     return pcspk_audio_init(s);
 258 }
 259
 260 static void pcspk_register(void)
 261 {
 262     type_register_static(&pcspk_info);
 263     isa_register_soundhw("pcspk", "PC speaker", pcspk_audio_init_soundhw);
 264 }
 265 type_init(pcspk_register)