1 /******************************************************************************
2 *
3 * Copyright 2002-2012 Broadcom Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 ******************************************************************************/
18
19 /******************************************************************************
20 *
21 * This file contains HID protocol definitions
22 *
23 ******************************************************************************/
24
25 #ifndef HIDDEFS_H
26 #define HIDDEFS_H
27
28 #include <base/strings/stringprintf.h>
29 #include <bluetooth/log.h>
30
31 #include "internal_include/bt_target.h"
32 #include "macros.h"
33 #include "stack/include/sdp_api.h"
34 /*
35 * tHID_STATUS: HID result codes, returned by HID and device and host functions.
36 */
37 typedef enum : uint8_t {
38 HID_SUCCESS = 0,
39 HID_ERR_NOT_REGISTERED,
40 HID_ERR_ALREADY_REGISTERED,
41 HID_ERR_NO_RESOURCES,
42 HID_ERR_NO_CONNECTION,
43 HID_ERR_INVALID_PARAM,
44 HID_ERR_UNSUPPORTED,
45 HID_ERR_UNKNOWN_COMMAND,
46 HID_ERR_CONGESTED,
47 HID_ERR_CONN_IN_PROCESS,
48 HID_ERR_ALREADY_CONN,
49 HID_ERR_DISCONNECTING,
50 HID_ERR_SET_CONNABLE_FAIL,
51 /* Device specific error codes */
52 HID_ERR_HOST_UNKNOWN,
53 HID_ERR_L2CAP_FAILED,
54 HID_ERR_AUTH_FAILED,
55 HID_ERR_SDP_BUSY,
56 HID_ERR_GATT,
57
58 HID_ERR_INVALID = 0xFF
59 } tHID_STATUS;
60
hid_status_text(const tHID_STATUS & status)61 inline std::string hid_status_text(const tHID_STATUS& status) {
62 switch (status) {
63 CASE_RETURN_TEXT(HID_SUCCESS);
64 CASE_RETURN_TEXT(HID_ERR_NOT_REGISTERED);
65 CASE_RETURN_TEXT(HID_ERR_ALREADY_REGISTERED);
66 CASE_RETURN_TEXT(HID_ERR_NO_RESOURCES);
67 CASE_RETURN_TEXT(HID_ERR_NO_CONNECTION);
68 CASE_RETURN_TEXT(HID_ERR_INVALID_PARAM);
69 CASE_RETURN_TEXT(HID_ERR_UNSUPPORTED);
70 CASE_RETURN_TEXT(HID_ERR_UNKNOWN_COMMAND);
71 CASE_RETURN_TEXT(HID_ERR_CONGESTED);
72 CASE_RETURN_TEXT(HID_ERR_CONN_IN_PROCESS);
73 CASE_RETURN_TEXT(HID_ERR_ALREADY_CONN);
74 CASE_RETURN_TEXT(HID_ERR_DISCONNECTING);
75 CASE_RETURN_TEXT(HID_ERR_SET_CONNABLE_FAIL);
76 CASE_RETURN_TEXT(HID_ERR_HOST_UNKNOWN);
77 CASE_RETURN_TEXT(HID_ERR_L2CAP_FAILED);
78 CASE_RETURN_TEXT(HID_ERR_AUTH_FAILED);
79 CASE_RETURN_TEXT(HID_ERR_SDP_BUSY);
80 CASE_RETURN_TEXT(HID_ERR_GATT);
81 CASE_RETURN_TEXT(HID_ERR_INVALID);
82 default:
83 return base::StringPrintf("UNKNOWN[%hhu]", status);
84 }
85 }
86
87 #define HID_L2CAP_CONN_FAIL (0x0100) /* Connection Attempt was made but failed */
88 #define HID_L2CAP_REQ_FAIL (0x0200) /* L2CAP_ConnectReq API failed */
89 #define HID_L2CAP_CFG_FAIL (0x0400) /* L2CAP Configuration was rejected by peer */
90
91 /* Define the HID transaction types
92 */
93 #define HID_TRANS_HANDSHAKE (0)
94 #define HID_TRANS_CONTROL (1)
95 #define HID_TRANS_GET_REPORT (4)
96 #define HID_TRANS_SET_REPORT (5)
97 #define HID_TRANS_GET_PROTOCOL (6)
98 #define HID_TRANS_SET_PROTOCOL (7)
99 #define HID_TRANS_GET_IDLE (8)
100 #define HID_TRANS_SET_IDLE (9)
101 #define HID_TRANS_DATA (10)
102 #define HID_TRANS_DATAC (11)
103
104 #define HID_GET_TRANS_FROM_HDR(x) (((x) >> 4) & 0x0f)
105 #define HID_GET_PARAM_FROM_HDR(x) ((x) & 0x0f)
106 #define HID_BUILD_HDR(t, p) (uint8_t)(((t) << 4) | ((p) & 0x0f))
107
108 /* Parameters for Handshake
109 */
110 #define HID_PAR_HANDSHAKE_RSP_SUCCESS (0)
111 #define HID_PAR_HANDSHAKE_RSP_NOT_READY (1)
112 #define HID_PAR_HANDSHAKE_RSP_ERR_INVALID_REP_ID (2)
113 #define HID_PAR_HANDSHAKE_RSP_ERR_UNSUPPORTED_REQ (3)
114 #define HID_PAR_HANDSHAKE_RSP_ERR_INVALID_PARAM (4)
115 #define HID_PAR_HANDSHAKE_RSP_ERR_UNKNOWN (14)
116 #define HID_PAR_HANDSHAKE_RSP_ERR_FATAL (15)
117
118 /* Parameters for Control
119 */
120 #define HID_PAR_CONTROL_NOP (0)
121 #define HID_PAR_CONTROL_HARD_RESET (1)
122 #define HID_PAR_CONTROL_SOFT_RESET (2)
123 #define HID_PAR_CONTROL_SUSPEND (3)
124 #define HID_PAR_CONTROL_EXIT_SUSPEND (4)
125 #define HID_PAR_CONTROL_VIRTUAL_CABLE_UNPLUG (5)
126
127 /* Different report types in get, set, data
128 */
129 #define HID_PAR_REP_TYPE_MASK (0x03)
130 #define HID_PAR_REP_TYPE_OTHER (0x00)
131 #define HID_PAR_REP_TYPE_INPUT (0x01)
132 #define HID_PAR_REP_TYPE_OUTPUT (0x02)
133 #define HID_PAR_REP_TYPE_FEATURE (0x03)
134
135 /* Parameters for Get Report
136 */
137
138 /* Buffer size in two bytes after Report ID */
139 #define HID_PAR_GET_REP_BUFSIZE_FOLLOWS (0x08)
140
141 /* Parameters for Protocol Type
142 */
143 #define HID_PAR_PROTOCOL_MASK (0x01)
144 #define HID_PAR_PROTOCOL_REPORT (0x01)
145 #define HID_PAR_PROTOCOL_BOOT_MODE (0x00)
146
147 #define HID_PAR_REP_TYPE_MASK (0x03)
148
149 /* Descriptor types in the SDP record
150 */
151 #define HID_SDP_DESCRIPTOR_REPORT (0x22)
152 #define HID_SDP_DESCRIPTOR_PHYSICAL (0x23)
153
154 typedef struct desc_info {
155 uint16_t dl_len;
156 uint8_t* dsc_list;
157 } tHID_DEV_DSCP_INFO;
158
159 #define HID_SSR_PARAM_INVALID 0xffff
160
161 #define HIDD_APP_DESCRIPTOR_LEN 2048
162
163 typedef struct sdp_info {
164 char svc_name[HID_MAX_SVC_NAME_LEN]; /*Service Name */
165 char svc_descr[HID_MAX_SVC_DESCR_LEN]; /*Service Description*/
166 char prov_name[HID_MAX_PROV_NAME_LEN]; /*Provider Name.*/
167 uint16_t rel_num; /*Release Number */
168 uint16_t hpars_ver; /*HID Parser Version.*/
169 uint16_t ssr_max_latency; /* HIDSSRHostMaxLatency value, if
170 HID_SSR_PARAM_INVALID not used*/
171 uint16_t ssr_min_tout; /* HIDSSRHostMinTimeout value, if HID_SSR_PARAM_INVALID not
172 used* */
173 uint8_t sub_class; /*Device Subclass.*/
174 uint8_t ctry_code; /*Country Code.*/
175 uint16_t sup_timeout; /* Supervisory Timeout */
176
177 tHID_DEV_DSCP_INFO dscp_info; /* Descriptor list and Report list to be set in
178 the SDP record.
179 This parameter is used if
180 HID_DEV_USE_GLB_SDP_REC is set to false.*/
181 tSDP_DISC_REC* p_sdp_layer_rec;
182 } tHID_DEV_SDP_INFO;
183
184 namespace std {
185 template <>
186 struct formatter<tHID_STATUS> : enum_formatter<tHID_STATUS> {};
187 } // namespace std
188
189 #endif
190