ADK

Audio Sink Application Configuration

User Guide
Issue 1

Page 1 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Document History
Revision Date History

1 20/07/2015 Original publication of this document

Contacts
General information www.csr.com
Information on this product [email protected]
Customer support for this product www.csrsupport.com

ADK Audio Sink Application Configuration User Guide

More detail on compliance and standards [email protected]
Help with this document [email protected]

Page 2 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Trademarks, Patents and Licences
Unless otherwise stated, words and logos marked with ™ or ® are trademarks registered or owned by CSR plc
and/or its affiliates.
Select appropriate sentences based on product range from this list
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 licence is granted under any patent or other rights owned
by CSR plc or its affiliates.
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.

ADK Audio Sink Application Configuration User Guide

Life Support Policy and Use in Safety-critical Compliance
CSR’s products are not authorised for use in life-support or safety-critical applications. Use in such applications is
done at the sole discretion of the customer. CSR will not warrant the use of its devices in such applications.

Performance and Conformance

Refer to www.csrsupport.com for compliance and conformance to standards information.

Page 3 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Contents
Document History ......................................................................................................................................................... 2
Contacts........................................................................................................................................................................ 2
Trademarks, Patents and Licences .............................................................................................................................. 3
Life Support Policy and Use in Safety-critical Compliance............................................................................................ 3
Performance and Conformance .................................................................................................................................... 3
Contents ....................................................................................................................................................................... 4
Tables, Figures and Equations ..................................................................................................................................... 5
1. Overview ............................................................................................................................................................ 7
2. Introduction ........................................................................................................................................................ 8
3. Dynamic Configuration Keys .............................................................................................................................. 9

ADK Audio Sink Application Configuration User Guide

3.1. Session Data Configuration .......................................................................................................................... 10
3.2. Subwoofer Configuration .............................................................................................................................. 14
3.3. Stored Phone Number Configuration ............................................................................................................ 15
3.4. FM Stored Frequency ................................................................................................................................... 16
3.5. Infra-Red Controller Learned Codes............................................................................................................. 17
3.6. SQIF Partitions Configuration ....................................................................................................................... 18
4. Static Configuration Keys ................................................................................................................................. 19
4.1. Feature Block Configuration ......................................................................................................................... 21
4.2. Lengths Configuration .................................................................................................................................. 28
4.3. Timers Configuration .................................................................................................................................... 29
4.4. Device ID and Software Version Configuration............................................................................................. 31
4.5. Battery Configuration .................................................................................................................................... 32
4.6. Radio Configuration ...................................................................................................................................... 34
4.7. Volume Control Configuration....................................................................................................................... 35
4.8. HFP Init Configuration .................................................................................................................................. 37
4.9. HFP 1.5 Feature Configuration ..................................................................................................................... 38
4.10. RSSI Inquiry Configuration........................................................................................................................ 39
4.11. PIO Configuration ..................................................................................................................................... 40
4.12. Button Configuration ................................................................................................................................. 41
4.13. Button Translation ..................................................................................................................................... 42
4.14. Button Pattern Configuration ..................................................................................................................... 43
4.15. LED Filters Configuration .......................................................................................................................... 44
4.16. LED States Configuration.......................................................................................................................... 45
4.17. Tri Colour LED Configuration .................................................................................................................... 45
4.18. LED Events Configuration ......................................................................................................................... 45
4.19. Events Configuration ................................................................................................................................. 46
4.20. Tones Configuration .................................................................................................................................. 48
4.21. User Tones Configuration ......................................................................................................................... 49
4.22. Audio Prompts Configuration .................................................................................................................... 50
4.23. Sniff Sub-Rate Configuration .................................................................................................................... 51
4.24. USB Configuration .................................................................................................................................... 52
4.25. FM Configuration ...................................................................................................................................... 54
4.26. AT Commands Configuration .................................................................................................................... 55
4.27. I2S Configuration ....................................................................................................................................... 55
4.28. I2S Initialisation Configuration ................................................................................................................... 55
4.29. Audio Routing Configuration ..................................................................................................................... 56
4.30. Input Manager Configuration..................................................................................................................... 58
4.31. Bluetooth Smart Remote Control Configuration ........................................................................................ 60

Page 4 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 4.32. Infra-Red Remote Control Configuration ................................................................................................... 61
4.33. Power Management Unit Charger Configuration ...................................................................................... 62
4.34. Peer Device Custom UUID Configuration ................................................................................................. 63
4.35. Multi-Channel Configuration...................................................................................................................... 64
4.36. PS Defrag Test Configuration ................................................................................................................... 66
4.37. Bluetooth Smart Permanent Pairing Configuration ................................................................................... 66
4.38. Software Version Configuration ................................................................................................................ 67
5. Appendix .......................................................................................................................................................... 68
Appendix A LED Pattern Configuration Data ............................................................................................................ 68
Appendix B State Mask ............................................................................................................................................ 69
Document References ................................................................................................................................................ 70
Terms and Definitions ................................................................................................................................................. 71

ADK Audio Sink Application Configuration User Guide

Tables, Figures and Equations
Table 2.1: Configuration Key Categories ...................................................................................................................... 8
Table 3.1: Dynamic Configuration Keys ........................................................................................................................ 9
Table 3.2: CONFIG_SESSION_DATA Data Structure................................................................................................ 10
Table 3.3: User Configurable Features Session Data ................................................................................................. 11
Table 3.4: Audio Enhancements Session Data ........................................................................................................... 11
Table 3.5: FM Receive session data ........................................................................................................................... 12
Table 3.6: Volume Levels Session Data ..................................................................................................................... 12
Table 3.7: User EQ Session Data ............................................................................................................................... 12
Table 3.8: User EQ Bank Session Data ...................................................................................................................... 13
Table 3.9: Filter Types ................................................................................................................................................ 13
Table 3.10: Subwoofer Configuration Data ................................................................................................................. 14
Table 3.11: Phone Number Configuration................................................................................................................... 15
Table 3.12: FM Stored Frequency Configuration ........................................................................................................ 16
Table 3.13: Infra-Red Controller Learnt Codes Configuration ..................................................................................... 17
Table 3.14: Data Structure for Each Learnt Infra-Red Code ....................................................................................... 17
Table 3.15: SQIF Partitions Configuration .................................................................................................................. 18
Table 4.1: Static Configuration Keys ........................................................................................................................... 20
Table 4.2: Feature Block Configuration....................................................................................................................... 21
Table 4.3: Feature Block Configuration: Word 1 ......................................................................................................... 22
Table 4.4: Feature Block Configuration: Word 2 ......................................................................................................... 23
Table 4.5: Feature Block Configuration: Word 3 ......................................................................................................... 24
Table 4.6: Feature Block Configuration: Word 4 ......................................................................................................... 25
Table 4.7: Feature Block Configuration: Word 5 ......................................................................................................... 25
Table 4.8: Feature Block Configuration: Word 6 ......................................................................................................... 26
Table 4.9: Feature Block Configuration: Word 7 ......................................................................................................... 26
Table 4.10: Feature Block Configuration: Word 8 ....................................................................................................... 27
Table 4.11: Lengths Configuration .............................................................................................................................. 28
Table 4.12: Timers Configuration ................................................................................................................................ 30
Table 4.13: Device ID and Software Version Configuration ........................................................................................ 31
Table 4.14: Battery Configuration ............................................................................................................................... 32
Table 4.15: Vref Configuration .................................................................................................................................... 32
Table 4.16: Vbat Configuration ................................................................................................................................... 32
Table 4.17: Vthm Configuration .................................................................................................................................. 33
Table 4.18: Vchg Configuration .................................................................................................................................. 33
Table 4.19: ADC Configuration ................................................................................................................................... 33

Page 5 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Table 4.20: Battery Limit Configuration ....................................................................................................................... 33
Table 4.21: Radio Configuration ................................................................................................................................. 34
Table 4.22: Volume Control Configuration .................................................................................................................. 35
Table 4.23: Volume Mapping Configuration ................................................................................................................ 36
Table 4.24: HFP Initialisation Configuration ................................................................................................................ 37
Table 4.25: HFP1.5 Configuration .............................................................................................................................. 38
Table 4.26: RSSI Pairing Configuration ...................................................................................................................... 39
Table 4.27: PIO Configuration .................................................................................................................................... 40
Table 4.28: Button Configuration ................................................................................................................................ 41
Table 4.29: Button Translation Configuration.............................................................................................................. 42
Table 4.30: Button Translation Type ........................................................................................................................... 42
Table 4.31: Button Pattern Configuration .................................................................................................................... 43

ADK Audio Sink Application Configuration User Guide

Table 4.32: Button Pattern Type ................................................................................................................................. 43
Table 4.33: LED Filters Configuration ......................................................................................................................... 44
Table 4.34: LED Filters Type ...................................................................................................................................... 44
Table 4.35: LED States Configuration......................................................................................................................... 45
Table 4.36: Tri Colour LED Configuration ................................................................................................................... 45
Table 4.37: LED States Configuration......................................................................................................................... 45
Table 4.38: Event Blocks ............................................................................................................................................ 46
Table 4.39: Data Structure Used by Event Translation Tables ................................................................................... 46
Table 4.40: Button Timing Events ............................................................................................................................... 47
Table 4.41: Tones Configuration Data Structure ......................................................................................................... 48
Table 4.42: Tones Configuration Type ........................................................................................................................ 48
Table 4.43: User Tones Configuration ........................................................................................................................ 49
Table 4.44: Audio Prompts Configuration ................................................................................................................... 50
Table 4.45: Table Title ................................................................................................................................................ 50
Table 4.46: Sniff Sub-Rate Configuration ................................................................................................................... 51
Table 4.47: USB Configuration ................................................................................................................................... 52
Table 4.48: USB Charger Configuration ..................................................................................................................... 53
Table 4.49: FM Configuration ..................................................................................................................................... 54
Table 4.50: Audio Routing Configuration .................................................................................................................... 56
Table 4.51: Audio Plugin features ............................................................................................................................... 56
Table 4.52: Silence Detection Configuration ............................................................................................................... 57
Table 4.53: SPDIF Latency Configuration................................................................................................................... 57
Table 4.54: Input Manager Configuration.................................................................................................................... 58
Table 4.55: Input Manager Lookup Table Configuration ............................................................................................. 58
Table 4.56: Input Manager Events .............................................................................................................................. 59
Table 4.57: Bluetooth Smart Remote Control Configuration ....................................................................................... 60
Table 4.58: Bluetooth Smart Remote Control HID Code Mapping .............................................................................. 60
Table 4.59: Infra-Red Control Configuration ............................................................................................................... 61
Table 4.60: Infra-Red Control Code Mapping ............................................................................................................. 61
Table 4.61: PMU Configuration ................................................................................................................................... 62
Table 4.62: Peer Device Custom UUID ...................................................................................................................... 63
Table 4.63: Multi Channel Configuration ..................................................................................................................... 64
Table 4.64: Audio Interface Configuration................................................................................................................... 65
Table 4.65: Software Version Configuration ............................................................................................................... 67
Table 5.1: LED Patterns Data Structure...................................................................................................................... 68
Table 5.2: State Mask Look Up Table ......................................................................................................................... 69

Page 6 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
1. Overview
This document describes the configuration data used by the Audio Sink application that is included as part of the
ADK release.
Note:
This document is intended to be used in conjunction with the Audio Sink Application User Guide and the Audio
Sink Application Configuration Tool User Guide documents.

ADK Audio Sink Application Configuration User Guide

