diff options
Diffstat (limited to 'src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h')
| -rw-r--r-- | src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h | 100 |
1 files changed, 50 insertions, 50 deletions
diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h index cd72d2f6bc..eb14aac791 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h @@ -3,15 +3,15 @@ This protocol abstracts user interface configuration for Bluetooth device. Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials are licensed and made available under - the terms and conditions of the BSD License that accompanies this distribution. + This program and the accompanying materials are licensed and made available under + the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php. - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + http://opensource.org/licenses/bsd-license.php. + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.7 **/ @@ -25,7 +25,7 @@ { \ 0x62960cf3, 0x40ff, 0x4263, { 0xa7, 0x7c, 0xdf, 0xde, 0xbd, 0x19, 0x1b, 0x4b } \ } - + typedef struct _EFI_BLUETOOTH_CONFIG_PROTOCOL EFI_BLUETOOTH_CONFIG_PROTOCOL; typedef UINT32 EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE; @@ -41,7 +41,7 @@ typedef struct { /// BLUETOOTH_ADDRESS BDAddr; /// - /// State of the remote deive + /// State of the remote deive /// UINT8 RemoteDeviceState; /// @@ -113,12 +113,12 @@ typedef enum { /// typedef enum { /// - /// For SSP - passkey entry. Input buffer is Passkey (4 bytes). No output buffer. + /// For SSP - passkey entry. Input buffer is Passkey (4 bytes). No output buffer. /// See Bluetooth HCI command for detail. /// EfiBluetoothCallbackTypeUserPasskeyNotification, /// - /// For SSP - just work and numeric comparison. Input buffer is numeric value (4 bytes). + /// For SSP - just work and numeric comparison. Input buffer is numeric value (4 bytes). /// Output buffer is BOOLEAN (1 byte). See Bluetooth HCI command for detail. /// EfiBluetoothCallbackTypeUserConfirmationRequest, @@ -127,7 +127,7 @@ typedef enum { /// EfiBluetoothCallbackTypeOOBDataRequest, /// - /// For legacy paring. No input buffer. Output buffer is PIN code( <= 16 bytes). + /// For legacy paring. No input buffer. Output buffer is PIN code( <= 16 bytes). /// See Bluetooth HCI command for detail. /// EfiBluetoothCallbackTypePinCodeRequest, @@ -139,44 +139,44 @@ typedef enum { /// typedef enum { /// - /// This callback is called when Bluetooth receive Disconnection_Complete event. Input buffer is Event + /// This callback is called when Bluetooth receive Disconnection_Complete event. Input buffer is Event /// Parameters of Disconnection_Complete Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeDisconnected, /// - /// This callback is called when Bluetooth receive Connection_Complete event. Input buffer is Event + /// This callback is called when Bluetooth receive Connection_Complete event. Input buffer is Event /// Parameters of Connection_Complete Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeConnected, /// - /// This callback is called when Bluetooth receive Authentication_Complete event. Input buffer is Event + /// This callback is called when Bluetooth receive Authentication_Complete event. Input buffer is Event /// Parameters of Authentication_Complete Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeAuthenticated, /// - /// This callback is called when Bluetooth receive Encryption_Change event. Input buffer is Event + /// This callback is called when Bluetooth receive Encryption_Change event. Input buffer is Event /// Parameters of Encryption_Change Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeEncrypted } EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE; - + /** Initialize Bluetooth host controller and local device. @param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. @retval EFI_SUCCESS The Bluetooth host controller and local device is initialized successfully. - @retval EFI_DEVICE_ERROR A hardware error occurred trying to initialize the Bluetooth host controller + @retval EFI_DEVICE_ERROR A hardware error occurred trying to initialize the Bluetooth host controller and local device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_INIT)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This ); - + /** Callback function, it is called if a Bluetooth device is found during scan process. @@ -194,16 +194,16 @@ EFI_STATUS IN VOID *Context, IN EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION *CallbackInfo ); - + /** Scan Bluetooth device. @param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. - @param 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 + @param 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. @param ScanType Bluetooth scan type, Inquiry and/or Page. See Bluetooth specification for detail. - @param Callback The callback function. This function is called if a Bluetooth device is found during scan + @param Callback The callback function. This function is called if a Bluetooth device is found during scan process. @param Context Data passed into Callback function. This is optional parameter and may be NULL. @@ -211,7 +211,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A hardware error occurred trying to scan the Bluetooth device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -220,7 +220,7 @@ EFI_STATUS IN EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION Callback, IN VOID *Context ); - + /** Connect a Bluetooth device. @@ -233,7 +233,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A hardware error occurred trying to connect the Bluetooth device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_CONNECT)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -253,14 +253,14 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A hardware error occurred trying to disconnect the Bluetooth device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_DISCONNECT)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN BLUETOOTH_ADDRESS *BD_ADDR, IN UINT8 Reason ); - + /** Get Bluetooth configuration data. @@ -280,7 +280,7 @@ EFI_STATUS *DataSize has been updated with the size needed to complete the request. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_GET_DATA)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -288,7 +288,7 @@ EFI_STATUS IN OUT UINTN *DataSize, IN OUT VOID *Data ); - + /** Set Bluetooth configuration data. @@ -305,7 +305,7 @@ EFI_STATUS @retval EFI_BUFFER_TOO_SMALL Cannot set configuration data. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_SET_DATA)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -313,7 +313,7 @@ EFI_STATUS IN UINTN DataSize, IN VOID *Data ); - + /** Get remove Bluetooth device configuration data. @@ -334,7 +334,7 @@ EFI_STATUS *DataSize has been updated with the size needed to complete the request. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -343,7 +343,7 @@ EFI_STATUS IN OUT UINTN *DataSize, IN OUT VOID *Data ); - + /** The callback function for PIN code. @@ -352,14 +352,14 @@ EFI_STATUS @param CallbackType Callback type in EFI_BLUETOOTH_PIN_CALLBACK_TYPE. @param InputBuffer A pointer to the buffer of data that is input from callback caller. @param InputBufferSize Indicates the size, in bytes, of the data buffer specified by InputBuffer. - @param OutputBuffer A pointer to the buffer of data that will be output from callback callee. + @param 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(). @param OutputBufferSize Indicates the size, in bytes, of the data buffer specified by OutputBuffer. @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -370,7 +370,7 @@ EFI_STATUS OUT VOID **OutputBuffer, OUT UINTN *OutputBufferSize ); - + /** Register PIN callback function. @@ -381,7 +381,7 @@ EFI_STATUS @retval EFI_SUCCESS The PIN callback function is registered successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -400,7 +400,7 @@ EFI_STATUS @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -408,7 +408,7 @@ EFI_STATUS IN BLUETOOTH_ADDRESS *BDAddr, OUT UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE] ); - + /** Register get link key callback function. @@ -419,14 +419,14 @@ EFI_STATUS @retval EFI_SUCCESS The link key callback function is registered successfully. **/ -typedef +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 ); - + /** The callback function to set link key. @@ -438,7 +438,7 @@ EFI_STATUS @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -446,7 +446,7 @@ EFI_STATUS IN BLUETOOTH_ADDRESS *BDAddr, IN UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE] ); - + /** Register set link key callback function. @@ -457,14 +457,14 @@ EFI_STATUS @retval EFI_SUCCESS The link key callback function is registered successfully. **/ -typedef +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 ); - + /** The callback function. It is called after connect completed. @@ -478,7 +478,7 @@ EFI_STATUS @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -488,7 +488,7 @@ EFI_STATUS IN VOID *InputBuffer, IN UINTN InputBufferSize ); - + /** Register link connect complete callback function. @@ -499,14 +499,14 @@ EFI_STATUS @retval EFI_SUCCESS The link connect complete callback function is registered successfully. **/ -typedef +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 ); - + /// /// This protocol abstracts user interface configuration for Bluetooth device. /// |