fuchsia.bluetooth.bredr

Audio Priority Direction extension. Used to put the channel in a mode where A2DP packets are prioritized over other packets in the source or sink direction.

SetPriority

Request

Name	Type
`priority`	`A2dpDirectionPriority`

Response

Name	Type
`result`	`AudioDirectionExt_SetPriority_Result`

ConnectionReceiver

Represents a service which is registered by this profile. Closing this protocol will remove the service registration.

Connected

Called when a peer connects to this service. The channel connected is delivered with parameters in channel. protocol will contain a protocol list up to the point connected (for example, if L2CAP is connected, it will contain the L2CAP protocol and specify the PSM connected)

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`channel`	`Channel`
`protocol`	`ProtocolDescriptorList`

L2capParametersExt

L2CAP Parameters Extension. Used to configure L2CAP channel parameters on an open channel.

RequestParameters

Request a L2CAP channel parameter update. request indicates the desired parameters, and new indicates the new parameters (which may differ from the requested parameters if they are rejected/modified). Currently only the following parameters can be changed:

flush_timeout

Request

Name	Type
`request`	`ChannelParameters`

Response

Name	Type
`new`	`ChannelParameters`

MockPeer

Defined in fuchsia.bluetooth.bredr/profile_test.fidl

MockPeer provides an interface for managing the lifetime of a mock peer in the piconet. Dropping MockPeer will unregister the peer from the Profile Test Server database.

Any launched components associated with the mock peer will be terminated.
Any actively connected ProfileProxy will be disconnected and dropped.

ConnectProxy

Connect a channel to the fuchsia.bluetooth.bredr.Profile protocol for manipulation of the mock peer.

It is valid to connect multiple proxies to a MockPeer.

This parallels the current behavior of the bluetooth profile components. Specifically, profiles internally use the fuchsia.bluetooth.bredr.Profile service to register, search, and connect services. ConnectProxy provides a way for the test client to do the same for a given mock peer.

If the interface is not connectable, it will be dropped with an epitaph signaling the failure.

request interface Interface to drive mock peer behavior.

Request

Name	Type
`interface`	`request<Profile>`

Response

<EMPTY>

LaunchProfile

Launch a profile specified by the launch_info.

request launch_info Information about the component to be launched.

response Acknowledgement when the profile has been launched, or an error code if the profile could not be launched

Request

Name	Type
`launch_info`	`LaunchInfo`

Response

Name	Type
`result`	`MockPeer_LaunchProfile_Result`

PeerObserver

Defined in fuchsia.bluetooth.bredr/profile_test.fidl

PeerObserver provides the integration test client with a way to validate the behavior of a peer in the piconet. Dropping PeerObserver will stop any subsequent updates for the peer.

ComponentTerminated

Called when a component, launched by MockPeer.LaunchProfile, has terminated for any reason. ComponentTerminated does not provide information regarding why a component has terminated and should not be used for debugging.

request component_url URL of the component that has terminated.

Request

Name	Type
`component_url`	`fuchsia.sys/component_url`

Response

<EMPTY>

PeerConnected

Called when a peer has connected to a service.

request peer_id The peer that connected to the service.
request protocol Contains the protocol list of the connection.

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`protocol`	`ProtocolDescriptorList`

Response

<EMPTY>

ServiceFound

The peer discovered the services of another peer in the piconet.

request peer_id The peer the service was found on.
request protocol Includes the ProtocolDescriptorList in the service record.
request attributes Contains all attributes requested from the search that are present on the peer record.

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`protocol`	`ProtocolDescriptorList`
`attributes`	`vector<Attribute>[512]`

Response

<EMPTY>

Profile

Service provides Bluetooth BR/EDR profiles a way to register a service definition, making a profile discoverable by peers. Registered services can receive L2CAP connections made to the advertised records, and can open new connections on peers.

Advertise

The call will resolve when the service advertisement terminates or if there was an error when advertising.

