Vous êtes sur la page 1sur 58

_`

BlueVOX2 Configurator

User Guide
September 2006

CSR
Cambridge Science Park
Milton Road
Cambridge CB4 0WH
United Kingdom

Registered in England 4187346

Tel: +44 (0)1223 692000


Fax: +44 (0)1223 692001
Part of the BlueVOX2 Audio Solution www.csr.com

CSR plc 2005


CS-110372-UGP1
This material is subject to CSRs non-disclosure agreement.
Contents

Contents
1 Introduction .................................................................................................................................................... 3
1.1 General.................................................................................................................................................... 3
2 Description of BlueVOX Configurator Workspace ...................................................................................... 4
2.1 Functionality ............................................................................................................................................ 5
2.1.1 File Menu ..................................................................................................................................... 5
2.1.2 Output Menu ................................................................................................................................ 5
2.1.3 Properties Menu........................................................................................................................... 6

_` BlueVOX2 Configurator User Guide


2.1.4 View Menu ................................................................................................................................... 6
2.1.5 Help Menu.................................................................................................................................... 6
3 Opening a Default Configuration.................................................................................................................. 7
4 Advanced Configuration Parameters ........................................................................................................... 8
5 EEPROM Initialisation.................................................................................................................................... 9
5.1 Downloading Persistent Store Values to EEPROM ............................................................................... 10
6 Document References ................................................................................................................................. 11
Appendix A Description of PS Keys............................................................................................................ 12
A.1 Battery Configuration ............................................................................................................................. 14
A.2 Button Configuration .............................................................................................................................. 15
A.3 Button Sequence Configuration............................................................................................................. 15
A.4 Supported Features ............................................................................................................................... 16
A.5 PIO Input Configuration ......................................................................................................................... 16
A.6 HFP 1.5 Feature Configuration.............................................................................................................. 17
A.7 Enabling HFP 1.5 Support ..................................................................................................................... 18
A.8 Headset Timeouts ................................................................................................................................. 19
A.9 Radio Configuration ............................................................................................................................... 20
A.10 NiMH Charger Configuration ................................................................................................................. 21
A.11 Feature Configuration ............................................................................................................................ 22
A.12 Audio Gain Mapping .............................................................................................................................. 28
A.13 LED State Configuration ........................................................................................................................ 33
A.14 LED Event Configuration ....................................................................................................................... 36
A.15 LED Filter Configuration ........................................................................................................................ 39
A.16 Event Configuration ............................................................................................................................... 44
A.17 Tone Configuration ................................................................................................................................ 46
A.18 PIO Output Configuration ...................................................................................................................... 46
A.19 Tri Colour LED Information .................................................................................................................... 48
A.20 Power Table Settings ............................................................................................................................ 49
Appendix B BlueVOX2 System Events ....................................................................................................... 51
Appendix C BlueVOX2 Tones ...................................................................................................................... 54
Appendix D BlueVOX2 Headset States ....................................................................................................... 56
Terms and Definitions ........................................................................................................................................ 57
Document History ............................................................................................................................................... 58

CSR plc 2005


CS-110372-UGP1 Page 2 of 58
This material is subject to CSRs non-disclosure agreement.
Introduction

1 Introduction
BlueVOX is the generic name for CSRs mono headset solutions. BlueVOX provides a fast-track Bluetooth
headset solution allowing manufacturers to rapidly develop their own unique mono headset designs.

This document describes BlueVOX2 Configurator.

BlueVOX2 Configurator is a user-friendly tool developed to configure the Headset V4 and Headset V4 Refresh
mono headset software to suit the manufactures Human Machine Interface (HMI) design.

_` BlueVOX2 Configurator User Guide


The Headset v4 and Headset v4 Refresh software is designed to run on CSRs BlueCore4-Audio ROM and
BlueCore3-Audio Flash chips.

Note: BlueCore4-Audio ROM implementations require an external EEPROM to store the Persistent Store values that
configure the HMI. Chapter 5 describes how to initialise the EEPROM for use with the Headset V4 software.

To allow manufacturers to distinguish their final product in the market place the Headset v4 and Headset V4
Refresh software is designed with a highly configurable HMI.

Developers can readily:

Define PIO functionality to suit their hardware design.


Associate device control with different button configurations.
Define unique LED patterns and audio tones to indicate:
User actions
System states
System events

1.1 General
The BlueVOX Configurator can be used to customise the full range of Headset v4 and Headset V4 Refresh HMI
settings.

PS Key configuration settings can be read into the BlueVOX Configurator from the default options, a previously
saved user-generated .psr file or a connected device.

Default configurations are provided for two, three and four-button headset designs.

When BlueVOX Configurator is opened, developers can select the button configuration that matches their
hardware design and suitable default settings for the selected hardware design are loaded into the BlueVOX
Configurator application.

Note: The default button assignment, functionality and user events can then be viewed in the User Events tab.

The default settings provide a viable HMI that can be used as supplied or can be customised, by the
manufacturer, using the BlueVOX Configurator advanced option.

Settings defined in the BlueVOX Configurator can be saved as a .psr file or downloaded directly to the
Persistent Store of a connected device.

CSR plc 2005


CS-110372-UGP1 Page 3 of 58
This material is subject to CSRs non-disclosure agreement.
Description of BlueVOX Configurator Workspace

2 Description of BlueVOX Configurator Workspace


BlueVox Configurator supports two modes of operation:

Simple mode: allows configuration values for default two, three and four-button headsets to be loaded
into the BlueVOX Configurator, and the input and output PIOs corresponding to the hardware design to
be assigned.
Advanced mode: allows developers access to the full range of configuration parameters supported by
the Headset V4 software.

_` BlueVOX2 Configurator User Guide


The configuration parameters in BlueVOX Configurator can be wriiten to a .psr file or downloaded to a
connected device in both modes.

Menu Bar Buttons Workspace

Debug Output Pane

CSR plc 2005


CS-110372-UGP1 Page 4 of 58
This material is subject to CSRs non-disclosure agreement.
Description of BlueVOX Configurator Workspace

2.1 Functionality
The full functionality provided by BlueVOX Configurator is accessed through menus in the menu bar. Buttons are
also provided to support the most commonly required functions.

This section describes the menus, menu items and their functions.

2.1.1 File Menu


The File menu contains:

_` BlueVOX2 Configurator User Guide


Open from Device: loads the configuration settings on a connected device into the BlueVOX Configurator
and displays them in the advanced view.
Note: A suitable connection to the device is required and the appropriate transport method must be set using
Transport from the Properties menu. See section 2.1.3.

Open from Default: loads configuration parameters for the default button options listed in a submenu:

Open Two Button: loads default configuration settings for a two-button headset into BlueVOX
Configurator.
Open Three Button: loads default configuration settings for a three-button headset into BlueVOX
Configurator.
Open Four Button: loads default configuration settings for a four-button headset into BlueVOX
Configurator.

Open from PSR file: loads configuration settings from a .psr file. An Open dialogue box allows the user
to browse to a location and select the .psr file to be used.
Exit: Closes the BlueVOX Configurator application.

Note: Exit does not automatically save changes made to values in the BlueVOX Configurator.

Buttons displayed on the left of the BlueVOX Configurator application window also provide Open from Default,
Open from File and Open from Device functionality.

2.1.2 Output Menu


The Output menu contains:

Write PSR File: Allows the currently displayed settings to be saved as a .psr file.

Note: A Save As dialogue opens. Select the location to save the file and enter a filename then click Save to
write the .psr file to the selected location.

Write to Device: Downloads the currently displayed settings to a connected device.


Note: A suitable connection to the device is required and the appropriate transport method must be set using
Transport from the Properties menu. See section 2.1.3.

Buttons displayed on the left of the BlueVOX Configurator application window also provide Write PSR and Write
Device functionality.

CSR plc 2005


CS-110372-UGP1 Page 5 of 58
This material is subject to CSRs non-disclosure agreement.
Description of BlueVOX Configurator Workspace

2.1.3 Properties Menu


The Properties menu contains:

Transport: Allows the transport protocol used to communicate with a connected BlueCore device to be
defined.

Selecting Transport opens a Choose Transport window:

_` BlueVOX2 Configurator User Guide


Note: The applications default transport as shipped is BCSP, Serial Port Com1 and Baud Rate 115200. If the
Transport method is changed, the newly applied transport method is retained until manually changed.

2.1.4 View Menu


The View menu contains:

Advanced: Select this option to display the additional tabs available for advanced configuration.

The advanced configuration tabs can also be accessed using the Advanced View button.

2.1.5 Help Menu


The Help menu contains:

About: Displays version information about the BlueVOX Configurator.

CSR plc 2005


CS-110372-UGP1 Page 6 of 58
This material is subject to CSRs non-disclosure agreement.
Opening a Default Configuration

3 Opening a Default Configuration


When BlueVOX Configurator is opened for the first time, a simple view of the application is displayed.

Note: Subsequently BlueVOX Configurator opens in the simple or advanced view depending on the active mode
when the application is closed.

To open a default configuration for a two, three or four-button device select the required option button on the left
of the Configurator screen. The default settings are loaded into the BlueVOX Configurator and displayed in the
simple view:

_` BlueVOX2 Configurator User Guide

The simple view provides access to a subset of the configuration parameters that allow engineers to set output
and input PIOs to match their hardware design and to select the the device platform, V4 version or V4 Refresh
version.

A view-only User Events tab allows the engineer to see details of the user event configuration. To adjust these or
other configuration settings click the Advanced View button.

CSR plc 2005


CS-110372-UGP1 Page 7 of 58
This material is subject to CSRs non-disclosure agreement.
Advanced Configuration Parameters

4 Advanced Configuration Parameters


To access the full range of configuration options click the Advanced View button or select Advanced from the View
menu.

The advanced view includes 11 tabs that group related configuration parameters and provide a user-friendly
interface. When set as required, parameters configured in the BlueVOX Configurator can be written to a .psr
file or downloaded directly to a connected device.

_` BlueVOX2 Configurator User Guide

The parameters set in the BlueVOX Configurator tabs map to PS Keys that control the Headset v4 softwares
HMI configuration. The PS Keys and the parameters they hold are described in Appendix A

To edit User Event, Leds (States), Leds (Events), Leds (Filter) and Audio Tones tabs click on an entry. An editor
window opens allowing an existing entry to be adjusted or a new entry created.

CSR plc 2005


CS-110372-UGP1 Page 8 of 58
This material is subject to CSRs non-disclosure agreement.
EEPROM Initialisation

5 EEPROM Initialisation
When using BlueCore4-Audio ROM to implement the Headset v4 software, a small external EEPROM is required
to store the HMI configuration data. This chapter describes how to initialise the EEPROM so that BlueCore can
read and write data to the EEPROM correctly.

The development engineer must write a special header into the EEPROM to inform the BlueCore device which
type of EEPROM is being used.

Note: CSRs BlueCore4-Audio ROM is compatible with EEPROM devices from many different manufacturers and with

_` BlueVOX2 Configurator User Guide


many different capacities.

e2write is a command line application that initialises an external EEPROM. e2write is included in the BlueSuite
Development Tools download available from the Headset section of www.csrsupport.com.

The syntax for this application is:

e2write DEVICE Log2Bytes AddrMask

For I2C EEPROM devices manufactured by ST, Rohm and Microchip, the appropriate Log2Bytes AddrMask
parameters depend on the memory capacity shown in Table 5.1.

Device size (kbit) Device e2_Device parameters

Manufacturer Part number Log2Bytes AddrMask

16 Rohm BR24E16
ST24E16 11 0
ST
ST25E16
24AA515
512 Microchip 24LC515 16 4
24FC515

Table 5.1: e2write Parameters for EEPROMs Manufactured by Rohm, ST and Microchip

For all other common EEPROM devices, the Log2Bytes AddrMask parameters depend on the memory capacity
shown in Table 5.2.

e2_Device Parameters

Device size (kbit) Log2Bytes AddrMask

1 7 0
2 8 0
4 9 1
8 10 3
16 11 7
32 12 0
64 13 0
128 14 0
256 15 0
512 16 0
1024 17 1

Table 5.2: e2write Parameters for EEPROMs from All Other Manufacturers

CSR plc 2005


CS-110372-UGP1 Page 9 of 58
This material is subject to CSRs non-disclosure agreement.
EEPROM Initialisation

To initialise the EEPROM:

1. Download the BlueSuite Development Tools from the Headset section of www.csrsupport.com. Unzip
the downloaded file into a new folder.
2. Power On the headset board.
3. Make an SPI connection between the headset board and the parallel port of the PC (also known as the
printer port).
4. Open a command prompt and change directory to the folder containing the e2write application.
5. Look up the correct values of Log2Bytes and AddrMask for the EEPROM device. Refer to Table 5.1

_` BlueVOX2 Configurator User Guide