Page 7 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
2. Introduction
The Audio Sink application can be setup and configured in many different ways depending on the build options and
configuration data. This document goes over each configuration item in full detail describing how the configuration
will affect behaviour.
Configuration keys used by the Audio Sink Application can be split into two categories outlined in Table 2.1.

Category Description

Dynamic Dynamic configuration keys may be updated at runtime by the Sink application. Dynamic keys
store preset data that the VM application can alter during runtime, the values of which then
persist across power resets. Dynamic configuration data is stored in the Key range USR0 to

ADK Audio Sink Application Configuration User Guide

USR5, see Section 3.

Static Static configuration keys cannot be updated by the VM application and are therefore preset at
production and constant. Static configuration data is stored in the range USR6 to USR49 (i.e. the
range extends to the end of the USR key allocation), see Section 4.

Note:
Static configuration keys can be updated using Over-The-Air updates, see the Audio Sink Application Software
Upgrade User Guide.

Table 2.1: Configuration Key Categories

Note:
Configuration data handled by the BlueCore firmware, but not by the VM application, is held in non-USR PS
Keys.

Page 8 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3. Dynamic Configuration Keys
This section covers the dynamic configuration keys used by the Audio Sink application. Table 3.1 lists all dynamic
configuration keys used by the Audio Sink application.

PSKEY ID PSKEY Name Description

USR0 CONFIG_SESSION_DATA See Section 3.1

USR1 CONFIG_SUBWOOFER See Section 3.2

USR2 CONFIG_PHONE_NUMBER See Section 3.3

USR3 CONFIG_FM_FREQUENCY_STORE See Section 3.4

ADK Audio Sink Application Configuration User Guide

USR4 CONFIG_IR_REMOTE_CONTROL_LEARNED_CODES See Section 3.5

USR5 CONFIG_SQIF_PARTITIONS See Section 3.6

Table 3.1: Dynamic Configuration Keys

Page 9 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.1. Session Data Configuration
Written by the application at the end of a session this Key holds the session data so that feature settings persist the
next time the application is run. Table 3.2 describes the layout of the configuration data within this PSKEY.

Word(s) Description

1 User configurable features state, see Section 3.1.1

2 Audio enhancements state, see Section 3.1.2

3 FM Receive state, see Section 3.1.3

4 - 11 Volume levels, see Section 3.1.4

ADK Audio Sink Application Configuration User Guide

12 - 32 User EQ state, see Section 3.1.5

Table 3.2: CONFIG_SESSION_DATA Data Structure

Note:
Individual feature bits in this PS Key can be preconfigured to set default values if it is not intended to allow a
user to change the state of a particular feature.

3.1.1. User Configurable Features

This item stores the current state of the user configurable features. This enables the Audio Sink application to
maintain its state between power cycles. The data items for this are described in Table 3.3.

Bit Feature Description

D[15] Volume Orientation 1 = Inverts the operation of the volume controls

0 = Volume control normal orientation

D[14] LED Disable 1 = Disables the LEDs

0 = Enables LEDs

D[13:10] TTS Language Selected Text To Speech Language Set

D[9] Multipoint Enable 1 = Enable Multipoint operation

0 = Disable Multipoint operation

D[8] Unused -

D[7] LBIPM Enable 1 = Enable Low Battery intelligent Power Management

0 = Disable Low Battery intelligent Power Management

D[6:5] Unused -

D[4] Text To Speech Enable 1 = Enable Text To Speech

0 = Disable Text To Speech

D[3] Speech Recognition Enable 1 = Enable Speech Recognition

0 = Disable Speech Recognition

D[2:0] Audio Source 0 = audio_source_none

1 = audio_source_FM

2 = audio_source_ANALOG
3 = audio_source_SPDIF

Page 10 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 Bit Feature Description

4 = audio_source_USB
5 = audio_source_AG1

6 = audio_source_AG2
7 = audio_source_end_of_list

Table 3.3: User Configurable Features Session Data

3.1.2. Audio Enhancements

This item stores the current state of the audio enhancements. This enables the Audio Sink application to maintain its

ADK Audio Sink Application Configuration User Guide

state between power cycles. The data items for this are described in Table 3.4.

Bit Feature Description

D[15] Audio Enhancements Enable 1 = Enable

0 = Disable

D[14:12] unused -

D[11] Subwoofer bypass 1 = Enable

0 = Disable

D[10] Speaker EQ Bypass 1 = Enable

0 = Disable

D[9] EQ Flat 1 = Enable

0 = Disable

D[8] User EQ Bypass 1 = Enable

0 = Disable

D[7] Bass Boost Bypass 1 = Enable

0 = Disable

D[6] Spatial Bypass 1 = Enable

0 = Disable

D[5] Compander Bypass 1 = Enable

0 = Disable

D[4] Dither Bypass 1 = Enable

0 = Disable

D[3] unused -

D[2:0] Selected EQ Bank 0x7 selects the option to use the last customer defined EQ settings

Table 3.4: Audio Enhancements Session Data

3.1.3. FM Receive
This item stores the current state of the FM Recieve. This enables the Audio Sink application to maintain its state
between power cycles. The data items for this are described in Table 3.5.

Page 11 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 Bit Feature Description

D[15:0] Stored FM Frequency Frequency stored on last FM Rx use

Table 3.5: FM Receive session data

3.1.4. Volume Levels

This item stores the current state of the volume levels. This enables the Audio Sink application to maintain its state
between power cycles. The data items for this are described in Table 3.6.

Words Description Words Description

ADK Audio Sink Application Configuration User Guide

1-2 Analogue volume level 1 Main volume level for Analogue

2 Aux volume level for Analogue

3-4 SPDIF volume level 1 Main volume level for SPDIF

2 Aux volume level for SPDIF

5-6 USB volume level 1 Main volume level for USB

2 Aux volume level for USB

7-8 FM Receive volume 1 Main volume level for FM Receive

level
2 Aux volume level for FM Recieve

Table 3.6: Volume Levels Session Data

3.1.5. User EQ
This item stores the current state of the volume levels. This enables the Audio Sink application to maintain its state
between power cycles. The data items for this are described in Table 3.7.

Words Description

1 Pre Gain

2-5 EQ Bank 1, see 3.1.5.1

6-9 EQ Bank 2, see 3.1.5.1

10-13 EQ Bank 3, see 3.1.5.1

14-17 EQ Bank 4, see 3.1.5.1

18-21 EQ Bank 5, see 3.1.5.1

Table 3.7: User EQ Session Data

Note:
By default, the Audio Sink application supports 5 user EQ banks. This can only be modified by changing the
source code.

Page 12 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.1.5.1. User EQ Bank
This data item stores session data for each EQ bank, Table 3.8 describes the data layout.

Word Description Range Divider Actual Range

1 Filter Type 0x0 <> 0xD (see Table 3.9) N/A N/A

2 Frequency 0x3C <> 0xEA60 3 20(Hz) <> 20 (kHz)

3 Gain 0xfd30 <> 0x02D0 60 -12(dB) <> +12(dB)

4 Q Factor 0x3FF <> 0x7FF8 4096 0.25 <> 8

Table 3.8: User EQ Bank Session Data

ADK Audio Sink Application Configuration User Guide

Value Filter Type

0x0 Bypass

0x1 First order low pass

0x2 First order high pass

0x3 First order all pass

0x4 First order low shelf

0x5 First order high shelf

0x6 First order tilt

0x7 Second order low pass

0x8 Second order high pass

0x9 Second order all pass

0xa Second order low shelf

0xb Second order high shelf

0xc Second order tilt

Table 3.9: Filter Types

Page 13 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.2. Subwoofer Configuration
The subwoofer configuration key is used to configure the subwoofer link. Table 3.10 describes this data item.
Note:
In previous ADK releases, this key was dynamic in that the Bluetooth address of the paired subwoofer was
written to this key. This is no longer required in current ADK releases and this key is treated as a static key
rather than a dynamic key.

Words Description

1-4 Reserved (in previous ADK releases, this was used to store the Bluetooth address of the paired
subwoofer)

ADK Audio Sink Application Configuration User Guide

5 - 13 SCO connection parameters to carry subwoofer media packets

Table 3.10: Subwoofer Configuration Data

Page 14 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.3. Stored Phone Number Configuration
This configuration item is used by the HFP module of the Audio Sink application to store a phone number received
from the connected AG. For more information on this process, see Audio Sink Application User Guide. The format of
this configuration item is described by Table 3.11.

Words Description

1 - 20 Array of uint16 numbers representing a phone number

Table 3.11: Phone Number Configuration

ADK Audio Sink Application Configuration User Guide

Page 15 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.4. FM Stored Frequency
The Audio Sink application is able to store a user's favourite radio stations. This configuration item is used to store
data for each of the stored FM radio frequency. Table 3.12 lists the data structure for this configuration item.
Note:
By default, the Audio Sink application is capable of storing 3 FM frequencies, this can only be modified by
changing the source code.

Word Description

1 Frequency for stored radio station 1

2 Frequency for stored radio station 2

ADK Audio Sink Application Configuration User Guide

3 Frequency for stored radio station 3

Table 3.12: FM Stored Frequency Configuration

Page 16 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.5. Infra-Red Controller Learned Codes
The Audio Sink application has a feature that allows new Infra-Red codes to be learnt and mapped to user events.
This configuration item stores the learnt codes, this configuration key contains an array of learnt infra-red codes,
Table 3.13 describes the data structure format for this key.

Words Description

1-2 First learnt code, see Table 3.14

2-4 Second learnt code, see Table 3.14

4 ... Other learnt codes to follow, see Table 3.14

ADK Audio Sink Application Configuration User Guide

Table 3.13: Infra-Red Controller Learnt Codes Configuration
Notes:
(1) This configuration key could be empty if no codes have been learnt.
(2) There is no software restriction on the number of Infra-Red codes that can be learnt. However, depending on
the target BlueCore, the amount of data that can be stored in one PSKEY will limit the maximum number of
learnt codes.

Bits Description

0-8 The Infra-Red code received from the controller (converts to virtual button ID)

9 - 12 Reserved

13 - 16 Virtual Button ID

17 - 32 Address of the remote controller that sent the Infra-Red code.

Table 3.14: Data Structure for Each Learnt Infra-Red Code

Page 17 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
3.6. SQIF Partitions Configuration
The software upgrade module of the Audio Sink application uses this configuration key. It is used to specify which
SQIF partitions, if present, are available. It also specifies the partition that is to be used for the device firmware
upgrade (DFU).

Bits Description

0-8 Bit mask specifying the free SQIF partitions

8 - 16 Reserved

17 - 24 SQIF partition to use for DFU (range: 0 to 14)

ADK Audio Sink Application Configuration User Guide

25 - 32 Reserved

Table 3.15: SQIF Partitions Configuration

Page 18 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4. Static Configuration Keys
PSKEY ID PSKEY Name Description

USR6 CONFIG_FEATURE_BLOCK See Section 4.1

USR7 CONFIG_LENGTHS See Section 4.2

USR8 CONFIG_TIMEOUTS See Section 4.3

USR9 CONFIG_DEVICE_ID See Section 4.4

USR10 CONFIG_BATTERY See Section 4.5

ADK Audio Sink Application Configuration User Guide

USR11 CONFIG_RADIO See Section 4.6

USR12 CONFIG_VOLUME_CONTROL See Section 4.7

USR13 CONFIG_HFP_INIT See Section 4.8

USR14 CONFIG_ADDITIONAL_HFP_SUPPORTED_FEATURES See Section 4.9

USR15 CONFIG_RSSI_PAIRING See Section 4.10

