Revision as of 01:11, 20 January 2021

btdrv

This is "nn::bluetooth::IBluetoothDriver".

Support for "nn::bluetooth::*" was added to sdknso with 6.x.

btdrv appears to be designed to only be used by the two sysmodules which use it, hid and btm. This service uses global state, nothing service-session-specific.

This has max_sessions 30. IPC handling is done by the main-thread.

As of 10.x these services only support using Hid and BLE devices, other devices such as audio are not usable.

[11.0.0+] sdknso moved various functions/etc from "nn::bluetooth::" into "nn::bluetooth::hal::". This includes all functions exposing btdrv. These btdrv functions now automatically initialize the service if needed, the dedicated initialization function is now a stub since calling it is no longer needed. The internal "nn::bluetooth::user::" functions implementing #bt were moved to "nn::bluetooth::hal::user::", these are called by the the user-facing "nn::bluetooth::" functions.

Cmd	Name
0	#InitializeBluetoothDriver
1	#InitializeBluetooth
2	#EnableBluetooth
3	#DisableBluetooth
4	#FinalizeBluetooth ([?-8.1.1] CleanupBluetooth)
5	#GetAdapterProperties
6	#GetAdapterProperty
7	#SetAdapterProperty
8	#StartInquiry ([?-8.1.1] StartDiscovery)
9	#StopInquiry ([?-8.1.1] CancelDiscovery)
10	#CreateBond
11	#RemoveBond
12	#CancelBond
13	#RespondToPinRequest ([?-8.1.1] PinReply)
14	#RespondToSspRequest ([?-8.1.1] SspReply)
15	#GetEventInfo
16	#InitializeHid
17	#OpenHidConnection ([?-8.1.1] HidConnect)
18	#CloseHidConnection ([?-8.1.1] HidDisconnect)
19	#WriteHidData ([?-8.1.1] HidSendData)
20	#WriteHidData2 ([?-8.1.1] HidSendData2)
21	#SetHidReport ([?-8.1.1] #HidSetReport)
22	#GetHidReport ([?-8.1.1] HidGetReport)
23	#TriggerConnection ([?-8.1.1] #HidWakeController)
24	#AddPairedDeviceInfo ([?-8.1.1] HidAddPairedDevice)
25	#GetPairedDeviceInfo ([?-8.1.1] HidGetPairedDevice)
26	#FinalizeHid ([?-8.1.1] CleanupHid)
27	#GetHidEventInfo ([?-8.1.1] HidGetEventInfo)
28	#SetTsi ([?-8.1.1]] ExtSetTsi)
29	#EnableBurstMode ([?-8.1.1] ExtSetBurstMode)
30	#SetZeroRetransmission ([?-8.1.1] ExtSetZeroRetran)
31	#EnableMcMode ([?-8.1.1] ExtSetMcMode)
32	#EnableLlrScan ([?-8.1.1] ExtStartLlrMode)
33	#DisableLlrScan ([?-8.1.1] ExtExitLlrMode)
34	#EnableRadio ([?-8.1.1] ExtSetRadio)
35	#SetVisibility ([?-8.1.1] ExtSetVisibility)
36	[4.0.0+] #EnableTbfcScan ([4.0.0-8.1.1] ExtSetTbfcScan)
37 ([1.0.0-3.0.2] 36)	#RegisterHidReportEvent
38 ([1.0.0-3.0.2] 37)	#GetHidReportEventInfo ([?-8.1.1] HidGetReportEventInfo)
39 ([1.0.0-3.0.2] 38)	#GetLatestPlr
40 ([3.0.0-3.0.2] 39)	[3.0.0+] #GetPendingConnections ([?-8.1.1] ExtGetPendingConnections)
41 ([3.0.0-3.0.2] 40)	[3.0.0+] #GetChannelMap
42 ([3.0.0-3.0.2] 41)	[3.0.0+] #EnableTxPowerBoostSetting ([?-8.1.1] EnableBluetoothBoostSetting)
43 ([3.0.0-3.0.2] 42)	[3.0.0+] #IsTxPowerBoostSettingEnabled ([?-8.1.1] IsBluetoothBoostSettingEnabled)
44 ([3.0.0-3.0.2] 43)	[3.0.0+] #EnableAfhSetting ([?-8.1.1] EnableBluetoothAfhSetting)
45 ([3.0.0-3.0.2] 44)	[3.0.0+] #IsAfhSettingEnabled ([?-8.1.1] IsBluetoothAfhSettingEnabled)
46	[5.0.0+] #InitializeBle ([5.0.0-8.1.1] InitializeBluetoothLe)
47	[5.0.0+] #EnableBle ([5.0.0-8.1.1] EnableBluetoothLe)
48	[5.0.0+] #DisableBle ([5.0.0-8.1.1] DisableBluetoothLe)
49	[5.0.0+] #FinalizeBle ([5.0.0-8.1.1] CleanupBluetoothLe)
50	[5.0.0+] #SetBleVisibility ([5.0.0-8.1.1] SetLeVisibility)
51	[5.0.0+] #SetBleConnectionParameter ([5.0.0-8.1.1] #SetLeConnectionParameter)
52	[5.0.0+] #SetBleDefaultConnectionParameter ([5.0.0-8.1.1] #SetLeDefaultConnectionParameter)
53	[5.0.0+] #SetBleAdvertiseData ([5.0.0-8.1.1] SetLeAdvertiseData)
54	[5.0.0+] #SetBleAdvertiseParameter ([5.0.0-8.1.1] SetLeAdvertiseParameter)
55	[5.0.0+] #StartBleScan ([5.0.0-8.1.1] StartLeScan)
56	[5.0.0+] #StopBleScan ([5.0.0-8.1.1] StopLeScan)
57	[5.0.0+] #AddBleScanFilterCondition ([5.0.0-8.1.1] AddLeScanFilterCondition)
58	[5.0.0+] #DeleteBleScanFilterCondition ([5.0.0-8.1.1] DeleteLeScanFilterCondition)
59	[5.0.0+] #DeleteBleScanFilter ([5.0.0-8.1.1] DeleteLeScanFilter)
60	[5.0.0+] #ClearBleScanFilters ([5.0.0-8.1.1] ClearLeScanFilters)
61	[5.0.0+] #EnableBleScanFilter ([5.0.0-8.1.1] EnableLeScanFilter)
62	[5.0.0+] #RegisterGattClient ([5.0.0-8.1.1] RegisterLeClient)
63	[5.0.0+] #UnregisterGattClient ([5.0.0-8.1.1] UnregisterLeClient)
64	[5.0.0+] #UnregisterAllGattClients ([5.0.0-8.1.1] UnregisterLeClientAll)
65	[5.0.0+] #ConnectGattServer ([5.0.0-8.1.1] LeClientConnect)
66	[5.1.0+] #CancelConnectGattServer ([5.1.0-8.1.1] LeClientCancelConnection)
67 ([5.0.0-5.0.2] 66)	[5.0.0+] #DisconnectGattServer ([?-8.1.1] LeClientCancelConnection)
68 ([5.0.0-5.0.2] 67)	[5.0.0+] #GetGattAttribute ([5.0.0-8.1.1] LeClientGetAttributes)
69 ([5.0.0-5.0.2] 68)	[5.0.0+] #GetGattService ([5.0.0-8.1.1] LeClientDiscoverService)
70 ([5.0.0-5.0.2] 69)	[5.0.0+] #ConfigureAttMtu ([5.0.0-8.1.1] LeClientConfigureMtu)
71 ([5.0.0-5.0.2] 70)	[5.0.0+] #RegisterGattServer ([5.0.0-8.1.1] RegisterLeServer)
72 ([5.0.0-5.0.2] 71)	[5.0.0+] #UnregisterGattServer ([5.0.0-8.1.1] UnregisterLeServer)
73 ([5.0.0-5.0.2] 72)	[5.0.0+] #ConnectGattClient ([5.0.0-8.1.1] LeServerConnect)
74 ([5.0.0-5.0.2] 73)	[5.0.0+] #DisconnectGattClient ([5.0.0-8.1.1] #LeServerDisconnect)
75	[5.0.0+] #AddGattService ([5.0.0-8.1.1] CreateLeService)
76 ([5.0.0-5.0.2] 74)	[5.0.0+] #EnableGattService ([5.0.0-8.1.1] StartLeService)
77	[5.0.0+] #AddGattCharacteristic ([5.0.0-8.1.1] AddLeCharacteristic)
78 ([5.0.0-5.0.2] 76)	[5.0.0+] #AddGattDescriptor ([5.0.0-8.1.1] AddLeDescriptor)
79 ([5.0.0-5.0.2] 78)	[5.0.0+] #GetBleManagedEventInfo ([5.0.0-8.1.1] GetLeCoreEventInfo)
80 ([5.0.0-5.0.2] 79)	[5.0.0+] #GetGattFirstCharacteristic ([5.0.0-8.1.1] LeGetFirstCharacteristic)
81 ([5.0.0-5.0.2] 80)	[5.0.0+] #GetGattNextCharacteristic ([5.0.0-8.1.1] LeGetNextCharacteristic)
82 ([5.0.0-5.0.2] 81)	[5.0.0+] #GetGattFirstDescriptor ([5.0.0-8.1.1] LeGetFirstDescriptor)
83 ([5.0.0-5.0.2] 82)	[5.0.0+] #GetGattNextDescriptor ([5.0.0-8.1.1] LeGetNextDescriptor)
84	[5.0.0+] #RegisterGattManagedDataPath ([5.0.0-8.1.1] RegisterLeCoreDataPath)
85	[5.0.0+] #UnregisterGattManagedDataPath ([5.0.0-8.1.1] UnregisterLeCoreDataPath)
86	[5.0.0+] #RegisterGattHidDataPath ([5.0.0-8.1.1] RegisterLeHidDataPath)
87	[5.0.0+] #UnregisterGattHidDataPath ([5.0.0-8.1.1] UnregisterLeHidDataPath)
88	[5.0.0+] #RegisterGattDataPath ([5.0.0-8.1.1] RegisterLeDataPath)
89 ([5.0.0-5.0.2] 83)	[5.0.0+] #UnregisterGattDataPath ([5.0.0-8.1.1] UnregisterLeDataPath)
90 ([5.0.0-5.0.2] 89)	[5.0.0+] #ReadGattCharacteristic ([5.0.0-8.1.1] LeClientReadCharacteristic)
91 ([5.0.0-5.0.2] 90)	[5.0.0+] #ReadGattDescriptor ([5.0.0-8.1.1] LeClientReadDescriptor)
92 ([5.0.0-5.0.2] 91)	[5.0.0+] #WriteGattCharacteristic ([5.0.0-8.1.1] LeClientWriteCharacteristic)
93 ([5.0.0-5.0.2] 92)	[5.0.0+] #WriteGattDescriptor ([5.0.0-8.1.1] LeClientWriteDescriptor)
94	[5.0.0+] #RegisterGattNotification ([5.0.0-8.1.1] LeClientRegisterNotification)
95 ([5.0.0-5.0.2] 93)	[5.0.0+] #UnregisterGattNotification ([5.0.0-8.1.1] LeClientDeregisterNotification)
96 ([5.0.0-5.0.2] 95)	[5.0.0+] #GetLeHidEventInfo
97 ([5.0.0-5.0.2] 96)	[5.0.0+] #RegisterBleHidEvent
98	[5.1.0+] #SetBleScanParameter ([5.1.0-8.1.1] SetLeScanParameter)
99	[10.0.0+] #MoveToSecondaryPiconet
256	[5.0.0+] #IsManufacturingMode
257	[7.0.0+] #EmulateBluetoothCrash
258	[9.0.0+] #GetBleChannelMap

