WiLink™ 8.0 Bluetooth® Vendor-Specific HCI

WiLink™ 8.0 Bluetooth® Vendor-Specific HCI

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

User's Guide

Literature Number: SWRU442A

October 2015 – Revised February 2016

Contents

1

2

3

4

5

2

Overview

.............................................................................................................................

5

Introduction

.........................................................................................................................

5

2.1

Configuration Requirements

............................................................................................

5

2.2

2.3

2.4

HCI Packet Format

.......................................................................................................

6

Command Packet

........................................................................................................

6

Event Packet

..............................................................................................................

7

Troubleshooting

..................................................................................................................

7

Terms and Abbreviations

......................................................................................................

8

Detailed Description of Supported VS HCI Commands and Events

............................................

9

5.1

HCI VS Commands

5.1.1

....................................................................................................

10

System Configuration Commands

........................................................................

10

5.1.1.1

5.1.1.2

HCI_VS_Write_BD_Addr (0xFC06)

HCI_VS_Start_VS_Lock (0xFE37)

..................................................................

10

...................................................................

11

5.1.1.3

5.1.1.4

5.1.1.5

HCI_VS_Stop_VS_Lock (0xFE38)

...................................................................

12

HCI_VS_Update_UART_HCI_Baudrate (0xFF36)

.................................................

13

HCI_VS_Sleep_Mode_Configurations (0xFD0C)

..................................................

14

5.1.1.6

5.1.1.7

5.1.1.8

HCI_VS_HCILL_Parameters (0xFD2B)

.............................................................

16

HCI_VS_Start_AVPR_VS_Lock (0xFE49)

..........................................................

17

HCI_VS_ Fast_Clock_Configuration_btip (0xFD1C)

...............................................

18

5.1.1.9

HCI_VS_Configure_DDIP (0xFD55)

.................................................................

20

5.1.1.10

HCI_VS_Clock_Set_Timeout (0xFE24)

.............................................................

22

5.1.2

5.1.2.1

5.1.2.2

Audio and Voice Configuration Commands

.............................................................

23

HCI_VS_Write_CODEC_Config (0xFD06)

..........................................................

23

HCI_VS_Write_CODEC_Config_Enhanced (0xFD07)

............................................

26

5.1.2.3

5.1.2.4

5.1.2.5

5.1.2.6

HCI_VS_Set_PCM_Loopback_Configuration (0xFD04)

HCI_VS_Set_PCM_Loopback_Enable (0xFE28)

..........................................

29

..................................................

30

HCI_VS_A3DP_Open_Stream (0xFD8C)

...........................................................

31

HCI_VS_A3DP_Close_Stream (0xFD8D)

...........................................................

32

5.1.2.7

5.1.2.8

5.1.2.9

5.1.3

5.1.3.1

5.1.3.2

5.1.3.3

5.1.3.4

5.1.3.5

5.1.3.6

5.1.3.7

5.1.3.8

5.1.3.9

5.1.4

5.1.4.1

5.1.4.2

HCI_VS_A3DP_Codec_Configuration (0xFD8E)

HCI_VS_A3DP_Start_Stream (0xFD8F)

HCI_VS_A3DP_Stop_Stream (0xFD90)

..................................................

33

............................................................

35

............................................................

36

RF and PHY Configuration Commands

..................................................................

37

HCI_VS_DRPb_Enable_RF_Calibration_Enhanced (0xFDFB)

..................................

37

HCI_VS_DRPb_Set_Power_Vector (0xFD82)

.....................................................

39

HCI_VS_DRPb_Set_Class2_Single_Power (0xFD87)

HCI_VS_DRPb_Tester_Con_TX (0xFDCA)

............................................

43

........................................................

45

HCI_VS_DRPb_Tester_Con_RX (0xFDCB)

........................................................

47

HCI_VS_DRPb_Tester_Packet_TX_RX (0xFDCC)

................................................

49

HCI_VS_DRPb_Reset (0xFD88)

.....................................................................

51

HCI_VS_DRPb_BER_Meter_Start (0xFD8B)

.......................................................

51

HCI_VS_DRP_Read_BER_Meter_Result (0xFD13)

..............................................

53

Debug Commands

..........................................................................................

54

HCI_VS_Set_Supported_Features (0xFF26)

.......................................................

54

HCI_VS_Get_System_Status (0xFE1F)

.............................................................

55

Table of Contents

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

6

5.1.4.3

5.1.5

5.1.5.1

5.1.5.2

5.1.5.3

5.1.5.4

5.1.5.5

5.1.5.6

5.1.5.7

5.1.5.8

HCI_VS_Read_RSSI (0xFDFC)

......................................................................

58

Memory Access Commands

...............................................................................

59

HCI_VS_Read_Hardware_Register (0xFF00)

......................................................

59

HCI_VS_Write_Hardware_Register (0xFF01)

......................................................

60

HCI_VS_Read_Modify_Write_Hardware_Register (0xFD09)

HCI_VS_Write_I2C_Register (0xFE0E)

....................................

61

.............................................................

62

HCI_VS_Read_Memory (0xFF02)

...................................................................

63

HCI_VS_Write_Memory (0xFF03)

...................................................................

64

HCI_VS_Read_Memory_Block (0xFF04)

...........................................................

65

HCI_VS_Write_Memory_Block (0xFF05)

...........................................................

66

Reference Documents

.........................................................................................................

66

Revision History

..........................................................................................................................

67

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

Contents

3

6

7

4

5

1

2

3 www.ti.com

List of Tables

HCI Packet Format

..........................................................................................................

6

HCI Packet Types

...........................................................................................................

6

HCI Command Packet Structure

...........................................................................................

7

HCI Event Packet Structure

................................................................................................

7

Terms and Abbreviations

...................................................................................................

8

VS HCI Status Return Descriptions

.......................................................................................

9

Reference Documents

.....................................................................................................

66

4

List of Tables

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

User's Guide

SWRU442A – October 2015 – Revised February 2016

1 Overview

This document describes all supported vendor-specific (VS) host controller interface (HCI) commands in the WiLink™ 8.0 Bluetooth

®

firmware. Modifications and new VS commands are added to this document as the software versions are updated.

This document covers the relevant Bluetooth-enabled WiLink 8.0 family, including WL183xMOD, and

WiLink 8Q (automotive) including WL183xQ and WL187xQ. For more information about WiLink 8Q, contact your local TI representative.

WiLink 8.0

WL1831MOD

WL1835MOD

WL1837MOD

Description

Single band combo Wi-Fi, Bluetooth and Bluetooth low energy module

Single band combo 2 × 2 MIMO Wi-Fi, Bluetooth and Bluetooth low energy module

Industrial dual band 2 × 2 MIMO Wi-Fi, Bluetooth and Bluetooth low energy module

2 Introduction

2.1

Configuration Requirements

HCI Tester tool is available for download in the TI Wireless Tools package release . This tool requires an

XML file and a BTS file to control WiLink devices through the HCI interface.

• For WL18xxMOD devices, download the XML and BTS files from the TI Bluetooth Service Pack .

• For additional devices, download the XML and BTS files from the Git , following the guidelines described in the README file.

The XML file can be directly loaded into the command library, as described in the HCITester User Guide

( SWRU136 ).

The BTS file, or initialization script, must be modified in order to work with HCITester. Follow the steps below to modify the BTS file for HCITester:

• Open HCITester tool and open the BTS file (File → Open)

• Create a new script (File → New) and copy the contents of the BTS file into the new tab.

• Replace the “0x00” value in the “Number of HCI Commands” parameter to “any” by selecting Edit →

Replace → Replace All and configuring the parameters as shown in

Figure 1 .

• When the BTS file is modified and in a new script, save that script as the new initialization file in TXT format. This initialization file must be run prior to running any scripts on the module.

• Click Execution → Execute to run the initialization file.

WiLink is a trademark of Texas Instruments.

Bluetooth is a registered trademark of Bluetooth SIG, Inc.

All other trademarks are the property of their respective owners.

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

5

Introduction

www.ti.com

Figure 1. Editing the BTS File for Use in HCITester Tool

Review the HCITester User’s Guide ( SWRU136 ) for further details about navigating and setting up the

HCITester tool.

2.2

HCI Packet Format

HCI packets are transmitted and received in bytes, least-significant byte (LSByte) first, using the packet format described in

Table 1 .

Table 1. HCI Packet Format

First Byte

Packet type indicator (1 byte)

Last Byte

HCI packet (variable length)

Table 2

lists the packet types.

HCI Packet Type

HCI command packet

HCI ACL data packet

HCI SCO data packet

HCI event packet

Reserved

Reserved

HCI ANT COMMAND

Table 2. HCI Packet Types

Packet Type Indicator

0x01

0x02

0x03

0x04

0x08

0x09

0x0A

Direction

Host to baseband controller

Both

Both

Baseband controller to host

Both

Both

Both

The following sections describe the HCI packets. For more information, see the Bluetooth specifications.

2.3

Command Packet

The following is quoted from Bluetooth Specification V1.1, Chapter 4.4.1, HCI Command Packet:

"Each command is assigned a 2 byte Opcode used to uniquely identify different types of commands.

The Opcode parameter is divided into two fields, called the Opcode Group Field (OGF) and Opcode

Command Field (OCF). The OGF occupies the upper six bits of the opcode, while the OCF occupies the remaining 10 bits. The OGF of 0x3F is reserved for VS debug commands. The OGF of 0x3E is reserved for Bluetooth Logo Testing. The organization of the Opcodes allows additional information to be inferred without fully decoding the entire Opcode."

6

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Introduction

The following lists the range assignment for opcodes in VS commands (OGF = 0x3F).

The command packet transfers standard and VS HCI commands from the host to the baseband controller.

Table 3

shows the packet structure.

Table 3. HCI Command Packet Structure

First

OCF OGF Length Para0 Para1 – – – – – –

Last

OCF:

OGF:

Length:

Para0–ParaN:

10-bit opcode command field, range: 0x00–0x3F (0x3E reserved for Bluetooth logo testing and 0x3F reserved for VS debug commands)

6-bit opcode group field

Length of all parameters in this packet measured in bytes (total length of parameters, not number of parameters)

Specific parameters are associated with each command. These parameters and the size of each parameter are defined for each command. The size of each parameter is an integer number of bytes.

2.4

Event Packet

The event packet transfers standard and VS HCI events from the baseband controller to the host.

Table 4

describes the packet structure.

Table 4. HCI Event Packet Structure

First

Event code Length Para0 Para1 – – – – – –

Last

Event code:

Length:

Para0–ParaN:

Each event is assigned a 1-byte event code that uniquely identifies the event type.

Range: 0x00–0xFF (The event code 0xFF is reserved for VS debug events. The event code 0xFE is reserved for Bluetooth logo testing.)

Length of all parameters in this packet measured in bytes (total length of parameters, not number of parameters)

Specific parameters are associated with each command. These parameters and the size of each parameter are defined for each command. The size of each parameter is an integer number of bytes.

3 Troubleshooting

If at any point a command is unsuccessful or the device hangs, perform the following debug steps:

1. Reset the Serial port.

• In HCITester, click View → Options. Toggle the serial port number and return to the previous setting. Click Apply. This will reset the serial port.

2. If resetting the serial port does not work, power cycle the device and restart the software.

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

7

Terms and Abbreviations

4 Terms and Abbreviations

Table 5

lists the terms and abbreviations used in this document.

