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 <string>
29
30 #include "sdp_api.h"
31 /*
32 * tHID_STATUS: HID result codes, returned by HID and device and host functions.
33 */
34 typedef enum : uint8_t {
35 HID_SUCCESS = 0,
36 HID_ERR_NOT_REGISTERED,
37 HID_ERR_ALREADY_REGISTERED,
38 HID_ERR_NO_RESOURCES,
39 HID_ERR_NO_CONNECTION,
40 HID_ERR_INVALID_PARAM,
41 HID_ERR_UNSUPPORTED,
42 HID_ERR_UNKNOWN_COMMAND,
43 HID_ERR_CONGESTED,
44 HID_ERR_CONN_IN_PROCESS,
45 HID_ERR_ALREADY_CONN,
46 HID_ERR_DISCONNECTING,
47 HID_ERR_SET_CONNABLE_FAIL,
48 /* Device specific error codes */
49 HID_ERR_HOST_UNKNOWN,
50 HID_ERR_L2CAP_FAILED,
51 HID_ERR_AUTH_FAILED,
52 HID_ERR_SDP_BUSY,
53 HID_ERR_GATT,
54
55 HID_ERR_INVALID = 0xFF
56 } tHID_STATUS;
57
58 #define CASE_RETURN_TEXT(code) \
59 case code: \
60 return #code
61
hid_status_text(const tHID_STATUS & status)62 inline std::string hid_status_text(const tHID_STATUS& status) {
63 switch (status) {
64 CASE_RETURN_TEXT(HID_SUCCESS);
65 CASE_RETURN_TEXT(HID_ERR_NOT_REGISTERED);
66 CASE_RETURN_TEXT(HID_ERR_ALREADY_REGISTERED);
67 CASE_RETURN_TEXT(HID_ERR_NO_RESOURCES);
68 CASE_RETURN_TEXT(HID_ERR_NO_CONNECTION);
69 CASE_RETURN_TEXT(HID_ERR_INVALID_PARAM);
70 CASE_RETURN_TEXT(HID_ERR_UNSUPPORTED);
71 CASE_RETURN_TEXT(HID_ERR_UNKNOWN_COMMAND);
72 CASE_RETURN_TEXT(HID_ERR_CONGESTED);
73 CASE_RETURN_TEXT(HID_ERR_CONN_IN_PROCESS);
74 CASE_RETURN_TEXT(HID_ERR_ALREADY_CONN);
75 CASE_RETURN_TEXT(HID_ERR_DISCONNECTING);
76 CASE_RETURN_TEXT(HID_ERR_SET_CONNABLE_FAIL);
77 CASE_RETURN_TEXT(HID_ERR_HOST_UNKNOWN);
78 CASE_RETURN_TEXT(HID_ERR_L2CAP_FAILED);
79 CASE_RETURN_TEXT(HID_ERR_AUTH_FAILED);
80 CASE_RETURN_TEXT(HID_ERR_SDP_BUSY);
81 CASE_RETURN_TEXT(HID_ERR_GATT);
82 CASE_RETURN_TEXT(HID_ERR_INVALID);
83 default:
84 return std::string("UNKNOWN[%hhu]", status);
85 }
86 }
87 #undef CASE_RETURN_TEXT
88
89 #define HID_L2CAP_CONN_FAIL \
90 (0x0100) /* Connection Attempt was made but failed */
91 #define HID_L2CAP_REQ_FAIL (0x0200) /* L2CAP_ConnectReq API failed */
92 #define HID_L2CAP_CFG_FAIL \
93 (0x0400) /* L2CAP Configuration was rejected by peer */
94
95 /* Define the HID transaction types
96 */
97 #define HID_TRANS_HANDSHAKE (0)
98 #define HID_TRANS_CONTROL (1)
99 #define HID_TRANS_GET_REPORT (4)
100 #define HID_TRANS_SET_REPORT (5)
101 #define HID_TRANS_GET_PROTOCOL (6)
102 #define HID_TRANS_SET_PROTOCOL (7)
103 #define HID_TRANS_GET_IDLE (8)
104 #define HID_TRANS_SET_IDLE (9)
105 #define HID_TRANS_DATA (10)
106 #define HID_TRANS_DATAC (11)
107
108 #define HID_GET_TRANS_FROM_HDR(x) (((x) >> 4) & 0x0f)
109 #define HID_GET_PARAM_FROM_HDR(x) ((x)&0x0f)
110 #define HID_BUILD_HDR(t, p) (uint8_t)(((t) << 4) | ((p)&0x0f))
111
112 /* Parameters for Handshake
113 */
114 #define HID_PAR_HANDSHAKE_RSP_SUCCESS (0)
115 #define HID_PAR_HANDSHAKE_RSP_NOT_READY (1)
116 #define HID_PAR_HANDSHAKE_RSP_ERR_INVALID_REP_ID (2)
117 #define HID_PAR_HANDSHAKE_RSP_ERR_UNSUPPORTED_REQ (3)
118 #define HID_PAR_HANDSHAKE_RSP_ERR_INVALID_PARAM (4)
119 #define HID_PAR_HANDSHAKE_RSP_ERR_UNKNOWN (14)
120 #define HID_PAR_HANDSHAKE_RSP_ERR_FATAL (15)
121
122 /* Parameters for Control
123 */
124 #define HID_PAR_CONTROL_NOP (0)
125 #define HID_PAR_CONTROL_HARD_RESET (1)
126 #define HID_PAR_CONTROL_SOFT_RESET (2)
127 #define HID_PAR_CONTROL_SUSPEND (3)
128 #define HID_PAR_CONTROL_EXIT_SUSPEND (4)
129 #define HID_PAR_CONTROL_VIRTUAL_CABLE_UNPLUG (5)
130
131 /* Different report types in get, set, data
132 */
133 #define HID_PAR_REP_TYPE_MASK (0x03)
134 #define HID_PAR_REP_TYPE_OTHER (0x00)
135 #define HID_PAR_REP_TYPE_INPUT (0x01)
136 #define HID_PAR_REP_TYPE_OUTPUT (0x02)
137 #define HID_PAR_REP_TYPE_FEATURE (0x03)
138
139 /* Parameters for Get Report
140 */
141
142 /* Buffer size in two bytes after Report ID */
143 #define HID_PAR_GET_REP_BUFSIZE_FOLLOWS (0x08)
144
145 /* Parameters for Protocol Type
146 */
147 #define HID_PAR_PROTOCOL_MASK (0x01)
148 #define HID_PAR_PROTOCOL_REPORT (0x01)
149 #define HID_PAR_PROTOCOL_BOOT_MODE (0x00)
150
151 #define HID_PAR_REP_TYPE_MASK (0x03)
152
153 /* Descriptor types in the SDP record
154 */
155 #define HID_SDP_DESCRIPTOR_REPORT (0x22)
156 #define HID_SDP_DESCRIPTOR_PHYSICAL (0x23)
157
158 typedef struct desc_info {
159 uint16_t dl_len;
160 uint8_t* dsc_list;
161 } tHID_DEV_DSCP_INFO;
162
163 #define HID_SSR_PARAM_INVALID 0xffff
164
165 #define HIDD_APP_DESCRIPTOR_LEN 2048
166
167 typedef struct sdp_info {
168 char svc_name[HID_MAX_SVC_NAME_LEN]; /*Service Name */
169 char svc_descr[HID_MAX_SVC_DESCR_LEN]; /*Service Description*/
170 char prov_name[HID_MAX_PROV_NAME_LEN]; /*Provider Name.*/
171 uint16_t rel_num; /*Release Number */
172 uint16_t hpars_ver; /*HID Parser Version.*/
173 uint16_t ssr_max_latency; /* HIDSSRHostMaxLatency value, if
174 HID_SSR_PARAM_INVALID not used*/
175 uint16_t
176 ssr_min_tout; /* HIDSSRHostMinTimeout value, if HID_SSR_PARAM_INVALID not
177 used* */
178 uint8_t sub_class; /*Device Subclass.*/
179 uint8_t ctry_code; /*Country Code.*/
180 uint16_t sup_timeout; /* Supervisory Timeout */
181
182 tHID_DEV_DSCP_INFO dscp_info; /* Descriptor list and Report list to be set in
183 the SDP record.
184 This parameter is used if
185 HID_DEV_USE_GLB_SDP_REC is set to false.*/
186 tSDP_DISC_REC* p_sdp_layer_rec;
187 } tHID_DEV_SDP_INFO;
188
189 #endif
190