inc/phNfcCompId.h

   1 /*\r
   2  * Copyright (C) 2010 NXP Semiconductors\r
   3  *\r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *      http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * \file phNfcCompId.h\r
  19  * \brief NFC Component ID Values - Used for Function Return Codes\r
  20  *\r
  21  * Project: NFC MW / HAL\r
  22  *\r
  23  * $Date: Thu Mar 12 12:00:30 2009 $\r
  24  * $Author: ing04880 $\r
  25  * $Revision: 1.6 $\r
  26  * $Aliases: NFC_FRI1.1_WK912_PREP1,NFC_FRI1.1_WK912_R21_1,NFC_FRI1.1_WK914_PREP1,NFC_FRI1.1_WK914_R22_1,NFC_FRI1.1_WK914_R22_2,NFC_FRI1.1_WK916_R23_1,NFC_FRI1.1_WK918_R24_1,NFC_FRI1.1_WK920_PREP1,NFC_FRI1.1_WK920_R25_1,NFC_FRI1.1_WK922_PREP1,NFC_FRI1.1_WK922_R26_1,NFC_FRI1.1_WK924_PREP1,NFC_FRI1.1_WK924_R27_1,NFC_FRI1.1_WK926_R28_1,NFC_FRI1.1_WK928_R29_1,NFC_FRI1.1_WK930_R30_1,NFC_FRI1.1_WK934_PREP_1,NFC_FRI1.1_WK934_R31_1,NFC_FRI1.1_WK941_PREP1,NFC_FRI1.1_WK941_PREP2,NFC_FRI1.1_WK941_1,NFC_FRI1.1_WK943_R32_1,NFC_FRI1.1_WK949_PREP1,NFC_FRI1.1_WK943_R32_10,NFC_FRI1.1_WK943_R32_13,NFC_FRI1.1_WK943_R32_14,NFC_FRI1.1_WK1007_R33_1,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 $\r
  27  *\r
  28  */\r
  29 \r
  30 #ifndef PHNFCCOMPID_H  /* */\r
  31 #define PHNFCCOMPID_H  /* */\r
  32 \r
  33 #ifndef PH_FRINFC_EXCLUDE_FROM_TESTFW /* */\r
  34 \r
  35 /**\r
  36  *  \name NFC Comp. ID\r
  37  *\r
  38  * File: \ref phNfcCompId.h\r
  39  *\r
  40  */\r
  41 /*@{*/\r
  42 #define PHNFCCOMPID_FILEREVISION "$Revision: 1.6 $" /**< \ingroup grp_file_attributes */\r
  43 #define PHNFCCOMPID_FILEALIASES  "$Aliases: NFC_FRI1.1_WK912_PREP1,NFC_FRI1.1_WK912_R21_1,NFC_FRI1.1_WK914_PREP1,NFC_FRI1.1_WK914_R22_1,NFC_FRI1.1_WK914_R22_2,NFC_FRI1.1_WK916_R23_1,NFC_FRI1.1_WK918_R24_1,NFC_FRI1.1_WK920_PREP1,NFC_FRI1.1_WK920_R25_1,NFC_FRI1.1_WK922_PREP1,NFC_FRI1.1_WK922_R26_1,NFC_FRI1.1_WK924_PREP1,NFC_FRI1.1_WK924_R27_1,NFC_FRI1.1_WK926_R28_1,NFC_FRI1.1_WK928_R29_1,NFC_FRI1.1_WK930_R30_1,NFC_FRI1.1_WK934_PREP_1,NFC_FRI1.1_WK934_R31_1,NFC_FRI1.1_WK941_PREP1,NFC_FRI1.1_WK941_PREP2,NFC_FRI1.1_WK941_1,NFC_FRI1.1_WK943_R32_1,NFC_FRI1.1_WK949_PREP1,NFC_FRI1.1_WK943_R32_10,NFC_FRI1.1_WK943_R32_13,NFC_FRI1.1_WK943_R32_14,NFC_FRI1.1_WK1007_R33_1,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 */\r
  44 /*@}*/\r
  45 \r
  46 #endif /* PH_FRINFC_EXCLUDE_FROM_TESTFW */\r
  47 \r
  48 /**\r
  49  *  \ingroup grp_comp_id\r
  50  *\r
  51  *  \name Component IDs\r
  52  *\r
  53  *  IDs for all NFC components. Combined with the Status Code they build the value (status)\r
  54  *  returned by each function.\r
  55  *\r
  56  *  ID Number Spaces:\r
  57  *  - 01..1F: HAL\r
  58  *  - 20..3F: NFC-MW (Local Device)\r
  59  *  - 40..5F: NFC-MW (Remote Device)\r
  60  *  .\r
  61  *\r
  62  *  \note The value \ref CID_NFC_NONE does not exist for Component IDs. Do not use this value except\r
  63  *         for \ref NFCSTATUS_SUCCESS. The enumeration function uses \ref CID_NFC_NONE\r
  64  *         to mark unassigned \ref phHal_sHwReference_t "Hardware References".\r
  65  *\r
  66  *  \if hal\r
  67  *   \sa \ref phHalNfc_Enumerate\r
  68  *  \endif\r
  69  */\r
  70 /*@{*/\r
  71 #define CID_NFC_NONE                    0x00    /**< \ingroup grp_comp_id\r
  72                                                      Unassigned or doesn't apply (see \ref NFCSTATUS_SUCCESS). */\r
  73 #define CID_NFC_DAL                     0x01    /**< \ingroup grp_comp_id\r
  74                                                      Driver Abstraction Layer\r
  75                                                      \if hal (\ref grp_subcomponents) \endif .   */\r
  76 #define CID_NFC_LLC                     0x07    /**< \ingroup grp_comp_id\r
  77                                                      Logical Link Control Layer\r
  78                                                      \if hal (\ref grp_subcomponents) \endif . */\r
  79 #define CID_NFC_HCI                     0x08    /**< \ingroup grp_comp_id\r
  80                                                      Host Control Interface Layer \r
  81                                                      \if hal (\ref grp_subcomponents) \endif . */\r
  82 #define CID_NFC_DNLD                    0x09    /**< \ingroup grp_comp_id\r
  83                                                      Firmware Download Management Layer\r
  84                                                      \if hal (\ref grp_subcomponents) \endif . */\r
  85 #define CID_NFC_HAL                     0x10    /**< \ingroup grp_comp_id\r
  86                                                      Hardware Abstraction Layer \if hal (\ref grp_hal_common) \endif . */\r
  87 #define CID_FRI_NFC_OVR_HAL             0x20    /**< \ingroup grp_comp_id\r
  88                                                      NFC-Device, HAL-based. */\r
  89 #define CID_FRI_NFC_NDEF_RECORD         0x22    /**< \ingroup grp_comp_id\r
  90                                                      NDEF Record Tools Library. */\r
  91 #define CID_FRI_NFC_NDEF_MAP            0x23    /**< \ingroup grp_comp_id\r
  92                                                      NDEF Mapping. */\r
  93 #define CID_FRI_NFC_NDEF_REGISTRY       0x24    /**< \ingroup grp_comp_id\r
  94                                                      NDEF_REGISTRY. */\r
  95 #define CID_FRI_NFC_AUTO_DEV_DIS        0x25    /**< \ingroup grp_comp_id\r
  96                                                      Automatic Device Discovery. */\r
  97 #define CID_FRI_NFC_NDEF_SMTCRDFMT      0x26    /**< \ingroup grp_comp_id\r
  98                                                      Smart Card Formatting */\r
  99 #define CID_FRI_NFC_LLCP                0x27    /**< \ingroup grp_comp_id\r
 100                                                      LLCP Core. */\r
 101 #define CID_FRI_NFC_LLCP_MAC            0x28    /**< \ingroup grp_comp_id\r
 102                                                      LLCP Mac Mappings. */\r
 103 #define CID_FRI_NFC_LLCP_TRANSPORT      0x29    /**< \ingroup grp_comp_id\r
 104                                                      LLCP Transport. */\r
 105 #define CID_NFC_LIB                     0x30    /**< \ingroup grp_comp_id\r
 106                                                      NFC Library Layer \if hal (\ref grp_hal_common) \endif . */\r
 107 #define CID_MAX_VALUE                   0xF0    /**< \ingroup grp_comp_id\r
 108                                                      The maximum CID value that is defined. */\r
 109 \r
 110 /*@}*/\r
 111 \r
 112 #endif /* PHNFCCOMPID_H */\r