Table 5. Terms and Abbreviations

LC

LM

LPS

LMP

MAC

NAK

OCF

OGF

OP

PRBS

PTCR

PCM

PER

QoS

ROM

VS

SCO

FHS

FW

HCI

HEC

HW

DRP

DUT eSCO

FEC

FH

Abbreviation or Term Definition

ACK Acknowledgment

ACL

BD

Asynchronous connection-oriented link

Bluetooth device

BER

BT

CODEC

CRC

CVSD

Bit error rate

Bluetooth

Coder and decoder

Cyclic redundancy check

Continuous variable slope delta modulation

Digital radio frequency (RF) processor

Device under test

Extended SCO

Forward error correction code

Frequency hopping

Frequency hop synchronization

Firmware

Host controller interface

Header error check

Hardware

Link control or controller

Link management or manager

Low-power scan

Link manager protocol

Medium access control

Negative acknowledge

Opcode command field (lower 10 bits of command)

Opcode group field (upper 6 bits of command)

Open platform

Pseudo-random binary sequence

Patch trap control register

Pulse-code modulation

Packet error rate

Quality of service

Read-only memory

Vendor specific

Synchronous connection-oriented link www.ti.com

8

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

0x15

0x16

0x17

0x18

0x19

0x1A

0x1B

0x1C

0x10

0x11

0x12

0x13

0x14

0x0B

0x0C

0x0D

0x0E

0x0F

Return Value

0x00

0x01

0x03

0x04

0x05

0x06

0x07

0x08

0x09

0x0A www.ti.com

5

Detailed Description of Supported VS HCI Commands and Events

Detailed Description of Supported VS HCI Commands and Events

Unless otherwise specified in the descriptions of

Section 5.1

,

Table 6

lists the possible return values for the commands.

Table 6. VS HCI Status Return Descriptions

Description

Success

Unknown HCI command

Hardware failure

Page timeout

Authentication failure

PIN missing

Memory capacity exceeded

Connection timeout

Connection limit exceeded

Synchronous connection limit to a device exceeded

ACL connection limit exceeded

Command disallowed

Connection rejected due to limited resources

Connection rejected due to security reasons

Connection rejected due to unacceptable BD_ADDR

Connection accept timeout exceeded

Unsupported feature or parameter value

Invalid HCI command parameters

Remote user terminated connection

Remote device terminated connection due to low resources

Remote device connection due to power off

Connection terminated by local host

Repeated attempts

Pairing not allowed

Unknown LMP PDU

Unsupported remote feature

SCO offset rejected

SCO interval rejected

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

9

Detailed Description of Supported VS HCI Commands and Events

5.1

HCI VS Commands

The HCI VS commands consist of the following types:

• System configuration commands

• Audio and voice configuration commands

• RF and PHY configuration commands

• Debug commands

• Memory access commands

5.1.1

System Configuration Commands

This section describes the system configuration commands.

5.1.1.1

HCI_VS_Write_BD_Addr (0xFC06)

Command

HCI_VS_Write_BD_Addr

Opcode

0xFC06

Command Parameters

New BD address

Description:

This command writes the value for the BD_ADDR parameter.

Command Parameters:

New BD Address

Value

XXXXXXXXXXXX

Parameter Description

BD address of the device

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Return Parameters

Status www.ti.com

Size: 6 bytes

Size: 1 byte

10

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

5.1.1.2

HCI_VS_Start_VS_Lock (0xFE37)

Detailed Description of Supported VS HCI Commands and Events

Command

HCI_VS_Start_VS_Lock

Opcode

0xFE37

Command Parameters

Software major version

Software minor version

Return Parameters

Status

Description:

This command protects the Bluetooth firmware from downloading and running an inappropriate patch code. The command checks the version that is supplied as command parameters and compares the version to the internal software version. If there is a match, no change occurs. If there is no match, all successive VS commands are locked in the firmware (their execution is skipped and a Command

Complete message with a SUCCESS error code is sent to the host).

The VS lock is released only by the Stop VS Lock command or by a hardware or software reset. If VS lock is on, all error messages are printed in the Bluetooth Logger only.

All protected segments of HCI scripts must be wrapped with the Start VS Lock and Stop VS Lock commands to protect the Bluetooth device from performing version-specific commands (for example, patch code unique to a specific firmware version).

Command Parameters:

Software Major Version

Value

0x00–0xFF

Parameter Description

Major (upper) number of the software version (the X of the X.Y.Z)

Size: 1 byte

Software minor version

Value

0x00–0xFF

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Minor (lower) number of the software version (the Z of X.Y.Z)

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

11

Detailed Description of Supported VS HCI Commands and Events

5.1.1.3

HCI_VS_Stop_VS_Lock (0xFE38)

Command

HCI_VS_Stop_VS_Lock

Opcode

0xFE38

Command Parameters

None

Return Parameters

Status www.ti.com

Description:

The Stop_VS_Lock command clears any lock by a previous command, terminates a protected script segment, and ensures that the next commands of a script are executed independently of the firmware software version.

All protected segments of HCI scripts must be wrapped with the Start_VS_Lock and Stop_VS_Lock commands to protect the Bluetooth device from performing version-specific commands (for example, patch code unique to a specific firmware version).

Command Parameters:

None

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Events Generated:

Command Complete Event

12

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.1.4

HCI_VS_Update_UART_HCI_Baudrate (0xFF36)

Command

HCI_VS_Update_UART_HCI_Baudrate

Opcode

0xFF36

Command Parameters Return Parameters

UART HCI baud rate value Status

Description:

This command sets the UART HCI baud rate. The HCI baud rate changes after the status response.

NOTE:

To continue using HCITester after the baud rate has been changed, the COM port settings must be adjusted to match the baud rate that was set.

Command Parameters:

UART HCI Baud Rate Value

Value

0x00000001–0x003D0900

Parameter Description

New UART baud rate (in bits/sec)

Size: 4 bytes

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

13

Detailed Description of Supported VS HCI Commands and Events

5.1.1.5

HCI_VS_Sleep_Mode_Configurations (0xFD0C)

Command Opcode

www.ti.com

HCI_VS_Sleep_Mode_Configurations 0xFD0C

Description:

This command configures the sleep mode to use.

NOTE:

Before this command is sent, deep sleep is disabled.

Default Values: Deep sleep is disabled by default.

Command Parameters:

Reserved

Value

0x00

Parameter Description

Reserved

Command Parameters

Reserved

Deep sleep enable

Deep sleep mode

Reserved

Reserved

Reserved

Reserved

Reserved

Return Parameters

Status

Size: 1 byte

Size: 1 byte

Reserved

Value

0xFF

Reserved

Value

0xFF

Reserved

Value

0xFF

Deep Sleep Enable

Value

0x00

0x01

Deep Sleep Mode

Value

0x00

0x01–0xFE

0xFF

Reserved

Value

0xFF

Parameter Description

Deep sleep is disabled.

Deep sleep is enabled.

Parameter Description

HCILL

Reserved

Retains previous value / Do not change.

Parameter Description

Reserved. Do not change.

Parameter Description

Reserved. Do not change.

Parameter Description

Reserved. Do not change.

Parameter Description

Reserved. Do not change.

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

14

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Reserved

Value

0x00

Detailed Description of Supported VS HCI Commands and Events

Size: 2 bytes

Parameter Description

Default value 0x00 must be used.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Events Generated:

Command Complete Event

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

15

Detailed Description of Supported VS HCI Commands and Events

5.1.1.6

HCI_VS_HCILL_Parameters (0xFD2B)

www.ti.com

Command Opcode

HCI_VS_ HCILL_Parameters 0xFD2B

Command Parameters

inactivity_timeout retransmit_timeout rts_pulse_width

Return Parameters

Status

Description:

This command controls the behavior of the HCILL deep-sleep protocol.

Default Parameters:

Inactivity_Timeout : 100 ms

Retransmit_Timeout: 500 ms

RTS_Pulse_Width: 1 μs

Command Parameters: inactivity_timeout

Value

0x0000–0xFFFF

Size: 2 bytes

Parameter Description

Time from UART inactivity to sending sleep_ind packet. If this value is 0, the device does not send sleep_ind packet. Unit is frames (1 frame = 1.25 ms).

retransmit_timeout

Value

0x0000–0xFFFF

rts_pulse_width

Value

0x00–0xFF

Size: 2 bytes

Parameter Description

Time from sending WAKEUP_IND packet, to a retransmission of this packet. If this value is 0, no retransmission occurs. Unit is frames (1 frame = 1.25 ms).

Size: 1 byte

Parameter Description

Each WAKEUP_IND packet can be accompanied by a short pulse on the RTS pin. This parameter controls the minimum width of this pulse. If this value is 0, no pulse is sent.

Unit is Micro seconds.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

16

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

5.1.1.7

HCI_VS_Start_AVPR_VS_Lock (0xFE49)

Detailed Description of Supported VS HCI Commands and Events

Command

HCI_VS_Start_AVPR_VS_Lock

Opcode

0xFE49

Command Parameters

Major version number

Minor version number

Return Parameters

Status

Description:

This command protects the AVPR firmware from downloading and running an inappropriate patch code.

The command checks the version that is supplied as command parameters and compares the version to the internal software version. If there is a match, no change occurs. If there is no match, all successive VS commands are locked in the firmware (their execution is skipped and a Command Complete message with a SUCCESS error code is sent to the host).

The VS lock is released only by the Stop VS Lock command or by a hardware or software reset. If VS lock is on, all error messages are printed in the Bluetooth Logger only.

All protected segments of HCI scripts must be wrapped with the Start VS Lock and Stop VS Lock commands to protect the Bluetooth device from performing version-specific commands (for example, patch code unique to a specific firmware version).

Command Parameters:

Major Version

Value

0x00–0xFF

Parameter description

Major version

Size: 1 byte

Minor Version

Value

0x00–0xFF

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter description

Minor version

Parameter description

Command succeeded

Command failed

Size: 1 byte

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

17

Detailed Description of Supported VS HCI Commands and Events

5.1.1.8

HCI_VS_ Fast_Clock_Configuration_btip (0xFD1C)

www.ti.com

Command

HCI_VS_ Fast_Clock_Configuration_btip

Opcode

0xFD1C

Command Parameters

Return

Parameters

XTAL Enable

Settling time

Reserved

Reserved

Reserved

Reserved

Reserved

Slow Clock Accuracy

Reserved

Reserved

Reserved

Reserved

Reserved

Reserved

Status

Description:

This command configures the clock sources parameters for both fast and slow clock: settling time, clock type, and related deep-sleep parameters.

If the device has more than two fast clock sources (primary and secondary), this command is sent twice with the appropriate parameters of each clock source.

Command Parameters:

XTAL Enable

Value

0x00

0x01

0xFF (default)

Size: 1 byte

Parameter Description

XTAL (OSC cell) is disabled, external clock configuration is used.

XTAL (OSC cell) is enabled. Notice: Use this value only for debug purposes. in case

XTAL is used the device automatically detects the XTAL and turn on the XTAL cell.

Retain default value; do not change. Uses the device automatic clock type detection.

Settling Time

Value

0x0000–0x003F

0xFFFF

Reserved

Value

0xFF

Reserved

Value

0xFF

Slow Clock Accuracy

Value

0x00–0xFA (0–250 ppm)

Size: 4 bytes

Parameter Description

