- Generated on Fri Nov 15 2024 18:01:35 for TianoCore EDK2 by
1.9.6
|
TianoCore EDK2 master
|
Go to the source code of this file.
Data Structures | |
| struct | _EFI_BLUETOOTH_HC_PROTOCOL |
Macros | |
| #define | EFI_BLUETOOTH_HC_PROTOCOL_GUID |
Variables | |
| EFI_GUID | gEfiBluetoothHcProtocolGuid |
EFI Bluetooth Host Controller Protocol as defined in UEFI 2.5. This protocol abstracts the Bluetooth host controller layer message transmit and receive.
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file BluetoothHc.h.
| #define EFI_BLUETOOTH_HC_PROTOCOL_GUID |
Definition at line 16 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_ASYNC_FUNC_CALLBACK) (IN VOID *Data, IN UINTN DataLength, IN VOID *Context) |
The async callback of AsyncReceiveEvent().
| [in] | Data | Data received via asynchronous transfer. |
| [in] | DataLength | The length of Data in bytes, received via asynchronous transfer. |
| [in] | Context | Context passed from asynchronous transfer request. |
| EFI_SUCCESS | The callback does execute successfully. |
| Others | The callback doesn't execute successfully. |
Definition at line 112 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_ASYNC_RECEIVE_ACL_DATA) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN BOOLEAN IsNewTransfer, IN UINTN PollingInterval, IN UINTN DataLength, IN EFI_BLUETOOTH_HC_ASYNC_FUNC_CALLBACK Callback, IN VOID *Context) |
Receive HCI ACL data packet in non-blocking way.
The AsyncReceiveACLData() function receives HCI ACL data packet in non-blocking way. Data in Callback holds the whole HCI ACL data packet, including Handle, PB flag, BC flag, data length, and data.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in] | IsNewTransfer | If TRUE, a new transfer will be submitted. If FALSE, the request is deleted. |
| [in] | PollingInterval | Indicates the periodic rate, in milliseconds, that the transfer is to be executed. |
| [in] | DataLength | Specifies the length, in bytes, of the data to be received. |
| [in] | Callback | The callback function. This function is called if the asynchronous transfer is completed. |
| [in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
| EFI_SUCCESS | The HCI asynchronous receive request is submitted successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: DataLength is 0. If IsNewTransfer is TRUE, and an asynchronous receive request already exists. |
Definition at line 257 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_ASYNC_RECEIVE_EVENT) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN BOOLEAN IsNewTransfer, IN UINTN PollingInterval, IN UINTN DataLength, IN EFI_BLUETOOTH_HC_ASYNC_FUNC_CALLBACK Callback, IN VOID *Context) |
Receive HCI event packet in non-blocking way.
The AsyncReceiveEvent() function receives HCI event packet in non-blocking way. Data in Callback function holds the whole HCI event packet, including EventCode, parameter length, and parameters.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in] | IsNewTransfer | If TRUE, a new transfer will be submitted. If FALSE, the request is deleted. |
| [in] | PollingInterval | Indicates the periodic rate, in milliseconds, that the transfer is to be executed. |
| [in] | DataLength | Specifies the length, in bytes, of the data to be received. |
| [in] | Callback | The callback function. This function is called if the asynchronous transfer is completed. |
| [in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
| EFI_SUCCESS | The HCI asynchronous receive request is submitted successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: DataLength is 0. If IsNewTransfer is TRUE, and an asynchronous receive request already exists. |
Definition at line 144 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_ASYNC_RECEIVE_SCO_DATA) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN BOOLEAN IsNewTransfer, IN UINTN PollingInterval, IN UINTN DataLength, IN EFI_BLUETOOTH_HC_ASYNC_FUNC_CALLBACK Callback, IN VOID *Context) |
Receive HCI SCO data packet in non-blocking way.
The AsyncReceiveSCOData() function receives HCI SCO data packet in non-blocking way. Data in Callback holds the whole HCI SCO data packet, including ConnectionHandle, PacketStatus flag, data length, and data.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in] | IsNewTransfer | If TRUE, a new transfer will be submitted. If FALSE, the request is deleted. |
| [in] | PollingInterval | Indicates the periodic rate, in milliseconds, that the transfer is to be executed. |
| [in] | DataLength | Specifies the length, in bytes, of the data to be received. |
| [in] | Callback | The callback function. This function is called if the asynchronous transfer is completed. |
| [in] | Context | Data passed into Callback function. This is optional parameter and may be NULL. |
| EFI_SUCCESS | The HCI asynchronous receive request is submitted successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: DataLength is 0. If IsNewTransfer is TRUE, and an asynchronous receive request already exists. |
Definition at line 363 of file BluetoothHc.h.
| typedef struct _EFI_BLUETOOTH_HC_PROTOCOL EFI_BLUETOOTH_HC_PROTOCOL |
Definition at line 21 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_RECEIVE_ACL_DATA) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer, IN UINTN Timeout) |
Receive HCI ACL data packet.
The ReceiveACLData() function receives HCI ACL data packet. Buffer holds the whole HCI ACL data packet, including Handle, PB flag, BC flag, data length, and data.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in,out] | BufferSize | On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. |
| [out] | Buffer | A pointer to the buffer of data that will be received from Bluetooth host controller. |
| [in] | Timeout | Indicating the transfer should be completed within this time frame. The units are in milliseconds. If Timeout is 0, then the caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. |
| EFI_SUCCESS | The HCI ACL data packet is received successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is 0. Buffer is NULL. |
| EFI_TIMEOUT | Receiving HCI ACL data packet fail due to timeout. |
| EFI_DEVICE_ERROR | Receiving HCI ACL data packet fail due to host controller or device error. |
Definition at line 224 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_RECEIVE_EVENT) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer, IN UINTN Timeout) |
Receive HCI event packet.
The ReceiveEvent() function receives HCI event packet. Buffer holds the whole HCI event packet, including EventCode, parameter length, and parameters.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in,out] | BufferSize | On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. |
| [out] | Buffer | A pointer to the buffer of data that will be received from Bluetooth host controller. |
| [in] | Timeout | Indicating the transfer should be completed within this time frame. The units are in milliseconds. If Timeout is 0, then the caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. |
| EFI_SUCCESS | The HCI event packet is received successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is 0. Buffer is NULL. |
| EFI_TIMEOUT | Receiving HCI event packet fail due to timeout. |
| EFI_DEVICE_ERROR | Receiving HCI event packet fail due to host controller or device error. |
Definition at line 91 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_RECEIVE_SCO_DATA) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer, IN UINTN Timeout) |
Receive HCI SCO data packet.
The ReceiveSCOData() function receives HCI SCO data packet. Buffer holds the whole HCI SCO data packet, including ConnectionHandle, PacketStatus flag, data length, and data.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in,out] | BufferSize | On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. |
| [out] | Buffer | A pointer to the buffer of data that will be received from Bluetooth host controller. |
| [in] | Timeout | Indicating the transfer should be completed within this time frame. The units are in milliseconds. If Timeout is 0, then the caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. |
| EFI_SUCCESS | The HCI SCO data packet is received successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is 0. Buffer is NULL. |
| EFI_TIMEOUT | Receiving HCI SCO data packet fail due to timeout. |
| EFI_DEVICE_ERROR | Receiving HCI SCO data packet fail due to host controller or device error. |
Definition at line 330 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_SEND_ACL_DATA) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout) |
Send HCI ACL data packet.
The SendACLData() function sends HCI ACL data packet. Buffer holds the whole HCI ACL data packet, including Handle, PB flag, BC flag, data length, and data.
The SendACLData() function and ReceiveACLData() function just send and receive data payload from application layer. In order to protect the payload data, the Bluetooth bus is required to call HCI_Set_Connection_Encryption command to enable hardware based encryption after authentication completed, according to pairing mode and host capability.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in,out] | BufferSize | On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. |
| [in] | Buffer | A pointer to the buffer of data that will be transmitted to Bluetooth host controller. |
| [in] | Timeout | Indicating the transfer should be completed within this time frame. The units are in milliseconds. If Timeout is 0, then the caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. |
| EFI_SUCCESS | The HCI ACL data packet is sent successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is 0. Buffer is NULL. |
| EFI_TIMEOUT | Sending HCI ACL data packet fail due to timeout. |
| EFI_DEVICE_ERROR | Sending HCI ACL data packet fail due to host controller or device error. |
Definition at line 188 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_SEND_COMMAND) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout) |
Send HCI command packet.
The SendCommand() function sends HCI command packet. Buffer holds the whole HCI command packet, including OpCode, OCF, OGF, parameter length, and parameters. When this function is returned, it just means the HCI command packet is sent, it does not mean the command is success or complete. Caller might need to wait a command status event to know the command status, or wait a command complete event to know if the command is completed.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in,out] | BufferSize | On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. |
| [in] | Buffer | A pointer to the buffer of data that will be transmitted to Bluetooth host controller. |
| [in] | Timeout | Indicating the transfer should be completed within this time frame. The units are in milliseconds. If Timeout is 0, then the caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. |
| EFI_SUCCESS | The HCI command packet is sent successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is 0. Buffer is NULL. |
| EFI_TIMEOUT | Sending HCI command packet fail due to timeout. |
| EFI_DEVICE_ERROR | Sending HCI command packet fail due to host controller or device error. |
Definition at line 55 of file BluetoothHc.h.
| typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_HC_SEND_SCO_DATA) (IN EFI_BLUETOOTH_HC_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout) |
Send HCI SCO data packet.
The SendSCOData() function sends HCI SCO data packet. Buffer holds the whole HCI SCO data packet, including ConnectionHandle, PacketStatus flag, data length, and data.
| [in] | This | Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. |
| [in,out] | BufferSize | On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. |
| [in] | Buffer | A pointer to the buffer of data that will be transmitted to Bluetooth host controller. |
| [in] | Timeout | Indicating the transfer should be completed within this time frame. The units are in milliseconds. If Timeout is 0, then the caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. |
| EFI_SUCCESS | The HCI SCO data packet is sent successfully. |
| EFI_UNSUPPORTED | The implementation does not support HCI SCO transfer. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: BufferSize is NULL. BufferSize is 0. Buffer is NULL. |
| EFI_TIMEOUT | Sending HCI SCO data packet fail due to timeout. |
| EFI_DEVICE_ERROR | Sending HCI SCO data packet fail due to host controller or device error. |
Definition at line 295 of file BluetoothHc.h.
1.9.6