TELINK SEMICONDUCTOR TLSR8232 Instructions d'installation et d'utilisation

Application Note

Telink TLSR8232 BLE SDK

Developer Handbook

AN-19112700-E1

TELINK SEMICONDUCTOR

Brief:

This document is the developer guide for TLSR8232

BLE SDK 1.3.0.

Version 1.0.0

2019-11-27

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 1 Ver.1.0.0

Published by

Telink Semiconductor

Bldg 3, 1500 Zuchongzhi Rd,

Zhangjiang Hi-Tech Park, Shanghai, China

Legal Disclaimer

This document is provided as-is. Telink Semiconductor reserves the right to make

improvements without further notice to this document or any products herein. This

document may contain technical inaccuracies or typographical errors. Telink

Semiconductor disclaims any and all liability for any errors, inaccuracies or

incompleteness contained herein.

Information:

For further information on the technology, product and business term, please contact

Telink Semiconductor Company (www.telink-semi.com).

For sales or technical support, please send email to the address of:

telinkcnsales@telink-semi.com

telinkcnsupport@telink-semi.com

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 2 Ver.1.0.0

Revision History

Version 1.0.0 (2019-11-27)

This is the Initial release.

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 3 Ver.1.0.0

Contents

Revision History...................................................................................................................2

Contents...............................................................................................................................3

Contents of Figures ...........................................................................................................11

1. SDK Overview................................................................................................................14

1.1 Software Architecture...........................................................................................14

1.1.1 main.c.........................................................................................................15

1.1.2 app_config.h...............................................................................................16

1.1.3 Application File...........................................................................................16

1.1.4 BLE Stack Entry.........................................................................................16

1.2 Applied ICs...........................................................................................................17

1.3 library....................................................................................................................17

1.4 Demo....................................................................................................................18

1.4.1 BLE Slave Demo........................................................................................19

1.4.2 Other Demos..............................................................................................20

2. MCU Basic Modules......................................................................................................21

2.1 MCU Address Space............................................................................................21

2.1.1 MCU Address Space Allocation.................................................................21

2.1.2 SRAM Space Allocation.............................................................................21

2.1.2.1 SRAM and Firmware Space............................................................21

2.1.2.2 list File Analysis Demo.....................................................................25

2.1.3 MCU Address Space Access.....................................................................29

2.1.3.1 Peripheral Space Access ................................................................29

2.1.3.2 Flash Space Operation....................................................................30

2.1.4 SDK Flash Space Allocation......................................................................32

2.1.4.1 Space Allocation of 512kB Flash.....................................................33

2.1.4.2 Space Allocation of 128kB Flash.....................................................35

2.2 Clock Module........................................................................................................37

2.2.1 System Clock & System Timer ..................................................................37

2.2.2 System Timer Usage..................................................................................39

2.3 GPIO Module........................................................................................................40

2.3.1 GPIO Definition..........................................................................................40

2.3.2 GPIO State Control....................................................................................40

2.3.3 GPIO Initialization ......................................................................................42

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 4 Ver.1.0.0

2.3.4 Configure SWS Pull-up to Avoid MCU Errors............................................43

3. BLE Module ...................................................................................................................44

3.1 BLE SDK Software Architecture...........................................................................44

3.1.1 Standard BLE SDK Architecture................................................................44

3.1.2 Telink BLE SDK Architecture.....................................................................45

3.1.2.1 Telink BLE Controller.......................................................................45

3.1.2.2 5316 BLE Slave...............................................................................46

3.2 BLE Controller......................................................................................................47

3.2.1 BLE Controller Introduction........................................................................47

3.2.2 Link Layer State Machine ..........................................................................47

3.2.3 Link Layer State Machine Combined Application......................................49

3.2.3.1 Link Layer State Machine Initialization............................................49

3.2.3.2 Idle + Advertising.............................................................................50

3.2.3.3 Idle + Advertising + ConnSlaveRole................................................50

3.2.4 Link Layer Timing Sequence .....................................................................51

3.2.4.1 Timing Sequence in Idle State.........................................................52

3.2.4.2 Timing Sequence in Advertising State ............................................52

3.2.4.3 Timing Sequence in Conn state Slave Role....................................53

3.2.4.4 Conn State Slave Role Timing Protection.......................................54

3.2.5 Link Layer TX FIFO & RX FIFO.................................................................55

3.2.6 Controller HCI Event..................................................................................58

3.2.6.1 HCI Event.........................................................................................59

