1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

use core::num::NonZeroI32;
use esp_idf_svc::sys;

#[derive(Copy, Clone, Eq, PartialEq, Hash)]
pub struct BLEError(NonZeroI32);

impl BLEError {
  pub fn fail() -> Result<(), Self> {
    Self::convert(0xFFFF)
  }

  pub const fn from_non_zero(error: NonZeroI32) -> Self {
    Self(error)
  }

  pub fn check_and_return<T>(error: u32, value: T) -> Result<T, Self> {
    match error {
      0 | sys::BLE_HS_EALREADY | sys::BLE_HS_EDONE => Ok(value),
      error => Err(Self(unsafe { NonZeroI32::new_unchecked(error as _) })),
    }
  }

  pub const fn convert(error: u32) -> Result<(), Self> {
    match error {
      0 | sys::BLE_HS_EALREADY | sys::BLE_HS_EDONE => Ok(()),
      error => Err(Self(unsafe { NonZeroI32::new_unchecked(error as _) })),
    }
  }

  pub fn code(&self) -> u32 {
    self.0.get() as _
  }
}

impl core::fmt::Display for BLEError {
  fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    match return_code_to_string(self.0.get()) {
      Some(text) => write!(f, "{text}")?,
      None => write!(f, "0x{:X}", self.0)?,
    };

    Ok(())
  }
}

impl core::fmt::Debug for BLEError {
  fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    match return_code_to_string(self.0.get()) {
      Some(text) => write!(f, "{text}")?,
      None => write!(f, "0x{:X}", self.0)?,
    };

    Ok(())
  }
}

#[cfg(feature = "std")]
impl std::error::Error for BLEError {}

/// ATT errors (BLE_HS_ERR_ATT_BASE : 0x100)
macro_rules! ATT_ERR {
  ($x:expr) => {
    const { sys::BLE_HS_ERR_ATT_BASE + $x }
  };
}

/// HCI errors (BLE_HS_ERR_HCI_BASE : 0x200)
macro_rules! HCI_ERR {
  ($x:expr) => {
    const { sys::BLE_HS_ERR_HCI_BASE + $x }
  };
}

/// L2CAP errors (BLE_HS_ERR_L2C_BASE : 0x300)
macro_rules! L2C_ERR {
  ($x:expr) => {
    const { sys::BLE_HS_ERR_L2C_BASE + $x }
  };
}

/// local Security Manager errors (BLE_HS_ERR_SM_US_BASE : 0x400)
macro_rules! SM_US_ERR {
  ($x:expr) => {
    const { sys::BLE_HS_ERR_SM_US_BASE + $x }
  };
}

/// Error base for remote (peer) Security Manager errors (BLE_HS_ERR_SM_PEER_BASE : 0x500)
#[allow(unused)]
macro_rules! SM_PEER_ERR {
  ($x:expr) => {
    const { sys::BLE_HS_ERR_SM_PEER_BASE + $x }
  };
}

/// hardware errors (BLE_HS_ERR_HW_BASE : 0x600)
#[allow(unused)]
macro_rules! HW_ERR {
  ($x:expr) => {
    const { sys::BLE_HS_ERR_HW_BASE + $x }
  };
}