and Table 5.2 for details.
6. Enter the e2write syntax replacing Log2Bytes and AddrMask with the correct values for the
appropriate EEPROM device.

For example, to initialise an ST24E16 EEPROM device enter:

e2write -DEVICE 11 0

The EEPROM is now initialised and is suitable for use as the Persistent Store.

5.1 Downloading Persistent Store Values to EEPROM


When the EEPROM is initialised, the Persistent Store settings for the headset can be downloaded to it. This is
done using the PSTool utility. Both the system .psr file and the HMI .psr file generated using BlueVOX
Configurator must be downloaded.

Note: The PSTool utility is shipped as part of BlueLab or can be downloaded from the CSR support website.

To download the Persistent Store settings:

1. Make an SPI connection to the headset board.


2. Open the PSTool utility.
3. Select SPI BCCMD and the port to connect to in the Choose Transport dialogue. Click OK.
4. Select Merge from the File Menu and select the system .psr file to be downloaded. Click Open. Repeat
to download the HMI .psr file.
Note: The system.psr file is located in the BlueVOX Configurator install directory.

A more detailed description of the PSTool utility and the merge facility is available in the PSTool User Guide
(CSR ref: blab-ug-008P) which can be downloaded from www.csrsupport.com.

CSR plc 2005


CS-110372-UGP1 Page 10 of 58
This material is subject to CSRs non-disclosure agreement.
Document References

6 Document References
Document Reference

PSTool User Guide blab-ug-008P


BlueVOX QuickStart Guide bcore-ug-016P
BlueCore4-Headset Software Release Note Headset V4 bcore-srn-081P
BlueCore4-Headset Software Release Note Headset V4 Refresh RC4 bcore-srn-087P

_` BlueVOX2 Configurator User Guide

CSR plc 2005


CS-110372-UGP1 Page 11 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Appendix A Description of PS Keys


Table 5.1 describes the Persistent Store Keys dedicated to the configuration in the Bluecore4-Headset
application.

PS Key Description Units Valid Default Notes


Range Value

USR0 Battery Structure See Appendix A.1.


Configuration

_` BlueVOX2 Configurator User Guide


USR1 Button Configuration Structure See Appendix A.2.
USR2 Button Sequence Structure See Appendix A.3.
Configuration
USR3 HFP Supported uint16 See Appendix A.4.
Features
USR4 PIO Input Uint16 See Appendix A.5.
configuration
USR5 HFP 1.5 Features Structure See Appendix A.6.
Enabled
USR6 Timers/Counters structure See Appendix A.8
USR7 Unused n/a n/a n/a n/a
USR8 Unused n/a n/a n/a n/a
USR9 Unused n/a n/a n/a n/a
USR10 Stores whether the True/false false This key is written to by
vol buttons are the application when the
inverted or not volume orientation is
changed i.e. to allow
users to swap the vol+
and vol- buttons.
USR11 Unused n/a n/a n/a n/a
USR12 Unused n/a n/a n/a n/a
USR13 Radio Configuration Structure See Appendix A.9.
USR14 NiMH Battery Structure See Appendix A.10.
Charger
Configuration
USR15 Feature Structure See Appendix A.11.
Configuration
USR16 Audio Gain Mapping Structure See Appendix A.12.
USR17 Number of LED Integer 0-20 4 Defines the number of
Filters LED filters used by the
application, see Appendix
A.15.
USR18 LED Filter Definition Structure See Appendix A.15.
USR19 Number of LED Integer 0-13 8 Defines the number of
State Definitions LED States used by the
application. See Appendix
A.13.
USR20 LED State Definition Structure See Appendix A.13.
USR21 Number of LED Integer 0-20 8 Defines the number of
Event Definitions LED Events. See
Appendix A.14.
USR22 LED Event Structure See Appendix A.14.
Definitions

CSR plc 2005


CS-110372-UGP1 Page 12 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

PS Key Description Units Valid Default Notes


Range Value

USR23 System Event Structure Defines configuration of


Configuration A up to 20 System Events.
See Appendix A.16.
USR24 System Event Structure Defines configuration of
Configuration B up to another 20 System
Events. See Appendix
A.16.
USR25 Number of Event Integer 0-40 20 Stores the number of

_` BlueVOX2 Configurator User Guide


Tones Event Tones defined in
USR26.
USR26 Event Tone Structure See Appendix A.17.
configuration
USR27 PIO Output Setup Structure See Appendix A.18.
USR28 Tri colour LED Structure See Appendix A.19.
information
USR29 Last Used AG BDADDR Stores the Bluetooth
Address of the last device
connected with the
headset.
USR30 Default AG BDADDR Stores the Bluetooth
Address of the first device
paired with the headset
(after the last reset).
USR31 Configuration ID Integer Holds the ID of the
required default
configuration stored in
constant space.
HFP_POWER_TABLE Power Table Structure See Appendix A.20.
Settings

Table A.1: Description of PS Keys used for BlueVox2

CSR plc 2005


CS-110372-UGP1 Page 13 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.1 Battery Configuration


PS Key USR0 holds data defining the battery monitoring parameters. The parameters are held in the following bit
fields:

Minimum Shutdown
Label Divider Ratio Gas Gauge Level 1
Threshold Threshold

Type uint16 uint16 (D15-D8) (D7-D0) uint16 (D15-D8)

0-5100 (mV in 0-5100 (mV in 0-5100mV (mV in

_` BlueVOX2 Configurator User Guide


Range 200-1000, 0.2-1.0
+20mV steps) +20mV steps) +20mV steps)

Default Value 405 (0x0195) 165 (0x00a5) 150 (0x0096) 170 (0x00aa)

Gas Gauge Level 2 Gas Gauge Level 3 Unused Monitoring period Reminder Time

(D7-D0) uint16 (D15-D8) (D7-D0) uint16 (D15-D8) (D7-D0)


0-5100mV (mV in 0-5100mV (mV in 0
1-255 secs 1-255 secs
+20mV steps) +20mV steps)
185 (0x00b9) 200 (0x00c8) 0 30 (0x001e) 5 (0x0005)

Table A.2: PS Key USR0 Battery Configuration Bit Fields

Notes:
(1)
The Battery monitoring will occur every Monitoring Period time.
(2)
If the battery voltage is below Shutdown threshold then the headset will perform a clean disconnect and will power
off.
(3)
If the battery voltage is above Shutdown threshold and below Minimum threshold then eventBatteryLow will be
reported.
(4)
If the battery voltage is above Minimum threshold and below Gas Gauge Level 1 then the headset will report
eventbatteryOK and EventGasGauge0
(5)
If the battery voltage is above Gas Gauge Level 1 and below Gas Gauge Level 2 then the headset will report
eventbatteryOK and EventGasGauge1
(6)
If the battery voltage is above Gas Gauge Level 2 and below Gas Gauge Level 3 then the headset will report
eventbatteryOK and EventGasGauge2
(7)
If the battery voltage is above Gas Gauge Level 3 then the headset will report eventbatteryOK and
EventGasGauge3

CSR plc 2005


CS-110372-UGP1 Page 14 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.2 Button Configuration


PS Key USR1 holds data that configures button press definitions. The parameters are held in the following bit
fields:

Double Press Very Long Press Very Very Long


Label Long Press Time Repeat Time
Time Time PressTime

Type uint16 uint16 uint16 uint16 uint16

_` BlueVOX2 Configurator User Guide


Range 100-1000 (ms) 500-8000 (ms) 1000-12000 (ms) 100-5000 (ms) 1000-12000 (ms)

Default
500 (0x01f4) 1000 (0x03e8) 35000 (0x0dac) 800 (0x0320) 5000 (0x1388)
Value

Table A.3: PS Key USR1 Button Configuration Bit Fields

Note: Default values quoted are for Headset v4 four button configuration.

A.3 Button Sequence Configuration


PS Key USR2 allows two sequences of up to six button presses to be defined and used to generate a system
event.

Every time a PIO is pressed the code checks for a match to the defined pattern. If the sequence of button
presses matches the sequence in the key then the specified event is sent to the main message loop.

Note: There is no limit to the time between button presses and no distinction is made between short or long button
presses.

The key can contain up to two event sequences in the form:

Label Event to be Generated Key 1 Key 2 Key 3 Key 4 Key 5 Key 6

Type uint16 uint16 uint16 uint16 uint16 uint16 uint16

Range 0x6001 - 0x603f Set bit pattern for required button press sequence

Default
N/a N/a N/a N/a N/a N/a N/a
Value

Table A.4: PS Key USR2 Button Sequence Configuration Bit Fields

Example

To configure the event EventEnterDUTmode as a result of 6 presses of PIO[0] the key would hold the hex
value:

6015 0001 0001 0001 0001 0001 0001 0000 0000 0000 0000 0000 0000 0000

The second sequence is not used in this example and is initialised to 0.

Note: Normal system events should be configured using PS Keys USR23 and USR24. See A.15 Event
Configuration.

CSR plc 2005


CS-110372-UGP1 Page 15 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.4 Supported Features


PS Key USR3 maps directly onto the supported features reported as part of the AT+BRSF command used during
registration and connection setup sequence.

A 16-bit unsigned integer bitmask is used to report support for the following features:

#define HFP_NREC_FUNCTION (1)


#define HFP_THREE_WAY_CALLING (1<<1)
#define HFP_CLI_PRESENTATION (1<<2)
#define HFP_VOICE_RECOGNITION (1<<3)

_` BlueVOX2 Configurator User Guide


#define HFP_REMOTE_VOL_CONTROL (1<<4)
#define HFP_ENHANCED_CALL_STATUS (1<<5)
#define HFP_ENHANCED_CALL_CONTROL (1<<6)

Example

To indicate support for three way calling and remote voice control the bitmask would be set as:

0000 0000 0000 1010 (i.e.hex value 000a)

A.5 PIO Input Configuration


PS Key USR4 configures the PIOs to be used to trigger a charger event or to put the device into DUT (Device
Under Test) mode on power on. The PS Key specifies the PIO which when held high indicates the event.

Charger Input DUT Mode


Label Reserved Reserved
PIO PIO

Type uint16 (D15-12) (D11-8) (D7-4) (D3-0)

Range Not used Not used 0-11 (0x0 - 0xb) 0-11 (0x0 - 0xb)

Default Value 0xf (not used) 0xf (not used) 0xf (not used) 0xf (not used)

Table A.5: PS Key USR4 PIO Input Configuration Bit Fields

Note: Default values quoted are for Headset v4 four-button configuration.

Description of Bit Fields

Charger Input PIO: the pin specified in this field is polled on power up. If the pin is held high it indicates
that the charger is connected and the charger event message will be received by the application.
Note: Charger events still need to be configured for charging indications such as LED patterns etc.

DUT Mode PIO: when the pin specified in this field is held high on power on the device enters Device
under Test mode. This feature can be useful during production line testing.

Example

To configure PIO[0] as the Charger Input PIO and PIO[11] as the DUT Mode, PS Key USR4 would hold the hex
value:

ff0b

CSR plc 2005


CS-110372-UGP1 Page 16 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.6 HFP 1.5 Feature Configuration


PS Key USR5 must be set when developing a device that will support version 1.5 of the Handsfree Profile (HFP
1.5).

The feature configuration data is held in the following bit fields:

Label Is HFP Reserved Additional Audio Bandwidth Max Voice Retransmission


1.5 Params Sync Latency Settings Effort
Enabled Used Packet
Types