Time (in microseconds) from device clock request assertion until a valid clock can be assumed on device clock input. This parameter is driven from the clock source wake up time. During device initialization, this value is updated to 5000. For power consumption optimization it is recommended to update the settling time to reflect the external clock wake up time. Default = 5000 µs or 0x1388.

Retain previous value; do not change.

Size: 1 byte

Parameter Description

Reserved. Do not change without consulting TI.

Size: 1 byte

Parameter Description

Reserved. Do not change.

Size: 1 byte

Parameter Description

Provides the slow clock accuracy in ppm: in case the clock source accuracy is better than 250 ppm, the device can optimize wake-up time in low power modes. (Default =

250 ppm)

18

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Reserved

Value

0x00

Reserved

Value

0

Reserved

Value

0

Reserved

Value

0xFF

Reserved

Value

0xFF

Reserved

Value

0

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Detailed Description of Supported VS HCI Commands and Events

Size: 1 byte

Parameter Description

Reserved. Do not change without consulting TI.

Size: 1 byte

Parameter Description

Reserved.

Size: 1 byte

Parameter Description

Reserved.

Size: 1 byte

Parameter Description

Reserved.

Size: 1 byte

Parameter Description

Reserved.

Size: 1 byte

Parameter Description

Reserved.

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

19

Detailed Description of Supported VS HCI Commands and Events

5.1.1.9

HCI_VS_Configure_DDIP (0xFD55)

www.ti.com

Command

HCI_VS_Configure_DDIP

Opcode

0xFD55

Command Parameters

BE access percentage

Guaranteed access percentage

Poll period

Reserved

Reserved

Reserved

Master burst after RX limit

Reserved

Reserved

Return Parameters

Status

Description:

This command configures the bandwidth allocation between ACL (best effort or guaranteed connection) and Inquiry/Page/Bluetooth low energy scans. The host protocol stack can define the behavior of the controller and control the performance of the device during the activities above.

NOTE:

The HCI_VS_Configure_DDIP command should run once at the end of the initialization script.

Command parameters:

Best Effort Access Percentage

Value

0x00–0x64 (0–100%)

Size: 1 byte

Parameter Description

Percentage allocated for best-effort ACL during page, inquiry and continuous Bluetooth low energy scans. Default = 25%.

Guaranteed Access Percentage1

Value

0x00–0x64 (0–100%)

Poll Period

Value

0x02–0xFF

Reserved

Value

Default = 0x07

Reserved

Value

Default = 0x2

Reserved

Value

0x01

Size: 1 byte

Parameter Description

Percentage allocated for guaranteed ACL during page, inquiry, and continuous

Bluetooth low energy scans. Default = 80%.

Size: 1 byte

Parameter Description

The controller (when acting as a slave of the connection) tries to reduce the poll period during DDIP activities by sending quality of service request to its master. This parameter controls the requested poll period. Default = 0x06.

Size: 1 byte

Parameter Description

Reserved (must be 7)

Size: 1 byte

Parameter Description

Reserved (must be 0x2)

Size: 1 byte

Parameter Description

Reserved

20

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Master Burst After RX Limit

Value

0x00–0xFF

Reserved

Value

0xFF

Reserved

Value

0xFF

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Detailed Description of Supported VS HCI Commands and Events

Size: 1 byte

Parameter Description

A number of frames, after reception of data by master, it tries to send ACK (before giving up and allowing another connection to be scheduled). Default = 0x01.

Size: 1 byte

Parameter Description

Reserved

Size: 1 byte

Parameter Description

Reserved

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

21

Detailed Description of Supported VS HCI Commands and Events

5.1.1.10

HCI_VS_Clock_Set_Timeout (0xFE24)

www.ti.com

Command Opcode

HCI_VS_Clock_Set_Timeout 0xFE24

Command Parameters

Timer mode

Time

Return Parameters

Status

Description:

The Clock_Set_Timeout command enables the device controller to wake up the host. After the allotted time expires, the device sends a notification of an event to the host to wake it up. It is only used in rare cases where the host does not have a timer.

NOTE:

This command is not relevant for WiLink 8Q devices.

Command Parameters:

Timer Mode

Value

0x01

0x10

Parameter Description

Start timer once

Start periodic timer

Size: 1 byte

Time

Value

0x0000–0xFFFF

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Specify the time in milliseconds.

Parameter Description

Command succeeded

Command failed

Size: 4 bytes

Size: 1 byte

22

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.2

Audio and Voice Configuration Commands

This section describes the audio and voice configuration commands.

5.1.2.1

HCI_VS_Write_CODEC_Config (0xFD06)

Command

Write_codec_config

Opcode

0xFD06

Command Parameters

PCM clock rate

PCM clock direction

Frame-sync frequency

Frame-sync duty cycle

Frame-sync edge

Frame-sync polarity

Reserved

Channel 1 data out size

Channel 1 data out offset

Channel 1 data out edge

Channel 1 data in size

Channel 1 data in offset

Channel 1 data in edge

Reserved

Channel 2 data out size

Channel 2 data out offset

Channel 2 data out edge

Channel 2 data in size

Channel 2 data in offset

Channel 2 data in edge

Reserved

Return Parameters

2 bytes

1 byte

4 bytes

2 bytes

1 byte

1 byte

1 byte

2 bytes

2 bytes

1 byte

2 bytes

2 bytes

1 byte

1 byte

2 bytes

2 bytes

1 byte

2 bytes

2 bytes

1 byte

1 byte

Description:

This command configures the codec interface parameters and the PCM clock rate, which is relevant when the Bluetooth core generates the clock. This command must be used by the host to use the PCM interface.

Default Values

PCM clock rate

PCM direction

Frame-sync frequency

Frame-sync duty cycle

Frame-sync edge

Frame-sync polarity

Reserved

Channel 1 data out size

Channel 1 data out offset

Channel 1 data out edge

Channel 1 data in size

Channel 1 data in offset

Channel 1 data in edge

Hardware Default

N/A

1 (input)

N/A

N/A

0 (rising edge)

0 (active high)

N/A

0

0

0 (rising edge)

0

0

0 (rising edge)

HCI Tester Command

2048 kHz

0 (output)

8000 Hz

1

0 (rising edge)

0 (active high)

0

16 bits

1

0 (rising edge)

16 bits

1

1 (falling edge)

Equivalent Hex

0x0800

0x00

0x00001F40

0x0001

0x00

0x00

0x00

0x0010

0x0001

0x00

0x0010

0x0001

0x01

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

23

Detailed Description of Supported VS HCI Commands and Events

Default Values

Reserved

Channel 1 data out size

Channel 2 data out offset

Channel 2 data out edge

Channel 2 data in size

Channel 2 data in offset

Channel 2 data in edge

Reserved

Hardware Default

N/A

0

0

0 (rising edge)

0

0

0 (rising edge)

N/A

Command Parameters:

PCM Clock Rate

Value

0x0040–0x3E80 (64Kbits–16Mbits)

HCI Tester Command

0

16

17

0 (rising edge)

16

17

1 (falling edge)

0 www.ti.com

Equivalent Hex

0x00

0x0010

0x0011

0x00

0x0010

0x0011

0x01

0x00

Size: 2 bytes

Parameter Description

The PCM clock rate is between 64k to 4096k (for master mode) or 64K to 16M (for slave mode). The rate influences other parameters, such as wait cycles and frequency rate calculation and therefore must be configured even if an external clock is used.

PCM Direction

Value

0x00

0x01

Frame-Sync Frequency

Value

0x00000064–0x0002A3C8

Frame-Sync Duty Cycle

Value

0x0000

0x0001–0xFFFF

Frame-Sync Edge

Value

0x00

0x01

Frame-Sync Polarity

Value

0x00

0x01

Reserved

Value

0x00

Size: 1 byte

Parameter Description

PCM clock and Fsync direction is output (codec_IF is master on PCM bus) and sampled on the rising edge.

PCM clock and Fsync direction is input (codec_IF is slave on PCM bus).

Size: 4 bytes

Parameter Description

Frame-sync frequency in Hz (Range 100 Hz–173 kHz). Default = 8000 Hz or

0x00001F40.

Size: 2 bytes

Parameter Description

50% of Fsync period

Number of cycles of PCM clock

Size: 1 byte

Parameter Description

Driven/sampled at rising edge

Driven/sampled at falling edge

Size: 1 byte

Parameter Description

Active high

Active low

Size: 1 byte

Parameter Description

Reserved for future use. Must be set to 0.

24

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Channel X data out size

Value

0x0001–0x0280

Channel X Data Out Offset

Value

0x0000–0x00FF

Channel X Data Out Edge

Value

0x00

0x01

Channel X Data In Size

Value

0x0001–0x0280

Channel X Data In Offset

Value

0x0000–0x00FF

Channel X Data In Edge

Value

0x00

0x01

Reserved

Value

0x00

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Detailed Description of Supported VS HCI Commands and Events

Size: 2 bytes

Parameter Description

Sample size in bits for each codec Fsync

The value is between 1 bit and 640 bits.

If data size is greater than 24 bits, the size must be divisible by 8 (for example, 1–24,

32, 40, 48, and so on). Default = 16 bits or 0x0010.

Size: 2 bytes

Parameter Description

Number of PCM clock cycles between rising of frame sync and data start. NOTE: The offset of CH2 must be a minimum of CH1 DATA LENGTH + 1. This requirement is also important when CH2 is not used.

Size: 1 byte

Parameter Description

Data driven at rising edge

Data driven at falling edge

Size: 2 bytes

Parameter Description

Sample size in bits for each codec Fsync

The value is between 1 bit and 640 bits.

If data size is greater than 24 bits, the size must be divisible by 8 (for example, 1–24,

32, 40, 48, and so on).

Parameter Description

Number of PCM clock cycles between rising of frame sync and data start

Size: 2 bytes

Size: 1 byte

Parameter Description

Data sampled at rising edge

Data sampled at falling edge

Size: 1 byte

Parameter Description

Reserved for future use. Must be set to 0.

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

25

Detailed Description of Supported VS HCI Commands and Events

5.1.2.2

HCI_VS_Write_CODEC_Config_Enhanced (0xFD07)

www.ti.com

Command Opcode

HCI_VS_Write_CODEC_Config_Enhanced 0xFD07

Command Parameters

PCM clock shutdown

PCM clock start

PCM clock stop

Reserved

Channel 1 data in order

Channel 1 data out order

Channel 1 data out mode

Channel 1 data out duplication

Channel 1 TX_dup_value

Channel 1 data quant

Reserved

Channel 2 data in order

Channel 2 data out order

Channel 2 data out mode

Channel 2 data out duplication

Channel 2 TX_dup_value

Channel 2 data quant

Reserved

Return Parameters

1 byte

2 bytes

2 bytes

1 byte

1 byte

1 byte

1 byte

1 byte

4 bytes

1 byte

1 byte

1 byte

1 byte

1 byte

1 byte

4 bytes

1 byte

1 byte

Description:

This command configures enhanced configuration of the codec interface. This command is optional and cannot be used when all default parameters are acceptable. When this command is used, it must follow

Write_codec_config.

Default Values

PCM clock shutdown

PCM clock start

PCM clock stop

Reserved

Channel 1 data in order

Channel 1 data out order

Channel 1 data out mode

Channel 1 data out duplication

Channel 1 TX_dup_value

Channel 1 data quant

Reserved

Channel 2 data in order

Channel 2 data out order

Channel 2 data out mode

