qemu/hw/char/milkymist-uart.c
<<
>>
Prefs
   1/*
   2 *  QEMU model of the Milkymist UART block.
   3 *
   4 *  Copyright (c) 2010 Michael Walle <michael@walle.cc>
   5 *
   6 * This library is free software; you can redistribute it and/or
   7 * modify it under the terms of the GNU Lesser General Public
   8 * License as published by the Free Software Foundation; either
   9 * version 2 of the License, or (at your option) any later version.
  10 *
  11 * This library is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 * Lesser General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU Lesser General Public
  17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18 *
  19 *
  20 * Specification available at:
  21 *   http://milkymist.walle.cc/socdoc/uart.pdf
  22 */
  23
  24#include "qemu/osdep.h"
  25#include "hw/hw.h"
  26#include "hw/sysbus.h"
  27#include "trace.h"
  28#include "chardev/char-fe.h"
  29#include "qemu/error-report.h"
  30#include "qemu/module.h"
  31
  32enum {
  33    R_RXTX = 0,
  34    R_DIV,
  35    R_STAT,
  36    R_CTRL,
  37    R_DBG,
  38    R_MAX
  39};
  40
  41enum {
  42    STAT_THRE   = (1<<0),
  43    STAT_RX_EVT = (1<<1),
  44    STAT_TX_EVT = (1<<2),
  45};
  46
  47enum {
  48    CTRL_RX_IRQ_EN = (1<<0),
  49    CTRL_TX_IRQ_EN = (1<<1),
  50    CTRL_THRU_EN   = (1<<2),
  51};
  52
  53enum {
  54    DBG_BREAK_EN = (1<<0),
  55};
  56
  57#define TYPE_MILKYMIST_UART "milkymist-uart"
  58#define MILKYMIST_UART(obj) \
  59    OBJECT_CHECK(MilkymistUartState, (obj), TYPE_MILKYMIST_UART)
  60
  61struct MilkymistUartState {
  62    SysBusDevice parent_obj;
  63
  64    MemoryRegion regs_region;
  65    CharBackend chr;
  66    qemu_irq irq;
  67
  68    uint32_t regs[R_MAX];
  69};
  70typedef struct MilkymistUartState MilkymistUartState;
  71
  72static void uart_update_irq(MilkymistUartState *s)
  73{
  74    int rx_event = s->regs[R_STAT] & STAT_RX_EVT;
  75    int tx_event = s->regs[R_STAT] & STAT_TX_EVT;
  76    int rx_irq_en = s->regs[R_CTRL] & CTRL_RX_IRQ_EN;
  77    int tx_irq_en = s->regs[R_CTRL] & CTRL_TX_IRQ_EN;
  78
  79    if ((rx_irq_en && rx_event) || (tx_irq_en && tx_event)) {
  80        trace_milkymist_uart_raise_irq();
  81        qemu_irq_raise(s->irq);
  82    } else {
  83        trace_milkymist_uart_lower_irq();
  84        qemu_irq_lower(s->irq);
  85    }
  86}
  87
  88static uint64_t uart_read(void *opaque, hwaddr addr,
  89                          unsigned size)
  90{
  91    MilkymistUartState *s = opaque;
  92    uint32_t r = 0;
  93
  94    addr >>= 2;
  95    switch (addr) {
  96    case R_RXTX:
  97        r = s->regs[addr];
  98        break;
  99    case R_DIV:
 100    case R_STAT:
 101    case R_CTRL:
 102    case R_DBG:
 103        r = s->regs[addr];
 104        break;
 105
 106    default:
 107        error_report("milkymist_uart: read access to unknown register 0x"
 108                TARGET_FMT_plx, addr << 2);
 109        break;
 110    }
 111
 112    trace_milkymist_uart_memory_read(addr << 2, r);
 113
 114    return r;
 115}
 116
 117static void uart_write(void *opaque, hwaddr addr, uint64_t value,
 118                       unsigned size)
 119{
 120    MilkymistUartState *s = opaque;
 121    unsigned char ch = value;
 122
 123    trace_milkymist_uart_memory_write(addr, value);
 124
 125    addr >>= 2;
 126    switch (addr) {
 127    case R_RXTX:
 128        qemu_chr_fe_write_all(&s->chr, &ch, 1);
 129        s->regs[R_STAT] |= STAT_TX_EVT;
 130        break;
 131    case R_DIV:
 132    case R_CTRL:
 133    case R_DBG:
 134        s->regs[addr] = value;
 135        break;
 136
 137    case R_STAT:
 138        /* write one to clear bits */
 139        s->regs[addr] &= ~(value & (STAT_RX_EVT | STAT_TX_EVT));
 140        qemu_chr_fe_accept_input(&s->chr);
 141        break;
 142
 143    default:
 144        error_report("milkymist_uart: write access to unknown register 0x"
 145                TARGET_FMT_plx, addr << 2);
 146        break;
 147    }
 148
 149    uart_update_irq(s);
 150}
 151
 152static const MemoryRegionOps uart_mmio_ops = {
 153    .read = uart_read,
 154    .write = uart_write,
 155    .valid = {
 156        .min_access_size = 4,
 157        .max_access_size = 4,
 158    },
 159    .endianness = DEVICE_NATIVE_ENDIAN,
 160};
 161
 162static void uart_rx(void *opaque, const uint8_t *buf, int size)
 163{
 164    MilkymistUartState *s = opaque;
 165
 166    assert(!(s->regs[R_STAT] & STAT_RX_EVT));
 167
 168    s->regs[R_STAT] |= STAT_RX_EVT;
 169    s->regs[R_RXTX] = *buf;
 170
 171    uart_update_irq(s);
 172}
 173
 174static int uart_can_rx(void *opaque)
 175{
 176    MilkymistUartState *s = opaque;
 177
 178    return !(s->regs[R_STAT] & STAT_RX_EVT);
 179}
 180
 181static void uart_event(void *opaque, int event)
 182{
 183}
 184
 185static void milkymist_uart_reset(DeviceState *d)
 186{
 187    MilkymistUartState *s = MILKYMIST_UART(d);
 188    int i;
 189
 190    for (i = 0; i < R_MAX; i++) {
 191        s->regs[i] = 0;
 192    }
 193
 194    /* THRE is always set */
 195    s->regs[R_STAT] = STAT_THRE;
 196}
 197
 198static void milkymist_uart_realize(DeviceState *dev, Error **errp)
 199{
 200    MilkymistUartState *s = MILKYMIST_UART(dev);
 201
 202    qemu_chr_fe_set_handlers(&s->chr, uart_can_rx, uart_rx,
 203                             uart_event, NULL, s, NULL, true);
 204}
 205
 206static void milkymist_uart_init(Object *obj)
 207{
 208    SysBusDevice *sbd = SYS_BUS_DEVICE(obj);
 209    MilkymistUartState *s = MILKYMIST_UART(obj);
 210
 211    sysbus_init_irq(sbd, &s->irq);
 212
 213    memory_region_init_io(&s->regs_region, OBJECT(s), &uart_mmio_ops, s,
 214                          "milkymist-uart", R_MAX * 4);
 215    sysbus_init_mmio(sbd, &s->regs_region);
 216}
 217
 218static const VMStateDescription vmstate_milkymist_uart = {
 219    .name = "milkymist-uart",
 220    .version_id = 1,
 221    .minimum_version_id = 1,
 222    .fields = (VMStateField[]) {
 223        VMSTATE_UINT32_ARRAY(regs, MilkymistUartState, R_MAX),
 224        VMSTATE_END_OF_LIST()
 225    }
 226};
 227
 228static Property milkymist_uart_properties[] = {
 229    DEFINE_PROP_CHR("chardev", MilkymistUartState, chr),
 230    DEFINE_PROP_END_OF_LIST(),
 231};
 232
 233static void milkymist_uart_class_init(ObjectClass *klass, void *data)
 234{
 235    DeviceClass *dc = DEVICE_CLASS(klass);
 236
 237    dc->realize = milkymist_uart_realize;
 238    dc->reset = milkymist_uart_reset;
 239    dc->vmsd = &vmstate_milkymist_uart;
 240    dc->props = milkymist_uart_properties;
 241}
 242
 243static const TypeInfo milkymist_uart_info = {
 244    .name          = TYPE_MILKYMIST_UART,
 245    .parent        = TYPE_SYS_BUS_DEVICE,
 246    .instance_size = sizeof(MilkymistUartState),
 247    .instance_init = milkymist_uart_init,
 248    .class_init    = milkymist_uart_class_init,
 249};
 250
 251static void milkymist_uart_register_types(void)
 252{
 253    type_register_static(&milkymist_uart_info);
 254}
 255
 256type_init(milkymist_uart_register_types)
 257