_` BlueVOX2 Configurator User Guide


Type uint16
(D14-1) (D0) uint16 uint32 uint16 uint16 uint16
(D15)

Values 0x1 See


Audio
enabled
n/a Packet
0x0 Types
disabled Bitmask

Table A.6: PS Key USR4 HFP 1.5 Feature Configuration Bit Fields

Audio Packet Types Bitmask

This bitmask is used for SCO/eSCO negotiation. The headset will automatically negotiate the best audio package
type that can be achieved from the activated package types.

Bit D15 D14 D13 D12 D11 D10 D9 D8

Packet Type reserved reserved reserved reserved reserved reserved sync_3ev5 sync_3ev3

Mask Value n/a n/a n/a n/a n/a n/a 0x0200 0x0100

D7 D6 D5 D4 D3 D2 D1 D0

sync_2ev5 sync_2ev3 sync_ev5 sync_ev4 sync_ev3 sync_hv3 sync_hv2 sync_hv1


0x0080 0x0040 0x0020 0x0010 0x0008 0x0004 0x0002 0x0001
Table A.7: PS Key USR5 Audio Packet Type Bitmask

Bit = 1: The packet type will be included in audio negotiation.


Note: eSCO packet types are only available if HFP 1.5 support is enabled see below.

Bit = 0: The packet type will not be included in audio negotiation.

IMPORTANT NOTE: The enable bits are inverted for D6, D7, D8, and D9 i.e. 0 = included in audio negotiation,
1 = not included in audio negotiation.

CSR plc 2005


CS-110372-UGP1 Page 17 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.7 Enabling HFP 1.5 Support


To enable HFP 1.5 support, an additional PS Key must also be set. If the BlueVOX Configurator HFP Features
tab is used to configure the Audio Packet Types and the Enable HFP 1.5 Features option is checked this key is
written automatically.

To enable HFP 1.5 if USR5 is set manually, the following PS Key must also be set manually:

To enable eSco EV3, EV4 and EV5:


PS Key LOCAL_SUPPORTED_FEATURES = fefc 800f 880b 0000

_` BlueVOX2 Configurator User Guide


To enable eSCO plus 2M EDR:

PS Key LOCAL_SUPPORTED_FEATURES = fefc 800f A80b 0000

To enable eSCO plus 3M EDR:

PS Key LOCAL_SUPPORTED_FEATURES = fefc 800f E80b 0000

If HFP 1.5 support is not required the value should be:


PS Key LOCAL_SUPPORTED_FEATURES = fefc 000f 0808 0000

Retransmission Effort

Enumeration values:

sync_retx_disabled No retransmissions.
sync_retx_power_usage At least one retransmission, optimise for power consumption.
sync_retx_link_quality At least one retransmission, optimise for link quality.
sync_retx_dont_care Don't care.

Example

The following entry:

8001 003f 0000 1f40 000c 0000 0002

in PS Key USER5 configures:

eSCO enabled
all packet types supported
8000Hz Bandwidth
latency of 12
retransmission effort = link quality

Headset with eSCO enabled , all packet types supported 8000Hz Bandwidth latency of 12 and retransmision
effort = link quality

CSR plc 2005


CS-110372-UGP1 Page 18 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.8 Headset Timeouts


PS Key USR6 configures the Timers and Counters used in the application.

NetworkServiceIndicatorRepeatTime_s

DisablePowerOffAfterPowerOnTime_s

CheckForAudioTransferDelay_s

_` BlueVOX2 Configurator User Guide


LionkLossNumRetries_s
AutoPowerOnTimeout_s
AutoSwitchOffTime_s

PairModeTimeout_s

MuteRemindTime_s
Label

Type uint16 uint16 uint16 uint16 uint16 uint16 uint16 uint16

Range 0-600 0-60 0-3600 0-60 0-65536 0-60 0-60 0-30


(secs) (secs) (secs) (secs) (secs) (secs) (secs) (secs)

Default 600 12 10 0 65536 5 5 1


Value (0x0258) (0x000c) (0x000a) (0x0000) (0xffff) (0x0005) (0x0005) (0x0001)

Table A.8: PS Key USR6 Timers and Counters

Description of Timers and Counters

AutoSwitchOffTime_s: The Time in seconds after which the headset will switch off if not connected. if==0 then
headset remains on indefinitely.

AutoPowerOnTimeout_s: The value in seconds that the headset waits after powering up to see if a power on
event occurs. After this time, the headset will return to the off state.

NetworkServiceIndicatorRepeatTime_s: The time in seconds after which the network service indication will be
replayed if there is no network present in the connected AG.

DisablePowerOffAfterPowerOnTime_s: The time after Power On for which the Power Off event has no effect.
This is used for example, if the UI specifies that a long press on Power On enters pairing mode but a long press
at any other time (including in the connectable state) should Power Off the headset.

PairModeTimeout_s: The time in seconds that the headset remains in the connectable / discoverable state
(pairing mode). Setting this to 0 will result in the headset entering and immediately exiting discoverable mode,
with the result that the device cannot be discovered.

If the headset is to always be discoverable whilst not connected, then the feature bit Automatic Pairing Mode
Enable (see PS Key USER15 on page 22) should be used in conjunction with this timeout.

MuteRemindTime_s: The time between mute reminder updates. This is used for LED and Tone reminders to
indicate that the headset is muted.

LinkLossNumRetries: Specifies the Number of retries to be made if an abnormal disconnect (link loss) occurs.
Each retry is initiated after a 10 second delay.

CheckForAudioTransferDelay: Timeout after an SLC establishment before the V4 software attempts to create a
SCO link to the AG device.

CSR plc 2005


CS-110372-UGP1 Page 19 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.9 Radio Configuration


PS Key USR13 determines the radio Inquiry and Page scan characteristics:

Inquiry Scan Interval Inquiry Scan Inquiry Scan Interval Inquiry Scan
Label
(slots) Window (slots) (slots) Window (slots)

Type uint16 uint16 uint16 uint16

Range 18-4096
18-4096 18-4096 18-4096
(0x0012
(0x0012 0x1000) (0x0012 0x1000) (0x0012 0x1000)

_` BlueVOX2 Configurator User Guide


0x1000)
Default
2048 (0x0800) 18 (0x0012) 2048 (0x0800) 18 (0x0012)
Value

Table A.9: PS Key USR13 Radio Configuration Bit Fields

Note: Default values quoted are for Headset v4 four button configuration.

BlueVOX Configurator does not provide an interface to this PS Key. The default values have been selected to
give the best performance characteristics and it is not recommended that these are changed in most
circumstances.

CSR plc 2005


CS-110372-UGP1 Page 20 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.10 NiMH Charger Configuration


PS Key USR14 holds the required parameter values used to configure the quick charge cycle for a NiMH battery.

Note: NiMH batteries are either trickle or quick charged. The parameters configured in this PS Key are associated with
the quick charge cycle and are very important in order to protect the lifetime of the battery.

QC Min QC Temp
QC Min QC Max QC dV QC dV QC Max
Battery Update
Label Voltage Voltage Voltage Inhibit Battery
o (Temp Period
(mV) (mV) (mV) Time (Temp C) o
C) (mins)

_` BlueVOX2 Configurator User Guide


Type uint16 uint16 uint16
uint16 uint16
(D15-8) (D7-0) (D15-8) (D7-0) (D15-8)

Range 900-3500 1800-3500 0-60 1-32 0-60 0 1-10

Default 1800 3300 7 15 40 00 4


Value (0x0708) (0x0ce4) (0x07) (0x0f) (0x28) (0x00) (0x04)

dT
QC Td QC Time Thermister Thermister
Thermister c VDet m VDet c Threshold
(oC) (mins) Enable PIO m o
( C)

uint16
int16 int16 int16 int16 int16
(D7-0) (D15-8) (D7-0)

0-180 -100 to -1000 to


0-15 0-15 -100 to 100 -1000 to 1000 0-10
100 1000

0 120 4 -48 68 0 0 1
(0x00) (0x78) (0x04) (0xffd0) (0x0044) (0x0000) (0x0000) (0x0001)

Table A.10: PS Key USR14 NiMH Charger Configuration Bit Fields

Note: Default values quoted are for Headset v4 four-button configuration.

The default PS Keys hex value is:

0708 0ce4 070f 2800 0400 7804 ffd0 0044 0000 0000 0001

CSR plc 2005


CS-110372-UGP1 Page 21 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.11 Feature Configuration


PS Key USR15 holds three words used to configure features as described in this section.

Word 1 Word 2 Word 3

General Features Reconnection Policy Extended Features

Word 1 General Features

_` BlueVOX2 Configurator User Guide


Bit D15 D14 D13 D12 D11 D10 D9 D8

Mute Play Remain Disable Auto


Codec Reboot
Mic Bias Control Tones at Discover- Power Off Answer
Feature Gain after
uses LDO Speaker Fixed able at all after Power on
Scale Reset
Gain Volume times On Connect

Default 0 0 0 1 1 0 0 0

D7 D6 D5 D4 D3 D2 D1 D0

Use User
Power On Power On NiMH LiON Automatic
defined Mute Local
uses uses Mute Battery Battery Pairing
Codec Volume
Internal Internal Override Charger Charger Mode
Gain Action
LDO SMPS Enable Enable Enable
Values
1 0 1 0 0 0 1 0

Table A.11: PS Key USR15 Feature Configuration Bit Fields

Description of Bit Fields

Mic Bias Uses LDO:

Bit = 1: The internal LDO is used for the mic bias.


Bit = 0: The PIO defined in the PS Key CODEC_PIO is used for the mic bias.

If this is not set correctly for a particular hardware design microphone audiopath may not work correctly. - the
Internal LDO can also be enabled on Power On via the Power On Internal LDO feature bit (D6). The use of the
LDO for the Mic Bias is not generally recommended as it can reduce audio quality.

Codec Gain Scale:

Bit = 1: The Profile Volumes are scaled across the full range of Speaker Gain Values (0-23). This
provides the full audible range for the headset.
Bit = 0: The Profile Volumes use the Speaker Gain range 4-19. This provides equal steps of around
2.5/3dB per Profile Volume Setting.

Mute Controls Speaker Gain:

Bit = 1: Mute will mute the Speaker and the Microphone of the headset.
Bit = 0: Only the Microphone will be muted.

CSR plc 2005


CS-110372-UGP1 Page 22 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Play Tones at Fixed Volume:

Bit = 1: Tones are played at a nominal fixed volume regardless of the current Profile Volume level.
Note: By default the fixed volume at which the tones will be played if this bit is set is HFP Volume Level 1.

Bit = 0: Tones are played at the current Profile Volume level.

Reboot after Reset:

Bit = 1: The headset powers off after a Reset has been issued.

_` BlueVOX2 Configurator User Guide


Bit = 0: The headset does not power off after a Reset has been issued.

Note: Reset clears the Default and Last user together with the list of Paired devices.

Auto Answer on Connect: This allows the headset to send an answer (ATA) AT command if an incoming call is
detected on connection.

Bit = 1: Headset sends answer (ATA) AT command.


Bit = 0: Headset does not respond to an incoming call detected on connection.

Note: Some AGs will attempt to auto answer the call on connection.

Use User defined Codec Gain Values:

Bit = 1: The application uses the CODEC Gain settings set in PS Key USR16 (Speaker Gain Mapping,
see Appendix A.12).
Bit = 0: Gains are scaled according to the Codec Gain Scale feature bit (D14).

Disable Power Off after Power On:

Bit = 1: Disables Power Off for 20 seconds after Power On.


Note: This is used for example, if the UI specifies that a long press on Power On enters pairing mode but
a long press at any other time (including in the connectable state) should Power Off the headset.

Bit = 0: Power Off is not disabled during Power On.

Mute Override: If the headset is muted (via the EventMuteToggle or EventMuteOn), then this bit controls
the action to take when an EventVolumeUp/EventVolumeDown or an AG volume indication message
occurs:

Bit = 1: Volume events cause the headset to unmute and set the volume to the new level.
Bit = 0: Volume events do not unmute the headset and the local headset volume value is updated
according to the Mute Local Volume Action feature bit (D4).

Mute Local Volume Action: This controls whether or not an EventVolumeUp, EventVolumeDown or an
AG volume indication message updates the headsets local volume variable (when the headset is muted):

Bit = 1: The headset updates the volume variable and the next time the headset is unmuted, the new
volume will take effect.
Bit = 0: The headset ignores any volume requests until it is unmuted.

Power On Internal LDO: This controls whether the Power On event latches on the internal Linear Regulator
(LDO: Low Drop Out):

Bit = 1: Latched on
Bit = 0: Not Latched on

CSR plc 2005


CS-110372-UGP1 Page 23 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Power On Internal SMPS: This controls whether the Power On event latches on the internal Switch Mode Power
Supply (SMPS):

Bit = 1: Latched on
Bit = 0: Not Latched on

Word two - Reconnection Policy

Bit D15 D14 D13 D12 D11:D8 D7:D4 D3:D0

Paired

_` BlueVOX2 Configurator User Guide


