IS187x_BM7x - BLEDK3 v1.01 Release Note

Transcription

1 IS187x_BM7x - BLEDK3 v1.01 Release Note page 1

2 Table of Contents Scope:... 4 ersion: v Bugs fixed... 4 Enhancements & New Features... 4 Known Bugs & Limitations Applications BLE UART Transparent BLE GATT Based Transceiver Beacon BeaconThings Software Architecture Service Table Design System Operation Structure of UI Parameter Build-in service Tables Standard GATT-Based Services ISSC Proprietary Services Support features Bluetooth Core Spec BLE capability GAP Roles Operation Modes and Procedures - LE Physical Transport Security - LE Physical Transport GATT Profile Enhanced BLE security function Configurable application parameter Beacon and BeaconThings BeaconThings Beacon Only Beacon Address Calculation Definition of GPIOs GPIO Functionality Dedicated Functional GPIOs System Configuration page 2

3 5.1.2 LED Indication (LED0/LED1) UART Data Transmit Indication (UART_TX_IND) Wake-up BLEDK3 from Shutdown State (WAKEUP_PIN) Configurable Functional GPIOs Status Indication (STATUS1_IND/ STATUS2_IND) UART Flow Control (UART_CTS/UART_RTS) Enable BLEDK3 Low Power Mode (UART_RX_IND) Force BLEDK3 Enter Into Standby Mode (PAIRING_KEY) Force BLEDK3 Terminate BLE Link (LINK_DROP) Low Battery oltage Indication (LOW_BATTERY_IND) Link Quality Indication (RSSI_IND) RF Active Indication (RX_ACTIE_IND) Host MCU Controllable GPIOs System timing Power on timing Reference: Document Tools Message sequence charts Procedure of System Initial Configuration Application State Machine Auto Pattern Manual Pattern Revision history page 3

4 Scope: This release notes describe supported software features for the BLEDK3 v1.0.0 release. ersion: v1.0.0 Release date: SN change Set: Bugs fixed N/A Enhancements & New Features - BLE UART Transparent - BLE GATT Based Transceiver - Beacon - BeaconThings Known Bugs & Limitations - Android Pairing issue: Android phone will initiate disconnect after pairing complete. - Settings: Issue happens when pairing method is not Just Work Devices: HTC M8, LG Nexus 5 Root cause: Unknown, still tracing page 4

5 1 APPLICATIONS 1.1 BLE UART Transparent The typical application is the Application (Host) MCU needs reliable BLE GATT transceiver to communication with Smart phones/ Tablet PC Apps. This BLE GATT transceiver is a virtual UART Cable between Apps and Host MCU. Host MCU does not need to care any BLE protocol BM70 (BLEDK3) Applicatio n MCU While BLEDK3 is a Peripheral Role, it can play as raw data changer between Host MCU and remote Central BLE device. It will package the received UART data as ATT packet send to remote device and vice versa. The data exchange protocol will go through Transparent Service that is BLEDK3 build in the proprietary service. From Host MCU view, it can send and receive the raw data by UART transport directly once the Transparent Service is enabled. Reliable Burst Transmit Property: Write and Notify attribute protocol are considered in Transparent Service to get the max data change throughput. But both attributes are not reliable data exchange protocol. Even BT4.1 spec had defined LE L2CAP Credit Based Flow Control spec, but ios and Android BLE frame work do not support it in present. In order to approach this property, a Proprietary Credit Based Flow Control Protocol is built in the BLEDK3. The measured max throughput between BLEDK3 and ios8 are around 8KBbye/sec if ios Apps implements this protocol. Application Scenario Notice: - Supported BLE Role: Peripheral/Server - Pattern: Auto Pattern - Relative GPIOs: UART_CTS, UART_RTS, UART_Rx_IND, UART_TX_IND - Relative Setting: UART Baud Rate, Flow Control, Transparent Service UUID 1.2 BLE GATT Based Transceiver The typical application is the Application (Host) MCU would like access more BLE GATT/GAP/Profiles control to approach the following application: - To play as BLE Broadcaster, Observer role. - To play as BLE Central/Client role. - To play as BLE Server role that meets the Bluetooth SIG standard GATT Profiles Spec. For example, Weight Scale Service/Profile, Heart Rate Service/Profile, Blood Pressure Service/Profile, Health Thermometer Service/Profile etc. page 5