USR16 CONFIG_PIO See Section 4.11

USR17 CONFIG_BUTTON See Section 4.12

USR18 CONFIG_BUTTON_TRANSLATION See Section 4.13

USR19 CONFIG_BUTTON_PATTERN_CONFIG See Section 4.14

USR20 CONFIG_LED_FILTERS See Section 4.15

USR21 CONFIG_LED_STATES See Section 4.16

USR22 CONFIG_TRI_COL_LEDS See Section 4.17

USR23 CONFIG_LED_EVENTS See Section 4.18

USR24 CONFIG_EVENTS_A See Section 4.19

USR25 CONFIG_EVENTS_B See Section 4.19

USR26 CONFIG_EVENTS_C See Section 4.19

USR27 CONFIG_TONES See Section 4.20

USR28 CONFIG_USER_TONES See Section 4.21

USR29 RESERVED This PSKEY is reserved

USR30 CONFIG_AUDIO_PROMPTS See Section 4.22

USR31 CONFIG_SSR_PARAMS See Section 4.23

USR32 CONFIG_USB_CONFIG See Section 4.24

USR33 CONFIG_FM_CONFIG See Section 4.25

USR34 CONFIG_AT_COMMANDS See Section 4.26

Page 19 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
PSKEY ID PSKEY Name Description

USR35 CONFIG_I2S_INIT_CONFIGURATION See Section 4.27

USR36 CONFIG_I2S_INIT_DATA See Section 4.28

USR37 CONFIG_AUDIO_ROUTING See Section 4.29

USR38 CONFIG_INPUT_MANAGER See Section 4.30

USR39 CONFIG_BLE_REMOTE_CONTROL See Section 4.31

USR40 CONFIG_IR_REMOTE_CONTROL See Section 4.32

ADK Audio Sink Application Configuration User Guide

USR41 CONFIG_PMU_MONITOR_CONFIG See Section 4.33

USR42 CONFIG_PEER_DEVICE_CUSTOM_UUID See Section 4.34

USR43 CONFIG_MULTI_CHANNEL_AUDIO See Section 4.35

USR44 RESERVED This PSKEY is reserved

USR45 RESERVED This PSKEY is reserved

USR46 RESERVED This PSKEY is reserved

USR47 CONFIG_DEFRAG_TEST See Section 4.36

USR48 CONFIG_PERMANENT_PAIRING See Section 4.37

USR49 CONFIG_SOFTWARE_VERSION_ID See Section 4.38

Table 4.1: Static Configuration Keys

Page 20 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 4.1. Feature Block Configuration
This configuration item contains configuration of the Audio Sink applications major feature set.

Word Description

1 Feature block word 1, see Table 4.3.

2 Feature block word 2, see Table 4.4.

3 Feature block word 3, see Table 4.5.

4 Feature block word 4, see Table 4.6.

ADK Audio Sink Application Configuration User Guide

5 Feature block word 5, see Table 4.7.

6 Feature block word 6, see Table 4.9.

7 Feature block word 7, see Table 4.10.

Table 4.2: Feature Block Configuration

Bits Feature Description

D[15] ReconnectOnPanic 1 = The Audio Sink application silently reboots and reconnects to the AG in
the event of a panic.
0 = The Audio Sink application powers off and does not turn back on without
user intervention in the event of a panic.

D[14] OverideFilterPermanentlyOn 1 = when displaying an override filter LED indication there are no breaks in a
solid colour display. Normal mode/event indications are suppressed for the
LED chosen for the override LED filter.
0 = The LED override filter functions as normal.

D[13] MuteSpeakerAndMic 1 = Mute mutes both the Speaker and the Microphone of the Sink.
0 = Only the Microphone will be muted.

D[12] PlayTonesAtFixedVolume 1 = Tones are played at a nominal fixed volume regardless of the current
Profile Volume level. The fixed volume level is set by the
FixedToneVolumeLevel parameter.
0 = Tones are played at the current Profile Volume level.

D[11] PowerOffAfterPDLResest 1 = The Audio Sink application powers off after user event
EventResetPairedDeviceList has been issued. The chip will
reboot if ResetAfterPowerOffComplete is set.
0 = The Audio Sink application does not power off after the event has been
issued.
Note:
Reset Clears the Default and Last user together with the list of Paired
devices.

D[10] RemainDiscoverableAtAllTimes 1 = The Audio Sink application remains discoverable at all times. This is
useful for Multipoint operation.
0 = The Sink remains discoverable until connected.

D[9] DisablePowerOffAfterPowerOn 1 = The Audio Sink application ignores the power off button press
immediately after power on. DisablePowerOffAfterPowerOnTime
sets the time the power button is ignored for.
0 = The Sink does not ignore the power off button press after power on.

D[8] AutoAnswerOnConnect 1 = This allows the Audio Sink application to send an answer (ATA) AT
command if an incoming call is detected on connection.

Page 21 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Feature Description

0 = The Audio Sink application does not respond to an incoming call

detected on connection.

D[7] EnterPairingModeOnFailureToConnect 1 = The Sink goes into pairing mode if it fails to connect with any
paired devices.
0 = The Sink goes into connectable mode if it fails to connect with
any paired devices.

D[6:5] PartyMode 0 = Party mode off.

1 = Party mode barge in mode. Music tracks are played immediately.
2 = Party mode AVRCP Mode. Music is queued and next track is played
when the current one has finished.
1 = Volume events EventVolumeUp/EventVolumeDown set the

ADK Audio Sink Application Configuration User Guide

D[4] AdjustVolumeWhilstMuted
volume to the new level while the Sink is muted.
0 = Volume events do not alter the volume level while the Sink is muted.

D[3] VolumeChangeCausesUnMute 1 = Volume events cause the Sink to unmute and set the volume to the new
level.
0 = Volume events do not unmute the Sink and the local Sink volume value
is updated according to the AdjustVolumeWhilstMuted feature.

D[2] PowerOffOnlyIfVRegEnLow When set this feature prevents the Sink from powering off if the VREG
enable pin is not low.

D[1] LimitRssiSuboowferPairing When set this enables subwoofer RSSI pairing that ensures signal strength
is higher than the configured threshold.

D[0] pair_mode_en 1 = This automatically enables the connectable/discoverable mode after a

power up.
0 = Feature Disabled.

Table 4.3: Feature Block Configuration: Word 1

Bits Feature Description

D[15] GoConnectableButtonPress 1 = The Audio Sink application becomes connectable on a button press.
0 = The Audio Sink application does not become connectable on a button press.
Note:
This is used with multipoint operation in the situation where one AG is already
connected and the user wishes to connect a second AG and needs to make the
Audio Sink application connectable to do so.

D[14] DisableTTSTerminate 1 = Voice prompt plays to completion on answering the call or the call terminates.
0 = Voice prompt stops as soon as the call is answered or terminates.

D[13] AutoReconnectPowerOn 1 = Auto Reconnection is enabled after a power on event. ActionOnPowerOn sets
the reconnection mode.
0 = Auto reconnection is not enabled after a power on event.

D[12] speech_rec_enabled 1 = Enables speech recognition.

0 = Disables speech recognition.

D[11] SeparateLNRButtons 1 = EventLastNumberRedial always redials from AG1.

0 = EventLastNumberRedial chooses the last AG that made an outgoing call
to place the call.
Note:
EventLastNumberRedial_AG2 can be setup to always redial from AG2
regardless of this items value.

D[10] SeparateVDButtons 1 = EventInitiateVoiceDial always redials from AG1.

0 = EventInitiateVoiceDial chooses the last AG that made an outgoing call
to place the call.
Note:
EventInitiateVoiceDial_AG2 can be setup to always voice dial from AG2

Page 22 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Feature Description

regardless of this items value.

D[9:8] reserved Not used.

D[7:6] PowerDownOnDiscoTimeout Configures which action to take after pairing mode timeout triggers:
0 = Return to connectable Mode.
1 = Power Off.
2 = Power off if PDL is empty.

D[5:4] ActionOnCallTransfer Configures which AG the Audio Sink application will try to connect after a call has
been transferred from the AG to the Audio Sink application:
0 = Reconnect the last connected AG.
1 = Reconnect the first available AG from the paired device list.

ADK Audio Sink Application Configuration User Guide

2 = Initiate RSSI Inquiry (RSSI Pairing) mode.

D[3:2] LedTimeMultiplier Applies a scaling factor to the times used for all LED on and off times. It can be used
to lengthen LED on and off times beyond that of the 2.5second limit:
0 = no scaling factor.
1 = *2 scaling factor.
2 = *4 scaling factor.
3 = *8 scaling factor.

D[1:0] ActionOnPowerOn Defines the AG the Audio Sink application will try to reconnect on power on:
0 = Reconnect the last connected AG.
1 = Reconnect the first available AG from the paired device list.
2 = Initiate RSSI Inquiry (RSSI Pairing) mode.

Table 4.4: Feature Block Configuration: Word 2

Bits Feature Description

D[15:12] DiscoIfPDLLessThan This forces the Sink to Enter Discoverable mode (pairing) if the paired device list
contains fewer entries than the value of this configuration item.

D[11] DoNotDiscoDuringLinkLoss 1 = The Sink does not enter discoverable mode if a link loss event has occurred.
0 = The Sink enters discoverable mode after the link loss event..

D[10] ManInTheMiddle 1 = Bluetooth 2.1 man in the middle enabled.

0 = Feature disabled.

D[9] UseDiffConnectedEventAtPowerOn 1 = The event EventSLCConnectedAfterPowerOn is generated when

an SLC occurs straight after power on. The event EventSLCConnected is
generated on SLC events when the Sink has already been on for some time.
0 = The event EventSLCConnected is generated on all SLC events.

D[8] EncryptOnSLCEstablishment 1 = Ensures that encryption is used on SLC Establishment.

2 = Encryption not enforced.

D[7] UseLowPowerAudioCodecs 1 = The Audio Sink application uses the low power audio codec options to help
reduce Sink power consumption.
0 = The Audio Sink application uses standard audio codec options.

D[6] PlayLocalVolumeTone 1 = The Sink plays a tone when the volume is changed using the remote device.
0 = Feature disabled.

D[5] SecurePairing 1 = Enables Secure Pairing.

0 = Secure Pairing disabled.
Note:
This bit enables secure pairing mode. If set, then the Sink only accepts pin
code requests when in pairing mode (connectable/discoverable state). This
prevents a remote user from pairing with the Sink without the Sink being
specifically placed into pairing mode.
This is over-ridden if the Sink initiates the connection, i.e. if a Sink attempts to
connect to a remote AG without the correct link key (or has the bdaddr but not

Page 23 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Feature Description

the link key) then the Sink accepts a pin code request.

D[4] PowerOffOnWiredAudioConnected 1 = The Audio Sink application will power off after the wired audio is connected.
0 = The Audio Sink application will not power off after the wired audio is
connected.

D[3] QueueVolumeTones 1 = Up to four volume tones can be queued and then played in sequence.
0 = Any request to play a tone while another is playing, is ignored.

D[2] QueueEventTones 1 = Up to four event tones can be queued and then played in sequence.
0 = Any request to play a tone while another is playing, is ignored.

D[1] QueueLEDEvents 1 = Up to four LED patterns can be queued and displayed in sequence.
0 = Any request to display an LED sequence while another is active is ignored.
1 = The mute reminder tone is played at a fixed volume set by the default

ADK Audio Sink Application Configuration User Guide

D[0] MuteToneFixedVolume
volume level parameter DefaultVolume.
0 = The mute reminder tone is played at a variable volume.

