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 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
//! A Bluetooth implementation for embedded systems. //! //! This crate is a proof-of-concept implementation of the host (application) side of the //! [`Bluetooth`] specification. It is still woefully incomplete, and will undoubtedly be redesigned //! completely, and potentially split into multiple crates before being stabilized. //! //! When the documentation refers to a specific section of "the" Bluetooth specification, the same //! section applies for all supported versions of the specification. If the versions differ, the //! specific version will also be included in the reference. //! //! # Design //! //! Like other core embedded crates (e.g, [`embedded-hal`]), this crate uses traits to be agnostic //! about the specific Bluetooth module. It provides a default implementation of the HCI for devices //! that implement the core [`Controller`] trait. The traits also make use of the [`nb`] crate to //! support different asynchronous or synchronous operation modes. //! //! ## Commands //! //! The [`host::Hci`] trait defines all of the functions that communicate from the host to the //! controller. The [`host::uart::Hci`] trait defines a read function that returns a //! [`host::uart::Packet`], which can contain an [`Event`], `AclData` (TODO), or `SyncData` //! (TODO). Both of these traits have default implementations in terms of the [`Controller`], so //! calling code does not need to implement any commands or event parsing code. //! //! ## Vendor-specific commands and events //! //! The [`host::uart::Hci`] trait requires specialization for the type of vendor-specific events //! (which implement [`event::VendorEvent`]) and vendor-specific errors. Any vendor-specific //! extensions will need to convert byte buffers into the appropriate event type (as defined by the //! vendor), but will not need to read data using the [`Controller`]. The Bluetooth standard //! provides packet length in a common header, so only complete packets will be passed on to the //! vendor code for deserialization. //! //! There is not yet support for vendor-specific commands. The vendor crate will have to serialize //! the command packets directly and write them to the [`Controller`]. //! //! # Reference implementation //! //! The [`bluenrg`] crate provides a sample implementation for STMicro's BlueNRG Bluetooth //! controllers. //! //! # Ideas for discussion and improvement //! //! - Add traits to facilitate writing Bluetooth controllers. These controllers would have a host on //! one side and a link layer on the other. Separate crate? If so, move common definitions (Status //! codes, opcodes, etc.) to a bluetooth-core crate. //! //! - Add a helper function for vendor-specific commands. This should take care of creating the //! header and writing the data to the [`Controller`]. Vendor code should only be responsible for //! serializing commands into byte slices. //! //! - Remove the `cmd_link` and `event_link` modules, and merge `uart` up into `host`. The Bluetooth //! spec made it seem like there were devices that do not include the packet type byte at the //! beginning of packets, but STMicro's BlueNRG implementation and Nordic's Zephyr implementation //! both include it. If there is a controller that does *not* include the packet type, the //! `event_link` HCI can always be brought back. //! //! - Provide config features for different versions of the Bluetooth Specification. //! //! - Implement all of the specified functions and events. //! //! - Provide opt-in config features for certain types of commands and events. For example, BlueNRG //! devices only implement 40 commands and 14 events, but the spec has around 250 commands and 76 //! events. It would be nice if unused events could be compiled out. This would be less important //! for commands, since those functions would simply never be called, and could be removed by the //! linker. This would entail significant work both on the part of the crate authors and on crate //! users, who would need to configure the crate appropriately. All combinations of features would //! also never be tested; there are simply too many, even if we only provide features for the //! events. On the other hand, those features should not interact, so maybe it would be feasible. //! //! [`Bluetooth`]: https://www.bluetooth.com/specifications/bluetooth-core-specification //! [`embedded-hal`]: https://crates.io/crates/embedded-hal //! [`nb`]: https://crates.io/crates/nb //! [`bluenrg`]: https://github.com/danielgallagher0/bluenrg #![no_std] #![deny(missing_docs)] #[macro_use] extern crate bitflags; extern crate byteorder; extern crate nb; #[macro_use] mod bitflag_array; pub mod event; pub mod host; mod opcode; pub mod types; pub use event::Event; pub use opcode::Opcode; use core::convert::TryFrom; use core::fmt::Debug; /// Interface to the Bluetooth controller from the host's perspective. /// /// The Bluetooth application host must communicate with a controller (which, in turn, communicates /// with the link layer) to control the Bluetooth radio. Device crates must implement this trait, /// which enables full access to all of the functions and events of the HCI through [`host::Hci`] /// and [`host::uart::Hci`], respectively. pub trait Controller { /// Enumeration of [`Controller`] errors. These typically will be specializations of /// [`host::uart::Error`] that specify both the vendor-specific error type _and_ a communication /// error type. The communication error type in turn will depend on the bus used to communicate /// with the controller as well as the device crate (e.g., [`linux-embedded-hal::Spidev`] uses /// [`std::io::Error`]). /// /// [`linux-embedded-hal::Spidev`]: /// https://docs.rs/linux-embedded-hal/0.1.1/linux_embedded_hal/struct.Spidev.html /// [`std::io::Error`]: https://doc.rust-lang.org/nightly/std/io/struct.Error.html type Error; /// The type of header sent to the controller for HCI commands. Should be either /// [`host::uart::CommandHeader`], [`host::cmd_link::Header`], or /// [`host::event_link::NoCommands`], depending on the controller implementation. type Header; /// Type containing vendor-specific extensions for the controller, including vendor-specific /// errors, events, and status codes. type Vendor: Vendor; /// Writes the bytes to the controller, in a single transaction if possible. All of `header` /// shall be written, followed by all of `payload`. `write` is allowed to block internally, but /// should return [`nb::Error::WouldBlock`] if the controller is not ready to receive the data. fn write(&mut self, header: &[u8], payload: &[u8]) -> nb::Result<(), Self::Error>; /// Reads data from the controller into the provided `buffer`. The length of the buffer /// indicates the number of bytes to read. The implementor must not return bytes in an order /// different from that in which they were received from the controller. For example, the /// implementor may read all available bytes from the controller and maintain them in an /// internal buffer, but `read_into` shall only read the number of bytes requested. /// /// # Example /// /// ``` /// // Controller sends: /// // +------+------+------+------+------+------+------+------+ /// // | 0x12 | 0x34 | 0x56 | 0x78 | 0x9a | 0xbc | 0xde | 0xf0 | /// // +------+------+------+------+------+------+------+------+ /// /// // host calls: /// /// # extern crate nb; /// # extern crate bluetooth_hci; /// # use bluetooth_hci::Controller as HciController; /// # struct Controller; /// # struct Error; /// # struct Header; /// # struct Vendor; /// # impl bluetooth_hci::Vendor for Vendor { /// # type Status = VendorStatus; /// # type Event = VendorEvent; /// # } /// # #[derive(Clone, Debug)] /// # struct VendorStatus; /// # impl std::convert::TryFrom<u8> for VendorStatus { /// # type Error = bluetooth_hci::BadStatusError; /// # fn try_from(value: u8) -> Result<VendorStatus, Self::Error> { /// # Err(bluetooth_hci::BadStatusError::BadValue(value)) /// # } /// # } /// # impl std::convert::Into<u8> for VendorStatus { /// # fn into(self) -> u8 { /// # 0 /// # } /// # } /// # struct VendorEvent; /// # impl bluetooth_hci::event::VendorEvent for VendorEvent { /// # type Error = Error; /// # type Status = VendorStatus; /// # type ReturnParameters = ReturnParameters; /// # fn new(_buffer: &[u8]) -> Result<Self, bluetooth_hci::event::Error<Self::Error>> /// # where /// # Self: Sized /// # { /// # Ok(VendorEvent{}) /// # } /// # } /// # #[derive(Clone, Debug)] /// # struct ReturnParameters; /// # impl bluetooth_hci::event::VendorReturnParameters for ReturnParameters { /// # type Error = Error; /// # fn new(_buffer: &[u8]) -> Result<Self, bluetooth_hci::event::Error<Self::Error>> { /// # Ok(ReturnParameters{}) /// # } /// # } /// # impl HciController for Controller { /// # type Error = Error; /// # type Header = Header; /// # type Vendor = Vendor; /// # fn write(&mut self, _header: &[u8], _payload: &[u8]) -> nb::Result<(), Self::Error> { /// # Ok(()) /// # } /// # fn read_into(&mut self, _buffer: &mut [u8]) -> nb::Result<(), Self::Error> { /// # Ok(()) /// # } /// # fn peek(&mut self, _n: usize) -> nb::Result<u8, Self::Error> { /// # Ok(0) /// # } /// # } /// # fn main() { /// # let mut controller = Controller; /// let mut buffer = [0; 4]; /// controller.read_into(&mut buffer[1..]); // read 3 bytes into buffer[1..] /// /// // buffer contains: /// // +------+------+------+------+ /// // | 0x00 | 0x12 | 0x34 | 0x56 | /// // +------+------+------+------+ /// /// // now the host calls: /// controller.read_into(&mut buffer); // read 4 bytes into buffer /// /// // buffer contains: /// // +------+------+------+------+ /// // | 0x78 | 0x9a | 0xbc | 0xde | /// // +------+------+------+------+ /// # } /// ``` /// If the next call to `read_into` requests more than 1 byte, the controller may return /// [`nb::Error::WouldBlock`], or may attempt to read more data from the controller. If not /// enough data is available from the controller, the implementor shall return /// [`nb::Error::WouldBlock`]. fn read_into(&mut self, buffer: &mut [u8]) -> nb::Result<(), Self::Error>; /// Looks ahead at the data coming from the Controller without consuming it. Implementors should /// be able to support values of `n` up to 5 to support all potential data types. /// /// `peek(0)` will typically be used to the the packet type (see Bluetooth Spec, Vol 4, Part A, /// Section 2), which will be followed by another peek to determine the amount of data to /// read. For example, the code to read an HCI event looks like this: /// /// ``` /// # extern crate nb; /// # extern crate bluetooth_hci; /// # use bluetooth_hci::Controller as HciController; /// # struct Controller; /// # #[derive(Debug)] /// # struct Error; /// # struct Header; /// # struct Vendor; /// # impl bluetooth_hci::Vendor for Vendor { /// # type Status = VendorStatus; /// # type Event = VendorEvent; /// # } /// # #[derive(Clone, Debug)] /// # struct VendorStatus; /// # impl std::convert::TryFrom<u8> for VendorStatus { /// # type Error = bluetooth_hci::BadStatusError; /// # fn try_from(value: u8) -> Result<VendorStatus, Self::Error> { /// # Err(bluetooth_hci::BadStatusError::BadValue(value)) /// # } /// # } /// # impl std::convert::Into<u8> for VendorStatus { /// # fn into(self) -> u8 { /// # 0 /// # } /// # } /// # struct VendorEvent; /// # impl bluetooth_hci::event::VendorEvent for VendorEvent { /// # type Error = Error; /// # type Status = VendorStatus; /// # type ReturnParameters = ReturnParameters; /// # fn new(_buffer: &[u8]) -> Result<Self, bluetooth_hci::event::Error<Self::Error>> /// # where /// # Self: Sized /// # { /// # Ok(VendorEvent{}) /// # } /// # } /// # #[derive(Clone, Debug)] /// # struct ReturnParameters; /// # impl bluetooth_hci::event::VendorReturnParameters for ReturnParameters { /// # type Error = Error; /// # fn new(_buffer: &[u8]) -> Result<Self, bluetooth_hci::event::Error<Self::Error>> { /// # Ok(ReturnParameters{}) /// # } /// # } /// # impl HciController for Controller { /// # type Error = Error; /// # type Header = Header; /// # type Vendor = Vendor; /// # fn write(&mut self, _header: &[u8], _payload: &[u8]) -> nb::Result<(), Self::Error> { /// # Ok(()) /// # } /// # fn read_into(&mut self, _buffer: &mut [u8]) -> nb::Result<(), Self::Error> { /// # Ok(()) /// # } /// # fn peek(&mut self, _n: usize) -> nb::Result<u8, Self::Error> { /// # Ok(0) /// # } /// # } /// # fn main() -> nb::Result<(), Error> { /// # const PACKET_TYPE_HCI_EVENT: u8 = 4; /// # let mut controller = Controller; /// const MAX_EVENT_LENGTH: usize = 255; /// const HEADER_LENGTH: usize = 2; /// let mut buffer = [0; MAX_EVENT_LENGTH + HEADER_LENGTH]; /// let packet_type = controller.peek(0)?; /// if packet_type == PACKET_TYPE_HCI_EVENT { /// // Byte 3 has the parameter length in HCI events /// let param_len = controller.peek(3)? as usize; /// /// // We want to consume the full HCI Event packet, and we now know the length. /// controller.read_into(&mut buffer[..HEADER_LENGTH + param_len])?; /// } /// # Ok(()) /// # } /// ``` fn peek(&mut self, n: usize) -> nb::Result<u8, Self::Error>; } /// Trait defining vendor-specific extensions for the Bluetooth Controller. pub trait Vendor { /// Enumeration of vendor-specific status codes. type Status: TryFrom<u8, Error = BadStatusError> + Into<u8> + Clone + Debug; /// Enumeration of vendor-specific events. type Event: event::VendorEvent; } /// List of possible error codes, Bluetooth Spec, Vol 2, Part D, Section 2. /// /// Includes an extension point for vendor-specific status codes. #[derive(Copy, Clone, Debug, PartialEq)] pub enum Status<V> { /// Success Success, /// Unknown HCI Command UnknownCommand, /// Unknown Connection Identifier UnknownConnectionId, /// Hardware Failure HardwareFailure, /// Page Timeout PageTimeout, /// Authentication Failure AuthFailure, /// PIN or Key Missing PinOrKeyMissing, /// Memory Capacity Exceeded OutOfMemory, /// Connection Timeout ConnectionTimeout, /// Connection Limit Exceeded ConnectionLimitExceeeded, /// Synchronous Connection Limit To A Device Exceeded SyncConnectionLimitExceeded, /// Connection Already Exists ConnectionAlreadyExists, /// Command Disallowed CommandDisallowed, /// Connection Rejected due to Limited Resources LimitedResources, /// Connection Rejected Due To Security Reasons ConnectionRejectedSecurity, /// Connection Rejected due to Unacceptable BD_ADDR UnacceptableBdAddr, /// Connection Accept Timeout Exceeded AcceptTimeoutExceeded, /// Unsupported Feature or Parameter Value UnsupportedFeature, /// Invalid HCI Command Parameters InvalidParameters, /// Remote User Terminated Connection RemoteTerminationByUser, /// Remote Device Terminated Connection due to Low Resources RemoteTerminationLowResources, /// Remote Device Terminated Connection due to Power Off RemoteTerminationPowerOff, /// Connection Terminated By Local Host ConnectionTerminatedByHost, /// Repeated Attempts RepeatedAttempts, /// Pairing Not Allowed PairingNotAllowed, /// Unknown LMP PDU UnknownLmpPdu, /// Unsupported Remote Feature / Unsupported LMP Feature UnsupportedRemoteFeature, /// SCO Offset Rejected ScoOffsetRejected, /// SCO Interval Rejected ScoIntervalRejected, /// SCO Air Mode Rejected ScoAirModeRejected, /// Invalid LMP Parameters / Invalid LL Parameters InvalidLmpParameters, /// Unspecified Error UnspecifiedError, /// Unsupported LMP Parameter Value / Unsupported LL Parameter Value UnsupportedLmpParameterValue, /// Role Change Not Allowed RoleChangeNotAllowed, /// LMP Response Timeout / LL Response Timeout LmpResponseTimeout, /// LMP Error Transaction Collision / LL Procedure Collision LmpTransactionCollision, /// LMP PDU Not Allowed LmpPduNotAllowed, /// Encryption Mode Not Acceptable EncryptionModeNotAcceptable, /// Link Key cannot be Changed LinkKeyCannotBeChanged, /// Requested QoS Not Supported RequestedQosNotSupported, /// Instant Passed InstantPassed, /// Pairing With Unit Key Not Supported PairingWithUnitKeyNotSupported, /// Different Transaction Collision DifferentTransactionCollision, /// Reserved for Future Use ReservedforFutureUse, /// QoS Unacceptable Parameter QosUnacceptableParameter, /// QoS Rejected QosRejected, /// Channel Classification Not Supported ChannelClassificationNotSupported, /// Insufficient Security InsufficientSecurity, /// Parameter Out Of Mandatory Range ParameterOutOfMandatoryRange, /// Reserved for Future Use ReservedForFutureUse49, /// Role Switch Pending RoleSwitchPending, /// Reserved for Future Use ReservedForFutureUse51, /// Reserved Slot Violation ReservedSlotViolation, /// Role Switch Failed RoleSwitchFailed, /// Extended Inquiry Response Too Large ExtendedInquiryResponseTooLarge, /// Secure Simple Pairing Not Supported By Host SecureSimplePairingNotSupportedByHost, /// Host Busy - Pairing HostBusyPairing, /// Connection Rejected due to No Suitable Channel Found ConnectionRejectedNoSuitableChannel, /// Controller Busy ControllerBusy, /// Unacceptable Connection Parameters UnacceptableConnectionParameters, /// Advertising Timeout AdvertisingTimeout, /// Connection Terminated due to MIC Failure ConnectionTerminatedMicFailure, /// Connection Failed to be Established ConnectionFailedToEstablish, /// MAC Connection Failed MacConnectionFailed, /// Coarse Clock Adjustment Rejected but Will Try to Adjust Using Clock Dragging CoarseClockAdjustmentRejectedDraggingAttempted, #[cfg(feature = "version-5-0")] /// Type0 Submap Not Defined /// /// First introduced in version 5.0 Type0SubmapNotDefined, #[cfg(feature = "version-5-0")] /// Unknown Advertising Identifier /// /// First introduced in version 5.0 UnknownAdvertisingId, #[cfg(feature = "version-5-0")] /// Limit Reached /// /// First introduced in version 5.0 LimitReached, #[cfg(feature = "version-5-0")] /// Operation Cancelled by Host /// /// First introduced in version 5.0 OperationCancelledByHost, /// Vendor-specific status code Vendor(V), } /// Wrapper enum for errors converting a u8 into a [`Status`]. pub enum BadStatusError { /// The value does not map to a [`Status`]. BadValue(u8), } impl<V> core::convert::TryFrom<u8> for Status<V> where V: core::convert::TryFrom<u8>, { type Error = V::Error; fn try_from(value: u8) -> Result<Status<V>, Self::Error> { match value { 0x00 => Ok(Status::Success), 0x01 => Ok(Status::UnknownCommand), 0x02 => Ok(Status::UnknownConnectionId), 0x03 => Ok(Status::HardwareFailure), 0x04 => Ok(Status::PageTimeout), 0x05 => Ok(Status::AuthFailure), 0x06 => Ok(Status::PinOrKeyMissing), 0x07 => Ok(Status::OutOfMemory), 0x08 => Ok(Status::ConnectionTimeout), 0x09 => Ok(Status::ConnectionLimitExceeeded), 0x0A => Ok(Status::SyncConnectionLimitExceeded), 0x0B => Ok(Status::ConnectionAlreadyExists), 0x0C => Ok(Status::CommandDisallowed), 0x0D => Ok(Status::LimitedResources), 0x0E => Ok(Status::ConnectionRejectedSecurity), 0x0F => Ok(Status::UnacceptableBdAddr), 0x10 => Ok(Status::AcceptTimeoutExceeded), 0x11 => Ok(Status::UnsupportedFeature), 0x12 => Ok(Status::InvalidParameters), 0x13 => Ok(Status::RemoteTerminationByUser), 0x14 => Ok(Status::RemoteTerminationLowResources), 0x15 => Ok(Status::RemoteTerminationPowerOff), 0x16 => Ok(Status::ConnectionTerminatedByHost), 0x17 => Ok(Status::RepeatedAttempts), 0x18 => Ok(Status::PairingNotAllowed), 0x19 => Ok(Status::UnknownLmpPdu), 0x1A => Ok(Status::UnsupportedRemoteFeature), 0x1B => Ok(Status::ScoOffsetRejected), 0x1C => Ok(Status::ScoIntervalRejected), 0x1D => Ok(Status::ScoAirModeRejected), 0x1E => Ok(Status::InvalidLmpParameters), 0x1F => Ok(Status::UnspecifiedError), 0x20 => Ok(Status::UnsupportedLmpParameterValue), 0x21 => Ok(Status::RoleChangeNotAllowed), 0x22 => Ok(Status::LmpResponseTimeout), 0x23 => Ok(Status::LmpTransactionCollision), 0x24 => Ok(Status::LmpPduNotAllowed), 0x25 => Ok(Status::EncryptionModeNotAcceptable), 0x26 => Ok(Status::LinkKeyCannotBeChanged), 0x27 => Ok(Status::RequestedQosNotSupported), 0x28 => Ok(Status::InstantPassed), 0x29 => Ok(Status::PairingWithUnitKeyNotSupported), 0x2A => Ok(Status::DifferentTransactionCollision), 0x2B => Ok(Status::ReservedforFutureUse), 0x2C => Ok(Status::QosUnacceptableParameter), 0x2D => Ok(Status::QosRejected), 0x2E => Ok(Status::ChannelClassificationNotSupported), 0x2F => Ok(Status::InsufficientSecurity), 0x30 => Ok(Status::ParameterOutOfMandatoryRange), 0x31 => Ok(Status::ReservedForFutureUse49), 0x32 => Ok(Status::RoleSwitchPending), 0x33 => Ok(Status::ReservedForFutureUse51), 0x34 => Ok(Status::ReservedSlotViolation), 0x35 => Ok(Status::RoleSwitchFailed), 0x36 => Ok(Status::ExtendedInquiryResponseTooLarge), 0x37 => Ok(Status::SecureSimplePairingNotSupportedByHost), 0x38 => Ok(Status::HostBusyPairing), 0x39 => Ok(Status::ConnectionRejectedNoSuitableChannel), 0x3A => Ok(Status::ControllerBusy), 0x3B => Ok(Status::UnacceptableConnectionParameters), 0x3C => Ok(Status::AdvertisingTimeout), 0x3D => Ok(Status::ConnectionTerminatedMicFailure), 0x3E => Ok(Status::ConnectionFailedToEstablish), 0x3F => Ok(Status::MacConnectionFailed), 0x40 => Ok(Status::CoarseClockAdjustmentRejectedDraggingAttempted), 0x41 => { #[cfg(feature = "version-5-0")] { Ok(Status::Type0SubmapNotDefined) } #[cfg(not(feature = "version-5-0"))] { Ok(Status::Vendor(V::try_from(value)?)) } } 0x42 => { #[cfg(feature = "version-5-0")] { Ok(Status::UnknownAdvertisingId) } #[cfg(not(feature = "version-5-0"))] { Ok(Status::Vendor(V::try_from(value)?)) } } 0x43 => { #[cfg(feature = "version-5-0")] { Ok(Status::LimitReached) } #[cfg(not(feature = "version-5-0"))] { Ok(Status::Vendor(V::try_from(value)?)) } } 0x44 => { #[cfg(feature = "version-5-0")] { Ok(Status::OperationCancelledByHost) } #[cfg(not(feature = "version-5-0"))] { Ok(Status::Vendor(V::try_from(value)?)) } } _ => Ok(Status::Vendor(V::try_from(value)?)), } } } impl<V> core::convert::Into<u8> for Status<V> where V: core::convert::Into<u8>, { fn into(self) -> u8 { match self { Status::Success => 0x00, Status::UnknownCommand => 0x01, Status::UnknownConnectionId => 0x02, Status::HardwareFailure => 0x03, Status::PageTimeout => 0x04, Status::AuthFailure => 0x05, Status::PinOrKeyMissing => 0x06, Status::OutOfMemory => 0x07, Status::ConnectionTimeout => 0x08, Status::ConnectionLimitExceeeded => 0x09, Status::SyncConnectionLimitExceeded => 0x0A, Status::ConnectionAlreadyExists => 0x0B, Status::CommandDisallowed => 0x0C, Status::LimitedResources => 0x0D, Status::ConnectionRejectedSecurity => 0x0E, Status::UnacceptableBdAddr => 0x0F, Status::AcceptTimeoutExceeded => 0x10, Status::UnsupportedFeature => 0x11, Status::InvalidParameters => 0x12, Status::RemoteTerminationByUser => 0x13, Status::RemoteTerminationLowResources => 0x14, Status::RemoteTerminationPowerOff => 0x15, Status::ConnectionTerminatedByHost => 0x16, Status::RepeatedAttempts => 0x17, Status::PairingNotAllowed => 0x18, Status::UnknownLmpPdu => 0x19, Status::UnsupportedRemoteFeature => 0x1A, Status::ScoOffsetRejected => 0x1B, Status::ScoIntervalRejected => 0x1C, Status::ScoAirModeRejected => 0x1D, Status::InvalidLmpParameters => 0x1E, Status::UnspecifiedError => 0x1F, Status::UnsupportedLmpParameterValue => 0x20, Status::RoleChangeNotAllowed => 0x21, Status::LmpResponseTimeout => 0x22, Status::LmpTransactionCollision => 0x23, Status::LmpPduNotAllowed => 0x24, Status::EncryptionModeNotAcceptable => 0x25, Status::LinkKeyCannotBeChanged => 0x26, Status::RequestedQosNotSupported => 0x27, Status::InstantPassed => 0x28, Status::PairingWithUnitKeyNotSupported => 0x29, Status::DifferentTransactionCollision => 0x2A, Status::ReservedforFutureUse => 0x2B, Status::QosUnacceptableParameter => 0x2C, Status::QosRejected => 0x2D, Status::ChannelClassificationNotSupported => 0x2E, Status::InsufficientSecurity => 0x2F, Status::ParameterOutOfMandatoryRange => 0x30, Status::ReservedForFutureUse49 => 0x31, Status::RoleSwitchPending => 0x32, Status::ReservedForFutureUse51 => 0x33, Status::ReservedSlotViolation => 0x34, Status::RoleSwitchFailed => 0x35, Status::ExtendedInquiryResponseTooLarge => 0x36, Status::SecureSimplePairingNotSupportedByHost => 0x37, Status::HostBusyPairing => 0x38, Status::ConnectionRejectedNoSuitableChannel => 0x39, Status::ControllerBusy => 0x3A, Status::UnacceptableConnectionParameters => 0x3B, Status::AdvertisingTimeout => 0x3C, Status::ConnectionTerminatedMicFailure => 0x3D, Status::ConnectionFailedToEstablish => 0x3E, Status::MacConnectionFailed => 0x3F, Status::CoarseClockAdjustmentRejectedDraggingAttempted => 0x40, _ => { #[cfg(feature = "version-5-0")] { match self { Status::Type0SubmapNotDefined => 0x41, Status::UnknownAdvertisingId => 0x42, Status::LimitReached => 0x43, Status::OperationCancelledByHost => 0x44, Status::Vendor(v) => v.into(), _ => 0xFF, } } #[cfg(not(feature = "version-5-0"))] { if let Status::Vendor(v) = self { v.into() } else { 0xFF } } } } } } /// Newtype for a connection handle. #[derive(Clone, Copy, Debug, PartialEq)] pub struct ConnectionHandle(pub u16); /// Newtype for BDADDR. #[derive(Copy, Clone, Debug, PartialEq)] pub struct BdAddr(pub [u8; 6]); /// Potential values for BDADDR #[derive(Copy, Clone, Debug, PartialEq)] pub enum BdAddrType { /// Public address. Public(BdAddr), /// Random address. Random(BdAddr), } impl BdAddrType { /// Writes a `BdAddrType` into the given slice. The slice must be exactly the right length (7 /// bytes). pub fn copy_into_slice(&self, bytes: &mut [u8]) { assert_eq!(bytes.len(), 7); match *self { BdAddrType::Public(addr) => { bytes[0] = 0; bytes[1..7].copy_from_slice(&addr.0); } BdAddrType::Random(addr) => { bytes[0] = 1; bytes[1..7].copy_from_slice(&addr.0); } } } } /// The BD Address type is not recognized. Includes the unrecognized byte. /// /// See [`to_bd_addr_type`] pub struct BdAddrTypeError(pub u8); /// Wraps a [`BdAddr`] in a [`BdAddrType`]. /// /// # Errors /// /// - `bd_addr_type` does not denote an appropriate type. Returns the byte. The address is /// discarded. pub fn to_bd_addr_type(bd_addr_type: u8, addr: BdAddr) -> Result<BdAddrType, BdAddrTypeError> { match bd_addr_type { 0 => Ok(BdAddrType::Public(addr)), 1 => Ok(BdAddrType::Random(addr)), _ => Err(BdAddrTypeError(bd_addr_type)), } } bitflags! { /// Bitfield for LE Remote Features. /// /// Fields are defined in Vol 6, Part B, Section 4.6 of the spec. See Table 4.3 (version 4.1) /// or Table 4.4 (version 4.2 and 5.0). #[derive(Default)] pub struct LinkLayerFeature : u64 { /// See section 4.6.1 const LE_ENCRYPTION = 1 << 0; /// See section 4.6.2 const CONNECTION_PARAMETERS_REQUEST_PROCEDURE = 1 << 1; /// See section 4.6.3 const EXTENDED_REJECT_INDICATION = 1 << 2; /// See section 4.6.4 const PERIPHERAL_INITIATED_FEATURES_EXCHANGE = 1 << 3; /// See section 4.6.5 const LE_PING = 1 << 4; /// See section 4.6.6 #[cfg(any(feature = "version-4-2", feature = "version-5-0"))] const LE_DATA_PACKET_LENGTH_EXTENSION = 1 << 5; /// See section 4.6.7 #[cfg(any(feature = "version-4-2", feature = "version-5-0"))] const LL_PRIVACY = 1 << 6; /// See section 4.6.8 #[cfg(any(feature = "version-4-2", feature = "version-5-0"))] const EXTENDED_SCANNER_FILTER_POLICIES = 1 << 7; /// See section 4.6.9 #[cfg(feature = "version-5-0")] const LE_2M_PHY = 1 << 8; /// See section 4.6.10 #[cfg(feature = "version-5-0")] const STABLE_MODULATION_INDEX_TX = 1 << 9; /// See section 4.6.11 #[cfg(feature = "version-5-0")] const STABLE_MODULATION_INDEX_RX = 1 << 10; /// Not in section 4.6 #[cfg(feature = "version-5-0")] const LE_CODED_PHY = 1 << 11; /// See section 4.6.12 #[cfg(feature = "version-5-0")] const LE_EXTENDED_ADVERTISING = 1 << 12; /// See section 4.6.13 #[cfg(feature = "version-5-0")] const LE_PERIODIC_ADVERTISING = 1 << 13; /// See section 4.6.14 #[cfg(feature = "version-5-0")] const CHANNEL_SELECTION_ALGORITHM_2 = 1 << 14; /// Not in section 4.6 #[cfg(feature = "version-5-0")] const LE_POWER_CLASS_1 = 1 << 15; /// See section 4.6.15 #[cfg(feature = "version-5-0")] const MINIMUM_NUMBER_OF_USED_CHANNELS_PROCEDURE = 1 << 16; } } bitflag_array! { /// Channel classifications for the LE Set Host Channel Classification command. /// /// If a flag is set, its classification is "Unknown". If the flag is cleared, it is known /// "bad". #[derive(Copy, Clone, Debug)] pub struct ChannelClassification : 5; pub struct ChannelFlag; /// Channel 0 classification not known. const CH_0 = 0, 1 << 0; /// Channel 1 classification not known. const CH_1 = 0, 1 << 1; /// Channel 2 classification not known. const CH_2 = 0, 1 << 2; /// Channel 3 classification not known. const CH_3 = 0, 1 << 3; /// Channel 4 classification not known. const CH_4 = 0, 1 << 4; /// Channel 5 classification not known. const CH_5 = 0, 1 << 5; /// Channel 6 classification not known. const CH_6 = 0, 1 << 6; /// Channel 7 classification not known. const CH_7 = 0, 1 << 7; /// Channel 8 classification not known. const CH_8 = 1, 1 << 0; /// Channel 9 classification not known. const CH_9 = 1, 1 << 1; /// Channel 10 classification not known. const CH_10 = 1, 1 << 2; /// Channel 11 classification not known. const CH_11 = 1, 1 << 3; /// Channel 12 classification not known. const CH_12 = 1, 1 << 4; /// Channel 13 classification not known. const CH_13 = 1, 1 << 5; /// Channel 14 classification not known. const CH_14 = 1, 1 << 6; /// Channel 15 classification not known. const CH_15 = 1, 1 << 7; /// Channel 16 classification not known. const CH_16 = 2, 1 << 0; /// Channel 17 classification not known. const CH_17 = 2, 1 << 1; /// Channel 18 classification not known. const CH_18 = 2, 1 << 2; /// Channel 19 classification not known. const CH_19 = 2, 1 << 3; /// Channel 20 classification not known. const CH_20 = 2, 1 << 4; /// Channel 21 classification not known. const CH_21 = 2, 1 << 5; /// Channel 22 classification not known. const CH_22 = 2, 1 << 6; /// Channel 23 classification not known. const CH_23 = 2, 1 << 7; /// Channel 24 classification not known. const CH_24 = 3, 1 << 0; /// Channel 25 classification not known. const CH_25 = 3, 1 << 1; /// Channel 26 classification not known. const CH_26 = 3, 1 << 2; /// Channel 27 classification not known. const CH_27 = 3, 1 << 3; /// Channel 28 classification not known. const CH_28 = 3, 1 << 4; /// Channel 29 classification not known. const CH_29 = 3, 1 << 5; /// Channel 30 classification not known. const CH_30 = 3, 1 << 6; /// Channel 31 classification not known. const CH_31 = 3, 1 << 7; /// Channel 32 classification not known. const CH_32 = 4, 1 << 0; /// Channel 33 classification not known. const CH_33 = 4, 1 << 1; /// Channel 34 classification not known. const CH_34 = 4, 1 << 2; /// Channel 35 classification not known. const CH_35 = 4, 1 << 3; /// Channel 36 classification not known. const CH_36 = 4, 1 << 4; }