Channel 2 data out duplication

Channel 2 TX_dup_value

Channel data quant

(1)

Reserved

Set by software during initialization

0

0

Hardware Default

0 (disable)

N/A

0 (most-significant bit [MSB] first)

0 (MSB first)

2 (input when idle)

(1)

0 (last sample)

0

0

N/A

0 (MSB first)

0 (MSB first)

2 (input when idle)

(1)

0 (last sample)

0

0

N/A

0

0

HCI Tester Command

0 (disable)

0

0 (MSB first)

0 (MSB first)

2 (input when idle)

0 (last sample)

0

0

0

0 (MSB first)

0

0

0

0 (MSB first)

2 (input when idle)

0 (last sample)

PCM Clock Shutdown

Value

0x00

0x01

Size: 1 byte

Parameter Description

PCM clock shutdown feature is disabled.

PCM clock shutdown feature is enabled. Time of start and stop is defined in the following two fields (used in master mode only).

26

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

PCM Clock Start

Value

0x0000–0xFFFF

PCM Clock Stop

Value

0x0000–0xFFFF

Channel X Data In Order

Value

Bit 0 = 0

Bit 0 = 1

Bit 1 = 0

Bit 1 = 1

Bit 2 = 0

Bit 2 = 1

Channel X Data Out Order

Value

Bit 0 = 0

Bit 0 = 1

Bit 1 = 0

Bit 1 = 1

Bit 2 = 0

Bit 2 = 1

Channel X Data Out Mode

Value

0x00

0x01

0x02

Channel X Data Out duplication

Value

0x00

0x01

Channel X TX_dup_value

Value

0x00000000–0x00FFFFFF

Channel X Data Quant

Value

0x00

0x01

Detailed Description of Supported VS HCI Commands and Events

Size: 2 bytes

Parameter Description

Number of PCM clock cycles relative to the PCM frame sync to start PCM clock (for example, start two clocks before frame sync)

Size: 2 bytes

Parameter Description

Number of PCM clock cycles relative to the PCM frame sync to stop PCM clock (for example, stop 20 clocks after frame sync)

Size: 1 byte

Parameter Description

Data driven MSB first

Data driven least-significant bit (LSB) first

Don’t swap bytes within the sample.

Swap bytes within the sample in bit-wise mode when data size > 8 ([XYZ] → [ZYX]).

Do not shift the sample.

Shift the sample by (24|16-dout_size) bits from MSB to LSB (controls sample alignment inside internal register (23:0) in bit-wise mode only).

Size: 1 byte

Parameter Description

Data driven MSB first

Data driven LSB first

Do not swap bytes within the sample.

Swap bytes within the sample in bit-wise mode when data size > 8 ([XYZ] → [ZYX]).

Do not shift the sample.

Shift the sample by (24|16-dout_size) bits from MSB to LSB (controls sample alignment inside internal register (23:0) in bit-wise mode only).

Size: 1 byte

Parameter Description

Always 3-state (input)

Always output

Switch to 3-state (input) when idle

Size: 1 byte

Parameter Description

Retransmit last sample when no data are available.

Transmit DUP_VALUE when no data are available.

Size: 4 bytes

Parameter Description

Replacement value to transmit when no data is available

Size: 1 byte

Parameter Description

In bit-wise mode, the basic data unit is the entire sample (8 – 24 bits). In byte-wise mode, the basic data unit is 1 byte.

Bit-wise mode. Possible if data in and data out size are up to 24 bits.

Byte-wise mode

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

27

Detailed Description of Supported VS HCI Commands and Events

Reserved

Value

0x00

Parameter Description

Reserved. Must be set to 0.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed www.ti.com

Size: 4 bytes

Size: 1 byte

28

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.2.3

HCI_VS_Set_PCM_Loopback_Configuration (0xFD04)

Command

HCI_VS_Set_PCM_Loopback_Configuration

Opcode

0xFD04

Command Parameters Return Parameters

PCM loopback delay Status

Description:

This command configures the default

PCM loopback delay on the bus between the PCM input data and the PCM output data. The new delay affects the next PCM loopback channel enabled. If a PCM loopback channel is already activated, disable it, and then enable it again to use the new delay.

Command Parameters:

PCM Loopback Delay

Value

0x0001–0x0544

Size: 2 bytes

Parameter Description

This value defines the delay in sample units (number of frame syncs) between the input sample to the device and the output of the same sample from the device. Supports

0–1348 frame syncs.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

29

Detailed Description of Supported VS HCI Commands and Events

5.1.2.4

HCI_VS_Set_PCM_Loopback_Enable (0xFE28)

Command

HCI_VS_Set_PCM_Loopback_Enable

Opcode

0xFE28

Command Parameters

PCM loopback enable www.ti.com

Return Parameters

Status

Description:

This command enables pulse-code modulation (PCM) loopback between the PCM input data to the PCM output data.

Command Parameters:

PCM Loopback Enable

Value

0x00

0x01

Parameter Description

Stop PCM loopback operation.

Start PCM loopback operation.

Size: 1 byte

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

30

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

5.1.2.5

HCI_VS_A3DP_Open_Stream (0xFD8C)

Detailed Description of Supported VS HCI Commands and Events

Command

HCI_VS_A3DP_Open_Stream

Opcode

0xFD8C

Command Parameters

Connection handle

L2CAP CID

L2CAP

MTU

AVDTP version parameter

AVDTP payload parameter

Reserved

Reserved

Return Parameters

Status

Description:

This command must be called when the A2DP SNK moves to open state and establishes the transport

A2DP channel to open an A3DP entity in the controller. The command contains the protocol parameters required for L2CAP and AVDTP packet construction. SBC and SARC parameters are applied using the

HCI_VS_A3DP_CODEC_CONFIGURATION command.

Command Parameters:

Connection Handle

Value

0x01–0x07

Parameter Description

The ACL connection handle

Size: 1 byte

L2CAP CID

Value

0x0040–0xFFFF

L2CAP MTU

Value

0x0030–0xFFFF

AVDTP Version Parameter

Value

0x00–0x03

AVDTP Payload Parameter

Value

0x30–0xFF

Reserved

Value

Reserved

Value

Size: 2 bytes

Parameter Description

L2CAP channel ID of the AVDTP data stream. Refers to the L2CAP channel ID of the remote device.

Size: 2 bytes

Parameter Description

The maximum size of payload data, in octets, that the upper layer entity can accept

Size: 1 byte

Parameter Description

AVDTP protocol header version parameter

Size: 1 byte

Parameter Description

This AVDTP field identifies the format of the RTP payload and determines its interpretation by the application.

Size: 4 bytes

Parameter Description

For future use

Size: 4 bytes

Parameter Description

For future use

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

31

Detailed Description of Supported VS HCI Commands and Events

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed www.ti.com

Size: 1 byte

Events Generated:

Command Complete Event

5.1.2.6

HCI_VS_A3DP_Close_Stream (0xFD8D)

Command

HCI_VS_A3DP_Close_Stream

Opcode

0xFD8D

Command Parameters

Connection handle

Reserved

Return Parameters

Status

Description:

This command must be called when the A2DP SNK moves to idle state and closes the transport A2DP channel. A stream started by the start stream command must be stopped by the stop stream command before closing.

Command Parameters:

Connection Handle

Value

0x01–0x07

Parameter Description

The ACL connection handle

Size: 1 byte

Reserved

Value Parameter Description

For future use

Size: 4 bytes

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

32

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.2.7

HCI_VS_A3DP_Codec_Configuration (0xFD8E)

Command

HCI_VS_A3DP_Codec_Configuration

Opcode

0xFD8E

Command Parameters

Audio Source

PCM input sample frequency

PCM number of channels

SBC input sample frequency

SBC channel mode

SBC number of blocks

SBC number of sub-bands SBC allocation method

SBC bit pool low boundary

SBC recommended bit pull

SBC dynamic bit pull enable

Reserved

Reserved

Return

Parameters

Status

Description:

This command configures the PCM source type, SBC encoder, and SARC parameters. This command must not be called during streaming, meaning no stream has started using the start stream command.

The command can refer to a specific stream, or to both active streams in a multiple SNK scenario. In addition to that API call, the controller PCM codec must also be configured using the commands:

• HCI_VS_Write_CODEC_Config

• HCI_VS_Write_CODEC_Config_Enhanced

Command Parameters:

Size: 1 byte Audio Source

Value

0x00

Parameter Description

Determines the audio source of the A2DP stream:

0–Audio source is the host through the PCM bus

PCM Input Sample

Value

0x01–0x09

PCM Number of Channels

Value

0x01–0x02

Size: 1 byte

Parameter Description

The PCM sample frequency rate of the input PCM bus. This parameter is valid only when the audio source is the host. When this parameter is different from the SBC input sample frequency parameter, the SARC is used for sample rate conversion.

0x01: 8000 Hz

0x02: 11025 Hz

0x03: 12000 Hz

0x04: 16000 Hz

0x05: 22050 Hz

0x06: 24000 Hz

0x07: 32000 Hz

0x08: 44100 Hz

0x09: 48000 Hz

Size: 1 byte

Parameter Description

The number of channels (1 or 2) of the PCM input. This parameter is valid only when the audio source is the host.

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

33

Detailed Description of Supported VS HCI Commands and Events

SBC Input Sample Frequency

Value

0x00–0x03 www.ti.com

Size: 1 byte

Parameter Description

The sample frequency rate of the PCM input to SBC encoder. Note that when this parameter is different from the PCM input sample frequency, the SARC is used for sample rate conversion.

0x00: 16000 Hz

0x01: 32000 Hz

0x02: 44100 Hz

0x03: 48000 Hz

SBC Channel Mode

Value

0x00–0x03

SBC Number of Blocks

Value

0x04, 0x08, 0x0C, 0x10

SBC Number of Subbands

Value

0x04, 0x08, 0x0C, 0x10

SBC Allocation Method

Value

0x00–0x01

SBC Bit Pool Low Boundary

Value

0x00–0x39

SBC Recommended Bit Pull

Value

0x00–0x39

SBC Dynamic Bit Pull enable

Value

0x00–0x01

Reserved

Value

Size: 1 byte

Parameter Description

Describes the channel mode used to encode a stream:

0x00: MONO

0x01: DUAL_CHNL

0x02: STEREO

0x03: JOINT_STEREO

Size: 1 byte

Parameter Description

Number of SBC blocks. (4, 8, 12, 16)

Size: 1 byte

Parameter Description

Number of SBC encoder blocks. (4, 8, 12, 16)

Size: 1 byte

Parameter Description

SBC allocation method (SNR, Loudness):

0: Loudness

1: SNR

Size: 1 byte

Parameter Description

The lower boundary of the negotiated bit pool range.

Size: 1 byte

Parameter Description

The host can recommend a specific bit pool value from the bit pool rate. The recommended bit pool value is also used as the high boundary in dynamic bit pool.

Size: 1 byte

Parameter Description

Determines whether a dynamic bit pool mechanism should be used for performance and quality adjustment:

0: Disable

1:Enable

Size: 4 bytes

Parameter Description

For future use

34

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Reserved

Value

Detailed Description of Supported VS HCI Commands and Events

Size: 4 bytes

Parameter Description

For future use

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Events Generated:

Command Complete Event

5.1.2.8

HCI_VS_A3DP_Start_Stream (0xFD8F)

Size: 1 byte

Command

HCI_VS_A3DP_Start_Stream

