MdePkg/Include/Protocol/BluetoothIo.h File Reference


Data Structures

struct  EFI_BLUETOOTH_DEVICE_INFO
struct  _EFI_BLUETOOTH_IO_PROTOCOL

Defines

#define EFI_BLUETOOTH_IO_SERVICE_BINDING_PROTOCOL_GUID
#define EFI_BLUETOOTH_IO_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_BLUETOOTH_IO_PROTOCOL 
EFI_BLUETOOTH_IO_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_GET_DEVICE_INFO )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT UINTN *DeviceInfoSize, OUT VOID **DeviceInfo)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_GET_SDP_INFO )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT UINTN *SdpInfoSize, OUT VOID **SdpInfo)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RAW_SEND )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RAW_RECEIVE )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer, IN UINTN Timeout)
typedef IN VOID * Data
typedef IN VOID IN UINTN DataLength
typedef IN VOID IN UINTN IN VOID * Context
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RAW_ASYNC_RECEIVE )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN BOOLEAN IsNewTransfer, IN UINTN PollingInterval, IN UINTN DataLength, IN EFI_BLUETOOTH_IO_ASYNC_FUNC_CALLBACK Callback, IN VOID *Context)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_SEND )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RECEIVE )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle, OUT UINTN *BufferSize, OUT VOID **Buffer, IN UINTN Timeout)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_ASYNC_RECEIVE )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle, IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_CONNECT )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT EFI_HANDLE *Handle, IN UINT16 Psm, IN UINT16 Mtu, IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_DISCONNECT )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle)
typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_REGISTER_SERVICE )(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT EFI_HANDLE *Handle, IN UINT16 Psm, IN UINT16 Mtu, IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context)

Functions

typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_ASYNC_FUNC_CALLBACK)(IN UINT16 ChannelID

Variables

EFI_GUID gEfiBluetoothIoServiceBindingProtocolGuid
EFI_GUID gEfiBluetoothIoProtocolGuid

Detailed Description

EFI Bluetooth IO Service Binding Protocol as defined in UEFI 2.5. EFI Bluetooth IO Protocol as defined in UEFI 2.5. The EFI Bluetooth IO Service Binding Protocol is used to locate EFI Bluetooth IO Protocol drivers to create and destroy child of the driver to communicate with other Bluetooth device by using Bluetooth IO protocol.

Copyright (c) 2015, Intel Corporation. All rights reserved.
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, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is introduced in UEFI Specification 2.5

Define Documentation

#define EFI_BLUETOOTH_IO_PROTOCOL_GUID

Value:

{ \
    0x467313de, 0x4e30, 0x43f1, { 0x94, 0x3e, 0x32, 0x3f, 0x89, 0x84, 0x5d, 0xb5  } \
  }

#define EFI_BLUETOOTH_IO_SERVICE_BINDING_PROTOCOL_GUID

Value:

{ \
    0x388278d3, 0x7b85, 0x42f0, { 0xab, 0xa9, 0xfb, 0x4b, 0xfd, 0x69, 0xf5, 0xab   } \
  }


Typedef Documentation

typedef IN UINTN IN VOID* Context

typedef IN EFI_IP4_CONFIG2_DATA_TYPE IN OUT UINTN IN VOID * Data

typedef IN UINTN DataLength

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_GET_DEVICE_INFO)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT UINTN *DeviceInfoSize, OUT VOID **DeviceInfo)

Get Bluetooth device information.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
DeviceInfoSize A pointer to the size, in bytes, of the DeviceInfo buffer.
DeviceInfo A pointer to a callee allocated buffer that returns Bluetooth device information.
Return values:
EFI_SUCCESS The Bluetooth device information is returned successfully.
EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth device information.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_GET_SDP_INFO)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT UINTN *SdpInfoSize, OUT VOID **SdpInfo)

Get Bluetooth SDP information.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
SdpInfoSize A pointer to the size, in bytes, of the SdpInfo buffer.
SdpInfo A pointer to a callee allocated buffer that returns Bluetooth SDP information.
Return values:
EFI_SUCCESS The Bluetooth device information is returned successfully.
EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth SDP information.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_ASYNC_RECEIVE)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle, IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context)

Receive L2CAP message (excluding L2CAP header) in non-blocking way from a specific channel.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
Handel A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to receive.
Callback The callback function. This function is called if the asynchronous transfer is completed.
Context Data passed into Callback function. This is optional parameter and may be NULL.
Return values:
EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully.
EFI_NOT_FOUND Handle is invalid or not found.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • DataLength is 0.
  • If an asynchronous receive request already exists on same Handle.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_CONNECT)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT EFI_HANDLE *Handle, IN UINT16 Psm, IN UINT16 Mtu, IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context)

Do L2CAP connection.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
Handel A handle to indicate this L2CAP connection.
Psm Bluetooth PSM. See Bluetooth specification for detail.
Mtu Bluetooth MTU. See Bluetooth specification for detail.
Callback The callback function. This function is called whenever there is message received in this channel.
Context Data passed into Callback function. This is optional parameter and may be NULL.
Return values:
EFI_SUCCESS The Bluetooth L2CAP layer connection is created successfully.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • Handle is NULL.
EFI_DEVICE_ERROR A hardware error occurred trying to do Bluetooth L2CAP connection.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_DISCONNECT)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle)

