[mirror_edk2.git] / MdePkg / Include / Protocol / BluetoothConfig.h

/** @file\r
  EFI Bluetooth Configuration Protocol as defined in UEFI 2.5.\r
  This protocol abstracts user interface configuration for Bluetooth device.\r
\r
  Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials are licensed and made available under \r
  the terms and conditions of the BSD License that accompanies this distribution.  \r
  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.                                          \r
    \r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  @par Revision Reference:          \r
  This Protocol is introduced in UEFI Specification 2.5\r
\r
**/\r
\r
#ifndef __EFI_BLUETOOTH_CONFIG_PROTOCOL_H__\r
#define __EFI_BLUETOOTH_CONFIG_PROTOCOL_H__\r
\r
#include <IndustryStandard/Bluetooth.h>\r
\r
#define EFI_BLUETOOTH_CONFIG_PROTOCOL_GUID \\r
  { \\r
    0x62960cf3, 0x40ff, 0x4263, { 0xa7, 0x7c, 0xdf, 0xde, 0xbd, 0x19, 0x1b, 0x4b } \\r
  }\r
  \r
typedef struct _EFI_BLUETOOTH_CONFIG_PROTOCOL EFI_BLUETOOTH_CONFIG_PROTOCOL;\r
\r
typedef UINT32      EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE;\r
#define EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_CONNECTED    0x1\r
#define EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_PAIRED       0x2\r
\r
///\r
/// EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION\r
///\r
typedef struct {\r
  ///\r
  /// 48bit Bluetooth device address.\r
  ///\r
  BLUETOOTH_ADDRESS         BDAddr;\r
  ///\r
  /// State of the remote deive \r
  ///\r
  UINT8                     RemoteDeviceState;\r
  ///\r
  /// Bluetooth ClassOfDevice. See Bluetooth specification for detail.\r
  ///\r
  BLUETOOTH_CLASS_OF_DEVICE ClassOfDevice;\r
  ///\r
  /// Remote device name\r
  ///\r
  UINT8                     RemoteDeviceName[BLUETOOTH_HCI_COMMAND_LOCAL_READABLE_NAME_MAX_SIZE];\r
} EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION;\r
\r
///\r
/// EFI_BLUETOOTH_CONFIG_DATA_TYPE\r
///\r
typedef enum {\r
  ///\r
  /// Local/Remote Bluetooth device name. Data structure is zero terminated CHAR8[].\r
  ///\r
  EfiBluetoothConfigDataTypeDeviceName,\r
  ///\r
  /// Local/Remote Bluetooth device ClassOfDevice. Data structure is BLUETOOTH_CLASS_OF_DEVICE.\r
  ///\r
  EfiBluetoothConfigDataTypeClassOfDevice,\r
  ///\r
  /// Remote Bluetooth device state. Data structure is EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE.\r
  ///\r
  EfiBluetoothConfigDataTypeRemoteDeviceState,\r
  ///\r
  /// Local/Remote Bluetooth device SDP information. Data structure is UINT8[].\r
  ///\r
  EfiBluetoothConfigDataTypeSdpInfo,\r
  ///\r
  /// Local Bluetooth device address. Data structure is BLUETOOTH_ADDRESS.\r
  ///\r
  EfiBluetoothConfigDataTypeBDADDR,\r
  ///\r
  /// Local Bluetooth discoverable state. Data structure is UINT8. (Page scan and/or Inquiry scan)\r
  ///\r
  EfiBluetoothConfigDataTypeDiscoverable,\r
  ///\r
  /// Local Bluetooth controller stored paired device list. Data structure is BLUETOOTH_ADDRESS[].\r
  ///\r
  EfiBluetoothConfigDataTypeControllerStoredPairedDeviceList,\r
  ///\r
  /// Local available device list. Data structure is BLUETOOTH_ADDRESS[].\r
  ///\r
  EfiBluetoothConfigDataTypeAvailableDeviceList,\r
  EfiBluetoothConfigDataTypeMax,\r
} EFI_BLUETOOTH_CONFIG_DATA_TYPE;\r
\r
///\r
/// EFI_BLUETOOTH_PIN_CALLBACK_TYPE.\r
///\r
typedef enum {\r
  ///\r
  /// For SSP - passkey entry. Input buffer is Passkey (4 bytes). No output buffer. \r
  /// See Bluetooth HCI command for detail.\r
  ///\r
  EfiBluetoothCallbackTypeUserPasskeyNotification,\r
  ///\r
  /// For SSP - just work and numeric comparison. Input buffer is numeric value (4 bytes). \r
  /// Output buffer is BOOLEAN (1 byte). See Bluetooth HCI command for detail.\r
  ///\r
  EfiBluetoothCallbackTypeUserConfirmationRequest,\r
  ///\r
  /// For SSP - OOB. See Bluetooth HCI command for detail.\r
  ///\r
  EfiBluetoothCallbackTypeOOBDataRequest,\r
  ///\r
  /// For legacy paring. No input buffer. Output buffer is PIN code( <= 16 bytes). \r
  /// See Bluetooth HCI command for detail.\r
  ///\r
  EfiBluetoothCallbackTypePinCodeRequest,\r
  EfiBluetoothCallbackTypeMax\r
} EFI_BLUETOOTH_PIN_CALLBACK_TYPE;\r
\r
///\r
/// EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE.\r
///\r
typedef enum {\r
  ///\r
  /// This callback is called when Bluetooth receive Disconnection_Complete event. Input buffer is Event \r
  /// Parameters of Disconnection_Complete Event defined in Bluetooth specification.\r
  ///\r
  EfiBluetoothConnCallbackTypeDisconnected,\r
  ///\r
  /// This callback is called when Bluetooth receive Connection_Complete event. Input buffer is Event \r
  /// Parameters of Connection_Complete Event defined in Bluetooth specification.\r
  ///\r
  EfiBluetoothConnCallbackTypeConnected,\r
  ///\r
  /// This callback is called when Bluetooth receive Authentication_Complete event. Input buffer is Event \r
  /// Parameters of Authentication_Complete Event defined in Bluetooth specification.\r
  ///\r
  EfiBluetoothConnCallbackTypeAuthenticated,\r
  ///\r
  /// This callback is called when Bluetooth receive Encryption_Change event. Input buffer is Event \r
  /// Parameters of Encryption_Change Event defined in Bluetooth specification.\r
  ///\r
  EfiBluetoothConnCallbackTypeEncrypted\r
} EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE;\r
\r
  \r