Auto- Reconnect
Default Device List Auto- Reconnect Reconnect
Reconnect Action on
Feature different to is Shuffled Reconnect Action on Action on
Power Call
Last AG on Link Loss Connect Power On
On Transfer
Connection
(1)
Range 0-1 n/a 0-1 0-1 0-6 0-6 (1) 0-6 (1)

BlueVOX
0x0 0x0 0x0 0x1 0x01 0x01 0x01
default
(1)
See Reconnect Action for descriptions of options

Table A.12: PS Key USR15 Word two - Reconnection Policy Bit Fields

Note: Default values quoted are for Headset v4 four-button configuration.

Description of Bit Fields

Default Different to Last AG: This bit field defines how the application interprets the Default and Last
connected AGs:

Bit = 1: Default is the first ever paired AG and the Last is the last connected AG (BUT ONLY if the last
was different to the default)
Bit = 0: Default is the first ever paired AG and the Last is the last connected AG (i.e any device - can
be the same as the default).

Paired Device is Shuffled on Connections: This controls the order in which the reconnect action - list attempts
to connect to the 8 devices in the paired device list 0 - paired device list will contain the order of pairing 1 - paired
device list will contain the order of connecting.

Bit = 1: Paired device list will contain the order of connecting.


Bit = 0: Paired device list will contain the order of pairing.

CSR plc 2005


CS-110372-UGP1 Page 24 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Reconnect Action

There are eight Reconnection Action options. The option required can be set separately for Power On and
following Disconnect and Call Transfer events:

Note: The Call Transfer Reconnect Action is evoked when the headset is used to transfer a call to the AG then back
to the headset.

Reconnect entry Action

0 (0x00) Attempt to Reconnect to the last connected AG

_` BlueVOX2 Configurator User Guide


1 (0x01) Attempt to Reconnect to LAST connected AG
2 (0x02) Attempt to Reconnect to DEFAULT AG
3 (0x03) Attempt to Reconnect to LAST AG then DEFAULT AG
4 (0x04) Attempt to Reconnect to DEFAULT AG then LAST AG
Attempt to Swap AG i.e if was DEFAULT then now
5 (0x05)
LAST AG etc
Attempt to Swap then swap again AG i.e if was
6 (0x06)
DEFAULT then now LAST then DEFAULT AG etc
Attempt to connect to all 8 devices in the paired device
7 (0x07) list. If we have just been cleanly disconnected then the
list does not include the device just dropped
Where:
last = Last connected device ( i.e The LAST or DEFAULT or none if freshly powered On).
LAST = This is defined in Default Different to Last, if:
Bit =1: Then this is the last connected device that is not the DEFAULT
Bit =0: Then this is the last connected device (can be the DEFAULT device)
DEFAULT = First device ever connected

Table A.13: PS Key USR15 Word two - Reconnection Action

Auto Reconnect Power on: Defines the Auto Reconnect action when the headset receives a Power On event:

Auto Reconnect Link Loss: Defines the Auto Reconnect action when the headset loses the SLC connection
to an AG with a resulting Link Loss Error code:

Reconnect Action on Connect: Defines the AG that the device will try to connect to when an Establish SLC
event is received. i.e. when a user generated event requiring a connection is received by an unconnected
headset e.g. Connect, Voice dial or Last Number Redial events.

Reconnect Action on Call Transfer: Defines the AG that the device will try to connect to when a call that has
been transferred to an AG is transferred back to the headset (using the headset).

Note: i.e. the Call Transfer Reconnect Action is evoked when the headset is used to transfer a call to the AG then
back to the headset. This only applies to Ags that disconnect the headset when it transfers a call.

Reconnect Action on Power On: Defines the AG that the device will try to connect to at next Power On event. If
The Auto Reconnect Power On bit field is set to 1.

CSR plc 2005


CS-110372-UGP1 Page 25 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Word three Extended Features

Bit D15 to D12 D11 D10 D9

Feature DiscoIfPDLLessThan:4 Reserved Reserved ListConnectNextButOne

Default 0000 0 0 0

_` BlueVOX2 Configurator User Guide


D8 D7 D6 D5 D4

Play Volume
Tone on Secure Use Raw Mic
EncryptOnSLCEstablishment VGSDoesNotSetMicGain
Remote Pairing Gains
Indication
1 0 0 0 0

D3 D2 D1 D0

Use Last Paired user as


Use Raw Speaker Gains Queue Tone Events Queue LED Events well as Last Connected
user
1 0 0 0

Table A.14: PS Key USR15 Word three Extended Features Bit Fields

Description of Bit Fields

DiscoIfPDLLessThan: This forces the headset to Enter Discoverable mode (pairing) if the paired device list is
less than the entry here.

i.e. an entry of 2 would mean that if the headset has previously paired with either 0 or 1 devices, then the headset
will enter discoverable mode.

Bit = 0: Feature disabled.


Bit = 1 - 7: Feature enabled.

ListConnectNextButOne: On a disconnect when using the list reconnection policy:

Bit = 0: Attempt connect to the first item in the list and then all others.
Bit = 1: Attempt connect to the second item in the list and then all others

EncryptOnSLCEstablishment: This forces Encryption on SLC establishment. Some Nokia S40 phones now do
not force encryption on the SLC. Setting this bit ensures that encryption is used.

Bit = 0: Encryption not enforced.


Bit = 1: Ensures that encryption is used.

VGSDoesNotSetMicGain: This configures how the local microphone gain level behaves.

Bit = 0: The mic level will be updated according to policy in Word 1 & PSKEY_USR_16, see
A.12Speaker Gain Mapping.
Bit = 1: The local microphone gain level will not be set on a VGS command from the AG.

CSR plc 2005


CS-110372-UGP1 Page 26 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Play volume tone on remote indication: This forces the headset to play a tone when the volume is adjusted
from the remote end if tones are configured to be played.

Bit = 0: Feature disabled.


Bit = 1: Feature enabled.

Secure Pairing: This bit enables secure pairing mode. If set, then the headset will only accept pin code requests
when in pairing mode (connectable/discoverable state). This prevents a remote user from pairing with the
headset without the headset being specifically placed into paring mode.

This is over-ridden if the headset initiates the connection. ie - if a headset attempts to connect to a remote AG

_` BlueVOX2 Configurator User Guide


without the correct link key (or has the bdaddr but not the link key) then the headset will accept a pin code
request.

Bit = 0: Feature disabled.


Bit = 1: Feature enabled.

Use Raw Mic Gains: This allows the user gain defined in PS Key USR16 to be split into a separate analogue
and digital gain for control of the mic gain The Set Raw API is used to control the mic gain.

Bit = 0: Feature disabled.


Bit = 1: Feature enabled.

Use Raw Speaker Gains: This allows the user gain defined in PS Key USR16 to be split into a separate
analogue and digital gain for control of the speaker gain. This must be used in conjunction with Use User defined
Codec Gain Values.

Bit = 0: Feature disabled.


Bit = 1: Feature enabled.

Use Last Paired User as well as Last Connected User: This will cause the HS to store the pairing information
for the last paired user as well as the last connected user.

Bit = 0: The HS will only attempt to the last connected user and ignore any users that have been paired
but not connected.
Bit = 1: and an AG is paired to the HS but not connected, then the HS will attempt to reconnect to the
last paired device on power on.

Queue Tone Events: This allows tones to be queued in the headset:

Bit = 1: Queued tones will be played in sequence.


Note: Up to 4 tones can be held in the queue.

Bit = 0: Any request to play a tone whilst another is playing, will be ignored.

Queue LED Events: This allows LED indicator patterns (up to four) to be queued in the headset.

Bit = 1: Queued LED patterns will be displayed in sequence.


Note: Up to 4 LED patterns can be held in the queue.

Bit = 0: Any request to display an LED sequence whilst is active will be ignored.

Use Last Paired User as well as Last Connected User: This causes the headset to store the pairing
information for the last paired user as well as the last connected user.

bit = 1: If an AG is paired to the headset but has not been previously connected, then the headset will
use this information to attempt to connect to the last paired device on Power On if bit D13 (Auto-
Reconnect Power On) in word two is set.
Note: If this bit is not set, pairing information for an AG that has been paired but not connected will be
discarded when the headset is powered off.

bit = 0: The headset will attempt to connect to the last connected AG and will ignore any AGs that have
been paired (but not connected) since the last connection.

CSR plc 2005


CS-110372-UGP1 Page 27 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.12 Audio Gain Mapping


PS Key USR16 holds values that configure the Speaker/Mic Gain behaviour of the application. PS Key USR16
supports both Predefined Gains and Raw Gains.

Two feature bits govern which method is used to configure PS Key USER16. Check the Use Raw Speaker Gains
and Use Raw Mic Gains options in the Configurators Features tab to configure Raw Gains, leave these options
unchecked to configure the audio gain using Predined Gains.

A.11.1 PS Key USER16 configured to use Predefined Gains

_` BlueVOX2 Configurator User Guide


Increase Decrease Mic Gain
Label Tones Speaker Gain Mic Gain
Action Action Level

uint16 uint16 (D15-


Type
(D15-12) (D11-8) (D7-4) (D3-0) 8) (D7-0)
0 - 22 0 - 22
0 - 15 0 - 15 0 - 15 0 - 15
Range (0x00 - (0x00 -
(0x0 - 0xf) (0x0 - 0xf) (0x0 - 0xf) (0x0 - 0xf)
0x16) 0x16)
Table A.15: PS Key USR16 Predefined Audio Gain Mapping Bit Fields

The PS Key contains a total of 128 Hex numbers representing each of the 16 (0-15) Profile Volume settings in
the AG profile. Each volume button press adjusts the Profile Volume setting by one level.

Example

A single volume press configuration entry for Profile Volume Level 7 might be 0x8671 090a and would equate
to:

Label Configuration Value Action

Increase action 0x8 Go to Profile Volume level 8


Decrease action 0x6 Go to Profile Volume level 6
Mic Gain level 0x7 Set Mic Gain Level to 7 for this
Profile Volume level
Tones 0x1 Play Middle 0, see Appendix C
Speaker Gain 0x09 Set the CODEC Gain for the
Speaker to 9 (-18dBr)
Mic Gain 0x0a Set the CODEC Gain for Mic to 10
(-15dBr)

Table A.16: Volume Press Configuration Example

Entries for each of the other 16 (0-15) Volume Gain settings appear in sequence in the PS Key.

CSR plc 2005


CS-110372-UGP1 Page 28 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

CODEC Gain Settings

Speaker and Mic Gain values support the range 0 to 22 (0x00 to 0x16) these values equate to the gain
settings:

CODEC (Speaker/Mic)
Digital Gain Analogue Gain GAIN (dBr)
Gain (0-22)

Value to set Internal Internal Gain achieved at


Speaker/Mic
22 7 7 +21.5

