Callback function, it is called if a BluetoothLE device is found during scan process.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Context | Context passed from scan request. |
[in] | CallbackInfo | Data related to scan result. NULL CallbackInfo means scan complete. |
- Return values
-
EFI_SUCCESS | The callback function complete successfully. |
Get BluetoothLE configuration data.
The GetData() function returns BluetoothLE configuration data. For remote BluetoothLE device configuration data, please use GetRemoteData() function with valid BD_ADDR.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | DataType | Configuration data type. |
[in,out] | DataSize | On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. |
[in,out] | Data | A pointer to the buffer of data that will be returned. |
- Return values
-
EFI_SUCCESS | The BluetoothLE configuration data is returned successfully. |
EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
- DataSize is NULL.
- *DataSize is 0.
- Data is NULL.
|
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. |
Set BluetoothLE configuration data.
The SetData() function sets local BluetoothLE device configuration data. Not all DataType can be set.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | DataType | Configuration data type. |
[in] | DataSize | Indicates the size, in bytes, of the data buffer specified by Data. |
[in] | Data | A pointer to the buffer of data that will be set. |
- Return values
-
EFI_SUCCESS | The BluetoothLE configuration data is set successfully. |
EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
- DataSize is 0.
- Data is NULL.
|
EFI_UNSUPPORTED | The DataType is unsupported. |
EFI_WRITE_PROTECTED | Cannot set configuration data. |
Get remove BluetoothLE device configuration data.
The GetRemoteData() function returns remote BluetoothLE device configuration data.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | DataType | Configuration data type. |
[in] | BDAddr | Remote BluetoothLE device address. |
[in,out] | DataSize | On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. |
[in,out] | Data | A pointer to the buffer of data that will be returned. |
- Return values
-
EFI_SUCCESS | The remote BluetoothLE device configuration data is returned successfully. |
EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
- DataSize is NULL.
- *DataSize is 0.
- Data is NULL.
|
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. |
The callback function for SMP.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Context | Data passed into callback function. This is optional parameter and may be NULL. |
[in] | BDAddr | Remote BluetoothLE device address. |
[in] | EventDataType | Event data type in EFI_BLUETOOTH_LE_SMP_EVENT_DATA_TYPE. |
[in] | DataSize | Indicates the size, in bytes, of the data buffer specified by Data. |
[in] | Data | A pointer to the buffer of data. |
- Return values
-
EFI_SUCCESS | The callback function complete successfully. |
Register Security Manager Protocol callback function for user authentication/authorization.
The RegisterSmpAuthCallback() function register Security Manager Protocol callback function for user authentication/authorization.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Callback | Callback function for user authentication/authorization. |
[in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
- Return values
-
EFI_SUCCESS | The SMP callback function is registered successfully. |
EFI_ALREADY_STARTED | A callback function is already registered on the same attribute opcode and attribute handle, when the Callback is not NULL. |
EFI_NOT_STARTED | A callback function is not registered on the same attribute opcode and attribute handle, when the Callback is NULL. |
Send user authentication/authorization to remote device.
The SendSmpAuthData() function sends user authentication/authorization to remote device. It should be used to send these information after the caller gets the request data from the callback function by RegisterSmpAuthCallback().
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | BDAddr | Remote BluetoothLE device address. |
[in] | EventDataType | Event data type in EFI_BLUETOOTH_LE_SMP_EVENT_DATA_TYPE. |
[in] | DataSize | The size of Data in bytes, of the data buffer specified by Data. |
[in] | Data | A pointer to the buffer of data that will be sent. The data format depends on the type of SMP event data being responded to. |
- Return values
-
EFI_SUCCESS | The SMP authorization data is sent successfully. |
EFI_NOT_READY | SMP is not in the correct state to receive the auth data. |
The callback function to get SMP data.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Context | Data passed into callback function. This is optional parameter and may be NULL. |
[in] | BDAddr | Remote BluetoothLE device address. For Local device setting, it should be NULL. |
[in] | DataType | Data type in EFI_BLUETOOTH_LE_SMP_DATA_TYPE. |
[in,out] | DataSize | On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. |
[out] | Data | A pointer to the buffer of data that will be returned. |
- Return values
-
EFI_SUCCESS | The callback function complete successfully. |
Register a callback function to get SMP related data.
The RegisterSmpGetDataCallback() function registers a callback function to get SMP related data.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Callback | Callback function for SMP get data. |
[in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
- Return values
-
EFI_SUCCESS | The SMP get data callback function is registered successfully. |
EFI_ALREADY_STARTED | A callback function is already registered on the same attribute opcode and attribute handle, when the Callback is not NULL. |
EFI_NOT_STARTED | A callback function is not registered on the same attribute opcode and attribute handle, when the Callback is NULL |
The callback function to set SMP data.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Context | Data passed into callback function. This is optional parameter and may be NULL. |
[in] | BDAddr | Remote BluetoothLE device address. |
[in] | DataType | Data type in EFI_BLUETOOTH_LE_SMP_DATA_TYPE. |
[in] | DataSize | Indicates the size, in bytes, of the data buffer specified by Data. |
[in] | Data | A pointer to the buffer of data. |
- Return values
-
EFI_SUCCESS | The callback function complete successfully. |
Register a callback function to set SMP related data.
The RegisterSmpSetDataCallback() function registers a callback function to set SMP related data.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Callback | Callback function for SMP set data. |
[in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
- Return values
-
EFI_SUCCESS | The SMP set data callback function is registered successfully. |
EFI_ALREADY_STARTED | A callback function is already registered on the same attribute opcode and attribute handle, when the Callback is not NULL. |
EFI_NOT_STARTED | A callback function is not registered on the same attribute opcode and attribute handle, when the Callback is NULL |
The callback function to hook connect complete event.
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Context | Data passed into callback function. This is optional parameter and may be NULL. |
[in] | CallbackType | The value defined in EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE. |
[in] | BDAddr | Remote BluetoothLE device address. |
[in] | InputBuffer | A pointer to the buffer of data that is input from callback caller. |
[in] | InputBufferSize | Indicates the size, in bytes, of the data buffer specified by InputBuffer. |
- Return values
-
EFI_SUCCESS | The callback function complete successfully. |
Register link connect complete callback function.
The RegisterLinkConnectCompleteCallback() function registers Bluetooth link connect complete callback function. The Bluetooth Configuration driver may call RegisterLinkConnectCompleteCallback() to register a callback function. During pairing, Bluetooth bus driver must trigger this callback function to report device state, if it is registered. Then Bluetooth Configuration driver will get information on device connection, according to CallbackType defined by EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE
- Parameters
-
[in] | This | Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. |
[in] | Callback | The callback function. NULL means unregister. |
[in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
- Return values
-
EFI_SUCCESS | The link connect complete callback function is registered successfully. |
EFI_ALREADY_STARTED | A callback function is already registered on the same attribute opcode and attribute handle, when the Callback is not NULL. |
EFI_NOT_STARTED | A callback function is not registered on the same attribute opcode and attribute handle, when the Callback is NULL |