These services will be discoverable via Service Discovery Protocol server. All services advertising the same channel must be added at once - if services are already registered on any channel advertised, registration will fail, the receiver will be closed with ZX_ERR_ALREADY_BOUND and an error will be returned. The ConnectionReceiver will get calls for connections to the channels included in the protocol_descriptor or alternative_protocol_descriptors in the services advertised. The receiver will be closed if there are any errors advertising.

If the advertisement cannot be made for any reason, an error of INVALID_ARGUMENTS will be returned and the receiver will be closed with a suitable epitaph.

Request

Name	Type
`services`	`vector<ServiceDefinition>[32]`
`parameters`	`ChannelParameters`
`receiver`	`ConnectionReceiver`

Response

Name	Type
`result`	`Profile_Advertise_Result`

Connect

Connect an L2CAP or RFCOMM channel to the connected peer identified by peer_id using the desired connection parameters listed. Dynamic PSMs can be specified in connection.

Returns the channel connected once established, or an error code if the channel could not be connected.

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`connection`	`ConnectParameters`

Response

Name	Type
`result`	`Profile_Connect_Result`

ConnectSco

Attempt to establish a synchronous connection to peer_id configured using params.

If initiator is true, a connection request will be sent. Only 1 parameter may be specified.

If initiator is false, the host will attempt to accept the next connection request using the parameters given in order. The parameters will be tried in order until either a connection is successful, all parameters have been rejected (ScoErrorCode.PARAMETERS_REJECTED), or the procedure is canceled.

The result of the connection attempt and the parameters used for the connection will be returned with receiver. Dropping receiver will cancel the request.

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`initiator`	`bool`
`params`	`vector<ScoConnectionParameters>`
`receiver`	`ScoConnectionReceiver`

Search

Register a search for services on newly connected peers. The SearchResults protocol will be used to report results for this search. Any service result with a service matching service_uuid will be returned with the additional attributes in attr_ids. If attr_ids is empty, all attributes will be requested. The additional attribute BLUETOOTH_PROTOCOL_DESCRIPTOR_LIST is always requested. See the Bluetooth Spec v5.2, Vol 3, Part B, Section 5) and relevant profile specification documents.

Request

Name	Type
`service_uuid`	`ServiceClassProfileIdentifier`
`attr_ids`	`vector<uint16>[512]`
`results`	`SearchResults`

ProfileTest

Defined in fuchsia.bluetooth.bredr/profile_test.fidl

The ProfileTest interface should be used to validate behavior of Bluetooth Profiles that use the fuchsia.bluetooth.bredr.Profile service.

The ProfileTest interface is used to create and manage fake peers. A mock piconet is created in which registered peers can discover and interact with each other.

RegisterPeer

Creates a new fake peer in the Profile Test Server database. An empty response is sent to indicate when registration is complete.

Use the provided PeerObserver interface to observe behavior of the registered peer. Dropping the observer will cease the updates from the server for the associated peer.

If registration is unsuccessful, the peer and observer will be closed.

request peer_id Identifier for the created peer.
request peer Handle that can be used to drive peer behavior using the fuchsia.blueooth.bredr.MockPeer interface.
request observer Relay for communicating updates from the mock peer.

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`peer`	`request<MockPeer>`
`observer`	`PeerObserver`

Response

<EMPTY>

ScoConnectionReceiver

Represents an active synchronous connection request by a profile. Either Connected() or Error() will be called and then server will close the protocol.

Connected

Called upon successful connection establishment. params contains the parameters that were used to establish the connection.

Request

Name	Type
`connection`	`ScoConnection`
`params`	`ScoConnectionParameters`

Error

Called when connection establishment fails or is cancelled by the host.

Request

Name	Type
`error`	`ScoErrorCode`

SearchResults

Represents an active search which can produce results when peers are connected. Closing this protocol will result in the associated search not being performed on new connected peers.

ServiceFound