_` BlueVOX2 Configurator User Guide


21 6 7 +18
20 5 7 +15.5
19 4 7 +12
18 3 7 +9.5
17 2 7 +6
16 1 7 +3.5
15 0 7 0
14 0 6 -3
13 0 5 -6
12 0 4 -9
11 0 3 -12
10 0 2 -15
9 0 1 -18
8 0 0 -21
7 15 0 -23.5
6 14 0 -27
5 13 0 -29.5
4 12 0 -33
3 11 0 -35.5
2 10 0 -39
1 9 0 -41.5
0 8 0 -45

Table A.17: CODEC Predefined Gain Settings

Note: For simplicity the BlueVOX Configurator allows engineers to set the Speaker or Microphone Gains from a drop
down list of Gain (dBr) values.

CSR plc 2005


CS-110372-UGP1 Page 29 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Typical Values

Table A.17 shows a typical set of values for the gain settings of a headset application:

Profile Increase Decrease Mic Gain Speaker Mic Codec


Tone
Volume Action Action Level Codec Gain Gain

0 4 0 0 1 0x04 0x11
1 4 0 1 4 0x06 0x11
2 4 0 2 4 0x06 0x11

_` BlueVOX2 Configurator User Guide


3 4 0 3 4 0x06 0x11
4 5 0 4 4 0x06 0x11
5 6 4 5 4 0x07 0x11
6 7 5 6 4 0x08 0x11
7 8 6 7 4 0x09 0x12
8 9 7 8 4 0x0a 0x12
9 a 8 9 4 0x0b 0x12
a b 9 a 4 0x0c 0x12
b f a b 4 0x0d 0x12
c f b c 4 0x0f 0x12
d f b d 4 0x0f 0x12
e f b e 4 0x0f 0x12
f f b f a 0x0f 0x13
Table A.18: CODEC Gain Typical Settings

This equates to a PS Key hex value of:

4001 0411 4014 0611 4024 0611 4034 0611 5044 0611 6454 0711 7564 0811
8674 0912 9784 0a12 a894 0b12 b9a4 0c12 fab4 0d12 fbc4 0f12 fbd4 0f12
fbe4 0f12 fbfa 0f13
Note: This is used as the default value for PS Key USR16 in the BlueCore4-Headset.

A.11.2 PS Key USER16 configured to use Raw Gains

When the Use Raw Gain feature bit set the user must provide values of analogue and digital gain values to
create the attenuation level required for the application.

Mic Raw Raw Raw


Raw
Increase Decrease Gain Analogue Digital Analogue
Label Tones Digital
Action Action Level Speaker Speaker Mic Gain
Mic Gain
(HFP) Gain Gain

uint16 uint16
Type
(D15-12) (D11-8) (D7-4) (D3-0) (D15-12) (D11-8) (D7-4) (D3-0)

0 - 15 0 - 15 0 - 15 0 - 15 0-7 0 - 15 0-7 0 - 15
Range (0x0 - (0x0 - (0x0 - (0x0 - (0x0 - (0x0 - (0x0 - (0x0 -
0xf) 0xf) 0xf) 0xf) 0x7) 0xf) 0x7) 0xf)

Table A.19: PS Key USR16 Raw Audio Gain Mapping Bit Fields

CSR plc 2005


CS-110372-UGP1 Page 30 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

The separate digital and analogue values each provide an attenuation level in dBr, the values of both of these
fields are added together to produce an overall gain for speaker and mic, there are separate entries for speaker
and mic gains.

The digital gain can be set to one of 15 values. The values provide the attenuation values shown in Table A.20:

Digital Gain Gain (dBr)

Internal Gain achieved at speaker/mic


0 0
1 +3.5

_` BlueVOX2 Configurator User Guide


2 +6
3 +9.5
4 +12
5 +15.5
6 +18
7 +21.5
8 -24
9 -20.5
10 -18
11 -14.5
12 -12
13 -8.5
14 -6
15 -2.5

Table A.20: Raw Digital Gain Values

The Raw analogue gain component can have 1 of 8 values:

Analogue Gain (dBr)

Internal Gain achieved at speaker/mic


0 -21
1 -18
2 -15
3 -12
4 -9
5 -6
6 -3
7 0

Table A.21: Raw Analogue Gain Values

Using a combination of analogue and digital gains from the raw gain tables it is possible to set smaller step sizes
than those available when using the predefined gain tables.

However, the range of available step sizes available is still limited and it may still be impossible to achieve the
exact gain required, in some cases a near to value is the best that can be achieved.

CSR plc 2005


CS-110372-UGP1 Page 31 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

For example to achieve an attenuation level of -11dB, two approaches would be to set the gains as shown:

1. Set Raw Analogue Gain to 4, giving an attenuation value of -9dB


Set Raw Digital Gain to 15, giving an attenuation value of -2.5dB

Combining the analogue and digital gain results in an actual attenuation of -11.5dB
2. Set Raw Analogue Gain to 6, giving an attenuation value of -3dB
Set Raw Digital Gain to 13, giving an attenuation value of -8.5dB

Combining the analogue and digital gain results in an actual attenuation of -11.5dB

_` BlueVOX2 Configurator User Guide


An example of a typical single HFP level entry in PSkey USR16 might be:

FCE1 4F4F

This entry would define HFP Mic Gain Level 14 with the attenuation of -11.5dB (as in the first example
configuration above), Increase action = go to level 15, Decrease action = go to level 13, headset tone = middle 0.

Setting the Audio Gain using the Raw configuration, whilst providing more precise control, is more time intensive
as engineers must consider the possible combinations that can be used to achieve the required Gain level.

Engineers should be aware that the use of positive digital gain settings should be avoided as they are likely to
result in audio distortion.

CSR plc 2005


CS-110372-UGP1 Page 32 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.13 LED State Configuration


Each headset state can be associated with a unique LED flashing pattern. The necessary configuration is defined
in two PS Keys:

USR19: specifies the number of LED flashing patterns (entries) defined in PS Key USR20.
USR20: holds the attributes of 1 to n entries defined as follows.

Word 1 Word 2

_` BlueVOX2 Configurator User Guide


LED On time LED off tim LED repeat time
Label Headset State
(x10ms) (x10ms)e (x50ms)

Type uint16 (D15-8) (D7-0) uint16 (D15-8) (D7-0)

Range/Description See Appendix 0-2550ms (in 10ms 0-2550ms (in 10ms 0-10000ms (in
Appendix B steps) steps) 50ms steps)

Word 3 Word 4

LED Dim Time Time out Number of flashes LED_A LED_B Colour

uint16 (D15-8) (D7-0) uint16 (D15-12) (D11-8) (D7-4) (D3-0)


0-255ms 0-255 ms 0-15 see below see below see below

Table A.22: PS Key USR20 - LED State Configuration Bit Fields

Description of Bit Fields

Headset State: System state associated with the LED pattern being defined, see Appendix D

On time, Off time, Number of flashes and Repeat time values:

Figure 1: LED Pattern

CSR plc 2005


CS-110372-UGP1 Page 33 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Dimming LEDs: Dimming / Ramping LEDs are available if running on BlueCore4 Audio ROM and BlueCore4
Headset-based hardware. Dimming LEDs can be enabled by entering a value in the LED Dimming field. This
value is the time between ramp steps to use.

There are 16 ramping steps used to Dim on or off an LED. It is important to ensure that the (Dim time * 16) is less
than the on time / off time for the ramp to complete.

E.g. For a 1 second on 1 second off pattern, then a good Dim time to use would be 800ms / 16 = 50 = 0x32.

Time out: This field specifies the number of times the sequence, specified by the entry, will repeat (unless
superseded by another event) before it times out. When set to 0 the sequence will not time out.

_` BlueVOX2 Configurator User Guide


LED_A: This field is a bitmask that specifies the PIO that will be referred to in the PS Key attributes as LED_A.

Bit D15 D14 D13 D12 D11 D10 D9

Mask value Tricol_a Tricol_b Tricol_c


LED_1 LED_0 PIO_10 PIO_9
LEDs * LEDs * LEDs *

D8 D7 D6 D5 D4 D3 D2 D1 D0

PIO_8 PIO_7 PIO_6 PIO_5 PIO_4 PIO_3 PIO_2 PIO_1 PIO_0

Table A.23: PS Key USR20 LED_A Bitmask

LED_B: This field is a bitmask that specifies the PIO that will be referred to in the PS Key attributes as LED_B.

Bit D15 D14 D13 D12 D11 D10 D9

Mask value Tricol_a Tricol_b Tricol_c


LED_1 LED_0 PIO_10 PIO_9
LEDs * LEDs * LEDs *

D8 D7 D6 D5 D4 D3 D2 D1 D0

PIO_8 PIO_7 PIO_6 PIO_5 PIO_4 PIO_3 PIO_2 PIO_1 PIO_0

Table A.24: PS Key USR20 LED_B Bitmask

Colour: This field defines the LED(s) that the sequence will display when a filter is not applied. The options for
this field are defined as:

bit value = 0000: Reserved


bit value = 0001: LED_A
bit value = 0010: LED_B
bit value = 0011: Alternate
bit value = 0100: LED_BOTH

CSR plc 2005


CS-110372-UGP1 Page 34 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Example

A typical example of an LED State configuration is the default LED indication for the Connectable state in
BlueVOX2 headsets:

Label Headset State LED On time LED off time LED repeat time

Type uint16 (D15-8) (D7-0) uint16 (D15-8) (D7-0)

Binary value 00000001 00001010 00001010 00101000

_` BlueVOX2 Configurator User Guide


Hex value 0x010a 0x0a28

Defines Connectable 100ms(1) 100ms(1) 2000ms(2)

Number of
LED Dim Time Time out LED_A LED_B Colour
flashes

uint16 (D15-12) (D11-8) uint16 (D15-12) (D11-8) (D7-4) (D3-0)


00000000 00000000 0010 1111 1110 0001
0x0000 0x0000 0x2fe1
0 0 2 LED_1 LED_0 LED_A

Table A.25: PS Key USR20 Example Entry


(1)
Notes: The software multiplies the value entered in this field by 10 i.e. 10x10 results in 100ms.
(2)
The software multiplies the value entered in this field by 50 i.e. 50x40 results in 2000ms.

This equates to an LED sequence hex value entry of:

010a 0a28 0000 2fe1

This results in LED_1 flashing twice for 100ms every 2 seconds while the device is connectable.

CSR plc 2005


CS-110372-UGP1 Page 35 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.14 LED Event Configuration


Each headset system event can be associated with a unique LED flashing pattern. This is defined in two PS
Keys:

USR21: specifies the number of LED flashing patterns (entries) defined in PS Key USR22.
USR22: holds the attributes of 1 to n LED flashing patterns.

Pattern flashing attributes are held in PS Key 22 in the following format:

_` BlueVOX2 Configurator User Guide


Word 1 Word 2

Headset System LED On time LED off time LED repeat time
Label
Event (x10ms) (x10ms) (x50ms)

Type uint16 (D15-8) (D7-0) uint16 (D15-8) (D7-0)

Range/Description See Appendix 0-2550ms (in 10ms 0-2550ms (in 10ms 0-10000ms (in
Appendix B steps) steps) 50ms steps)

Word 3 Word 4

Time out Number of flashes LED_A LED_B Colour

uint16 uint16 (D15-12) (D11-8) (D7-4) (D3-0)


0-255ms 0-255 ms 0-15 see below see below

Table A.26: PS Key USR22 LED Event Configuration Bit Fields

Description of Bit Fields

Headset System Event: System event associated with the LED pattern being defined, see Appendix B

Note: This is specified as an offset of 0x6000 i.e. to specify the Power On Event (0x6001) the value of this field
would be 0x01.

On time, Off time, Number of flashes and Repeat time values:

Figure 2: LED Pattern

CSR plc 2005


CS-110372-UGP1 Page 36 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Time out: This field specifies the number of times the sequence, specified by the entry, will repeat (unless
superseded by another event) before it times out. When set to 0 the sequence will not time out.

LED_A: This field is a bitmask that specifies the PIO(s) to which LED are connected.

Bit D15 D14 D13 D12 D11 D10 D9

Mask value Tricol_a Tricol_b Tricol_c


LED_1 LED_0 PIO_10 PIO_9
LEDs * LEDs * LEDs *
* See Tricolour LED for further information.

