diff options
Diffstat (limited to 'stack/include/mca_api.h')
| -rw-r--r-- | stack/include/mca_api.h | 51 |
1 files changed, 32 insertions, 19 deletions
diff --git a/stack/include/mca_api.h b/stack/include/mca_api.h index 4ac2c89..d455e5b 100644 --- a/stack/include/mca_api.h +++ b/stack/include/mca_api.h @@ -1,14 +1,27 @@ -/***************************************************************************** -** -** Name: mca_api.h -** -** Description: This interface file contains the interface to the -** Multi-Channel Adaptation Protocol (MCAP). -** -** Copyright (c) 2009-2009, Broadcom Corp., All Rights Reserved. -** WIDCOMM Bluetooth Core. Proprietary and confidential. -** -*****************************************************************************/ +/****************************************************************************** + * + * Copyright (C) 2009-2012 Broadcom Corporation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + ******************************************************************************/ + +/****************************************************************************** + * + * This interface file contains the interface to the Multi-Channel + * Adaptation Protocol (MCAP). + * + ******************************************************************************/ #ifndef MCA_API_H #define MCA_API_H @@ -72,7 +85,7 @@ typedef UINT8 tMCA_DEP; /* the handle for MCA_CreateDep. This is also the lo typedef UINT16 tMCA_DL; /* the handle for the data channel. This is reported at MCA_OPEN_CFM_EVT or MCA_OPEN_IND_EVT */ /* This is the data callback function. It is executed when MCAP has a data -** packet ready for the application. +** packet ready for the application. */ typedef void (tMCA_DATA_CBACK)(tMCA_DL mdl, BT_HDR *p_pkt); @@ -195,7 +208,7 @@ typedef union { } tMCA_CTRL; /* This is the control callback function. This function passes control events -** to the application. +** to the application. */ typedef void (tMCA_CTRL_CBACK)(tMCA_HANDLE handle, tMCA_CL mcl, UINT8 event, tMCA_CTRL *p_data); @@ -244,7 +257,7 @@ MCA_API extern UINT8 MCA_SetTraceLevel (UINT8 level); ** It is assumed that the control channel PSM and data channel ** PSM are not used by any other instances of the stack. ** If the given p_reg->ctrl_psm is 0, this handle is INT only. -** +** ** Returns 0, if failed. Otherwise, the MCA handle. ** *******************************************************************************/ @@ -270,7 +283,7 @@ MCA_API extern void MCA_Deregister(tMCA_HANDLE handle); ** Description Create a data endpoint. If the MDEP is created successfully, ** the MDEP ID is returned in *p_dep. After a data endpoint is ** created, an application can initiate a connection between this -** endpoint and an endpoint on a peer device. +** endpoint and an endpoint on a peer device. ** ** Returns MCA_SUCCESS if successful, otherwise error. ** @@ -296,7 +309,7 @@ MCA_API extern tMCA_RESULT MCA_DeleteDep(tMCA_HANDLE handle, tMCA_DEP dep); ** ** Function MCA_ConnectReq ** -** Description This function initiates an MCAP control channel connection +** Description This function initiates an MCAP control channel connection ** to the peer device. When the connection is completed, an ** MCA_CONNECT_IND_EVT is reported to the application via its ** control callback function. @@ -317,7 +330,7 @@ MCA_API extern tMCA_RESULT MCA_ConnectReq(tMCA_HANDLE handle, BD_ADDR bd_addr, ** Function MCA_DisconnectReq ** ** Description This function disconnect an MCAP control channel -** to the peer device. +** to the peer device. ** If associated data channel exists, they are disconnected. ** When the MCL is disconnected an MCA_DISCONNECT_IND_EVT is ** reported to the application via its control callback function. @@ -334,7 +347,7 @@ MCA_API extern tMCA_RESULT MCA_DisconnectReq(tMCA_CL mcl); ** Description This function sends a CREATE_MDL request to the peer device. ** When the response is received, a MCA_CREATE_CFM_EVT is reported ** with the given MDL ID. -** If the response is successful, a data channel is open +** If the response is successful, a data channel is open ** with the given p_chnl_cfg ** When the data channel is open successfully, a MCA_OPEN_CFM_EVT ** is reported. This data channel is identified as tMCA_DL. @@ -452,7 +465,7 @@ MCA_API extern tMCA_RESULT MCA_Delete(tMCA_CL mcl, UINT16 mdl_id); ** ** Function MCA_WriteReq ** -** Description Send a data packet to the peer device. +** Description Send a data packet to the peer device. ** ** The application passes the packet using the BT_HDR structure. ** The offset field must be equal to or greater than L2CAP_MIN_OFFSET. |