Called when a search this client added finds a matching service on a peer. peer_id is the peer the service was found on. protocol includes the ProtocolDescriptorList in the service record if it exists (it is also included in attributes.) attributes contains all attributes requested from the search that are present on the peer record. It may also include additional attributes. Each ServiceFound call should be acknowledged by replying. A limited amount of unacknowledged results will be sent on the channel. Results may be dropped if results are received while too many results are unacknowledged.

Request

Name	Type
`peer_id`	`fuchsia.bluetooth/PeerId`
`protocol`	`ProtocolDescriptorList`
`attributes`	`vector<Attribute>[512]`

Response

<EMPTY>

STRUCTS

Attribute

A generic attribute, used for protocol information;

Name	Type	Description	Default
`id`	`uint16`		No default
`element`	`DataElement`		No default

AudioDirectionExt_SetPriority_Response

<EMPTY>

MockPeer_LaunchProfile_Response

Defined in fuchsia.bluetooth.bredr/profile_test.fidl

<EMPTY>

ProfileDescriptor

A description of a profile that this service conforms to. See Bluetooth Specification v5.2 Vol 3, Part B, Section 5.1.11

Name	Type	Default
`profile_id`	`ServiceClassProfileIdentifier`	No default
`major_version`	`uint8`	No default
`minor_version`	`uint8`	No default

Profile_Advertise_Response

<EMPTY>

Profile_Connect_Response resource

Name	Type	Description	Default
`channel`	`Channel`		No default

ProtocolDescriptor

Identifies a communications protocol along with protocol-specific parameters. Usually used to describe a protocol endpoint in a ProtocolDescriptorList

Name	Type	Description	Default
`protocol`	`ProtocolIdentifier`		No default
`params`	`vector<DataElement>[255]`		No default

ENUMS

A2dpDirectionPriority strict

Type: uint32

A2DP packet priority used in AudioDirectionExt. NORMAL should be used whenever audio is not streaming, and SOURCE/SINK should match the direction audio is being streamed.

Name	Value	Description
`NORMAL`	`1`
`SOURCE`	`2`
`SINK`	`3`

ChannelMode strict

Type: uint32

Used to specify preferred and accepted L2CAP channel modes. If the peer rejects a non-BASIC mode, the Bluetooth system will attempt to open the channel in BASIC mode instead. For a description of each mode, see Bluetooth Spec v5.2, Vol 3, Part A, Sec 2.4.

Name	Value	Description
`BASIC`	`1`
`ENHANCED_RETRANSMISSION`	`2`

CodingFormat strict

Type: uint8

The coding format used for synchronous connection data.

Name	Value	Description
`MULAW`	`1`
`ALAW`	`2`
`CVSD`	`3`
`TRANSPARENT`	`4`
`LINEAR_PCM`	`5`
`MSBC`	`6`

DataPath strict

Type: uint8

Indicates the audio transport that should be used for the data on a synchronous connection.

Name	Value	Description
`HOST`	`1`	The HCI transport.
`OFFLOAD`	`2`	Transport audio data directly between the controller and the audio hardware.
`TEST`	`3`	The audio test mode transport. See Core Spec v5.2, Vol 4, Part E, Section 7.6.2 for details.

HfpParameterSet strict

Type: uint8

Codec parameter sets defined in the Hands-Free Profile specification (v1.8, section 5.7).

Name	Value	Description
`MSBC_T1`	`1`
`MSBC_T2`	`2`
`CVSD_S1`	`3`
`CVSD_S2`	`4`
`CVSD_S3`	`5`
`CVSD_S4`	`6`
`CVSD_D0`	`7`
`CVSD_D1`	`8`

ProtocolIdentifier strict

Type: uint16

Defined Protocol Identifiers for the Protocol Descriptor We intentionally omit deprecated profile identifiers. From Bluetooth Assigned Numbers: https://www.bluetooth.com/specifications/assigned-numbers/service-discovery