_` BlueVOX2 Configurator User Guide


D8 D7 D6 D5 D4 D3 D2 D1 D0

PIO_8 PIO_7 PIO_6 PIO_5 PIO_4 PIO_3 PIO_2 PIO_1 PIO_0

Table A.27: LED_A Bitmask

Colour: This field defines the LED(s) that the sequence will display when a filter is not applied. The options for
this field are defined as:

Bit value = 0000: Reserved


Bit value = 0001: LED_A
Bit value = 0010: LED_B
Bit value = 0011: Alternate
Bit value = 0100: LED_BOTH.

Example

A typical example of an LED event configuration is the default LED indication for the Power On event in
BlueCore4-headsets:

Label Headset Event LED On time LED off time LED repeat time

Type uint16 (D15-8) (D7-0) uint16 (D15-8) (D7-0)

Binary value 00000001 01100100 00000000 00000000

Hex value 0x0164 0x0000

Defines EventPowerOn 1000ms(1) 0 (n/a)(1) 0 (n/a) (2)

Time out Number of flashes LED_A LED_B Colour

uint16 uint16 (D15-12) (D11-8) (D7-4) (D3-0)


0000000000000000 0001 1111 1110 0001
0x0000 0x1fe1
0 1 LED_1 LED_0 LED_A

Table A.28: PS Key USR22 - Example Entry


(1)
Notes: The software multiplies the value entered in this field by 10 i.e. 10x10 results in 100ms.
(2)
The software multiplies the value entered in this field by 50 i.e. 40x50 results in 2000ms.

This equates to an LED sequence hex value entry of:

0164 0000 0000 1fe1

CSR plc 2005


CS-110372-UGP1 Page 37 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

This results in LED_1 flashing once for 1000ms (1 second) when the Power On event is generated.

Specialist use of PS Key22

PS Key 22 can be used to configure two other useful behaviour patterns:

Non-repeating patterns
To configure a PIO as an output pin for the duration of an event

Non-repeating Patterns:

_` BlueVOX2 Configurator User Guide


Setting the Repeat Time to 0 defines a non-repeating pattern. When a non-repeating pattern has completed the
previous state pattern will resume.

Configuring a PIO as Output Pin:

A PIO can be configured as an output pin, set and unset on individual events.

Note: This is generally used to indicate an event.

To configure a PIO as an output pin:

1. Setting the Number of Flashes to 0.


2. Set a non-zero On time to set the pin to ON (set high) or set a non-zero Off time to set the pin to Off (set
low).
Note: Two PS Key entries must be configured, one to set the pin high when the event occurs and one to set the
pin low when the event is no longer occurring.

As with normal Event Configuration the LED_A, LED_B and Colour fields can be used to configure the ON and
OFF conditions to influence one or two PIOs.

For example to set two pins PIO[11] and PIO[12] to high when an EventChargerConnected event is
generated, the hex value entered would be:

22ff 0000 00bc 0100

Headset System
Label LED On time LED off time LED repeat time
Event

Hex Value 22 ff 00 00

Defines charger connected


non-zero zero zero
event

Time out Number of flashes LED_A LED_B Colour

0x00 00 b c 0100
use both LED_A
zero zero PIO[11] PIO[12]
and LED_B

Table A.29: PS KEY USR22 Example Entry

CSR plc 2005


CS-110372-UGP1 Page 38 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.15 LED Filter Configuration


The BlueCore4-Headset allows each headset state/event to be associated with a unique LED flashing pattern.
See Appendix A.13 and Appendix A.14.

In addition, the software allows filters to be applied to individual LED patterns to change them in response to
some event or change in state. For example, to change the colour and/or frequency of a pattern being displayed
when the battery is low.

When implementing a filter it is normally necessary to create two filters, one to enable the change when the
trigger event or state change occurs and one to disable the change when trigger condition ceases.

_` BlueVOX2 Configurator User Guide


Two PS Keys hold the configuration details for implementing LED filters:

USR17: specifies the number of filters (entries) defined in PS Key USR18.


USR18: holds the attributes of 1 to n filters.

Filter attributes are held in the following format:

Headset Speed
Label Speed Active Unused Colour
Event Action

Type uint16 uint16


(D15-8) (D7-0) (D15) (D14) (D13-12) (D11-8)

Follower
Filter to Override Follower
LED to Use Unused LED Delay Unused
cancel LED Active LED Active
(x50ms)

uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)

Table A.30: PS Key USR18 - LED Filter Configuration Bit Fields

Description of Bit Fields

Headset event: System event associated with the LED filter being defined, see Appendix B

Note: This is specified as an offset of 0x6000 i.e. to specify the Power On Event (0x6001) the value of this field
would be 0x01.

Speed: The multiplier/divider applied to the frequency pattern.

Note: To leave the frequency of the original pattern unchanged this bit field should be set to 0.

Active: This bit field enables and disables the filter:

Bit = 1: Enabled.
Bit = 0: Disabled.

Unused: Dummy bit.

Speed Action: This field specifies the action to apply to the frequency:

Bit value = 01: SPEED_MULTIPLY, multiply the frequency by the value specified in the Speed field.
Bit value = 00: SPEED_DIVIDE, divide the frequency by the value specified in the Speed field.

CSR plc 2005


CS-110372-UGP1 Page 39 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Colour: This field defines the colour filter to apply:

Bit value = 0000: Reserved


Bit value = 0001: LED_A, force use of LED_A
Bit value = 0010: LED_B, force use of LED_B
Bit value = 0011: Alternative, force use of alternating LEDs
Bit value = 0100: LED_BOTH, force use of both LEDs

Filter to cancel: If the filter is set to not active (i.e. is used to cancel another defined filter when an event is

_` BlueVOX2 Configurator User Guide


generated), then this field contains the index of the filter that is to be cancelled. For example, if the filter is being
specified to cancel the second filter defined in PS Key USR17 then this field must be set to 0x2.

LED To Use: This field is used to specify an LED, which will be used for either the Override or LED Follower
behaviour, if they are activated.

Override LED Active: This field is set to activate or deactivate the Override LED field. When activated the LED
specified in the Override LED field will be turned ON during the OFF period of the original pattern.

bit = 1: Activate
bit = 0: Deactivate

Unused: Dummy bits.

LED Follower Active: When this bit is set the LED specified in the Override LED field repeats the original pattern
with a time offset as specified in the LED Follower delay field.

LED Follower delay (x50ms): The value in this field defines the time offset in milliseconds, between the original
pattern flashes and follower pattern flashes.

Note: The software multiplies the value entered by 50 milliseconds before it is applied.

Unused: Dummy bits.

Example

To configure filters to change all indications from Blue to Red on the BlueCore4-Headset development board
when the low battery event is received the PS Key hex values would be:

USR17 = 0003 (indicating 3 filters in PS Key USR18)


USR18 = 1a00 8200 0000 1e00 0100 0000 1f00 0010 0000

Note: All State and Event Indications that this filter is to affect need LED_A (blue) and LED_B (red) bit
fields set in PS Key USR20 (LED State Configuration) and USR22 (LED Event Configuration).

CSR plc 2005


CS-110372-UGP1 Page 40 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Explanation of USR18 value

The following three filters are defined:

EventLowBattery Enable the filter:

Headset Speed
Label Speed Active Unused Colour
Event Action

Type uint16 uint16


(D15-8) (D7-0) (D15) (D14) (D13-12) (D11-8)

_` BlueVOX2 Configurator User Guide


Binary value 00011010 00000000 1 0 00 0010

Hex value 0x1a00 8200

Description Event Low


not used Enabled not used not used LED_B (red)
Battery

Follower
Filter to Override Override Follower
Unused LED Delay Unused
cancel LED LED Active LED Active
(x50ms)

uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
0000 0000 0x0 00 0 0000 00000000
0x0000
not used not used not used not used not used not used not used

Table A.31: Example of Enabling Filter

The first entry, which enables the filter becomes:

1a00 8200 0000

CSR plc 2005


CS-110372-UGP1 Page 41 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Event TrickleCharge Disable filter

Headset Speed
Label Speed Active Unused Colour
Event Action

uint16 uint16
Type
(D15-8) (D7-0) (D15) (D14) (D13-12) (D11-8)

Binary value 00011110 00000000 0 0 00 0000

Hex value 0x1e00 0010

_` BlueVOX2 Configurator User Guide


Event Trickle
Description not used Disabled not used not used not used
Charge

Follower
Filter to Override Override Follower
Unused LED Delay Unused
cancel LED LED Active LED Active
(x50ms)

uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
0001 0000 0x0 00 0 0000 00000000
0x0000
st
1 filter
defined in PS not used not used not used not used not used not used
Key

Table A.32: Example of Disabling Filter

The second entry to disable the battery low filter when the trickle charge event is generated, becomes:

1e00 0010 0000

CSR plc 2005


CS-110372-UGP1 Page 42 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

EventFastCharge Disable filter

Headset Speed
Label Speed Active Unused Colour
Event Action

uint16 uint16
Type
(D15-8) (D7-0) (D15) (D14) (D13-12) (D11-8)

Binary value 00011111 00000000 0 0 00 0000

Hex value 0x1f00 0010

_` BlueVOX2 Configurator User Guide


Event Fast
Description not used Disabled not used not used not used
Charge

Follower
Filter to Override Override Follower
Unused LED Delay Unused
cancel LED LED Active LED Active
(x50ms)

uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
0001 0000 0x0 00 0 0000 00000000
0x0000
st
1 filter
defined in PS not used not used not used not used not used not used
Key

Table A.33: Example of Enabling Filter

The third entry to disable the battery low filter when the fast charge event is generated becomes:

1f00 0010 0000

The full USR18 hex value entry becomes:

1a00 8200 0000 1e00 0010 0000 1f00 0010 0000

CSR plc 2005


CS-110372-UGP1 Page 43 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.16 Event Configuration


Each headset system event is configured to be triggered by a set of system attributes. These include PIO lines,
PIO Duration and Headset State. A system event is only be generated when all the specified attribute conditions
are satisfied.

Two PS Keys USR23 and USR24 are used to configure events. The keys are of fixed length and must be 60
words long. Each key can contain a maximum of 20 Events = 60 Words.

Note: If the key contains less than the full 20 events then the remainder of the key must be padded with zero's.

_` BlueVOX2 Configurator User Guide


Each event is defined in the following format:

Headset State
Label System Event PIO Duration PIO Mask
Mask

Type uint16 (D15-8) (D7-0) uint16 uint16

Table A.34: PS Key USR23 and 24 Bit Fields

Description of Bit Fields

System Events: Event to be triggered, see Appendix B

Note: This is specified as an offset of 0x6000 i.e. to specify the Power On Event (0x6001) the value of this field
would be 0x01.

PIO Duration: This bit field specifies the duration attribute that must be satisfied to generate the system event.
The valid durations and their respective hex values are given below:

Label Value Description

Invalid 0x00 n/a


Sent immediately on release of the button - sent
Short (S) 0x01 regardless of whether the short is the first part of a
double press
Long (L) 0x02 Sent when the long timer has been reached
Very Long (V) 0x03 Sent when the very long timer has been reached
Sent when a second identical press is received within
Double (D) 0x04
the double time timeout
Repeat (R) 0x05 Sent every repeat time if the button is held down
RisingEdge (E) 0x06 Sent immediately on button press
FallingEdge (F) 0x07 Sent immediately on button release
Sent at the double press timeout if a short button press
Short SINGLE 0x08
was received, but was not part of a double press.
Sent when the button is released if the time is between
Long Release 0x09
the long and very long times.
Sent when the button is released, if the time is after the
Very Long Release 0x0a
very long timer.
Very Very Long Press 0x0b Sent when the very very long timer has been reached.
Sent when the button is released if the time is after the
Very Very Long Release 0x0c
very very long timer.
RESERVED 0x0d - 0x0f n/a

Table A.35: PIO Durations

CSR plc 2005


CS-110372-UGP1 Page 44 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

PIO Mask: The PIO mask is used to specify the PIO or PIOs that must be held high (pressed) to generate the
event:

Bit = 1: PIO must be pressed to generate event.


Bit = 0: PIO not involved in generating the event.

For Example:

To define a simultaneous press of both PIO[0] and PIO[1] to generate the event, the value for the PIO Mask bit
field would be 0x0003.