6 - To access BLE transceivers (IS1870SF, BM70 etc.) hardware peripherals. For example, PWM output for LED or motor control. ADC input for sensor. Host MCU can do BLE GATT/GAP/Profiles control with BLEDK3 by proprietary UART commands. The GATT service tables can be added into Service Table Program memory area of BLEDK3. BLEDK3 UART App/GAP GATT Service GATT/SMP L2CAP RF/BB/LC Transparent HRS WSS ADC DIO PWM Application Scenario Notice: - Supported BLE Role: All - Pattern: Manual Pattern - Service Table: The add-on GATT Service Table can be edit by UI tool. - Only support peer to peer connection for central or peripheral role. 1.3 Beacon BLEDK3 can be configured as any kind of Beacon devices. Typically, Beacon devices always broadcast Non- Connectable AD packet. The content of broadcast can be configured by air updated. In order to manage Beacon devices by authorized administrator over the air, BLEDK3 provide an authentication scheme called Beacon Admin Service. See it more detail in the technical section. 1.4 BeaconThings BeaconThings is a concept to enhance user experience. The user just registers the BeaconThings accessories once in the APP during first time device paired procedure. And then almost no manual operation is needed, the BeaconThings accessories can be connected by ios device automatically. From technical view, the ibeacon function will be combined with other supported features like BLE UART Transparent or BLE GATT Based Transceiver in BLEDK3. And BLEDK3 will advertise ibeacon AD and connectable AD simultaneously in standby mode. There are 3 steps to approach the BeaconThings. And these steps will be executed in the background. - Launch APP: APP will be wake up due to the register monitored ibeacon AD received. - Automatic BLE connection: APP will scan the nearby peripherals with specific UUID and connect a suitable peripheral. - BLE communication: The BLE data can exchange between APP and BeaconThings accessories. page 6

7 2 SOFTWARE ARCHITECTURE 2.1 Service Table Design BLEDK3 operates as a GATT based bridge. All of standard or proprietary services can be append into BLEDK3 by UI tool editing. Maximum number of attribute list can be added is 100. GAP service, Device Information Service, Beacon Service, and proprietary transparent service are build-in as default services. 2.2 System Operation BLEDK3 operates on either auto pattern or manual pattern. For auto pattern, it only supports BLE Slave and buildin services. For manual pattern, it supports both BLE Master and BLE Slave by using UART protocol with MCU. And appended services only can operate in manual pattern. 2.3 Structure of UI Parameter FW reserves 8K bytes of eflash for UI parameter configuration. There s always existing Factory UI Table (UI_II) in this area after flash code is written. As FW UI parameter is configured by UI tool, Run Time Update UI parameter (UI_I) will also be generated into this area. FW will check the End_Check of UI_I. If End_Check of UI_I is valid, UI_I will be used, otherwise FW will recover UI_I by UI_II. Only UI_I can be updated by FW for pairing information, App Air Patch, or Beacon Admin. Below show the structure of UI parameter. Address Parameter Mcode FW Update (Run Time Update) B04: 0x4000 (1.5KB) Run Time Update UI parameter (UI_I) Y B04: 0x4600 (0.5KB) Reserved N/A B04: 0x4800 (1.5KB) Factory UI Table (UI_II) N B04: 0x4E00 (512B) IC Information(0x4E00) & Factory Client Foot Print (0x4E20) (UI_III) N B04: 0x5000 (4KB) GATT Service Table N 3 BUILD-IN SERICE TABLES 3.1 Standard GATT-Based Services Generic Access Service Device Information Service 3.2 ISSC Proprietary Services Transparent Service Refer to ISSC_Transparent_Service document for more information. Beacon Admin Service Refer to ISSC_Beacon_Admin_Service document for more information. page 7

