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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
//! Vendor-specific HCI commands and types needed for those commands. extern crate bluetooth_hci as hci; extern crate byteorder; extern crate embedded_hal as hal; extern crate nb; use byteorder::{ByteOrder, LittleEndian}; /// Vendor-specific HCI commands for the [ActiveBlueNRG](::ActiveBlueNRG). pub trait Commands { /// Type of communication errors. type Error; /// This command is intended to retrieve the firmware revision number. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalGetFirmwareRevision) event. fn get_firmware_revision(&mut self) -> nb::Result<(), Self::Error>; /// This command writes a value to a low level configure data structure. It is useful to setup /// directly some low level parameters for the system in the runtime. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalWriteConfigData) event. fn write_config_data(&mut self, config: &ConfigData) -> nb::Result<(), Self::Error>; /// This command requests the value in the low level configure data structure. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalReadConfigData) event. fn read_config_data(&mut self, param: ConfigParameter) -> nb::Result<(), Self::Error>; /// This command sets the TX power level of the BlueNRG-MS. /// /// When the system starts up or reboots, the default TX power level will be used, which is the /// maximum value of [8 dBm](PowerLevel::Dbm8_0). Once this command is given, the output power /// will be changed instantly, regardless if there is Bluetooth communication going on or /// not. For example, for debugging purpose, the BlueNRG-MS can be set to advertise all the /// time. And use this command to observe the signal strength changing. /// /// The system will keep the last received TX power level from the command, i.e. the 2nd /// command overwrites the previous TX power level. The new TX power level remains until /// another Set TX Power command, or the system reboots. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalSetTxPowerLevel) event. fn set_tx_power_level(&mut self, level: PowerLevel) -> nb::Result<(), Self::Error>; /// Puts the device in standby mode. /// /// Normally the BlueNRG-MS will automatically enter sleep mode to save power. This command /// further put the device into the Standby mode instead of the sleep mode. The difference is /// that, in sleep mode, the device can still wake up itself with the internal timer. But in /// standby mode, this timer is also disabled. So the only possibility to wake up the device is /// by the external signals, e.g. a HCI command sent via SPI bus. /// /// Based on the measurement, the current consumption under sleep mode is ~2 uA. And this value /// is ~1.5 uA in standby mode. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalDeviceStandby) event. /// /// The command is only accepted when there is no other Bluetooth activity. Otherwise an error /// code [command disallowed](hci::Status::CommandDisallowed) will return. fn device_standby(&mut self) -> nb::Result<(), Self::Error>; /// Retrieve the number of packets sent in the last TX direct test. /// /// During the Direct Test mode, in the TX tests, the number of packets sent in the test is not /// returned when executing the Direct Test End command. This command implements this feature. /// /// If the Direct TX test is started, a 32-bit counter will be used to count how many packets /// have been transmitted. After the Direct Test End, this command can be used to check how many /// packets were sent during the Direct TX test. /// /// The counter starts from 0 and counts upwards. As would be the case if 32-bits are all used, /// the counter wraps back and starts from 0 again. The counter is not cleared until the next /// Direct TX test starts. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalGetTxTestPacketCount) event. fn get_tx_test_packet_count(&mut self) -> nb::Result<(), Self::Error>; /// This command starts a carrier frequency, i.e. a tone, on a specific channel. /// /// The frequency sine wave at the specific channel may be used for debugging purpose only. The /// channel ID is a parameter from 0 to 39 for the 40 BLE channels, e.g. 0 for 2.402 GHz, 1 for /// 2.404 GHz etc. /// /// This command should not be used when normal Bluetooth activities are ongoing. /// The tone should be stopped by [`stop_tone`](Commands::stop_tone) command. /// /// # Errors /// /// - [InvalidChannel](Error::InvalidChannel) if the channel is greater than 39. /// - Underlying communication errors /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalStartTone) event. fn start_tone(&mut self, channel: u8) -> nb::Result<(), Error<Self::Error>>; /// Stops the previously started by the [`start_tone`](Commands::start_tone) command. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalStopTone) event. fn stop_tone(&mut self) -> nb::Result<(), Self::Error>; /// This command is intended to return the Link Layer Status and Connection Handles. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalGetLinkStatus) event. fn get_link_status(&mut self) -> nb::Result<(), Self::Error>; /// This command is intended to retrieve information about the current Anchor Interval and /// allocable timing slots. /// /// # Errors /// /// Only underlying communication errors are reported. /// /// # Generated events /// /// The controller will generate a [command /// complete](::event::command::ReturnParameters::HalGetAnchorPeriod) event. fn get_anchor_period(&mut self) -> nb::Result<(), Self::Error>; } impl<'spi, 'dbuf, SPI, OutputPin1, OutputPin2, InputPin, E> Commands for ::ActiveBlueNRG<'spi, 'dbuf, SPI, OutputPin1, OutputPin2, InputPin> where SPI: hal::blocking::spi::Transfer<u8, Error = E> + hal::blocking::spi::Write<u8, Error = E>, OutputPin1: hal::digital::OutputPin, OutputPin2: hal::digital::OutputPin, InputPin: hal::digital::InputPin, { type Error = E; fn get_firmware_revision(&mut self) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_GET_FIRMWARE_REVISION, &[]) } impl_variable_length_params!( write_config_data, ConfigData, ::opcode::HAL_WRITE_CONFIG_DATA ); fn read_config_data(&mut self, param: ConfigParameter) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_READ_CONFIG_DATA, &[param as u8]) } fn set_tx_power_level(&mut self, level: PowerLevel) -> nb::Result<(), Self::Error> { let mut bytes = [0; 2]; LittleEndian::write_u16(&mut bytes, level as u16); self.write_command(::opcode::HAL_SET_TX_POWER_LEVEL, &bytes) } fn device_standby(&mut self) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_DEVICE_STANDBY, &[]) } fn get_tx_test_packet_count(&mut self) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_TX_TEST_PACKET_COUNT, &[]) } fn start_tone(&mut self, channel: u8) -> nb::Result<(), Error<Self::Error>> { const MAX_CHANNEL: u8 = 39; if channel > MAX_CHANNEL { return Err(nb::Error::Other(Error::InvalidChannel(channel))); } self.write_command(::opcode::HAL_START_TONE, &[channel as u8]) .map_err(rewrap_error) } fn stop_tone(&mut self) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_STOP_TONE, &[]) } fn get_link_status(&mut self) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_GET_LINK_STATUS, &[]) } fn get_anchor_period(&mut self) -> nb::Result<(), Self::Error> { self.write_command(::opcode::HAL_GET_ANCHOR_PERIOD, &[]) } } /// Potential errors from parameter validation. /// /// Before some commands are sent to the controller, the parameters are validated. This type /// enumerates the potential validation errors. Must be specialized on the types of communication /// errors. #[derive(Copy, Clone, Debug, PartialEq)] pub enum Error<E> { /// For the [Start Tone](Commands::start_tone) command, the channel was greater than the maximum /// allowed channel (39). The invalid channel is returned. InvalidChannel(u8), /// Underlying communication error. Comm(E), } fn rewrap_error<E>(e: nb::Error<E>) -> nb::Error<Error<E>> { match e { nb::Error::WouldBlock => nb::Error::WouldBlock, nb::Error::Other(c) => nb::Error::Other(Error::Comm(c)), } } /// Low-level configuration parameters for the controller. pub struct ConfigData { offset: u8, length: u8, value_buf: [u8; ConfigData::MAX_LENGTH], } impl ConfigData { /// Maximum length needed to serialize the data. pub const MAX_LENGTH: usize = 0x2E; /// Serializes the data into the given buffer. /// /// Returns the number of valid bytes in the buffer. /// /// # Panics /// /// The buffer must be large enough to support the serialized data (at least /// [`MAX_LENGTH`](ConfigData::MAX_LENGTH) bytes). pub fn into_bytes(&self, bytes: &mut [u8]) -> usize { bytes[0] = self.offset; bytes[1] = self.length; let len = self.length as usize; bytes[2..2 + len].copy_from_slice(&self.value_buf[..len]); 2 + len } /// Builder for [ConfigData]. /// /// The controller allows us to write any _contiguous_ portion of the [ConfigData] structure in /// [`write_config_data`](Commands::write_config_data). The builder associated functions allow /// us to start with any field, and the returned builder allows only either chaining the next /// field or building the structure to write. pub fn public_address(addr: hci::BdAddr) -> ConfigDataDiversifierBuilder { let mut data = ConfigData { offset: 0, length: 6, value_buf: [0; Self::MAX_LENGTH], }; data.value_buf[0..6].copy_from_slice(&addr.0); ConfigDataDiversifierBuilder { data } } /// Builder for [ConfigData]. /// /// The controller allows us to write any _contiguous_ portion of the [ConfigData] structure in /// [`write_config_data`](Commands::write_config_data). The builder associated functions allow /// us to start with any field, and the returned builder allows only either chaining the next /// field or building the structure to write. pub fn diversifier(d: u16) -> ConfigDataEncryptionRootBuilder { let mut data = ConfigData { offset: 6, length: 2, value_buf: [0; Self::MAX_LENGTH], }; LittleEndian::write_u16(&mut data.value_buf[0..2], d); ConfigDataEncryptionRootBuilder { data } } /// Builder for [ConfigData]. /// /// The controller allows us to write any _contiguous_ portion of the [ConfigData] structure in /// [`write_config_data`](Commands::write_config_data). The builder associated functions allow /// us to start with any field, and the returned builder allows only either chaining the next /// field or building the structure to write. pub fn encryption_root(key: hci::host::EncryptionKey) -> ConfigDataIdentityRootBuilder { let mut data = ConfigData { offset: 8, length: 16, value_buf: [0; Self::MAX_LENGTH], }; data.value_buf[0..16].copy_from_slice(&key.0); ConfigDataIdentityRootBuilder { data } } /// Builder for [ConfigData]. /// /// The controller allows us to write any _contiguous_ portion of the [ConfigData] structure in /// [`write_config_data`](Commands::write_config_data). The builder associated functions allow /// us to start with any field, and the returned builder allows only either chaining the next /// field or building the structure to write. pub fn identity_root(key: hci::host::EncryptionKey) -> ConfigDataLinkLayerOnlyBuilder { let mut data = ConfigData { offset: 24, length: 16, value_buf: [0; Self::MAX_LENGTH], }; data.value_buf[0..16].copy_from_slice(&key.0); ConfigDataLinkLayerOnlyBuilder { data } } /// Builder for [ConfigData]. /// /// The controller allows us to write any _contiguous_ portion of the [ConfigData] structure in /// [`write_config_data`](Commands::write_config_data). The builder associated functions allow /// us to start with any field, and the returned builder allows only either chaining the next /// field or building the structure to write. pub fn link_layer_only(ll_only: bool) -> ConfigDataRoleBuilder { let mut data = ConfigData { offset: 40, length: 1, value_buf: [0; Self::MAX_LENGTH], }; data.value_buf[0] = ll_only as u8; ConfigDataRoleBuilder { data } } /// Builder for [ConfigData]. /// /// The controller allows us to write any _contiguous_ portion of the [ConfigData] structure in /// [`write_config_data`](Commands::write_config_data). The builder associated functions allow /// us to start with any field, and the returned builder allows only either chaining the next /// field or building the structure to write. pub fn role(role: Role) -> ConfigDataCompleteBuilder { let mut data = ConfigData { offset: 41, length: 1, value_buf: [0; Self::MAX_LENGTH], }; data.value_buf[0] = role as u8; ConfigDataCompleteBuilder { data } } } /// Builder for [ConfigData]. pub struct ConfigDataDiversifierBuilder { data: ConfigData, } impl ConfigDataDiversifierBuilder { /// Specify the diversifier and continue building. pub fn diversifier(mut self, d: u16) -> ConfigDataEncryptionRootBuilder { let len = self.data.length as usize; LittleEndian::write_u16(&mut self.data.value_buf[len..2 + len], d); self.data.length += 2; ConfigDataEncryptionRootBuilder { data: self.data } } /// Build the [ConfigData] as-is. It includes only the public address. pub fn build(self) -> ConfigData { self.data } } /// Builder for [ConfigData]. pub struct ConfigDataEncryptionRootBuilder { data: ConfigData, } impl ConfigDataEncryptionRootBuilder { /// Specify the encryption root and continue building. pub fn encryption_root( mut self, key: hci::host::EncryptionKey, ) -> ConfigDataIdentityRootBuilder { let len = self.data.length as usize; self.data.value_buf[len..16 + len].copy_from_slice(&key.0); self.data.length += 16; ConfigDataIdentityRootBuilder { data: self.data } } /// Build the [ConfigData] as-is. It includes the diversifier, and may include fields before it, /// but does not include any fields after it (including the encryption root). pub fn build(self) -> ConfigData { self.data } } /// Builder for [ConfigData]. pub struct ConfigDataIdentityRootBuilder { data: ConfigData, } impl ConfigDataIdentityRootBuilder { /// Specify the identity root and continue building. pub fn identity_root( mut self, key: hci::host::EncryptionKey, ) -> ConfigDataLinkLayerOnlyBuilder { let len = self.data.length as usize; self.data.value_buf[len..16 + len].copy_from_slice(&key.0); self.data.length += 16; ConfigDataLinkLayerOnlyBuilder { data: self.data } } /// Build the [ConfigData] as-is. It includes the encryption root, and may include fields before /// it, but does not include any fields after it (including the identity root). pub fn build(self) -> ConfigData { self.data } } /// Builder for [ConfigData]. pub struct ConfigDataLinkLayerOnlyBuilder { data: ConfigData, } impl ConfigDataLinkLayerOnlyBuilder { /// Specify whether to use the link layer only and continue building. pub fn link_layer_only(mut self, ll_only: bool) -> ConfigDataRoleBuilder { self.data.value_buf[self.data.length as usize] = ll_only as u8; self.data.length += 1; ConfigDataRoleBuilder { data: self.data } } /// Build the [ConfigData] as-is. It includes the identity root, and may include fields before /// it, but does not include any fields after it (including the link layer only flag). pub fn build(self) -> ConfigData { self.data } } /// Builder for [ConfigData]. pub struct ConfigDataRoleBuilder { data: ConfigData, } impl ConfigDataRoleBuilder { /// Specify the device role and continue building. pub fn role(mut self, role: Role) -> ConfigDataCompleteBuilder { self.data.value_buf[self.data.length as usize] = role as u8; self.data.length += 1; ConfigDataCompleteBuilder { data: self.data } } /// Build the [ConfigData] as-is. It includes the link layer only flag, and may include fields /// before it, but does not include any fields after it (including the role). pub fn build(self) -> ConfigData { self.data } } /// Builder for [ConfigData]. pub struct ConfigDataCompleteBuilder { data: ConfigData, } impl ConfigDataCompleteBuilder { /// Build the [ConfigData] as-is. It includes the role field, and may include fields before it. pub fn build(self) -> ConfigData { self.data } } /// Roles that the server can adopt. #[repr(u8)] pub enum Role { /// Peripheral and primary device. /// - Only one connection. /// - 6 KB of RAM retention. Peripheral6Kb = 1, /// Peripheral and primary device. /// - Only one connection. /// - 12 KB of RAM retention. Peripheral12Kb = 2, /// Primary device and peripheral /// - Up to 8 connections /// - 12 KB of RAM retention Primary12Kb = 3, /// Primary device and peripheral. /// - Simultaneous advertising and scanning /// - Up to 4 connections /// - This mode is available starting from BlueNRG-MS FW stack version 7.1.b SimultaneousAdvertisingScanning = 4, } /// Configuration parameters that are readable by the /// [`read_config_data`](Commands::read_config_data) command. #[repr(u8)] pub enum ConfigParameter { /// Bluetooth public address. PublicAddress = 0, /// Diversifier used to derive CSRK (connection signature resolving key). Diversifier = 6, /// Encryption root key used to derive the LTK (long-term key) and CSRK (connection signature /// resolving key). EncryptionRoot = 8, /// Identity root key used to derive the LTK (long-term key) and CSRK (connection signature /// resolving key). IdentityRoot = 24, /// Switch on/off Link Layer only mode. LinkLayerOnly = 40, /// BlueNRG-MS roles and mode configuration. Role = 41, } /// Transmitter power levels available for the system. /// /// The controller uses two parameters to determine the actual power level: enable high power, and /// PA level. This enum combines the two parameters. The high byte is the PA level; the low byte is /// the enable high power flag. #[repr(u16)] pub enum PowerLevel { /// PA level 0, low power. DbmNeg18 = 0x000, /// PA level 0, high power. DbmNeg15 = 0x001, /// PA level 1, low power. DbmNeg14_7 = 0x100, /// PA level 1, high power. DbmNeg11_7 = 0x101, /// PA level 2, low power. DbmNeg11_4 = 0x200, /// PA level 2, high power. DbmNeg8_4 = 0x201, /// PA level 3, low power. DbmNeg8_1 = 0x300, /// PA level 3, high power. DbmNeg5_1 = 0x301, /// PA level 4, low power. DbmNeg4_9 = 0x400, /// PA level 4, high power. DbmNeg2_1 = 0x401, /// PA level 5, low power. DbmNeg1_6 = 0x500, /// PA level 5, high power. Dbm1_4 = 0x501, /// PA level 6, low power. Dbm1_7 = 0x600, /// PA level 6, high power. Dbm4_7 = 0x601, /// PA level 7, low power. Dbm5_0 = 0x700, /// PA level 7, high power. Dbm8_0 = 0x701, }