Cmds 46-83 were added with [4.0.0+].

Various cmds were moved/etc starting with #InitializeBle with [5.0.0+].

InitializeBluetoothDriver

No input/output.

[1.0.0-10.2.0] This is the first cmd used during service init.

This just returns 0.

InitializeBluetooth

No input, returns an output Event handle with EventClearMode=1.

This is used by btm, this should not be used by other processes.

EnableBluetooth

No input/output.

This is used by btm.

DisableBluetooth

No input/output.

This is used by btm.

FinalizeBluetooth

No input/output.

Not used by btm, other processes should not use this.

GetAdapterProperties

Takes a type-0x1A output buffer containing an #AdapterProperty.

This is used by btm.

GetAdapterProperty

Takes an input #BluetoothPropertyType and a type-0xA output buffer.

SetAdapterProperty

Takes an input #BluetoothPropertyType and a type-0x9 input buffer.

StartInquiry

No input/output.

This is used by btm.

This starts Inquiry, the output data will be available via #GetEventInfo. Inquiry will automatically stop in 10.24 seconds.

StopInquiry

No input/output.

This is used by btm.

This stops Inquiry which was started by #StartInquiry, if it's still active.

CreateBond

Takes an input #Address and a type-0x19 input buffer containing a #TransportType, no output.