8 Air Patch Service Refer to ISSC_Air_Patch_Service document for more information. 4 SUPPORT FEATURES 4.1 Bluetooth Core Spec BLEDK3 is certified as BT4.2 spec. It supports LE Secure Connections pairing and LE Data Length Extension. LE Secure Connections (LESC) pairing: Except OOB, all of the IO capacity had been implemented in BLEDK3. Note: ios 8.2 support LESC pairing scheme. LE Secure Connections pairing utilizes the P-256 elliptic curve. LE Data Length Extension: No Encrypted packet: The max supported physical packet length is 255 bytes. Encrypted packet: The max supported physical packet length is 104 bytes. 4.2 BLE capability GAP Roles Broadcaster Role Observer Role Peripheral Role Central Role Operation Modes and Procedures - LE Physical Transport Broadcast Mode Discoverable Mode Connection Modes - Non-Connectable Mode - Directed Connectable Mode - Undirected Connectable Mode Bondable Mode Observation Procedure General Connection Establishment Procedure Connection Parameter Update Procedure Terminate Connection Procedure Bonding Procedure Security - LE Physical Transport Security Modes BLEDK3 only supports LE Security Mode 1. Including following security levels: 1. No Security (No authentication and no encryption) 2. Unauthenticated pairing with encryption 3. Authenticated pairing with encryption page 8

9 4. Authenticated LE Secure Connections pairing with encryption Encryption Procedure Initiate Pairing Procedure Resolvable Private Address Resolution Procedure The maximum number of device bonding information can be stored is GATT Profile BLEDK3 supports both GATT Client role and GATT Server role. Available features are listed as below: Server Configuration Primary Service Discovery Characteristic Discovery Characteristic Descriptor Discovery Reading a Characteristic alue Writing a Characteristic alue Notification of a Characteristic alue Indication of a Characteristic alue Reading a Characteristic Descriptor Writing a Characteristic Descriptor 4.3 Enhanced BLE security function BLE Passkey Confirm: BLEDK3 provides fix passkey feature for pairing processing. If this option is enabled by UI tool, the configuration of six digits passkey will be used in pairing procedure. This feature only can be enabled while IO capability of Security Setting is DisplayOnly or DisplayYesNo. Trust Device Connection: BLEDK3 can be configured only the paired device can keep BLE link with it, except for no pairing information is stored in database or pairing key is pressed. 4.4 Configurable application parameter Most of feature related parameters can be configured by UI tool, like device information, timeout of operation mode, LED type of operation mode, connection parameter, advertising data and so on. 4.5 Beacon and BeaconThings BeaconThings While BLEDK3 operates in discovery mode, BLEDK3 can send non-connectable advertising event and connectable undirected advertising event at the same time. And it can be configured by UI tool to enabled/disable non-connectable advertising when BLEDK3 is connected by remote device. If non-connectable advertising event is disabled under connected state, BLEDK3 will stop sending non-connectable advertising event once connection is established. And restart sending advertising event after connection is terminated. page 9

10 Connected Disconnected Standby mode Standby mode LE AD. Beacon AD. Rx/Tx after connected Connected Disconnected Standby mode Standby mode LE AD. Beacon AD. Rx/Tx after connected Beacon Only While BLEDK3 operates in Broadcast Mode, BLEDK3 can send non-connectable advertising event. This kind of non-connectable advertising event is what we called Beacon. Besides Beacon behavior, BLEDK3 also supports additional capability for remote device to configure advertising data called Beacon Admin. BLEDK3 can send connectable undirected advertising event in a limited period for remote device to establish connection after power on. After Beacon Admin procedure is terminated, BLEDK3 will never send connectable undirected advertising event except power off then power on BLEDK3. The limited period of connectable undirected advertising can be configured by UI tool which is named Beacon Admin Timeout. Case1: No connection before beacon admin timeout Beacon Admin TO Standby mode Standby mode LE AD. Beacon AD. Case2: Establish connection before beacon admin timeout Connected Disconnected Standby mode Beacon Admin Standby mode LE AD. Beacon AD. Rx/Tx after connected Beacon Address Calculation FixedRandNum = {0x9A, 0xD2, 0xF3, 0x8D, 0x21, 0x68} From index i=0 to i=5 BeaconAddr[i] = BluetoothAddr[i] xor FixedRandNum[i] BeaconAddr[5] = BeaconAddr[5] or 0xC0 page 10