Opcode

0xFD8F

Command Parameters

Connection handle

Reserved

Return Parameters

Status

Description:

This command starts the A2DP data streaming to the remote device. The host must initiate PCM audio data immediately following this API call. When no PCM data is accepted at the controller after this command call, no data is sent to the peer device.

Command Parameters:

Connection Handle

Value

0x01–0x07

Parameter Description

The ACL connection handle

Size: 1 byte

Reserved

Value Parameter Description

For future use

Size: 4 bytes

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

35

Detailed Description of Supported VS HCI Commands and Events

5.1.2.9

HCI_VS_A3DP_Stop_Stream (0xFD90)

www.ti.com

Command

HCI_VS_A3DP_Stop_Stream

Opcode

0xFD90

Command Parameters

Connection handle

Flush flag

Generate stop event

Reserved

Return Parameters

Status

Description:

This command stops the SBC data streaming to the remote device. An input parameter determines whether the current internal buffers must be transmitted to the remote device (or devices) and then flushed (soft flush) or flushed immediately (hard flush). That option might be required if the stream stopped between songs for reconfiguration, so that the song ending should be heard by the user and not flushed.

A VS event is generated at the completion of the operation, if requested.

Command Parameters:

Connection Handle

Value

0x01–0x07

Parameter Description

The ACL connection handle

Size: 1 byte

Flush Flag

Value

0x00–0x01

Generate Stop Event

Value

0x00–0x01

Reserved

Value

Size: 1 byte

Parameter Description

Determines whether the current internal buffers should be transmitted to the remote device (or devices), or should be flushed immediately.

0x00: Transmit internal buffers before flush (soft flush)

0x01: Immediate flush of buffers (hard flush)

Size: 1 byte

Parameter Description

Determines whether a stop stream event will be generated as soon as stream is stopped. To be used in Soft Flush.

0x00: No

0x01: Yes

Size: 4 bytes

Parameter Description

For future use

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

36

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.3

RF and PHY Configuration Commands

This section describes the RF and PHY configuration commands.

5.1.3.1

HCI_VS_DRPb_Enable_RF_Calibration_Enhanced (0xFDFB)

Command Opcode

HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB

Command Parameters

Mode

Periodic Options

Calibration procedures selection

Override temp condition

Return

Parameters

Status

Description:

The command configures internal RF calibrations. Calibrations can run immediately (once) or periodically.

Define the calibration procedures needed to run in each calibration mode. When enabling periodic mode run, the calibration will start running immediately, next periodic calibration will start after the configurable period.

NOTE:

The command must run only during the initialization process as part of the initialization script.

Command Parameters:

Mode

Value

0x00

0x01

Parameter Description

0x00 = Initial calibration (activate the selected calibrations one time)

0x01 = Periodic calibration

Size: 1 byte

Periodic Options

Value

0x00–0xFD

0xFF

Calibration Procedures Selection

Value

0x00000000–0x0000FFFF

0xFFFFFFFF

Size: 1 byte

Parameter Description

0x00–0xFD = sets the selected calibration period to [Value × 10] seconds. Performs when the system is in standby mode.

0xFE = Keep periodic calibration (update "Calibration procedures selection" and

"Override temp condition" without executing the calibrations themselves). Default = 5 minutes or 0x1E).

0xFF = Stop periodic calibration

Size: 4 bytes

Parameter Description

0x00000000–0x0000FFFF = See Procedures bitmap

0xFFFFFFFF = Keep last bitmap

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

37

Detailed Description of Supported VS HCI Commands and Events

Bit 3

Bit 4

Bit 5

Bit 6

Bit 7

Procedures Bitmap

Value

Bit 0

Bit 1

Bit 2

Bit 8

Bit 9

Bit 10

Bit 11

Bit 12

Bit 13

Bit 14

Bit 15

Bit 16

Bit 17

Bit 18

Bits 19–31

Parameter Description

Initialization

Timing

Random Seed

Clocks

AFE (Analog Front End)

DC

LDO

DCO current

DCO Open Loop Freq

KDCO

Not Used

TPC (Transmit Power Control)

IFA Pole (IF Amplifier filter pole)

Not Used

Not Used

Not Used

Not Used

PD Extract (Pre Distortion extract)

Not Used

Reserved

Override Temp Condition

Value

0x00

0x01

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Default Mode (After Initialization)

Disable

Disable

Disable

Disable

Disable

Disable

Disable

Disable

Disable

Disable

Disable

Disable

Parameter Description

Run selected calibrations only if temperature range changed

Run selected calibrations regardless of temperature range changes

Parameter Description

Command succeeded

Command failed

Disable www.ti.com

Size: 1 byte

Size: 1 byte

38

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.3.2

HCI_VS_DRPb_Set_Power_Vector (0xFD82)

Command

HCI_VS_DRPb_Set_Power_Vector

Opcode

0xFD82

Command Parameters

Power type

Power level N value (N = 0 – 7) tx_power_edr_epc_idx

Reserved

Return Parameters

Status

Description:

The transmit power control algorithm is based on the capability to construct the amplitude control word

(ACW) for any given power level in dBm (see Note 1), as long as it is in the supported range.

When Vbat decreases below ≈3 V, automatic Vbat detection switches between HP (high power, Vbat is higher than 3 V) and LP (low power, Vbat is lower than 3 V) vectors; thus, setting both HP and LP power vectors is required for the relevant modulations.

NOTE:

1.

Each power level (dBm) must be a multiple of 2. For example: for 10 dBm, the value of

10 × 2 (or decimal value of 20) must be used. When configuring power tables, a command must be sent for each modulation type. In addition, after configuring the power vectors, the TPC calibration must run in initial calibration mode and the Override temp changes configuration.

2.

The number of power levels must be the same for all power vector types (all modulation types). There are 0-7 levels.

3.

Vbat is measured with an on-chip ADC that has an accuracy error of up to 5%.

4.

Due to hysteresis, there is a threshold voltage that causes the transition between HP and LP modes and vice versa:

From LP to HP → 3.2 V

From HP to LP → 3.0 V

Default:

############################################################

#### Power Tables ROM Data is aligned to the following ####

############################################################

############################################################

#### Low Power (LP) Vector Table ####

############################################################

#Set BT BR (GFSK) LP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 0x00, -22.5 *2, -18 *2, -13.5 *2, -9 *2, -

4.5 *2, 0 *2, 5 *2, 10 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set BT LE (BLE) LP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 0x03, -22.5 *2, -18 *2, -13.5 *2, -9 *2, -

4.5 *2, 0 *2, 5 *2, 10 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set ANT LP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 0x04, -22.5 *2, -18 *2, -13.5 *2, -9 *2, -

4.5 *2, 0 *2, 5 *2, 10 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set BT BR EDR 2MB LP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 0x01, -25 *2, -20.5 *2, -16 *2, -11.5 *2, -7 *2, -

2 *2, 3 *2, 8 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

39

Detailed Description of Supported VS HCI Commands and Events

www.ti.com

#Set BT BR EDR 3MB LP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 0x02, -25 *2, -20.5 *2, -16 *2, -11.5 *2, -7 *2, -

2 *2, 3 *2, 8 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

############################################################

#### High Power (HP) Vector Table ####

############################################################

#Set BT BR (GFSK) HP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 8, -19.5 *2, -14.5 *2, -9.5 *2, -

4.5 *2, 0.5 *2, 5.5 *2, 10.5 *2, 15.5 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set BT LE (BLE) HP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 9, -19.5 *2, -14.5 *2, -9.5 *2, -

4.5 *2, 0.5 *2, 5.5 *2, 10.5 *2, 15.5 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set ANT HP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 10, -19.5 *2, -14.5 *2, -9.5 *2, -

4.5 *2, 0.5 *2, 5.5 *2, 10.5 *2, 15.5 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set BT BR EDR 2MB HP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 11, -22.5 *2, -18 *2, -13.5 *2, -9 *2, -

4.5 *2, 0 *2, 5 *2, 10 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#Set BT BR EDR 3MB HP Vectors Values (note the need to multiply the output power in dBm by '2'

Send_HCI_VS_DRPb_Set_Power_Vector 0xFD82, 12, -22.5 *2, -18 *2, -13.5 *2, -9 *2, -

4.5 *2, 0 *2, 5 *2, 10 *2, 0x3F, 0x00FF

Wait_HCI_Command_Complete_VS_DRPb_Set_Power_Vector_Event 5000, any,

HCI_VS_DRPb_Set_Power_Vector,0x00

#############################################################

#### Class 2 Power ROM Data is aligned to the following ####

#############################################################

Send_HCI_VS_DRPb_Set_Class2_Single_Power 0xFD87, 5, 5, 5, 5, 5, 4, 5, 4, 4, 4

Wait_HCI_Command_Complete_VS_DRPb_Set_Class2_Single_Power_Event 5000, any,

HCI_VS_DRPb_Set_Class2_Single_Power, 0x00

40

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Command parameters:

Power Table Type (Modulation Type)

Value

0x00–0x04

0x08–0x0C

Detailed Description of Supported VS HCI Commands and Events

Parameter Description

LP = Low Power (Vbat is lower than ≈3 V)

HP = High Power (Vbat is higher than ≈3 V)

0x00 = BT BR (GFSK) LP

0x01 = BT EDR 2MB LP

0x02 = BT EDR 3MB LP

0x03 = BT LE (BLE) LP

0x04 = ANT LP

0x08 = BT BR (GFSK) HP

0x09 = BT LE (BLE) HP

0x0A = ANT HP

0x0B = BT EDR 2MB HP

0x0C = BT EDR 3MB HP

Size: 1 byte

Size for Each Power Level N Value: 1 byte Power Level N Value (N = 0 – 7)

Value

BT BR (GFSK) LP: –45 – 20

BT LE (BLE) LP: –45 – 20

ANT LP: –45 – 20

BT EDR 2MB LP: –50 – 16

BT EDR 3MB LP: –50 – 16

BT BR (GFSK) HP: –39 – 31

BT LE (BLE) HP: –39 – 31

ANT HP: –39 – 31

BT EDR 2MB HP: –45 – 20

BT EDR 3MB HP: –45 – 20

tx_power_edr_epc_idx

Value

0x00–0x3F

Parameter Description

Required RF power for each of the 8 power levels (0–7) in dBm, multiplied by 2

Size: 1 byte

Parameter Description

EDR power level index for EPC (enhanced power control) use.

This parameter indicates the BT BR (GFSK) power level index that holds the value similar (up to ±2 dB) to the EDR power level value in index 7 (maximal index).

For EDR 2-MB modulation, bits 0–2 are used.

For EDR 3-MB modulation, bits 3–5 are used.

Size: 2 bytes

Parameter Description

Reserved

Reserved

Value

Reserved

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

41

Detailed Description of Supported VS HCI Commands and Events

Procedure:

For power level vector update:

1. Set the power vector type (modulation) to update the power level vector.

NOTE:

If updating all power levels for all supported modulation types, then 10

HCI_VS_DRPb_Set_Power_Vector commands will be executed.

2. Set the desired power (in dBm × 2) for each of the power levels (0–7).

www.ti.com

NOTE:

• When setting the new power levels, follow the power limitations described previously in the Power level n value parameter table. Start by setting the maximal output power level

(level 7) according to the need, and then set the rest of the power levels, maintaining steps of –4.5 dB, –5 dB, or –5.5 dB until reaching the lowest allowed power value. This step is required to maintain the 2- to 8-dB step size allowed by the specification.

