1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ANDROID_INPUT_DRIVER_H
18 #define ANDROID_INPUT_DRIVER_H
19 
20 #include <stdint.h>
21 #include <sys/types.h>
22 
23 #include "InputHost.h"
24 
25 #include <hardware/input.h>
26 #include <utils/RefBase.h>
27 #include <utils/String8.h>
28 
29 // Declare a concrete type for the HAL
30 struct input_host {
31 };
32 
33 namespace android {
34 
35 class InputDriverInterface : public input_host_t, public virtual RefBase {
36 protected:
37     InputDriverInterface() = default;
38     virtual ~InputDriverInterface() = default;
39 
40 public:
41     virtual void init() = 0;
42 
43     virtual input_device_identifier_t* createDeviceIdentifier(
44             const char* name, int32_t productId, int32_t vendorId,
45             input_bus_t bus, const char* uniqueId) = 0;
46     virtual input_device_definition_t* createDeviceDefinition() = 0;
47     virtual input_report_definition_t* createInputReportDefinition() = 0;
48     virtual input_report_definition_t* createOutputReportDefinition() = 0;
49     virtual void freeReportDefinition(input_report_definition_t* reportDef) = 0;
50 
51     virtual void inputDeviceDefinitionAddReport(input_device_definition_t* d,
52             input_report_definition_t* r) = 0;
53     virtual void inputReportDefinitionAddCollection(input_report_definition_t* report,
54             input_collection_id_t id, int32_t arity) = 0;
55     virtual void inputReportDefinitionDeclareUsageInt(input_report_definition_t* report,
56             input_collection_id_t id, input_usage_t usage, int32_t min, int32_t max,
57             float resolution) = 0;
58     virtual void inputReportDefinitionDeclareUsagesBool(input_report_definition_t* report,
59             input_collection_id_t id, input_usage_t* usage, size_t usageCount) = 0;
60 
61     virtual input_device_handle_t* registerDevice(input_device_identifier_t* id,
62             input_device_definition_t* d) = 0;
63     virtual void unregisterDevice(input_device_handle_t* handle) = 0;
64 
65     virtual input_report_t* inputAllocateReport(input_report_definition_t* r) = 0;
66     virtual void inputReportSetUsageInt(input_report_t* r, input_collection_id_t id,
67             input_usage_t usage, int32_t value, int32_t arity_index) = 0;
68     virtual void inputReportSetUsageBool(input_report_t* r, input_collection_id_t id,
69             input_usage_t usage, bool value, int32_t arity_index) = 0;
70     virtual void reportEvent(input_device_handle_t* d, input_report_t* report) = 0;
71 
72     virtual input_property_map_t* inputGetDevicePropertyMap(input_device_identifier_t* id) = 0;
73     virtual input_property_t* inputGetDeviceProperty(input_property_map_t* map,
74             const char* key) = 0;
75     virtual const char* inputGetPropertyKey(input_property_t* property) = 0;
76     virtual const char* inputGetPropertyValue(input_property_t* property) = 0;
77     virtual void inputFreeDeviceProperty(input_property_t* property) = 0;
78     virtual void inputFreeDevicePropertyMap(input_property_map_t* map) = 0;
79 
80     virtual void dump(String8& result) = 0;
81 };
82 
83 class InputDriver : public InputDriverInterface {
84 public:
85     explicit InputDriver(const char* name);
86     virtual ~InputDriver() = default;
87 
88     virtual void init() override;
89 
90     virtual input_device_identifier_t* createDeviceIdentifier(
91             const char* name, int32_t productId, int32_t vendorId,
92             input_bus_t bus, const char* uniqueId) override;
93     virtual input_device_definition_t* createDeviceDefinition() override;
94     virtual input_report_definition_t* createInputReportDefinition() override;
95     virtual input_report_definition_t* createOutputReportDefinition() override;
96     virtual void freeReportDefinition(input_report_definition_t* reportDef) override;
97 
98     virtual void inputDeviceDefinitionAddReport(input_device_definition_t* d,
99             input_report_definition_t* r) override;
100     virtual void inputReportDefinitionAddCollection(input_report_definition_t* report,
101             input_collection_id_t id, int32_t arity) override;
102     virtual void inputReportDefinitionDeclareUsageInt(input_report_definition_t* report,
103             input_collection_id_t id, input_usage_t usage, int32_t min, int32_t max,
104             float resolution) override;
105     virtual void inputReportDefinitionDeclareUsagesBool(input_report_definition_t* report,
106             input_collection_id_t id, input_usage_t* usage, size_t usageCount) override;
107 
108     virtual input_device_handle_t* registerDevice(input_device_identifier_t* id,
109             input_device_definition_t* d) override;
110     virtual void unregisterDevice(input_device_handle_t* handle) override;
111 
112     virtual input_report_t* inputAllocateReport(input_report_definition_t* r) override;
113     virtual void inputReportSetUsageInt(input_report_t* r, input_collection_id_t id,
114             input_usage_t usage, int32_t value, int32_t arity_index) override;
115     virtual void inputReportSetUsageBool(input_report_t* r, input_collection_id_t id,
116             input_usage_t usage, bool value, int32_t arity_index) override;
117     virtual void reportEvent(input_device_handle_t* d, input_report_t* report) override;
118 
119     virtual input_property_map_t* inputGetDevicePropertyMap(input_device_identifier_t* id) override;
120     virtual input_property_t* inputGetDeviceProperty(input_property_map_t* map,
121             const char* key) override;
122     virtual const char* inputGetPropertyKey(input_property_t* property) override;
123     virtual const char* inputGetPropertyValue(input_property_t* property) override;
124     virtual void inputFreeDeviceProperty(input_property_t* property) override;
125     virtual void inputFreeDevicePropertyMap(input_property_map_t* map) override;
126 
127     virtual void dump(String8& result) override;
128 
129 private:
130     String8 mName;
131     const input_module_t* mHal;
132 };
133 
134 
135 extern "C" {
136 
137 input_device_identifier_t* create_device_identifier(input_host_t* host,
138         const char* name, int32_t product_id, int32_t vendor_id,
139         input_bus_t bus, const char* unique_id);
140 
141 input_device_definition_t* create_device_definition(input_host_t* host);
142 
143 input_report_definition_t* create_input_report_definition(input_host_t* host);
144 
145 input_report_definition_t* create_output_report_definition(input_host_t* host);
146 
147 void free_report_definition(input_host_t* host, input_report_definition_t* report_def);
148 
149 void input_device_definition_add_report(input_host_t* host,
150         input_device_definition_t* d, input_report_definition_t* r);
151 
152 void input_report_definition_add_collection(input_host_t* host,
153         input_report_definition_t* report, input_collection_id_t id, int32_t arity);
154 
155 void input_report_definition_declare_usage_int(input_host_t* host,
156         input_report_definition_t* report, input_collection_id_t id,
157         input_usage_t usage, int32_t min, int32_t max, float resolution);
158 
159 void input_report_definition_declare_usages_bool(input_host_t* host,
160         input_report_definition_t* report, input_collection_id_t id,
161         input_usage_t* usage, size_t usage_count);
162 
163 
164 input_device_handle_t* register_device(input_host_t* host,
165         input_device_identifier_t* id, input_device_definition_t* d);
166 
167 void unregister_device(input_host_t* host, input_device_handle_t* handle);
168 
169 input_report_t* input_allocate_report(input_host_t* host, input_report_definition_t* r);
170 
171 void input_report_set_usage_int(input_host_t* host, input_report_t* r,
172         input_collection_id_t id, input_usage_t usage, int32_t value, int32_t arity_index);
173 
174 void input_report_set_usage_bool(input_host_t* host, input_report_t* r,
175         input_collection_id_t id, input_usage_t usage, bool value, int32_t arity_index);
176 
177 void report_event(input_host_t* host, input_device_handle_t* d, input_report_t* report);
178 
179 input_property_map_t* input_get_device_property_map(input_host_t* host,
180         input_device_identifier_t* id);
181 
182 input_property_t* input_get_device_property(input_host_t* host, input_property_map_t* map,
183         const char* key);
184 
185 const char* input_get_property_key(input_host_t* host, input_property_t* property);
186 
187 const char* input_get_property_value(input_host_t* host, input_property_t* property);
188 
189 void input_free_device_property(input_host_t* host, input_property_t* property);
190 
191 void input_free_device_property_map(input_host_t* host, input_property_map_t* map);
192 }
193 
194 } // namespace android
195 #endif // ANDROID_INPUT_DRIVER_H
196