hw/input/pl050.c

   1 /*
   2  * Arm PrimeCell PL050 Keyboard / Mouse Interface
   3  *
   4  * Copyright (c) 2006-2007 CodeSourcery.
   5  * Written by Paul Brook
   6  *
   7  * This code is licensed under the GPL.
   8  */
   9
  10 #include "qemu/osdep.h"
  11 #include "hw/sysbus.h"
  12 #include "migration/vmstate.h"
  13 #include "hw/input/ps2.h"
  14 #include "hw/irq.h"
  15 #include "qemu/log.h"
  16 #include "qemu/module.h"
  17
  18 #define TYPE_PL050 "pl050"
  19 #define PL050(obj) OBJECT_CHECK(PL050State, (obj), TYPE_PL050)
  20
  21 typedef struct PL050State {
  22     SysBusDevice parent_obj;
  23
  24     MemoryRegion iomem;
  25     void *dev;
  26     uint32_t cr;
  27     uint32_t clk;
  28     uint32_t last;
  29     int pending;
  30     qemu_irq irq;
  31     bool is_mouse;
  32 } PL050State;
  33
  34 static const VMStateDescription vmstate_pl050 = {
  35     .name = "pl050",
  36     .version_id = 2,
  37     .minimum_version_id = 2,
  38     .fields = (VMStateField[]) {
  39         VMSTATE_UINT32(cr, PL050State),
  40         VMSTATE_UINT32(clk, PL050State),
  41         VMSTATE_UINT32(last, PL050State),
  42         VMSTATE_INT32(pending, PL050State),
  43         VMSTATE_END_OF_LIST()
  44     }
  45 };
  46
  47 #define PL050_TXEMPTY         (1 << 6)
  48 #define PL050_TXBUSY          (1 << 5)
  49 #define PL050_RXFULL          (1 << 4)
  50 #define PL050_RXBUSY          (1 << 3)
  51 #define PL050_RXPARITY        (1 << 2)
  52 #define PL050_KMIC            (1 << 1)
  53 #define PL050_KMID            (1 << 0)
  54
  55 static const unsigned char pl050_id[] =
  56 { 0x50, 0x10, 0x04, 0x00, 0x0d, 0xf0, 0x05, 0xb1 };
  57
  58 static void pl050_update(void *opaque, int level)
  59 {
  60     PL050State *s = (PL050State *)opaque;
  61     int raise;
  62
  63     s->pending = level;
  64     raise = (s->pending && (s->cr & 0x10) != 0)
  65             || (s->cr & 0x08) != 0;
  66     qemu_set_irq(s->irq, raise);
  67 }
  68
  69 static uint64_t pl050_read(void *opaque, hwaddr offset,
  70                            unsigned size)
  71 {
  72     PL050State *s = (PL050State *)opaque;
  73     if (offset >= 0xfe0 && offset < 0x1000)
  74         return pl050_id[(offset - 0xfe0) >> 2];
  75
  76     switch (offset >> 2) {
  77     case 0: /* KMICR */
  78         return s->cr;
  79     case 1: /* KMISTAT */
  80         {
  81             uint8_t val;
  82             uint32_t stat;
  83
  84             val = s->last;
  85             val = val ^ (val >> 4);
  86             val = val ^ (val >> 2);
  87             val = (val ^ (val >> 1)) & 1;
  88
  89             stat = PL050_TXEMPTY;
  90             if (val)
  91                 stat |= PL050_RXPARITY;
  92             if (s->pending)
  93                 stat |= PL050_RXFULL;
  94
  95             return stat;
  96         }
  97     case 2: /* KMIDATA */
  98         if (s->pending)
  99             s->last = ps2_read_data(s->dev);
 100         return s->last;
 101     case 3: /* KMICLKDIV */
 102         return s->clk;
 103     case 4: /* KMIIR */
 104         return s->pending | 2;
 105     default:
 106         qemu_log_mask(LOG_GUEST_ERROR,
 107                       "pl050_read: Bad offset %x\n", (int)offset);
 108         return 0;
 109     }
 110 }
 111
 112 static void pl050_write(void *opaque, hwaddr offset,
 113                         uint64_t value, unsigned size)
 114 {
 115     PL050State *s = (PL050State *)opaque;
 116     switch (offset >> 2) {
 117     case 0: /* KMICR */
 118         s->cr = value;
 119         pl050_update(s, s->pending);
 120         /* ??? Need to implement the enable/disable bit.  */
 121         break;
 122     case 2: /* KMIDATA */
 123         /* ??? This should toggle the TX interrupt line.  */
 124         /* ??? This means kbd/mouse can block each other.  */
 125         if (s->is_mouse) {
 126             ps2_write_mouse(s->dev, value);
 127         } else {
 128             ps2_write_keyboard(s->dev, value);
 129         }
 130         break;
 131     case 3: /* KMICLKDIV */
 132         s->clk = value;
 133         return;
 134     default:
 135         qemu_log_mask(LOG_GUEST_ERROR,
 136                       "pl050_write: Bad offset %x\n", (int)offset);
 137     }
 138 }
 139 static const MemoryRegionOps pl050_ops = {
 140     .read = pl050_read,
 141     .write = pl050_write,
 142     .endianness = DEVICE_NATIVE_ENDIAN,
 143 };
 144
 145 static void pl050_realize(DeviceState *dev, Error **errp)
 146 {
 147     PL050State *s = PL050(dev);
 148     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
 149
 150     memory_region_init_io(&s->iomem, OBJECT(s), &pl050_ops, s, "pl050", 0x1000);
 151     sysbus_init_mmio(sbd, &s->iomem);
 152     sysbus_init_irq(sbd, &s->irq);
 153     if (s->is_mouse) {
 154         s->dev = ps2_mouse_init(pl050_update, s);
 155     } else {
 156         s->dev = ps2_kbd_init(pl050_update, s);
 157     }
 158 }
 159
 160 static void pl050_keyboard_init(Object *obj)
 161 {
 162     PL050State *s = PL050(obj);
 163
 164     s->is_mouse = false;
 165 }
 166
 167 static void pl050_mouse_init(Object *obj)
 168 {
 169     PL050State *s = PL050(obj);
 170
 171     s->is_mouse = true;
 172 }
 173
 174 static const TypeInfo pl050_kbd_info = {
 175     .name          = "pl050_keyboard",
 176     .parent        = TYPE_PL050,
 177     .instance_init = pl050_keyboard_init,
 178 };
 179
 180 static const TypeInfo pl050_mouse_info = {
 181     .name          = "pl050_mouse",
 182     .parent        = TYPE_PL050,
 183     .instance_init = pl050_mouse_init,
 184 };
 185
 186 static void pl050_class_init(ObjectClass *oc, void *data)
 187 {
 188     DeviceClass *dc = DEVICE_CLASS(oc);
 189
 190     dc->realize = pl050_realize;
 191     dc->vmsd = &vmstate_pl050;
 192 }
 193
 194 static const TypeInfo pl050_type_info = {
 195     .name          = TYPE_PL050,
 196     .parent        = TYPE_SYS_BUS_DEVICE,
 197     .instance_size = sizeof(PL050State),
 198     .abstract      = true,
 199     .class_init    = pl050_class_init,
 200 };
 201
 202 static void pl050_register_types(void)
 203 {
 204     type_register_static(&pl050_type_info);
 205     type_register_static(&pl050_kbd_info);
 206     type_register_static(&pl050_mouse_info);
 207 }
 208
 209 type_init(pl050_register_types)