MdePkg/Include/Protocol/BluetoothConfig.h

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