11 4.6 Definition of GPIOs BM70 IS1807 H/W Dedicated Configurable Host MCU Pin GPIOs Functionality Functional GPIOs Functional GPIOs Controllable GPIOs Out P00 - AD0 - UART/CTS P01 - AD1 P02 - AD2 LED0 - LED0 P03 - GOIO - AD3 P04 -GPIO - AD4 P05 -GPIO - AD5 P06 - AD6 P07 - AD7 P10 - AD8 - TX_CLS1 P11 - AD9 - MISO2 P12 - AD10 - I2C SCL P13 - AD11 - I2C SDA P14 - AD12 - EENT0 P15 - AD13 - EENT1 P16 - XI32K P17 page 11

12 - XO32K System P20 configuration H:Application L:Test mode P21 - PWM0 P22 - PWM1 P23 - PWM2 WAKEUP_PIN P24 - RX_CLS1 P25 - AD15 - PWM3 P26 - UART_TX_IND P27 - NCS2 UART_TX_IND - AD14 P30 P31 - SPI Bus/NCS - SPI Flash/CSN P32 - SPI Bus/MISO - SPI Flash/SDO P33 - SPI Bus/MOSI - SPI Flash/SDI P34 - SPI Bus/SCLK - SPI Flash/SCK P35 - LED1 LED1 P36 - PWM0 - UART/RTS Note1. I/O type: A = Analog, D = Digital, I = Input, O = Output page 12

13 5 GPIO FUNCTIONALITY 5.1 Dedicated Functional GPIOs System Configuration P2_0 is only used for system configuration. It can t be used by any application. P2_0 is configured to be input and pulled up as default. If P2_0 is pulled down, IC will switch into Test Mode LED Indication (LED0/LED1) BLEDK3 supports two LED indicating. There re several LED types can be chosen for different modes. Except for LED type, LED on/off duration also can be configured by UI tool. All supported LED types are listed as below. If LED is configured as OFF or no usage, then the pin of LED can be used as normal GPIO. MCU can control this PIN by sending UART command. LED Type LED0 LED1 0 OFF OFF 1 ON ON 2 ON OFF 3 OFF ON 4 OFF FLASH 5 FLASH OFF 6 ON FLASH 7 FLASH ON 8 FLASH(At the same time) FLASH(At the same time) 9 FLASH(interleave) FLASH(interleave) Related UI Parameter: LED Flash Setting UART Data Transmit Indication (UART_TX_IND) The pin definition of UART_TX_IND is assigned BLEDK3. UART_TX_IND is used to indicate MCU that data will be transmitted out by UART_TXD after a specific interval which can be configured by UI Tool. UART_TX_IND: P27 H: No UART data will be transmitted. (TX_IND) L: BLEDK3 indicate UART data will be transmitted out after certain timing. page 13

14 UART_TX Start UART_TX End UART_TX_IND TWakeup_External_MCU_Wait_Time UART_TXD *TWakeup_External_MCU_Wait_Time: The time interval before data send out by UART_TXD (set by UI). Related UI Parameter: Wakeup External MCU Wait Time BLEDK3 indicates Host MCU UART data timing diagram Wake-up BLEDK3 from Shutdown State (WAKEUP_PIN) BLEDK3 enters into shutdown state in some scenario, and BLEDK3 doesn t have any capability in shutdown state. MCU must wake-up BLEDK3 from shutdown state for future behavior. WAKEUP_PIN feature also can be disabled by setting WAKEUP_PIN_DISABLE to be TRUE. Once WAKEUP_PIN feature is disabled, this pin becomes a normal GPIO. MCU can control this PIN by sending UART command. Both WAKEUP_PIN and UART_RX_IND (If UART RX_IND is configured as enabled) can be used to wake-up BLEDK3. After wakeup from shutdown, BLEDK3 enters into standby mode in auto pattern. After wakeup from shutdown, BLEDK3 enters into idle mode in manual pattern. Trigger BLEDK3 Ready WAKEUP_PIN 87 ms Related UI Parameter: WAKEUP_PIN_DISABLE BLEDK3 wake up time in auto pattern 5.2 Configurable Functional GPIOs BLEDK3 provides functionality that can be achieved by GPIO. Most of those functionalities are not limited to specific GPIOs. All of them can be configured by UI tool. There re only two functionalities need to be assigned by specific GPIOs. One is UART_RST, and the other is UART_CTS. Related UI Parameter: GPIO Configuration Status Indication (STATUS1_IND/ STATUS2_IND) BLEDK3 status is composed of STATUS1_IND and STATUS2_IND. To get whole status information, both STATUS1_IND and STATUS2_IND should be assigned in configurable GPIOs by UI tool. Below table shows the definition of BLEDK3 status. page 14