/**\r
  Initialize Bluetooth host controller and local device.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS           The Bluetooth host controller and local device is initialized successfully.\r
  @retval EFI_DEVICE_ERROR      A hardware error occurred trying to initialize the Bluetooth host controller \r
                                and local device.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_INIT)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL  *This\r
  );\r
  \r
/**\r
  Callback function, it is called if a Bluetooth device is found during scan process.\r
\r
  @param  This            Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Context         Context passed from scan request.\r
  @param  CallbackInfo    Data related to scan result. NULL CallbackInfo means scan complete.\r
\r
  @retval EFI_SUCCESS       The callback function complete successfully.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION) (\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL            *This,\r
  IN VOID                                     *Context,\r
  IN EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION  *CallbackInfo\r
  );\r
  \r
/**\r
  Scan Bluetooth device.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  ReScan        If TRUE, a new scan request is submitted no matter there is scan result before. \r
                        If FALSE and there is scan result, the previous scan result is returned and no scan request \r
                        is submitted.\r
  @param  ScanType      Bluetooth scan type, Inquiry and/or Page. See Bluetooth specification for detail.\r
  @param  Callback      The callback function. This function is called if a Bluetooth device is found during scan \r
                        process.\r
  @param  Context       Data passed into Callback function. This is optional parameter and may be NULL.\r
\r
  @retval EFI_SUCCESS           The Bluetooth scan request is submitted.\r
  @retval EFI_DEVICE_ERROR      A hardware error occurred trying to scan the Bluetooth device.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN BOOLEAN                                        ReScan,\r
  IN UINT8                                          ScanType,\r
  IN EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION    Callback,\r
  IN VOID                                           *Context\r
  );\r
  \r
/**\r
  Connect a Bluetooth device.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  BD_ADDR       The address of Bluetooth device to be connected.\r
\r
  @retval EFI_SUCCESS           The Bluetooth device is connected successfully.\r
  @retval EFI_ALREADY_STARTED   The Bluetooth device is already connected.\r
  @retval EFI_NOT_FOUND         The Bluetooth device is not found.\r
  @retval EFI_DEVICE_ERROR      A hardware error occurred trying to connect the Bluetooth device.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_CONNECT)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN BLUETOOTH_ADDRESS                              *BD_ADDR\r
  );\r
\r
/**\r
  Disconnect a Bluetooth device.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  BD_ADDR       The address of Bluetooth device to be connected.\r
  @param  Reason        Bluetooth disconnect reason. See Bluetooth specification for detail.\r
\r
  @retval EFI_SUCCESS           The Bluetooth device is disconnected successfully.\r
  @retval EFI_NOT_STARTED       The Bluetooth device is not connected.\r
  @retval EFI_NOT_FOUND         The Bluetooth device is not found.\r
  @retval EFI_DEVICE_ERROR      A hardware error occurred trying to disconnect the Bluetooth device.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_DISCONNECT)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN BLUETOOTH_ADDRESS                              *BD_ADDR,\r
  IN UINT8                                          Reason\r
  );\r
  \r
/**\r
  Get Bluetooth configuration data.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  DataType      Configuration data type.\r
  @param  DataSize      On input, indicates the size, in bytes, of the data buffer specified by Data.\r
                        On output, indicates the amount of data actually returned.\r
  @param  Data          A pointer to the buffer of data that will be returned.\r
\r
  @retval EFI_SUCCESS           The Bluetooth configuration data is returned successfully.\r
  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
                                - DataSize is NULL.\r
                                - *DataSize is 0.\r
                                - Data is NULL.\r
  @retval EFI_UNSUPPORTED       The DataType is unsupported.\r
  @retval EFI_NOT_FOUND         The DataType is not found.\r
  @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_GET_DATA)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN EFI_BLUETOOTH_CONFIG_DATA_TYPE                 DataType,\r
  IN OUT UINTN                                      *DataSize,\r
  IN OUT VOID                                       *Data\r
  );\r
  \r
/**\r
  Set Bluetooth configuration data.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  DataType      Configuration data type.\r
  @param  DataSize      Indicates the size, in bytes, of the data buffer specified by Data.\r
  @param  Data          A pointer to the buffer of data that will be set.\r
\r
  @retval EFI_SUCCESS           The Bluetooth configuration data is set successfully.\r
  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
                                - DataSize is 0.\r
                                - Data is NULL.\r
  @retval EFI_UNSUPPORTED       The DataType is unsupported.\r
  @retval EFI_BUFFER_TOO_SMALL  Cannot set configuration data.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_SET_DATA)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN EFI_BLUETOOTH_CONFIG_DATA_TYPE                 DataType,\r
  IN UINTN                                          DataSize,\r
  IN VOID                                           *Data\r
  );\r
  \r
/**\r
  Get remove Bluetooth device configuration data.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  DataType      Configuration data type.\r
  @param  BDAddr        Remote Bluetooth device address.\r
  @param  DataSize      On input, indicates the size, in bytes, of the data buffer specified by Data.\r
                        On output, indicates the amount of data actually returned.\r
  @param  Data          A pointer to the buffer of data that will be returned.\r
\r
  @retval EFI_SUCCESS           The remote Bluetooth device configuration data is returned successfully.\r
  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
                                - DataSize is NULL.\r
                                - *DataSize is 0.\r
                                - Data is NULL.\r
  @retval EFI_UNSUPPORTED       The DataType is unsupported.\r
  @retval EFI_NOT_FOUND         The DataType is not found.\r
  @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN EFI_BLUETOOTH_CONFIG_DATA_TYPE                 DataType,\r
  IN BLUETOOTH_ADDRESS                              BDAddr,\r
  IN OUT UINTN                                      *DataSize,\r
  IN OUT VOID                                       *Data\r
  );\r
  \r
/**\r
  The callback function for PIN code.\r
\r
  @param  This                Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Context             Context passed from registration.\r
  @param  CallbackType        Callback type in EFI_BLUETOOTH_PIN_CALLBACK_TYPE.\r
  @param  InputBuffer         A pointer to the buffer of data that is input from callback caller.\r
  @param  InputBufferSize     Indicates the size, in bytes, of the data buffer specified by InputBuffer.\r
  @param  OutputBuffer        A pointer to the buffer of data that will be output from callback callee. \r
                              Callee allocates this buffer by using EFI Boot Service AllocatePool().\r
  @param  OutputBufferSize    Indicates the size, in bytes, of the data buffer specified by OutputBuffer.\r
\r
  @retval EFI_SUCCESS   The callback function complete successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                        *This,\r
  IN VOID                                                 *Context,\r
  IN EFI_BLUETOOTH_PIN_CALLBACK_TYPE                      CallbackType,\r
  IN VOID                                                 *InputBuffer,\r
  IN UINTN                                                InputBufferSize,\r
  OUT VOID                                                **OutputBuffer,\r
  OUT UINTN                                               *OutputBufferSize\r
  );\r
  \r
/**\r
  Register PIN callback function.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Callback      The callback function. NULL means unregister.\r
  @param  Context       Data passed into Callback function. This is optional parameter and may be NULL.\r
\r
  @retval EFI_SUCCESS   The PIN callback function is registered successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                        *This,\r
  IN EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION  Callback,\r
  IN VOID                                                 *Context\r
  );\r
\r
/**\r
  The callback function to get link key.\r
\r
  @param  This                Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Context             Context passed from registration.\r
  @param  BDAddr              A pointer to Bluetooth device address.\r
  @param  LinkKey             A pointer to the buffer of link key.\r
\r
  @retval EFI_SUCCESS   The callback function complete successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL        *This,\r
  IN VOID                                 *Context,\r
  IN BLUETOOTH_ADDRESS                    *BDAddr,\r
  OUT UINT8                               LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE]\r
  );\r
  \r
/**\r
  Register get link key callback function.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Callback      The callback function. NULL means unregister.\r
  @param  Context       Data passed into Callback function. This is optional parameter and may be NULL.\r
\r
  @retval EFI_SUCCESS   The link key callback function is registered successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                                  *This,\r
  IN EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION   Callback,\r
  IN VOID                                                           *Context\r
  );\r
  \r
/**\r
  The callback function to set link key.\r
\r
  @param  This                Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Context             Context passed from registration.\r
  @param  BDAddr              A pointer to Bluetooth device address.\r
  @param  LinkKey             A pointer to the buffer of link key.\r
\r
  @retval EFI_SUCCESS   The callback function complete successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL        *This,\r
  IN VOID                                 *Context,\r
  IN BLUETOOTH_ADDRESS                    *BDAddr,\r
  IN UINT8                                LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE]\r
  );\r
  \r
/**\r
  Register set link key callback function.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Callback      The callback function. NULL means unregister.\r
  @param  Context       Data passed into Callback function. This is optional parameter and may be NULL.\r
\r
  @retval EFI_SUCCESS   The link key callback function is registered successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                                  *This,\r
  IN EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION   Callback,\r
  IN VOID                                                           *Context\r
  );\r
  \r
/**\r
  The callback function. It is called after connect completed.\r
\r
  @param  This                Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Context             Context passed from registration.\r
  @param  CallbackType        Callback type in EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE.\r
  @param  BDAddr              A pointer to Bluetooth device address.\r
  @param  InputBuffer         A pointer to the buffer of data that is input from callback caller.\r
  @param  InputBufferSize     Indicates the size, in bytes, of the data buffer specified by InputBuffer.\r
\r
  @retval EFI_SUCCESS   The callback function complete successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                  *This,\r
  IN VOID                                           *Context,\r
  IN EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE   CallbackType,\r
  IN BLUETOOTH_ADDRESS                              *BDAddr,\r
  IN VOID                                           *InputBuffer,\r
  IN UINTN                                          InputBufferSize\r
  );\r
  \r
/**\r
  Register link connect complete callback function.\r
\r
  @param  This          Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
  @param  Callback      The callback function. NULL means unregister.\r
  @param  Context       Data passed into Callback function. This is optional parameter and may be NULL.\r
\r
  @retval EFI_SUCCESS   The link connect complete callback function is registered successfully.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK)(\r
  IN EFI_BLUETOOTH_CONFIG_PROTOCOL                                      *This,\r
  IN EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION   Callback,\r
  IN VOID                                                               *Context\r
  );\r
  \r
///\r
/// This protocol abstracts user interface configuration for Bluetooth device.\r
///\r
struct _EFI_BLUETOOTH_CONFIG_PROTOCOL {\r
  EFI_BLUETOOTH_CONFIG_INIT                               Init;\r
  EFI_BLUETOOTH_CONFIG_SCAN                               Scan;\r
  EFI_BLUETOOTH_CONFIG_CONNECT                            Connect;\r
  EFI_BLUETOOTH_CONFIG_DISCONNECT                         Disconnect;\r
  EFI_BLUETOOTH_CONFIG_GET_DATA                           GetData;\r
  EFI_BLUETOOTH_CONFIG_SET_DATA                           SetData;\r
  EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA                    GetRemoteData;\r
  EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK              RegisterPinCallback;\r
  EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK     RegisterGetLinkKeyCallback;\r
  EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK     RegisterSetLinkKeyCallback;\r
  EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK RegisterLinkConnectCompleteCallback;\r
};\r
\r
extern EFI_GUID gEfiBluetoothConfigProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
362c355c QS	1	/** @file\r
	2	EFI Bluetooth Configuration Protocol as defined in UEFI 2.5.\r
	3	This protocol abstracts user interface configuration for Bluetooth device.\r
	4	\r
	5	Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials are licensed and made available under \r
	7	the terms and conditions of the BSD License that accompanies this distribution. \r
	8	The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php. \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	@par Revision Reference: \r
	15	This Protocol is introduced in UEFI Specification 2.5\r
	16	\r
	17	**/\r
	18	\r
	19	#ifndef __EFI_BLUETOOTH_CONFIG_PROTOCOL_H__\r
	20	#define __EFI_BLUETOOTH_CONFIG_PROTOCOL_H__\r
	21	\r
	22	#include <IndustryStandard/Bluetooth.h>\r
	23	\r
	24	#define EFI_BLUETOOTH_CONFIG_PROTOCOL_GUID \\r
	25	{ \\r
	26	0x62960cf3, 0x40ff, 0x4263, { 0xa7, 0x7c, 0xdf, 0xde, 0xbd, 0x19, 0x1b, 0x4b } \\r
	27	}\r
	28	\r
	29	typedef struct _EFI_BLUETOOTH_CONFIG_PROTOCOL EFI_BLUETOOTH_CONFIG_PROTOCOL;\r
	30	\r
	31	typedef UINT32 EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE;\r
	32	#define EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_CONNECTED 0x1\r
	33	#define EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_PAIRED 0x2\r
	34	\r
	35	///\r
	36	/// EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION\r
	37	///\r
	38	typedef struct {\r
	39	///\r
	40	/// 48bit Bluetooth device address.\r
	41	///\r
	42	BLUETOOTH_ADDRESS BDAddr;\r
	43	///\r
	44	/// State of the remote deive \r
	45	///\r
	46	UINT8 RemoteDeviceState;\r
	47	///\r
	48	/// Bluetooth ClassOfDevice. See Bluetooth specification for detail.\r
	49	///\r
	50	BLUETOOTH_CLASS_OF_DEVICE ClassOfDevice;\r
	51	///\r
	52	/// Remote device name\r
	53	///\r
	54	UINT8 RemoteDeviceName[BLUETOOTH_HCI_COMMAND_LOCAL_READABLE_NAME_MAX_SIZE];\r
	55	} EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION;\r
	56	\r
	57	///\r
	58	/// EFI_BLUETOOTH_CONFIG_DATA_TYPE\r
	59	///\r
	60	typedef enum {\r
	61	///\r
	62	/// Local/Remote Bluetooth device name. Data structure is zero terminated CHAR8[].\r
	63	///\r
	64	EfiBluetoothConfigDataTypeDeviceName,\r
65	///\r
66	/// Local/Remote Bluetooth device ClassOfDevice. Data structure is BLUETOOTH_CLASS_OF_DEVICE.\r
67	///\r
68	EfiBluetoothConfigDataTypeClassOfDevice,\r
69	///\r
70	/// Remote Bluetooth device state. Data structure is EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE.\r
71	///\r
72	EfiBluetoothConfigDataTypeRemoteDeviceState,\r
73	///\r
74	/// Local/Remote Bluetooth device SDP information. Data structure is UINT8[].\r
75	///\r
76	EfiBluetoothConfigDataTypeSdpInfo,\r
77	///\r
78	/// Local Bluetooth device address. Data structure is BLUETOOTH_ADDRESS.\r
79	///\r
80	EfiBluetoothConfigDataTypeBDADDR,\r
81	///\r
82	/// Local Bluetooth discoverable state. Data structure is UINT8. (Page scan and/or Inquiry scan)\r
83	///\r
84	EfiBluetoothConfigDataTypeDiscoverable,\r
85	///\r
86	/// Local Bluetooth controller stored paired device list. Data structure is BLUETOOTH_ADDRESS[].\r
87	///\r
88	EfiBluetoothConfigDataTypeControllerStoredPairedDeviceList,\r
89	///\r
90	/// Local available device list. Data structure is BLUETOOTH_ADDRESS[].\r
91	///\r
92	EfiBluetoothConfigDataTypeAvailableDeviceList,\r
93	EfiBluetoothConfigDataTypeMax,\r
94	} EFI_BLUETOOTH_CONFIG_DATA_TYPE;\r
95	\r
96	///\r
97	/// EFI_BLUETOOTH_PIN_CALLBACK_TYPE.\r
98	///\r
99	typedef enum {\r
100	///\r
101	/// For SSP - passkey entry. Input buffer is Passkey (4 bytes). No output buffer. \r
102	/// See Bluetooth HCI command for detail.\r
103	///\r
104	EfiBluetoothCallbackTypeUserPasskeyNotification,\r
105	///\r
106	/// For SSP - just work and numeric comparison. Input buffer is numeric value (4 bytes). \r
107	/// Output buffer is BOOLEAN (1 byte). See Bluetooth HCI command for detail.\r
108	///\r
109	EfiBluetoothCallbackTypeUserConfirmationRequest,\r
110	///\r
111	/// For SSP - OOB. See Bluetooth HCI command for detail.\r
112	///\r
113	EfiBluetoothCallbackTypeOOBDataRequest,\r
114	///\r
115	/// For legacy paring. No input buffer. Output buffer is PIN code( <= 16 bytes). \r
116	/// See Bluetooth HCI command for detail.\r
117	///\r
118	EfiBluetoothCallbackTypePinCodeRequest,\r
119	EfiBluetoothCallbackTypeMax\r
120	} EFI_BLUETOOTH_PIN_CALLBACK_TYPE;\r
121	\r
122	///\r
123	/// EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE.\r
124	///\r
125	typedef enum {\r
126	///\r
127	/// This callback is called when Bluetooth receive Disconnection_Complete event. Input buffer is Event \r
128	/// Parameters of Disconnection_Complete Event defined in Bluetooth specification.\r
129	///\r
130	EfiBluetoothConnCallbackTypeDisconnected,\r
131	///\r
132	/// This callback is called when Bluetooth receive Connection_Complete event. Input buffer is Event \r
133	/// Parameters of Connection_Complete Event defined in Bluetooth specification.\r
134	///\r
135	EfiBluetoothConnCallbackTypeConnected,\r
136	///\r
137	/// This callback is called when Bluetooth receive Authentication_Complete event. Input buffer is Event \r
138	/// Parameters of Authentication_Complete Event defined in Bluetooth specification.\r
139	///\r
140	EfiBluetoothConnCallbackTypeAuthenticated,\r
141	///\r
142	/// This callback is called when Bluetooth receive Encryption_Change event. Input buffer is Event \r
143	/// Parameters of Encryption_Change Event defined in Bluetooth specification.\r
144	///\r
145	EfiBluetoothConnCallbackTypeEncrypted\r
146	} EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE;\r
147	\r
148	\r
149	/**\r
150	Initialize Bluetooth host controller and local device.\r
151	\r
152	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
153	\r
154	@retval EFI_SUCCESS The Bluetooth host controller and local device is initialized successfully.\r
155	@retval EFI_DEVICE_ERROR A hardware error occurred trying to initialize the Bluetooth host controller \r
156	and local device.\r
157	\r
158	**/\r
159	typedef \r
160	EFI_STATUS\r
161	(EFIAPI *EFI_BLUETOOTH_CONFIG_INIT)(\r
162	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This\r
163	);\r
164	\r
165	/**\r
166	Callback function, it is called if a Bluetooth device is found during scan process.\r
167	\r
168	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
169	@param Context Context passed from scan request.\r
170	@param CallbackInfo Data related to scan result. NULL CallbackInfo means scan complete.\r
171	\r
172	@retval EFI_SUCCESS The callback function complete successfully.\r
173	\r
174	**/\r
175	typedef\r
176	EFI_STATUS\r
177	(EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION) (\r
178	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
179	IN VOID *Context,\r
180	IN EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION *CallbackInfo\r
181	);\r
182	\r
183	/**\r
184	Scan Bluetooth device.\r
185	\r
186	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
187	@param ReScan If TRUE, a new scan request is submitted no matter there is scan result before. \r
188	If FALSE and there is scan result, the previous scan result is returned and no scan request \r
189	is submitted.\r
190	@param ScanType Bluetooth scan type, Inquiry and/or Page. See Bluetooth specification for detail.\r
191	@param Callback The callback function. This function is called if a Bluetooth device is found during scan \r
192	process.\r
193	@param Context Data passed into Callback function. This is optional parameter and may be NULL.\r
194	\r
195	@retval EFI_SUCCESS The Bluetooth scan request is submitted.\r
196	@retval EFI_DEVICE_ERROR A hardware error occurred trying to scan the Bluetooth device.\r
197	\r
198	**/\r
199	typedef \r
200	EFI_STATUS\r
201	(EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN)(\r
202	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
203	IN BOOLEAN ReScan,\r
204	IN UINT8 ScanType,\r
205	IN EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION Callback,\r
206	IN VOID *Context\r
207	);\r
208	\r
209	/**\r
210	Connect a Bluetooth device.\r
211	\r
212	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
213	@param BD_ADDR The address of Bluetooth device to be connected.\r
214	\r
215	@retval EFI_SUCCESS The Bluetooth device is connected successfully.\r
216	@retval EFI_ALREADY_STARTED The Bluetooth device is already connected.\r
217	@retval EFI_NOT_FOUND The Bluetooth device is not found.\r
218	@retval EFI_DEVICE_ERROR A hardware error occurred trying to connect the Bluetooth device.\r
219	\r
220	**/\r
221	typedef \r
222	EFI_STATUS\r
223	(EFIAPI *EFI_BLUETOOTH_CONFIG_CONNECT)(\r
224	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
225	IN BLUETOOTH_ADDRESS *BD_ADDR\r
226	);\r
227	\r
228	/**\r
229	Disconnect a Bluetooth device.\r
230	\r
231	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
232	@param BD_ADDR The address of Bluetooth device to be connected.\r
233	@param Reason Bluetooth disconnect reason. See Bluetooth specification for detail.\r
234	\r
235	@retval EFI_SUCCESS The Bluetooth device is disconnected successfully.\r
236	@retval EFI_NOT_STARTED The Bluetooth device is not connected.\r
237	@retval EFI_NOT_FOUND The Bluetooth device is not found.\r
238	@retval EFI_DEVICE_ERROR A hardware error occurred trying to disconnect the Bluetooth device.\r
239	\r
240	**/\r
241	typedef \r
242	EFI_STATUS\r
243	(EFIAPI *EFI_BLUETOOTH_CONFIG_DISCONNECT)(\r
244	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
245	IN BLUETOOTH_ADDRESS *BD_ADDR,\r
246	IN UINT8 Reason\r
247	);\r
248	\r
249	/**\r
250	Get Bluetooth configuration data.\r
251	\r
252	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
253	@param DataType Configuration data type.\r
254	@param DataSize On input, indicates the size, in bytes, of the data buffer specified by Data.\r
255	On output, indicates the amount of data actually returned.\r
256	@param Data A pointer to the buffer of data that will be returned.\r
257	\r
258	@retval EFI_SUCCESS The Bluetooth configuration data is returned successfully.\r
259	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
260	- DataSize is NULL.\r
261	- *DataSize is 0.\r
262	- Data is NULL.\r
263	@retval EFI_UNSUPPORTED The DataType is unsupported.\r
264	@retval EFI_NOT_FOUND The DataType is not found.\r
265	@retval EFI_BUFFER_TOO_SMALL The buffer is too small to hold the buffer.\r
266	\r
267	**/\r
268	typedef \r
269	EFI_STATUS\r
270	(EFIAPI *EFI_BLUETOOTH_CONFIG_GET_DATA)(\r
271	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
272	IN EFI_BLUETOOTH_CONFIG_DATA_TYPE DataType,\r
273	IN OUT UINTN *DataSize,\r
274	IN OUT VOID *Data\r
275	);\r
276	\r
277	/**\r
278	Set Bluetooth configuration data.\r
279	\r
280	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
281	@param DataType Configuration data type.\r
282	@param DataSize Indicates the size, in bytes, of the data buffer specified by Data.\r
283	@param Data A pointer to the buffer of data that will be set.\r
284	\r
285	@retval EFI_SUCCESS The Bluetooth configuration data is set successfully.\r
286	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
287	- DataSize is 0.\r
288	- Data is NULL.\r
289	@retval EFI_UNSUPPORTED The DataType is unsupported.\r
290	@retval EFI_BUFFER_TOO_SMALL Cannot set configuration data.\r
291	\r
292	**/\r
293	typedef \r
294	EFI_STATUS\r
295	(EFIAPI *EFI_BLUETOOTH_CONFIG_SET_DATA)(\r
296	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
297	IN EFI_BLUETOOTH_CONFIG_DATA_TYPE DataType,\r
298	IN UINTN DataSize,\r
299	IN VOID *Data\r
300	);\r
301	\r
302	/**\r
303	Get remove Bluetooth device configuration data.\r
304	\r
305	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
306	@param DataType Configuration data type.\r
307	@param BDAddr Remote Bluetooth device address.\r
308	@param DataSize On input, indicates the size, in bytes, of the data buffer specified by Data.\r
309	On output, indicates the amount of data actually returned.\r
310	@param Data A pointer to the buffer of data that will be returned.\r
311	\r
312	@retval EFI_SUCCESS The remote Bluetooth device configuration data is returned successfully.\r
313	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
314	- DataSize is NULL.\r
315	- *DataSize is 0.\r
316	- Data is NULL.\r
317	@retval EFI_UNSUPPORTED The DataType is unsupported.\r
318	@retval EFI_NOT_FOUND The DataType is not found.\r
319	@retval EFI_BUFFER_TOO_SMALL The buffer is too small to hold the buffer.\r
320	\r
321	**/\r
322	typedef \r
323	EFI_STATUS\r
324	(EFIAPI *EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA)(\r
325	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
326	IN EFI_BLUETOOTH_CONFIG_DATA_TYPE DataType,\r
327	IN BLUETOOTH_ADDRESS BDAddr,\r
328	IN OUT UINTN *DataSize,\r
329	IN OUT VOID *Data\r
330	);\r
331	\r
332	/**\r
333	The callback function for PIN code.\r
334	\r
335	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
336	@param Context Context passed from registration.\r
337	@param CallbackType Callback type in EFI_BLUETOOTH_PIN_CALLBACK_TYPE.\r
338	@param InputBuffer A pointer to the buffer of data that is input from callback caller.\r
339	@param InputBufferSize Indicates the size, in bytes, of the data buffer specified by InputBuffer.\r
340	@param OutputBuffer A pointer to the buffer of data that will be output from callback callee. \r
341	Callee allocates this buffer by using EFI Boot Service AllocatePool().\r
342	@param OutputBufferSize Indicates the size, in bytes, of the data buffer specified by OutputBuffer.\r
343	\r
344	@retval EFI_SUCCESS The callback function complete successfully.\r
345	\r
346	**/\r
347	typedef \r
348	EFI_STATUS\r
349	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION)(\r
350	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
351	IN VOID *Context,\r
352	IN EFI_BLUETOOTH_PIN_CALLBACK_TYPE CallbackType,\r
353	IN VOID *InputBuffer,\r
354	IN UINTN InputBufferSize,\r
355	OUT VOID **OutputBuffer,\r
356	OUT UINTN *OutputBufferSize\r
357	);\r
358	\r
359	/**\r
360	Register PIN callback function.\r
361	\r
362	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
363	@param Callback The callback function. NULL means unregister.\r
364	@param Context Data passed into Callback function. This is optional parameter and may be NULL.\r
365	\r
366	@retval EFI_SUCCESS The PIN callback function is registered successfully.\r
367	\r
368	**/\r
369	typedef \r
370	EFI_STATUS\r
371	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK)(\r
372	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
373	IN EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION Callback,\r
374	IN VOID *Context\r
375	);\r
376	\r
377	/**\r
378	The callback function to get link key.\r
379	\r
380	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
381	@param Context Context passed from registration.\r
382	@param BDAddr A pointer to Bluetooth device address.\r
383	@param LinkKey A pointer to the buffer of link key.\r
384	\r
385	@retval EFI_SUCCESS The callback function complete successfully.\r
386	\r
387	**/\r
388	typedef \r
389	EFI_STATUS\r
390	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION)(\r
391	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
392	IN VOID *Context,\r
393	IN BLUETOOTH_ADDRESS *BDAddr,\r
394	OUT UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE]\r
395	);\r
396	\r
397	/**\r
398	Register get link key callback function.\r
399	\r
400	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
401	@param Callback The callback function. NULL means unregister.\r
402	@param Context Data passed into Callback function. This is optional parameter and may be NULL.\r
403	\r
404	@retval EFI_SUCCESS The link key callback function is registered successfully.\r
405	\r
406	**/\r
407	typedef \r
408	EFI_STATUS\r
409	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK)(\r
410	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
411	IN EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION Callback,\r
412	IN VOID *Context\r
413	);\r
414	\r
415	/**\r
416	The callback function to set link key.\r
417	\r
418	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
419	@param Context Context passed from registration.\r
420	@param BDAddr A pointer to Bluetooth device address.\r
421	@param LinkKey A pointer to the buffer of link key.\r
422	\r
423	@retval EFI_SUCCESS The callback function complete successfully.\r
424	\r
425	**/\r
426	typedef \r
427	EFI_STATUS\r
428	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION)(\r
429	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
430	IN VOID *Context,\r
431	IN BLUETOOTH_ADDRESS *BDAddr,\r
432	IN UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE]\r
433	);\r
434	\r
435	/**\r
436	Register set link key callback function.\r
437	\r
438	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
439	@param Callback The callback function. NULL means unregister.\r
440	@param Context Data passed into Callback function. This is optional parameter and may be NULL.\r
441	\r
442	@retval EFI_SUCCESS The link key callback function is registered successfully.\r
443	\r
444	**/\r
445	typedef \r
446	EFI_STATUS\r
447	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK)(\r
448	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
449	IN EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION Callback,\r
450	IN VOID *Context\r
451	);\r
452	\r
453	/**\r
454	The callback function. It is called after connect completed.\r
455	\r
456	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
457	@param Context Context passed from registration.\r
458	@param CallbackType Callback type in EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE.\r
459	@param BDAddr A pointer to Bluetooth device address.\r
460	@param InputBuffer A pointer to the buffer of data that is input from callback caller.\r
461	@param InputBufferSize Indicates the size, in bytes, of the data buffer specified by InputBuffer.\r
462	\r
463	@retval EFI_SUCCESS The callback function complete successfully.\r
464	\r
465	**/\r
466	typedef \r
467	EFI_STATUS\r
468	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION)(\r
469	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
470	IN VOID *Context,\r
471	IN EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE CallbackType,\r
472	IN BLUETOOTH_ADDRESS *BDAddr,\r
473	IN VOID *InputBuffer,\r
474	IN UINTN InputBufferSize\r
475	);\r
476	\r
477	/**\r
478	Register link connect complete callback function.\r
479	\r
480	@param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance.\r
481	@param Callback The callback function. NULL means unregister.\r
482	@param Context Data passed into Callback function. This is optional parameter and may be NULL.\r
483	\r
484	@retval EFI_SUCCESS The link connect complete callback function is registered successfully.\r
485	\r
486	**/\r
487	typedef \r
488	EFI_STATUS\r
489	(EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK)(\r
490	IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This,\r
491	IN EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION Callback,\r
492	IN VOID *Context\r
493	);\r
494	\r
495	///\r
496	/// This protocol abstracts user interface configuration for Bluetooth device.\r
497	///\r
498	struct _EFI_BLUETOOTH_CONFIG_PROTOCOL {\r
499	EFI_BLUETOOTH_CONFIG_INIT Init;\r
500	EFI_BLUETOOTH_CONFIG_SCAN Scan;\r
501	EFI_BLUETOOTH_CONFIG_CONNECT Connect;\r
502	EFI_BLUETOOTH_CONFIG_DISCONNECT Disconnect;\r
503	EFI_BLUETOOTH_CONFIG_GET_DATA GetData;\r
504	EFI_BLUETOOTH_CONFIG_SET_DATA SetData;\r
505	EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA GetRemoteData;\r
506	EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK RegisterPinCallback;\r
507	EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK RegisterGetLinkKeyCallback;\r
508	EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK RegisterSetLinkKeyCallback;\r
509	EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK RegisterLinkConnectCompleteCallback;\r
510	};\r
511	\r
512	extern EFI_GUID gEfiBluetoothConfigProtocolGuid;\r
513	\r
514	#endif\r