Table 4.5: Feature Block Configuration: Word 3

Bits Feature Description

D[15] ResetLEDEnableStateAfterReset 1 = After a reboot the LED enable/disable state is reset and the LEDs are enabled
independently of the led_disable parameter.
0 = The LED enable/disable state is stored over a reboot. The state is stored in the
led_disable bit of the CONFIG_LED_STATES PSKEY.

D[14] ResetAfterPowerOffComplete 1 = The Audio Sink application performs a chip reset after powering off. This may be
used if the BlueCore IC is powered permanently with no other form of hardware reset
available.
0 = Feature Disabled.

D[13] AutoPowerOnAfterInitialisation 1 = The Audio Sink application automatically powers on once the chip has been
powered and initialisation is complete.
0 = Feature Disabled.

D[12] DisableRoleSwitching 1 = The Audio Sink application does not send role switch requests to the AG. This
feature may be useful if the AG does not support role switching.
0 = The Audio Sink application sends role switch requests to the AG when using
multipoint.

D[11:8] audio_plugin Specifies which audio plug in is used for SCO audio connections.
Note:
The bit values for the this item are dependent on the DSP projects that are
included in the Sink project.

D[7:4] DefaultVolume
This is the volume level used after initial power up. The default volume
can be set in the range 0 to 15. The sixteen levels can be configured in
PSKEY_SPEAKER_GAIN_MAPPING. TODO: WHERE IS THIS STORED?
THERE'S NO SPEAKER GAIN MAPPING…

D[3] IgnoreButtonPressAfterLedEnable 1 = If a button is pressed that re-enables the LED display the event assigned to the
button does not occur.
0 = If a button is pressed that re-enables the LED display the event assigned to the
button occurs as normal.

D[2] LNRCancelsVoiceDialIfActive 1 = Cancels a voice dial if a last number redial is initiated.

0 = Continues a voice dial operation if a last number redial is initiated.

D[1] GoConnectableDuringLinkLoss 1 = The Audio Sink application is connectable while attempting to reconnect a device
after link loss.
0 = The Audio Sink application is not connectable while attempting to reconnect a
device after link loss.

D[0] TwsQualificationEnable 1 = Enable the PTS qualification for TWS AVRCP TG/CT features.

Page 24 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Feature Description

0 = Disable the PTS qualification for TWS AVRCP TG/CT features.

Table 4.6: Feature Block Configuration: Word 4

Bits Feature Description

D[15] ChargerTerminationLEDOveride 1 = The charger LED indications stay at trickle charge once reached, i.e. the
indications only change when the charger is disconnected and reconnected.
0 = The charger indications toggles between fast and trickle charge
indications as appropriate to the current state of the battery charge level.

ADK Audio Sink Application Configuration User Guide

D[14:10] FixedToneVolumeLevel This sets the volume level at which tones are played if the fixed level has
been enabled. Fixed tone volume is enabled by setting
PlayTonesAtFixedVolume to 1. FixedToneVolumeLevel can be
set in the range 0 to 31.

D[9] EnableAvrcpAudioSwitching 1 = AVRCP play status is used to speed up audio source switching.
0 = AVRCP play status is not used to speed up audio source switching.

D[8] ForceEV3S1ForSco2 1 = The second SCO connection is forced to use EV3 S1 packets for better
interoperability with certain AGs.
0 = Any packet type is available for the second AG.

D[7] VoicePromptPairing 1 = PIN/Passkey/Confirmation messages are read out using preconfigured

Voice Prompts.
0 = Feature Disabled.

D[6] avrcp_enabled 1 = Enable AVRCP control. This feature is not supported on some ROM
variants.
0 = Feature Disabled.

D[5:4] PairIfPDLLessThan When set to a non-zero value and the number of devices in the PDL is less
than this value, the Sink goes into RSSI Inquiry (Proximity Pairing) mode.

D[3] EnableSyncMuteMicrophones 1 = The mute command is sent to both AGs when using multipoint.
0 = The mute command is sent to only the AG in use.

D[2:1] ActionOnPanicReset 0 = Attempt to Reconnect to the last connected AG.

1 = Reconnect the first available AG from the paired device list (not including
the paired device that has just disconnected).
2 = Initiate RSSI Inquiry (Proximity Pairing) mode.

D[0] VoicePromptNumbers 1 = Voice prompts are used to 'speak' an incoming caller number.
0 = Feature Disabled.

Table 4.7: Feature Block Configuration: Word 5

Bits Name Description

D[15:12] DefaultA2dpVolLevel This sets the initial level of the audio heard following a pairing/connection to a
new device. Thereafter, the last user selected volume level is stored in
persistent store and used for subsequent connections.

D[11] pbap_enabled 1 = Enables Phone Book Application Profile functionality.

0 = Feature Disabled.

D[10] EnableA2dpStreaming 1 = Sink can stream audio using an A2DP link.

0 = A2DP streaming is not enabled .

D[9:5] A2dpOptionalCodecsEnabled This bitmask specifies which codecs are available for use:
Note:
A corresponding DSP codec application must be available if these bits
are enabled or the Sink panics.

D[4] EnableA2dpMediaOpenOnConnection 1 = The Sink performs a media open when the A2DP signalling connection
has been made and the A2DP stream had previously been suspended. This
can happen if the Sink has suspended a stream and the phone has chosen to

Page 25 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Name Description

drop the signalling channel completely.

0 = Feature Disabled.

D[3] AssumeAutoSuspendOnCall 1 = The Sink assumes that the AG is responsible for suspending the media
connection when receiving an incoming call.
0 = The Sink suspends the media connection when receiving an incoming
call.
Note:
Allowing the Sink to manage the suspending of the media connection
can have interoperability issues.

D[2:0] ReconnectLastAttempts When using the reconnection type of LAST, this parameter controls the
number of times the Sink attempts to connect to the last connected devices, a
minimum value of 2 is suggested for this parameter. The range of

ADK Audio Sink Application Configuration User Guide

ReconnectLastAttempts is 0 to 7.

Table 4.8: Feature Block Configuration: Word 6

Bits Name Description

D[15] ShareMeSource 1 = The device supports relay of audio to another ShareMe device.
0 = The device does not support relay of audio to another ShareMe device.

D[14] ShareMeSink 1 = The device supports receiving of audio relayed from another ShareMe device.
0 = The device does not support receiving of audio relayed from another ShareMe
device.

D[13] TwsSource 1 = The device supports relay of audio to another TWS device.
0 = The device does not support relay of audio to another TWS device.

D[12] TwsSink 1= The device supports receiving of audio relayed from another TWS device.
0= The device does not support receiving of audio relayed from another TWS
device.

D[11] PeerUseLiac 1 = Limited Access Code is used when pairing Peer devices.
0 = General Access Code is used when pairing Peer devices.

D[10] PeerUseDeviceId 1 = Use the Device ID record to filter suitable devices.

0 = Do not filter on Device ID.

D[9] PeerUseCsrUuid 1 = Use a fixed CSR defined 128-bit SDP service UUID to identify Peer device
support.
0 = Use a custom defined 128-bit SDP service UUID to identify Peer device
support.

D[8:7] ShareMePairingMode 0 = Temporary pairing information is retrained for ShareMe devices.

1 = Standard pairing information is retained for ShareMe devices.

D[6] TwsSingleDeviceOperation 1 = Enable single device operation.

0 = Disable single device operation.

D[5:4] TwsMasterAudioRouting Determines which audio routing mode is selected for a Master TWS device relaying
audio in a TWS session:
0 = Stereo
1 = Left
2 = Right
3 = Down-mix

D[3:2] TwsSlaveAudioRouting Determines which audio routing mode is selected for a Slave TWS device receiving
audio in a TWS session:
0 = Stereo
1 = Left
2 = Right
3 = Down-mix

D[1:0] TwsPairingMode Determines how pairing information is retained for TWS devices:
0 = Temporary
1 = Standard
2 = Permanent

Table 4.9: Feature Block Configuration: Word 7

Page 26 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Feature Description

D[15] ShareMePeerControlsSource 1 = A connected remote ShareMe device can issue AVRCP commands to
an AG connected to the local ShareMe device.
0 = A connected remote ShareMe device cannot issue AVRCP
commands to an AG connected to the local ShareMe device.

D[14:13] PeerSource Initial source selected for new TWS connections:

0 = Auto
1 = Analogue
2 = USB
3 = A2DP

D[12] PeerLinkRecoveryWhileStreaming 1 = In case of a link loss between two Peer devices, the Master device will
page the Slave device.
0 = In case of a link loss between two Peer devices, the Master device will
not page the Slave device.

ADK Audio Sink Application Configuration User Guide

D[11:3] Reserved N/A

D[2] AmplifierShutDownByPIO 1 = I2S and DAC external audio amplifier shut down in Limbo state is
managed by "Power On" and "Audio Mute" output PIOs.
0 = PIO controlled power down mode is not enabled.
Notes:
(1) This field is intended only for sound bar project and has no effect
on other projects.
(2) When this bit is enabled, VM application makes the system wait
until a configurable timeout expires in Limbo state before driving the
configured PIOs. This allows the tones and audio prompts to finish
playing before audio amplifier has been powered off. This timeout
value is configured by the PS Key configuration item "Sound Bar
Audio Amplifier Power Down Timeout".
(3) When this bit is enabled, PS Key configuration items "Power On"
and "Audio Mute" PIOs must also be configured alongside this bit to
facilitate the power management feature for external audio
amplifiers.

D[1] GaiaEnableSession 1 = GAIA session is enabled on connection.

0 = GAIA session is not enabled on connection.

D[0] GaiaRemainConnected 1 = GAIA connection remains after power off.

0 = GAIA connection is disconnected after power off.

Table 4.10: Feature Block Configuration: Word 8

Page 27 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.2. Lengths Configuration
This configuration contains the lengths information for various configuration items. Table 4.11 lists the layout of this
configuration item.

Word Bits Description

1 D[15:0] This defines the number of entries currently in the Paired Device List.

2 D[15:0] This defines the total number of entries that exist in the lookup table that maps System/User
Event to Voice Prompt(s).

3 D[15:0] This defines the total number of languages configured for the Voice Prompts feature.

ADK Audio Sink Application Configuration User Guide

4 D[15:0] This defines the total number of LED filters configured, see section TODO

5 D[15:0] This defines the total number of LED states configured, see section TODO

6 D[15:0] This defines the total number of LED events configured, see section TODO

7 D[15:0] This defines the total number of Tones configured, see section TODO

8 D[15:0] Voice Prompts are stored in banks of languages, this tracks the number of voice prompts
configured for each language.
Note:
Each language must contain the same number of Voice Prompts and the same mappings
for System/User Event to Voice Prompt(s). See ADK Audio Prompts Application Note.

9 D[15:0] This defines the total number of User Tones configured, see section TODO

10 D[15:0] This defines the total size of the data defined in the CONFIG_AT_COMMANDS configuration
key.

11 D[15:8] Name = PS Defrag Trigger - Key Size.

This configuration item is used in conjunction with PS Defrag Trigger - Minimum Available Keys
to force a PS Defrag to occur. The PS Defrag operation is checked at Power Off or optionally
on a timer and will start automatically when the number of available PS Keys with a capacity
greater than the specified PS Defrag Trigger - Key Size is less than PS Defrag Trigger - Minimum
Available Keys.

D[7:0] Name = PS Defrag Trigger - Minimum Available Keys