15 STATUS1_IND / STATUS2_IND Status Description H/H Shutdown Mode BLEDK3 is shutdown H/L Standby Mode BLEDK3 sends advertising packets and wait for connection. BLEDK3 is under discoverable and connectable. L/L BLE Connected Mode BLE link is established and CCCD of ISSC_Transparent_TX characteristic is disabled L/H Transparent Service Enabled Mode BLE link is established and CCCD of ISSC_Transparent_TX characteristic is enabled Power on State Standby State Physical Link Establish Data Session Open Standby State Shutdown State Connected Enable Disconnecte STATUS1_IND STATUS2_IND BLEDK3 status indication by two configurable GPIO pins Related UI Parameter: GPIO Configuration UART Flow Control (UART_CTS/UART_RTS) BLEDK3 support UART flow control scheme. Once UART flow control is enabled, both CTS and RTS GPIOs should be assigned. The two GPIOs allow MCU and BLEDk3 to alert each other to their state. If UART buffer of BLEDK3 is full, RTS will be raised by BLEDK3. If UART buffer of MCU is full, CTS will be raised by MCU. At most two bytes will be sent after CTS is raised. UART_TX Start Flow Stop Flow Go UART_TX End UART_CTS UART_TXD Host MCU indicate BLEDK3 UART flow control timing diagram page 15

16 Open Data Session Flow Stop Flow Go Close Data Session UART_RTS UART_RXD BLEDK3 indicate Host MCU UART flow control timing diagram Related UI Parameter: UART Setting/HW Flow Control GPIO Configuration Enable BLEDK3 Low Power Mode (UART_RX_IND) In order to reduce current consumption, BLEDK3 will automatically enter into low power mode if UART RX_IND is enabled and UART_RX_IND is assigned. Since BLEDK3 can t correctly deal with UART data received under low power mode, MCU must wakeup BLEDK3 before UART data transmission. Currently the minimum guard time is 3ms. If MCU has no capability to wakeup BLEDK3 before data transmission, UART RX_IND function must be configured as disabled. Therefore BLEDK3 won t enter into low power mode. UART RX Start UART RX End UART_RX_IND Tuart_rx_ind UART_RXD *Tuart_rx_ind: >3ms Host MCU wakeup BLEDK3 timing diagram Force BLEDK3 Enter Into Standby Mode (PAIRING_KEY) When BLEDK3 is under connected mode, MCU can use PAIRING_KEY to force BLEDK3 enter into standby mode. page 16

17 Trigger Enter Standby Mode PAIRING_KEY Tpairing_key *Tpairing_key:>160 ms Timing diagram of BLEDK3 pairing key function Force BLEDK3 Terminate BLE Link (LINK_DROP) When BLEDK3 is under connected mode, MCU can use LINK_DROP to force BLEDK3 to terminate current BLE link. And then enters into shutdown state. BLE Link Connected BLEDK3 Drop Link BLE Link Disconnected LINK DROP Tdrop_link STATUS1_IND *Tdrop_link:>10 ms Timing diagram of BLEDK3 link drop function Low Battery oltage Indication (LOW_BATTERY_IND) BLEDK3 can indicate MCU that the detected battery voltage is lower by LOW_BATTERY_IND assigned in GPIO Configuration. Once battery voltage is lower than Low Battery Level, LOW_BATTERY_IND will be laid down. And LOW_BATTERY_IND will be raised until battery voltage is higher than Normal Battery Level. BLEDK3 also can be configured automatically enters into shutdown down state when battery voltage is lower after a certain time interval. Related UI Parameter: Battery Detection Interval Low Battery Level Normal Battery Level Low Battery Into Shutdown Time Link Quality Indication (RSSI_IND) BLEDK3 can indicate link quality by RSSI_IND (if Link Quality Detection is configured as enabled). BLEDK3 checks two quality levels which can be configured UI tool. If link quality is lower than RSSI Weak Threshold, then RSSI_IND output as LOW. If link quality is higher than RSSI Normal Threshold, then RSSI_IND output as HIGH. page 17