3.2.6.2 HCI LE Event...................................................................................60

3.2.7 Telink Defined Event..................................................................................62

3.2.7.1 BLT_EV_FLAG_ADV.......................................................................65

3.2.7.2 BLT_EV_FLAG_ADV_DURATION_TIMEOUT...............................65

3.2.7.3 BLT_EV_FLAG_SCAN_RSP ..........................................................65

3.2.7.4 BLT_EV_FLAG_CONNECT............................................................65

3.2.7.5 BLT_EV_FLAG_TERMINATE.........................................................66

3.2.7.6 BLT_EV_FLAG_ENCRYPTION_CONN_DONE.............................67

3.2.7.7 BLT_EV_FLAG_DATA_LENGTH_EXCHANGE.............................67

3.2.7.8 BLT_EV_FLAG_GPIO_EARLY_WAKEUP.....................................68

3.2.7.9 BLT_EV_FLAG_CHN_MAP_REQ ..................................................69

3.2.7.10 BLT_EV_FLAG_CHN_MAP_UPDATE .........................................69

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 5 Ver.1.0.0

3.2.7.11 BLT_EV_FLAG_CONN_PARA_REQ ...........................................69

3.2.7.12 BLT_EV_FLAG_CONN_PARA_UPDATE.....................................70

3.2.7.13 BLT_EV_FLAG_SUSPEND_ENETR............................................70

3.2.7.14 BLT_EV_FLAG_SUSPEND_EXIT ................................................70

3.2.7.15 BLT_EV_FLAG_PHY_UPDATE....................................................70

3.2.8 Controller API.............................................................................................71

3.2.8.1 Controller API Brief..........................................................................71

3.2.8.2 API Return Type ble_sts_t...............................................................71

3.2.8.3 MAC Address Initialization...............................................................71

3.2.8.4 Link Layer State Machine Initialization............................................72

3.2.8.5 bls_ll_setAdvData............................................................................72

3.2.8.6 bls_ll_setScanRspData....................................................................73

3.2.8.7 bls_ll_setAdvParam.........................................................................74

3.2.8.8 bls_ll_setAdvEnable ........................................................................78

3.2.8.9 bls_ll_setAdvDuration......................................................................78

3.2.8.10 blc_ll_setAdvCustomedChannel....................................................79

3.2.8.11 rf_set_power_level_index..............................................................79

3.2.8.12 bls_ll_terminateConnection...........................................................80

3.2.8.13 Get Connection Parameters..........................................................81

3.2.8.14 blc_ll_getCurrentState...................................................................81

3.2.8.15 blc_ll_getLatestAvgRSSI...............................................................81

3.2.8.16 Whitelist & Resolvinglist.................................................................82

3.2.9 2M PHY Supported....................................................................................83

3.2.10 Data Length Extension.............................................................................84

3.3 L2CAP ..................................................................................................................85

3.3.1 Register L2CAP Data Processing Function...............................................86

3.3.2 Update Connection Parameters.................................................................87

3.3.2.1 Slave Requests for Connection Parameter Update........................87

3.3.2.2 Master Responds to Connection Parameter Update Request........88

3.3.2.3 Master Updates Connection Parameters in Link Layer...................90

3.4 ATT & GATT.........................................................................................................90

3.4.1 GATT Basic Unit “Attribute” .......................................................................90

3.4.2 Attribute and ATT Table.............................................................................92

3.4.2.1 attNum .............................................................................................92

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 6 Ver.1.0.0

3.4.2.2 perm.................................................................................................93

3.4.2.3 uuid, uuidLen ...................................................................................94

3.4.2.4 pAttrValue, attrLen...........................................................................94

3.4.2.5 Callback Function w.........................................................................95

3.4.2.6 Callback Function r..........................................................................97

3.4.2.7 Attribute Table Layout......................................................................98

3.4.2.8 ATT Table Initialization....................................................................99

3.4.3 Attribute PDU & GATT API........................................................................99

3.4.3.1 Read by Group Type Request, Read by Group Type Response .100

3.4.3.2 Find by Type Value Request, Find by Type Value Response ......101

3.4.3.3 Read by Type Request, Read by Type Response........................101

3.4.3.4 Find Information Request, Find Information Response ................102

3.4.3.5 Read Request, Read Response....................................................103

3.4.3.6 Read Blob Request, Read Blob Response...................................103

3.4.3.7 Exchange MTU Request, Exchange MTU Response...................104

3.4.3.8 Write Request, Write Response....................................................105

