Home | History | Annotate | Download | only in inc
      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  * \file phNfcCompId.h
     19  * \brief NFC Component ID Values - Used for Function Return Codes
     20  *
     21  * Project: NFC MW / HAL
     22  *
     23  * $Date: Thu Mar 12 12:00:30 2009 $
     24  * $Author: ing04880 $
     25  * $Revision: 1.6 $
     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 $
     27  *
     28  */
     29 
     30 #ifndef PHNFCCOMPID_H  /* */
     31 #define PHNFCCOMPID_H  /* */
     32 
     33 #ifndef PH_FRINFC_EXCLUDE_FROM_TESTFW /* */
     34 
     35 /**
     36  *  \name NFC Comp. ID
     37  *
     38  * File: \ref phNfcCompId.h
     39  *
     40  */
     41 /*@{*/
     42 #define PHNFCCOMPID_FILEREVISION "$Revision: 1.6 $" /**< \ingroup grp_file_attributes */
     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 */
     44 /*@}*/
     45 
     46 #endif /* PH_FRINFC_EXCLUDE_FROM_TESTFW */
     47 
     48 /**
     49  *  \ingroup grp_comp_id
     50  *
     51  *  \name Component IDs
     52  *
     53  *  IDs for all NFC components. Combined with the Status Code they build the value (status)
     54  *  returned by each function.
     55  *
     56  *  ID Number Spaces:
     57  *  - 01..1F: HAL
     58  *  - 20..3F: NFC-MW (Local Device)
     59  *  - 40..5F: NFC-MW (Remote Device)
     60  *  .
     61  *
     62  *  \note The value \ref CID_NFC_NONE does not exist for Component IDs. Do not use this value except
     63  *         for \ref NFCSTATUS_SUCCESS. The enumeration function uses \ref CID_NFC_NONE
     64  *         to mark unassigned \ref phHal_sHwReference_t "Hardware References".
     65  *
     66  *  \if hal
     67  *   \sa \ref phHalNfc_Enumerate
     68  *  \endif
     69  */
     70 /*@{*/
     71 #define CID_NFC_NONE                    0x00    /**< \ingroup grp_comp_id
     72                                                      Unassigned or doesn't apply (see \ref NFCSTATUS_SUCCESS). */
     73 #define CID_NFC_DAL                     0x01    /**< \ingroup grp_comp_id
     74                                                      Driver Abstraction Layer
     75                                                      \if hal (\ref grp_subcomponents) \endif .   */
     76 #define CID_NFC_LLC                     0x07    /**< \ingroup grp_comp_id
     77                                                      Logical Link Control Layer
     78                                                      \if hal (\ref grp_subcomponents) \endif . */
     79 #define CID_NFC_HCI                     0x08    /**< \ingroup grp_comp_id
     80                                                      Host Control Interface Layer
     81                                                      \if hal (\ref grp_subcomponents) \endif . */
     82 #define CID_NFC_DNLD                    0x09    /**< \ingroup grp_comp_id
     83                                                      Firmware Download Management Layer
     84                                                      \if hal (\ref grp_subcomponents) \endif . */
     85 #define CID_NFC_HAL                     0x10    /**< \ingroup grp_comp_id
     86                                                      Hardware Abstraction Layer \if hal (\ref grp_hal_common) \endif . */
     87 #define CID_FRI_NFC_OVR_HAL             0x20    /**< \ingroup grp_comp_id
     88                                                      NFC-Device, HAL-based. */
     89 #define CID_FRI_NFC_NDEF_RECORD         0x22    /**< \ingroup grp_comp_id
     90                                                      NDEF Record Tools Library. */
     91 #define CID_FRI_NFC_NDEF_MAP            0x23    /**< \ingroup grp_comp_id
     92                                                      NDEF Mapping. */
     93 #define CID_FRI_NFC_NDEF_REGISTRY       0x24    /**< \ingroup grp_comp_id
     94                                                      NDEF_REGISTRY. */
     95 #define CID_FRI_NFC_AUTO_DEV_DIS        0x25    /**< \ingroup grp_comp_id
     96                                                      Automatic Device Discovery. */
     97 #define CID_FRI_NFC_NDEF_SMTCRDFMT      0x26    /**< \ingroup grp_comp_id
     98                                                      Smart Card Formatting */
     99 #define CID_FRI_NFC_LLCP                0x27    /**< \ingroup grp_comp_id
    100                                                      LLCP Core. */
    101 #define CID_FRI_NFC_LLCP_MAC            0x28    /**< \ingroup grp_comp_id
    102                                                      LLCP Mac Mappings. */
    103 #define CID_FRI_NFC_LLCP_TRANSPORT      0x29    /**< \ingroup grp_comp_id
    104                                                      LLCP Transport. */
    105 #define CID_NFC_LIB                     0x30    /**< \ingroup grp_comp_id
    106                                                      NFC Library Layer \if hal (\ref grp_hal_common) \endif . */
    107 #define CID_MAX_VALUE                   0xF0    /**< \ingroup grp_comp_id
    108                                                      The maximum CID value that is defined. */
    109 
    110 /*@}*/
    111 
    112 #endif /* PHNFCCOMPID_H */
    113