• To stop at a particular power level (which is any power level m ≠ 0), the same value written in power level m must be duplicated in all power levels m-1, m-2, … , 0.

• For Bluetooth low energy modulation, when setting the power level 7 value, remember to meet the maximum 10-dBm output power at the antenna.

3. Per LP and HP and according to the EDR2 or EDR3 modulation type, set the tx_pwr_edr_epc_idx parameter.

NOTE:

Keep the same value in any LP or HP family of vectors (even when the modulation type in the command is not EDR2 or EDR3).

4. If necessary, configure and execute the relevant Class 2 single power to use with a peer device that does not support power control (per LP/HP and per modulation) using:

HCI_VS_DRPb_Set_Class2_Single_Power (0xFD87).

5. Execute transmit power control (TPC) calibration, configuring Initialization calibration mode and override temp changes condition:

# Run TPC calibration to update the ACW (Amplitude Control Word) to the PA

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 0x00, 0x00000800, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event 5000, any,

HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

42

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.3.3

HCI_VS_DRPb_Set_Class2_Single_Power (0xFD87)

Command Opcode

HCI_VS_DRPb_Set_Class2_Single_Power 0xFD87

Command Parameters

GFSK power level idx LP

EDR2 power level idx LP

EDR3 power level idx LP

BLE power level idx LP

ANT power level idx LP

GFSK power level idx HP

BLE power level idx HP

ANT power level idx HP

EDR2 power level idx HP

EDR3 power level idx HP

Return Parameters

Status

Description:

This command allows the user to set the power level to use during a connection so that the fixed power does not compress the other receiver. This is done by selecting from the 8 available power levels. The device then transmits at this level all the time. This single power should be set according to the power level vectors configurations, per modulation scheme, and per low power (LP) and high power (HP), and initiated through: HCI_VS_DRPb_Set_Power_Vector (0xFD82).

NOTE:

The output power in a connection cannot exceed the maximum output power of power class

2 for transmitting packets, if the receiving device does not support the necessary messaging to send the power control messages.

Command Parameters:

GFSK Power Level idx LP

Value

0x00–0x07

Parameter Description

Sets the GFSK power level to use without power control for LP vectors

Size: 1 byte

EDR2 Power Level idx LP

Value

0x00–0x07

EDR3 Power Level idx LP

Value

0x00–0x07

BLE Power Level idx LP

Value

0x00–0x07

ANT Power Level idx LP

Value

0x00–0x07

GFSK Power Level idx HP

Value

0x00–0x07

Size: 1 byte

Parameter Description

Sets the EDR2 power level idx to be used without power control for LP vectors

Size: 1 byte

Parameter Description

Sets the EDR3 power level idx to be used without power control for LP vectors

Size: 1 byte

Parameter Description

Sets the Bluetooth low energy power level idx to be used without power control for LP vectors

Size: 1 byte

Parameter Description

Sets the Bluetooth low energy power level idx to be used without power control for LP vectors

Size: 1 byte

Parameter Description

Sets the GFSK power level idx to be used without power control for HP vectors

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

43

Detailed Description of Supported VS HCI Commands and Events

BLE Power Level idx HP

Value

0x00–0x07 www.ti.com

Size: 1 byte

Parameter Description

Sets the Bluetooth low energy power level idx to be used without power control for HP vectors

ANT Power Level idx HP

Value

0x00–0x07

EDR2 Power Level idx HP

Value

0x00–0x07

EDR3 Power Level idx HP

Value

0x00–0x07

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Size: 1 byte

Parameter Description

Sets the ANT power level idx to be used without power control for HP vectors

Size: 1 byte

Parameter Description

Sets the EDR2 power level idx to be used without power control for HP vectors

Size: 1 byte

Parameter Description

Sets the EDR3 power level idx to be used without power control for HP vectors

Parameter Description

Command succeeded

Command failed

Size: 1 byte

44

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.3.4

HCI_VS_DRPb_Tester_Con_TX (0xFDCA)

Command

HCI_VS_DRPb_Tester_Con_TX

Opcode

0xFDCA

Command Parameters

Frequency

Modulation scheme

Test pattern

Power level index

Reserved

Reserved

Return Parameters

Status

Description:

This command operates the RF transceiver in continuous transmission mode, which is most likely used in regulatory and standardization procedures and tests, such as FCC and ETSI certifications. Activating the

VS runs the TX START sequence code using the configured frequency, modulation, pattern, and power level. The VS also enables the generation of a user-defined pattern (or correcting definitions without a patch) by setting a new pattern generator (also known as a PN generator) initialization value and mask.

NOTE:

1.

Unlike a normal connection, the PHY configuration does not take place in the MAC.

Instead, the reception parameters are set by the VS command itself (RX mode, frequency, and so on), directly to the registers.

2.

Periodic calibration activity might interrupt the continuous transmission activity. Recall disabling periodic calibration activity when continuous transmission duration is longer than the periodic calibration period duration:

# Disable periodic calibration

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 1, 0xFF,

0x00000000, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event

5000, any, HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

# Disable RXRX periodic calibration

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 3, 0xFF,

0x00000000, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event

5000, any, HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

# Disable RXRX LNA (periodic) calibration

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 4, 0xFF,

0x00000000, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event

5000, any, HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

Command Parameters:

Register Address

Value

2402–2480

Parameter Description

Transmission frequency in MHz

Size: 2 bytes

Modulation Scheme

Value

0x00–0x05

Parameter Description

0x00 = CW

0x01 = BT BR (GFSK)

0x02 = BT EDR 2MB ( π/4-DQPSK)

0x03 = BT EDR 3MB (8-DPSK)

0x04 = BT LE (BLE, GFSK)

0x05 = ANT (GFSK)

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

45

Detailed Description of Supported VS HCI Commands and Events

Test Pattern

Value

0x00–0x07

Parameter Description

0x00 = PN9

0x01 = PN15

0x02 = ZOZO (101010101010101010)

0x03 = All 1

0x04 = All 0

0x05 = FOFO (1111000011110000)

0x06 = FFOO (1111111100000000)

0x07 = Not used

Power Level Index

Value

0x00–0x07

0x08 (PA off)

Parameter Description

Range 0–7: 7 = Max Output Power (default), 0 = Min Output Power

8 = PA Off (leakage)

Note: Value is written as is. Make sure to configure legal values only.

www.ti.com

Size: 1 byte

Size: 1 byte

Size: 4 bytes Reserved

Value

0x00000000

Reserved

Value

0x00000000

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Reserved

Parameter Description

Reserved

Parameter Description

Command succeeded

Command failed

Size: 4 bytes

Size: 1 byte

46

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.3.5

HCI_VS_DRPb_Tester_Con_RX (0xFDCB)

Command Opcode

HCI_VS_DRPb_Tester_Con_RX 0xFDCB

Command Parameters

Frequency

RX mode

Modulation type

Return Parameters

Status

Description

This command operates the RF transceiver in continuous reception mode (most likely used in regulatory and standardization procedures and tests, such as FCC and ETSI certifications). By activating the VS, the

RX START sequence code runs, using the configured frequency, RX mode, and modulation type.

NOTE:

1.

Unlike a normal connection, the PHY configuration does not take place in the MAC.

Instead, the reception parameters are set by the VS command itself (RX mode, frequency, and so on), directly to the registers.

2.

Periodic calibration activity might interrupt the continuous transmission activity. Recall disabling periodic calibration activity when continuous transmission duration is longer than the periodic calibration period duration:

# Disable periodic calibration

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 1, 0xFF,

0x00000000, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event

5000, any, HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

# Disable RXRX periodic calibration

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 3, 0xFF,

0x00000000, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event

5000, any, HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

# Disable RXRX LNA (periodic) calibration

Send_HCI_VS_DRPb_Enable_RF_Calibration_Enhanced 0xFDFB, 4, 0xFF,

0x00000000, 0x01

Wait_HCI_Command_Complete_VS_DRPb_Enable_RF_Calibration_Enhanced_Event

5000, any, HCI_VS_DRPb_Enable_RF_Calibration_Enhanced, 0x00

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

47

Detailed Description of Supported VS HCI Commands and Events

Command Parameters:

Frequency

Value

2402–2480

Parameter Description

Reception frequency in MHz

RX Mode

Value

0x00–0x03

Parameter Description

0x00 = Connection mode

0x01 = Reserved

0x02 = Reserved

0x03 = Scan mode

Modulation Type

Value

0x00–0x05

Parameter Description

0x00 = CW

0x01 = BT BR (GFSK)

0x02 = BT EDR 2MB ( π/4-DQPSK)

0x03 = BT EDR 3MB (8-DPSK)

0x04 = BT LE (BLE, GFSK)

0x05 = ANT (GFSK)

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed www.ti.com

Size: 2 bytes

Size: 1 byte

Size: 1 byte

Size: 1 byte

48

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.3.6

HCI_VS_DRPb_Tester_Packet_TX_RX (0xFDCC)

Command

HCI_VS_DRPb_Tester_Packet _TX_RX

Opcode

0xFDCC

Command Parameters

ACL TX packet type

Frequency mode

TX single frequency

RX single frequency

ACL TX data pattern

Reserved

ACL packet data length

Power level index

Disable whitening

PRBS9 Initialization value

Return Parameters

Status

Description

This command operates the RF transceiver in continuous reception mode (most likely used in regulatory and standardization procedures and tests, such as FCC and ETSI certifications). Activating the VS runs the RX START sequence code using the configured frequency, RX mode, and modulation type.

This command emulates Bluetooth connection mode. Connection does not require a setup procedure.

Command Parameters:

ACL TX Packet Type

Value

Size: 1 byte

0x00–0x0B

Parameter Description

0x00 = DM1 (default)

0x01 = DH1

0x02 = DM3

0x03 = DH3

0x04 = DM5

0x05 = DH5

0x06 = 2-DH1

0x07 = 2-DH3

0x08 = 2-DH5

0x09 = 3-DH1

0x0A = 3-DH3

0x0B = 3-DH5

Size: 1 byte Frequency Mode

Value

0x00

0x03 (default)

TX Single Frequency

Value

2402–2480

0xFFFF

RX Single Frequency

Value

2402–2480

0xFFFF

Parameter Description

Hopping

Single frequency

Parameter Description

Transmission frequency in MHz

No TX

Parameter Description

Transmission frequency in MHz

No RX

Size: 2 bytes

Size: 2 bytes

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

49

Detailed Description of Supported VS HCI Commands and Events

ACL TX Packet Data pattern

Value

0x00

0x01

0x02

0x03

0x04

0x05

Parameter Description

All 0

All 1

ZOZO (101010101010101010) (default)

FOFO (1111000011110000)

Ordered (1, 2, 3, 4, and so on)

PRBS9 (pseudo-random bit sequence)

Reserved

Value

0x00

ACL Packet Data Length

Value

DM1: 0–17

DH1: 0–27 (default)

DM3: 0–121

DH3: 0–183

DM5: 0–224

DH5: 0–339

2-DH1: 0–54

2-DH3: 0–367

2-DH5: 0–679

3-DH1: 0–83

3-DH3: 0–552

3-DH5: 0–1021

Power Level Index

Value

0x00–0x07

0x08 (PA off)

Parameter Description

Reserved

Parameter Description

ACL packet data length in bytes

Disable Whitening

Value

0x00