Name	Value	Description
`SDP`	`1`
`RFCOMM`	`3`
`ATT`	`7`
`OBEX`	`8`
`BNEP`	`15`
`HIDP`	`17`
`HARDCOPY_CONTROL_CHANNEL`	`18`
`HARDCOPY_DATA_CHANNEL`	`20`
`HARDCOPY_NOTIFICATION`	`22`
`AVCTP`	`23`
`AVDTP`	`25`
`MCAP_CONTROL_CHANNEL`	`30`
`MCAP_DATA_CHANNEL`	`31`
`L2CAP`	`256`

ScoErrorCode strict

Type: uint32

Name	Value	Description
`FAILURE`	`1`
`CANCELLED`	`2`
`INVALID_ARGUMENTS`	`3`
`PARAMETERS_REJECTED`	`4`

ServiceClassProfileIdentifier strict

Type: uint16

Identifiers that are valid for Bluetooth Classes / Profiles. We intentionally omit classes and profile IDs that are unsupported, deprecated, or reserved for use by Fuchsia Bluetooth. These numbers are sourced from the Bluetooth Assigned Numbers for SDP. https://www.bluetooth.com/specifications/assigned-numbers/service-discovery

Name	Value	Description
`SERIAL_PORT`	`4353`	Serial Port Profile (SPP)
`DIALUP_NETWORKING`	`4355`	Dial-up Networking Profile (DUN)
`OBEX_OBJECT_PUSH`	`4357`	Object Push Profile (OPP)
`OPEX_FILE_TRANSFER`	`4358`	File Transfer Profile (FTP)
`HEADSET`	`4360`	Headset Profile (HSP)
`HEADSET_AUDIO_GATEWAY`	`4370`
`HEADSET_HS`	`4401`
`AUDIO_SOURCE`	`4362`	Advanced Audio Distribution Profile (A2DP)
`AUDIO_SINK`	`4363`
`ADVANCED_AUDIO_DISTRIBUTION`	`4365`
`AV_REMOTE_CONTROL_TARGET`	`4364`	Audio/Video Remote Control Profile (AVRCP)
`AV_REMOTE_CONTROL`	`4366`
`AV_REMOTE_CONTROL_CONTROLLER`	`4367`
`PANU`	`4373`	Personal Area Networking (PAN)
`NAP`	`4374`
`GN`	`4375`
`HANDSFREE`	`4382`	Hands-Free Profile (HFP)
`HANDSFREE_AUDIO_GATEWAY`	`4383`
`SIM_ACCESS`	`4397`	Sim Access Profile (SAP)
`PHONEBOOK_PCE`	`4398`	Phonebook Access Profile (PBAP)
`PHONEBOOK_PSE`	`4399`
`PHONEBOOK`	`4400`
`MESSAGE_ACCESS_SERVER`	`4402`	Message Access Profile (MAP)
`MESSAGE_NOTIFICATION_SERVER`	`4403`
`MESSAGE_ACCESS_PROFILE`	`4404`
`MPS_PROFILE`	`4410`	Multi-Profile Specification (MPS)
`MPS_CLASS`	`4411`
`PNP_INFORMATION`	`4608`	Device Identification Profile (DI)
`GENERIC_NETWORKING`	`4609`	Generic Networking
`GENERIC_FILE_TRANSFER`	`4610`	Generic File Transfer
`GENERIC_AUDIO`	`4611`	Generic Audio
`GENERIC_TELEPHONY`	`4612`	Generic Telephony
`VIDEO_SOURCE`	`4867`	Video Distribution Profile (VDP)
`VIDEO_SINK`	`4868`
`VIDEO_DISTRIBUTION`	`4869`
`HDP`	`5120`	Health Device Profile (HDP)
`HDP_SOURCE`	`5121`
`HDP_SINK`	`5122`

TABLES

Channel resource

A channel opened to a peer.

