libnx/nx/include/switch/services/btdrv.h

1005 lines
30 KiB
C

/**
* @file btdrv.h
* @brief Bluetooth driver (btdrv) service IPC wrapper.
* @author yellows8
* @copyright libnx Authors
*/
#pragma once
#include "../types.h"
#include "../kernel/event.h"
#include "../services/btdrv_types.h"
#include "../services/set.h"
#include "../sf/service.h"
/// Data for \ref btdrvGetHidReportEventInfo. The data stored here depends on the \ref BtdrvHidEventType.
typedef struct {
union {
u8 data[0x480]; ///< Raw data.
struct {
u32 unk_x0; ///< Always 0.
u8 unk_x4; ///< Always 0.
BtdrvAddress addr; ///< \ref BtdrvAddress
u8 pad; ///< Padding
u16 size; ///< Size of the below data.
u8 data[]; ///< Data.
} type4; ///< ::BtdrvHidEventType_Unknown4
struct {
union {
u8 data[0xC]; ///< Raw data.
struct {
u32 res; ///< 0 = success, non-zero = error.
BtdrvAddress addr; ///< \ref BtdrvAddress
u8 pad[2]; ///< Padding
};
};
} type8; ///< ::BtdrvHidEventType_Unknown8
struct {
union {
union {
u8 rawdata[0x290]; ///< Raw data.
struct {
BtdrvAddress addr; ///< \ref BtdrvAddress
u8 pad[2]; ///< Padding
u32 unk_x0; ///< Unknown. hid-sysmodule only uses the below data when this field is 0.
BtdrvHidData data; ///< \ref BtdrvHidData
u8 pad2[2]; ///< Padding
};
} hid_data; ///< Pre-9.0.0
union {
u8 rawdata[0x2C8]; ///< Raw data.
struct {
u32 unk_x0; ///< Unknown. hid-sysmodule only uses the below report when this field is 0.
BtdrvAddress addr; ///< \ref BtdrvAddress
BtdrvHidReport report; ///< \ref BtdrvHidReport
};
} hid_report; ///< [9.0.0+]
};
} type9; ///< ::BtdrvHidEventType_Unknown9
};
} BtdrvHidReportEventInfo;
/// The raw sharedmem data for HidReportEventInfo.
typedef struct {
struct {
u8 type; ///< \ref BtdrvHidEventType
u8 pad[7];
u64 tick;
u64 size;
} hdr;
union {
struct {
struct {
u8 unused[0x3]; ///< Unused
BtdrvAddress addr; ///< \ref BtdrvAddress
u8 unused2[0x3]; ///< Unused
u16 size; ///< Size of the below data.
u8 data[]; ///< Data.
} v1; ///< Pre-9.0.0
struct {
u8 unused[0x5]; ///< Unused
BtdrvAddress addr; ///< \ref BtdrvAddress
u8 pad; ///< Padding
u16 size; ///< Size of the below data.
u8 data[]; ///< Data.
} v9; ///< [9.0.0+]
} type4; ///< ::BtdrvHidEventType_Unknown4
struct {
u8 data[0xC]; ///< Raw data.
} type8; ///< ::BtdrvHidEventType_Unknown8
struct {
union {
struct {
u8 rawdata[0x290]; ///< Raw data.
} hid_data; ///< Pre-9.0.0
struct {
u8 rawdata[0x2C8]; ///< Raw data.
} hid_report; ///< [9.0.0+]
};
} type9; ///< ::BtdrvHidEventType_Unknown9
} data;
} BtdrvHidReportEventInfoBufferData;
/// CircularBuffer
typedef struct {
Mutex mutex;
void* event_type; ///< Not set with sharedmem.
u8 data[0x2710];
s32 write_offset;
s32 read_offset;
u64 utilization;
char name[0x11];
u8 initialized;
} BtdrvCircularBuffer;
/// Initialize btdrv.
Result btdrvInitialize(void);
/// Exit btdrv.
void btdrvExit(void);
/// Gets the Service object for the actual btdrv service session.
Service* btdrvGetServiceSession(void);
/**
* @brief InitializeBluetooth
* @note This is used by btm-sysmodule, this should not be used by other processes.
* @note The Event must be closed by the user once finished with it.
* @param[out] out_event Output Event with autoclear=true.
*/
Result btdrvInitializeBluetooth(Event* out_event);
/**
* @brief EnableBluetooth
* @note This is used by btm-sysmodule.
*/
Result btdrvEnableBluetooth(void);
/**
* @brief DisableBluetooth
* @note This is used by btm-sysmodule.
*/
Result btdrvDisableBluetooth(void);
/**
* @brief FinalizeBluetooth
* @note This is not used by btm-sysmodule, this should not be used by other processes.
*/
Result btdrvFinalizeBluetooth(void);
/**
* @brief GetAdapterProperties
* @param[out] property \ref BtdrvAdapterProperty
*/
Result btdrvGetAdapterProperties(BtdrvAdapterProperty *property);
/**
* @brief GetAdapterProperty
* @param[in] type \ref BtdrvBluetoothPropertyType
* @param[out] buffer Output buffer, see \ref BtdrvBluetoothPropertyType for the contents.
* @param[in] size Output buffer size.
*/
Result btdrvGetAdapterProperty(BtdrvBluetoothPropertyType type, void* buffer, size_t size);
/**
* @brief SetAdapterProperty
* @param[in] type \ref BtdrvBluetoothPropertyType
* @param[in] buffer Input buffer, see \ref BtdrvBluetoothPropertyType for the contents.
* @param[in] size Input buffer size.
*/
Result btdrvSetAdapterProperty(BtdrvBluetoothPropertyType type, const void* buffer, size_t size);
/**
* @brief StartInquiry
* @note This is used by btm-sysmodule.
*/
Result btdrvStartInquiry(void);
/**
* @brief StopInquiry
* @note This is used by btm-sysmodule.
*/
Result btdrvStopInquiry(void);
/**
* @brief CreateBond
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[in] type TransportType
*/
Result btdrvCreateBond(BtdrvAddress addr, u32 type);
/**
* @brief RemoveBond
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
*/
Result btdrvRemoveBond(BtdrvAddress addr);
/**
* @brief CancelBond
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
*/
Result btdrvCancelBond(BtdrvAddress addr);
/**
* @brief RespondToPinRequest
* @param[in] addr \ref BtdrvAddress
* @param[in] flag Flag
* @param[in] pin_code \ref BtdrvBluetoothPinCode
* @param[in] unk Unknown
*/
Result btdrvRespondToPinRequest(BtdrvAddress addr, bool flag, const BtdrvBluetoothPinCode *pin_code, u8 unk);
/**
* @brief RespondToSspRequest
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[in] variant BluetoothSspVariant
* @param[in] flag Flag
* @param[in] unk Unknown
*/
Result btdrvRespondToSspRequest(BtdrvAddress addr, u8 variant, bool flag, u32 unk);
/**
* @brief GetEventInfo
* @note This is used by btm-sysmodule.
* @param[out] buffer Output buffer. 0x400-bytes from state is written here.
* @param[in] size Output buffer size.
* @oaram[out] type Output EventType.
*/
Result btdrvGetEventInfo(void* buffer, size_t size, u32 *type);
/**
* @brief InitializeHid
* @note This is used by btm-sysmodule, this should not be used by other processes.
* @note The Event must be closed by the user once finished with it.
* @param[out] out_event Output Event with autoclear=true.
*/
Result btdrvInitializeHid(Event* out_event);
/**
* @brief OpenHidConnection
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
*/
Result btdrvOpenHidConnection(BtdrvAddress addr);
/**
* @brief CloseHidConnection
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
*/
Result btdrvCloseHidConnection(BtdrvAddress addr);
/**
* @brief This sends a HID DATA transaction packet with report-type Output.
* @param[in] addr \ref BtdrvAddress
* @param[in] buffer Input \ref BtdrvHidReport, on pre-9.0.0 this is \ref BtdrvHidData.
*/
Result btdrvWriteHidData(BtdrvAddress addr, const BtdrvHidReport *buffer);
/**
* @brief WriteHidData2
* @param[in] addr \ref BtdrvAddress
* @param[in] buffer Input buffer, same as the buffer for \ref btdrvWriteHidData.
* @param[in] size Input buffer size.
*/
Result btdrvWriteHidData2(BtdrvAddress addr, const void* buffer, size_t size);
/**
* @brief This sends a HID SET_REPORT transaction packet.
* @param[in] addr \ref BtdrvAddress
* @param[in] type \ref BtdrvBluetoothHhReportType
* @param[in] buffer Input \ref BtdrvHidReport, on pre-9.0.0 this is \ref BtdrvHidData.
*/
Result btdrvSetHidReport(BtdrvAddress addr, BtdrvBluetoothHhReportType type, const BtdrvHidReport *buffer);
/**
* @brief This sends a HID GET_REPORT transaction packet.
* @param[in] addr \ref BtdrvAddress
* @param[in] report_id This is sent in the packet for the Report Id, when non-zero.
* @param[in] type \ref BtdrvBluetoothHhReportType
*/
Result btdrvGetHidReport(BtdrvAddress addr, u8 report_id, BtdrvBluetoothHhReportType type);
/**
* @brief TriggerConnection
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[in] unk [9.0.0+] Unknown
*/
Result btdrvTriggerConnection(BtdrvAddress addr, u16 unk);
/**
* @brief AddPairedDeviceInfo
* @note This is used by btm-sysmodule.
* @param[in] settings \ref SetSysBluetoothDevicesSettings
*/
Result btdrvAddPairedDeviceInfo(const SetSysBluetoothDevicesSettings *settings);
/**
* @brief GetPairedDeviceInfo
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[out] settings \ref SetSysBluetoothDevicesSettings
*/
Result btdrvGetPairedDeviceInfo(BtdrvAddress addr, SetSysBluetoothDevicesSettings *settings);
/**
* @brief FinalizeHid
* @note This is not used by btm-sysmodule, this should not be used by other processes.
*/
Result btdrvFinalizeHid(void);
/**
* @brief GetHidEventInfo
* @note This is used by btm-sysmodule.
* @param[out] buffer Output buffer. 0x480-bytes from state is written here.
* @param[in] size Output buffer size.
* @param[out] type \ref BtdrvHidEventType, always ::BtdrvHidEventType_Unknown0 or ::BtdrvHidEventType_Unknown7.
*/
Result btdrvGetHidEventInfo(void* buffer, size_t size, BtdrvHidEventType *type);
/**
* @brief SetTsi
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[in] unk Unknown
*/
Result btdrvSetTsi(BtdrvAddress addr, u8 unk);
/**
* @brief EnableBurstMode
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[in] flag Flag
*/
Result btdrvEnableBurstMode(BtdrvAddress addr, bool flag);
/**
* @brief SetZeroRetransmission
* @note This is used by btm-sysmodule.
* @param[in] addr \ref BtdrvAddress
* @param[in] buf Input buffer containing an array of u8s.
* @param[in] count Total u8s in the input buffer. This can be 0, the max is 5.
*/
Result btdrvSetZeroRetransmission(BtdrvAddress addr, u8 *buf, u8 count);
/**
* @brief EnableMcMode
* @note This is used by btm-sysmodule.
* @param[in] flag Flag
*/
Result btdrvEnableMcMode(bool flag);
/**
* @brief EnableLlrScan
* @note This is used by btm-sysmodule.
*/
Result btdrvEnableLlrScan(void);
/**
* @brief DisableLlrScan
* @note This is used by btm-sysmodule.
*/
Result btdrvDisableLlrScan(void);
/**
* @brief EnableRadio
* @note This is used by btm-sysmodule.
* @param[in] flag Flag
*/
Result btdrvEnableRadio(bool flag);
/**
* @brief SetVisibility
* @note This is used by btm-sysmodule.
* @param[in] flag0 Unknown flag.
* @param[in] flag1 Unknown flag.
*/
Result btdrvSetVisibility(bool flag0, bool flag1);
/**
* @brief EnableTbfcScan
* @note Only available on [4.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] flag Flag
*/
Result btdrvEnableTbfcScan(bool flag);
/**
* @brief RegisterHidReportEvent
* @note This also does sharedmem init/handling if needed, on [7.0.0+].
* @note The Event must be closed by the user once finished with it.
* @param[out] out_event Output Event with autoclear=true.
*/
Result btdrvRegisterHidReportEvent(Event* out_event);
/**
* @brief GetHidReportEventInfo
* @note \ref btdrvRegisterHidReportEvent must be used before this, on [7.0.0+].
* @note This is used by hid-sysmodule. When used by other processes, hid/user-process will conflict. No events will be received by that user-process, or it will be corrupted, etc.
* @note [7.0.0+] When data isn't available, the type is set to ::BtdrvHidEventType_Unknown4, with the buffer cleared to all-zero.
* @param[out] buffer Output buffer, see \ref BtdrvHidReportEventInfo.
* @param[in] size Output buffer size.
* @oaram[out] type \ref BtdrvHidEventType
*/
Result btdrvGetHidReportEventInfo(void* buffer, size_t size, BtdrvHidEventType *type);
/// Gets the SharedMemory addr for HidReportEventInfo (\ref BtdrvCircularBuffer), only valid when \ref btdrvRegisterHidReportEvent was previously used, on [7.0.0+].
void* btdrvGetHidReportEventInfoSharedmemAddr(void);
/**
* @brief GetLatestPlr
* @param[out] out Output \ref BtdrvPlrList, on pre-9.0.0 this is \ref BtdrvPlrStatistics.
*/
Result btdrvGetLatestPlr(BtdrvPlrList *out);
/**
* @brief GetPendingConnections
* @note This is used by btm-sysmodule.
* @note Only available on [3.0.0+].
*/
Result btdrvGetPendingConnections(void);
/**
* @brief GetChannelMap
* @note Only available on [3.0.0+].
* @param[out] out \ref BtdrvChannelMapList
*/
Result btdrvGetChannelMap(BtdrvChannelMapList *out);
/**
* @brief EnableTxPowerBoostSetting
* @note Only available on [3.0.0+].
* @param[in] flag Input flag.
*/
Result btdrvEnableTxPowerBoostSetting(bool flag);
/**
* @brief IsTxPowerBoostSettingEnabled
* @note Only available on [3.0.0+].
* @param[out] out Output flag.
*/
Result btdrvIsTxPowerBoostSettingEnabled(bool *out);
/**
* @brief EnableAfhSetting
* @note Only available on [3.0.0+].
* @param[in] flag Input flag.
*/
Result btdrvEnableAfhSetting(bool flag);
/**
* @brief IsAfhSettingEnabled
* @note Only available on [3.0.0+].
* @param[out] out Output flag.
*/
Result btdrvIsAfhSettingEnabled(bool *out);
/**
* @brief InitializeBle
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @note The Event must be closed by the user once finished with it.
* @param[out] out_event Output Event with autoclear=true.
*/
Result btdrvInitializeBle(Event* out_event);
/**
* @brief EnableBle
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
*/
Result btdrvEnableBle(void);
/**
* @brief DisableBle
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
*/
Result btdrvDisableBle(void);
/**
* @brief FinalizeBle
* @note Only available on [5.0.0+].
*/
Result btdrvFinalizeBle(void);
/**
* @brief SetBleVisibility
* @note Only available on [5.0.0+].
* @param[in] flag0 Unknown flag.
* @param[in] flag1 Unknown flag.
*/
Result btdrvSetBleVisibility(bool flag0, bool flag1);
/**
* @brief SetLeConnectionParameter
* @note Only available on [5.0.0-8.1.1]. This is the older version of \ref btdrvSetBleConnectionParameter.
* @param[in] param \ref BtdrvLeConnectionParams
*/
Result btdrvSetLeConnectionParameter(const BtdrvLeConnectionParams *param);
/**
* @brief SetBleConnectionParameter
* @note Only available on [9.0.0+]. This is the newer version of \ref btdrvSetLeConnectionParameter.
* @param[in] addr \ref BtdrvAddress
* @param[in] param \ref BtdrvBleConnectionParameter
* @param[in] flag Flag
*/
Result btdrvSetBleConnectionParameter(BtdrvAddress addr, const BtdrvBleConnectionParameter *param, bool flag);
/**
* @brief SetLeDefaultConnectionParameter
* @note Only available on [5.0.0-8.1.1]. This is the older version of \ref btdrvSetBleDefaultConnectionParameter.
* @param[in] param \ref BtdrvLeConnectionParams
*/
Result btdrvSetLeDefaultConnectionParameter(const BtdrvLeConnectionParams *param);
/**
* @brief SetBleDefaultConnectionParameter
* @note Only available on [9.0.0+]. This is the newer version of \ref btdrvSetLeDefaultConnectionParameter.
* @param[in] param \ref BtdrvBleConnectionParameter
*/
Result btdrvSetBleDefaultConnectionParameter(const BtdrvBleConnectionParameter *param);
/**
* @brief SetBleAdvertiseData
* @note Only available on [5.0.0+].
* @param[in] data \ref BtdrvBleAdvertisePacketData
*/
Result btdrvSetBleAdvertiseData(const BtdrvBleAdvertisePacketData *data);
/**
* @brief SetBleAdvertiseParameter
* @note Only available on [5.0.0+].
* @param[in] addr \ref BtdrvAddress
* @param[in] unk0 Unknown
* @param[in] unk1 Unknown
*/
Result btdrvSetBleAdvertiseParameter(BtdrvAddress addr, u16 unk0, u16 unk1);
/**
* @brief StartBleScan
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
*/
Result btdrvStartBleScan(void);
/**
* @brief StopBleScan
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
*/
Result btdrvStopBleScan(void);
/**
* @brief AddBleScanFilterCondition
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] filter \ref BtdrvBleAdvertiseFilter
*/
Result btdrvAddBleScanFilterCondition(const BtdrvBleAdvertiseFilter *filter);
/**
* @brief DeleteBleScanFilterCondition
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] filter \ref BtdrvBleAdvertiseFilter
*/
Result btdrvDeleteBleScanFilterCondition(const BtdrvBleAdvertiseFilter *filter);
/**
* @brief DeleteBleScanFilter
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
*/
Result btdrvDeleteBleScanFilter(u8 unk);
/**
* @brief ClearBleScanFilters
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
*/
Result btdrvClearBleScanFilters(void);
/**
* @brief EnableBleScanFilter
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] flag Flag
*/
Result btdrvEnableBleScanFilter(bool flag);
/**
* @brief RegisterGattClient
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvRegisterGattClient(const BtdrvGattAttributeUuid *uuid);
/**
* @brief UnregisterGattClient
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
*/
Result btdrvUnregisterGattClient(u8 unk);
/**
* @brief UnregisterAllGattClients
* @note Only available on [5.0.0+].
*/
Result btdrvUnregisterAllGattClients(void);
/**
* @brief ConnectGattServer
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] unk Unknown
* @param[in] addr \ref BtdrvAddress
* @param[in] flag Flag
* @param[in] AppletResourceUserId AppletResourceUserId
*/
Result btdrvConnectGattServer(u8 unk, BtdrvAddress addr, bool flag, u64 AppletResourceUserId);
/**
* @brief CancelConnectGattServer
* @note Only available on [5.1.0+].
* @note This is used by btm-sysmodule.
* @param[in] unk Unknown
* @param[in] addr \ref BtdrvAddress
* @param[in] flag Flag
*/
Result btdrvCancelConnectGattServer(u8 unk, BtdrvAddress addr, bool flag);
/**
* @brief DisconnectGattServer
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] unk Unknown
*/
Result btdrvDisconnectGattServer(u32 unk);
/**
* @brief GetGattAttribute
* @note Only available on [5.0.0+].
* @param[in] addr \ref BtdrvAddress, only used on pre-9.0.0.
* @param[in] unk Unknown
*/
Result btdrvGetGattAttribute(BtdrvAddress addr, u32 unk);
/**
* @brief GetGattService
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvGetGattService(u32 unk, const BtdrvGattAttributeUuid *uuid);
/**
* @brief ConfigureAttMtu
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] unk Unknown
* @param[in] mtu MTU
*/
Result btdrvConfigureAttMtu(u32 unk, u16 mtu);
/**
* @brief RegisterGattServer
* @note Only available on [5.0.0+].
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvRegisterGattServer(const BtdrvGattAttributeUuid *uuid);
/**
* @brief UnregisterGattServer
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
*/
Result btdrvUnregisterGattServer(u8 unk);
/**
* @brief ConnectGattClient
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
* @param[in] addr \ref BtdrvAddress
* @param[in] flag Flag
*/
Result btdrvConnectGattClient(u8 unk, BtdrvAddress addr, bool flag);
/**
* @brief DisconnectGattClient
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
* @param[in] addr \ref BtdrvAddress, only used on pre-9.0.0.
*/
Result btdrvDisconnectGattClient(u8 unk, BtdrvAddress addr);
/**
* @brief AddGattService
* @note Only available on [5.0.0+].
* @param[in] unk0 Unknown
* @param[in] unk1 Unknown
* @param[in] flag Flag
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvAddGattService(u8 unk0, u8 unk1, bool flag, const BtdrvGattAttributeUuid *uuid);
/**
* @brief EnableGattService
* @note Only available on [5.0.0+].
* @param[in] unk Unknown
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvEnableGattService(u8 unk, const BtdrvGattAttributeUuid *uuid);
/**
* @brief AddGattCharacteristic
* @note Only available on [5.0.0+].
* @param[in] unk0 Unknown
* @param[in] unk1 Unknown
* @param[in] unk2 Unknown
* @param[in] uuid0 \ref BtdrvGattAttributeUuid
* @param[in] uuid1 \ref BtdrvGattAttributeUuid
*/
Result btdrvAddGattCharacteristic(u8 unk0, u8 unk1, u16 unk2, const BtdrvGattAttributeUuid *uuid0, const BtdrvGattAttributeUuid *uuid1);
/**
* @brief AddGattDescriptor
* @note Only available on [5.0.0+].
* @param[in] unk0 Unknown
* @param[in] unk1 Unknown
* @param[in] uuid0 \ref BtdrvGattAttributeUuid
* @param[in] uuid1 \ref BtdrvGattAttributeUuid
*/
Result btdrvAddGattDescriptor(u8 unk0, u16 unk1, const BtdrvGattAttributeUuid *uuid0, const BtdrvGattAttributeUuid *uuid1);
/**
* @brief GetBleManagedEventInfo
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[out] buffer Output buffer. 0x400-bytes from state is written here.
* @param[in] size Output buffer size.
* @oaram[out] type Output BleEventType.
*/
Result btdrvGetBleManagedEventInfo(void* buffer, size_t size, u32 *type);
/**
* @brief GetGattFirstCharacteristic
* @note Only available on [5.0.0+].
* @param[in] flag Flag
* @param[in] unk Unknown
* @param[in] id \ref BtdrvGattId
* @param[in] uuid \ref BtdrvGattAttributeUuid
* @param[out] unk_out Unknown
* @param[out] id_out \ref BtdrvGattId
*/
Result btdrvGetGattFirstCharacteristic(bool flag, u32 unk, const BtdrvGattId *id, const BtdrvGattAttributeUuid *uuid, u8 *unk_out, BtdrvGattId *id_out);
/**
* @brief GetGattNextCharacteristic
* @note Only available on [5.0.0+].
* @param[in] flag Flag
* @param[in] unk Unknown
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] uuid \ref BtdrvGattAttributeUuid
* @param[out] unk_out Unknown
* @param[out] id_out \ref BtdrvGattId
*/
Result btdrvGetGattNextCharacteristic(bool flag, u32 unk, const BtdrvGattId *id0, const BtdrvGattId *id1, const BtdrvGattAttributeUuid *uuid, u8 *unk_out, BtdrvGattId *id_out);
/**
* @brief GetGattFirstDescriptor
* @note Only available on [5.0.0+].
* @param[in] flag Flag
* @param[in] unk Unknown
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] uuid \ref BtdrvGattAttributeUuid
* @param[out] id_out \ref BtdrvGattId
*/
Result btdrvGetGattFirstDescriptor(bool flag, u32 unk, const BtdrvGattId *id0, const BtdrvGattId *id1, const BtdrvGattAttributeUuid *uuid, BtdrvGattId *id_out);
/**
* @brief GetGattNextDescriptor
* @note Only available on [5.0.0+].
* @param[in] flag Flag
* @param[in] unk Unknown
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] id2 \ref BtdrvGattId
* @param[in] uuid \ref BtdrvGattAttributeUuid
* @param[out] id_out \ref BtdrvGattId
*/
Result btdrvGetGattNextDescriptor(bool flag, u32 unk, const BtdrvGattId *id0, const BtdrvGattId *id1, const BtdrvGattId *id2, const BtdrvGattAttributeUuid *uuid, BtdrvGattId *id_out);
/**
* @brief RegisterGattManagedDataPath
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvRegisterGattManagedDataPath(const BtdrvGattAttributeUuid *uuid);
/**
* @brief UnregisterGattManagedDataPath
* @note Only available on [5.0.0+].
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvUnregisterGattManagedDataPath(const BtdrvGattAttributeUuid *uuid);
/**
* @brief RegisterGattHidDataPath
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvRegisterGattHidDataPath(const BtdrvGattAttributeUuid *uuid);
/**
* @brief UnregisterGattHidDataPath
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvUnregisterGattHidDataPath(const BtdrvGattAttributeUuid *uuid);
/**
* @brief RegisterGattDataPath
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvRegisterGattDataPath(const BtdrvGattAttributeUuid *uuid);
/**
* @brief UnregisterGattDataPath
* @note Only available on [5.0.0+].
* @note This is used by btm-sysmodule.
* @param[in] uuid \ref BtdrvGattAttributeUuid
*/
Result btdrvUnregisterGattDataPath(const BtdrvGattAttributeUuid *uuid);
/**
* @brief ReadGattCharacteristic
* @note Only available on [5.0.0+].
* @param[in] connection_handle ConnectionHandle
* @param[in] primary_service PrimaryService
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] unk Unknown
*/
Result btdrvReadGattCharacteristic(u32 connection_handle, bool primary_service, const BtdrvGattId *id0, const BtdrvGattId *id1, u8 unk);
/**
* @brief ReadGattDescriptor
* @note Only available on [5.0.0+].
* @param[in] connection_handle ConnectionHandle
* @param[in] primary_service PrimaryService
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] id2 \ref BtdrvGattId
* @param[in] unk Unknown
*/
Result btdrvReadGattDescriptor(u32 connection_handle, bool primary_service, const BtdrvGattId *id0, const BtdrvGattId *id1, const BtdrvGattId *id2, u8 unk);
/**
* @brief WriteGattCharacteristic
* @note Only available on [5.0.0+].
* @param[in] connection_handle ConnectionHandle
* @param[in] primary_service PrimaryService
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] buffer Input buffer.
* @param[in] size Input buffer size, must be <=0x258.
* @param[in] unk Unknown
* @param[in] flag Flag
*/
Result btdrvWriteGattCharacteristic(u32 connection_handle, bool primary_service, const BtdrvGattId *id0, const BtdrvGattId *id1, const void* buffer, size_t size, u8 unk, bool flag);
/**
* @brief WriteGattDescriptor
* @note Only available on [5.0.0+].
* @param[in] connection_handle ConnectionHandle
* @param[in] primary_service PrimaryService
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
* @param[in] id2 \ref BtdrvGattId
* @param[in] buffer Input buffer.
* @param[in] size Input buffer size, must be <=0x258.
* @param[in] unk Unknown
*/
Result btdrvWriteGattDescriptor(u32 connection_handle, bool primary_service, const BtdrvGattId *id0, const BtdrvGattId *id1, const BtdrvGattId *id2, const void* buffer, size_t size, u8 unk);
/**
* @brief RegisterGattNotification
* @note Only available on [5.0.0+].
* @param[in] connection_handle ConnectionHandle
* @param[in] primary_service PrimaryService
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
*/
Result btdrvRegisterGattNotification(u32 connection_handle, bool primary_service, const BtdrvGattId *id0, const BtdrvGattId *id1);
/**
* @brief UnregisterGattNotification
* @note Only available on [5.0.0+].
* @param[in] connection_handle ConnectionHandle
* @param[in] primary_service PrimaryService
* @param[in] id0 \ref BtdrvGattId
* @param[in] id1 \ref BtdrvGattId
*/
Result btdrvUnregisterGattNotification(u32 connection_handle, bool primary_service, const BtdrvGattId *id0, const BtdrvGattId *id1);
/**
* @brief GetLeHidEventInfo
* @note Only available on [5.0.0+].
* @note The state used by this is reset after writing the data to output.
* @param[out] buffer Output buffer. 0x400-bytes from state is written here. See \ref BtdrvLeEventInfo.
* @param[in] size Output buffer size.
* @oaram[out] type Output BleEventType.
*/
Result btdrvGetLeHidEventInfo(void* buffer, size_t size, u32 *type);
/**
* @brief RegisterBleHidEvent
* @note Only available on [5.0.0+].
* @note The Event must be closed by the user once finished with it.
* @param[out] out_event Output Event with autoclear=true.
*/
Result btdrvRegisterBleHidEvent(Event* out_event);
/**
* @brief SetBleScanParameter
* @note Only available on [5.1.0+].
* @note This is used by btm-sysmodule.
* @param[in] unk0 Unknown
* @param[in] unk1 Unknown
*/
Result btdrvSetBleScanParameter(u16 unk0, u16 unk1);
/**
* @brief MoveToSecondaryPiconet
* @note Only available on [10.0.0+].
* @param[in] addr \ref BtdrvAddress
*/
Result btdrvMoveToSecondaryPiconet(BtdrvAddress addr);
/**
* @brief IsManufacturingMode
* @note Only available on [5.0.0+].
* @param[out] out Output flag.
*/
Result btdrvIsManufacturingMode(bool *out);
/**
* @brief EmulateBluetoothCrash
* @note Only available on [7.0.0+].
* @param[in] reason \ref BtdrvFatalReason
*/
Result btdrvEmulateBluetoothCrash(BtdrvFatalReason reason);
/**
* @brief GetBleChannelMap
* @note Only available on [9.0.0+].
* @param[out] out \ref BtdrvChannelMapList
*/
Result btdrvGetBleChannelMap(BtdrvChannelMapList *out);
///@name CircularBuffer
///@{
/**
* @brief Read
* @note Used by \ref btdrvGetHidReportEventInfo on [7.0.0+].
* @param c \ref BtdrvCircularBuffer
*/
void* btdrvCircularBufferRead(BtdrvCircularBuffer *c);
/**
* @brief Free
* @note Used by \ref btdrvGetHidReportEventInfo on [7.0.0+].
* @param c \ref BtdrvCircularBuffer
*/
bool btdrvCircularBufferFree(BtdrvCircularBuffer *c);
///@}