[9.0.0+] Now only takes an #Address and a #TransportType without a buffer, no output.

The #TransportType is unused.

This is used by btm.

RemoveBond

Takes an input #Address, no output.

This is used by btm.

CancelBond

Takes an input #Address, no output.

This is used by btm.

RespondToPinRequest

Takes an input #Address, a bool, an u8, a #BluetoothPinCode, no output.

sdknso uses an user-specified s32 for the u8.

The sysmodule impl for the funcptr used with this cmd only uses the #Address - this and hard-coded string "0000" are written into the parameter struct (and a size field for the string).

RespondToSspRequest

Takes an input #Address, a #BluetoothSspVariant, a bool, an u32, no output.

This is used by btm.

The sysmodule impl for the funcptr used with this cmd only uses the #Address and bool - the parameter struct size is only 0x7-bytes.

GetEventInfo

Takes a type-0xA output buffer and returns an output #EventType.

This copies 0x400-bytes from state to the output buffer, copies the #EventType from state to output, and signals an event.

This is used by btm.

See #EventInfo.

InitializeHid

Takes an input u16, returns an output Event with EventClearMode=1.

Originally sdknso used an user-specified value for the u16, however with [9.0.0+] it uses hard-coded value 0x1 instead.

This is used by btm, this should not be used by other processes.

OpenHidConnection

Takes an input #Address, no output.

This just returns 0.

This is used by btm.

CloseHidConnection

Takes an input #Address, no output.

This is used by btm.

HidSendData

Takes an input #Address and a type-0x19 input buffer containing a #HidData, no output.

WriteHidData

Takes an input #Address and a type-0x19 input buffer containing a #HidReport, no output.

This is used by hid.

This sends a HID DATA transaction packet with report-type Output.

WriteHidData2

Takes an input #Address and a type-0x9 input buffer, no output.

This is internally the same as #WriteHidData, with the input buffer being directly passed to the funcptr instead of a tmp copy of the input #HidReport.

HidSetReport

Takes an input #Address, a #BluetoothHhReportType, a type-0x19 input buffer containing a #HidData, no output.

SetHidReport

Takes an input #Address, a #BluetoothHhReportType, a type-0x19 input buffer containing a #HidReport, no output.

This is used by hid.

This sends a HID SET_REPORT transaction packet.

GetHidReport

Takes an input #Address, an u8 report_id, a #BluetoothHhReportType, no output.

This is used by hid.

This sends a HID GET_REPORT transaction packet. The report_id is sent in the packet for the Report Id, when non-zero.

HidWakeController

Takes an input #Address, no output.

TriggerConnection

Takes an input #Address and an u16, no output.

This is used by btm.

AddPairedDeviceInfo

Takes a type-0x19 input buffer containing BluetoothDevicesSettings, no output.

This is used by btm.

GetPairedDeviceInfo

Takes an input #Address and a type-0x1A output buffer containing BluetoothDevicesSettings.

This is used by btm.

FinalizeHid

No input/output.

Not used by btm, other processes should not use this.

GetHidEventInfo

Takes a type-0xA output buffer, returns an output #HidEventType.

This copies 0x480-bytes from state to the output buffer. #HidEventType is set to: stateval!=0 ? 7 : 0. Once finished, this signals an event.

This is used by btm.

SetTsi

Takes an input #Address and an u8 Tsi, no output.

This is used by btm.

The response will be available via #GetHidEventInfo.

Tsi: non-value-0xFF to Set, value 0xFF to Exit.

EnableBurstMode

Takes an input #Address and a bool, no output.

This is used by btm.

The response will be available via #GetHidEventInfo.

bool flag: true = Set, false = Exit.

SetZeroRetransmission

Takes an input #Address and a type-0x9 input buffer containing an array of u8s, no output.

The entry-count is clamped to a maximum of 5, the count can be 0. This buffer contains ReportIds.

This is used by btm.

The response will be available via #GetHidEventInfo.

EnableMcMode

Takes an input bool, no output.

This is used by btm.

EnableLlrScan

No input/output.

This is used by btm.

DisableLlrScan

No input/output.

This is used by btm.

EnableRadio

Takes an input bool, no output.

This is used by btm.

SetVisibility

Takes two input bools, no output.

This is used by btm.

EnableTbfcScan

Takes an input bool, no output.

This is used by btm.

RegisterHidReportEvent

No input, returns an output Event handle with EventClearMode=1.