0x01

PRBS9 Initialization value

Value

0x0000–0x01FF www.ti.com

Size: 1 byte

Size: 1 byte

Size: 2 bytes

Size: 1 byte

Parameter Description

Range 0–7: 7 = Max Output Power (default); 0 = Min Output; Power 8 = PA Off

(leakage)

Note: Value is written as is. Make sure configuring only legal values.

Size: 1 byte

Parameter Description

Enable whitening

Disable whitening

Size: 2 bytes

Parameter Description

Used only in PRBS9 patterns to initialize PRBS9 data

50

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

5.1.3.7

HCI_VS_DRPb_Reset (0xFD88)

Command

HCI_VS_DRPb_Reset

Opcode

0xFD88

Detailed Description of Supported VS HCI Commands and Events

Command Parameters

None

Return Parameters

Status

Description:

This VS command is designed to run the firmware sequence to reset all DRP (PHY) register values and bring them back to initial state.

This command can be used to stop the continuous transmission or continuous reception initiated through

HCI_VS_DRPb_Tester_Con_TX or HCI_VS_DRPb_Tester_Con_RX, respectively.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Events Generated:

Command Complete Event

5.1.3.8

HCI_VS_DRPb_BER_Meter_Start (0xFD8B)

Command Opcode

HCI_VS_DRPb_BER_Meter_Start 0xFD8B

Command Parameters

Frequency channel

Reserved

BD Address

LT Address

ACL Packet Type

Packet Length

Number of Packets

PRBS Initialize

POLL Period

Return Parameters

Status

Description:

This command activates the internal software-based BER meter, while the device receives a predefined pseudo-random binary sequence (PRBS) pattern created by another device or an I-Q RF modulator. The

VS command controls the reception frequency and the packet-connection parameters, turns on a continuous RX, and triggers the BER meter into operation so the BER result is logged out to a user interface (such as Logger).

Command Parameters:

Frequency Channel

Value

Size: 1 byte

0 ÷ 78

Parameter Description

Frequency channel index (k), range 0–78 (decimal)

Freq = 2402 + 2k, for k = 0, 1, 2… 39

Freq = 2403 + 2(k–40), for k = 40, 41…78

Reserved

Value

0x00

Parameter Description

Reserved

Size: 6 bytes

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

51

Detailed Description of Supported VS HCI Commands and Events

BD Address

Value

0x000000000000 ÷ 0xFFFFFFFFFFFF

Parameter Description

BD address of the device being tested by its internal BER meter

LT Address

Value

0 ÷ 5

ACL Packet Type

Value

Parameter Description

Address of the device within a specific Piconet

0x00 ÷ 0x0B

Parameter Description

0x00 = DM1

0x01 = DH1 (default)

0x02 = DM3

0x03 = DH3

0x04 = DM5

0x05 = DH5

0x06 = 2-DH1

0x07 = 2-DH3

0x08 = 2-DH5

0x09 = 3-DH1

0x0A = 3-DH3

0x0B = 3-DH5

Packet Length

Value

0x0000 ÷ 0x03FD

Parameter Description

Number of bytes per packet, according to packet type

DM1: 0–17

DH1: 0–27

DM3: 0–121

DH3: 0–183

DM5: 0–224

DH5: 0–339

2-DH1: 0–54

2-DH3: 0–367

2-DH5: 0–679

3-DH1: 0–83

3-DH3: 0–552

3-DH5: 0–1021

Number of Packets

Value

0x0000 ÷ 0xFFFF

PRBS Initialization Value

Value

0x0000 ÷ 0x01FF

Poll Period

Value

0x00 ÷ 0xFF

Parameter Description

Number of packets from 0 to 65,535

Parameter Description

Value from which the PRBS pattern generator must start

Parameter Description

Poll period in number of Bluetooth frames www.ti.com

Size: 6 bytes

Size: 1 byte

Size: 1 byte

Size: 2 bytes

Size: 2 bytes

Size: 2 bytes

Size: 1 byte

52

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Return Parameters:

Status

Value

0x00

0x01–0xFF

Detailed Description of Supported VS HCI Commands and Events

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Events Generated:

Command Complete Event

5.1.3.9

HCI_VS_DRP_Read_BER_Meter_Result (0xFD13)

Command Opcode

HCI_VS_DRP_Read_BER_Meter_Result 0xFD13

Command Parameters Return Parameters

Status

Finished at least 1 test

Packets received

Total bits counted

Number of error bits found

Description:

This command allows reading of the BER result produced by the internal software-based BER meter. The results are logged to the device HCI debug interface (Logger application). This command can be used instead of the logger to enable the use of the BER meter results in production testing where the Logger is not available.

Command Parameters: There are no command parameters.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Size: 1 byte Finished at Least 1 Test

Value

0x00

0x01

Packets Received

Value

Parameter Description

First test has not been finished.

Values are valid for current measurement.

Parameter Description

Number of packets received in current measurement.

Size: 2 byte

Total Bits Counted

Value Parameter Description

Total number of bits counted.

Size: 4 byte

Number of Error Bits Found

Value Parameter Description

Number of bits in error in a single test cycle.

Size: 1 byte

Events Generated:

Command Complete Event

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

53

Detailed Description of Supported VS HCI Commands and Events

5.1.4

Debug Commands

This section describes the debug commands.

5.1.4.1

HCI_VS_Set_Supported_Features (0xFF26)

Command

HCI_VS_Set_Supported_Features

Opcode

0xFF26

Description:

This command changes the supported features of the device.

Command Parameters:

Byte

Value

0x00

0x01

0x02

0x03

0x04

0x05

0x06

0x07

Parameter Description

Byte 0

Byte 1

Byte 2

Byte 3

Byte 4

Byte 5

Byte 6

Byte 7

Command Parameters

Byte

Bit

Support www.ti.com

Return Parameters

Status

Size: 1 byte

Size: 1 byte Bit

Value

0–7

0xXX

Support

Value

0x00

0x01

0xFF

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Single bit

Whole byte value

Parameter Description

Not supported

Supported

Change whole byte

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Size: 1 byte

54

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

5.1.4.2

HCI_VS_Get_System_Status (0xFE1F)

Detailed Description of Supported VS HCI Commands and Events

Command

HCI_VS_Get_System_Status

Opcode

0xFE1F

Command Parameters

None

Return Parameters

Status

Software version X

Software version Z

Chip revision

Chip mode

Root Clock

Slow clock used

Process type detected

ODP Process

Deep-sleep mode

Whitening mode

CDC mode

Self-test

Hopping mode

UART baud rate

Temperature detected

Index

Temperature value

FREF/TCXO clock

Reserved

Reserved

Description:

This command returns the current system parameters.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Software Version X

Value

0x01–0xFF

Software Version Z

Value

0x01–0xFF

Chip Revision

Value

0x00–0xFF

Chip Mode

Value

0x00

0x01

0x02–0x05

Parameter Description

Major version of the software used.

Parameter Description

Internal software version.

Parameter Description

Hardware revision number.

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Parameter Description

Reserved for TI internal use

TI mode

Reserved for TI internal use

FREF

Value

0x0000–0xFFFF

Parameter Description

FREF in use (kHz)

Size: 2 bytes

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

55

Detailed Description of Supported VS HCI Commands and Events

Slow Clock Used

Value

0x00

0x01

Parameter Description

Internal slow clock used

External slow clock used

Process Type Detected

Value

0x00

0x01

0x02

ODP Process

Value

0x00

0x01

0x02

Deep-Sleep Mode

Value

0x00

0x01

0x02

0x03–0x08

Whitening Mode

Value

0x00

0x01

CDC Mode

Value

0x00

0x01

Self-Test

Value

0x00

0x01

Hopping Mode

Value

0x00

0x01

0x02

0x03

UART Baud Rate

Value

0x00000000–0xFFFFFFFF

Parameter Description

Nominal process detected

Weak process detected

Strong process detected

Parameter Description

Nominal process detected

Weak process detected

Strong process detected

Parameter Description

Deep sleep disabled

Reserved

HCILL deep sleep enabled

For future use

Parameter Description

Whitening enabled

Whitening disabled

Parameter Description

CDC disabled

CDC enabled

Parameter Description

Self-test failed

Self-test passed

Parameter Description

Frequency Hopping

Single Frequency TX and RX

Only TX Single Frequency

Only RX Single Frequency

Parameter Description

UART baud rate (bps) www.ti.com

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 1 byte

Size: 4 bytes

56

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Temperature Index

Value

0x00

0x01

0x02

0x03

0x04

Temperature Detected

Value

0x00–0x7F

0xFF–0x80

I2C Status

Value

Bit 0

Bit 1

Bit 2

FREF/TCXO Clock

Value

0x0000–0xFFFF

Reserved

Value

Reserved

Value

Detailed Description of Supported VS HCI Commands and Events

Size: 1 byte

Parameter Description

Hot

Room

Cold

Warm

Cool

Size: 1 byte

Parameter Description

Positive temperature value in Degrees Celsius.

Negative temperature in Degrees Celsius.

Size: 1 byte

Parameter Description

I2C Enabled

EEPROM Connected

Codec Connected

Size: 2 bytes

Parameter Description

This parameter returns the clock rate in kHz.

Size: 1 byte

Parameter Description

Reserved

Size: 1 byte

Parameter Description

Reserved

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

57

Detailed Description of Supported VS HCI Commands and Events

5.1.4.3

HCI_VS_Read_RSSI (0xFDFC)

Command

Send_HCI_VS_Read_RSSI

Opcode

0xFDFC

Command Parameters

Connection handle

Return Parameters

Status

Handle

RSSI www.ti.com

Description:

This command returns the RSSI value for a specified connection handle.

NOTE:

The Golden Range Threshold refers to an ideal range of RSSI values (–74 to –54). In some software, an RSSI value of 0 indicates that the RSSI value is within the Golden Range

Threshold. This command does not support this feature, and will return the precise RSSI value irrespective of the Golden Range Threshold.

Command Parameters:

Connection Handle

Value

0x01–0x07

Parameter Description

Connection handle

Size: 1 byte

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Size: 1 byte

Size: 2 bytes Handle

Value

0x0001–0x0007

RSSI

Value

Signed integer

Events Generated:

Command Complete Event

Parameter Description

Connection handle

Parameter Description

RSSI value

Size: 1 byte

58

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.5

Memory Access Commands

This section describes the memory access commands.

5.1.5.1

HCI_VS_Read_Hardware_Register (0xFF00)

Command

HCI_VS_Read_Hardware_Register

Opcode

0xFF00

Command Parameters

Register address

Return Parameters

Status

Register value

Description:

This command returns the value of a specific hardware register.

Command Parameters:

Register Address

Value

0xXXXXXXXX

Parameter Description

Address of register

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Size: 4 bytes

Size: 1 byte

Register Value

Value

0xXXXX

Events Generated:

Command Complete Event

Parameter Description

Value of register

Size: 2 bytes

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

59

Detailed Description of Supported VS HCI Commands and Events

5.1.5.2

HCI_VS_Write_Hardware_Register (0xFF01)

Command

HCI_VS_Write_Write_Register

Opcode

0xFF01

Description:

This command assigns a value to a hardware register.

Command Parameters:

Register Address

Value

0xXXXXXXXX

Parameter Description

Address of register

Register Value

Value

0xXXXX

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Value to assign

Parameter Description

Command succeeded

Command failed www.ti.com

Command Parameters

