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