xref: /openbmc/qemu/include/hw/input/adb.h (revision ad9e5aa2)
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 
31 #define MAX_ADB_DEVICES 16
32 
33 #define ADB_MAX_OUT_LEN 16
34 
35 typedef struct ADBBusState ADBBusState;
36 typedef struct ADBDevice ADBDevice;
37 
38 /* buf = NULL means polling */
39 typedef int ADBDeviceRequest(ADBDevice *d, uint8_t *buf_out,
40                               const uint8_t *buf, int len);
41 
42 typedef bool ADBDeviceHasData(ADBDevice *d);
43 
44 #define TYPE_ADB_DEVICE "adb-device"
45 #define ADB_DEVICE(obj) OBJECT_CHECK(ADBDevice, (obj), TYPE_ADB_DEVICE)
46 
47 struct ADBDevice {
48     /*< private >*/
49     DeviceState parent_obj;
50     /*< public >*/
51 
52     int devaddr;
53     int handler;
54 };
55 
56 #define ADB_DEVICE_CLASS(cls) \
57     OBJECT_CLASS_CHECK(ADBDeviceClass, (cls), TYPE_ADB_DEVICE)
58 #define ADB_DEVICE_GET_CLASS(obj) \
59     OBJECT_GET_CLASS(ADBDeviceClass, (obj), TYPE_ADB_DEVICE)
60 
61 typedef struct ADBDeviceClass {
62     /*< private >*/
63     DeviceClass parent_class;
64     /*< public >*/
65 
66     ADBDeviceRequest *devreq;
67     ADBDeviceHasData *devhasdata;
68 } ADBDeviceClass;
69 
70 #define TYPE_ADB_BUS "apple-desktop-bus"
71 #define ADB_BUS(obj) OBJECT_CHECK(ADBBusState, (obj), TYPE_ADB_BUS)
72 
73 #define ADB_STATUS_BUSTIMEOUT  0x1
74 #define ADB_STATUS_POLLREPLY   0x2
75 
76 struct ADBBusState {
77     /*< private >*/
78     BusState parent_obj;
79     /*< public >*/
80 
81     ADBDevice *devices[MAX_ADB_DEVICES];
82     uint16_t pending;
83     int nb_devices;
84     int poll_index;
85     uint8_t status;
86 
87     QEMUTimer *autopoll_timer;
88     bool autopoll_enabled;
89     bool autopoll_blocked;
90     uint8_t autopoll_rate_ms;
91     uint16_t autopoll_mask;
92     void (*autopoll_cb)(void *opaque);
93     void *autopoll_cb_opaque;
94 };
95 
96 int adb_request(ADBBusState *s, uint8_t *buf_out,
97                 const uint8_t *buf, int len);
98 int adb_poll(ADBBusState *s, uint8_t *buf_out, uint16_t poll_mask);
99 
100 void adb_autopoll_block(ADBBusState *s);
101 void adb_autopoll_unblock(ADBBusState *s);
102 
103 void adb_set_autopoll_enabled(ADBBusState *s, bool enabled);
104 void adb_set_autopoll_rate_ms(ADBBusState *s, int rate_ms);
105 void adb_set_autopoll_mask(ADBBusState *s, uint16_t mask);
106 void adb_register_autopoll_callback(ADBBusState *s, void (*cb)(void *opaque),
107                                     void *opaque);
108 
109 #define TYPE_ADB_KEYBOARD "adb-keyboard"
110 #define TYPE_ADB_MOUSE "adb-mouse"
111 
112 #endif /* ADB_H */
113