From nobody Sat Dec 28 11:55:10 2024 Delivered-To: importer@patchew.org Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) client-ip=198.145.21.10; envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org; Authentication-Results: mx.zoho.com; spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) smtp.mailfrom=edk2-devel-bounces@lists.01.org; Return-Path: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 1496720161849803.9458214981263; Mon, 5 Jun 2017 20:36:01 -0700 (PDT) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id E44B021959CB7; Mon, 5 Jun 2017 20:34:44 -0700 (PDT) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id C327721959CA1 for ; Mon, 5 Jun 2017 20:34:43 -0700 (PDT) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga105.jf.intel.com with ESMTP; 05 Jun 2017 20:35:50 -0700 Received: from ray-dev.ccr.corp.intel.com ([10.239.9.1]) by FMSMGA003.fm.intel.com with ESMTP; 05 Jun 2017 20:35:49 -0700 X-Original-To: edk2-devel@lists.01.org X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.39,304,1493708400"; d="scan'208";a="864937074" From: Ruiyu Ni To: edk2-devel@lists.01.org Date: Tue, 6 Jun 2017 11:35:42 +0800 Message-Id: <20170606033543.254936-5-ruiyu.ni@intel.com> X-Mailer: git-send-email 2.12.2.windows.2 In-Reply-To: <20170606033543.254936-1-ruiyu.ni@intel.com> References: <20170606033543.254936-1-ruiyu.ni@intel.com> Subject: [edk2] [PATCH v2 4/5] MdePkg/BluetoothIo: Formalize function header comments. X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Jiewen Yao MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Ruiyu Ni Cc: Jiewen Yao --- MdePkg/Include/Protocol/BluetoothIo.h | 287 +++++++++++++++++-------------= ---- 1 file changed, 144 insertions(+), 143 deletions(-) diff --git a/MdePkg/Include/Protocol/BluetoothIo.h b/MdePkg/Include/Protoco= l/BluetoothIo.h index d750767f09..50d08f18d2 100644 --- a/MdePkg/Include/Protocol/BluetoothIo.h +++ b/MdePkg/Include/Protocol/BluetoothIo.h @@ -1,19 +1,19 @@ /** @file 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 Blue= tooth IO Protocol drivers to=20 + The EFI Bluetooth IO Service Binding Protocol is used to locate EFI Blue= tooth IO Protocol drivers to create and destroy child of the driver to communicate with other Bluetoo= th device by using Bluetooth IO protocol. =20 - Copyright (c) 2015, Intel Corporation. All rights reserved.
- This program and the accompanying materials are licensed and made availa= ble under=20 - the terms and conditions of the BSD License that accompanies this distri= bution. =20 + Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.
+ This program and the accompanying materials are licensed and made availa= ble under + the terms and conditions of the BSD License that accompanies this distri= bution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php. = =20 - =20 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, = =20 + 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 IMP= LIED. =20 - @par Revision Reference: =20 + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.5 =20 **/ @@ -25,14 +25,14 @@ =20 #define EFI_BLUETOOTH_IO_SERVICE_BINDING_PROTOCOL_GUID \ { \ - 0x388278d3, 0x7b85, 0x42f0, { 0xab, 0xa9, 0xfb, 0x4b, 0xfd, 0x69, 0xf5= , 0xab } \ + 0x388278d3, 0x7b85, 0x42f0, { 0xab, 0xa9, 0xfb, 0x4b, 0xfd, 0x69, 0xf5= , 0xab } \ } - =20 + #define EFI_BLUETOOTH_IO_PROTOCOL_GUID \ { \ - 0x467313de, 0x4e30, 0x43f1, { 0x94, 0x3e, 0x32, 0x3f, 0x89, 0x84, 0x5d= , 0xb5 } \ + 0x467313de, 0x4e30, 0x43f1, { 0x94, 0x3e, 0x32, 0x3f, 0x89, 0x84, 0x5d= , 0xb5 } \ } - =20 + typedef struct _EFI_BLUETOOTH_IO_PROTOCOL EFI_BLUETOOTH_IO_PROTOCOL; =20 /// @@ -72,51 +72,51 @@ typedef struct { /** Get Bluetooth device information. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param DeviceInfoSize A pointer to the size, in bytes, of the DeviceIn= fo buffer. - @param DeviceInfo A pointer to a callee allocated buffer that retu= rns Bluetooth device information. + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[out] DeviceInfoSize A pointer to the size, in bytes, of the = DeviceInfo buffer. + @param[out] DeviceInfo A pointer to a callee allocated buffer t= hat returns Bluetooth device information. =20 - @retval EFI_SUCCESS The Bluetooth device information is return= ed successfully. - @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrie= ve the Bluetooth device information. + @retval EFI_SUCCESS The Bluetooth device information is retu= rned successfully. + @retval EFI_DEVICE_ERROR A hardware error occurred trying to retr= ieve the Bluetooth device information. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_GET_DEVICE_INFO)( - IN EFI_BLUETOOTH_IO_PROTOCOL *This, - OUT UINTN *DeviceInfoSize, - OUT VOID **DeviceInfo + IN EFI_BLUETOOTH_IO_PROTOCOL *This, + OUT UINTN *DeviceInfoSize, + OUT VOID **DeviceInfo ); - =20 + /** Get Bluetooth SDP information. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param SdpInfoSize A pointer to the size, in bytes, of the SdpInfo = buffer. - @param SdpInfo A pointer to a callee allocated buffer that retu= rns Bluetooth SDP information. + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[out] SdpInfoSize A pointer to the size, in bytes, of the = SdpInfo buffer. + @param[out] SdpInfo A pointer to a callee allocated buffer t= hat returns Bluetooth SDP information. =20 - @retval EFI_SUCCESS The Bluetooth device information is return= ed successfully. - @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrie= ve the Bluetooth SDP information. + @retval EFI_SUCCESS The Bluetooth device information is retu= rned successfully. + @retval EFI_DEVICE_ERROR A hardware error occurred trying to retr= ieve the Bluetooth SDP information. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_GET_SDP_INFO)( - IN EFI_BLUETOOTH_IO_PROTOCOL *This, - OUT UINTN *SdpInfoSize, - OUT VOID **SdpInfo + IN EFI_BLUETOOTH_IO_PROTOCOL *This, + OUT UINTN *SdpInfoSize, + OUT VOID **SdpInfo ); - =20 + /** Send L2CAP message (including L2CAP header). =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param BufferSize On input, indicates the size, in bytes, of the d= ata buffer specified by Buffer.=20 - On output, indicates the amount of data actually= transferred. - @param Buffer A pointer to the buffer of data that will be tra= nsmitted to Bluetooth L2CAP layer. - @param Timeout Indicating the transfer should be completed with= in this time frame. The units are in=20 - milliseconds. If Timeout is 0, then the caller m= ust wait for the function to be completed=20 - until EFI_SUCCESS or EFI_DEVICE_ERROR is returne= d. + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @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. + @param[in] Buffer A pointer to the buffer of data that wil= l be transmitted to Bluetooth L2CAP layer. + @param[in] Timeout Indicating the transfer should be comple= ted 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. =20 @retval EFI_SUCCESS The L2CAP message is sent successfully. @retval EFI_INVALID_PARAMETER One or more of the following conditions = is TRUE: @@ -127,25 +127,25 @@ EFI_STATUS @retval EFI_DEVICE_ERROR Sending L2CAP message fail due to host c= ontroller or device error. =20 **/ -typedef=20 +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 + IN EFI_BLUETOOTH_IO_PROTOCOL *This, + IN OUT UINTN *BufferSize, + IN VOID *Buffer, + IN UINTN Timeout ); - =20 + /** Receive L2CAP message (including L2CAP header). =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param BufferSize On input, indicates the size, in bytes, of the d= ata buffer specified by Buffer.=20 - On output, indicates the amount of data actually= transferred. - @param Buffer A pointer to the buffer of data that will be rec= eived from Bluetooth L2CAP layer. - @param Timeout Indicating the transfer should be completed with= in this time frame. The units are in=20 - milliseconds. If Timeout is 0, then the caller m= ust wait for the function to be completed=20 - until EFI_SUCCESS or EFI_DEVICE_ERROR is returne= d. + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @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. + @param[out] Buffer A pointer to the buffer of data that wil= l be received from Bluetooth L2CAP layer. + @param[in] Timeout Indicating the transfer should be comple= ted 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. =20 @retval EFI_SUCCESS The L2CAP message is received successful= ly. @retval EFI_INVALID_PARAMETER One or more of the following conditions = is TRUE: @@ -156,7 +156,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR Receiving L2CAP message fail due to host= controller or device error. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_L2CAP_RAW_RECEIVE)( IN EFI_BLUETOOTH_IO_PROTOCOL *This, @@ -164,16 +164,16 @@ EFI_STATUS OUT VOID *Buffer, IN UINTN Timeout ); - =20 + /** Callback function, it is called when asynchronous transfer is completed. =20 - @param ChannelID Bluetooth L2CAP message channel ID. - @param Data Data received via asynchronous transfer. - @param DataLength The length of Data in bytes, received via asyn= chronous transfer. - @param Context Context passed from asynchronous transfer requ= est. + @param[in] ChannelID Bluetooth L2CAP message channel ID. + @param[in] Data Data received via asynchronous transfer. + @param[in] DataLength The length of Data in bytes, received via = asynchronous transfer. + @param[in] Context Context passed from asynchronous transfer = request. =20 - @retval EFI_SUCCESS The callback function complete successfully. + @retval EFI_SUCCESS The callback function complete successfull= y. =20 **/ typedef @@ -184,25 +184,25 @@ EFI_STATUS IN UINTN DataLength, IN VOID *Context ); - =20 + /** Receive L2CAP message (including L2CAP header) in non-blocking way. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param IsNewTransfer If TRUE, a new transfer will be submitted. If FA= LSE, the request is deleted. - @param PollingInterval Indicates the periodic rate, in milliseconds, th= at the transfer is to be executed. - @param DataLength Specifies the length, in bytes, of the data to b= e received. - @param Callback The callback function. This function is called i= f the asynchronous transfer is=20 - completed. - @param Context Data passed into Callback function. This is opti= onal parameter and may be NULL.=20 - =20 + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[in] IsNewTransfer If TRUE, a new transfer will be submitte= d. If FALSE, the request is deleted. + @param[in] PollingInterval Indicates the periodic rate, in millisec= onds, that the transfer is to be executed. + @param[in] DataLength Specifies the length, in bytes, of the d= ata to be received. + @param[in] Callback The callback function. This function is = called if the asynchronous transfer is + completed. + @param[in] Context Data passed into Callback function. This= is optional parameter and may be NULL. + @retval EFI_SUCCESS The L2CAP asynchronous receive request i= s submitted successfully. @retval EFI_INVALID_PARAMETER One or more of the following conditions = is TRUE: - DataLength is 0. - If IsNewTransfer is TRUE, and an async= hronous receive request already exists. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_L2CAP_RAW_ASYNC_RECEIVE)( IN EFI_BLUETOOTH_IO_PROTOCOL *This, @@ -216,14 +216,14 @@ EFI_STATUS /** Send L2CAP message (excluding L2CAP header) to a specific channel. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2= CapConnect indicates which channel to send. - @param BufferSize On input, indicates the size, in bytes, of the d= ata buffer specified by Buffer.=20 - On output, indicates the amount of data actually= transferred. - @param Buffer A pointer to the buffer of data that will be tra= nsmitted to Bluetooth L2CAP layer. - @param Timeout Indicating the transfer should be completed with= in this time frame. The units are in=20 - milliseconds. If Timeout is 0, then the caller m= ust wait for the function to be completed=20 - until EFI_SUCCESS or EFI_DEVICE_ERROR is returne= d. + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[in] Handle A handle created by EFI_BLUETOOTH_IO_PRO= TOCOL.L2CapConnect indicates which channel to send. + @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. + @param[in] Buffer A pointer to the buffer of data that wil= l be transmitted to Bluetooth L2CAP layer. + @param[in] Timeout Indicating the transfer should be comple= ted 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. =20 @retval EFI_SUCCESS The L2CAP message is sent successfully. @retval EFI_NOT_FOUND Handle is invalid or not found. @@ -235,26 +235,26 @@ EFI_STATUS @retval EFI_DEVICE_ERROR Sending L2CAP message fail due to host c= ontroller or device error. =20 **/ -typedef=20 +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 + IN EFI_BLUETOOTH_IO_PROTOCOL *This, + IN EFI_HANDLE Handle, + IN OUT UINTN *BufferSize, + IN VOID *Buffer, + IN UINTN Timeout ); - =20 + /** Receive L2CAP message (excluding L2CAP header) from a specific channel. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2= CapConnect indicates which channel to receive. - @param 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 rec= eived from Bluetooth L2CAP layer. - @param Timeout Indicating the transfer should be completed with= in this time frame. The units are in=20 - milliseconds. If Timeout is 0, then the caller m= ust wait for the function to be completed=20 - until EFI_SUCCESS or EFI_DEVICE_ERROR is returne= d. + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[in] Handle A handle created by EFI_BLUETOOTH_IO_PRO= TOCOL.L2CapConnect indicates which channel to receive. + @param[out] BufferSize Indicates the size, in bytes, of the dat= a buffer specified by Buffer. + @param[out] Buffer A pointer to the buffer of data that wil= l be received from Bluetooth L2CAP layer. + @param[in] Timeout Indicating the transfer should be comple= ted 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. =20 @retval EFI_SUCCESS The L2CAP message is received successful= ly. @retval EFI_NOT_FOUND Handle is invalid or not found. @@ -266,22 +266,22 @@ EFI_STATUS @retval EFI_DEVICE_ERROR Receiving L2CAP message fail due to host= controller or device error. =20 **/ -typedef=20 +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 + IN EFI_BLUETOOTH_IO_PROTOCOL *This, + IN EFI_HANDLE Handle, + OUT UINTN *BufferSize, + OUT VOID **Buffer, + IN UINTN Timeout ); - =20 + /** Callback function, it is called when asynchronous transfer is completed. =20 - @param Data Data received via asynchronous transfer. - @param DataLength The length of Data in bytes, received via asyn= chronous transfer. - @param Context Context passed from asynchronous transfer requ= est. + @param[in] Data Data received via asynchronous transfer. + @param[in] DataLength The length of Data in bytes, received vi= a asynchronous transfer. + @param[in] Context Context passed from asynchronous transfe= r request. =20 @retval EFI_SUCCESS The callback function complete successfully. =20 @@ -289,20 +289,21 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK) ( - IN VOID *Data, - IN UINTN DataLength, - IN VOID *Context + IN VOID *Data, + IN UINTN DataLength, + IN VOID *Context ); - =20 + /** Receive L2CAP message (excluding L2CAP header) in non-blocking way from = a specific channel. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param Handel A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2= CapConnect indicates which channel to receive. - @param Callback The callback function. This function is called i= f the asynchronous transfer is=20 - completed. - @param Context Data passed into Callback function. This is opti= onal parameter and may be NULL.=20 - =20 + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[in] Handel A handle created by EFI_BLUETOOTH_IO_PRO= TOCOL.L2CapConnect indicates which channel + to receive. + @param[in] Callback The callback function. This function is = called if the asynchronous transfer is + completed. + @param[in] Context Data passed into Callback function. This= is optional parameter and may be NULL. + @retval EFI_SUCCESS The L2CAP asynchronous receive request i= s submitted successfully. @retval EFI_NOT_FOUND Handle is invalid or not found. @retval EFI_INVALID_PARAMETER One or more of the following conditions = is TRUE: @@ -310,33 +311,33 @@ EFI_STATUS - If an asynchronous receive request alr= eady exists on same Handle. =20 **/ -typedef=20 +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 + IN EFI_BLUETOOTH_IO_PROTOCOL *This, + IN EFI_HANDLE Handle, + IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, + IN VOID* Context ); - =20 + /** Do L2CAP connection. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param Handel A handle to indicate this L2CAP connection. - @param Psm Bluetooth PSM. See Bluetooth specification for d= etail. - @param Mtu Bluetooth MTU. See Bluetooth specification for d= etail. - @param Callback The callback function. This function is called w= henever there is message received=20 - in this channel. - @param Context Data passed into Callback function. This is opti= onal parameter and may be NULL. - =20 + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[out] Handel A handle to indicate this L2CAP connecti= on. + @param[in] Psm Bluetooth PSM. See Bluetooth specificati= on for detail. + @param[in] Mtu Bluetooth MTU. See Bluetooth specificati= on for detail. + @param[in] Callback The callback function. This function is = called whenever there is message received + in this channel. + @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_INVALID_PARAMETER One or more of the following conditions = is TRUE: - Handle is NULL. @retval EFI_DEVICE_ERROR A hardware error occurred trying to do B= luetooth L2CAP connection. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_L2CAP_CONNECT)( IN EFI_BLUETOOTH_IO_PROTOCOL *This, @@ -346,42 +347,42 @@ EFI_STATUS IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context ); - =20 + /** Do L2CAP disconnection. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param Handel A handle to indicate this L2CAP connection. - =20 + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[in] Handel A handle to indicate this L2CAP connecti= on. + @retval EFI_SUCCESS The Bluetooth L2CAP layer is disconnecte= d successfully. @retval EFI_NOT_FOUND Handle is invalid or not found. @retval EFI_DEVICE_ERROR A hardware error occurred trying to do B= luetooth L2CAP disconnection. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_L2CAP_DISCONNECT)( IN EFI_BLUETOOTH_IO_PROTOCOL *This, IN EFI_HANDLE Handle ); - =20 + /** Register L2CAP callback function for special channel. =20 - @param This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instanc= e. - @param Handel A handle to indicate this L2CAP connection. - @param Psm Bluetooth PSM. See Bluetooth specification for d= etail. - @param Mtu Bluetooth MTU. See Bluetooth specification for d= etail. - @param Callback The callback function. This function is called w= henever there is message received=20 - in this channel. NULL means unregister. - @param Context Data passed into Callback function. This is opti= onal parameter and may be NULL. - =20 + @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL= instance. + @param[out] Handel A handle to indicate this L2CAP connecti= on. + @param[in] Psm Bluetooth PSM. See Bluetooth specificati= on for detail. + @param[in] Mtu Bluetooth MTU. See Bluetooth specificati= on for detail. + @param[in] Callback The callback function. This function is = called whenever there is message received + in this channel. NULL means unregister. + @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_ALREADY_STARTED The callback function already exists whe= n register. @retval EFI_NOT_FOUND The callback function does not exist whe= n unregister. =20 **/ -typedef=20 +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_IO_L2CAP_REGISTER_SERVICE)( IN EFI_BLUETOOTH_IO_PROTOCOL *This, @@ -391,9 +392,9 @@ EFI_STATUS IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback, IN VOID *Context ); - =20 + /// -/// This protocol provides service for Bluetooth L2CAP (Logical Link Contr= ol and Adaptation Protocol)=20 +/// This protocol provides service for Bluetooth L2CAP (Logical Link Contr= ol and Adaptation Protocol) /// and SDP (Service Discovery Protocol). /// struct _EFI_BLUETOOTH_IO_PROTOCOL { --=20 2.12.2.windows.2 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel