Uploaded files
[ti-bt/service-packs.git] / README
1   This README discusses the usage of Bluetooth script file (BTS), a binary \r
2   file format that contains actions and commands for Texas Instruments\r
3   Bluetooth devices. In addition to describing the file format specifications, \r
4   this README also explains about its naming convention and specifies which \r
5   bts file to use for each of Texas Instruments Bluetooth devices.\r
6 \r
7 WHAT IS A BTS FILE?\r
8 \r
9   BTS is an abbreviation for Bluetooth script. The BTS file is a binary file \r
10   that contains commands and actions for Texas Instruments' Bluetooth devices.\r
11   HCI communication is a two-way street. For each HCI command sent from the \r
12   host to a BT device, the BT device responds with an HCI event. In order to\r
13   simplify the format and procedures required to successfully execute these \r
14   HCI commands, the BTS format is used. The BTS file consists of mandatory\r
15   initialization scripts and additional platform-dependent, optional\r
16   commands that are primarily used in the Bluetooth device initialization.\r
17   The BTS file can be run either as a .bts file placed in the file system, \r
18   or be converted into a memory array in C language that can then be integrated\r
19   into the code of the entire system. \r
20 \r
21   BTS files are distributed under TEXAS INSTRUMENTS LICENSE - see the\r
22   accompanying LICENSE file for more details. \r
23 \r
24 BTS FUNCTIONALITY\r
25 \r
26   The primary usage of the BTS format is to run the initialization script\r
27   after the Bluetooth device powers up. The initialization script must be\r
28   executed after every device power-up. BTS initialization scripts contain\r
29   a section of memory write commands (written code to RAM) that perform as\r
30   a software patch to fix potential ROM issues of the BT device.\r
31   Although this is the primary purpose of the BTS format, it can also be \r
32   used in any scenario to load HCI commands to the Bluetooth device. BTS files\r
33   may also be used for platform-related commands such as to enable deep-sleep\r
34   mechanism, changing UART baud rate, audio configurations, etc.\r
35 \r
36 BTS NAMING FORMAT\r
37 \r
38   Each initialization script corresponds to a single TI BT chip and firmware\r
39   ROM version. These versions are indicated in the name of the initialization \r
40   script. The naming conventions of the TI BT chips are TIInit_X.Y.Z.bts,\r
41   where:\r
42   \r
43   X = Product Name\r
44   Y = ROM SW Major Number\r
45   Z = ROM SW Minor Number\r
46   \r
47   6.6.15    =   CC256xA/NL5500L Product, 6.15 ROM Version\r
48   6.7.16    =   CC256xB Product, 7.16 ROM Version\r
49   6.12.26   =   CC256xC Product, 12.26 ROM Version\r
50   7.6.15    =   WL127x Product, 6.15 ROM Version\r
51   10.6.15   =   WL128x, 6.15 ROM Version\r
52   11.8.32   =   WL180x, WL183x, WL185x - PG2.1 or PG2.2, 8.32 ROM Version\r
53   12.8.32   =   WL187x - PG2.1 or PG2.2, 8.32 ROM Version\r
54   12.10.28  =   WL18xxQ - PG1.11, 10.28 ROM Version\r
55   \r
56   Exceptions are the initialization files of CC256xB/C devices which are also\r
57   provided as three separate bts files: \r
58   \r
59        initscripts-TIInit_6.7.16_bt_spec_4.1.bts \r
60   -OR- initscripts-TIInit_6.12.26.bts              - BT main bts file   \r
61        initscripts-TIInit_6.7.16_ble_add-on.bts \r
62   -OR- initscripts-TIInit_6.12.26_ble_add-on.bts   - BLE functionality add-on\r
63        initscripts-TIInit_6.7.16_avpr_add-on.bts \r
64   -OR- initscripts-TIInit_6.12.26_avpr_add-on.bts  - AVPR (WBS, Assisted A2DP) functionality add-On\r
65   \r
66   When using CC256xB or CC256xC with linux (either TI dual-mode Bluetooth stack or BlueZ), \r
67   use the TIInit_6.7.16.bts or TIInit_6.12.26.bts respectively. It combines the main bts with \r
68   ble add-on.\r
69   \r
70   For additional details, please refer to: \r
71    http://www.ti.com/tool/wl18xx-bt-sp\r
72    http://www.ti.com/tool/cc256xc-bt-sp\r
73    http://www.ti.com/tool/cc256xb-bt-sp\r
74