Ordinal	Name	Type	Description
1	`socket`	`handle<socket>`	Socket interface for sending/receiving SDUs on the channel. Always present.
2	`channel_mode`	`ChannelMode`	Channel mode accepted by the peer. Always present.
3	`max_tx_sdu_size`	`uint16`	Maximum SDU size the peer is capable of accepting. Always present.
4	`ext_direction`	`AudioDirectionExt`	Audio Direction priority extension. See `AudioDirectionExt`. Present only if supported by the host.
5	`flush_timeout`	`zx/duration`
6	`ext_l2cap`	`L2capParametersExt`	L2CAP parameter extension. See `L2capParametersExt`. Always present for L2CAP Channels, never present for other Channels.

ChannelParameters

Used to specify preferred L2CAP channel parameters.

Ordinal	Name	Type	Description
1	`channel_mode`	`ChannelMode`	Optional. If not provided, BASIC will be used.
2	`max_rx_sdu_size`	`uint16`	Maximum SDU size this profile is capable of accepting. Must be >= 48. Optional. If not provided, the size will be determined by the Bluetooth system. No guarantees are given regarding the size selected.
3	`security_requirements`	`SecurityRequirements`	Minimum security requirements a link must have before this channel can be created. The requirements provided here will be attempted with the peer before the channel is established. If a peer cannot provide the requirements, the channel is closed. Optional. If not provided, then the only security property guaranteed is encryption.
4	`flush_timeout`	`zx/duration`	The flush timeout indicates the maximum amount of time a data packet should be buffered in the controller before it is dropped. A flush timeout of infinity can be used to mark packets as flushable without any particular flush timeout. Range: 1ms - 1,279ms (or ∞). Rounded down. Optional. If not provided, no flush timeout and packets are not flushable.

Information

Human-readable information about a service. Strings are encoded in UTF-8. See Bluetooth Specification v5.2 Vol 3, Part B, Sections 5.1.15 through 5.1.17

Ordinal	Name	Type	Description
1	`language`	`string[2]`	Language that the other fields in this table are in. Must be two characters long and a valid ICO 639:1988 identifier. Must be present.
2	`name`	`string[1024]`	Service name
3	`description`	`string[1024]`	A human-readable description
4	`provider`	`string[1024]`	The provider of this service (person or organization)

L2capParameters

The parameters associated with a connection over the L2CAP protocol.

Ordinal	Name	Type	Description
1	`psm`	`uint16`	Required. Dynamic PSM for the connection. See the defined PSMs in `service.fidl`.
2	`parameters`	`ChannelParameters`	Optional. L2CAP channel parameters.

LaunchInfo

Defined in fuchsia.bluetooth.bredr/profile_test.fidl

Information used to launch a profile component.

Ordinal	Name	Type	Description
1	`component_url`	`fuchsia.sys/component_url`	Required. The location from which to retrieve this component.
2	`arguments`	`vector<string>`	Optional. The arguments to be provided to the component.

RfcommParameters

The parameters associated with a connection over the RFCOMM protocol.

Ordinal	Name	Type	Description
1	`channel`	`RfcommChannel`	Required. RFCOMM channel for the connection.

ScoConnection resource

Ordinal	Name	Type	Description
1	`socket`	`handle<socket>`	Socket for transmitting/receiving data over the synchronous connection. Closing the socket will close the connection. If audio is offloaded, data written to the socket will be dropped and reads will fail.

ScoConnectionParameters

