1 /*
2 * Copyright 2020 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 #pragma once
18
19 #include <bluetooth/log.h>
20 #include <hardware/bluetooth.h>
21
22 #include <cstdint>
23 #include <string>
24
25 #include "macros.h"
26
27 /*
28 * Definitions for HCI Error Codes that are passed in the events
29 */
30 typedef enum : uint8_t {
31 HCI_SUCCESS = 0x00,
32 HCI_ERR_ILLEGAL_COMMAND = 0x01,
33 HCI_ERR_NO_CONNECTION = 0x02,
34 HCI_ERR_HW_FAILURE = 0x03,
35 HCI_ERR_PAGE_TIMEOUT = 0x04,
36 HCI_ERR_AUTH_FAILURE = 0x05,
37 HCI_ERR_KEY_MISSING = 0x06,
38 HCI_ERR_MEMORY_FULL = 0x07,
39 HCI_ERR_CONNECTION_TOUT = 0x08,
40 HCI_ERR_MAX_NUM_OF_CONNECTIONS = 0x09,
41 HCI_ERR_MAX_NUM_OF_SCOS = 0x0A,
42 HCI_ERR_CONNECTION_EXISTS = 0x0B,
43 HCI_ERR_COMMAND_DISALLOWED = 0x0C,
44 HCI_ERR_HOST_REJECT_RESOURCES = 0x0D,
45 HCI_ERR_HOST_REJECT_SECURITY = 0x0E,
46 HCI_ERR_HOST_REJECT_DEVICE = 0x0F,
47 HCI_ERR_HOST_TIMEOUT = 0x10, // stack/btm/btm_ble_gap,
48 HCI_ERR_ILLEGAL_PARAMETER_FMT = 0x12,
49 HCI_ERR_PEER_USER = 0x13,
50 HCI_ERR_REMOTE_LOW_RESOURCE = 0x14,
51 HCI_ERR_REMOTE_POWER_OFF = 0x15,
52 HCI_ERR_CONN_CAUSE_LOCAL_HOST = 0x16,
53 HCI_ERR_REPEATED_ATTEMPTS = 0x17,
54 HCI_ERR_PAIRING_NOT_ALLOWED = 0x18,
55 HCI_ERR_UNSUPPORTED_REM_FEATURE = 0x1A, // stack/btm/btm_ble_gap
56 HCI_ERR_UNSPECIFIED = 0x1F,
57 HCI_ERR_LMP_RESPONSE_TIMEOUT = 0x22, // GATT_CONN_LMP_TIMEOUT
58 HCI_ERR_LMP_ERR_TRANS_COLLISION = 0x23, // TODO remove
59 HCI_ERR_ENCRY_MODE_NOT_ACCEPTABLE = 0x25,
60 HCI_ERR_UNIT_KEY_USED = 0x26,
61 HCI_ERR_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED = 0x29,
62 HCI_ERR_DIFF_TRANSACTION_COLLISION = 0x2A, // stack/btm/btm_sec
63 HCI_ERR_INSUFFCIENT_SECURITY = 0x2F, // btif/btu
64 HCI_ERR_ROLE_SWITCH_PENDING = 0x32, // stack/btm/btm_sco
65 HCI_ERR_ROLE_SWITCH_FAILED = 0x35,
66 HCI_ERR_HOST_BUSY_PAIRING = 0x38, // stack/btm/btm_sec
67 HCI_ERR_UNACCEPT_CONN_INTERVAL = 0x3B, // stack/l2cap/l2c_ble
68 HCI_ERR_ADVERTISING_TIMEOUT = 0x3C, // stack/btm/btm_ble
69 HCI_ERR_CONN_FAILED_ESTABLISHMENT = 0x3E, // GATT_CONN_FAIL_ESTABLISH
70 HCI_ERR_LIMIT_REACHED = 0x43, // stack/btm/btm_ble_multi_adv.cc
71 HCI_ERR_CANCELLED_BY_LOCAL_HOST = 0x44, // stack/btm/btm_iso_impl.h
72
73 _HCI_ERR_MAX_ERR = 0x44,
74 HCI_ERR_UNDEFINED = 0xff,
75 } tHCI_ERROR_CODE;
76
77 #define HCI_ERR_MAX_ERR _HCI_ERR_MAX_ERR // HACK for now for SMP
78
hci_error_code_text(const tHCI_ERROR_CODE & error_code)79 inline std::string hci_error_code_text(const tHCI_ERROR_CODE& error_code) {
80 switch (error_code) {
81 CASE_RETURN_TEXT(HCI_SUCCESS);
82 CASE_RETURN_TEXT(HCI_ERR_ILLEGAL_COMMAND);
83 CASE_RETURN_TEXT(HCI_ERR_NO_CONNECTION);
84 CASE_RETURN_TEXT(HCI_ERR_HW_FAILURE);
85 CASE_RETURN_TEXT(HCI_ERR_PAGE_TIMEOUT);
86 CASE_RETURN_TEXT(HCI_ERR_AUTH_FAILURE);
87 CASE_RETURN_TEXT(HCI_ERR_KEY_MISSING);
88 CASE_RETURN_TEXT(HCI_ERR_MEMORY_FULL);
89 CASE_RETURN_TEXT(HCI_ERR_CONNECTION_TOUT);
90 CASE_RETURN_TEXT(HCI_ERR_MAX_NUM_OF_CONNECTIONS);
91 CASE_RETURN_TEXT(HCI_ERR_MAX_NUM_OF_SCOS);
92 CASE_RETURN_TEXT(HCI_ERR_CONNECTION_EXISTS);
93 CASE_RETURN_TEXT(HCI_ERR_COMMAND_DISALLOWED);
94 CASE_RETURN_TEXT(HCI_ERR_HOST_REJECT_RESOURCES);
95 CASE_RETURN_TEXT(HCI_ERR_HOST_REJECT_SECURITY);
96 CASE_RETURN_TEXT(HCI_ERR_HOST_REJECT_DEVICE);
97 CASE_RETURN_TEXT(HCI_ERR_HOST_TIMEOUT);
98 CASE_RETURN_TEXT(HCI_ERR_ILLEGAL_PARAMETER_FMT);
99 CASE_RETURN_TEXT(HCI_ERR_PEER_USER);
100 CASE_RETURN_TEXT(HCI_ERR_REMOTE_LOW_RESOURCE);
101 CASE_RETURN_TEXT(HCI_ERR_REMOTE_POWER_OFF);
102 CASE_RETURN_TEXT(HCI_ERR_CONN_CAUSE_LOCAL_HOST);
103 CASE_RETURN_TEXT(HCI_ERR_REPEATED_ATTEMPTS);
104 CASE_RETURN_TEXT(HCI_ERR_PAIRING_NOT_ALLOWED);
105 CASE_RETURN_TEXT(HCI_ERR_UNSUPPORTED_REM_FEATURE);
106 CASE_RETURN_TEXT(HCI_ERR_UNSPECIFIED);
107 CASE_RETURN_TEXT(HCI_ERR_LMP_RESPONSE_TIMEOUT);
108 CASE_RETURN_TEXT(HCI_ERR_LMP_ERR_TRANS_COLLISION);
109 CASE_RETURN_TEXT(HCI_ERR_ENCRY_MODE_NOT_ACCEPTABLE);
110 CASE_RETURN_TEXT(HCI_ERR_UNIT_KEY_USED);
111 CASE_RETURN_TEXT(HCI_ERR_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED);
112 CASE_RETURN_TEXT(HCI_ERR_DIFF_TRANSACTION_COLLISION);
113 CASE_RETURN_TEXT(HCI_ERR_INSUFFCIENT_SECURITY);
114 CASE_RETURN_TEXT(HCI_ERR_ROLE_SWITCH_PENDING);
115 CASE_RETURN_TEXT(HCI_ERR_ROLE_SWITCH_FAILED);
116 CASE_RETURN_TEXT(HCI_ERR_HOST_BUSY_PAIRING);
117 CASE_RETURN_TEXT(HCI_ERR_UNACCEPT_CONN_INTERVAL);
118 CASE_RETURN_TEXT(HCI_ERR_ADVERTISING_TIMEOUT);
119 CASE_RETURN_TEXT(HCI_ERR_CONN_FAILED_ESTABLISHMENT);
120 CASE_RETURN_TEXT(HCI_ERR_LIMIT_REACHED);
121 CASE_RETURN_TEXT(HCI_ERR_CANCELLED_BY_LOCAL_HOST);
122 default:
123 return std::format("UNKNOWN[0x{:02x}]", static_cast<uint8_t>(error_code));
124 }
125 }
126
hci_error_to_bt_status(const tHCI_ERROR_CODE & error_code)127 inline bt_status_t hci_error_to_bt_status(const tHCI_ERROR_CODE& error_code) {
128 switch (error_code) {
129 case HCI_SUCCESS: /* 0x00 */
130 return BT_STATUS_SUCCESS;
131 case HCI_ERR_ILLEGAL_COMMAND: /* 0x01 */
132 return BT_STATUS_UNSUPPORTED;
133 case HCI_ERR_NO_CONNECTION: /* 0x02 */
134 return BT_STATUS_NOT_READY;
135 case HCI_ERR_HW_FAILURE: /* 0x03 */
136 return BT_STATUS_FAIL;
137 case HCI_ERR_PAGE_TIMEOUT: /* 0x04 */
138 return BT_STATUS_TIMEOUT;
139 case HCI_ERR_AUTH_FAILURE: /* 0x05 */
140 return BT_STATUS_AUTH_FAILURE;
141 case HCI_ERR_KEY_MISSING: /* 0x06 */
142 return BT_STATUS_AUTH_FAILURE;
143 case HCI_ERR_MEMORY_FULL: /* 0x07 */
144 return BT_STATUS_NOMEM;
145 case HCI_ERR_CONNECTION_TOUT: /* 0x08 */
146 return BT_STATUS_TIMEOUT;
147 case HCI_ERR_MAX_NUM_OF_CONNECTIONS: /* 0x09 */
148 return BT_STATUS_FAIL;
149 case HCI_ERR_MAX_NUM_OF_SCOS: /* 0x0A */
150 return BT_STATUS_FAIL;
151 case HCI_ERR_CONNECTION_EXISTS: /* 0x0B */
152 return BT_STATUS_BUSY;
153 case HCI_ERR_COMMAND_DISALLOWED: /* 0x0C */
154 return BT_STATUS_UNSUPPORTED;
155 case HCI_ERR_HOST_REJECT_RESOURCES: /* 0x0D */
156 return BT_STATUS_BUSY;
157 case HCI_ERR_HOST_REJECT_SECURITY: /* 0x0E */
158 return BT_STATUS_AUTH_REJECTED;
159 case HCI_ERR_HOST_REJECT_DEVICE: /* 0x0F */
160 return BT_STATUS_AUTH_REJECTED;
161 case HCI_ERR_HOST_TIMEOUT: /* 0x10 */
162 return BT_STATUS_TIMEOUT;
163 case HCI_ERR_ILLEGAL_PARAMETER_FMT: /* 0x12 */
164 return BT_STATUS_PARM_INVALID;
165 case HCI_ERR_PEER_USER: /* 0x13 */
166 return BT_STATUS_RMT_DEV_DOWN;
167 case HCI_ERR_REMOTE_LOW_RESOURCE: /* 0x14 */
168 return BT_STATUS_RMT_DEV_DOWN;
169 case HCI_ERR_REMOTE_POWER_OFF: /* 0x15 */
170 return BT_STATUS_RMT_DEV_DOWN;
171 case HCI_ERR_CONN_CAUSE_LOCAL_HOST: /* 0x16 */
172 return BT_STATUS_DONE;
173 case HCI_ERR_REPEATED_ATTEMPTS: /* 0x17 */
174 return BT_STATUS_FAIL;
175 case HCI_ERR_PAIRING_NOT_ALLOWED: /* 0x18 */
176 return BT_STATUS_AUTH_REJECTED;
177 case HCI_ERR_UNSUPPORTED_REM_FEATURE: /* 0x1A */
178 return BT_STATUS_UNSUPPORTED;
179 case HCI_ERR_UNSPECIFIED: /* 0x1F */
180 return BT_STATUS_FAIL;
181 case HCI_ERR_LMP_RESPONSE_TIMEOUT: /* 0x22 */
182 return BT_STATUS_TIMEOUT;
183 case HCI_ERR_LMP_ERR_TRANS_COLLISION: /* 0x23 */
184 return BT_STATUS_FAIL;
185 case HCI_ERR_ENCRY_MODE_NOT_ACCEPTABLE: /* 0x25 */
186 return BT_STATUS_AUTH_REJECTED;
187 case HCI_ERR_UNIT_KEY_USED: /* 0x26 */
188 return BT_STATUS_AUTH_FAILURE;
189 case HCI_ERR_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED: /* 0x29 */
190 return BT_STATUS_UNSUPPORTED;
191 case HCI_ERR_DIFF_TRANSACTION_COLLISION: /* 0x2A */
192 return BT_STATUS_FAIL;
193 case HCI_ERR_INSUFFCIENT_SECURITY: /* 0x2F */
194 return BT_STATUS_AUTH_REJECTED;
195 case HCI_ERR_ROLE_SWITCH_PENDING: /* 0x32 */
196 return BT_STATUS_BUSY;
197 case HCI_ERR_ROLE_SWITCH_FAILED: /* 0x35 */
198 return BT_STATUS_FAIL;
199 case HCI_ERR_HOST_BUSY_PAIRING: /* 0x38 */
200 return BT_STATUS_BUSY;
201 case HCI_ERR_UNACCEPT_CONN_INTERVAL: /* 0x3B */
202 return BT_STATUS_PARM_INVALID;
203 case HCI_ERR_ADVERTISING_TIMEOUT: /* 0x3C */
204 return BT_STATUS_TIMEOUT;
205 case HCI_ERR_CONN_FAILED_ESTABLISHMENT: /* 0x3E */
206 return BT_STATUS_FAIL;
207 case HCI_ERR_LIMIT_REACHED: /* 0x43 */
208 return BT_STATUS_FAIL;
209 case HCI_ERR_CANCELLED_BY_LOCAL_HOST: /* 0x44 */
210 return BT_STATUS_DONE;
211 default:
212 return BT_STATUS_FAIL;
213 }
214 }
215
216 // Context equivalence
217 using tHCI_STATUS = tHCI_ERROR_CODE;
hci_status_code_text(const tHCI_STATUS & status_code)218 inline std::string hci_status_code_text(const tHCI_STATUS& status_code) {
219 return hci_error_code_text(status_code);
220 }
221
222 using tHCI_REASON = tHCI_ERROR_CODE;
hci_reason_code_text(const tHCI_REASON & reason_code)223 inline std::string hci_reason_code_text(const tHCI_REASON& reason_code) {
224 return hci_error_code_text(reason_code);
225 }
226
227 // Conversion from raw packet value
to_hci_error_code(const uint8_t & error_code)228 inline tHCI_ERROR_CODE to_hci_error_code(const uint8_t& error_code) {
229 if (error_code > _HCI_ERR_MAX_ERR) {
230 return HCI_ERR_UNDEFINED;
231 }
232 return static_cast<tHCI_ERROR_CODE>(error_code);
233 }
234
to_hci_status_code(const uint8_t & status_code)235 inline tHCI_STATUS to_hci_status_code(const uint8_t& status_code) {
236 if (status_code > _HCI_ERR_MAX_ERR) {
237 return HCI_ERR_UNDEFINED;
238 }
239 return static_cast<tHCI_STATUS>(status_code);
240 }
241
to_hci_reason_code(const uint8_t & reason_code)242 inline tHCI_REASON to_hci_reason_code(const uint8_t& reason_code) {
243 if (reason_code > _HCI_ERR_MAX_ERR) {
244 return HCI_ERR_UNDEFINED;
245 }
246 return static_cast<tHCI_REASON>(reason_code);
247 }
248
249 namespace std {
250 template <>
251 struct formatter<tHCI_ERROR_CODE> : enum_formatter<tHCI_ERROR_CODE> {};
252 } // namespace std
253