This gets the Event handle for a previously created Event.

This is used by hid.

The Event is signaled when data is available with #GetHidReportEventInfo.

GetHidReportEventInfo

No input, takes a type-0xA output buffer and returns a #HidEventType.

[7.0.0+] No longer takes a buffer or returns output, now returns an output sharedmem handle. sdknso maps this with size=0x3000 and permissions=RW-.

Originally this was used in a dedicated sdknso func, with [7.0.0+] this is now used at the start of the sdknso impl for #RegisterHidReportEvent if the above sharedmem was not mapped yet.

The [7.0.0+] GetHidReportEventInfo sdknso func loads data using the above sharedmem.

This is used by hid.

GetLatestPlr

Takes a type-0x16 output buffer containing a #PlrList ([1.0.0-8.1.1] #PlrStatistics).

GetPendingConnections

No input/output.

This is used by btm.

The output data will be available via #GetHidEventInfo.

GetChannelMap

Takes a type-0x16 output buffer containing a #ChannelMapList.

EnableTxPowerBoostSetting

Takes an input bool, no output.

sdknso ignores errors from this. sdknso exposes this under "nn::bluetooth::debug::".

IsTxPowerBoostSettingEnabled

No input, returns an output bool.

sdknso sets the tmpout_bool to 1, and uses that with the cmd. The sdknso func directly returns tmpout_bool, errors from the cmd are ignored.

sdknso exposes this under "nn::bluetooth::debug::".

EnableAfhSetting

Takes an input bool, no output.

sdknso ignores errors from this. sdknso exposes this under "nn::bluetooth::debug::".

IsAfhSettingEnabled

sdknso sets the tmpout_bool to 1, and uses that with the cmd. The sdknso func directly returns tmpout_bool, errors from the cmd are ignored.

sdknso exposes this under "nn::bluetooth::debug::".

InitializeBle

No input, returns an output Event handle with EventClearMode=1.

This is used by btm.

EnableBle

No input/output.

This is used by btm.

DisableBle

No input/output.

This is used by btm.

FinalizeBle

No input/output.

SetBleVisibility

Takes two input bools, no output.

SetLeConnectionParameter

Takes a #LeConnectionParams, no output.

SetBleConnectionParameter

Takes an input #Address, a bool, a #BleConnectionParameter, no output.

This is used by btm.

SetLeDefaultConnectionParameter

Takes a #LeConnectionParams, no output.

SetBleDefaultConnectionParameter

Takes a #BleConnectionParameter, no output.

This is used by btm.

SetBleAdvertiseData

Takes a type-0x19 input buffer containing a #BleAdvertisePacketData, no output.

SetBleAdvertiseParameter

Takes an input #Address, two u16s, no output.

StartBleScan

No input/output.

This is used by btm.

StopBleScan

No input/output.

This is used by btm.

AddBleScanFilterCondition

Takes a type-0x19 input buffer containing a #BleAdvertiseFilter, no output.

This is used by btm.

DeleteBleScanFilterCondition

Takes a type-0x19 input buffer containing a #BleAdvertiseFilter, no output.

This is used by btm.

DeleteBleScanFilter

Takes an input u8, no output.

Originally the sdknso func used an u8 for the user-specified param, with [9.0.0+] it's a s32.

ClearBleScanFilters

No input/output.

This is used by btm.

EnableBleScanFilter

Takes an input bool, no output.

This is used by btm.

RegisterGattClient

Takes an input #GattAttributeUuid, no output.

This is used by btm.

UnregisterGattClient

Takes an input u8, no output.

UnregisterAllGattClients

No input/output.

ConnectGattServer

Takes an input u8, an #Address, a bool, an AppletResourceUserId, no output.

This is used by btm.

CancelConnectGattServer

Takes an input u8, an #Address, a bool, no output.

This is used by btm.

DisconnectGattServer

Takes an input u32, no output.

This is used by btm.

GetGattAttribute

Takes an #Address and an u32, no output.

[9.0.0+] Now takes an input u32, no output.

GetGattService

Takes an input u32 and a #GattAttributeUuid, no output.

ConfigureAttMtu

Takes an input u16 and u32, no output.

This is used by btm.

RegisterGattServer

Takes an input #GattAttributeUuid, no output.

UnregisterGattServer

Takes an input u8, no output.

ConnectGattClient

Takes an input u8, an #Address, a bool, no output.

LeServerDisconnect

Takes an input u8, an #Address, no output.

DisconnectGattClient

Takes an input u8, no output.

AddGattService

Takes an input u8, an u8, a bool, a #GattAttributeUuid, no output.

Originally sdknso used an user-specified u8 for the second u8, with [9.0.0+] that func param is now a s32.

EnableGattService

Takes an input u8, a #GattAttributeUuid, no output.

AddGattCharacteristic

Takes an input u8, an u8, an u16, a #GattAttributeUuid, a #GattAttributeUuid, no output.

AddGattDescriptor

Takes an input u8, an u16, a #GattAttributeUuid, a #GattAttributeUuid, no output.

GetBleManagedEventInfo

Takes a type-0xA output buffer, returns an output #BleEventType.

This copies 0x400-bytes from state to the output buffer, and copies the #BleEventType from state to output.

This is used by btm.

GetGattFirstCharacteristic

Takes an input bool, an u32, a #GattId, a #GattAttributeUuid, returns an output u8 Property and CharacteristicId.

GetGattNextCharacteristic

Takes an input bool, an u32, a #GattId, a #GattId, a #GattAttributeUuid, returns an output u8 Property and CharacteristicId.

GetGattFirstDescriptor

Takes an input bool, an u32, a #GattId, a #GattId, a #GattAttributeUuid, returns an output DescriptorId.

GetGattNextDescriptor

Takes an input bool, an u32, a #GattId, a #GattId, a #GattId, a #GattAttributeUuid, returns an output DescriptorId.