Ordinal	Name	Type	Description
1	`parameter_set`	`HfpParameterSet`	Set of SCO parameters from the Hands-Free Profile specification. Required.
2	`air_coding_format`	`CodingFormat`	The over-the-air coding format used for transmitted and received data. Required.
3	`air_frame_size`	`uint16`	Frame size produced by the codec in the context of over-the-air coding. Required.
4	`io_bandwidth`	`uint32`	Host-controller data rate in bytes/second. Required.
5	`io_coding_format`	`CodingFormat`	The coding format used over the transport. Required.
6	`io_frame_size`	`uint16`	The number of bits in each sample/frame of data. Required.
7	`io_pcm_data_format`	`fuchsia.hardware.audio/SampleFormat`	The data format over the transport for linear samples. Ignored for non-linear coding formats. Optional. SIGNED indicates 2's complement sign encoding. FLOAT is not supported.
8	`io_pcm_sample_payload_msb_position`	`uint8`	For linear samples, indicates how many bit positions the MSB of the sample is away from the MSB of the data. Ignored for non-linear coding formats. Optional. Default: 0.
9	`path`	`DataPath`	The data transport. Required.

SecurityRequirements

Authentication and permission requirements to access an advertised service.

Ordinal	Name	Type	Description
1	`authentication_required`	`bool`	If present and true, the physical link must be authenticated with man-in-the-middle attack protection to access this service. If missing, authentication is not required.
2	`secure_connections_required`	`bool`	If present and true, the physical link must be encrypted with a Secure Connections key to access this service if the host is capable. Advertisement will fail if the host does not support Secure Connections. See Bluetooth Spec v5.2, Vol 3, Part C, Sec 5.2.2.8.

ServiceDefinition

Definition for a service that is to be advertised as available via Bluetooth BR/EDR.

Ordinal	Name	Type	Description
1	`service_class_uuids`	`vector<fuchsia.bluetooth/Uuid>[255]`	UUIDs of service classes that this service record conforms to. This field is required - all advertised services must have at least one service class.
2	`protocol_descriptor_list`	`ProtocolDescriptorList`	Specification for the primary protocol that can be used to gain access to this service, with their protocol-specific identifiers. This is ordered from lowest level (typically L2CAP) to highest.
3	`additional_protocol_descriptor_lists`	`vector<vector<ProtocolDescriptor>>[255]`	Additional protocol descriptor lists, if the service requires more channels in addition to the main service.
4	`profile_descriptors`	`vector<ProfileDescriptor>[255]`	Bluetooth profiles that are supported by this service.
5	`information`	`vector<Information>[85]`	Human-readable service information, in one or more languages. The first set of information is considered the primary language.
6	`additional_attributes`	`vector<Attribute>[65023]`	Additional attributes to be included in the Service Definition for specific services or profiles. All of these attributes should have an Attribute ID above 0x0200.

UNIONS

AudioDirectionExt_SetPriority_Result strict

Name	Type	Description
`response`	`AudioDirectionExt_SetPriority_Response`
`err`	`fuchsia.bluetooth/ErrorCode`

ConnectParameters strict

The channel and relevant parameters for a connection.

Name	Type	Description
`l2cap`	`L2capParameters`	An L2CAP connection.
`rfcomm`	`RfcommParameters`	An RFCOMM connection.

DataElement strict

A DataElement is one element in a SDP record. SDP attributes and other parameters are expresssed in DataElements.

Name	Type	Description
`int8`	`int8`
`int16`	`int16`
`int32`	`int32`
`int64`	`int64`
`uint8`	`uint8`
`uint16`	`uint16`
`uint32`	`uint32`
`uint64`	`uint64`
`str`	`string[1024]`
`url`	`fuchsia.url/Url`
`uuid`	`fuchsia.bluetooth/Uuid`
`b`	`bool`
`sequence`	`vector<DataElement>[255]`
`alternatives`	`vector<DataElement>[255]`

MockPeer_LaunchProfile_Result strict

Defined in fuchsia.bluetooth.bredr/profile_test.fidl

Name	Type	Description
`response`	`MockPeer_LaunchProfile_Response`
`err`	`fuchsia.bluetooth/ErrorCode`

Profile_Advertise_Result strict

Name	Type	Description
`response`	`Profile_Advertise_Response`
`err`	`fuchsia.bluetooth/ErrorCode`

Profile_Connect_Result strict resource