3.4.3.9 Write Command.............................................................................106

3.4.3.10 Handle Value Notification............................................................106

3.4.3.11 Handle Value Indication...............................................................107

3.4.3.12 Handle Value Confirmation..........................................................108

3.5 SMP....................................................................................................................109

3.5.1 SMP Parameter Configuration.................................................................109

3.5.1.1 Device Bonding..............................................................................109

3.5.1.2 Device OOB data verification ........................................................109

3.5.1.3 Secure Connection Pairing (SC) ...................................................109

3.5.2 Enable SMP.............................................................................................110

3.5.3 SMP Event ...............................................................................................111

3.5.3.1 BLT_EV_FLAG_PAIRING_BEGIN................................................111

3.5.3.2 BLT_EV_FLAG_PAIRING_END ...................................................112

3.5.4 SMP Bonding Information........................................................................112

4. Power Management (PM)............................................................................................115

4.1 PM Driver............................................................................................................115

4.1.1 Low Power Modes....................................................................................115

4.1.2 Hardware Wakeup Sources.....................................................................115

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 7 Ver.1.0.0

4.1.3 Low Power Mode Entry and Wakeup ......................................................117

4.2 BLE Low Power Management............................................................................119

4.2.1 PM In Idle State........................................................................................119

4.2.2 PM in BLE Adv State & Conn State.........................................................120

4.3 BLE PM Configuration........................................................................................120

4.3.1 PM Module Initialization...........................................................................120

4.3.2 Set Low Power Modes via “bls_pm_setSuspendMask” ..........................121

4.3.3 bls_pm_setWakeupSource......................................................................121

4.3.4 Working Mechanism of Low Power Managment.....................................122

4.4 “latency_use” Configuration and Calculation .....................................................125

4.5 Other APIs..........................................................................................................125

4.5.1 bls_pm_getSystemWakeupTick...............................................................126

4.5.2 bls_pm_enableAdvMcuStall.....................................................................127

4.6 Notes about GPIO Wakeup................................................................................127

4.6.1 Fail to Enter Suspend/Deepsleep When Wakeup Level is Valid.............127

4.7 BLE System PM Reference................................................................................128

4.8 Timer Wakeup of APP Layer..............................................................................129

5. Low Battery Detect ......................................................................................................131

5.1 Significance of Low Battery Detect....................................................................131

5.2 Implementation of Low Battery Detect...............................................................131

5.2.1 Cautions of Low Battery Detect ...............................................................131

5.2.1.1 MUST Use GPIO Input Channel....................................................132

5.2.1.2 MUST Use ADC Differential Mode................................................133

5.2.1.3 MUST Use DFIFO for ADC Sampling Valu...................................133

5.2.2 Dedicated Low Battery Detect Demo.......................................................133

5.2.2.1 Initialization of Low Battery Detect ................................................134

5.2.2.2 Low Battery Detect Processing .....................................................134

5.2.2.3 Low Battery Voltage Alarm............................................................135

6. OTA..............................................................................................................................137

6.1 Flash Architecture and OTA Procedure.............................................................137

6.1.1 Flash Storage Architecture ......................................................................137

6.1.2 OTA Update Procedure ...........................................................................138

6.1.3 Modify Firmware Size and Boot Address.................................................139

6.2 RF Data Proceesing in OTA Mode.....................................................................141

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 8 Ver.1.0.0

6.2.1 OTA Processing in Attribute Table on Slave Side...................................141

6.2.2 OTA Data Packet Format.........................................................................142

6.2.3 RF Transfer Processing on Master Side..................................................143

6.2.4 RF Receive Processing on Slave Side....................................................146

7. Key Scan......................................................................................................................149

7.1 Key Matrix...........................................................................................................149

7.2 Keyscan, Keymap and Keycode........................................................................151

7.2.1 Keyscan....................................................................................................151

7.2.2 Keymap &kb_event..................................................................................151

7.3 Keycode..............................................................................................................154

7.4 Keyscan Flow.....................................................................................................156

7.4.1 Basic Keyscan Flow.................................................................................156

7.4.2 Keyscan Flow Timing Optimization..........................................................157

7.5 Deepsleep Wakeup Fast Keyscan.....................................................................159

7.6 Repeat Key Processing......................................................................................161

7.7 Stuck Key Processing ........................................................................................162

7.8 Power Optimization for Long Key Press............................................................164

8. LED Management........................................................................................................165

8.1 LED Task Related Functions..............................................................................165