RegisterGattManagedDataPath

Takes an input #GattAttributeUuid, no output.

This is used by btm.

UnregisterGattManagedDataPath

Takes an input #GattAttributeUuid, no output.

RegisterGattHidDataPath

Takes an input #GattAttributeUuid, no output.

This is used by btm.

UnregisterGattHidDataPath

Takes an input #GattAttributeUuid, no output.

This is used by btm.

RegisterGattDataPath

Takes an input #GattAttributeUuid, no output.

This is used by btm.

UnregisterGattDataPath

Takes an input #GattAttributeUuid, no output.

This is used by btm.

ReadGattCharacteristic

Takes an input bool PrimaryService, an u8, an u32 ConnectionHandle, a #GattId, a #GattId, no output.

This is used by hid and btm.

ReadGattDescriptor

Takes an input bool PrimaryService, an u8, an u32 ConnectionHandle, a #GattId, a #GattId, a #GattId, no output.

This is used by hid.

WriteGattCharacteristic

Takes a type-0x9 input buffer, a bool PrimaryService, an u8, a bool, an u32 ConnectionHandle, a #GattId, a #GattId, no output.

The buffer size must be <=0x258.

This is used by hid and btm.

WriteGattDescriptor

Takes a type-0x9 input buffer, a bool PrimaryService, an u8, an u32 ConnectionHandle, a #GattId, a #GattId, a #GattId, no output.

The buffer size must be <=0x258.

This is used by hid and btm.

RegisterGattNotification

Takes an input bool, an u32 ConnectionHandle, a #GattId, a #GattId, no output.

This is used by hid and btm.

UnregisterGattNotification

Takes an input bool, an u32 ConnectionHandle, a #GattId, a #GattId, no output.

This is used by hid.

GetLeHidEventInfo

Takes a type-0xA output buffer, returns an output #BleEventType.

This copies 0x400-bytes from state to the output buffer, and copies the #BleEventType from state to output. This also resets the state which was used for the outbuf-copy. Once finished, this signals an event.

This is used by hid.

See #LeEventInfo for the output buffer.

RegisterBleHidEvent

No input, returns an output Event handle with EventClearMode=1.

This is used by hid.

SetBleScanParameter

Takes two input u16s, no output.

This is used by btm.

MoveToSecondaryPiconet

Takes an input #Address, no output.

The response will be available via #GetHidEventInfo.

IsManufacturingMode

No input, returns an output bool.

sdknso will Abort if this fails, the bool is returned instead of a Result. sdknso exposes this under "nn::bluetooth::debug::".

This calls the same two funcs as various other cmds etc. This writes the bool returned by the second func to output, then returns 0. The second func loads the bool from system-setting "bluetooth_debug!skip_boot". The first func is the same as the second one, except it writes the bool into global state.

This is used by btm.

EmulateBluetoothCrash

Takes an input #FatalReason, no output.

sdknso masks the FatalReason with an u16-mask before passing it to the cmd. sdknso exposes this under "nn::bluetooth::debug::".

This writes data into a CircularBuffer (seperate from sharedmem) with type=0x29, where the data is an u16 determined using the input #FatalReason. This is only done if a state field is value 0x3, after calling the func for this the field is set to value 0. The thread handling that sent message then converts the u16 back into a #FatalReason for writing into #EventInfo.

GetBleChannelMap

Takes a type-0x16 output buffer containing a #ChannelMapList.

bt

This is "nn::bluetooth::IBluetoothUser".

This has max_sessions 30. IPC handling is done by the main-thread.

Cmd	Name
0	#LeClientReadCharacteristic
1	#LeClientReadDescriptor
2	#LeClientWriteCharacteristic
3	#LeClientWriteDescriptor
4	#LeClientRegisterNotification
5	#LeClientDeregisterNotification
6	#SetLeResponse
7	#LeSendIndication
8	#GetLeEventInfo
9	#RegisterBleEvent

LeClientReadCharacteristic

Takes a PID, a bool, an u8, an u32, a #GattId, a #GattId, an AppletResourceUserId, no output.

This is essentially the same as #ReadGattCharacteristic, the AppletResourceUserId is unused.

LeClientReadDescriptor

Takes a PID, a bool, an u8, an u32, a #GattId, a #GattId, a #GattId, an AppletResourceUserId, no output.

This is essentially the same as #ReadGattDescriptor, the AppletResourceUserId is unused.

LeClientWriteCharacteristic

Takes a PID, a type-0x9 input buffer, a bool, an u8, a bool, an u32, a #GattId, a #GattId, an AppletResourceUserId, no output.

This is essentially the same as #WriteGattCharacteristic, the AppletResourceUserId is unused.

LeClientWriteDescriptor

Takes a PID, a type-0x9 input buffer, a bool, an u8, an u32, a #GattId, a #GattId, a #GattId, an AppletResourceUserId, no output.

This is essentially the same as #WriteGattDescriptor, the AppletResourceUserId is unused.

LeClientRegisterNotification

Takes a PID, an input bool, an u32, a #GattId, a #GattId, an AppletResourceUserId, no output.

This is essentially the same as #RegisterGattNotification, the AppletResourceUserId is unused.

LeClientDeregisterNotification

Takes a PID, an input bool, an u32, a #GattId, a #GattId, an AppletResourceUserId, no output.

This is essentially the same as #UnregisterGattNotification, the AppletResourceUserId is unused.

SetLeResponse

Takes a PID, a type-0x9 input buffer, an u8, a #GattAttributeUuid, a #GattAttributeUuid, an AppletResourceUserId, no output.

The AppletResourceUserId is unused.

The buffer size must be <=0x258.

LeSendIndication

Takes a PID, a type-0x9 input buffer, an u8, a bool, a #GattAttributeUuid, a #GattAttributeUuid, an AppletResourceUserId, no output.