Register address

Register value

Return Parameters

Status

Size: 4 bytes

Size: 2 bytes

Size: 1 byte

60

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Detailed Description of Supported VS HCI Commands and Events

5.1.5.3

HCI_VS_Read_Modify_Write_Hardware_Register (0xFD09)

Command

HCI_VS_Read_Modify_Write_Hardware_Register

Opcode

0xFD09

Command Parameters Return Parameters

Register address

Register value

Register mask

Status

Description:

This command assigns a value to a hardware register using a bit mask, thus changing only the requested bits.

Command Parameters:

Register Address

Value

0xXXXXXXXX

Parameter Description

Hardware register address (32 bits)

Size: 4 bytes

Register Value

Value

0xXXXX

Register Mask

Value

0xXXXX

Size: 2 bytes

Parameter Description

Value to be written. Bits that equal 0 in the mask are ignored.

Size: 2 bytes

Parameter Description

Bit mask of the bits to be overwritten. In every bit: 0 = No change; 1 = Change.

For every bit that equals 1 in the mask, the write value is taken from the corresponding bit in the Value field.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

Command succeeded

Command failed

Size: 1 byte

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

61

Detailed Description of Supported VS HCI Commands and Events

5.1.5.4

HCI_VS_Write_I2C_Register (0xFE0E)

www.ti.com

Command

HCI_VS_Write_I2C_Register

Opcode

0xFE0E

Command Parameters

Slave ID

Reserved

Working Frequency

Sub Address

Data Length

Data

Return Parameters

Status

Description:

Writes to the I2C register specified.

Command Parameters:

Slave ID

Value

0x00–0xFF

Parameter Description

Configured to the I2C address of the slave for communication.

Example:

• 0x71: Codec 1

• 0x1A : Codec 2

• 0x50: EEPROM

Size: 1 byte

Reserved

Value

0

Parameter Description

Reserved. Use 0 for future compatibility.

Size: 1 byte

Working Frequency

Value

0x0064–0x0190

Parameter Description

Sets transmission frequency in kHz. Range = 100 kHz–400 kHz

Example:

• CODEC speed, 400 kHz

• EEPROM speed, 100 kHz

Size: 2 bytes

Subaddress

Value

0–255

Data Length

Value

0x01–0x10

Data

Value

Parameter Description

Internal register address of the slave device to write to or read from.

Parameter Description

Data length in bytes (Range: 1–16 bytes).

Parameter Description

Data stream in hex, from left to right.

Size: 1 byte

Size: 1 byte

Size: 16 bytes

62

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Detailed Description of Supported VS HCI Commands and Events

Events Generated:

Command Complete Event

5.1.5.5

HCI_VS_Read_Memory (0xFF02)

Command

HCI_VS_Read_Memory

Opcode

0xFF02

Command Parameters

Memory address

Type

Description:

This command returns a specific memory address value.

Command Parameters:

Memory Address

Value

0xXXXXXXXX

Parameter Description

Legal address in memory

Size: 1 byte

Return Parameters

Status

Memory value

Size: 4 bytes

Size: 1 byte Type

Value

0x01

0x02

0x04

Return Parameters:

Status

Value

0x00

0x01–0xFF

Memory Value

Value

0xXXXXXXXX

Events Generated:

Command Complete Event

Parameter Description

UINT8

UINT16

UINT32

Parameter Description

Command succeeded

Command failed

Parameter Description

Any value

Size: 1 byte

Size: 1, 2, 4 bytes

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

63

Detailed Description of Supported VS HCI Commands and Events

5.1.5.6

HCI_VS_Write_Memory (0xFF03)

Command

HCI_VS_Write_Memory

Opcode

0xFF03

Command Parameters

Memory address

Type

Value

Description:

This command writes a value into a specific memory address.

Command Parameters:

Memory Address

Value

0xXXXXXXXX

Parameter Description

Memory address

Type

Value

0x01

0x02

0x04

Value

Value

0xXXXXXXXX

Return Parameters:

Status

Value

0x00

0x01–0xFF

Events Generated:

Command Complete Event

Parameter Description

UINT8

UINT16

UINT32

Parameter Description

Types 1, 2 – MS bytes don’t care

Parameter Description

Command succeeded

Command failed

Return Parameters

Status www.ti.com

Size: 4 bytes

Size: 1 byte

Size: 4 bytes

Size: 1 byte

64

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

5.1.5.7

HCI_VS_Read_Memory_Block (0xFF04)

Detailed Description of Supported VS HCI Commands and Events

Command

HCI_VS_Read_Memory_Block

Opcode

0xFF04

Description:

This command returns a specific memory block value.

Command Parameters:

Start Memory Address

Value

0xXXXXXXXX

Parameter Description

Any legal address

Command Parameters

Start memory address

Size (in bytes)

Return Parameters

Status

Memory block value

Size: 4 bytes

Size: 1 byte Size

Value

0x01–0xFA

Return Parameters:

Status

Value

0x00

0x01–0xFF

Memory Block Value

Value

Parameter Description

Any value from 1 to 250 bytes

Parameter Description

Command succeeded

Command failed

Parameter Description

Value of specified memory block

Size: 1 byte

Size: 1–250 bytes

Events Generated:

Command Complete Event

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

WiLink™ 8.0 Bluetooth

Copyright © 2015–2016, Texas Instruments Incorporated

®

Vendor-Specific HCI Commands

65

Reference Documents

5.1.5.8

HCI_VS_Write_Memory_Block (0xFF05)

Command

HCI_VS_Read_Write_Memory_Block

Opcode

0xFF05

Command Parameters

Start memory address

Size

Values

Description:

This command writes a value into a specific memory block address.

Command Parameters:

Start Memory Address

Value

0xXXXXXXXX

Parameter Description

Any legal address

Size (in bytes)

Value

0x01–0xFA1

Parameter Description

Any value from 1 to 250 bytes

6

Values

Value Parameter Description

Addresses increase from left to right.

Return Parameters:

Status

Value

0x00

0x01–0xFF

Parameter Description

Command succeeded

Command failed

Events Generated:

Command Complete Event

Reference Documents

Table 7

lists the reference documents referred to in this user's guide.

Document

1. Specification of the Bluetooth System

2. Specification of the Bluetooth System

3. Specification of the Bluetooth System

Table 7. Reference Documents

Revision

1.1

1.2

4.0

www.ti.com

Return Parameters

Status

Size: 4 bytes

Size: 1 byte

Size: 1–250 bytes

Size: 1 byte

Date

22 Feb 2001

05 Nov 2003

30 June 2010

66

WiLink™ 8.0 Bluetooth

®

Vendor-Specific HCI Commands

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

www.ti.com

Revision History

Revision History

Changes from October 22, 2015 to February 29, 2016

...................................................................................................

Page

• Added

Section 5.1.1.10

, HCI_VS_Clock_Set_Timeout (0xFE24)

.................................................................

22

NOTE: Page numbers for previous revisions may differ from page numbers in the current version.

SWRU442A – October 2015 – Revised February 2016

Submit Documentation Feedback

Copyright © 2015–2016, Texas Instruments Incorporated

Revision History

67

IMPORTANT NOTICE

Texas Instruments Incorporated and its subsidiaries (TI) reserve the right to make corrections, enhancements, improvements and other changes to its semiconductor products and services per JESD46, latest issue, and to discontinue any product or service per JESD48, latest issue. Buyers should obtain the latest relevant information before placing orders and should verify that such information is current and complete. All semiconductor products (also referred to herein as “components”) are sold subject to TI’s terms and conditions of sale supplied at the time of order acknowledgment.

TI warrants performance of its components to the specifications applicable at the time of sale, in accordance with the warranty in TI’s terms and conditions of sale of semiconductor products. Testing and other quality control techniques are used to the extent TI deems necessary to support this warranty. Except where mandated by applicable law, testing of all parameters of each component is not necessarily performed.

TI assumes no liability for applications assistance or the design of Buyers’ products. Buyers are responsible for their products and applications using TI components. To minimize the risks associated with Buyers’ products and applications, Buyers should provide adequate design and operating safeguards.

TI does not warrant or represent that any license, either express or implied, is granted under any patent right, copyright, mask work right, or other intellectual property right relating to any combination, machine, or process in which TI components or services are used. Information published by TI regarding third-party products or services does not constitute a license to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property of the third party, or a license from TI under the patents or other intellectual property of TI.

Reproduction of significant portions of TI information in TI data books or data sheets is permissible only if reproduction is without alteration and is accompanied by all associated warranties, conditions, limitations, and notices. TI is not responsible or liable for such altered documentation. Information of third parties may be subject to additional restrictions.

Resale of TI components or services with statements different from or beyond the parameters stated by TI for that component or service voids all express and any implied warranties for the associated TI component or service and is an unfair and deceptive business practice.

TI is not responsible or liable for any such statements.

Buyer acknowledges and agrees that it is solely responsible for compliance with all legal, regulatory and safety-related requirements concerning its products, and any use of TI components in its applications, notwithstanding any applications-related information or support that may be provided by TI. Buyer represents and agrees that it has all the necessary expertise to create and implement safeguards which anticipate dangerous consequences of failures, monitor failures and their consequences, lessen the likelihood of failures that might cause harm and take appropriate remedial actions. Buyer will fully indemnify TI and its representatives against any damages arising out of the use of any TI components in safety-critical applications.

In some cases, TI components may be promoted specifically to facilitate safety-related applications. With such components, TI’s goal is to help enable customers to design and create their own end-product solutions that meet applicable functional safety standards and requirements. Nonetheless, such components are subject to these terms.

No TI components are authorized for use in FDA Class III (or similar life-critical medical equipment) unless authorized officers of the parties have executed a special agreement specifically governing such use.

Only those TI components which TI has specifically designated as military grade or “enhanced plastic” are designed and intended for use in military/aerospace applications or environments. Buyer acknowledges and agrees that any military or aerospace use of TI components which have not been so designated is solely at the Buyer's risk, and that Buyer is solely responsible for compliance with all legal and regulatory requirements in connection with such use.

TI has specifically designated certain components as meeting ISO/TS16949 requirements, mainly for automotive use. In any case of use of non-designated products, TI will not be responsible for any failure to meet ISO/TS16949.

Products

Audio

Amplifiers

Data Converters

DLP® Products

DSP

Clocks and Timers

Interface

Logic

Power Mgmt

Microcontrollers

RFID

OMAP Applications Processors

Wireless Connectivity www.ti.com/audio amplifier.ti.com

dataconverter.ti.com

www.dlp.com

dsp.ti.com

www.ti.com/clocks interface.ti.com

logic.ti.com

power.ti.com

microcontroller.ti.com

Applications

Automotive and Transportation

Communications and Telecom

Computers and Peripherals

Consumer Electronics

Energy and Lighting

Industrial

Medical

Security

Space, Avionics and Defense

Video and Imaging www.ti-rfid.com

www.ti.com/omap

TI E2E Community

www.ti.com/wirelessconnectivity www.ti.com/automotive www.ti.com/communications www.ti.com/computers www.ti.com/consumer-apps www.ti.com/energy www.ti.com/industrial www.ti.com/medical www.ti.com/security www.ti.com/space-avionics-defense www.ti.com/video e2e.ti.com

Mailing Address: Texas Instruments, Post Office Box 655303, Dallas, Texas 75265

Copyright © 2016, Texas Instruments Incorporated

Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement

Table of contents