include/hw/input/adb.h

   1 /*
   2  * QEMU ADB emulation shared definitions and prototypes
   3  *
   4  * Copyright (c) 2004-2007 Fabrice Bellard
   5  * Copyright (c) 2007 Jocelyn Mayer
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25
  26 #ifndef ADB_H
  27 #define ADB_H
  28
  29 #include "hw/qdev-core.h"
  30 #include "qom/object.h"
  31
  32 #define MAX_ADB_DEVICES 16
  33
  34 #define ADB_MAX_OUT_LEN 16
  35
  36 typedef struct ADBBusState ADBBusState;
  37 typedef struct ADBDevice ADBDevice;
  38
  39 /* buf = NULL means polling */
  40 typedef int ADBDeviceRequest(ADBDevice *d, uint8_t *buf_out,
  41                               const uint8_t *buf, int len);
  42
  43 typedef bool ADBDeviceHasData(ADBDevice *d);
  44
  45 #define TYPE_ADB_DEVICE "adb-device"
  46 typedef struct ADBDeviceClass ADBDeviceClass;
  47 #define ADB_DEVICE(obj) OBJECT_CHECK(ADBDevice, (obj), TYPE_ADB_DEVICE)
  48
  49 struct ADBDevice {
  50     /*< private >*/
  51     DeviceState parent_obj;
  52     /*< public >*/
  53
  54     int devaddr;
  55     int handler;
  56 };
  57
  58 #define ADB_DEVICE_CLASS(cls) \
  59     OBJECT_CLASS_CHECK(ADBDeviceClass, (cls), TYPE_ADB_DEVICE)
  60 #define ADB_DEVICE_GET_CLASS(obj) \
  61     OBJECT_GET_CLASS(ADBDeviceClass, (obj), TYPE_ADB_DEVICE)
  62
  63 struct ADBDeviceClass {
  64     /*< private >*/
  65     DeviceClass parent_class;
  66     /*< public >*/
  67
  68     ADBDeviceRequest *devreq;
  69     ADBDeviceHasData *devhasdata;
  70 };
  71
  72 #define TYPE_ADB_BUS "apple-desktop-bus"
  73 #define ADB_BUS(obj) OBJECT_CHECK(ADBBusState, (obj), TYPE_ADB_BUS)
  74
  75 #define ADB_STATUS_BUSTIMEOUT  0x1
  76 #define ADB_STATUS_POLLREPLY   0x2
  77
  78 struct ADBBusState {
  79     /*< private >*/
  80     BusState parent_obj;
  81     /*< public >*/
  82
  83     ADBDevice *devices[MAX_ADB_DEVICES];
  84     uint16_t pending;
  85     int nb_devices;
  86     int poll_index;
  87     uint8_t status;
  88
  89     QEMUTimer *autopoll_timer;
  90     bool autopoll_enabled;
  91     bool autopoll_blocked;
  92     uint8_t autopoll_rate_ms;
  93     uint16_t autopoll_mask;
  94     void (*autopoll_cb)(void *opaque);
  95     void *autopoll_cb_opaque;
  96 };
  97
  98 int adb_request(ADBBusState *s, uint8_t *buf_out,
  99                 const uint8_t *buf, int len);
 100 int adb_poll(ADBBusState *s, uint8_t *buf_out, uint16_t poll_mask);
 101
 102 void adb_autopoll_block(ADBBusState *s);
 103 void adb_autopoll_unblock(ADBBusState *s);
 104
 105 void adb_set_autopoll_enabled(ADBBusState *s, bool enabled);
 106 void adb_set_autopoll_rate_ms(ADBBusState *s, int rate_ms);
 107 void adb_set_autopoll_mask(ADBBusState *s, uint16_t mask);
 108 void adb_register_autopoll_callback(ADBBusState *s, void (*cb)(void *opaque),
 109                                     void *opaque);
 110
 111 #define TYPE_ADB_KEYBOARD "adb-keyboard"
 112 #define TYPE_ADB_MOUSE "adb-mouse"
 113
 114 #endif /* ADB_H */