The AppletResourceUserId is unused.

The buffer size used internally is clamped to max size 0x258.

GetLeEventInfo

Takes a PID, a type-0xA output buffer, an AppletResourceUserId, returns an output #BleEventType.

This is identical to #GetLeHidEventInfo except different state is used. The AppletResourceUserId is unused. See #LeEventInfo for the output buffer.

RegisterBleEvent

Takes a PID, an AppletResourceUserId, returns an output Event handle with EventClearMode=1.

This is identical to #RegisterBleHidEvent except different Event state is used. The AppletResourceUserId is unused.

BluetoothPropertyType

This is u32 enum "nn::bluetooth::BluetoothPropertyType".

The sysmodule will Abort if the input type is unavailable / not recognized.

Value	Description	Buffer contents
1	Name	String, max length 0xF8 excluding NUL-terminator.
2	Address	#Address
3		Only available with #SetAdapterProperty. Unknown, #Address. The default is the same as type2, with the last two bytes inverted.
5		3-bytes
6		1-byte. The default is value 0x68.

TransportType

This is u32 enum "nn::bluetooth::TransportType".

BluetoothSspVariant

This is u8 enum "nn::bluetooth::BluetoothSspVariant".

EventType

This is u32 enum "nn::bluetooth::EventType".

Value	Name	Description
0		The funcptr which writes the data into state for this event is not called (only checked on [10.0.0]).
3		New device found during Inquiry.
4		Inquiry status changed.
5		Triggered by BSA_SEC_PIN_REQ_EVT: PIN code request for pairing.
6		Triggered by BSA_SEC_SP_CFM_REQ_EVT/BSA_SEC_SP_KEY_NOTIF_EVT: SSP confirm request / SSP passkey notification.
7		Connection
13		BluetoothCrash. Triggered by #EmulateBluetoothCrash and BSA_MGT_DISCONNECT_EVT.

ConnectionEventType

This is the event value in #EventInfo when #EventType is type7.

Value	Name	Description
0		Connection status.
1		Triggered by BSA_SEC_SP_CFM_REQ_EVT: SSP confirm request.
2		Triggered by BSA_SEC_SUSPENDED_EVT: ACL Link is now Suspended.

BluetoothHhReportType

This is u32 enum "nn::bluetooth::BluetoothHhReportType".

Bit0-1 directly control the HID bluetooth transaction report-type value. Bit2-3: these directly control the Parameter Reserved field for SetReport, for GetReport these control the Parameter Reserved and Size bits.

Value	Description
0	Other
1	Input
2	Output
3	Feature

HidEventType

This is u32 enum "nn::bluetooth::HidEventType".

Value	Name	Description
0		Connection. Only used with #GetHidEventInfo.
4		DATA report on the Interrupt channel.
7		Response for extensions. Only used with #GetHidEventInfo.
8		Response to SET_REPORT.
9		Response to GET_REPORT.

BleEventType

This is u32 enum "nn::bluetooth::BleEventType".

FatalReason

This is u32 enum "nn::bluetooth::FatalReason".

This determines the u16 data to write into the CircularBuffer.

Value	Description
0	Only for #EventInfo: invalid.
1	u16 data = 0x850.
2	u16 data = 0x851.
Other values	u16 data = 0x852.
7	Only for #EventInfo: triggered after enabling bluetooth, when a global state field is value 4 or 2.

AdapterProperty

This is "nn::bluetooth::AdapterProperty". This is a 0x103-byte struct.

