tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-21 04:34:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

MdePkg/BluetoothIo: Formalize function header comments.

Browse Source 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
This commit is contained in:
Ruiyu Ni 2017-06-06 11:07:12 +08:00
parent 5a39f404f3
commit 1e4547668e
1 changed files with 144 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
MdePkg/Include/Protocol/BluetoothIo.h
View File

@ -4,7 +4,7 @@
The EFI Bluetooth IO Service Binding Protocol is used to locate EFI Bluetooth IO Protocol drivers to 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. 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.<BR> Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under 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 terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at The full text of the license may be found at
@ -72,9 +72,9 @@ typedef struct {
/** /**
Get Bluetooth device information. Get Bluetooth device information.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param DeviceInfoSize A pointer to the size, in bytes, of the DeviceInfo buffer. @param[out] DeviceInfoSize A pointer to the size, in bytes, of the DeviceInfo buffer.
@param DeviceInfo A pointer to a callee allocated buffer that returns Bluetooth device information. @param[out] DeviceInfo A pointer to a callee allocated buffer that returns Bluetooth device information.
@retval EFI_SUCCESS The Bluetooth device information is returned successfully. @retval EFI_SUCCESS The Bluetooth device information is returned successfully.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth device information. @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth device information.
@ -91,9 +91,9 @@ EFI_STATUS
/** /**
Get Bluetooth SDP information. Get Bluetooth SDP information.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param SdpInfoSize A pointer to the size, in bytes, of the SdpInfo buffer. @param[out] SdpInfoSize A pointer to the size, in bytes, of the SdpInfo buffer.
@param SdpInfo A pointer to a callee allocated buffer that returns Bluetooth SDP information. @param[out] SdpInfo A pointer to a callee allocated buffer that returns Bluetooth SDP information.
@retval EFI_SUCCESS The Bluetooth device information is returned successfully. @retval EFI_SUCCESS The Bluetooth device information is returned successfully.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth SDP information. @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth SDP information.
@ -110,11 +110,11 @@ EFI_STATUS
/** /**
Send L2CAP message (including L2CAP header). Send L2CAP message (including L2CAP header).
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. @param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer.
On output, indicates the amount of data actually transferred. On output, indicates the amount of data actually transferred.
@param Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer. @param[in] Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer.
@param Timeout Indicating the transfer should be completed within this time frame. The units are in @param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed 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. until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@ -139,11 +139,11 @@ EFI_STATUS
/** /**
Receive L2CAP message (including L2CAP header). Receive L2CAP message (including L2CAP header).
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. @param[in] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer.
On output, indicates the amount of data actually transferred. On output, indicates the amount of data actually transferred.
@param Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer. @param[out] Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer.
@param Timeout Indicating the transfer should be completed within this time frame. The units are in @param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed 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. until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@ -168,10 +168,10 @@ EFI_STATUS
/** /**
Callback function, it is called when asynchronous transfer is completed. Callback function, it is called when asynchronous transfer is completed.
@param ChannelID Bluetooth L2CAP message channel ID. @param[in] ChannelID Bluetooth L2CAP message channel ID.
@param Data Data received via asynchronous transfer. @param[in] Data Data received via asynchronous transfer.
@param DataLength The length of Data in bytes, received via asynchronous transfer. @param[in] DataLength The length of Data in bytes, received via asynchronous transfer.
@param Context Context passed from asynchronous transfer request. @param[in] Context Context passed from asynchronous transfer request.
@retval EFI_SUCCESS The callback function complete successfully. @retval EFI_SUCCESS The callback function complete successfully.
@ -188,13 +188,13 @@ EFI_STATUS
/** /**
Receive L2CAP message (including L2CAP header) in non-blocking way. Receive L2CAP message (including L2CAP header) in non-blocking way.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param IsNewTransfer If TRUE, a new transfer will be submitted. If FALSE, the request is deleted. @param[in] IsNewTransfer If TRUE, a new transfer will be submitted. If FALSE, the request is deleted.
@param PollingInterval Indicates the periodic rate, in milliseconds, that the transfer is to be executed. @param[in] PollingInterval Indicates the periodic rate, in milliseconds, that the transfer is to be executed.
@param DataLength Specifies the length, in bytes, of the data to be received. @param[in] DataLength Specifies the length, in bytes, of the data to be received.
@param Callback The callback function. This function is called if the asynchronous transfer is @param[in] Callback The callback function. This function is called if the asynchronous transfer is
completed. completed.
@param Context Data passed into Callback function. This is optional parameter and may be NULL. @param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully. @retval EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
@ -216,12 +216,12 @@ EFI_STATUS
/** /**
Send L2CAP message (excluding L2CAP header) to a specific channel. Send L2CAP message (excluding L2CAP header) to a specific channel.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to send. @param[in] Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to send.
@param BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. @param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer.
On output, indicates the amount of data actually transferred. On output, indicates the amount of data actually transferred.
@param Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer. @param[in] Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer.
@param Timeout Indicating the transfer should be completed within this time frame. The units are in @param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed 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. until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@ -248,11 +248,11 @@ EFI_STATUS
/** /**
Receive L2CAP message (excluding L2CAP header) from a specific channel. Receive L2CAP message (excluding L2CAP header) from a specific channel.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to receive. @param[in] Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to receive.
@param BufferSize Indicates the size, in bytes, of the data buffer specified by Buffer. @param[out] BufferSize Indicates the size, in bytes, of the data buffer specified by Buffer.
@param Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer. @param[out] Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer.
@param Timeout Indicating the transfer should be completed within this time frame. The units are in @param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed 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. until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@ -279,9 +279,9 @@ EFI_STATUS
/** /**
Callback function, it is called when asynchronous transfer is completed. Callback function, it is called when asynchronous transfer is completed.
@param Data Data received via asynchronous transfer. @param[in] Data Data received via asynchronous transfer.
@param DataLength The length of Data in bytes, received via asynchronous transfer. @param[in] DataLength The length of Data in bytes, received via asynchronous transfer.
@param Context Context passed from asynchronous transfer request. @param[in] Context Context passed from asynchronous transfer request.
@retval EFI_SUCCESS The callback function complete successfully. @retval EFI_SUCCESS The callback function complete successfully.
@ -297,11 +297,12 @@ EFI_STATUS
/** /**
Receive L2CAP message (excluding L2CAP header) in non-blocking way from a specific channel. Receive L2CAP message (excluding L2CAP header) in non-blocking way from a specific channel.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param Handel A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to receive. @param[in] Handel A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel
@param Callback The callback function. This function is called if the asynchronous transfer is to receive.
@param[in] Callback The callback function. This function is called if the asynchronous transfer is
completed. completed.
@param Context Data passed into Callback function. This is optional parameter and may be NULL. @param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully. @retval EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully.
@retval EFI_NOT_FOUND Handle is invalid or not found. @retval EFI_NOT_FOUND Handle is invalid or not found.
@ -322,13 +323,13 @@ EFI_STATUS
/** /**
Do L2CAP connection. Do L2CAP connection.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param Handel A handle to indicate this L2CAP connection. @param[out] Handel A handle to indicate this L2CAP connection.
@param Psm Bluetooth PSM. See Bluetooth specification for detail. @param[in] Psm Bluetooth PSM. See Bluetooth specification for detail.
@param Mtu Bluetooth MTU. See Bluetooth specification for detail. @param[in] Mtu Bluetooth MTU. See Bluetooth specification for detail.
@param Callback The callback function. This function is called whenever there is message received @param[in] Callback The callback function. This function is called whenever there is message received
in this channel. in this channel.
@param Context Data passed into Callback function. This is optional parameter and may be NULL. @param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The Bluetooth L2CAP layer connection is created successfully. @retval EFI_SUCCESS The Bluetooth L2CAP layer connection is created successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
@ -350,8 +351,8 @@ EFI_STATUS
/** /**
Do L2CAP disconnection. Do L2CAP disconnection.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param Handel A handle to indicate this L2CAP connection. @param[in] Handel A handle to indicate this L2CAP connection.
@retval EFI_SUCCESS The Bluetooth L2CAP layer is disconnected successfully. @retval EFI_SUCCESS The Bluetooth L2CAP layer is disconnected successfully.
@retval EFI_NOT_FOUND Handle is invalid or not found. @retval EFI_NOT_FOUND Handle is invalid or not found.
@ -368,13 +369,13 @@ EFI_STATUS
/** /**
Register L2CAP callback function for special channel. Register L2CAP callback function for special channel.
@param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param Handel A handle to indicate this L2CAP connection. @param[out] Handel A handle to indicate this L2CAP connection.
@param Psm Bluetooth PSM. See Bluetooth specification for detail. @param[in] Psm Bluetooth PSM. See Bluetooth specification for detail.
@param Mtu Bluetooth MTU. See Bluetooth specification for detail. @param[in] Mtu Bluetooth MTU. See Bluetooth specification for detail.
@param Callback The callback function. This function is called whenever there is message received @param[in] Callback The callback function. This function is called whenever there is message received
in this channel. NULL means unregister. in this channel. NULL means unregister.
@param Context Data passed into Callback function. This is optional parameter and may be NULL. @param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The Bluetooth L2CAP callback function is registered successfully. @retval EFI_SUCCESS The Bluetooth L2CAP callback function is registered successfully.
@retval EFI_ALREADY_STARTED The callback function already exists when register. @retval EFI_ALREADY_STARTED The callback function already exists when register.