_` BlueVOX2 Configurator User Guide


Note: The other attributes specified in the Event System key i.e. PIO Duration and Headset State Mask conditions must
also be met for the event to be generated.

Bit D15 D14 D13 D12 D11 D10 D9 D8

Feature Reserved Reserved Reserved Reserved PIO[11] PIO[10] PIO[9] PIO[8]

Hex Value 0x0003

Binary 0 0 0 0 0 0 0 0

D7 D6 D5 D4 D3 D2 D1 D0

PIO[7] PIO[6] PIO[5] PIO[4] PIO[3] PIO[2] PIO[1] PIO[0]

0 0 0 0 0 0 1 1

Table A.36: PS Key USR23 and 24 Example Entry

Headset State Mask

For the system event to be generated, the headset must be in the specified state. The Headset State Mask bit
field specifies the headset state during which the system event can be generated if the other attribute conditions
are met:

Bit D15 D14 D13 D12 D11 D10 D9 D8

Active Three Three


Incoming
Call Call - Way Call Way Call
Feature Reserved Reserved Reserved Call On
Without Multi Call - Call On - Call
Hold
SCO Hold Waiting

D7 D6 D5 D4 D3 D2 D1 D0

Active Call Incoming Outgoing Connectable/ Powering


Test Mode Connected Connectable
with SCO Call Call Discoverable On

Table A.37: PS Key USR23 and 24 Headset State Bitmask

Example of an Event Configuration entry

To configure an Answer Call event to be generated when PIO[0] is pressed for a short duration when the headset
is in an Incoming Call state PS Key 24 would include the following hex value entry:

0601 0001 0020

CSR plc 2005


CS-110372-UGP1 Page 45 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.17 Tone Configuration


Each headset event can be associated with a tone to be played when the event occurs.

Two PS Keys are used to configure tones:

USR25: This key defines the number of entries in USR26 i.e. 1 n.


USR26: This key defines 1 n event/tone associations in the form:

_` BlueVOX2 Configurator User Guide


Label System Event Tone

Type uint8 uint8

Range 0x00 to 0x15 (1) or 0xff(2) 0x00 to 0x38(3)


(1)
This is the number of the event as an offset of 0x6000, see Appendix B
(2)
The value 0xff is used to associate the tone used as the headsets Out of Band Ring Tone, see example
below.
(3)
This represents the range of currently available tones, see Appendix C

Table A.38: PS Key USR26 Tone Configuration Bit Fields

Example:

To define an Out of Band Ring Tone (Valkyries):

Event = 0xff, Tone = 0x1d

To define toneShort 5 to be played on EventPowerOn:

EventPowerOn = 0x6001 = 01, Short 5 = 0x06

Therefore the PS Key hex values required to implement these tones would be:

PS Key USR25 = 0002 (indicates that there are two entries in PS Key USR26)
PS Key USR26 = ff1c 0106

A.18 PIO Output Configuration


PS Key USR27 provides a method of configuring a PIO as an output pin when certain state/event conditions are
met.

A specified pin can be configured to high when one of the following events is generated:

Call Active
Incoming Ring
Outgoing Ring
Active SCO
Power On
NiMH Charger Enable

CSR plc 2005


CS-110372-UGP1 Page 46 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

The key value is set in the format:

NiMH
Headset
Call Incoming Outgoing Power On Charger
Label Active Unused Unused
Active PIO Ring PIO Ring PIO PIO Enable
PIO (SCO)
PIO

uint16 uint16
Type (D11-8) (D7-4) (D3-0) (D11-8) (D7-4) (D3-0)
(D15-12) (D15-12)

Table A.39: PS Key USR26 PIO Output Configuration Bit Fields

_` BlueVOX2 Configurator User Guide


Description of Bit Fields

Call Active: If activated, the PIO specified in this field is held high when the headset is in an ongoing call. This is
set whenever the headset is in an ongoing call. If the call is ended, either by the headset or by the AG, this PIO
will be set Low.

Incoming Ring: If activated, the PIO specified in this field is held high when the headset is in the
IncomingCallEstablish state.

Outgoing Ring: If activated, the PIO specified in this field is held high when the headset is in the
OutgoingCallEstablish state.

Headset Active SCO: If activated, the PIO specified in this field is held high when SCO is active and audio is
routed to the headset.

Power On: If activated, the PIO specified in this field is held high when the headset is in the On state.

NiMH Charger Enable: If activated, the PIO specified in this field is held high to switch on the external NiMH
battery fast charging circuit.

Example:

To configure a Power On PIO[6] and a Ringing PIO[10]. The PS Key value would be configured as follows:

NiMH
Call Incoming Outgoing Active Power
Label Charger Unused Unused
Active Ring Ring SCO On
Enable

Binary
1111 1010 1111 1111 0110 1111 1111 1111
Value

Hex value 0xf 0xa 0xf 0xf 0x6 0xf 0xf 0xf

If an entry is set to 0xf the PIO will not be used

Table A.40: PS Key USR26 Example Entry

This gives a PS Key hex value of:

faff 6fff

CSR plc 2005


CS-110372-UGP1 Page 47 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.19 Tri Colour LED Information


PS Key USR28 is used to define the PIO or LED attached to any tricolour LEDs. Once defined, tricolour LEDs
can then be passed into LED Filter Configuration (PS Key USR18), LED Configuration (PS Key USR20) or LED
Event Configuration (PS Key USR22) to achieve different colours e.g. Red + Blue to give Purple.

A bitmask is used to specify the PIO/LED attached to the Tricolour connection pins:

Bitmask definition for assigning PIO_x/LED_x

_` BlueVOX2 Configurator User Guide


Bit D15 D14 D13 D12 D11 D10 D9

Mask value TriCol_a + TriCol_b + TriCol_a +


LED_1 LED_0 PIO_10 PIO_9
TriCol_c TriCol_c TriCol_b

D8 D7 D6 D5 D4 D3 D2 D1 D0

PIO_8 PIO_7 PIO_6 PIO_5 PIO_4 PIO_3 PIO_2 PIO_1 PIO_0

PS Key USR28

The effect of setting USR28 is best described by considering an example:

Label TriCol_a TriCol_b TriColor_c Unused

Type uint16 (D15-11) (D10-7) (D6-4) (D3-0)


Description Define Define Define n/a
PIO_x/LED_x (to PIO_x/LED_x (to PIO_x/LED_x (to
specify the PIO or specify the PIO or specify the PIO or
LED pin connected LED pin connected LED pin connected
to TriCol_a LED to TriCol_b LED to TriCol_c LED
pins) pins) pins)
Example: to define 0x2 0xe 0xf 0x0
a Red, Green and
Blue connected to
PIO[2], LED_0 and
LED_1 respectively.
(See table Bitmask
definition for
assigning
PIO_x/LED_x for
further explanation)
Binary 0010 1110 1111 0000

Following the example configuration above specifying the LED entries in LED Filter Configuration (PS Key
USR18), LED Configuration (PS Key USR20) or LED Event Configuration (PS Key USR22) will have the
following results:

LED entry used Resulting LED Colour

2 Red LED only


14 Green LED only
15 Blue LED only
11 Red and Green LEDs
12 Green and Blue LEDs
13 Red and Blue LEDs

CSR plc 2005


CS-110372-UGP1 Page 48 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

A.20 Power Table Settings


PS Key HFP_POWER_TABLE contains the power table used by the HFP library for any connections made. It
allows the link policy and the role switching implemented by the HFP library to be configured.

The power table supports entries for two modes:

Normal connected: connected with no active SCO link.


SCO connected: connected with an active SCO link.

The first word of the entry defines the number of entries for the Normal and SCO power table with a role for each

_` BlueVOX2 Configurator User Guide


mode. The bitfields of the first word are defined as:

Word 1

Label Normal Role Normal SCO Role SCO Number


number of of Entries
Entries

Type Uint16 (D15-12) (D11-8) (D7-4) (D3-0)


Description Role Definitions: Role Definitions:

0x00 = Master 0x00 = Master


0x01 = Slave 0x01 = Slave
0x02 = Passive 0x02 = Passive

Subsequent entries define the power table for each mode. Each entry is in the form:

Label State min_interval max_interval attempt timeout time

Type uint16 uint16 uint16 uint16 uint16 uint16


Description lp_active Defines the Defines the Determines Determines The period
(0x0000-use minimum ??? maximum how many how many for which the
active mode) interval ??? interval slots the additional mode will be
slave shall slots the entered. See
lp_sniff listen when slave shall example
(0x0001-use not treating listen when entry below.
sniff mode) the not treating
lp_passive connection the
(0x00ff - as a connection
dont care) scatternet as a
link. scatternet
link.

CSR plc 2005


CS-110372-UGP1 Page 49 of 58
This material is subject to CSRs non-disclosure agreement.
Description of PS Keys

Example entry for PS Key HFP_POWER_TABLE

This example describes the default settings to describe a typical power table entry:

Word 1

Label Normal Role Normal SCO Role SCO Number


number of of Entries
Entries

decimal 1 2 1 2

_` BlueVOX2 Configurator User Guide


Hex 0x1 0x2 0x1 0x2
Description Role is slave Defines two Role is slave defines two
entries for entries for SCO
normal connections
connections

Normal Mode power table:

Label state min interval max interval attempt timeout time

Entry lp_passive 0 0 0 0 1
Hex value 0x00ff 0x0000 0x0000 0x0000 0x0000 0x0001
Entry lp_sniff 800 800 4 1 0
Hex value 0x0001 0x0320 0x0320 0x0004 0x0001 0x0000
SCO Mode power table:

Label state min interval max interval attempt timeout time

Entry lp_passive 0 0 0 0 1
Hex value 0x00ff 0x0000 0x0000 0x0000 0x0000 0x0001
Entry lp_sniff 160 160 4 1 0
Hex value 0x0001 0x00a0 0x00a0 0x0004 0x0001 0x0000
Thus the hexadecimal entry for the PS key would be:

1212

00ff 0000 0000 0000 0000 0001 0001 0320 0320 0004 0001 0000

00ff 0000 0000 0000 0000 0001 0001 00a0 00a0 0004 0001 0000

This example defines the following behaviour:

Word 1defines the device as slave in both modes and indicates that there are two power table entries for each
mode.

CSR plc 2005


CS-110372-UGP1 Page 50 of 58
This material is subject to CSRs non-disclosure agreement.
BlueVOX2 System Events

Appendix B BlueVOX2 System Events


Table B.1 lists the viable BlueVOX BlueCore4-Headset system events.

Note: In the majority of situations, System Events are referenced in PS Keys as an offset of their base 0x6000.
i.e. EventPowerOn (0x6001) is identified using 0x01. However, in some cases the full Event number is
required.

System Event Event Event Description

