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