backends/baum.c

   1 /*
   2  * QEMU Baum Braille Device
   3  *
   4  * Copyright (c) 2008, 2010-2011, 2016 Samuel Thibault
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "qemu/osdep.h"
  25 #include "qapi/error.h"
  26 #include "qemu-common.h"
  27 #include "sysemu/char.h"
  28 #include "qemu/timer.h"
  29 #include "hw/usb.h"
  30 #include "ui/console.h"
  31 #include <brlapi.h>
  32 #include <brlapi_constants.h>
  33 #include <brlapi_keycodes.h>
  34
  35 #if 0
  36 #define DPRINTF(fmt, ...) \
  37         printf(fmt, ## __VA_ARGS__)
  38 #else
  39 #define DPRINTF(fmt, ...)
  40 #endif
  41
  42 #define ESC 0x1B
  43
  44 #define BAUM_REQ_DisplayData            0x01
  45 #define BAUM_REQ_GetVersionNumber       0x05
  46 #define BAUM_REQ_GetKeys                0x08
  47 #define BAUM_REQ_SetMode                0x12
  48 #define BAUM_REQ_SetProtocol            0x15
  49 #define BAUM_REQ_GetDeviceIdentity      0x84
  50 #define BAUM_REQ_GetSerialNumber        0x8A
  51
  52 #define BAUM_RSP_CellCount              0x01
  53 #define BAUM_RSP_VersionNumber          0x05
  54 #define BAUM_RSP_ModeSetting            0x11
  55 #define BAUM_RSP_CommunicationChannel   0x16
  56 #define BAUM_RSP_PowerdownSignal        0x17
  57 #define BAUM_RSP_HorizontalSensors      0x20
  58 #define BAUM_RSP_VerticalSensors        0x21
  59 #define BAUM_RSP_RoutingKeys            0x22
  60 #define BAUM_RSP_Switches               0x23
  61 #define BAUM_RSP_TopKeys                0x24
  62 #define BAUM_RSP_HorizontalSensor       0x25
  63 #define BAUM_RSP_VerticalSensor         0x26
  64 #define BAUM_RSP_RoutingKey             0x27
  65 #define BAUM_RSP_FrontKeys6             0x28
  66 #define BAUM_RSP_BackKeys6              0x29
  67 #define BAUM_RSP_CommandKeys            0x2B
  68 #define BAUM_RSP_FrontKeys10            0x2C
  69 #define BAUM_RSP_BackKeys10             0x2D
  70 #define BAUM_RSP_EntryKeys              0x33
  71 #define BAUM_RSP_JoyStick               0x34
  72 #define BAUM_RSP_ErrorCode              0x40
  73 #define BAUM_RSP_InfoBlock              0x42
  74 #define BAUM_RSP_DeviceIdentity         0x84
  75 #define BAUM_RSP_SerialNumber           0x8A
  76 #define BAUM_RSP_BluetoothName          0x8C
  77
  78 #define BAUM_TL1 0x01
  79 #define BAUM_TL2 0x02
  80 #define BAUM_TL3 0x04
  81 #define BAUM_TR1 0x08
  82 #define BAUM_TR2 0x10
  83 #define BAUM_TR3 0x20
  84
  85 #define BUF_SIZE 256
  86
  87 typedef struct {
  88     CharDriverState *chr;
  89
  90     brlapi_handle_t *brlapi;
  91     int brlapi_fd;
  92     unsigned int x, y;
  93     bool deferred_init;
  94
  95     uint8_t in_buf[BUF_SIZE];
  96     uint8_t in_buf_used;
  97     uint8_t out_buf[BUF_SIZE];
  98     uint8_t out_buf_used, out_buf_ptr;
  99
 100     QEMUTimer *cellCount_timer;
 101 } BaumDriverState;
 102
 103 /* Let's assume NABCC by default */
 104 enum way {
 105     DOTS2ASCII,
 106     ASCII2DOTS
 107 };
 108 static const uint8_t nabcc_translation[2][256] = {
 109 #ifndef BRLAPI_DOTS
 110 #define BRLAPI_DOTS(d1,d2,d3,d4,d5,d6,d7,d8) \
 111     ((d1?BRLAPI_DOT1:0)|\
 112      (d2?BRLAPI_DOT2:0)|\
 113      (d3?BRLAPI_DOT3:0)|\
 114      (d4?BRLAPI_DOT4:0)|\
 115      (d5?BRLAPI_DOT5:0)|\
 116      (d6?BRLAPI_DOT6:0)|\
 117      (d7?BRLAPI_DOT7:0)|\
 118      (d8?BRLAPI_DOT8:0))
 119 #endif
 120 #define DO(dots, ascii) \
 121     [DOTS2ASCII][dots] = ascii, \
 122     [ASCII2DOTS][ascii] = dots
 123     DO(0, ' '),
 124     DO(BRLAPI_DOTS(1, 0, 0, 0, 0, 0, 0, 0), 'a'),
 125     DO(BRLAPI_DOTS(1, 1, 0, 0, 0, 0, 0, 0), 'b'),
 126     DO(BRLAPI_DOTS(1, 0, 0, 1, 0, 0, 0, 0), 'c'),
 127     DO(BRLAPI_DOTS(1, 0, 0, 1, 1, 0, 0, 0), 'd'),
 128     DO(BRLAPI_DOTS(1, 0, 0, 0, 1, 0, 0, 0), 'e'),
 129     DO(BRLAPI_DOTS(1, 1, 0, 1, 0, 0, 0, 0), 'f'),
 130     DO(BRLAPI_DOTS(1, 1, 0, 1, 1, 0, 0, 0), 'g'),
 131     DO(BRLAPI_DOTS(1, 1, 0, 0, 1, 0, 0, 0), 'h'),
 132     DO(BRLAPI_DOTS(0, 1, 0, 1, 0, 0, 0, 0), 'i'),
 133     DO(BRLAPI_DOTS(0, 1, 0, 1, 1, 0, 0, 0), 'j'),
 134     DO(BRLAPI_DOTS(1, 0, 1, 0, 0, 0, 0, 0), 'k'),
 135     DO(BRLAPI_DOTS(1, 1, 1, 0, 0, 0, 0, 0), 'l'),
 136     DO(BRLAPI_DOTS(1, 0, 1, 1, 0, 0, 0, 0), 'm'),
 137     DO(BRLAPI_DOTS(1, 0, 1, 1, 1, 0, 0, 0), 'n'),
 138     DO(BRLAPI_DOTS(1, 0, 1, 0, 1, 0, 0, 0), 'o'),
 139     DO(BRLAPI_DOTS(1, 1, 1, 1, 0, 0, 0, 0), 'p'),
 140     DO(BRLAPI_DOTS(1, 1, 1, 1, 1, 0, 0, 0), 'q'),
 141     DO(BRLAPI_DOTS(1, 1, 1, 0, 1, 0, 0, 0), 'r'),
 142     DO(BRLAPI_DOTS(0, 1, 1, 1, 0, 0, 0, 0), 's'),
 143     DO(BRLAPI_DOTS(0, 1, 1, 1, 1, 0, 0, 0), 't'),
 144     DO(BRLAPI_DOTS(1, 0, 1, 0, 0, 1, 0, 0), 'u'),
 145     DO(BRLAPI_DOTS(1, 1, 1, 0, 0, 1, 0, 0), 'v'),
 146     DO(BRLAPI_DOTS(0, 1, 0, 1, 1, 1, 0, 0), 'w'),
 147     DO(BRLAPI_DOTS(1, 0, 1, 1, 0, 1, 0, 0), 'x'),
 148     DO(BRLAPI_DOTS(1, 0, 1, 1, 1, 1, 0, 0), 'y'),
 149     DO(BRLAPI_DOTS(1, 0, 1, 0, 1, 1, 0, 0), 'z'),
 150
 151     DO(BRLAPI_DOTS(1, 0, 0, 0, 0, 0, 1, 0), 'A'),
 152     DO(BRLAPI_DOTS(1, 1, 0, 0, 0, 0, 1, 0), 'B'),
 153     DO(BRLAPI_DOTS(1, 0, 0, 1, 0, 0, 1, 0), 'C'),
 154     DO(BRLAPI_DOTS(1, 0, 0, 1, 1, 0, 1, 0), 'D'),
 155     DO(BRLAPI_DOTS(1, 0, 0, 0, 1, 0, 1, 0), 'E'),
 156     DO(BRLAPI_DOTS(1, 1, 0, 1, 0, 0, 1, 0), 'F'),
 157     DO(BRLAPI_DOTS(1, 1, 0, 1, 1, 0, 1, 0), 'G'),
 158     DO(BRLAPI_DOTS(1, 1, 0, 0, 1, 0, 1, 0), 'H'),
 159     DO(BRLAPI_DOTS(0, 1, 0, 1, 0, 0, 1, 0), 'I'),
 160     DO(BRLAPI_DOTS(0, 1, 0, 1, 1, 0, 1, 0), 'J'),
 161     DO(BRLAPI_DOTS(1, 0, 1, 0, 0, 0, 1, 0), 'K'),
 162     DO(BRLAPI_DOTS(1, 1, 1, 0, 0, 0, 1, 0), 'L'),
 163     DO(BRLAPI_DOTS(1, 0, 1, 1, 0, 0, 1, 0), 'M'),
 164     DO(BRLAPI_DOTS(1, 0, 1, 1, 1, 0, 1, 0), 'N'),
 165     DO(BRLAPI_DOTS(1, 0, 1, 0, 1, 0, 1, 0), 'O'),
 166     DO(BRLAPI_DOTS(1, 1, 1, 1, 0, 0, 1, 0), 'P'),
 167     DO(BRLAPI_DOTS(1, 1, 1, 1, 1, 0, 1, 0), 'Q'),
 168     DO(BRLAPI_DOTS(1, 1, 1, 0, 1, 0, 1, 0), 'R'),
 169     DO(BRLAPI_DOTS(0, 1, 1, 1, 0, 0, 1, 0), 'S'),
 170     DO(BRLAPI_DOTS(0, 1, 1, 1, 1, 0, 1, 0), 'T'),
 171     DO(BRLAPI_DOTS(1, 0, 1, 0, 0, 1, 1, 0), 'U'),
 172     DO(BRLAPI_DOTS(1, 1, 1, 0, 0, 1, 1, 0), 'V'),
 173     DO(BRLAPI_DOTS(0, 1, 0, 1, 1, 1, 1, 0), 'W'),
 174     DO(BRLAPI_DOTS(1, 0, 1, 1, 0, 1, 1, 0), 'X'),
 175     DO(BRLAPI_DOTS(1, 0, 1, 1, 1, 1, 1, 0), 'Y'),
 176     DO(BRLAPI_DOTS(1, 0, 1, 0, 1, 1, 1, 0), 'Z'),
 177
 178     DO(BRLAPI_DOTS(0, 0, 1, 0, 1, 1, 0, 0), '0'),
 179     DO(BRLAPI_DOTS(0, 1, 0, 0, 0, 0, 0, 0), '1'),
 180     DO(BRLAPI_DOTS(0, 1, 1, 0, 0, 0, 0, 0), '2'),
 181     DO(BRLAPI_DOTS(0, 1, 0, 0, 1, 0, 0, 0), '3'),
 182     DO(BRLAPI_DOTS(0, 1, 0, 0, 1, 1, 0, 0), '4'),
 183     DO(BRLAPI_DOTS(0, 1, 0, 0, 0, 1, 0, 0), '5'),
 184     DO(BRLAPI_DOTS(0, 1, 1, 0, 1, 0, 0, 0), '6'),
 185     DO(BRLAPI_DOTS(0, 1, 1, 0, 1, 1, 0, 0), '7'),
 186     DO(BRLAPI_DOTS(0, 1, 1, 0, 0, 1, 0, 0), '8'),
 187     DO(BRLAPI_DOTS(0, 0, 1, 0, 1, 0, 0, 0), '9'),
 188
 189     DO(BRLAPI_DOTS(0, 0, 0, 1, 0, 1, 0, 0), '.'),
 190     DO(BRLAPI_DOTS(0, 0, 1, 1, 0, 1, 0, 0), '+'),
 191     DO(BRLAPI_DOTS(0, 0, 1, 0, 0, 1, 0, 0), '-'),
 192     DO(BRLAPI_DOTS(1, 0, 0, 0, 0, 1, 0, 0), '*'),
 193     DO(BRLAPI_DOTS(0, 0, 1, 1, 0, 0, 0, 0), '/'),
 194     DO(BRLAPI_DOTS(1, 1, 1, 0, 1, 1, 0, 0), '('),
 195     DO(BRLAPI_DOTS(0, 1, 1, 1, 1, 1, 0, 0), ')'),
 196
 197     DO(BRLAPI_DOTS(1, 1, 1, 1, 0, 1, 0, 0), '&'),
 198     DO(BRLAPI_DOTS(0, 0, 1, 1, 1, 1, 0, 0), '#'),
 199
 200     DO(BRLAPI_DOTS(0, 0, 0, 0, 0, 1, 0, 0), ','),
 201     DO(BRLAPI_DOTS(0, 0, 0, 0, 1, 1, 0, 0), ';'),
 202     DO(BRLAPI_DOTS(1, 0, 0, 0, 1, 1, 0, 0), ':'),
 203     DO(BRLAPI_DOTS(0, 1, 1, 1, 0, 1, 0, 0), '!'),
 204     DO(BRLAPI_DOTS(1, 0, 0, 1, 1, 1, 0, 0), '?'),
 205     DO(BRLAPI_DOTS(0, 0, 0, 0, 1, 0, 0, 0), '"'),
 206     DO(BRLAPI_DOTS(0, 0, 1, 0, 0, 0, 0, 0), '\''),
 207     DO(BRLAPI_DOTS(0, 0, 0, 1, 0, 0, 0, 0), '`'),
 208     DO(BRLAPI_DOTS(0, 0, 0, 1, 1, 0, 1, 0), '^'),
 209     DO(BRLAPI_DOTS(0, 0, 0, 1, 1, 0, 0, 0), '~'),
 210     DO(BRLAPI_DOTS(0, 1, 0, 1, 0, 1, 1, 0), '['),
 211     DO(BRLAPI_DOTS(1, 1, 0, 1, 1, 1, 1, 0), ']'),
 212     DO(BRLAPI_DOTS(0, 1, 0, 1, 0, 1, 0, 0), '{'),
 213     DO(BRLAPI_DOTS(1, 1, 0, 1, 1, 1, 0, 0), '}'),
 214     DO(BRLAPI_DOTS(1, 1, 1, 1, 1, 1, 0, 0), '='),
 215     DO(BRLAPI_DOTS(1, 1, 0, 0, 0, 1, 0, 0), '<'),
 216     DO(BRLAPI_DOTS(0, 0, 1, 1, 1, 0, 0, 0), '>'),
 217     DO(BRLAPI_DOTS(1, 1, 0, 1, 0, 1, 0, 0), '$'),
 218     DO(BRLAPI_DOTS(1, 0, 0, 1, 0, 1, 0, 0), '%'),
 219     DO(BRLAPI_DOTS(0, 0, 0, 1, 0, 0, 1, 0), '@'),
 220     DO(BRLAPI_DOTS(1, 1, 0, 0, 1, 1, 0, 0), '|'),
 221     DO(BRLAPI_DOTS(1, 1, 0, 0, 1, 1, 1, 0), '\\'),
 222     DO(BRLAPI_DOTS(0, 0, 0, 1, 1, 1, 0, 0), '_'),
 223 };
 224
 225 /* The guest OS has started discussing with us, finish initializing BrlAPI */
 226 static int baum_deferred_init(BaumDriverState *baum)
 227 {
 228     int tty = BRLAPI_TTY_DEFAULT;
 229     QemuConsole *con;
 230
 231     if (baum->deferred_init) {
 232         return 1;
 233     }
 234
 235     if (brlapi__getDisplaySize(baum->brlapi, &baum->x, &baum->y) == -1) {
 236         brlapi_perror("baum: brlapi__getDisplaySize");
 237         return 0;
 238     }
 239
 240     con = qemu_console_lookup_by_index(0);
 241     if (con && qemu_console_is_graphic(con)) {
 242         tty = qemu_console_get_window_id(con);
 243         if (tty == -1)
 244             tty = BRLAPI_TTY_DEFAULT;
 245     }
 246
 247     if (brlapi__enterTtyMode(baum->brlapi, tty, NULL) == -1) {
 248         brlapi_perror("baum: brlapi__enterTtyMode");
 249         return 0;
 250     }
 251     baum->deferred_init = 1;
 252     return 1;
 253 }
 254
 255 /* The serial port can receive more of our data */
 256 static void baum_accept_input(struct CharDriverState *chr)
 257 {
 258     BaumDriverState *baum = chr->opaque;
 259     int room, first;
 260
 261     if (!baum->out_buf_used)
 262         return;
 263     room = qemu_chr_be_can_write(chr);
 264     if (!room)
 265         return;
 266     if (room > baum->out_buf_used)
 267         room = baum->out_buf_used;
 268
 269     first = BUF_SIZE - baum->out_buf_ptr;
 270     if (room > first) {
 271         qemu_chr_be_write(chr, baum->out_buf + baum->out_buf_ptr, first);
 272         baum->out_buf_ptr = 0;
 273         baum->out_buf_used -= first;
 274         room -= first;
 275     }
 276     qemu_chr_be_write(chr, baum->out_buf + baum->out_buf_ptr, room);
 277     baum->out_buf_ptr += room;
 278     baum->out_buf_used -= room;
 279 }
 280
 281 /* We want to send a packet */
 282 static void baum_write_packet(BaumDriverState *baum, const uint8_t *buf, int len)
 283 {
 284     uint8_t io_buf[1 + 2 * len], *cur = io_buf;
 285     int room;
 286     *cur++ = ESC;
 287     while (len--)
 288         if ((*cur++ = *buf++) == ESC)
 289             *cur++ = ESC;
 290     room = qemu_chr_be_can_write(baum->chr);
 291     len = cur - io_buf;
 292     if (len <= room) {
 293         /* Fits */
 294         qemu_chr_be_write(baum->chr, io_buf, len);
 295     } else {
 296         int first;
 297         uint8_t out;
 298         /* Can't fit all, send what can be, and store the rest. */
 299         qemu_chr_be_write(baum->chr, io_buf, room);
 300         len -= room;
 301         cur = io_buf + room;
 302         if (len > BUF_SIZE - baum->out_buf_used) {
 303             /* Can't even store it, drop the previous data... */
 304             assert(len <= BUF_SIZE);
 305             baum->out_buf_used = 0;
 306             baum->out_buf_ptr = 0;
 307         }
 308         out = baum->out_buf_ptr;
 309         baum->out_buf_used += len;
 310         first = BUF_SIZE - baum->out_buf_ptr;
 311         if (len > first) {
 312             memcpy(baum->out_buf + out, cur, first);
 313             out = 0;
 314             len -= first;
 315             cur += first;
 316         }
 317         memcpy(baum->out_buf + out, cur, len);
 318     }
 319 }
 320
 321 /* Called when the other end seems to have a wrong idea of our display size */
 322 static void baum_cellCount_timer_cb(void *opaque)
 323 {
 324     BaumDriverState *baum = opaque;
 325     uint8_t cell_count[] = { BAUM_RSP_CellCount, baum->x * baum->y };
 326     DPRINTF("Timeout waiting for DisplayData, sending cell count\n");
 327     baum_write_packet(baum, cell_count, sizeof(cell_count));
 328 }
 329
 330 /* Try to interpret a whole incoming packet */
 331 static int baum_eat_packet(BaumDriverState *baum, const uint8_t *buf, int len)
 332 {
 333     const uint8_t *cur = buf;
 334     uint8_t req = 0;
 335
 336     if (!len--)
 337         return 0;
 338     if (*cur++ != ESC) {
 339         while (*cur != ESC) {
 340             if (!len--)
 341                 return 0;
 342             cur++;
 343         }
 344         DPRINTF("Dropped %td bytes!\n", cur - buf);
 345     }
 346
 347 #define EAT(c) do {\
 348     if (!len--) \
 349         return 0; \
 350     if ((c = *cur++) == ESC) { \
 351         if (!len--) \
 352             return 0; \
 353         if (*cur++ != ESC) { \
 354             DPRINTF("Broken packet %#2x, tossing\n", req); \
 355             if (timer_pending(baum->cellCount_timer)) {    \
 356                 timer_del(baum->cellCount_timer);     \
 357                 baum_cellCount_timer_cb(baum);             \
 358             } \
 359             return (cur - 2 - buf); \
 360         } \
 361     } \
 362 } while (0)
 363
 364     EAT(req);
 365     switch (req) {
 366     case BAUM_REQ_DisplayData:
 367     {
 368         uint8_t cells[baum->x * baum->y], c;
 369         uint8_t text[baum->x * baum->y];
 370         uint8_t zero[baum->x * baum->y];
 371         int cursor = BRLAPI_CURSOR_OFF;
 372         int i;
 373
 374         /* Allow 100ms to complete the DisplayData packet */
 375         timer_mod(baum->cellCount_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
 376                        NANOSECONDS_PER_SECOND / 10);
 377         for (i = 0; i < baum->x * baum->y ; i++) {
 378             EAT(c);
 379             cells[i] = c;
 380             if ((c & (BRLAPI_DOT7|BRLAPI_DOT8))
 381                     == (BRLAPI_DOT7|BRLAPI_DOT8)) {
 382                 cursor = i + 1;
 383                 c &= ~(BRLAPI_DOT7|BRLAPI_DOT8);
 384             }
 385             c = nabcc_translation[DOTS2ASCII][c];
 386             if (!c) {
 387                 c = '?';
 388             }
 389             text[i] = c;
 390         }
 391         timer_del(baum->cellCount_timer);
 392
 393         memset(zero, 0, sizeof(zero));
 394
 395         brlapi_writeArguments_t wa = {
 396             .displayNumber = BRLAPI_DISPLAY_DEFAULT,
 397             .regionBegin = 1,
 398             .regionSize = baum->x * baum->y,
 399             .text = (char *)text,
 400             .textSize = baum->x * baum->y,
 401             .andMask = zero,
 402             .orMask = cells,
 403             .cursor = cursor,
 404             .charset = (char *)"ISO-8859-1",
 405         };
 406
 407         if (brlapi__write(baum->brlapi, &wa) == -1)
 408             brlapi_perror("baum brlapi_write");
 409         break;
 410     }
 411     case BAUM_REQ_SetMode:
 412     {
 413         uint8_t mode, setting;
 414         DPRINTF("SetMode\n");
 415         EAT(mode);
 416         EAT(setting);
 417         /* ignore */
 418         break;
 419     }
 420     case BAUM_REQ_SetProtocol:
 421     {
 422         uint8_t protocol;
 423         DPRINTF("SetProtocol\n");
 424         EAT(protocol);
 425         /* ignore */
 426         break;
 427     }
 428     case BAUM_REQ_GetDeviceIdentity:
 429     {
 430         uint8_t identity[17] = { BAUM_RSP_DeviceIdentity,
 431             'B','a','u','m',' ','V','a','r','i','o' };
 432         DPRINTF("GetDeviceIdentity\n");
 433         identity[11] = '0' + baum->x / 10;
 434         identity[12] = '0' + baum->x % 10;
 435         baum_write_packet(baum, identity, sizeof(identity));
 436         break;
 437     }
 438     case BAUM_REQ_GetVersionNumber:
 439     {
 440         uint8_t version[] = { BAUM_RSP_VersionNumber, 1 }; /* ? */
 441         DPRINTF("GetVersionNumber\n");
 442         baum_write_packet(baum, version, sizeof(version));
 443         break;
 444     }
 445     case BAUM_REQ_GetSerialNumber:
 446     {
 447         uint8_t serial[] = { BAUM_RSP_SerialNumber,
 448             '0','0','0','0','0','0','0','0' };
 449         DPRINTF("GetSerialNumber\n");
 450         baum_write_packet(baum, serial, sizeof(serial));
 451         break;
 452     }
 453     case BAUM_REQ_GetKeys:
 454     {
 455         DPRINTF("Get%0#2x\n", req);
 456         /* ignore */
 457         break;
 458     }
 459     default:
 460         DPRINTF("unrecognized request %0#2x\n", req);
 461         do
 462             if (!len--)
 463                 return 0;
 464         while (*cur++ != ESC);
 465         cur--;
 466         break;
 467     }
 468     return cur - buf;
 469 }
 470
 471 /* The other end is writing some data.  Store it and try to interpret */
 472 static int baum_write(CharDriverState *chr, const uint8_t *buf, int len)
 473 {
 474     BaumDriverState *baum = chr->opaque;
 475     int tocopy, cur, eaten, orig_len = len;
 476
 477     if (!len)
 478         return 0;
 479     if (!baum->brlapi)
 480         return len;
 481     if (!baum_deferred_init(baum))
 482         return len;
 483
 484     while (len) {
 485         /* Complete our buffer as much as possible */
 486         tocopy = len;
 487         if (tocopy > BUF_SIZE - baum->in_buf_used)
 488             tocopy = BUF_SIZE - baum->in_buf_used;
 489
 490         memcpy(baum->in_buf + baum->in_buf_used, buf, tocopy);
 491         baum->in_buf_used += tocopy;
 492         buf += tocopy;
 493         len -= tocopy;
 494
 495         /* Interpret it as much as possible */
 496         cur = 0;
 497         while (cur < baum->in_buf_used &&
 498                 (eaten = baum_eat_packet(baum, baum->in_buf + cur, baum->in_buf_used - cur)))
 499             cur += eaten;
 500
 501         /* Shift the remainder */
 502         if (cur) {
 503             memmove(baum->in_buf, baum->in_buf + cur, baum->in_buf_used - cur);
 504             baum->in_buf_used -= cur;
 505         }
 506
 507         /* And continue if any data left */
 508     }
 509     return orig_len;
 510 }
 511
 512 /* Send the key code to the other end */
 513 static void baum_send_key(BaumDriverState *baum, uint8_t type, uint8_t value) {
 514     uint8_t packet[] = { type, value };
 515     DPRINTF("writing key %x %x\n", type, value);
 516     baum_write_packet(baum, packet, sizeof(packet));
 517 }
 518
 519 static void baum_send_key2(BaumDriverState *baum, uint8_t type, uint8_t value,
 520                            uint8_t value2) {
 521     uint8_t packet[] = { type, value, value2 };
 522     DPRINTF("writing key %x %x\n", type, value);
 523     baum_write_packet(baum, packet, sizeof(packet));
 524 }
 525
 526 /* We got some data on the BrlAPI socket */
 527 static void baum_chr_read(void *opaque)
 528 {
 529     BaumDriverState *baum = opaque;
 530     brlapi_keyCode_t code;
 531     int ret;
 532     if (!baum->brlapi)
 533         return;
 534     if (!baum_deferred_init(baum))
 535         return;
 536     while ((ret = brlapi__readKey(baum->brlapi, 0, &code)) == 1) {
 537         DPRINTF("got key %"BRLAPI_PRIxKEYCODE"\n", code);
 538         /* Emulate */
 539         switch (code & BRLAPI_KEY_TYPE_MASK) {
 540         case BRLAPI_KEY_TYPE_CMD:
 541             switch (code & BRLAPI_KEY_CMD_BLK_MASK) {
 542             case BRLAPI_KEY_CMD_ROUTE:
 543                 baum_send_key(baum, BAUM_RSP_RoutingKey, (code & BRLAPI_KEY_CMD_ARG_MASK)+1);
 544                 baum_send_key(baum, BAUM_RSP_RoutingKey, 0);
 545                 break;
 546             case 0:
 547                 switch (code & BRLAPI_KEY_CMD_ARG_MASK) {
 548                 case BRLAPI_KEY_CMD_FWINLT:
 549                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL2);
 550                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 551                     break;
 552                 case BRLAPI_KEY_CMD_FWINRT:
 553                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TR2);
 554                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 555                     break;
 556                 case BRLAPI_KEY_CMD_LNUP:
 557                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TR1);
 558                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 559                     break;
 560                 case BRLAPI_KEY_CMD_LNDN:
 561                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TR3);
 562                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 563                     break;
 564                 case BRLAPI_KEY_CMD_TOP:
 565                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL1|BAUM_TR1);
 566                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 567                     break;
 568                 case BRLAPI_KEY_CMD_BOT:
 569                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL3|BAUM_TR3);
 570                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 571                     break;
 572                 case BRLAPI_KEY_CMD_TOP_LEFT:
 573                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL2|BAUM_TR1);
 574                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 575                     break;
 576                 case BRLAPI_KEY_CMD_BOT_LEFT:
 577                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL2|BAUM_TR3);
 578                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 579                     break;
 580                 case BRLAPI_KEY_CMD_HOME:
 581                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL2|BAUM_TR1|BAUM_TR3);
 582                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 583                     break;
 584                 case BRLAPI_KEY_CMD_PREFMENU:
 585                     baum_send_key(baum, BAUM_RSP_TopKeys, BAUM_TL1|BAUM_TL3|BAUM_TR1);
 586                     baum_send_key(baum, BAUM_RSP_TopKeys, 0);
 587                     break;
 588                 }
 589             }
 590             break;
 591         case BRLAPI_KEY_TYPE_SYM:
 592             {
 593                 brlapi_keyCode_t keysym = code & BRLAPI_KEY_CODE_MASK;
 594                 if (keysym < 0x100) {
 595                     uint8_t dots = nabcc_translation[ASCII2DOTS][keysym];
 596                     if (dots) {
 597                         baum_send_key2(baum, BAUM_RSP_EntryKeys, 0, dots);
 598                         baum_send_key2(baum, BAUM_RSP_EntryKeys, 0, 0);
 599                     }
 600                 }
 601                 break;
 602             }
 603         }
 604     }
 605     if (ret == -1 && (brlapi_errno != BRLAPI_ERROR_LIBCERR || errno != EINTR)) {
 606         brlapi_perror("baum: brlapi_readKey");
 607         brlapi__closeConnection(baum->brlapi);
 608         g_free(baum->brlapi);
 609         baum->brlapi = NULL;
 610     }
 611 }
 612
 613 static void baum_free(struct CharDriverState *chr)
 614 {
 615     BaumDriverState *baum = chr->opaque;
 616
 617     timer_free(baum->cellCount_timer);
 618     if (baum->brlapi) {
 619         brlapi__closeConnection(baum->brlapi);
 620         g_free(baum->brlapi);
 621     }
 622     g_free(baum);
 623 }
 624
 625 static CharDriverState *chr_baum_init(const char *id,
 626                                       ChardevBackend *backend,
 627                                       ChardevReturn *ret,
 628                                       bool *be_opened,
 629                                       Error **errp)
 630 {
 631     ChardevCommon *common = backend->u.braille.data;
 632     BaumDriverState *baum;
 633     CharDriverState *chr;
 634     brlapi_handle_t *handle;
 635
 636     chr = qemu_chr_alloc(common, errp);
 637     if (!chr) {
 638         return NULL;
 639     }
 640     baum = g_malloc0(sizeof(BaumDriverState));
 641     baum->chr = chr;
 642
 643     chr->opaque = baum;
 644     chr->chr_write = baum_write;
 645     chr->chr_accept_input = baum_accept_input;
 646     chr->chr_free = baum_free;
 647
 648     handle = g_malloc0(brlapi_getHandleSize());
 649     baum->brlapi = handle;
 650
 651     baum->brlapi_fd = brlapi__openConnection(handle, NULL, NULL);
 652     if (baum->brlapi_fd == -1) {
 653         error_setg(errp, "brlapi__openConnection: %s",
 654                    brlapi_strerror(brlapi_error_location()));
 655         goto fail_handle;
 656     }
 657     baum->deferred_init = 0;
 658
 659     baum->cellCount_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, baum_cellCount_timer_cb, baum);
 660
 661     qemu_set_fd_handler(baum->brlapi_fd, baum_chr_read, NULL, baum);
 662
 663     return chr;
 664
 665 fail_handle:
 666     g_free(handle);
 667     g_free(chr);
 668     g_free(baum);
 669     return NULL;
 670 }
 671
 672 static void register_types(void)
 673 {
 674     register_char_driver("braille", CHARDEV_BACKEND_KIND_BRAILLE, NULL,
 675                          chr_baum_init);
 676 }
 677
 678 type_init(register_types);