Forces a PS defrag when the number of available PS Keys with a capacity greater than the
specified PS Defrag Trigger - Key Size is less than the PS Defrag Trigger - Minimum Available
Keys

12 D[15:8] Defines the total number of entries in the Input Manager lookup table.

D[7:4] Defines the total number of entries in the Bluetooth Smart Remote Controller lookup table.

D[3:0] Defines the total number of entries in the Infra-Red Remote Controller lookup table.

Table 4.11: Lengths Configuration

Page 28 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 4.3. Timers Configuration
Configures the timers used by the Audio Sink application, the list of configurable times described in Table 4.3.

Word Timer Range Description

1 AutoSwitchOffTime_s 0-600 (s) 0 = Timeout disabled

1-600 = The time in seconds after which the device
switches off if not connected.

2 LimboTimeout_s 0-60 (s) The value in seconds that the Sink waits in the limbo
state for a power on event before powering off. The
limbo state is entered when the device is powered or
receives a power off event.

ADK Audio Sink Application Configuration User Guide

3 NetworkServiceIndicatorRepeatTime_s 0-3600(s)

4 DisablePowerOffAfterPowerOnTime_s 0-60(s) The time in seconds 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 should Power Off the Audio Sink
application.

5 PairModeTimeout_s 0-65535(s) The time in seconds that the Sink remains in the
connectable / discoverable state (pairing mode).
Note:
Setting this to 0 results in the Audio Sink
application entering and immediately exiting the
discoverable state.

6 MuteRemindTime_s 0-60(s) The time in seconds to periodically play the mute

reminder tone whilst audio is muted.

7 ConnectableTimeout_s 0-65535(s) Specifies the amount of time in seconds the Sink

remains connectable following a successful
connection when using MultiPoint operational modes
before not being connectable any more.

8 PairModeTimeoutIfPDL_s 0-65535(s) If the Paired Device List contains no entries, this

pairing mode timeout is used instead of
PairModeTimeout_s.
0 = disabled
1-65535 = The timer value

9 ReconnectionAttempts 0-65535(s) number of times to try and reconnect a device before

giving up

10 EncryptionRefreshTimeout_m 0-65535(m) This timer value, in minutes, causes the link

encryption key to change when the timer expires.
Note:
The timer is not refreshed if a SCO connection is
active when the timer fires and the timer.

11 InquiryTimeout_s 0-65535(s) Specifies the maximum inquiry time for device

searching, in units of 1.28 seconds.

12 SecondAGConnectDelayTime_s 0-65535(s) This value determines the delay time, in ms, between
the connection of AG1 and the start of connection to
AG2 when using MultiPoint operation.

13 MissedCallIndicateTime_s 0-65535(s) The period in second between two indications

Page 29 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Word Timer Range Description

14 MissedCallIndicateAttemps 0-65535(s) number of times to indicate before stopping indication

15 A2dpLinkLossReconnectionTime_s 0-65535(s) the amount of time in seconds to attempt to reconnect

a2dp

16 LanguageConfirmTime_s 0-65535(s) The time between

EventUsrSelectAudioPromptLanguageMode and
storing the language in PS

17 SpeechRecRepeatTime_ms 0-65535(s) the between voice prompts ASR restarts

18 StoreCurrentSinkVolumeAndSourceTimeout_s 0-65535(s) The time in seconds elapsed after the last

ADK Audio Sink Application Configuration User Guide

VolumeUp/Down or Source button was pressed, to
store the volume information into PS Store

19 WiredAudioConnectedPowerOffTimeout_s 0-65535(s) The time in seconds elapsed before the device is

powered off after the wired audio is connected

20 StoreCurrentPEQSettingsTimeout_s The time in seconds elapsed after the last GAIA

command has been received to store EQ settings into
PS Store

21 DefragCheckTimer_s 0-65535(s) When no audio is routed the Audio Sink application

will periodically check if a PS Defrag is required:
0 = Disabled
1-65535 = The period timer value

22 AudioAmpPowerDownTimeoutInLimbo_s 0-65535(s) The period in seconds for which the system waits
before powering down audio amplifier for sound bar
when in Limbo state

23 ImmediateAlertTimer_s 0-65535(s) The period in seconds for which the system waits
before palying alert tone again

24 ImmediateAlertStopTimeout_s 0-65535(s) The period in seconds for which the system waits
before stoppingthe alert

25 LinkLossTimer_s 0-65535(s) The period in seconds for which the system waits
before palying alert tone again

26 LinkLossAlertStopTimeout_s 0-65535(s) The period in seconds for which the system waits
before stoppingthe alert

Table 4.12: Timers Configuration

Page 30 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.4. Device ID and Software Version Configuration
This contains the Device ID information along with the software version number. On entry into service mode, the
Audio Sink application becomes discoverable and changes its local name to the Bluetooth address + the contents of
this configuration. Table 4.13 describes the data structure for this configuration item.

Word(s) Name Description

1 Vendor ID Source 0x0001 = Vendor ID has been assigned by the Bluetooth Special Interest Group.
0x0002 = Vendor ID has been assigned by the USB Implementers Forum.

2 Vendor ID Should be set as assigned by the Vendor ID source.

3 Product ID Should be set as appropriate for the product.

ADK Audio Sink Application Configuration User Guide

4 BCD Version Should be set as appropriate for the product version where:
0xABCD = version AB.C.D

5-8 Software Version Should be set to the appropriate software version for the product.

Table 4.13: Device ID and Software Version Configuration

Page 31 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.5. Battery Configuration
The battery monitoring and battery charging parameters are stored in this configuration item. The data structure of
this configuration item is described in Table 4.14.

Word(s) Name Description

1-2 Vref Configuration See Table 4.15.

3-10 Vbat Configuration See Table 4.16

11-19 Vthm Configuration See Table 4.17

20-22 Vchg Configuration See Table 4.18

ADK Audio Sink Application Configuration User Guide

Table 4.14: Battery Configuration

Word(s) Name Description

1-2 Vref ADC See Table 4.19

Table 4.15: Vref Configuration

Word(s) Name Description

1-2 Battery Voltage ADC See Table 4.19

3 Battery Limit Setting [0] See Table 4.20

4 Battery Limit Setting [1] See Table 4.20

5 Battery Limit Setting [2] See Table 4.20

6 Battery Limit Setting [3] See Table 4.20

7 Battery Limit Setting [4] See Table 4.20

8 Battery Limit Setting [5] See Table 4.20

Table 4.16: Vbat Configuration

Bit(s) Name Description

D[143:128] Thermistor ADC See Table 4.19

D[127:124] Delay Delay(ms) between setting PIO and reading

ADC

D[123:119] Reserved N/A

D[118] Raw limits Set limits in ADC counts rather than voltage

D[117] Drive PIO Drive thermistor from a PIO

D[112:116] PIO PIO to use (0-31)

Page 32 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 Bit(s) Name Description

D[111:96] Battery Limit Setting [0] See Table 4.20

D[95:80] Battery Limit Setting [1] See Table 4.20

D[79:64] Battery Limit Setting [2] See Table 4.20

D[63:48] Battery Limit Setting [3] See Table 4.20

D[47:32] Battery Limit Setting [4] See Table 4.20

D[31:16] Battery Limit Setting [5] See Table 4.20

ADK Audio Sink Application Configuration User Guide

D[15:0] Battery Limit Setting [6] See Table 4.20

Table 4.17: Vthm Configuration

Word(s) Name Description

1-2 Vchg ADC See Table 4.19

3 Limit Vchg Threshold (mV/POWER_VSCALE)

Table 4.18: Vchg Configuration

Bits Name Description

D[127:120] ADC Source The ADC Source:

0 = AIO0
1 = AIO1
2 = AIO2
3 = AIO3
4 = VREF
5 = VBAT
6 = VDD_SENSE
7 = VREG_ENABLE

D[119:111] Read period when charging Interval (in seconds) between

measurements when charging

D[111:96] Read period when not Interval (in seconds) between

charging measurements when not charging

Table 4.19: ADC Configuration

Bits Name Description

D[15:8] Notify Period Interval

(seconds/POWER_PERIOD_SCALE)
between notifications (0 to disable)

D[7:0] Limit Battery Voltage Threshold

(mV/POWER_SCALE)

Table 4.20: Battery Limit Configuration

Page 33 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.6. Radio Configuration
Determines the radio inquiry and page scan characteristics, Table 4.21 describes the data layout of this configuration
item.
Note:
The Audio Sink Configuration tool 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.

Word Description

1 Page scan interval

ADK Audio Sink Application Configuration User Guide

2 Page scan window

3 Inquiry scan interval

4 Inquiry scan window

Table 4.21: Radio Configuration

Page 34 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.7. Volume Control Configuration
This configuration item stores the values that configure the volume control behaviour for the Audio Sink application.
Table 4.22 describes the data structure for this configuration item.

Word(s) Name Description

1 no_of_steps number of steps of volume change

permitted

2 volume_knee_value_1 volume point at which curve of dB

conversion changes

3 volume_knee_value_2 volume point at which curve of dB

ADK Audio Sink Application Configuration User Guide

conversion changes

4 dB_knee_value_1 dB value for point at which curve of dB

conversion changes

5 dB_knee_value_2 dB value for point at which curve of dB

conversion changes

6 dB_max dB value at maximum volume level

7 dB_min dB value at minimum volume level

8 Volume map [0] See Table 4.23

9 Volume map [1] See Table 4.23

10 Volume map [2] See Table 4.23

11 Volume map [3] See Table 4.23

12 Volume map [4] See Table 4.23

13 Volume map [5] See Table 4.23

14 Volume map [6] See Table 4.23

15 Volume map [7] See Table 4.23

16 Volume map [8] See Table 4.23

17 Volume map [9] See Table 4.23

18 Volume map [10] See Table 4.23

19 Volume map [11] See Table 4.23

20 Volume map [12] See Table 4.23

21 Volume map [13] See Table 4.23

22 Volume map [14] See Table 4.23

23 Volume map [15] See Table 4.23

Table 4.22: Volume Control Configuration

Page 35 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 Bit(s) Name Description

D[31:28] IncVol The hfp volume level to go to when volume up is pressed

D[27:24] DecVol The hfp volume level to go to when volume down is

pressed

D[23:16] Tone The tone associated with a given volume level

D[15:8] A2dpGain The a2dp gain index to use for the given volume level

D[7:0] VolGain The hfp DAC gain to use for the given volume level

ADK Audio Sink Application Configuration User Guide

Table 4.23: Volume Mapping Configuration

Page 36 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.8. HFP Init Configuration
Contains configuration parameters that are passed into the HFP library in order for a HFP instance to be created and
initialised. Table 4.24 describes the data structure of this configuration item.

Bits Name Description

D[0:15] Supported profile The supported Profile, this indicates which profile(s) the HFP library
should support. This can be headset profile, one of the handsfree
profiles or both the headset profile and one of the handsfree profiles.

D[16:31] Supported features See supported flags

D[32:47] Supported WBS codecs User configurable information regarding the HF's codecs

ADK Audio Sink Application Configuration User Guide

D[48:49] Service Optional indicators the HF may not want to receive: service

D[50:51] Signal Strength Optional indicators the HF may not want to receive: signal strength

D[52:53] Roaming Status Optional indicators the HF may not want to receive: roaming status

D[54:55] Battery Charge Optional indicators the HF may not want to receive: battery charge

D[56:63] Reserved N/A

D[64:76] Reserved N/A

D[77] Disable NREC Disable Noise Reduction/Echo Cancellation on connection

D[78] Extended Errors Enable sending of extended error codes by AG's supporting them