Do L2CAP disconnection.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
Handel A handle to indicate this L2CAP connection.
Return values:
EFI_SUCCESS The Bluetooth L2CAP layer is disconnected successfully.
EFI_NOT_FOUND Handle is invalid or not found.
EFI_DEVICE_ERROR A hardware error occurred trying to do Bluetooth L2CAP disconnection.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RAW_ASYNC_RECEIVE)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN BOOLEAN IsNewTransfer, IN UINTN PollingInterval, IN UINTN DataLength, IN EFI_BLUETOOTH_IO_ASYNC_FUNC_CALLBACK Callback, IN VOID *Context)

Receive L2CAP message (including L2CAP header) in non-blocking way.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
IsNewTransfer If TRUE, a new transfer will be submitted. If FALSE, the request is deleted.
PollingInterval Indicates the periodic rate, in milliseconds, that the transfer is to be executed.
DataLength Specifies the length, in bytes, of the data to be received.
Callback The callback function. This function is called if the asynchronous transfer is completed.
Context Data passed into Callback function. This is optional parameter and may be NULL.
Return values:
EFI_SUCCESS The L2CAP 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.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RAW_RECEIVE)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer, IN UINTN Timeout)

Receive L2CAP message (including L2CAP header).

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred.
Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer.
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.
Return values:
EFI_SUCCESS The L2CAP message 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 L2CAP message fail due to timeout.
EFI_DEVICE_ERROR Receiving L2CAP message fail due to host controller or device error.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RAW_SEND)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout)

Send L2CAP message (including L2CAP header).

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred.
Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer.
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.
Return values:
EFI_SUCCESS The L2CAP message 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 L2CAP message fail due to timeout.
EFI_DEVICE_ERROR Sending L2CAP message fail due to host controller or device error.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_RECEIVE)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle, OUT UINTN *BufferSize, OUT VOID **Buffer, IN UINTN Timeout)

Receive L2CAP message (excluding L2CAP header) from a specific channel.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to receive.
BufferSize Indicates the size, in bytes, of the data buffer specified by Buffer.
Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer.
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.
Return values:
EFI_SUCCESS The L2CAP message is received successfully.
EFI_NOT_FOUND Handle is invalid or not found.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • BufferSize is NULL.
  • *BufferSize is 0.
  • Buffer is NULL.
EFI_TIMEOUT Receiving L2CAP message fail due to timeout.
EFI_DEVICE_ERROR Receiving L2CAP message fail due to host controller or device error.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_REGISTER_SERVICE)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, OUT EFI_HANDLE *Handle, IN UINT16 Psm, IN UINT16 Mtu, IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context)

Register L2CAP callback function for special channel.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
Handel A handle to indicate this L2CAP connection.
Psm Bluetooth PSM. See Bluetooth specification for detail.
Mtu Bluetooth MTU. See Bluetooth specification for detail.
Callback The callback function. This function is called whenever there is message received in this channel. NULL means unregister.
Context Data passed into Callback function. This is optional parameter and may be NULL.
Return values:
EFI_SUCCESS The Bluetooth L2CAP callback function is registered successfully.
EFI_ALREADY_STARTED The callback function already exists when register.
EFI_NOT_FOUND The callback function does not exist when unregister.

typedef EFI_STATUS(EFIAPI * EFI_BLUETOOTH_IO_L2CAP_SEND)(IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle, IN OUT UINTN *BufferSize, IN VOID *Buffer, IN UINTN Timeout)

Send L2CAP message (excluding L2CAP header) to a specific channel.

Parameters:
This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to send.
BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred.
Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer.
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.
Return values:
EFI_SUCCESS The L2CAP message is sent successfully.
EFI_NOT_FOUND Handle is invalid or not found.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  • BufferSize is NULL.
  • *BufferSize is 0.
  • Buffer is NULL.
EFI_TIMEOUT Sending L2CAP message fail due to timeout.
EFI_DEVICE_ERROR Sending L2CAP message fail due to host controller or device error.


Function Documentation

typedef EFI_STATUS ( EFIAPI *  EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK  ) 

Callback function, it is called when asynchronous transfer is completed.

Parameters:
ChannelID Bluetooth L2CAP message channel ID.
Data Data received via asynchronous transfer.
DataLength The length of Data in bytes, received via asynchronous transfer.
Context Context passed from asynchronous transfer request.
Return values:
EFI_SUCCESS The callback function complete successfully.
Callback function, it is called when asynchronous transfer is completed.

Parameters:
Data Data received via asynchronous transfer.
DataLength The length of Data in bytes, received via asynchronous transfer.
Context Context passed from asynchronous transfer request.
Return values:
EFI_SUCCESS The callback function complete successfully.


Variable Documentation


Generated on Wed Sep 23 16:24:22 2015 for MdePkg[ALL] by  doxygen 1.5.7.1