pub fn return_code_to_string(rc: i32) -> Option<&'static str> {
  match rc as u32 {
    sys::BLE_HS_EALREADY => Some("Operation already in progress or completed."),
    sys::BLE_HS_EINVAL => Some("One or more arguments are invalid."),
    sys::BLE_HS_EMSGSIZE => Some("The provided buffer is too small."),
    sys::BLE_HS_ENOENT => Some("No entry matching the specified criteria."),
    sys::BLE_HS_ENOMEM => Some("Operation failed due to resource exhaustion."),
    sys::BLE_HS_ENOTCONN => Some("No open connection with the specified handle."),
    sys::BLE_HS_ENOTSUP => Some("Operation disabled at compile time."),
    sys::BLE_HS_EAPP => Some("Application callback behaved unexpectedly."),
    sys::BLE_HS_EBADDATA => Some("Command from peer is invalid."),
    sys::BLE_HS_EOS => Some("Mynewt OS error."),
    sys::BLE_HS_ECONTROLLER => Some("Event from controller is invalid."),
    sys::BLE_HS_ETIMEOUT => Some("Operation timed out."),
    sys::BLE_HS_EDONE => Some("Operation completed successfully."),
    sys::BLE_HS_EBUSY => Some("Operation cannot be performed until procedure completes."),
    sys::BLE_HS_EREJECT => Some("Peer rejected a connection parameter update request."),
    sys::BLE_HS_EUNKNOWN => Some("Unexpected failure; catch all."),
    sys::BLE_HS_EROLE => Some("Operation requires different role (e.g., central vs. peripheral)."),
    sys::BLE_HS_ETIMEOUT_HCI => Some("HCI request timed out; controller unresponsive."),
    sys::BLE_HS_ENOMEM_EVT => Some(
      "Controller failed to send event due to memory exhaustion (combined host-controller only).",
    ),
    sys::BLE_HS_ENOADDR => Some("Operation requires an identity address but none configured."),
    sys::BLE_HS_ENOTSYNCED => {
      Some("Attempt to use the host before it is synced with controller.")
    }
    sys::BLE_HS_EAUTHEN => Some("Insufficient authentication."),
    sys::BLE_HS_EAUTHOR => Some("Insufficient authorization."),
    sys::BLE_HS_EENCRYPT => Some("Insufficient encryption level."),
    sys::BLE_HS_EENCRYPT_KEY_SZ => Some("Insufficient key size"),
    sys::BLE_HS_ESTORE_CAP => Some("Storage at capacity."),
    sys::BLE_HS_ESTORE_FAIL => Some("Storage IO error."),

    ATT_ERR!(sys::BLE_ATT_ERR_INVALID_HANDLE) => Some("The attribute handle given was not valid on this server."),
    ATT_ERR!(sys::BLE_ATT_ERR_READ_NOT_PERMITTED) => Some("The attribute cannot be read."),
    ATT_ERR!(sys::BLE_ATT_ERR_WRITE_NOT_PERMITTED) => Some("The attribute cannot be written."),
    ATT_ERR!(sys::BLE_ATT_ERR_INVALID_PDU) => Some("The attribute PDU was invalid."),
    ATT_ERR!(sys::BLE_ATT_ERR_INSUFFICIENT_AUTHEN) => Some("The attribute requires authentication before it can be read or written."),
    ATT_ERR!(sys::BLE_ATT_ERR_REQ_NOT_SUPPORTED) => Some("Attribute server does not support the request received from the client."),
    ATT_ERR!(sys::BLE_ATT_ERR_INVALID_OFFSET) => Some("Offset specified was past the end of the attribute."),
    ATT_ERR!(sys::BLE_ATT_ERR_INSUFFICIENT_AUTHOR) => Some("The attribute requires authorization before it can be read or written."),
    ATT_ERR!(sys::BLE_ATT_ERR_PREPARE_QUEUE_FULL) => Some("Too many prepare writes have been queued."),
    ATT_ERR!(sys::BLE_ATT_ERR_ATTR_NOT_FOUND) => Some("No attribute found within the given attribute handle range."),
    ATT_ERR!(sys::BLE_ATT_ERR_ATTR_NOT_LONG) => Some("The attribute cannot be read or written using the Read Blob Request."),
    ATT_ERR!(sys::BLE_ATT_ERR_INSUFFICIENT_KEY_SZ) => Some("The Encryption Key Size used for encrypting this link is insufficient."),
    ATT_ERR!(sys::BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN) => Some("The attribute value length is invalid for the operation."),
    ATT_ERR!(sys::BLE_ATT_ERR_UNLIKELY) => Some("The attribute request has encountered an error that was unlikely, could not be completed as requested."),
    ATT_ERR!(sys::BLE_ATT_ERR_INSUFFICIENT_ENC) => Some("The attribute requires encryption before it can be read or written."),
    ATT_ERR!(sys::BLE_ATT_ERR_UNSUPPORTED_GROUP) => Some("The attribute type is not a supported grouping attribute as defined by a higher layer specification."),
    ATT_ERR!(sys::BLE_ATT_ERR_INSUFFICIENT_RES) => Some("Insufficient Resources to complete the request."),

    HCI_ERR!(sys::ble_error_codes_BLE_ERR_UNKNOWN_HCI_CMD) => Some("Unknown HCI Command"),
    HCI_ERR!(sys::ble_error_codes_BLE_ERR_UNK_CONN_ID) => Some("Unknown Connection Identifier"),
    HCI_ERR!(sys::ble_error_codes_BLE_ERR_AUTH_FAIL) => Some("Authentication Failure"),
    HCI_ERR!(sys::ble_error_codes_BLE_ERR_INV_HCI_CMD_PARMS) => Some("Invalid HCI Command Parameters"),
    HCI_ERR!(sys::ble_error_codes_BLE_ERR_REM_USER_CONN_TERM) => Some("Remote User Terminated Connection"),
    HCI_ERR!(sys::ble_error_codes_BLE_ERR_CONN_TERM_LOCAL) => Some("Connection Terminated By Local Host"),
    HCI_ERR!(sys::ble_error_codes_BLE_ERR_CONN_ESTABLISHMENT) => Some("Connection Failed to be Established."),

    L2C_ERR!(sys::BLE_L2CAP_SIG_ERR_CMD_NOT_UNDERSTOOD) => Some("Invalid or unsupported incoming L2CAP sig command."),
    L2C_ERR!(sys::BLE_L2CAP_SIG_ERR_MTU_EXCEEDED) => Some("Incoming packet too large."),
    L2C_ERR!(sys::BLE_L2CAP_SIG_ERR_INVALID_CID) => Some("No channel with specified ID."),

    SM_US_ERR!(sys::BLE_SM_ERR_PASSKEY) => Some("The user input of passkey failed, for example, the user cancelled the operation."),
    SM_US_ERR!(sys::BLE_SM_ERR_OOB)=> Some("The OOB data is not available."),
    SM_US_ERR!(sys::BLE_SM_ERR_AUTHREQ) => Some("The pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices."),
    SM_US_ERR!(sys::BLE_SM_ERR_CONFIRM_MISMATCH) => Some("The confirm value does not match the calculated compare value."),
    SM_US_ERR!(sys::BLE_SM_ERR_PAIR_NOT_SUPP) => Some("Pairing is not supported by the device."),
    SM_US_ERR!(sys::BLE_SM_ERR_ENC_KEY_SZ) => Some("The resultant encryption key size is insufficient for the security requirements of this device."),
    SM_US_ERR!(sys::BLE_SM_ERR_CMD_NOT_SUPP) => Some("The SMP command received is not supported on this device."),
    SM_US_ERR!(sys::BLE_SM_ERR_UNSPECIFIED) => Some("Pairing failed due to an unspecified reason."),
    SM_US_ERR!(sys::BLE_SM_ERR_REPEATED) => Some("Pairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request."),
    SM_US_ERR!(sys::BLE_SM_ERR_INVAL) => Some("The Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified range."),
    SM_US_ERR!(sys::BLE_SM_ERR_DHKEY) => Some("Indicates to the remote device that the DHKey Check value received doesn’t match the one calculated by the local device."),
    SM_US_ERR!(sys::BLE_SM_ERR_NUMCMP) => Some("Indicates that the confirm values in the numeric comparison protocol do not match."),
    SM_US_ERR!(sys::BLE_SM_ERR_ALREADY) => Some("Indicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process."),
    SM_US_ERR!(sys::BLE_SM_ERR_CROSS_TRANS) => Some("Indicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport."),

    _ => None,
  }
}

#[cfg(not(feature = "debug"))]
macro_rules! ble {
  ($err:expr) => {{
    $crate::BLEError::convert($err as _)
  }};
}
#[cfg(feature = "debug")]
macro_rules! ble {
  ($err:expr) => {{
    let rc = $crate::BLEError::convert($err as _);
    if let Err(err) = rc {
      ::log::warn!(target: "esp32_nimble", "{}[{}]: {:?}", file!(), line!(), err);
    }
    rc
  }};
}

pub(crate) use ble;