8.2 LED Task Configuration and Management........................................................165

8.2.1 LED Event Definition................................................................................165

8.2.2 LED Event Priority....................................................................................166

9. blt Software Timer........................................................................................................168

9.1 Timer Initialization...............................................................................................168

9.2 Timer Inquiry Processing....................................................................................168

9.3 Add Timer Task..................................................................................................171

9.4 Delete Timer Task..............................................................................................171

9.5 Demo..................................................................................................................171

10. IR................................................................................................................................174

10.1 PWM Driver......................................................................................................174

10.1.1 PWM id and Pin .....................................................................................174

10.1.2 PWM Clock ............................................................................................175

10.1.3 PWM Cycle and Duty.............................................................................176

10.1.4 PWM Revert...........................................................................................177

Telink TLSR8232 BLE SDK Developer Handbook

AN-19112700-E1 9 Ver.1.0.0

10.1.5 PWM Start and Stop..............................................................................177

10.1.6 PWM Mode ............................................................................................177

10.1.7 PWM Pulse Number...............................................................................177

10.1.8 PWM Phase...........................................................................................178

10.1.9 PWM Interrupt........................................................................................178

10.1.10 API for IR DMA FIFO Mode.................................................................180

10.1.10.1 Configuration of DMA FIFO.......................................................180

10.1.10.2 Set DMA FIFO Buffer.................................................................181

10.1.10.3 Start and Stop of IR DMA FIFO Mode.......................................181

10.2 IR Demo ...........................................................................................................181

10.2.1 PWM Mode Selection ............................................................................181

10.2.2 Demo IR protocol...................................................................................182

10.2.3 IR Timing Design....................................................................................182

10.2.4 IR Initialization........................................................................................185

10.2.4.1 rc_ir_init .......................................................................................185

10.2.4.2 IR Hardware Configuration..........................................................185

10.2.4.3 IR Variable Initialization...............................................................186

10.2.5 FIFO Task Configuration........................................................................186

10.2.5.1 FIFO Task_data...........................................................................186

10.2.5.2 FifoTask_idle................................................................................187

10.2.5.3 FifoTask_repeat...........................................................................188

10.2.5.4 FifoTask_repeat*n&FifoTask_idle_repeat*n ...............................189

10.2.6 Check IR Busy Status in APP Layer......................................................189

11. Drivers in BLE SDK ...................................................................................................190

11.1 External Capacitor for 24 MHz Crystal.............................................................190

11.2 Select 32kHz Clock Sources............................................................................190

11.3 EMI ...................................................................................................................190

11.3.1 EMI Test.................................................................................................190

11.3.1.1 Carrier Mode................................................................................191

11.3.1.2 CD Mode......................................................................................191

11.3.1.3 TX Mode ......................................................................................192

11.3.1.4 RX Mode......................................................................................192

11.3.2 EMI Test Tool.........................................................................................193

11.4 PHY Test..........................................................................................................198

Ce manuel convient aux modèles suivants

Table des matières

Autres manuels TELINK SEMICONDUCTOR Accessoires informatiques

TELINK SEMICONDUCTOR

TELINK SEMICONDUCTOR TLSR8267 Manuel utilisateur

Manuels Accessoires informatiques populaires d'autres marques

Motorola

Motorola ATRIX Manuel utilisateur

HP USB Media Docking Station Manuel utilisateur

Cherry

Cherry B.UNLIMITED 3.0 Manuel utilisateur

Logitech

Logitech IO2 Manuel utilisateur

ARM

ARM DSTREAM-ST Manuel utilisateur

Bartec

Bartec TC 7 Series Manuel utilisateur

Philips

Philips SPC3540 Manuel utilisateur

Logitech

Logitech mk220 Manuel utilisateur

SilverStone

SilverStone LC02 Manuel utilisateur

Flexispot

Flexispot ML2B Manuel utilisateur

Hamlet

Hamlet UNIVERSAL COVER 101 KBT2 Manuel utilisateur

Adam Equipment

Adam Equipment RS-485 Manuel utilisateur

Vivo

Vivo MOUNT-KB05-4DW Manuel utilisateur

Kvaser

Kvaser Memorator Professional Manuel utilisateur

DRC

DRC D-Imaging Manuel utilisateur

Sven

Sven Base 305 сombo Manuel utilisateur

Hama

Hama 108310 Manuel utilisateur

SpeechWare

SpeechWare FlexyMike FMK03 Manuel utilisateur