src/phHciNfc_LinkMgmt.h

   1 /*
   2  * Copyright (C) 2010 NXP Semiconductors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*!
  18 * =========================================================================== *
  19 *                                                                             *
  20 *                                                                             *
  21 * \file  phHciNfc_LinkMgmt.h                                                  *
  22 * \brief HCI Header for the Link Management Gate.                             *
  23 *                                                                             *
  24 *                                                                             *
  25 * Project: NFC-FRI-1.1                                                        *
  26 *                                                                             *
  27 * $Date: Tue Mar 30 09:32:13 2010 $                                           *
  28 * $Author: ing04880 $                                                         *
  29 * $Revision: 1.5 $                                                            *
  30 * $Aliases: NFC_FRI1.1_WK1007_R33_4,NFC_FRI1.1_WK1017_PREP1,NFC_FRI1.1_WK1017_R34_1,NFC_FRI1.1_WK1017_R34_2,NFC_FRI1.1_WK1023_R35_1 $
  31 *                                                                             *
  32 * =========================================================================== *
  33 */
  34
  35
  36 #ifndef PHHCINFC_LINKMGMT_H
  37 #define PHHCINFC_LINKMGMT_H
  38
  39 /*@}*/
  40
  41
  42 /**
  43  *  \name HCI
  44  *
  45  * File: \ref phHciNfc_LinkMgmt.h
  46  *
  47  */
  48 /*@{*/
  49 #define PHHCINFC_LINK_MGMT_FILEREVISION "$Revision: 1.5 $" /**< \ingroup grp_file_attributes */
  50 #define PHHCINFC_LINK_MGMT_FILEALIASES  "$Aliases: NFC_FRI1.1_WK1007_R33_4,NFC_FRI1.1_WK1017_PREP1,NFC_FRI1.1_WK1017_R34_1,NFC_FRI1.1_WK1017_R34_2,NFC_FRI1.1_WK1023_R35_1 $"   /**< \ingroup grp_file_attributes */
  51 /*@}*/
  52
  53 /*
  54 ***************************** Header File Inclusion ****************************
  55 */
  56
  57 #include <phHciNfc_Generic.h>
  58
  59 /*
  60 ****************************** Macro Definitions *******************************
  61 */
  62
  63 /*
  64 ******************** Enumeration and Structure Definition **********************
  65 */
  66
  67
  68
  69 /*
  70 *********************** Function Prototype Declaration *************************
  71 */
  72
  73 /**
  74  * \ingroup grp_hci_nfc
  75  *
  76  *  The phHciNfc_LinkMgmt_Initialise function creates and the opens Link
  77  *  Management Gate
  78  *
  79  *  \param[in]  psHciContext            psHciContext is the pointer to HCI Layer
  80  *                                      context Structure.
  81  *  \param[in]  pHwRef                  pHwRef is the Information of
  82  *                                      the Device Interface Link .
  83  *
  84  *  \retval NFCSTATUS_PENDING           Link Mgmt Gate Initialisation is pending.
  85  *  \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
  86  *                                      could not be interpreted properly.
  87  *  \retval Other errors                Errors related to the other layers
  88  *
  89  */
  90 extern
  91 NFCSTATUS
  92 phHciNfc_LinkMgmt_Initialise(
  93                                 phHciNfc_sContext_t     *psHciContext,
  94                                 void                    *pHwRef
  95                          );
  96 /**
  97  * \ingroup grp_hci_nfc
  98  *
  99  *  The phHciNfc_LinkMgmt_Release function closes the opened pipes between
 100  *  the Host Controller Device and the NFC Device.
 101  *
 102  *  \param[in]  psHciContext            psHciContext is the pointer to HCI Layer
 103  *                                      context Structure.
 104  *  \param[in]  pHwRef                  pHwRef is the Information of
 105  *                                      the Device Interface Link .
 106  *
 107  *  \retval NFCSTATUS_PENDING           Release of the Link Management gate
 108  *                                      resources are pending.
 109  *  \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
 110  *                                      could not be interpreted properly.
 111  *  \retval Other errors                Errors related to the other layers
 112  *
 113  */
 114 extern
 115 NFCSTATUS
 116 phHciNfc_LinkMgmt_Release(
 117                                 phHciNfc_sContext_t     *psHciContext,
 118                                 void                    *pHwRef
 119                      );
 120
 121
 122 /**
 123  * \ingroup grp_hci_nfc
 124  *
 125  *  The phHciNfc_LinkMgmt_Open function opens Link
 126  *  Management Gate
 127  *
 128  *  \param[in]  psHciContext            psHciContext is the pointer to HCI Layer
 129  *                                      context Structure.
 130  *  \param[in]  pHwRef                  pHwRef is the Information of
 131  *                                      the Device Interface Link .
 132  *
 133  *  \retval NFCSTATUS_PENDING           Link Mgmt Gate open is pending.
 134  *  \retval NFCSTATUS_INVALID_PARAMETER One or more of the supplied parameters
 135  *                                      could not be interpreted properly.
 136  *  \retval Other errors                Errors related to the other layers
 137  *
 138  */
 139
 140 extern
 141 NFCSTATUS
 142 phHciNfc_LinkMgmt_Open(
 143                                 phHciNfc_sContext_t     *psHciContext,
 144                                 void                    *pHwRef
 145                          );
 146
 147
 148 #endif
 149