_` BlueVOX2 Configurator User Guide


number Type

Power On 0x6001 Action Power The Headset On


Power Off 0x6002 Action Shutdown the headset
Action Make the headset Connectable /
Enter Pairing Mode 0x6003
Discoverable
Voice Dial 0x6004 Action Request a Voice Dial
Last Number Redial 0x6005 Action Request a Last Number Redial
Answer 0x6006 Action Answer a single Incoming call
Reject 0x6007 Action Reject a single Incoming call
Cancel / End 0x6008 Action Cancel / End a single active call
Action Transfer the audio of an active call to or
Transfer Audio 0x6009
from the AG
Toggle Mute 0x600a Action Toggle the Mute state of the headset
Action Increase the local volume and inform the
Volume Up 0x600b
AG of a volume change
Action Decrease the local volume and inform the
Volume Down 0x600c
AG of a volume change
Action Swap the orientation of the volume buttons
Toggle Volume 0x600d
(state does not persist in PS KEY_USR_10)
TWC Release All Held 0x600e Action Release all held calls
TWC Accept Waiting Release Action Accept a held or waiting call and release the
0x600f
Active active call
Action Accept a held or waiting call and place the
TWC Accept Waiting Hold Active 0x6010
active call on hold
Action Create a Multi Party call by adding any held
TWC Add Held To TWC 0x6011
calls to the conversation
Action Connect Multi-party calls and remove
TWC Expicit Tx 0x6012
yourself from the conversation
Enable/Disable Leds 0x6013 Action
Action Reset the Paired Device List and the
Reset Paired Device List 0x6014
Last/Default User
Enter DUT Mode 0x6015 Action Enter Device Under Test mode
Pairing Fail 0x6016 Indication A Pairing Attempt has failed
Pairing Successful 0x6017 Indication A Pairing attempt has succeeded
Indication An Audio Link has been Opened (also
Audio Link Open 0x6018
indicates Tone Playback complete)
Audio Link Close 0x6019 Indication An Audio link has been Closed
Indication The Battery Voltage is below the minimum
Low Battery 0x601a
threshold
End Of Call 0x601b Action End Of Call Detected

CSR plc 2005


CS-110372-UGP1 Page 51 of 58
This material is subject to CSRs non-disclosure agreement.
BlueVOX2 System Events

System Event Event Event Description


number Type

Indication Establish a Service Level Connection as per


Establish SCL 0x601c
the Reconnection policy
LED Event Complete 0x601d Indication A LED Event indication has finished
Indication The Battery Charger has entered Trickle
Trickle Charge 0x601e
Charge (NiMH Charger Only)
Auto Switch Off 0x601f Internal The Automatic Switch off timer has elapsed
Indication The Battery Charger has entered Fast

_` BlueVOX2 Configurator User Guide


Fast Charge 0x6020
Charge
Indication The Battery Voltage is above the minimum
Battery OK 0x6021
threshold
Charger Connected 0x6022 Action The Charger has been connected
Charger Disconnected 0x6023 Action The Charger has been removed
Indication A Service Level Connection has ben
SLC Disconnected 0x6024
removed
Complete UnMute Mic 0x6025 Internal Complete the UnMute Action
Indication An abnormal SLC disconnect has been
Link Loss 0x6026
detected
Limbo Timeout 0x6027 Internal Complete the UnMute Action
Mute On 0x6028 Action Activate Mute
Mute Off 0x6029 Action De-Activate Mute
Mute Reminder 0x602a Internal Headset is Muted
Reset Complete 0x602b Internal A Paired Device Reset is now complete
Enter TXContTestMode 0x602c Action Enter TX Continuous Test Mode
Enter DUT State 0x602d Action Enter the Device Under Test State
Action Restore the default orientation of the
Volume Orientation Normal 0x602e
Volume buttons
Volume Orientation Invert 0x602f Action Invert the Action of the Volume Buttons
Indication An AG has reported that there is no GSM
Network Not Present 0x6030
Network Present
Indication An AG has reported that there is a GSM
Network Present 0x6031
Network Present
Enable LEDS 0x6032 Action -
Disable LEDS 0x6033 Action -
SLCConnected 0x6034 Indication An SLC has been Established
Error 0x6035 Indication An AT command Error has been received
Indication A button has been held down for the Long
Long Timer 0x6036
Press Duration
Indication A button has been held down for the Very
tVLong Timer 0x6037
Long Press Duration
Enable Power Off 0x6038 Internal Allow Power Off Events to occur
Indication The Charger is reporting an Error whilst an
Charge Error 0x6039
active call is present
Place Incoming Call On Hold 0x603a Action Place an incoming call on hold
Accept Held Incoming Call 0x603b Action Accept the held incoming call
Reject Held Incoming Call 0x603c Action Reject the held incoming call

CSR plc 2005


CS-110372-UGP1 Page 52 of 58
This material is subject to CSRs non-disclosure agreement.
BlueVOX2 System Events

System Event Event Event Description


number Type

Cancel Led Indication 0x603d Action Reset the LED subsystem


HSP Enter Active Call State 0x603e Internal Enters Active call State when in HSP mode
The Charger is reporting an Error When no
Charge Error In Idle State 0x603f Indication call is present
Indicates headset failed to reconnect
Reconnect Failed 0x6040 Indication following abnormal disconnect
The battery voltage is above gas gauge

_` BlueVOX2 Configurator User Guide


Gas Gauge 0 0x6041 Indication level 0
The battery voltage is above gas gauge
Gas Gauge 1 0x6042 Indication level 1
The battery voltage is above gas gauge
Gas Gauge 2 0x6043 Indication level 2
The battery voltage is above gas gauge
Gas Gauge 3 0x6044 Indication level 3
Establish an audio link if one is not already
Check for Audio Transfer 0x6045 Internal open.

Table 6.1: BlueVOX2 System Events

CSR plc 2005


CS-110372-UGP1 Page 53 of 58
This material is subject to CSRs non-disclosure agreement.
BlueVOX2 Tones

Appendix C BlueVOX2 Tones


Tone Name Value Musical Note Duration

No tone 0x00
Middle 0 0x01 G5 300ms
Short 1 0x02 C6 100ms
Short 2 0x03 E6 100ms

_` BlueVOX2 Configurator User Guide


Short 3 0x04 G6 100ms
Short 4 0x05 AS6 100ms
Short 5 0x06 C7 100ms
Short 6 0x07 D7 100ms
Short 7 0x08 E7 100ms
Short 8 0x09 FS7 100ms
Middle 9 0x0a GS7 300ms
4 Note Rising Scale 0x0b GS4 DS5 GS5 C6 150 150 150 150
4 Note Falling Scale 0x0c C6 GS5 DS5 GS4 150 150 150 150
2 Note Rising Scale 0x0d E6 A6 200 200
2 Note Falling Scale 0x0e A6 E6 300 300
Long High Short Low 0x0f G5 G7 400 100
Short Middle 0x10 GS7 100
Long Middle 0x11 GS7 500
Long Low 0x12 G5 500
Short High 0x13 G6 100
V Long High 0x14 G6 800
Long High 0x15 G6 500
Short Double Low 0x16 G5 Ring Tone G5 100 100
Short Double High 0x17 G6 G6 100 100
battery_low_tone 0x18 E6 AS6 E6 AS6 E6 125 125 125 125 125
low_500ms_tone 0x19 G5 500
Long Double Low 0x1a G5 REST G5 500 500 500
ring_twilight 0x1b Ring Tone -
ring tone_g_s_t_q 0x1c Ring Tone -
ring tone_valkyries 0x1d Ring Tone -
ring tone_greensleeves 0x1e Ring Tone -
ring_two_beeps 0x1f Ring Tone -
ring _fairground 0x20 Ring Tone -
ring _counterpoint 0x21 Ring Tone -
ring_major_arp 0x22 Ring Tone -
ring_major_scale 0x23 Ring Tone -
ring_minor_arp 0x24 Ring Tone -

CSR plc 2005


CS-110372-UGP1 Page 54 of 58
This material is subject to CSRs non-disclosure agreement.
BlueVOX2 Tones

Tone Name Value Musical Note Duration

ring_harmonic_minor_scale 0x25 Ring Tone -


ring_more_than_a_feeling 0x26 Ring Tone -
ring_eight_beeps 0x27 Ring Tone -
ring_four_beeps 0x28 Ring Tone -
ring_bumble_bee 0x29 Ring Tone -
-

_` BlueVOX2 Configurator User Guide


ring_aug_scale 0x2a Ring Tone

ring_dim_scale 0x2b Ring Tone -


CustomRingTone 0x2c Ring Tone -
4 Note Low to High 0x2d G5 D6 G6 B5 37.5 37.5 37.5 37.5
4 Note High to Low 0x2e B5 G6 D6 G5 37.5 37.5 37.5 37.5
Short High to Low 0x2f G6 G5 25 25
5 Rapid High Tones 0x30 B6 B6 B6 B6 B6 94 94 94 94 94
Short Low to High 0x31 DS7 G7 100 100
Short High to Low 0x32 G7 DS7 100 100
Short V High 0x33 DS8 50
B6 G8 B6 G8 B6 G8 B6 50 50 50 50 50 50 50 50
12 High/Higher beeps 0x34
G8 B6 G8 B6 G8 50 50 50 50
Short Middle 0x35 DS8 50
A6 rest A6 rest A6 rest A6 50 50 50 50 50 50 50 50
5 high beeps 0x36
rest A6 rest 50 50
Short Low to High 0x37 B6 rest DS8 50 50 50
Short High to Low 0x38 DS8 rest B6 50 50 50

Table 6.2: BlueVOX2 Tones

CSR plc 2005


CS-110372-UGP1 Page 55 of 58
This material is subject to CSRs non-disclosure agreement.
BlueVOX2 Headset States

Appendix D BlueVOX2 Headset States


This appendix lists the headset states currently used in BlueVOX 1 BlueCore4 Headsets:

State Value Description

The headset is physically but not logically on (i.e. the


headsetLimbo 0x00 headset application has not received a Power On event) -
this state is used for NiMH charging

_` BlueVOX2 Configurator User Guide


headsetConnectable 0x01 The headset is Connectable but not Discoverable
headsetConnDiscoverable 0x02 The headset is both Connectable and Discoverable
The headset is Connected to an AG - No Longer
headsetConnected 0x03
Connectable or Discoverable
headsetOutgoingCallEstablish 0x04 The Connected AG is making an outgoing call
headsetIncomingCallEstablish 0x05 The Connected AG is receiving an Incoming call Indication
headsetActiveCall 0x06 A call is in progress
headsetTestMode 0x07 DUT mode (Device Under Test)
An active call is in progress and a second incoming call is
headsetThreeWayCallWaiting 0x08
being indicated
An active call is in progress and a second call is currently on
headsetThreeWayCallOnHold 0x09
hold
headsetThreeWay Multi Call 0x0a Two active calls are in progress - multi-party calling
headsetIncomingCallOnHold 0x0b A single Incoming Call has been placed on hold
A call is in progress but there is not an active audio
headsetActiveCallNoSco 0x0c
connection

Table 6.3: BlueVOX2 Headset States

CSR plc 2005


CS-110372-UGP1 Page 56 of 58
This material is subject to CSRs non-disclosure agreement.
Terms and Definitions

Terms and Definitions


BlueCore Group term for CSRs range of Bluetooth wireless technology chips

Bluetooth Set of technologies providing audio and data transfer over short-range radio connections
Bluetooth SIG Bluetooth Special Interest Group
CSR Cambridge Silicon Radio
AG Audio Gateway
BCSP BlueCore Serial Protocol

_` BlueVOX2 Configurator User Guide


DUT Device Under Test
EEPROM Electrically Erasable Programmable Read Only Memory
eSCO extended Synchronous Connection-Oriented
HFP Handsfree Profile
HSP Headset Profile
HMI Human Machine Interface
I2 C Inter-Integrated Circuit
LDO Low Drop Out
LED Light Emitting Diode
NiMH Nickel Metal Hydride
PIO Parallel Input Output
ROM Read Only Memory
SCO Synchronous Connection-Oriented
SLC Service Level Connection
SMPS Switch Mode Power Supply
SPI Serial Peripheral Interface
UI User Interface
USB Universal Serial Bus
VGS Volume Gain Setting

CSR plc 2005


CS-110372-UGP1 Page 57 of 58
This material is subject to CSRs non-disclosure agreement.
Document History

Document History
Revision Date History

a 12 SEP 06 Original publication of this document. (CSR reference: CS-110372-UGP1)

_` BlueVOX2 Configurator User Guide


_`=

BlueVOX2 Configurator

User Guide

CS-110372-UGP1

September 2006


Unless otherwise stated, words and logos marked with or are trademarks registered or owned by CSR plc or

its affiliates. Bluetooth and the Bluetooth logos are trademarks owned by Bluetooth SIG, Inc. and licensed to
CSR. Other products, services and names used in this document may have been trademarked by their respective
owners.

The publication of this information does not imply that any license is granted under any patent or other rights
owned by CSR plc.

CSR reserves the right to make technical changes to its products as part of its development programme.

While every care has been taken to ensure the accuracy of the contents of this document, CSR cannot accept
responsibility for any errors.

CSRs products are not authorised for use in life-support or safety-critical applications.

CSR plc 2005


CS-110372-UGP1 Page 58 of 58
This material is subject to CSRs non-disclosure agreement.

Vous aimerez peut-être aussi