D[79] MultiPoint Whether multiple connections to one profile are supported

D[80:87] Link Loss Time The time in minutes to attempt to reconnect for on link loss

D[88:95] Link Loss Interval The time in seconds between link loss reconnect attempts

D[96] Caller Name CSR2CSR feature

D[97] Raw Text CSR2CSR feature

D[98] SMS CSR2CSR feature

D[99] Battery Level CSR2CSR feature

D[100] Power Source CSR2CSR feature

D[101:103] Codecs CSR2CSR feature

D[104:105] Codec Bandwidth CSR2CSR feature

D[106:111] Reserved N/A

Table 4.24: HFP Initialisation Configuration

Page 37 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.9. HFP 1.5 Feature Configuration
This configuration item must be defined for the Audio Sink application to support version 1.5 of the Handsfree Profile.
Table 4.25 describes the data structure of this configuration item.

Bit(s) Name Description

D[0] Additional Audio Params Enable use of audio params

D[1:5] Reserved N/A

D[6:15] Packet Types Supported packet types

D[16:47] bandwidth SCO Bandwidth

ADK Audio Sink Application Configuration User Guide

D[48:63] max_latency SCO Max Latency

D[64:79] voice_settings SCO Voice Settings

D[D80:96] retx_effort SCO Retransmission Effort

Table 4.25: HFP1.5 Configuration

Page 38 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.10. RSSI Inquiry Configuration
This configuration item holds the parameters for RSSI Inquiry, otherwise known as Proximity Pairing. Table 4.26
describes the data structure of this configuration item.

Bit(s) Name Description

D[0:15] tx_power The inquiry Tx power

D[16:31] threshold The minimum RSSI reading for an AG to be paired

D[32:47] diff_threshold The required difference between AG and next closest AG

ADK Audio Sink Application Configuration User Guide

D[48:79] cod_filter COD to consider

D[80:95] conn_threshold The minimum RSSI reading for an AG to be connected

D[96:111] conn_diff_threshold The required difference between AG and next closest AG

D[112:119] max_responses Maximum number of inquiry responses

D[120:127] timeout Maximum inquiry time (timeout * 1.28s)

D[128:135] resume_timeout Time to wait between inquiry attempts

D[136:139] num_results Number of results we can store

D[140] connect_if_in_pdl Don't connect to an AG if not already in the PDL

D[141] dont_pair_if_in_pdl Don't pair with an AG if already in the PDL

D[142] try_all_discovered Attempt to pair/connect to all discovered AGs

D[143] pair_on_pdl_reset Start RSSI pairing on PDL reset event

Table 4.26: RSSI Pairing Configuration

Page 39 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.11. PIO Configuration
Holds data that configures PIO's used by the Audio Sink application, Table 4.27 describes the data structure of this
configuration item.

Bit(s) Name Description

D[0:7] spdif_detect PIO for SPDIF detect

D[8:15] analog_input PIO for Analogue Input

D[16:23] charger_input PIO for Charger Input

ADK Audio Sink Application Configuration User Guide

D[24:31] dut_pio PIO for DUT

D[32:39] spdif_input PIO for SPDIF input

D[40:47] aux_out_detect PIO for Aux Out Detect

D[48:55] CallActivePIO PIO for Active Call

D[56:63] IncomingRingPIO PIO for Incoming Ring

D[64:71] OutgoingRingPIO PIO for Outgoing Ring

D[72:79] DeviceAudioActivePIO PIO for Active Audio

D[80:87] PowerOnPIO PIO for Power On

D[88:95] spdif_output PIO for SPDIF output

D[96:103] LedEnablePIO PIO for LED Enable

D[104:111] AudioMutePIO PIO for Audio mute

D[112:143] pio_invert Bit mask used to invert button PIOs,

1 = inverted

D[144:159] mic_a Mic A settings, see TODO

D[160:175] mic_b Mic B settings, see TODO

D[176:191] line_a Line A settings, see TODO

D[192:207] line_b Line B settings, see TODO

D[208:223] pio_map Pins to map (see PioSetMapPins32

in pio.h)

Table 4.27: PIO Configuration

Page 40 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.12. Button Configuration
Holds data that configures button press definitions, Table 4.28 describes the data structure of this configuration item.

Bits Name Description

D[0:15] Double press The time interval (ms), in which a second press may be detected leading to
a double press event instead of reporting the button press as a single press.

D[16:31] Long press The time a button has to be pressed for, in ms, in order to generate a long
message timer.

D[32:47] Very long press The time a button has to be pressed for, in ms, in order to generate a very
long timer message.

ADK Audio Sink Application Configuration User Guide

D[48:63] Repeat The time, in ms, between repeat messages being generated if a button is
held down.

D[64:79] Very very long press The time a button has to be pressed for, in ms, in order to generate a very
very long timer message.

D[80:87] Debounce number The number of debounce checks performed.

D[88:95] Debounce period The interval between each debounce check in ms.

Table 4.28: Button Configuration

Page 41 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.13. Button Translation
Contains the button translation table, which maps logical inputs onto physical inputs such as PIOs or Capacitive
touch sensors. Table 4.29 describes the data structure of this configuration item.

Word

1 Button translation, see Table 4.30

2 Button translation, see Table 4.30

… Button translation, see Table 4.30

18 Button translation, see Table 4.30

ADK Audio Sink Application Configuration User Guide

Table 4.29: Button Translation Configuration
Note:
By default, the Audio Sink application supports 18 button translations. This can be updated by modifying the
source code.

Bits Name Description

D[0:7] Button Number Button number to assign, 0 to 15.

D[8:9] Input Source Input source, PIO or CAP sense.

D[10:15] Input Number Input number, 0 to 31.

Table 4.30: Button Translation Type

Page 42 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.14. Button Pattern Configuration
This configures the button patterns, otherwise known as button sequences used by the Audio Sink application to
generate an internal event. Table 4.31 lists the data structure of this configuration item.
Notes:
(1) There is no limit to the time between button presses and no distinction is made between short or long button
presses.
(2) By default, up to 4 button patterns can be configured, this can be modified by changing the source code.

Word(s) Description

ADK Audio Sink Application Configuration User Guide

1-7 Button pattern 1, see Table 4.32

8-14 Button pattern 2, see Table 4.32

15-21 Button pattern 3, see Table 4.32

22-28 Button pattern 4, see Table 4.32

Table 4.31: Button Pattern Configuration

Word Name Description

1 Event This is the event that is generated after a

successful pattern sequence match.

2 pattern[0] This is a sequence of six 32-bit patterns

representing the PIOs that are to be matched. If
3 pattern[1] a pattern sequence less than six buttons is
required the last PIO Keys can be set to 0.
4 pattern[2]

5 pattern[3]

6 pattern[4]

7 pattern[5]

Table 4.32: Button Pattern Type

Page 43 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.15. LED Filters Configuration
This configures the LED Filters used by the Audio Sink application to display LED patterns indicating a particular
event. Table 4.33 lists the data structure of this configuration item.
Note:
The number of LED filters that have been configured must be added to the lengths configuration, see Section
4.2.

Words Description

1-3 Each entry is of the LED Filters Data Type, as defined in

Table 4.34.
n…n

ADK Audio Sink Application Configuration User Guide

Table 4.33: LED Filters Configuration

Bits Name Description

D[0:15] Event The event to trigger the filter upon.

D[16:18] Filter Type The type of filter:

0 = Disabled
1 = Cancel
2 = Speed
3 = Override
4 = Colour
5 = Follow

D[19:21] Colour Force LED to this colour pattern no matter what is defined in the state
pattern

D[22:26] Filter To Cancel If a filter is already being displayed, this will cause that filter to be cancelled
when this one starts.

D[27:30] Override LED The LED to use to display the pattern.

D[31] Override Disable Override LED disable flag when filter active

D[32:34] Reserved N/A

D[35:38] Follower LED Delay The delay before the following pattern starts (in 50ms steps, range 0-
750ms).

D[39] Speed Multiplier Action Which action to perform on the speed multiplier
0 = multiply
1= divide.

D[40:47] Speed Multiplier The speed multiplier to apply.

0 = No speed multiplier.

Table 4.34: LED Filters Type

Page 44 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.16. LED States Configuration
This configures the LED States used by the Audio Sink application to display LED patterns indicating a particular
state. Table 4.35 lists the data structure of this configuration item.
Note:
The number of LED states that have been configured must be added to the lengths configuration, see Section
4.2.

Words Description

1-5 Each entry is of the LED Patterns Data Type, as defined

in 5.Appendix A.
n...n

ADK Audio Sink Application Configuration User Guide

Table 4.35: LED States Configuration

4.17. Tri Colour LED Configuration

This configuration item stores the Tri Colour LED information, the data structure of this configuration item is
described in Table 4.36.

Bits Name Description

D[0:3] Tri Colour A

D[4:7] Tri Colour B

D[8:11] Tri Colour C

D[12:15] Reserved N/A

Table 4.36: Tri Colour LED Configuration

4.18. LED Events Configuration

This configures the LED Events used by the Audio Sink application to display LED patterns indicating a particular
state. Table 4.37 lists the data structure of this configuration item.
Note:
The number of LED states that have been configured must be added to the lengths configuration, see Section
4.2.

Words Description

1-5 Each entry is of the LED Patterns Data Type, as defined

in 5.Appendix A.
n...n

Table 4.37: LED States Configuration

Page 45 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.19. Events Configuration
The events configuration for the Audio Sink application is split over three configuration items, Table 4.38 lists these
items. The events have been split over three configuration items because the data is too large to fit in a single key.

Configuration Item Description

CONFIG_EVENTS_A Event block 1

CONFIG_EVENTS_B Event block 2

CONFIG_EVENTS_C Event block 3

ADK Audio Sink Application Configuration User Guide

Table 4.38: Event Blocks

Each event block contains a translation table to convert button presses to User Events. The table in each event
block is a fixed length and contains 22 entries. The data structure used for each entry of the translation table is
described in Table 4.39.

Bits Name Description

D[0:7] User Event The User event that will be generated if all the requirement conditions of this
event translation are met, see 4.19.1.

D[8:15] Button Timing Event Defines the Button Timing Event that has to be generated for the User Event to
be generated, see 4.19.2.

D[16:31] Button Mask Defines the button(s) that generated the Button Timing event, see 4.19.3.

D[32:47] State Mask Defines the state(s) that must be active when the Button Timing Event was
generated, see 4.19.4.

Table 4.39: Data Structure Used by Event Translation Tables

Page 46 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.19.1. User Event
The user event is an offset (0-255) from EVENTS_USR_MESSAGE_BASE to the User Event enumeration.

4.19.2. Button Timing Event

The Button Timing Event outlines which type of button press must be used to generate the associated User Event.
Table 4.40 describes the values for each of the available Button Timing Events.

Value Name Description

0 B_INVALID Unassigned

1 B_SHORT Timer that fires whilst button(s) have been pressed down for a

ADK Audio Sink Application Configuration User Guide

short period (timer)

2 B_LONG Timer that fires whilst button(s) have been pressed down for a
long period (timer)

3 B_VERY_LONG Timer that fires whilst button(s) have been pressed down for a
very long period (timer)

4 B_DOUBLE Button(s) have been double pressed (two very short presses,
one after the other)

5 B_REPEAT Timer that repeats whilst the button(s) are held down

6 B_LOW_TO_HIGH Rising edge of a button(s) press

7 B_HIGH_TO_LOW Falling edge of a button(s) press

8 B_SHORT_SINGLE Button(s) have been pressed for a short period and then
released