Offset	Size	Description
0x0	0x6	Same as the data for #BluetoothPropertyType type2.
0x6	0x3	Same as the data for #BluetoothPropertyType type5.
0x9	0xF9	Same as the data for #BluetoothPropertyType type1 (last byte is not initialized).
0x102	0x1	Set to hard-coded value 0x68 (same as the data for #BluetoothPropertyType type6).

Address

This is "nn::bluetooth::Address". This is a 0x6-byte struct with 1-byte alignment.

EventInfo

This is the output buffer for #GetEventInfo. The data stored here depends on the #EventType.

Type0:

Offset	Size	Description
0x0	0x4

Type3:

Offset	Size	Description
0x0	0xF9	Device name, NUL-terminated string.
0xF9	0x6	Device address.
0xFF	0x10
0x10F	0x3	Device class.
0x112	0x4	Set to fixed value u32 0x1.
0x116	0xFA
0x210	0x5C	Reserved
0x26C	0xF9	Device name, NUL-terminated string. Same as name above, except starting at index 1.
0x365	0x4	s32 RSSI
0x369	0x4	Two bytes which are the same as name[11-12].
0x36D	0x10	Reserved

Type4:

Offset	Size	Description
0x0	0x4	Status: 0 = stopped, 1 = started.

Type5:

Offset	Size	Description
0x0	0x6	Device address.
0x6	0xF9	Device name, NUL-terminated string.
0xFF	0x3	Device class.

Type6:

Offset	Size	Description
0x0	0x6	Device address.
0x6	0xF9	Device name, NUL-terminated string.
0xFF	0x3	Device class.
0x102	0x2	Padding
0x104	0x4	0 = SSP confirm request, 3 = SSP passkey notification.
0x108	0x4	s32 Passkey, only set when the above field is value 3.

Type7:

Offset	Size	Description
0x0	0x4	Status, always 0 except with event0: 2 = ACL Link is now Resumed (BSA_SEC_RESUMED_EVT), 9 = connection failed (pairing/authentication failed, or opening the hid connection failed).
0x4	0x6	Device address.
0xA	0x2	Padding
0xC	0x4	#ConnectionEventType

Type13:

Offset	Size	Description
0x0	0x2	#FatalReason

BluetoothPinCode

This is "nn::bluetooth::BluetoothPinCode". This is a 0x10-byte struct with 1-byte alignment.

HidData

This is "nn::bluetooth::HidData". This is a 0x282-byte struct.

Offset	Size	Description
0x0	0x2	Size of the following data.
0x2	0x280	Data

HidReport

This is "nn::bluetooth::HidReport". This is a 0x2BE-byte struct.

Offset	Size	Description
0x0	0x2	Size of the following data.
0x2	0x2BC	Data

PlrStatistics

This is "nn::bluetooth::PlrStatistics". This is a 0x84-byte struct.

PlrList

This is "nn::bluetooth::PlrList". This is a 0xA4-byte struct.

ChannelMapList

This is "nn::bluetooth::ChannelMapList". This is a 0x88-byte struct.

LeConnectionParams

This is "nn::bluetooth::LeConnectionParams". This is a 0x14-byte struct with 2-byte alignment.

BleConnectionParameter

This is "nn::bluetooth::BleConnectionParameter". This is a 0xC-byte struct with 2-byte alignment.

BleAdvertisePacketData

This is "nn::bluetooth::BleAdvertisePacketData" ([5.0.0-8.1.1] "nn::bluetooth::LeAdvertiseData"). This is a 0xCC-byte struct.

Offset	Size	Description
0x0	0x4
0x4	0x1
0x5	0x1	Size of the data at +0x6.
0x6	0x1F
0x25	0x3	Padding
0x28	0x1	Total array entries for the below array, can be 0.
0x29	0x7	Padding
0x30	count*0x14	Array entries, see below.
0xA4	0x1	Size of the data at +0xA8.
0xA5	0x1
0xA6	0x2	Padding
0xA8	0x1F
0xC7	0x1
0xC8	0x1
0xC9	0x3	Padding

Array entry:

Offset	Size	Description
0x0	0x2
0x2	0x12	Unused

BleAdvertiseFilter

This is "nn::bluetooth::BleAdvertiseFilter". This is a 0x3E-byte struct.

BleAdvertisePacketParameter

This is "nn::bluetooth::BleAdvertisePacketParameter". This is a 8-byte struct with 1-byte alignment.

BleScanResult

This is "nn::bluetooth::BleScanResult". This is a 0x148-byte struct.

Offset	Size	Description
0x0	0x1
0x1	0x6	#Address
0x7	0x139
0x140	0x4	s32
0x144	0x4	s32

BleConnectionInfo

This is "nn::bluetooth::BleConnectionInfo". This is a 0xC-byte struct.

Offset	Size	Description
0x0	0x4	ConnectionHandle, 0xFFFFFFFF ([5.0.0-5.0.2] 0xFFFF) is invalid.
0x4	0x6	#Address
0xA	0x2	Padding

GattAttributeUuid

This is "nn::bluetooth::GattAttributeUuid". This is a 0x14-byte struct with 4-byte alignment.

Offset	Size	Description
0x0	0x4	UUID size, must be 0x2, 0x4, or 0x10.
0x4	0x10	UUID with the above size.

GattId

This is "nn::bluetooth::GattId". This is a 0x18-byte struct with 4-byte alignment.

Offset	Size	Description
0x0	0x1	InstanceId
0x1	0x3	Padding
0x4	0x14	#GattAttributeUuid

LeEventInfo

This is a 0x400-byte struct.

Offset	Size	Description
0x0	0x4
0x4	0x4
0x8	0x1
0x9	0x3	Padding
0xC	0x14	#GattAttributeUuid
0x20	0x14	#GattAttributeUuid
0x34	0x14	#GattAttributeUuid
0x48	0x2	Size of the below data.
0x4A	{above size}	Data.

BleClientGattOperationInfo

This is "nn::bluetooth::BleClientGattOperationInfo". This is converted from #LeEventInfo.

Offset	Size	Description
0x0	0x1	Converted from #LeEventInfo+0x0.
0x1	0x3	Padding
0x4	0x4	Same as #LeEventInfo+0x4.
0x8	0x1	Same as #LeEventInfo+0x8.
0x9	0x3	Padding
0xC	0x14	Same as #LeEventInfo+0xC.
0x20	0x14	Same as #LeEventInfo+0x20.
0x34	0x14	Same as #LeEventInfo+0x34.
0x48	0x8	Same as #LeEventInfo+0x48.
0x50	{above size}	Same as #LeEventInfo+0x4A.

Notes

The output from sudo hcitool info {BDADDR} is identical for [1.0.0-11.0.0]:

 BD Address:  {BDADDR}
 OUI Company: Nintendo Co.,Ltd (98-B6-E9)
 Device Name: Nintendo Switch
 LMP Version: 4.2 (0x8) LMP Subversion: 0x2409
 Manufacturer: Broadcom Corporation (15)
 Features page 0: 0xbf 0xfe 0xcf 0xfe 0xdb 0xff 0x7b 0x87
   <3-slot packets> <5-slot packets> <encryption> <slot offset> 
   <timing accuracy> <role switch> <sniff mode> <RSSI> 
   <channel quality> <SCO link> <HV2 packets> <HV3 packets> 
   <u-law log> <A-law log> <CVSD> <paging scheme> <power control> 
   <transparent SCO> <broadcast encrypt> <EDR ACL 2 Mbps> 
   <EDR ACL 3 Mbps> <enhanced iscan> <interlaced iscan> 
   <interlaced pscan> <inquiry with RSSI> <extended SCO> 
   <EV4 packets> <EV5 packets> <AFH cap. slave> 
   <AFH class. slave> <LE support> <3-slot EDR ACL> 
   <5-slot EDR ACL> <sniff subrating> <pause encryption> 
   <AFH cap. master> <AFH class. master> <EDR eSCO 2 Mbps> 
   <EDR eSCO 3 Mbps> <3-slot EDR eSCO> <extended inquiry> 
   <LE and BR/EDR> <simple pairing> <encapsulated PDU> 
   <err. data report> <non-flush flag> <LSTO> <inquiry TX power> 
   <EPC> <extended features> 
 Features page 1: 0x0f 0x00 0x00 0x00 0x00 0x00 0x00 0x00
 Features page 2: 0x7f 0x0b 0x00 0x00 0x00 0x00 0x00 0x00

The bluetooth driver implements the bluetooth protocol over h4/uart. It interfaces with the uart service to actually talk with the bluetooth hardware.

The bluetooth stack is Broadcom/Cypress brcm BSA (for example, see here).

The following L2CAP services are registered (dynamic channels): SDP, ATT (GATT), RFCOMM, HID (PSMs: 0x11, 0x13, 0x8001, 0x8003).

l2cu_send_peer_echo_rsp is called with p_data=NULL and data_len=0, therefore no data is returned in the L2CAP ECHO response.

The following HID transaction types are supported (by hidh_l2cif_data_ind): HANDSHAKE, CONTROL (only param VIRTUAL_CABLE_UNPLUG is supported), DATA, DATAC.

DATAC is not actually supported, since the callback function (bta_hh_cback) just frees the message and returns.

Firmware

System Version	BSA version string	Date string	Config string
[1.0.0]	BSA0106_01.60.00	Hayward_J3_Patch_20161118	BCM4356A3_001.004.009.0045.0000
[2.0.0]	BSA0106_01.60.00	Hayward_J5_RC_20161227	BCM4356A3_001.004.009.0047.0049
[3.0.0-3.0.1]	BSA0106_01.60.00	Hayward_K4_RC_20170504	BCM4356A3_001.004.009.0054.0056
[4.0.0]	BSA0106_01.60.00	Hayward_L4_RC_20170815	CYW4356A3_001.004.009.0057.0059
[5.0.0]	BSA0106_01.60.00	Hayward_M2_RC_20180109	CYW4356A3_001.004.009.0059.0061
[5.1.0]	BSA0106_01.60.00	Hayward_N1_RC_20180226	CYW4356A3_001.004.009.0062.0064
[6.0.0-6.2.0]	BSA0106_01.60.00	Hayward_N3_RC_20180612	CYW4356A3_001.004.009.0062.0064
[7.0.0]	BSA0106_01.60.00	Hayward_O1_RC_20180829	CYW4356A3_001.004.009.0076.0077
[8.0.0-9.0.0]	BSA0106_01.60.00	Hayward_P1_RC_20190121	CYW4356A3_001.004.009.0076.0077
[10.0.0-11.0.0]	BSA0106_01.60.00	Hayward_R2_RC_20191119	CYW4356A3_001.004.009.0092.0095

@@ Line 403: / Line 403: @@
 == SetTsi ==
-Takes an input [[#Address]] and an u8, no output.
+Takes an input [[#Address]] and an u8 Tsi, no output.
 This is used by [[BTM_services|btm]].
+The response will be available via [[#GetHidEventInfo]].
+Tsi: non-value-0xFF to Set, value 0xFF to Exit.
 == EnableBurstMode ==
@@ Line 411: / Line 415: @@
 This is used by [[BTM_services|btm]].
+The response will be available via [[#GetHidEventInfo]].
+bool flag: true = Set, false = Exit.
 == SetZeroRetransmission ==
@@ Line 418: / Line 426: @@
 This is used by [[BTM_services|btm]].
+The response will be available via [[#GetHidEventInfo]].
 == EnableMcMode ==
@@ Line 752: / Line 762: @@
 == MoveToSecondaryPiconet ==
 Takes an input [[#Address]], no output.
+The response will be available via [[#GetHidEventInfo]].
 == IsManufacturingMode ==
@@ Line 956: / Line 968: @@
 | 4 || || DATA report on the Interrupt channel.
 |-
-| 7 || || Only used with [[#GetHidEventInfo]].
+| 7 || || Response for extensions. Only used with [[#GetHidEventInfo]].
 |-
 | 8 || || Response to SET_REPORT.

Difference between revisions of "Bluetooth Driver services"

Revision as of 01:11, 20 January 2021

btdrv

InitializeBluetoothDriver

InitializeBluetooth

EnableBluetooth

DisableBluetooth

FinalizeBluetooth

GetAdapterProperties

GetAdapterProperty

SetAdapterProperty

StartInquiry

StopInquiry

CreateBond

RemoveBond

CancelBond

RespondToPinRequest

RespondToSspRequest

GetEventInfo

InitializeHid

OpenHidConnection

CloseHidConnection

HidSendData

WriteHidData

WriteHidData2

HidSetReport

SetHidReport

GetHidReport

HidWakeController

TriggerConnection

AddPairedDeviceInfo

GetPairedDeviceInfo

FinalizeHid

GetHidEventInfo

SetTsi

EnableBurstMode

SetZeroRetransmission

EnableMcMode

EnableLlrScan

DisableLlrScan

EnableRadio

SetVisibility

EnableTbfcScan

RegisterHidReportEvent

GetHidReportEventInfo

GetLatestPlr

GetPendingConnections

GetChannelMap

EnableTxPowerBoostSetting

IsTxPowerBoostSettingEnabled

EnableAfhSetting

IsAfhSettingEnabled

InitializeBle

EnableBle

DisableBle

FinalizeBle

SetBleVisibility

SetLeConnectionParameter

SetBleConnectionParameter

SetLeDefaultConnectionParameter

SetBleDefaultConnectionParameter

SetBleAdvertiseData

SetBleAdvertiseParameter

StartBleScan

StopBleScan

AddBleScanFilterCondition

DeleteBleScanFilterCondition

DeleteBleScanFilter

ClearBleScanFilters

EnableBleScanFilter

RegisterGattClient

UnregisterGattClient

UnregisterAllGattClients

ConnectGattServer

CancelConnectGattServer

DisconnectGattServer

GetGattAttribute

GetGattService

ConfigureAttMtu

RegisterGattServer