MdePkg[all]
1.08
|
Data Structures | |
struct | EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION |
struct | _EFI_BLUETOOTH_CONFIG_PROTOCOL |
Macros | |
#define | EFI_BLUETOOTH_CONFIG_PROTOCOL_GUID |
#define | EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_CONNECTED 0x1 |
#define | EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_PAIRED 0x2 |
Functions | |
typedef | EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This |
Variables | |
EFI_GUID | gEfiBluetoothConfigProtocolGuid |
EFI Bluetooth Configuration Protocol as defined in UEFI 2.7. This protocol abstracts user interface configuration for Bluetooth device.
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
#define EFI_BLUETOOTH_CONFIG_PROTOCOL_GUID |
#define EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_CONNECTED 0x1 |
#define EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_PAIRED 0x2 |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_CONNECT)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN BLUETOOTH_ADDRESS *BD_ADDR) |
Connect a Bluetooth device.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
BD_ADDR | The address of Bluetooth device to be connected. |
EFI_SUCCESS | The Bluetooth device is connected successfully. |
EFI_ALREADY_STARTED | The Bluetooth device is already connected. |
EFI_NOT_FOUND | The Bluetooth device is not found. |
EFI_DEVICE_ERROR | A hardware error occurred trying to connect the Bluetooth device. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_DISCONNECT)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN BLUETOOTH_ADDRESS *BD_ADDR, IN UINT8 Reason) |
Disconnect a Bluetooth device.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
BD_ADDR | The address of Bluetooth device to be connected. |
Reason | Bluetooth disconnect reason. See Bluetooth specification for detail. |
EFI_SUCCESS | The Bluetooth device is disconnected successfully. |
EFI_NOT_STARTED | The Bluetooth device is not connected. |
EFI_NOT_FOUND | The Bluetooth device is not found. |
EFI_DEVICE_ERROR | A hardware error occurred trying to disconnect the Bluetooth device. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_GET_DATA)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_DATA_TYPE DataType, IN OUT UINTN *DataSize, IN OUT VOID *Data) |
Get Bluetooth configuration data.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
DataType | Configuration data type. |
DataSize | On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. |
Data | A pointer to the buffer of data that will be returned. |
EFI_SUCCESS | The Bluetooth configuration data is returned successfully. |
EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
|
EFI_UNSUPPORTED | The DataType is unsupported. |
EFI_NOT_FOUND | The DataType is not found. |
EFI_BUFFER_TOO_SMALL | The buffer is too small to hold the buffer. DataSize has been updated with the size needed to complete the request. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_DATA_TYPE DataType, IN BLUETOOTH_ADDRESS *BDAddr, IN OUT UINTN *DataSize, IN OUT VOID *Data) |
Get remove Bluetooth device configuration data.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
DataType | Configuration data type. |
BDAddr | Remote Bluetooth device address. |
DataSize | On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. |
Data | A pointer to the buffer of data that will be returned. |
EFI_SUCCESS | The remote Bluetooth device configuration data is returned successfully. |
EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
|
EFI_UNSUPPORTED | The DataType is unsupported. |
EFI_NOT_FOUND | The DataType is not found. |
EFI_BUFFER_TOO_SMALL | The buffer is too small to hold the buffer. DataSize has been updated with the size needed to complete the request. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_INIT)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This) |
Initialize Bluetooth host controller and local device.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
EFI_SUCCESS | The Bluetooth host controller and local device is initialized successfully. |
EFI_DEVICE_ERROR | A hardware error occurred trying to initialize the Bluetooth host controller and local device. |
typedef struct _EFI_BLUETOOTH_CONFIG_PROTOCOL EFI_BLUETOOTH_CONFIG_PROTOCOL |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION Callback, IN VOID *Context) |
Register link connect complete callback function.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Callback | The callback function. NULL means unregister. |
Context | Data passed into Callback function. This is optional parameter and may be NULL. |
EFI_SUCCESS | The link connect complete callback function is registered successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN VOID *Context, IN EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE CallbackType, IN BLUETOOTH_ADDRESS *BDAddr, IN VOID *InputBuffer, IN UINTN InputBufferSize) |
The callback function. It is called after connect completed.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Context | Context passed from registration. |
CallbackType | Callback type in EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE. |
BDAddr | A pointer to Bluetooth device address. |
InputBuffer | A pointer to the buffer of data that is input from callback caller. |
InputBufferSize | Indicates the size, in bytes, of the data buffer specified by InputBuffer. |
EFI_SUCCESS | The callback function complete successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION Callback, IN VOID *Context) |
Register get link key callback function.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Callback | The callback function. NULL means unregister. |
Context | Data passed into Callback function. This is optional parameter and may be NULL. |
EFI_SUCCESS | The link key callback function is registered successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN VOID *Context, IN BLUETOOTH_ADDRESS *BDAddr, OUT UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE]) |
The callback function to get link key.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Context | Context passed from registration. |
BDAddr | A pointer to Bluetooth device address. |
LinkKey | A pointer to the buffer of link key. |
EFI_SUCCESS | The callback function complete successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION Callback, IN VOID *Context) |
Register PIN callback function.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Callback | The callback function. NULL means unregister. |
Context | Data passed into Callback function. This is optional parameter and may be NULL. |
EFI_SUCCESS | The PIN callback function is registered successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN VOID *Context, IN EFI_BLUETOOTH_PIN_CALLBACK_TYPE CallbackType, IN VOID *InputBuffer, IN UINTN InputBufferSize, OUT VOID **OutputBuffer, OUT UINTN *OutputBufferSize) |
The callback function for PIN code.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Context | Context passed from registration. |
CallbackType | Callback type in EFI_BLUETOOTH_PIN_CALLBACK_TYPE. |
InputBuffer | A pointer to the buffer of data that is input from callback caller. |
InputBufferSize | Indicates the size, in bytes, of the data buffer specified by InputBuffer. |
OutputBuffer | A pointer to the buffer of data that will be output from callback callee. Callee allocates this buffer by using EFI Boot Service AllocatePool(). |
OutputBufferSize | Indicates the size, in bytes, of the data buffer specified by OutputBuffer. |
EFI_SUCCESS | The callback function complete successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION Callback, IN VOID *Context) |
Register set link key callback function.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Callback | The callback function. NULL means unregister. |
Context | Data passed into Callback function. This is optional parameter and may be NULL. |
EFI_SUCCESS | The link key callback function is registered successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN VOID *Context, IN BLUETOOTH_ADDRESS *BDAddr, IN UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE]) |
The callback function to set link key.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Context | Context passed from registration. |
BDAddr | A pointer to Bluetooth device address. |
LinkKey | A pointer to the buffer of link key. |
EFI_SUCCESS | The callback function complete successfully. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_SCAN)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN BOOLEAN ReScan, IN UINT8 ScanType, IN EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION Callback, IN VOID *Context) |
Scan Bluetooth device.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
ReScan | If TRUE, a new scan request is submitted no matter there is scan result before. If FALSE and there is scan result, the previous scan result is returned and no scan request is submitted. |
ScanType | Bluetooth scan type, Inquiry and/or Page. See Bluetooth specification for detail. |
Callback | The callback function. This function is called if a Bluetooth device is found during scan process. |
Context | Data passed into Callback function. This is optional parameter and may be NULL. |
EFI_SUCCESS | The Bluetooth scan request is submitted. |
EFI_DEVICE_ERROR | A hardware error occurred trying to scan the Bluetooth device. |
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_CONFIG_SET_DATA)(IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_DATA_TYPE DataType, IN UINTN DataSize, IN VOID *Data) |
Set Bluetooth configuration data.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
DataType | Configuration data type. |
DataSize | Indicates the size, in bytes, of the data buffer specified by Data. |
Data | A pointer to the buffer of data that will be set. |
EFI_SUCCESS | The Bluetooth configuration data is set successfully. |
EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
|
EFI_UNSUPPORTED | The DataType is unsupported. |
EFI_BUFFER_TOO_SMALL | Cannot set configuration data. |
EFI_BLUETOOTH_CONFIG_DATA_TYPE
Enumerator | |
---|---|
EfiBluetoothConfigDataTypeDeviceName |
Local/Remote Bluetooth device name. Data structure is zero terminated CHAR8[]. |
EfiBluetoothConfigDataTypeClassOfDevice |
Local/Remote Bluetooth device ClassOfDevice. Data structure is BLUETOOTH_CLASS_OF_DEVICE. |
EfiBluetoothConfigDataTypeRemoteDeviceState |
Remote Bluetooth device state. Data structure is EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE. |
EfiBluetoothConfigDataTypeSdpInfo |
Local/Remote Bluetooth device SDP information. Data structure is UINT8[]. |
EfiBluetoothConfigDataTypeBDADDR |
Local Bluetooth device address. Data structure is BLUETOOTH_ADDRESS. |
EfiBluetoothConfigDataTypeDiscoverable |
Local Bluetooth discoverable state. Data structure is UINT8. (Page scan and/or Inquiry scan) |
EfiBluetoothConfigDataTypeControllerStoredPairedDeviceList |
Local Bluetooth controller stored paired device list. Data structure is BLUETOOTH_ADDRESS[]. |
EfiBluetoothConfigDataTypeAvailableDeviceList |
Local available device list. Data structure is BLUETOOTH_ADDRESS[]. |
EfiBluetoothConfigDataTypeRandomAddress | |
EfiBluetoothConfigDataTypeRSSI | |
EfiBluetoothConfigDataTypeAdvertisementData |
Advertisement report. Data structure is UNIT8[]. |
EfiBluetoothConfigDataTypeIoCapability | |
EfiBluetoothConfigDataTypeOOBDataFlag | |
EfiBluetoothConfigDataTypeKeyType |
KeyType of Authentication Requirements flag of local device as UINT8, indicating requested security properties. See Bluetooth specification 3.H.3.5.1. BIT0: MITM, BIT1:SC. |
EfiBluetoothConfigDataTypeEncKeySize | |
EfiBluetoothConfigDataTypeMax |
EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE.
EFI_BLUETOOTH_PIN_CALLBACK_TYPE.
typedef EFI_STATUS | ( | EFIAPI * | EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION | ) |
Callback function, it is called if a Bluetooth device is found during scan process.
This | Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. |
Context | Context passed from scan request. |
CallbackInfo | Data related to scan result. NULL CallbackInfo means scan complete. |
EFI_SUCCESS | The callback function complete successfully. |
EFI_GUID gEfiBluetoothConfigProtocolGuid |