9 B_LONG_RELEASE Button(s) have been pressed for a long period and then
released

10 B_VERY_LONG_RELEASE Button(s) have been pressed for a very long period and then
released

11 B_VERY_VERY_LONG Timer that fires whilst button(s) have been pressed down for a
very very long period (timer)

12 B_VERY_VERY_LONG_RELEASE Button(s) have been pressed for a very very long period and
then released

13 B_TRIPLE Button(s) have been triple pressed (three very short presses,
one after the other)

Table 4.40: Button Timing Events

4.19.3. Button Mask

The button mask outlines which button(s) must be held down to generate the associated User Event. This is a 16 bit
value where button (ID 0) relates to Bit [0] and button (ID 15) relates to Bit [15].

4.19.4. State Mask

The State Mask outlines which application state(s) must be active for the user event to be generated. 5.Appendix B
lists the bit positions of the mask for each state.

Page 47 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.20. Tones Configuration
The tones configuration for the Audio Sink application is used to map audible tones against Audio Sink application
User Events. This causes the configured tone to be played when the mapped User Event is generated. The data
structure of this configuration item is described in Table 4.41.
Note:
The number of tones that have been configured must be added to the Lengths configuration item, see Section
4.2.

Words Description

1-2 User Event to tone translation, see Table 4.42

ADK Audio Sink Application Configuration User Guide

n…n User Event to tone translation, see Table 4.42

Table 4.41: Tones Configuration Data Structure

Bits Name Description

D[0:15] Event The mapped User Event

D[16:23] Reserved N/A

D[24:31] Tone The audio tone to play when User

Event is generated

Table 4.42: Tones Configuration Type

Page 48 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.21. User Tones Configuration
This configuration item is used to store the User Tones which allows custom tones to be configured. The number of
custom tones that can be configured is limited to 8. The data format of this configuration key is outlined in Table
4.43.

Word(s) Description

1 Offset to the custom tone data (starting at word 9) for tone [0]

2 Offset to the custom tone data (starting at word n2) for tone [1]

3 Offset to the custom tone data (starting at word n4) for tone [2]

ADK Audio Sink Application Configuration User Guide

4 Offset to the custom tone data (starting at word n6) for tone [3]

5 Offset to the custom tone data (starting at word n8) for tone [4]

6 Offset to the custom tone data (starting at word n10) for tone [5]

7 Offset to the custom tone data (starting at word n12) for tone [6]

8 Offset to the custom tone data (starting at word n14) for tone [7]

9..n1 Tone data for custom tone [0]

n2..n3 Tone data for custom tone [1]

n4..n5 Tone data for custom tone [2]

n6..n7 Tone data for custom tone [3]

n8..n9 Tone data for custom tone [4]

n10..n11 Tone data for custom tone [5]

n12..n13 Tone data for custom tone [6]

Table 4.43: User Tones Configuration

Notes:
(1) If no user tones are required, this configuration item should not contain any data.
(2) If less than 8 User Tones have been configured, the offsets must be zero.
(3) The number of tones that have been configured must be added to the Lengths configuration item, see
Section 4.2.

Page 49 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.22. Audio Prompts Configuration
This configuration item is used to store the Audio Prompts Configuration allows custom audio prompts to be
configured. The number of audio prompts that can be configured is not limited, other than by PSKEY size. The
configuration item contains an array of data structures one after the other. The data format of this configuration key
is outlined in Table 4.44.

Words Description

1-3 Voice Prompt configuration, see Table 4.45

n…n Voice Prompt configuration, see Table 4.45

Table 4.44: Audio Prompts Configuration

ADK Audio Sink Application Configuration User Guide

Note:
The number of audio prompts that have been configured must be added to the Lengths configuration item, see
Section 4.2.

Bits Name Description

D[0:15] Event The mapped User Event

D[16:23] Reserved N/A

D[24:31] Prompt ID The audio prompt that needs to be played when the mapped user event is
generated.

D[32] Play Immediate 1 = Don't queue the audio prompt if the audio system is busy, ensure it plays
immediately.
0 = Queue the audio prompt if the audio system is busy, it will play as soon as
the audio system is ready.

D[33] SCO Block 1 = Do not play the audio prompt if the there is an active SCO connection.
0 = Always play the audio prompt

D[34:47] State Mask The State Mask outlines which application state(s) must be active for the audio
prompt to be played. 5.Appendix B lists the bit positions of the mask for each
state.

Table 4.45: Table Title

Page 50 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.23. Sniff Sub-Rate Configuration
This configuration item is used to store the Sniff Sub-Rate (SSR) configuration parameters. These are used to setup
preferred sub-rating parameters to be used when the device enters sniff mode for SLC and SCO connections. The
data format of this configuration key is outlined in Table 4.46.

Word Name Description

1 SLC remote latency The maximum time the remote device need not be present when sub-rating.
(for SLC connections)

2 SLC remote timeout The minimum time the remote device should stay in sniff before entering
sub-rating mode. (for SLC connections)

ADK Audio Sink Application Configuration User Guide

3 SLC local timeout The minimum time the local device should stay in sniff before entering sub-
rating mode. (for SLC connections)

4 SCO remote latency The maximum time the remote device need not be present when sub-rating.
(for SCO connections)

5 SCO remote timeout The minimum time the remote device should stay in sniff before entering
sub-rating mode. (for SCO connections)

6 SCO local timeout The minimum time the local device should stay in sniff before entering sub-
rating mode. (for SCO connections)

Note:
All values are in units of 0.625ms.

Table 4.46: Sniff Sub-Rate Configuration

Page 51 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.24. USB Configuration
This configuration item is used to store the USB configuration parameters. The data format of this configuration key
is outlined in Table 4.47.

Bits Name Description

D[0:15] i_disc Current when USB disconnected but charger connected, see Table
4.48

D[16:31] i_susp Current when suspended, see Table 4.48

D[32:47] i_susp_db Current when suspended prior to enumeration with dead battery,
see Table 4.48

ADK Audio Sink Application Configuration User Guide

D[48:63] i_att Current when attached but not enumerated, see Table 4.48

D[64:79] i_att_trickle Current when attached but not enumerated and trickle charging, see
Table 4.48

D[80:95] i_conn Current when connected to host/hub, see Table 4.48

D[96:111] i_conn_trickle Current when connected to host/hub and trickle charging, see Table
4.48

D[112:127] i_chg Current when connected to a charging host/hub, see Table 4.48

D[128:143] i_dchg Current when connected to a dedicated charger, see Table 4.48

D[144:159] i_lim Current when vbus drop is detected, see Table 4.48

D[160] audio_always_on Route USB audio even if not in use

D[161] pause_when_switching_source Pause USB audio when switching away from USB source

D[162:163] plugin_type Mono/Stereo

D[164:167] plugin_index USB plugin to use

D[168:171] attach_timeout Time (seconds) after attach at which we set low power bootmode if
not enumerated

D[172:175] deconfigured_timeout Time (seconds) after deconfigure at which we set low power
bootmode if not enumerated

D[176:191] device_class Class of device bitmask:

0000 0001 = Enable USB audio microphone device class
0000 0010 = Enable USB audio speaker device class
0000 0100 = Enable USB battery charging device class
0000 1000 = Enable USB mass storage device class
0001 0000 = Enable USB Consumer transport control device class
0010 0000 = Enable USB HID keyboard device class

Table 4.47: USB Configuration

Page 52 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Name Description

D[0] charge Enable/Disable Charger, 1=enable, 0=disable

D[1:2] boost Charge boost, 0=disabled, 1=internal, 2=external

D[3] vsel Voltage Select 0=charger, 1=battery

D[4] power_off Power off, 0=disabled, 1=enabled

D[5] disable_leds Disable LEDs, 0=disabled, 1=enabled

D[6:7] reserved N/A

ADK Audio Sink Application Configuration User Guide

D[8:15] current Current, measured in (mA)

Table 4.48: USB Charger Configuration

Page 53 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.25. FM Configuration
This configuration item is used to store the USB configuration parameters. The data format of this configuration key
is outlined in Table 4.49.

Word Description

1 Seek band bottom (88.1Mhz)

2 Seek band top (107.9Mhz)

3 Frequency spacing

4 Seek tune RSSI

ADK Audio Sink Application Configuration User Guide

5 Seek tune SNR

6 RSQ RSSI low

7 RSQ RSSI high

8 RSQ SNR low

9 RSQ SNR hight

10 Antenna Selection

11 Hardware PIO

Table 4.49: FM Configuration

Page 54 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.26. AT Commands Configuration
This configuration item is used to store the custom AT commands configuration. The data format of this configuration
key is covered in the Audio Sink Application Custom AT Commands User Guide documentation.

4.27. I2S Configuration

This configuration item is used to store the I2S configuration data. The data format of this configuration key is
described in the ADK I2S User Guide.

ADK Audio Sink Application Configuration User Guide

4.28. I2S Initialisation Configuration
This configuration item is used to store the I2S initialisation data. The data format of this configuration key is
described in the ADK I2S User Guide.

Page 55 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.29. Audio Routing Configuration
This configuration item is used to store the Audio Routing configuration. The data format of this configuration key is
outlined in Table 4.50.

Word(s) Description

1 Audio Plugin Features including input and output hardware selection, see Table
4.51.

2-3 Reserved, do not use.

4-5 Silence detection settings, see Table 4.52.

ADK Audio Sink Application Configuration User Guide

6 Target latency, see Table 4.53.

Table 4.50: Audio Routing Configuration

Bits Name Description

D[0:1] Reserved N/A

D[2:3] Audio input routing The input audio routing:

0 = Internal routing
1 = I2S routing
2 = SPDIF routing
3 = Internal and relay routing

D[4:7] SPDIF supported data types SPDIF input type:

0 = PCM
1 = Reserved (Do not use)
2 = AAC
3 = MP3

D[8] Stereo 0 = mono input

1 = stereo input

D[9:10] DUT Microphone The input mic for DUT mode:

0 = DUT Mic A
1 = DUT Mic B
2 = DUT Mic C
3 = DUT Mic D

D[11] Force tone resampling 0 = No resampling of tones

1 = Tones are resampled

D[12:13] Reserved N/A

D[14] Use one mic back channel 0 = Disabled

1 = One mic back channel enabled

D[15] Use two mic back channel 0 = Disabled

1 = Two mic back channel enabled

Table 4.51: Audio Plugin features

Page 56 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 Word Name Description

1 Threshold Threshold (16 bit fractional value - aligned to MSB in DSP)

2 Trigger time Trigger time in seconds (16 bit int)

Table 4.52: Silence Detection Configuration

Bits Name Description

D[0:7] Reserved N/A

ADK Audio Sink Application Configuration User Guide

D[8:15] Target latency The target latency

Table 4.53: SPDIF Latency Configuration

Page 57 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.30. Input Manager Configuration
This configuration item is used to store the Audio Routing configuration. The data format of this configuration key is
outlined in Table 4.55.

Word Name Description

1 Multiple Detect Timer As soon as an input is pressed down, this timer is armed, it allows a second or
third or fourth, etc. button to be pressed so a multiple button press is captured.
As soon as the multiple detect timer has fired, no further button presses are
actioned until the inputs have been released.

2 Short Timer The short timer fires if the input(s) are still held down for the configured short
timer duration.

ADK Audio Sink Application Configuration User Guide

3 Long Timer The long timer fires if the input(s) are still held down for the configured "long
timer" duration

4 V.Long Timer The very long timer fires if the input(s) are still held down for the configured very
long timer duration

