hw/display/ssd0303.c

   1 /*
   2  * SSD0303 OLED controller with OSRAM Pictiva 96x16 display.
   3  *
   4  * Copyright (c) 2006-2007 CodeSourcery.
   5  * Written by Paul Brook
   6  *
   7  * This code is licensed under the GPL.
   8  */
   9
  10 /* The controller can support a variety of different displays, but we only
  11    implement one.  Most of the commends relating to brightness and geometry
  12    setup are ignored. */
  13 #include "qemu/osdep.h"
  14 #include "hw/i2c/i2c.h"
  15 #include "ui/console.h"
  16
  17 //#define DEBUG_SSD0303 1
  18
  19 #ifdef DEBUG_SSD0303
  20 #define DPRINTF(fmt, ...) \
  21 do { printf("ssd0303: " fmt , ## __VA_ARGS__); } while (0)
  22 #define BADF(fmt, ...) \
  23 do { fprintf(stderr, "ssd0303: error: " fmt , ## __VA_ARGS__); exit(1);} while (0)
  24 #else
  25 #define DPRINTF(fmt, ...) do {} while(0)
  26 #define BADF(fmt, ...) \
  27 do { fprintf(stderr, "ssd0303: error: " fmt , ## __VA_ARGS__);} while (0)
  28 #endif
  29
  30 /* Scaling factor for pixels.  */
  31 #define MAGNIFY 4
  32
  33 enum ssd0303_mode
  34 {
  35     SSD0303_IDLE,
  36     SSD0303_DATA,
  37     SSD0303_CMD
  38 };
  39
  40 enum ssd0303_cmd {
  41     SSD0303_CMD_NONE,
  42     SSD0303_CMD_SKIP1
  43 };
  44
  45 #define TYPE_SSD0303 "ssd0303"
  46 #define SSD0303(obj) OBJECT_CHECK(ssd0303_state, (obj), TYPE_SSD0303)
  47
  48 typedef struct {
  49     I2CSlave parent_obj;
  50
  51     QemuConsole *con;
  52     int row;
  53     int col;
  54     int start_line;
  55     int mirror;
  56     int flash;
  57     int enabled;
  58     int inverse;
  59     int redraw;
  60     enum ssd0303_mode mode;
  61     enum ssd0303_cmd cmd_state;
  62     uint8_t framebuffer[132*8];
  63 } ssd0303_state;
  64
  65 static uint8_t ssd0303_recv(I2CSlave *i2c)
  66 {
  67     BADF("Reads not implemented\n");
  68     return 0xff;
  69 }
  70
  71 static int ssd0303_send(I2CSlave *i2c, uint8_t data)
  72 {
  73     ssd0303_state *s = SSD0303(i2c);
  74     enum ssd0303_cmd old_cmd_state;
  75
  76     switch (s->mode) {
  77     case SSD0303_IDLE:
  78         DPRINTF("byte 0x%02x\n", data);
  79         if (data == 0x80)
  80             s->mode = SSD0303_CMD;
  81         else if (data == 0x40)
  82             s->mode = SSD0303_DATA;
  83         else
  84             BADF("Unexpected byte 0x%x\n", data);
  85         break;
  86     case SSD0303_DATA:
  87         DPRINTF("data 0x%02x\n", data);
  88         if (s->col < 132) {
  89             s->framebuffer[s->col + s->row * 132] = data;
  90             s->col++;
  91             s->redraw = 1;
  92         }
  93         break;
  94     case SSD0303_CMD:
  95         old_cmd_state = s->cmd_state;
  96         s->cmd_state = SSD0303_CMD_NONE;
  97         switch (old_cmd_state) {
  98         case SSD0303_CMD_NONE:
  99             DPRINTF("cmd 0x%02x\n", data);
 100             s->mode = SSD0303_IDLE;
 101             switch (data) {
 102             case 0x00 ... 0x0f: /* Set lower column address.  */
 103                 s->col = (s->col & 0xf0) | (data & 0xf);
 104                 break;
 105             case 0x10 ... 0x20: /* Set higher column address.  */
 106                 s->col = (s->col & 0x0f) | ((data & 0xf) << 4);
 107                 break;
 108             case 0x40 ... 0x7f: /* Set start line.  */
 109                 s->start_line = 0;
 110                 break;
 111             case 0x81: /* Set contrast (Ignored).  */
 112                 s->cmd_state = SSD0303_CMD_SKIP1;
 113                 break;
 114             case 0xa0: /* Mirror off.  */
 115                 s->mirror = 0;
 116                 break;
 117             case 0xa1: /* Mirror off.  */
 118                 s->mirror = 1;
 119                 break;
 120             case 0xa4: /* Entire display off.  */
 121                 s->flash = 0;
 122                 break;
 123             case 0xa5: /* Entire display on.  */
 124                 s->flash = 1;
 125                 break;
 126             case 0xa6: /* Inverse off.  */
 127                 s->inverse = 0;
 128                 break;
 129             case 0xa7: /* Inverse on.  */
 130                 s->inverse = 1;
 131                 break;
 132             case 0xa8: /* Set multiplied ratio (Ignored).  */
 133                 s->cmd_state = SSD0303_CMD_SKIP1;
 134                 break;
 135             case 0xad: /* DC-DC power control.  */
 136                 s->cmd_state = SSD0303_CMD_SKIP1;
 137                 break;
 138             case 0xae: /* Display off.  */
 139                 s->enabled = 0;
 140                 break;
 141             case 0xaf: /* Display on.  */
 142                 s->enabled = 1;
 143                 break;
 144             case 0xb0 ... 0xbf: /* Set Page address.  */
 145                 s->row = data & 7;
 146                 break;
 147             case 0xc0 ... 0xc8: /* Set COM output direction (Ignored).  */
 148                 break;
 149             case 0xd3: /* Set display offset (Ignored).  */
 150                 s->cmd_state = SSD0303_CMD_SKIP1;
 151                 break;
 152             case 0xd5: /* Set display clock (Ignored).  */
 153                 s->cmd_state = SSD0303_CMD_SKIP1;
 154                 break;
 155             case 0xd8: /* Set color and power mode (Ignored).  */
 156                 s->cmd_state = SSD0303_CMD_SKIP1;
 157                 break;
 158             case 0xd9: /* Set pre-charge period (Ignored).  */
 159                 s->cmd_state = SSD0303_CMD_SKIP1;
 160                 break;
 161             case 0xda: /* Set COM pin configuration (Ignored).  */
 162                 s->cmd_state = SSD0303_CMD_SKIP1;
 163                 break;
 164             case 0xdb: /* Set VCOM dselect level (Ignored).  */
 165                 s->cmd_state = SSD0303_CMD_SKIP1;
 166                 break;
 167             case 0xe3: /* no-op.  */
 168                 break;
 169             default:
 170                 BADF("Unknown command: 0x%x\n", data);
 171             }
 172             break;
 173         case SSD0303_CMD_SKIP1:
 174             DPRINTF("skip 0x%02x\n", data);
 175             break;
 176         }
 177         break;
 178     }
 179     return 0;
 180 }
 181
 182 static int ssd0303_event(I2CSlave *i2c, enum i2c_event event)
 183 {
 184     ssd0303_state *s = SSD0303(i2c);
 185
 186     switch (event) {
 187     case I2C_FINISH:
 188         s->mode = SSD0303_IDLE;
 189         break;
 190     case I2C_START_RECV:
 191     case I2C_START_SEND:
 192     case I2C_NACK:
 193         /* Nothing to do.  */
 194         break;
 195     }
 196
 197     return 0;
 198 }
 199
 200 static void ssd0303_update_display(void *opaque)
 201 {
 202     ssd0303_state *s = (ssd0303_state *)opaque;
 203     DisplaySurface *surface = qemu_console_surface(s->con);
 204     uint8_t *dest;
 205     uint8_t *src;
 206     int x;
 207     int y;
 208     int line;
 209     char *colors[2];
 210     char colortab[MAGNIFY * 8];
 211     int dest_width;
 212     uint8_t mask;
 213
 214     if (!s->redraw)
 215         return;
 216
 217     switch (surface_bits_per_pixel(surface)) {
 218     case 0:
 219         return;
 220     case 15:
 221         dest_width = 2;
 222         break;
 223     case 16:
 224         dest_width = 2;
 225         break;
 226     case 24:
 227         dest_width = 3;
 228         break;
 229     case 32:
 230         dest_width = 4;
 231         break;
 232     default:
 233         BADF("Bad color depth\n");
 234         return;
 235     }
 236     dest_width *= MAGNIFY;
 237     memset(colortab, 0xff, dest_width);
 238     memset(colortab + dest_width, 0, dest_width);
 239     if (s->flash) {
 240         colors[0] = colortab;
 241         colors[1] = colortab;
 242     } else if (s->inverse) {
 243         colors[0] = colortab;
 244         colors[1] = colortab + dest_width;
 245     } else {
 246         colors[0] = colortab + dest_width;
 247         colors[1] = colortab;
 248     }
 249     dest = surface_data(surface);
 250     for (y = 0; y < 16; y++) {
 251         line = (y + s->start_line) & 63;
 252         src = s->framebuffer + 132 * (line >> 3) + 36;
 253         mask = 1 << (line & 7);
 254         for (x = 0; x < 96; x++) {
 255             memcpy(dest, colors[(*src & mask) != 0], dest_width);
 256             dest += dest_width;
 257             src++;
 258         }
 259         for (x = 1; x < MAGNIFY; x++) {
 260             memcpy(dest, dest - dest_width * 96, dest_width * 96);
 261             dest += dest_width * 96;
 262         }
 263     }
 264     s->redraw = 0;
 265     dpy_gfx_update(s->con, 0, 0, 96 * MAGNIFY, 16 * MAGNIFY);
 266 }
 267
 268 static void ssd0303_invalidate_display(void * opaque)
 269 {
 270     ssd0303_state *s = (ssd0303_state *)opaque;
 271     s->redraw = 1;
 272 }
 273
 274 static const VMStateDescription vmstate_ssd0303 = {
 275     .name = "ssd0303_oled",
 276     .version_id = 1,
 277     .minimum_version_id = 1,
 278     .fields = (VMStateField[]) {
 279         VMSTATE_INT32(row, ssd0303_state),
 280         VMSTATE_INT32(col, ssd0303_state),
 281         VMSTATE_INT32(start_line, ssd0303_state),
 282         VMSTATE_INT32(mirror, ssd0303_state),
 283         VMSTATE_INT32(flash, ssd0303_state),
 284         VMSTATE_INT32(enabled, ssd0303_state),
 285         VMSTATE_INT32(inverse, ssd0303_state),
 286         VMSTATE_INT32(redraw, ssd0303_state),
 287         VMSTATE_UINT32(mode, ssd0303_state),
 288         VMSTATE_UINT32(cmd_state, ssd0303_state),
 289         VMSTATE_BUFFER(framebuffer, ssd0303_state),
 290         VMSTATE_I2C_SLAVE(parent_obj, ssd0303_state),
 291         VMSTATE_END_OF_LIST()
 292     }
 293 };
 294
 295 static const GraphicHwOps ssd0303_ops = {
 296     .invalidate  = ssd0303_invalidate_display,
 297     .gfx_update  = ssd0303_update_display,
 298 };
 299
 300 static void ssd0303_realize(DeviceState *dev, Error **errp)
 301 {
 302     ssd0303_state *s = SSD0303(dev);
 303
 304     s->con = graphic_console_init(dev, 0, &ssd0303_ops, s);
 305     qemu_console_resize(s->con, 96 * MAGNIFY, 16 * MAGNIFY);
 306 }
 307
 308 static void ssd0303_class_init(ObjectClass *klass, void *data)
 309 {
 310     DeviceClass *dc = DEVICE_CLASS(klass);
 311     I2CSlaveClass *k = I2C_SLAVE_CLASS(klass);
 312
 313     dc->realize = ssd0303_realize;
 314     k->event = ssd0303_event;
 315     k->recv = ssd0303_recv;
 316     k->send = ssd0303_send;
 317     dc->vmsd = &vmstate_ssd0303;
 318 }
 319
 320 static const TypeInfo ssd0303_info = {
 321     .name          = TYPE_SSD0303,
 322     .parent        = TYPE_I2C_SLAVE,
 323     .instance_size = sizeof(ssd0303_state),
 324     .class_init    = ssd0303_class_init,
 325 };
 326
 327 static void ssd0303_register_types(void)
 328 {
 329     type_register_static(&ssd0303_info);
 330 }
 331
 332 type_init(ssd0303_register_types)