advertisement
4. Static Configuration Keys
USR13
USR14
USR15
USR16
USR17
USR18
USR19
USR6
USR7
USR8
USR9
USR10
USR11
USR12
USR20
USR21
USR22
USR23
USR24
USR25
USR26
USR27
USR28
USR29
USR30
USR31
USR32
USR33
USR34
PSKEY ID PSKEY Name Description
CONFIG_FEATURE_BLOCK
CONFIG_LENGTHS
CONFIG_TIMEOUTS
CONFIG_DEVICE_ID
CONFIG_BATTERY
CONFIG_RADIO
CONFIG_VOLUME_CONTROL
CONFIG_HFP_INIT
CONFIG_ADDITIONAL_HFP_SUPPORTED_FEATURES
CONFIG_RSSI_PAIRING
CONFIG_PIO
CONFIG_BUTTON
CONFIG_BUTTON_TRANSLATION
CONFIG_BUTTON_PATTERN_CONFIG
CONFIG_LED_FILTERS
CONFIG_LED_STATES
CONFIG_TRI_COL_LEDS
CONFIG_LED_EVENTS
CONFIG_EVENTS_A
CONFIG_EVENTS_B
CONFIG_EVENTS_C
CONFIG_TONES
CONFIG_USER_TONES
RESERVED
CONFIG_AUDIO_PROMPTS
CONFIG_SSR_PARAMS
CONFIG_USB_CONFIG
CONFIG_FM_CONFIG
CONFIG_AT_COMMANDS
This PSKEY is reserved
© Cambridge Silicon Radio Limited 2015
Page 19 of 71
CS-334708-UG1 www.csr.com
PSKEY ID PSKEY Name
USR35
USR36
USR37
USR38
USR39
USR40
USR41
USR42
USR43
USR44
USR45
USR46
USR47
USR48
USR49
Description
CONFIG_I2S_INIT_CONFIGURATION
CONFIG_I2S_INIT_DATA
CONFIG_AUDIO_ROUTING
CONFIG_INPUT_MANAGER
CONFIG_BLE_REMOTE_CONTROL
CONFIG_IR_REMOTE_CONTROL
CONFIG_PMU_MONITOR_CONFIG
CONFIG_PEER_DEVICE_CUSTOM_UUID
CONFIG_MULTI_CHANNEL_AUDIO
RESERVED
This PSKEY is reserved
RESERVED
This PSKEY is reserved
RESERVED
This PSKEY is reserved
CONFIG_DEFRAG_TEST
CONFIG_PERMANENT_PAIRING
CONFIG_SOFTWARE_VERSION_ID
Table 4.1: Static Configuration Keys
© Cambridge Silicon Radio Limited 2015
Page 20 of 71
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
3
4
1
2
5
6
7
Description
Feature block word 1, see Table 4.3.
Feature block word 2, see Table 4.4.
Feature block word 3, see Table 4.5.
Feature block word 4, see Table 4.6.
Feature block word 5, see Table 4.7.
Feature block word 6, see Table 4.9.
Feature block word 7, see Table 4.10.
Table 4.2: Feature Block Configuration
Bits Feature
D[15]
ReconnectOnPanic
D[14] OverideFilterPermanentlyOn
D[13] MuteSpeakerAndMic
D[12]
PlayTonesAtFixedVolume
D[11]
PowerOffAfterPDLResest
D[10]
RemainDiscoverableAtAllTimes
D[9]
DisablePowerOffAfterPowerOn
D[8] AutoAnswerOnConnect
Description
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.
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.
1 = Mute mutes both the Speaker and the Microphone of the Sink.
0 = Only the Microphone will be muted.
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.
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.
1 = The Audio Sink application remains discoverable at all times. This is useful for Multipoint operation.
0 = The Sink remains discoverable until connected.
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.
1 = This allows the Audio Sink application to send an answer (ATA) AT command if an incoming call is detected on connection.
© Cambridge Silicon Radio Limited 2015
Page 21 of 71
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]
D[4]
D[3]
D[2]
D[1]
D[0]
PartyMode
AdjustVolumeWhilstMuted
VolumeChangeCausesUnMute
PowerOffOnlyIfVRegEnLow
LimitRssiSuboowferPairing pair_mode_en
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 volume to the new level while the Sink is muted.
0 = Volume events do not alter the volume level while the Sink is muted.
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.
When set this feature prevents the Sink from powering off if the VREG enable pin is not low.
When set this enables subwoofer RSSI pairing that ensures signal strength is higher than the configured threshold.
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]
D[13]
D[12]
D[11]
D[10]
DisableTTSTerminate
AutoReconnectPowerOn speech_rec_enabled
SeparateLNRButtons
SeparateVDButtons
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.
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.
1 = Enables speech recognition.
0 = Disables speech recognition.
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.
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
© Cambridge Silicon Radio Limited 2015
Page 22 of 71
CS-334708-UG1 www.csr.com
Bits Feature
D[9:8] reserved
D[7:6]
PowerDownOnDiscoTimeout
D[5:4]
ActionOnCallTransfer
D[3:2]
D[1:0]
LedTimeMultiplier
ActionOnPowerOn
Description
regardless of this items value.
Not used.
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.
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.
2 = Initiate RSSI Inquiry (RSSI Pairing) mode.
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.
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]
D[11]
D[10]
D[9]
DiscoIfPDLLessThan
DoNotDiscoDuringLinkLoss
This forces the Sink to Enter Discoverable mode (pairing) if the paired device list contains fewer entries than the value of this configuration item
.
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..
ManInTheMiddle
1 = Bluetooth 2.1 man in the middle enabled.
0 = Feature disabled.
UseDiffConnectedEventAtPowerOn 1 = The event
EventSLCConnectedAfterPowerOn an SLC occurs straight after power on. The event
is generated when
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]
D[7]
D[6]
D[5]
EncryptOnSLCEstablishment
UseLowPowerAudioCodecs
PlayLocalVolumeTone
SecurePairing
1 = Ensures that encryption is used on SLC Establishment.
2 = Encryption not enforced.
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.
1 = The Sink plays a tone when the volume is changed using the remote device.
0 = Feature disabled.
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
© Cambridge Silicon Radio Limited 2015
Page 23 of 71
CS-334708-UG1 www.csr.com
Bits
D[4]
D[3]
D[2]
D[1]
D[0]
Feature
PowerOffOnWiredAudioConnected
QueueVolumeTones
QueueEventTones
QueueLEDEvents
MuteToneFixedVolume
Description
the link key) then the Sink accepts a pin code request.
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.
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.
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.
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 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]
D[14]
D[13]
D[12]
D[11:8]
ResetLEDEnableStateAfterReset
ResetAfterPowerOffComplete
AutoPowerOnAfterInitialisation
DisableRoleSwitching audio_plugin
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.
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.
1 = The Audio Sink application automatically powers on once the chip has been powered and initialisation is complete.
0 = Feature Disabled.
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.
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]
D[3]
D[2]
D[1]
D[0]
DefaultVolume
IgnoreButtonPressAfterLedEnable
LNRCancelsVoiceDialIfActive
GoConnectableDuringLinkLoss
TwsQualificationEnable
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…
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.
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.
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.
1 = Enable the PTS qualification for TWS AVRCP TG/CT features.
© Cambridge Silicon Radio Limited 2015
Page 24 of 71
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]
D[14:10] FixedToneVolumeLevel
D[9]
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.
EnableAvrcpAudioSwitching
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.
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]
D[7]
D[6]
D[5:4]
D[3]
D[2:1]
D[0]
ForceEV3S1ForSco2
VoicePromptPairing avrcp_enabled
PairIfPDLLessThan
EnableSyncMuteMicrophones
ActionOnPanicReset
VoicePromptNumbers
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.
1 = PIN/Passkey/Confirmation messages are read out using preconfigured
Voice Prompts.
0 = Feature Disabled.
1 = Enable AVRCP control. This feature is not supported on some ROM variants.
0 = Feature Disabled.
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.
1 = The mute command is sent to both AGs when using multipoint.
0 = The mute command is sent to only the AG in use.
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.
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]
D[11]
D[10]
D[9:5]
D[4]
DefaultA2dpVolLevel pbap_enabled
EnableA2dpStreaming
A2dpOptionalCodecsEnabled
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.
1 = Enables Phone Book Application Profile functionality.
0 = Feature Disabled.
1 = Sink can stream audio using an A2DP link.
0 = A2DP streaming is not enabled .
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.
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
© Cambridge Silicon Radio Limited 2015
Page 25 of 71
CS-334708-UG1 www.csr.com
Bits
D[3]
D[2:0]
Name
AssumeAutoSuspendOnCall
Description
drop the signalling channel completely.
0 = Feature Disabled.
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.
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
ReconnectLastAttempts is 0 to 7.
Table 4.8: Feature Block Configuration: Word 6
Bits Name Description
D[15]
D[14]
D[13]
D[12]
D[11]
D[10]
D[9]
D[8:7]
ShareMeSource
ShareMeSink
TwsSource
TwsSink
PeerUseLiac
PeerUseDeviceId
PeerUseCsrUuid
ShareMePairingMode
1 = The device supports relay of audio to another ShareMe device.
0 = The device does not support relay of audio to another ShareMe device.
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.
1 = The device supports relay of audio to another TWS device.
0 = The device does not support relay of audio to another TWS device.
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.
1 = Limited Access Code is used when pairing Peer devices.
0 = General Access Code is used when pairing Peer devices.
1 = Use the Device ID record to filter suitable devices.
0 = Do not filter on Device ID.
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.
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
D[3:2]
D[1:0]
TwsSlaveAudioRouting
TwsPairingMode
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
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
Determines how pairing information is retained for TWS devices:
0 = Temporary
1 = Standard
2 = Permanent
Table 4.9: Feature Block Configuration: Word 7
© Cambridge Silicon Radio Limited 2015
Page 26 of 71
CS-334708-UG1 www.csr.com
Bits Feature Description
D[15]
ShareMePeerControlsSource
D[14:13] PeerSource
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.
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.
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]
D[0]
GaiaEnableSession
GaiaRemainConnected
1 = GAIA session is enabled on connection.
0 = GAIA session is not enabled on connection.
1 = GAIA connection remains after power off.
0 = GAIA connection is disconnected after power off.
Table 4.10: Feature Block Configuration: Word 8
© Cambridge Silicon Radio Limited 2015
Page 27 of 71
CS-334708-UG1 www.csr.com
3
6
7
4
5
8
4.2. Lengths Configuration
configuration item.
Word Bits
1
2
D[15:0]
D[15:0]
9
10
11
12
D[15:0]
D[15:0]
D[15:0]
D[15:0]
D[15:0]
D[15:0]
D[15:0]
D[15:0]
D[15:8]
D[7:0]
D[15:8]
D[7:4]
D[3:0]
Description
This defines the number of entries currently in the Paired Device List.
This defines the total number of entries that exist in the lookup table that maps System/User
Event to Voice Prompt(s).
This defines the total number of languages configured for the Voice Prompts feature.
This defines the total number of LED filters configured, see section TODO
This defines the total number of LED states configured, see section TODO
This defines the total number of LED events configured, see section TODO
This defines the total number of Tones configured, see section TODO
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.
This defines the total number of User Tones configured, see section TODO
This defines the total size of the data defined in the CONFIG_AT_COMMANDS configuration key.
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.
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
Defines the total number of entries in the Input Manager lookup table.
Defines the total number of entries in the Bluetooth Smart Remote Controller lookup table.
Defines the total number of entries in the Infra-Red Remote Controller lookup table.
Table 4.11: Lengths Configuration
© Cambridge Silicon Radio Limited 2015
Page 28 of 71
CS-334708-UG1 www.csr.com
3
4
2
5
6
7
8
9
10
11
12
13
4.3. Timers Configuration
Word Timer
1
AutoSwitchOffTime_s
LimboTimeout_s
NetworkServiceIndicatorRepeatTime_s
DisablePowerOffAfterPowerOnTime_s
PairModeTimeout_s
MuteRemindTime_s
ConnectableTimeout_s
PairModeTimeoutIfPDL_s
ReconnectionAttempts
EncryptionRefreshTimeout_m
InquiryTimeout_s
SecondAGConnectDelayTime_s
MissedCallIndicateTime_s
Range Description
0-600 (s)
0-60 (s)
0-3600(s)
0-60(s)
0-65535(s)
0 = Timeout disabled
1-600 = The time in seconds after which the device switches off if not connected.
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.
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.
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.
0-60(s)
0-65535(s)
The time in seconds to periodically play the mute reminder tone whilst audio is muted.
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.
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
0-65535(s) number of times to try and reconnect a device before giving up
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.
0-65535(s)
0-65535(s)
0-65535(s)
Specifies the maximum inquiry time for device searching, in units of 1.28 seconds.
This value determines the delay time, in ms, between the connection of AG1 and the start of connection to
AG2 when using MultiPoint operation.
The period in second between two indications
© Cambridge Silicon Radio Limited 2015
Page 29 of 71
CS-334708-UG1 www.csr.com
Word Timer
14
MissedCallIndicateAttemps
15
A2dpLinkLossReconnectionTime_s
16
17
18
19
20
21
22
23
24
25
26
LanguageConfirmTime_s
WiredAudioConnectedPowerOffTimeout_s
StoreCurrentPEQSettingsTimeout_s
DefragCheckTimer_s
AudioAmpPowerDownTimeoutInLimbo_s
ImmediateAlertTimer_s
ImmediateAlertStopTimeout_s
LinkLossTimer_s
LinkLossAlertStopTimeout_s
Range
0-65535(s)
0-65535(s)
0-65535(s)
SpeechRecRepeatTime_ms
0-65535(s)
StoreCurrentSinkVolumeAndSourceTimeout_s
0-65535(s)
0-65535(s)
0-65535(s)
0-65535(s)
0-65535(s)
0-65535(s)
0-65535(s)
Description
number of times to indicate before stopping indication the amount of time in seconds to attempt to reconnect a2dp
The time between
EventUsrSelectAudioPromptLanguageMode and storing the language in PS the between voice prompts ASR restarts
The time in seconds elapsed after the last
VolumeUp/Down or Source button was pressed, to store the volume information into PS Store
The time in seconds elapsed before the device is powered off after the wired audio is connected
The time in seconds elapsed after the last GAIA command has been received to store EQ settings into
PS Store
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
The period in seconds for which the system waits before powering down audio amplifier for sound bar when in Limbo state
The period in seconds for which the system waits before palying alert tone again
The period in seconds for which the system waits before stoppingthe alert
The period in seconds for which the system waits before palying alert tone again
0-65535(s) The period in seconds for which the system waits before stoppingthe alert
Table 4.12: Timers Configuration
© Cambridge Silicon Radio Limited 2015
Page 30 of 71
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.
3
4
Word(s) Name
1
2
Description
Vendor ID Source
Vendor ID
0x0001 = Vendor ID has been assigned by the Bluetooth Special Interest Group.
0x0002 = Vendor ID has been assigned by the USB Implementers Forum.
Should be set as assigned by the Vendor ID source.
Product ID
BCD Version
Should be set as appropriate for the product.
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
© Cambridge Silicon Radio Limited 2015
Page 31 of 71
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)
1-2
3-10
11-19
20-22
Name Description
Vref Configuration
Vbat Configuration
Vthm Configuration
Vchg Configuration
Table 4.14: Battery Configuration
Word(s)
1-2
Name
Vref ADC
Description
Table 4.15: Vref Configuration
Word(s)
6
7
8
4
5
1-2
3
Name Description
Battery Voltage ADC
Battery Limit Setting [0]
Battery Limit Setting [1]
Battery Limit Setting [2]
Battery Limit Setting [3]
Battery Limit Setting [4]
Battery Limit Setting [5]
Table 4.16: Vbat Configuration
Bit(s)
D[143:128]
D[127:124]
D[123:119]
D[118]
D[117]
D[112:116]
Name
Thermistor ADC
Delay
Reserved
Raw limits
Drive PIO
PIO
Description
Delay(ms) between setting PIO and reading
ADC
N/A
Set limits in ADC counts rather than voltage
Drive thermistor from a PIO
PIO to use (0-31)
© Cambridge Silicon Radio Limited 2015
Page 32 of 71
CS-334708-UG1 www.csr.com
Bit(s)
D[111:96]
D[95:80]
D[79:64]
D[63:48]
D[47:32]
D[31:16]
D[15:0]
Name Description
Battery Limit Setting [0]
Battery Limit Setting [1]
Battery Limit Setting [2]
Battery Limit Setting [3]
Battery Limit Setting [4]
Battery Limit Setting [5]
Battery Limit Setting [6]
Table 4.17: Vthm Configuration
Word(s)
1-2
3
Name Description
Vchg ADC
Limit
Vchg Threshold (mV/POWER_VSCALE)
Table 4.18: Vchg Configuration
Bits
D[127:120]
D[119:111]
D[111:96]
Bits
D[15:8]
D[7:0]
Name Description
ADC Source
Read period when charging
Read period when not charging
The ADC Source:
0 = AIO0
1 = AIO1
2 = AIO2
3 = AIO3
4 = VREF
5 = VBAT
6 = VDD_SENSE
7 = VREG_ENABLE
Interval (in seconds) between measurements when charging
Interval (in seconds) between measurements when not charging
Table 4.19: ADC Configuration
Name Description
Notify Period
Limit
Interval
(seconds/POWER_PERIOD_SCALE) between notifications (0 to disable)
Battery Voltage Threshold
(mV/POWER_SCALE)
Table 4.20: Battery Limit Configuration
© Cambridge Silicon Radio Limited 2015
Page 33 of 71
CS-334708-UG1 www.csr.com
4.6. Radio 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
3
4
1
2
Page scan interval
Page scan window
Inquiry scan interval
Inquiry scan window
Table 4.21: Radio Configuration
© Cambridge Silicon Radio Limited 2015
Page 34 of 71
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.
15
16
17
18
19
20
21
22
23
6
7
8
9
10
11
12
13
14
Word(s) Name
1
2
3
4
5
Description
no_of_steps volume_knee_value_1 volume_knee_value_2 dB_knee_value_1 dB_knee_value_2 dB_max dB_min
Volume map [0]
Volume map [1]
Volume map [2]
Volume map [3]
Volume map [4]
Volume map [5]
Volume map [6]
Volume map [7]
Volume map [8]
Volume map [9]
Volume map [10]
Volume map [11]
Volume map [12]
Volume map [13]
Volume map [14]
Volume map [15]
Table 4.22: Volume Control Configuration
number of steps of volume change permitted volume point at which curve of dB conversion changes volume point at which curve of dB conversion changes dB value for point at which curve of dB conversion changes dB value for point at which curve of dB conversion changes dB value at maximum volume level dB value at minimum volume level
© Cambridge Silicon Radio Limited 2015
Page 35 of 71
CS-334708-UG1 www.csr.com
Bit(s) Name Description
D[31:28]
D[27:24]
IncVol
DecVol
The hfp volume level to go to when volume up is pressed
The hfp volume level to go to when volume down is pressed
D[23:16] Tone
D[15:8] A2dpGain
The tone associated with a given volume level
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
Table 4.23: Volume Mapping Configuration
© Cambridge Silicon Radio Limited 2015
Page 36 of 71
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
D[16:31]
D[32:47]
D[48:49]
D[50:51]
D[52:53]
D[54:55]
D[56:63]
D[64:76]
D[77]
Supported features
Supported WBS codecs
Service
Signal Strength
Roaming Status
Battery Charge
Reserved
Reserved
Disable NREC
D[78]
D[79]
D[80:87]
D[88:95]
D[96]
Extended Errors
MultiPoint
Link Loss Time
Link Loss Interval
Caller Name
D[97]
D[98]
D[99]
Raw Text
SMS
Battery Level
D[100] Power Source
D[101:103] Codecs
D[104:105] Codec Bandwidth
D[106:111] Reserved
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.
See supported flags
User configurable information regarding the HF's codecs
Optional indicators the HF may not want to receive: service
Optional indicators the HF may not want to receive: signal strength
Optional indicators the HF may not want to receive: roaming status
Optional indicators the HF may not want to receive: battery charge
N/A
N/A
Disable Noise Reduction/Echo Cancellation on connection
Enable sending of extended error codes by AG's supporting them
Whether multiple connections to one profile are supported
The time in minutes to attempt to reconnect for on link loss
The time in seconds between link loss reconnect attempts
CSR2CSR feature
CSR2CSR feature
CSR2CSR feature
CSR2CSR feature
CSR2CSR feature
CSR2CSR feature
CSR2CSR feature
N/A
Table 4.24: HFP Initialisation Configuration
© Cambridge Silicon Radio Limited 2015
Page 37 of 71
CS-334708-UG1 www.csr.com
Bit(s)
D[0]
D[1:5]
D[6:15]
D[16:47]
D[48:63]
D[64:79]
D[D80:96]
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.
Name
Additional Audio Params
Reserved
Packet Types bandwidth max_latency
Description
Enable use of audio params
N/A
Supported packet types
SCO Bandwidth
SCO Max Latency voice_settings retx_effort
Table 4.25: HFP1.5 Configuration
SCO Voice Settings
SCO Retransmission Effort
© Cambridge Silicon Radio Limited 2015
Page 38 of 71
CS-334708-UG1 www.csr.com
4.10. RSSI Inquiry Configuration
describes the data structure of this configuration item.
Bit(s) Name
D[0:15] tx_power
D[16:31] threshold
D[32:47] diff_threshold
D[48:79] cod_filter
D[80:95] conn_threshold
D[96:111] conn_diff_threshold
D[112:119] max_responses
D[120:127] timeout
D[128:135] resume_timeout
D[136:139] num_results
D[140] connect_if_in_pdl
D[141] dont_pair_if_in_pdl
D[142] try_all_discovered
D[143] pair_on_pdl_reset
Description
The inquiry Tx power
The minimum RSSI reading for an AG to be paired
The required difference between AG and next closest AG
COD to consider
The minimum RSSI reading for an AG to be connected
The required difference between AG and next closest AG
Maximum number of inquiry responses
Maximum inquiry time (timeout * 1.28s)
Time to wait between inquiry attempts
Number of results we can store
Don't connect to an AG if not already in the PDL
Don't pair with an AG if already in the PDL
Attempt to pair/connect to all discovered AGs
Start RSSI pairing on PDL reset event
Table 4.26: RSSI Pairing Configuration
© Cambridge Silicon Radio Limited 2015
Page 39 of 71
CS-334708-UG1 www.csr.com
4.11. PIO Configuration
configuration item.
Bit(s)
D[0:7]
D[8:15]
D[16:23]
D[24:31]
D[32:39]
D[40:47]
D[48:55]
D[56:63]
D[64:71]
D[72:79]
D[80:87]
D[88:95]
D[96:103]
D[104:111]
D[112:143]
D[144:159]
D[160:175]
D[176:191]
D[192:207]
D[208:223]
Name
spdif_detect analog_input charger_input dut_pio spdif_input aux_out_detect
CallActivePIO
IncomingRingPIO
OutgoingRingPIO
DeviceAudioActivePIO
PowerOnPIO spdif_output
LedEnablePIO
AudioMutePIO pio_invert mic_a mic_b line_a line_b pio_map
Description
PIO for SPDIF detect
PIO for Analogue Input
PIO for Charger Input
PIO for DUT
PIO for SPDIF input
PIO for Aux Out Detect
PIO for Active Call
PIO for Incoming Ring
PIO for Outgoing Ring
PIO for Active Audio
PIO for Power On
PIO for SPDIF output
PIO for LED Enable
PIO for Audio mute
Bit mask used to invert button PIOs,
1 = inverted
Mic A settings, see TODO
Mic B settings, see TODO
Line A settings, see TODO
Line B settings, see TODO
Pins to map (see PioSetMapPins32 in pio.h)
Table 4.27: PIO Configuration
© Cambridge Silicon Radio Limited 2015
Page 40 of 71
CS-334708-UG1 www.csr.com
4.12. Button Configuration
Bits
D[0:15]
D[16:31]
D[32:47]
D[48:63]
D[64:79]
D[80:87]
D[88:95]
Name
Double press
Long press
Very long press
Repeat
Very very long press
Debounce number
Debounce period
Description
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.
The time a button has to be pressed for, in ms, in order to generate a long message timer.
The time a button has to be pressed for, in ms, in order to generate a very long timer message.
The time, in ms, between repeat messages being generated if a button is held down.
The time a button has to be pressed for, in ms, in order to generate a very very long timer message.
The number of debounce checks performed.
The interval between each debounce check in ms.
Table 4.28: Button Configuration
© Cambridge Silicon Radio Limited 2015
Page 41 of 71
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
2
…
18
Button translation, see Table 4.30
Button translation, see Table 4.30
Button translation, see Table 4.30
Button translation, see Table 4.30
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]
D[8:9]
Button Number
Input Source
D[10:15] Input Number
Button number to assign, 0 to 15.
Input source, PIO or CAP sense.
Input number, 0 to 31.
Table 4.30: Button Translation Type
© Cambridge Silicon Radio Limited 2015
Page 42 of 71
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
1-7
8-14
15-21
22-28
Button pattern 1, see Table 4.32
Button pattern 2, see Table 4.32
Button pattern 3, see Table 4.32
Button pattern 4, see Table 4.32
Table 4.31: Button Pattern Configuration
4
5
6
7
2
3
Word Name
1
Description
Event pattern[0] This is a sequence of six 32-bit patterns representing the PIOs that are to be matched. If pattern[1] a pattern sequence less than six buttons is required the last PIO Keys can be set to 0. pattern[2] pattern[3]
This is the event that is generated after a successful pattern sequence match. pattern[4] pattern[5]
Table 4.32: Button Pattern Type
© Cambridge Silicon Radio Limited 2015
Page 43 of 71
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
Words Description
1-3 n…n
Each entry is of the LED Filters Data Type, as defined in
Table 4.33: LED Filters Configuration
Bits
D[0:15]
D[16:18]
D[19:21]
D[22:26]
D[27:30]
D[31]
D[32:34]
D[35:38]
D[39]
D[40:47]
Name Description
Event
Filter Type
The event to trigger the filter upon.
The type of filter:
0 = Disabled
1 = Cancel
2 = Speed
3 = Override
4 = Colour
5 = Follow
Colour
Filter To Cancel
Override LED
Override Disable
Reserved
Follower LED Delay
Force LED to this colour pattern no matter what is defined in the state pattern
If a filter is already being displayed, this will cause that filter to be cancelled when this one starts.
The LED to use to display the pattern.
Override LED disable flag when filter active
N/A
The delay before the following pattern starts (in 50ms steps, range 0-
750ms).
Speed Multiplier Action Which action to perform on the speed multiplier
0 = multiply
1= divide.
Speed Multiplier The speed multiplier to apply.
0 = No speed multiplier.
Table 4.34: LED Filters Type
© Cambridge Silicon Radio Limited 2015
Page 44 of 71
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
Words Description
1-5 n...n
Each entry is of the LED Patterns Data Type, as defined
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
Bits
D[0:3]
D[4:7]
D[8:11]
D[12:15]
Name Description
Tri Colour A
Tri Colour B
Tri Colour C
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
Words Description
1-5 n...n
Each entry is of the LED Patterns Data Type, as defined
Table 4.37: LED States Configuration
© Cambridge Silicon Radio Limited 2015
Page 45 of 71
CS-334708-UG1 www.csr.com
4.19. Events Configuration
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
CONFIG_EVENTS_B
CONFIG_EVENTS_C
Event block 1
Event block 2
Event block 3
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
Bits Name Description
D[0:7] User Event
D[8:15] Button Timing Event Defines the Button Timing Event that has to be generated for the User Event to
D[16:31] Button Mask
Defines the button(s) that generated the Button Timing event, see 4.19.3.
D[32:47] State Mask
The User event that will be generated if all the requirement conditions of this
event translation are met, see 4.19.1.
Defines the state(s) that must be active when the Button Timing Event was
Table 4.39: Data Structure Used by Event Translation Tables
© Cambridge Silicon Radio Limited 2015
Page 46 of 71
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.
5
6
7
8
Value
0
1
2
3
4
9
10
11
12
13
Name
B_INVALID
B_SHORT
B_LONG
B_VERY_LONG
B_DOUBLE
B_REPEAT
B_LOW_TO_HIGH
B_HIGH_TO_LOW
B_SHORT_SINGLE
B_LONG_RELEASE
B_VERY_LONG_RELEASE
B_VERY_VERY_LONG
B_VERY_VERY_LONG_RELEASE
B_TRIPLE
Description
Unassigned
Timer that fires whilst button(s) have been pressed down for a short period (timer)
Timer that fires whilst button(s) have been pressed down for a long period (timer)
Timer that fires whilst button(s) have been pressed down for a very long period (timer)
Button(s) have been double pressed (two very short presses, one after the other)
Timer that repeats whilst the button(s) are held down
Rising edge of a button(s) press
Falling edge of a button(s) press
Button(s) have been pressed for a short period and then released
Button(s) have been pressed for a long period and then released
Button(s) have been pressed for a very long period and then released
Timer that fires whilst button(s) have been pressed down for a very very long period (timer)
Button(s) have been pressed for a very very long period and then released
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
lists the bit positions of the mask for each state.
© Cambridge Silicon Radio Limited 2015
Page 47 of 71
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
Words Description
1-2 n…n
User Event to tone translation, see Table 4.42
User Event to tone translation, see Table 4.42
Table 4.41: Tones Configuration Data Structure
Bits
D[0:15]
D[16:23]
D[24:31]
Name
Event
Reserved
Tone
Table 4.42: Tones Configuration Type
Description
The mapped User Event
N/A
The audio tone to play when User
Event is generated
© Cambridge Silicon Radio Limited 2015
Page 48 of 71
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
Word(s) Description
8
9..n1 n2..n3 n4..n5 n6..n7 n8..n9 n10..n11 n12..n13
3
4
1
2
5
6
7
Offset to the custom tone data (starting at word 9) for tone [0]
Offset to the custom tone data (starting at word n2) for tone [1]
Offset to the custom tone data (starting at word n4) for tone [2]
Offset to the custom tone data (starting at word n6) for tone [3]
Offset to the custom tone data (starting at word n8) for tone [4]
Offset to the custom tone data (starting at word n10) for tone [5]
Offset to the custom tone data (starting at word n12) for tone [6]
Offset to the custom tone data (starting at word n14) for tone [7]
Tone data for custom tone [0]
Tone data for custom tone [1]
Tone data for custom tone [2]
Tone data for custom tone [3]
Tone data for custom tone [4]
Tone data for custom tone [5]
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
© Cambridge Silicon Radio Limited 2015
Page 49 of 71
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
Words Description
1-3 n…n
Voice Prompt configuration, see Table 4.45
Voice Prompt configuration, see Table 4.45
Table 4.44: Audio Prompts Configuration
Note:
The number of audio prompts that have been configured must be added to the Lengths configuration item, see
Bits Name Description
D[0:15]
D[16:23]
D[24:31]
Event
Reserved
Prompt ID
D[32]
D[33]
D[34:47]
Play Immediate
SCO Block
State Mask
The mapped User Event
N/A
The audio prompt that needs to be played when the mapped user event is generated.
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.
1 = Do not play the audio prompt if the there is an active SCO connection.
0 = Always play the audio prompt
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
© Cambridge Silicon Radio Limited 2015
Page 50 of 71
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
2
3
SLC remote latency The maximum time the remote device need not be present when sub-rating.
(for SLC connections)
SLC remote timeout The minimum time the remote device should stay in sniff before entering sub-rating mode. (for SLC connections)
SLC local timeout The minimum time the local device should stay in sniff before entering subrating mode. (for SLC connections)
4
5
SCO remote latency The maximum time the remote device need not be present when sub-rating.
(for SCO connections)
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 subrating mode. (for SCO connections)
Note:
All values are in units of 0.625ms.
Table 4.46: Sniff Sub-Rate Configuration
© Cambridge Silicon Radio Limited 2015
Page 51 of 71
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
Bits Name Description
D[0:15]
D[16:31]
D[32:47] i_disc i_susp i_susp_db
Current when USB disconnected but charger connected, see Table
Current when suspended, see Table 4.48
Current when suspended prior to enumeration with dead battery,
D[48:63]
D[64:79] i_att i_att_trickle
Current when attached but not enumerated, see Table 4.48
Current when attached but not enumerated and trickle charging, see
Current when connected to host/hub, see Table 4.48
D[80:95] i_conn
D[96:111] i_conn_trickle
D[112:127] i_chg
D[128:143] i_dchg
D[144:159]
D[160] i_lim audio_always_on
Current when connected to host/hub and trickle charging, see Table
Current when connected to a charging host/hub, see Table 4.48
Current when connected to a dedicated charger, see Table 4.48
Current when vbus drop is detected, see Table 4.48
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
D[164:167] plugin_index
D[168:171] attach_timeout
Mono/Stereo
USB plugin to use
D[172:175] deconfigured_timeout
Time (seconds) after attach at which we set low power bootmode if not enumerated
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
© Cambridge Silicon Radio Limited 2015
Page 52 of 71
CS-334708-UG1 www.csr.com
Bits
D[0]
D[1:2]
D[3]
D[4]
D[5]
D[6:7]
D[8:15]
Name
charge boost vsel power_off disable_leds reserved current
Description
Enable/Disable Charger, 1=enable, 0=disable
Charge boost, 0=disabled, 1=internal, 2=external
Voltage Select 0=charger, 1=battery
Power off, 0=disabled, 1=enabled
Disable LEDs, 0=disabled, 1=enabled
N/A
Current, measured in (mA)
Table 4.48: USB Charger Configuration
© Cambridge Silicon Radio Limited 2015
Page 53 of 71
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
Word Description
3
4
1
2
5
6
7
8
9
10
11
Seek band bottom (88.1Mhz)
Seek band top (107.9Mhz)
Frequency spacing
Seek tune RSSI
Seek tune SNR
RSQ RSSI low
RSQ RSSI high
RSQ SNR low
RSQ SNR hight
Antenna Selection
Hardware PIO
Table 4.49: FM Configuration
© Cambridge Silicon Radio Limited 2015
Page 54 of 71
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. I
2
S Configuration
This configuration item is used to store the I
2
S configuration data. The data format of this configuration key is described in the ADK I2S User Guide.
4.28. I
2
S Initialisation Configuration
This configuration item is used to store the I
2
S initialisation data. The data format of this configuration key is described in the ADK I2S User Guide.
© Cambridge Silicon Radio Limited 2015
Page 55 of 71
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
Word(s) Description
1
2-3
4-5
6
Audio Plugin Features including input and output hardware selection, see Table
Reserved, do not use.
Silence detection settings, see Table 4.52.
Target latency, see Table 4.53.
Table 4.50: Audio Routing Configuration
Bits
D[0:1]
D[2:3]
Name
Reserved
Audio input routing
D[4:7]
D[8]
D[9:10]
D[11]
D[12:13]
D[14]
D[15]
SPDIF supported data types
Stereo
DUT Microphone
Force tone resampling
Reserved
Use one mic back channel
Use two mic back channel
Description
N/A
The input audio routing:
0 = Internal routing
1 = I2S routing
2 = SPDIF routing
3 = Internal and relay routing
SPDIF input type:
0 = PCM
1 = Reserved (Do not use)
2 = AAC
3 = MP3
0 = mono input
1 = stereo input
The input mic for DUT mode:
0 = DUT Mic A
1 = DUT Mic B
2 = DUT Mic C
3 = DUT Mic D
0 = No resampling of tones
1 = Tones are resampled
N/A
0 = Disabled
1 = One mic back channel enabled
0 = Disabled
1 = Two mic back channel enabled
Table 4.51: Audio Plugin features
© Cambridge Silicon Radio Limited 2015
Page 56 of 71
CS-334708-UG1 www.csr.com
Word
1
2
Name Description
Threshold Threshold (16 bit fractional value - aligned to MSB in DSP)
Trigger time Trigger time in seconds (16 bit int)
Table 4.52: Silence Detection Configuration
Bits
D[0:7]
D[8:15]
Name Description
Reserved N/A
Target latency The target latency
Table 4.53: SPDIF Latency Configuration
© Cambridge Silicon Radio Limited 2015
Page 57 of 71
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
Word Name Description
1
2
3
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.
Short Timer
Long Timer
The short timer fires if the input(s) are still held down for the configured short timer duration.
The long timer fires if the input(s) are still held down for the configured "long timer" duration
4
5
V.Long Timer
VV.Long Timer
The very long timer fires if the input(s) are still held down for the configured very long timer duration
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,
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
D[0:15]
D[16:31]
D[32:39]
D[40:47]
Name Description
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).
State Mask
User Event
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.
The user event is an offset (0-255) from EVENTS_USR_MESSAGE_BASE to the User
Event enumeration.
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
© Cambridge Silicon Radio Limited 2015
Page 58 of 71
CS-334708-UG1 www.csr.com
Value Input Event
8
9
10
5
6
7
0
1
2
3
4
Input down
Input very short release
Short timer (while input held down)
Input short release
Long timer (while input held down)
Input long release
Very long timer (while input held down)
Input very long release
Very very long timer (while input held down)
Input very very long release
Input repeat timer (while input held down)
Table 4.56: Input Manager Events
© Cambridge Silicon Radio Limited 2015
Page 59 of 71
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
1
2..n
Max Remotes
Lookup Table
Description
Configures the maximum number of remote controllers that can be supported.
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.
Table 4.57: Bluetooth Smart Remote Control Configuration
Bits
D[0:3]
D[4:15]
Name
Input ID
HID Code
Description
The input ID the HID code translates to (allows up to 16 RC buttons to be supported)
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
© Cambridge Silicon Radio Limited 2015
Page 60 of 71
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
2
3
Word Name
1
4
5
6..n
Description
Protocol Defines which IR protocol the application supports (can only support one protocol; either NEC or RC5)
Max Learnt Codes The maximum number of IR codes the application can learn
Learning Mode
Timeout
Failsafe for turning off the IR learning mode (ms)
Learning Mode
Reminder
A reminder tone can be generated to indicate learning mode is active, this will be repeated every timeout (ms)
The PIO interfacing the InfraRed hardware Infra-Red PIO
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
D[0:3]
D[4:7]
D[8:15]
D[16:31]
Name
Infra-Red
Code
Reserved
Input ID
Address
Description
The infrared code sent by the remote controller that converts to *input_id* for the input manager to process
N/A
The input ID the IR code translates to (allows up to 16 RC buttons to be supported)
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
© Cambridge Silicon Radio Limited 2015
Page 61 of 71
CS-334708-UG1 www.csr.com
D[0:7]
D[8:15]
D[16:23]
D[24:31]
D[32:39]
D[40:47]
D[48:63]
D[64:79]
D[80:95]
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
Min charge
Max charge
Charger step
Reserved
Temp increase
Temp decrease
Minimum charger current
Maximum charger current
Charger current step-size
Not used (set to 0)
Temeprature (degC) where current will not be increased
Temeprature (degC) where current will be decreased
Monitor period active
Monitor period idle
Period (ms) to monitor PMU temperature when charger is active
Period (ms) to monitor PMU temperature when charger is idle
Monitor period no power Period (ms) to monitor PMU temperature when there is no charger power
Table 4.61: PMU Configuration
© Cambridge Silicon Radio Limited 2015
Page 62 of 71
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
Words
1-8
Name
UUID
Description
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
© Cambridge Silicon Radio Limited 2015
Page 63 of 71
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
Bits
D[0:15]
D[16:31]
D[32:47]
D[48:58]
D[59]
D[60:61]
D[62:63]
D[64:79]
D[80:95]
D[96:111]
D[112:127]
D[128:143]
D[144:159]
D[160:175]
[D176:191]
Name Description
Digital Interface 1
Digital Interface 2
Analogue Interface
Reserved
Enable channel trims
Volume scaling Aux
Volume scaling Main
Fixed hardware gain
Channel trim (pri left)
Channel trim (pri right)
Channel trim (sec left)
Channel trim (sec right)
Channel trim (sub)
Channel trim (aux left)
Channel trim (aux right)
Configures the first digital interface, see Table 4.64.
Configures the second digital interface, see Table 4.64.
Configures the analogue interface, see Table 4.64.
Not used.
Configures whether to use channel trims:
0=do not use channel trims
1=use channel trims
Volume scaling for the auxiliary channels:
0=hardware scaling
1=DSP scaling
2=hybrid scaling
Volume scaling for the main channels:
0=hardware scaling
1=DSP scaling
2=hybrid scaling
A fixed gain to apply to channels.
Channel trim to apply to the primary left channel.
Channel trim to apply to the primary right channel.
Channel trim to apply to the secondary left channel.
Channel trim to apply to the secondary right channel.
Channel trim to apply to the subwoofer channel.
Channel trim to apply to the auxiliary left channel.
Channel trim to apply to the auxiliary right channel.
Table 4.63: Multi Channel Configuration
Bits
D[0:8]
D[9]
D[10]
D[11]
Name
Reserved
Output format if digital
Enable Right Channel
Swap A and B
Description
N/A
Configure the digital audio output to use:
0=use I2S output
1=use SPDIF output
Configure whether to enable the right channel:
0=disabled
1=enabled
Configure whether to swap A and B channels:
© Cambridge Silicon Radio Limited 2015
Page 64 of 71
CS-334708-UG1 www.csr.com
Bits
D[12:14]
D[15]
Name
Multi-Channel Routing
Enable Audio Interface
Description
0=swapped
1=not swapped
Configure the Multi-Channel routing:
0=none
1=primary
2=secondary
3=subwoofer
4=auxiliary
Configure whether to use the audio interface:
0=disabled
1=enabled
Table 4.64: Audio Interface Configuration
© Cambridge Silicon Radio Limited 2015
Page 65 of 71
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.
© Cambridge Silicon Radio Limited 2015
Page 66 of 71
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
Word
1
2
3
Name Description
Software Version
Configuration Version
Upgrade Transport
Defines the software version of the Audio Sink application.
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.
Defines the transport type to use for over the air upgrades:
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
© Cambridge Silicon Radio Limited 2015
Page 67 of 71
CS-334708-UG1 www.csr.com
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project