5 VV.Long Timer The very very long timer fires if the input(s) are still held down for the configured
"very very long timer" duration.

6 Repeat Timer The repeat timer fires every configured "repeat timer" duration while the input(s)
are held down.

7…n Lookup Table The Input Manager lookup table, this is an array of lookup table data structures,
See Table 4.55.
Note:
The number of entries in the Input Managers lookup table must be added
to the Lengths configuration item, see Section 4.2.

Note:
Timer configuration items listed in this key are in units of seconds.

Table 4.54: Input Manager Configuration

Bits Name Description

D[0:15] Input Mask The Input Mask value is a mask that outlines which input(s) must be held down for the
user event to be generated. This is a 16 bit value where input ID 0 relates to Bit[0] (of
the mask) and input ID 15 relates to Bit[15] (of the mask).

D[16:31] State Mask The State Mask outlines which application state(s) must be active for the user event to
be generated. 5.Appendix B lists the bit positions of the mask for each state.

D[32:39] User Event The user event is an offset (0-255) from EVENTS_USR_MESSAGE_BASE to the User
Event enumeration.

D[40:47] Input Event The input event outlines which type of input event must be triggered to generate the
associated user event. Table 4.56 describes the available input events.

Table 4.55: Input Manager Lookup Table Configuration

Page 58 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
 Value Input Event

0 Input down

1 Input very short release

2 Short timer (while input held down)

3 Input short release

4 Long timer (while input held down)

5 Input long release

ADK Audio Sink Application Configuration User Guide

6 Very long timer (while input held down)

7 Input very long release

8 Very very long timer (while input held down)

9 Input very very long release

10 Input repeat timer (while input held down)

Table 4.56: Input Manager Events

Page 59 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.31. Bluetooth Smart Remote Control Configuration
This configuration item is used to store the Bluetooth Smart remote control configuration. The data format of this
configuration key is outlined in Table 4.57.

Word Name Description

1 Max Remotes Configures the maximum number of remote controllers that can be supported.

2..n Lookup Table Stores the lookup table for the Bluetooth Smart remote controller, this is a variable
length array of mapping entries, see Table 4.58.
Note:
The number of entries in the lookup table must be added to the Lengths
configuration item, see Section 4.2.

ADK Audio Sink Application Configuration User Guide

Table 4.57: Bluetooth Smart Remote Control Configuration

Bits Name Description

D[0:3] Input ID The input ID the HID code translates to (allows up to 16 RC buttons to be supported)

D[4:15] HID Code The HID Code sent by the remote control, Consumer HID has some values that are
12-bit length (0x0 <> 0xFFF)

Table 4.58: Bluetooth Smart Remote Control HID Code Mapping

Page 60 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.32. Infra-Red Remote Control Configuration
This configuration item is used to store the Infra-Red control configuration. The data format of this configuration key
is outlined in Table 4.59

Word Name Description

1 Protocol Defines which IR protocol the application supports (can only support one protocol;
either NEC or RC5)

2 Max Learnt Codes The maximum number of IR codes the application can learn

3 Learning Mode Failsafe for turning off the IR learning mode (ms)
Timeout

ADK Audio Sink Application Configuration User Guide

4 Learning Mode A reminder tone can be generated to indicate learning mode is active, this will be
Reminder repeated every timeout (ms)

5 Infra-Red PIO The PIO interfacing the InfraRed hardware

6..n Lookup Table Stores the lookup table for the Infra-Red remote controller, this is a variable length
array of mapping entries, see Table 4.60.
Note:
The number of entries in the lookup table must be added to the Lengths
configuration item, see Section 4.2.

Table 4.59: Infra-Red Control Configuration

Bits Name Description

D[0:3] Infra-Red The infrared code sent by the remote controller that converts to *input_id* for the input
Code manager to process

D[4:7] Reserved N/A

D[8:15] Input ID The input ID the IR code translates to (allows up to 16 RC buttons to be supported)

D[16:31] Address The address of the remote control that sent the IR code (an Infrared remote may use
different addresses for different buttons, so need to ensure the code was actually sent
from the known RC)

Table 4.60: Infra-Red Control Code Mapping

Page 61 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.33. Power Management Unit Charger Configuration
This configuration item is used to setup the Power Management Unit (PMU) charger. The data format of this
configuration key is outlined in Table 4.61.
Note:
The PS Key may be configured to allow the charger current to be ramped down in steps as the temperature of
the device increases when the boost pass transistor is used with high charger input voltages, this allows the
device to continue charging but at a lesser rate as the temperature increases

Bits Name Description

D[0:7] Min charge Minimum charger current

ADK Audio Sink Application Configuration User Guide

D[8:15] Max charge Maximum charger current

D[16:23] Charger step Charger current step-size

D[24:31] Reserved Not used (set to 0)

D[32:39] Temp increase Temeprature (degC) where current will not be increased

D[40:47] Temp decrease Temeprature (degC) where current will be decreased

D[48:63] Monitor period active Period (ms) to monitor PMU temperature when charger is active

D[64:79] Monitor period idle Period (ms) to monitor PMU temperature when charger is idle

D[80:95] Monitor period no power Period (ms) to monitor PMU temperature when there is no charger power

Table 4.61: PMU Configuration

Page 62 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.34. Peer Device Custom UUID Configuration
This configuration item is used to setup the Peer Device Custom UUID. The data format of this configuration key is
outlined in Table 4.62.

Words Name Description

1-8 UUID The Custom UUID used to identify the local device as a Peer Device.
Note:
Any Peer Device that requests to connect to this device (when using the Custom
UUID) must have the same Custom UUID otherwise the connection request will be
rejected.

Table 4.62: Peer Device Custom UUID

ADK Audio Sink Application Configuration User Guide

Page 63 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.35. Multi-Channel Configuration
This configuration item is used to setup the Multi-Channel audio. The data format of this configuration key is outlined
in Table 4.63.

Bits Name Description

D[0:15] Digital Interface 1 Configures the first digital interface, see Table 4.64.

D[16:31] Digital Interface 2 Configures the second digital interface, see Table 4.64.

D[32:47] Analogue Interface Configures the analogue interface, see Table 4.64.

D[48:58] Reserved Not used.

ADK Audio Sink Application Configuration User Guide

D[59] Enable channel trims Configures whether to use channel trims:
0=do not use channel trims
1=use channel trims

D[60:61] Volume scaling Aux Volume scaling for the auxiliary channels:
0=hardware scaling
1=DSP scaling
2=hybrid scaling

D[62:63] Volume scaling Main Volume scaling for the main channels:
0=hardware scaling
1=DSP scaling
2=hybrid scaling

D[64:79] Fixed hardware gain A fixed gain to apply to channels.

D[80:95] Channel trim (pri left) Channel trim to apply to the primary left channel.

D[96:111] Channel trim (pri right) Channel trim to apply to the primary right channel.

D[112:127] Channel trim (sec left) Channel trim to apply to the secondary left channel.

D[128:143] Channel trim (sec right) Channel trim to apply to the secondary right channel.

D[144:159] Channel trim (sub) Channel trim to apply to the subwoofer channel.

D[160:175] Channel trim (aux left) Channel trim to apply to the auxiliary left channel.

[D176:191] Channel trim (aux right) Channel trim to apply to the auxiliary right channel.

Table 4.63: Multi Channel Configuration

Bits Name Description

D[0:8] Reserved N/A

D[9] Output format if digital Configure the digital audio output to use:
0=use I2S output
1=use SPDIF output

D[10] Enable Right Channel Configure whether to enable the right channel:
0=disabled
1=enabled

D[11] Swap A and B Configure whether to swap A and B channels:

Page 64 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Bits Name Description

0=swapped
1=not swapped

D[12:14] Multi-Channel Routing Configure the Multi-Channel routing:

0=none
1=primary
2=secondary
3=subwoofer
4=auxiliary

D[15] Enable Audio Interface Configure whether to use the audio interface:

ADK Audio Sink Application Configuration User Guide

0=disabled
1=enabled

Table 4.64: Audio Interface Configuration

Page 65 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.36. PS Defrag Test Configuration
This configuration item should not be used to store any data. It is explicitly used by the Audio Sink application for
defrag testing.

4.37. Bluetooth Smart Permanent Pairing Configuration

This configuration item should not be used to store any data. It is explicitly used by the Audio Sink application to
store pairing information for Bluetooth Smart devices that do not expose their public Bluetooth address.

ADK Audio Sink Application Configuration User Guide

Page 66 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
4.38. Software Version Configuration
This configuration item is used to setup the software version information. The data format of this configuration key is
outlined in Table 4.65

Word Name Description

1 Software Version Defines the software version of the Audio Sink application.

2 Configuration Version Defines the Configuration set version, used by the Audio Sink application to
verify whether or not the configuration set is compatible with the version it
understands.

3 Upgrade Transport Defines the transport type to use for over the air upgrades:

ADK Audio Sink Application Configuration User Guide

0=none
1=Serial Port Profile (SPP) transport
2=RFCOMM using CSR GAIA UUID
3=GATT (Bluetooth Smart) transport

Table 4.65: Software Version Configuration

Page 67 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
5. Appendix

Appendix A LED Pattern Configuration Data

LED Patterns is a data structure that takes the form as described in Table 5.1: LED Patterns Data Structure.

Bits Name Description

D[0:15] State OR Event State OR Event ID to action the LED pattern upon.

D[16:23] State State ID or NULL if this is part of an event pattern

ADK Audio Sink Application Configuration User Guide

D[24:31] On Time How long to keep the LED on (ms

D[32:39] Off Time How long to keep the LED off (ms)

D[40:47] Repeat Time How long to wait before repeating the pattern (ms)

D[48:55] Dim Time Time to dim this LED

D[56:63] Time Out Total time to display LED pattern, 0 to always display pattern.

D[64:67] Num Flashes How many flashes in the pattern

D[68:71] Led A Default first LED to use

D[72:75] Led B Second LED to use

D[76] Override Disable Override LED to disable flag for this pattern

D[77:79] Colour Which of the LEDs to use

Table 5.1: LED Patterns Data Structure

Page 68 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Appendix B State Mask
Event translations specify which state(s) must be active for the associated User Event to be generated. Table 5.2
lists the state mask used for these translation tables.

Bit Application state

0 deviceLimbo

1 deviceConnectable

2 deviceConnDiscoverable

3 deviceConnected

ADK Audio Sink Application Configuration User Guide

4 deviceOutgoingCallEstablish

5 deviceIncomingCallEstablish

6 deviceActiveCallSCO

7 deviceTestMode

8 deviceThreeWayCallWaiting

9 deviceThreeWayCallOnHold

10 deviceThreeWayMultiCall

11 deviceIncomingCallOnHold

12 DeviceActiveCallNoSCO

13 DeviceA2DPStreaming

14 DeviceLowBattery

15 RESERVED

Table 5.2: State Mask Look Up Table

Page 69 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Document References
Document Reference

Audio Sink Application Custom AT Commands User Guide CS-330103-UG

ADK Audio Sink Application Configuration User Guide

Page 70 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com
Terms and Definitions
BlueCore® Group term for CSR’s range of Bluetooth wireless technology chips

Bluetooth® Set of technologies providing audio and data transfer over short-range radio connections

CSR Cambridge Silicon Radio

UniFi® Group term for CSR’s range of chips designed to meet IEEE 802.11 standards

ADK Audio Sink Application Configuration User Guide

Page 71 of 71
© Cambridge Silicon Radio Limited 2015 CS-334708-UG1
www.csr.com