18 Weak link quality Normal link quality Weak link quality RSSI_IND Link quality indication Related UI Parameter: Link Quality Detection RSSI Normal Threshold RSSI Weak Threshold RF Active Indication (RX_ACTIE_IND) BLEDK3 can indicate MCU that BLEDK3 is not under low power mode by assigned RF_ACTIE_IND in GPIO configuration. If RF Active IND MCU Include set to be Indication only when RF active, BLEDK3 raises the RF_ACTIE_IND when RF is active. If RF Active IND MCU Include set to be Indication when RF and MCU active, BLEDK3 raises the RF_ACTIE_IND when RF and MCU of BLEDK3 are active. MCU wake up Start TX/RX packet End TX/RX packet MCU power down MCU of BLEDK3 TX/RX packet RF_ACTIE _IND RF active indication function only when RF is turning on MCU wake up Start TX/RX packet End TX/RX packet MCU power down MCU of BLEDK3 TX/RX packet RF_ACTIE _IND Related UI Parameter: RF active indication function when MCU is awake and RF is turning on page 18

19 GPIO Configuration RF Active IND MCU Include 5.3 Host MCU Controllable GPIOs BLEDK3 is designed based on IS1870. Even though most of IS1870 GPIOs can be controlled by Host MCU, there re still two exceptions. Host MCU can t control the dedicated functional GPIOs except for LED0/LED1/WAKEUP_PIN. If LED0 is not assigned for specific function, then the pin of LED0 can be controlled by Host MCU. LED1 and WAKEUP_PIN are the same manner. Host MCU can t control the configurable functional GPIOs if they are assigned for specific functionalities. 6 SYSTEM TIMING 6.1 Power on timing Power on to Standby Auto Pattern Power on to Idle Manual Pattern Shutdown to Standby Auto Pattern Shutdown to Idle Manual Pattern ms ms ms ms Standby in auto pattern is defined as application initialization complete and changes the state indication pins. Idle in manual pattern is defined as application initialization complete and reports its state. 7 REFERENCE: 7.1 Document BLEDK3 Command Set BLEDK3_Parameters ISSC Beacon Admin Service ISSC Transparent Service ISSC_BLE_Air_Patch 7.2 Tools IS187x_001_BLEDK3_UI BLEDK3 Auto Pattern Test Tool BLEDK3 Manual Test Tool page 19

20 8 MESSAGE SEQUENCE CHARTS 8.1 Procedure of System Initial Configuration Power On ROM Power On Process N P2_0=1 Y ROM IBDK N eflash Tag = ISSC5505 Y Load Manufacture Parameters BLEDK Application page 20

21 8.2 Application State Machine Auto Pattern Power On Standby State Pairing_K ey N Standby Mode: Discoverable & Connectable mode N Power-on & Normal Standby Time out Setting 4 1 Remote Disconnect Standby Time out Setting Y 3 Y Standby_TO N Connection Be-Paired Y N Pairing Enable Pairing Process Link State N Pairing OK Connected Mode: Pairing OK Pairing fail 1 Link Lost Disconnected Remote Drop 1 Shutdown State Host MCU Drop 3 4 Wakeup Shutdown Mode: Power off Power off Configurable by Manufacture setting Mode page 21

22 8.2.2 Manual Pattern Manual Pattern Idle Mode Set_Advertising _Enable (Disable) Set_Advertising _Enable (NonConnectabl e) Set_Advertising _Enable (Connectable) Set_Advertising _Enable (Disable) Set_Scan _Enable (Enable) Set_Scan _Enable (Disable) Create _Connection Create _connection _Cancel Broadcast Mode Standby Mode Scanning Mode Connecting Mode Connected Pairing Enabled N Connected Y Pairing Process Pairing OK LE Physical Link Established Pairing Fail Disconnected Idle Mode Into_Power _Down_Mode Shutdown Mode Wakeup Trigger Idle Mode Power off Power Off page 22

23 9 REISION HISTORY ersion Date History v /03/31 Initiate this document /05/18 Add Beacon Address Calculation method Beacon Address Calculation Add system power on timing Power on timing page 23