xref: /openbmc/qemu/include/hw/input/adb.h (revision ba632924)
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.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 #define TYPE_ADB_DEVICE "adb-device"
43 #define ADB_DEVICE(obj) OBJECT_CHECK(ADBDevice, (obj), TYPE_ADB_DEVICE)
44 
45 struct ADBDevice {
46     /*< private >*/
47     DeviceState parent_obj;
48     /*< public >*/
49 
50     int devaddr;
51     int handler;
52     bool disable_direct_reg3_writes;
53 };
54 
55 #define ADB_DEVICE_CLASS(cls) \
56     OBJECT_CLASS_CHECK(ADBDeviceClass, (cls), TYPE_ADB_DEVICE)
57 #define ADB_DEVICE_GET_CLASS(obj) \
58     OBJECT_GET_CLASS(ADBDeviceClass, (obj), TYPE_ADB_DEVICE)
59 
60 typedef struct ADBDeviceClass {
61     /*< private >*/
62     DeviceClass parent_class;
63     /*< public >*/
64 
65     ADBDeviceRequest *devreq;
66 } ADBDeviceClass;
67 
68 #define TYPE_ADB_BUS "apple-desktop-bus"
69 #define ADB_BUS(obj) OBJECT_CHECK(ADBBusState, (obj), TYPE_ADB_BUS)
70 
71 struct ADBBusState {
72     /*< private >*/
73     BusState parent_obj;
74     /*< public >*/
75 
76     ADBDevice *devices[MAX_ADB_DEVICES];
77     int nb_devices;
78     int poll_index;
79 };
80 
81 int adb_request(ADBBusState *s, uint8_t *buf_out,
82                 const uint8_t *buf, int len);
83 int adb_poll(ADBBusState *s, uint8_t *buf_out, uint16_t poll_mask);
84 
85 #define TYPE_ADB_KEYBOARD "adb-keyboard"
86 #define TYPE_ADB_MOUSE "adb-mouse"
87 
88 #endif /* ADB_H */
89