Add few Doxygen comments.

This commit is contained in:
Romuald Conty 2009-09-24 14:33:42 +00:00
parent 56a2f4283a
commit 9205db8599
3 changed files with 27 additions and 1 deletions

View file

@ -89,6 +89,8 @@ LIBNFC_EXPORT bool nfc_initiator_init(const dev_info* pdi);
* @return Returns true if action was successfully performed; otherwise returns false. * @return Returns true if action was successfully performed; otherwise returns false.
* @param pdi dev_info struct pointer that represent currently used device * @param pdi dev_info struct pointer that represent currently used device
* @param im Desired modulation * @param im Desired modulation
* @param pbtInitData Optional initiator data used for Felica, ISO14443B, Topaz Polling or for ISO14443A selecting a specific UID.
* @param uiInitDataLen Length of initiator data \a pbtInitData.
* *
* The NFC device will try to find the available passive tags. Some NFC devices are capable to emulate passive tags. The standards (ISO18092 and ECMA-340) describe the modulation that can be used for reader to passive communications. The chip needs to know with what kind of tag it is dealing with, therefore the initial modulation and speed (106, 212 or 424 kbps) should be supplied. * The NFC device will try to find the available passive tags. Some NFC devices are capable to emulate passive tags. The standards (ISO18092 and ECMA-340) describe the modulation that can be used for reader to passive communications. The chip needs to know with what kind of tag it is dealing with, therefore the initial modulation and speed (106, 212 or 424 kbps) should be supplied.
* @note For every initial modulation type there is a different collection of information returned (in tag_info pointer pti) They all fit in the data-type which is called tag_info. This is a union which contains the tag information that belongs to the according initial modulation type. * @note For every initial modulation type there is a different collection of information returned (in tag_info pointer pti) They all fit in the data-type which is called tag_info. This is a union which contains the tag information that belongs to the according initial modulation type.

View file

@ -146,6 +146,10 @@ typedef enum {
IM_PASSIVE_DEP = 0x06, IM_PASSIVE_DEP = 0x06,
}init_modulation; }init_modulation;
/**
* @struct tag_info_dep
* @brief NFC tag information in Data Exchange Protocol
*/
typedef struct { typedef struct {
byte_t NFCID3i[10]; byte_t NFCID3i[10];
byte_t btDID; byte_t btDID;
@ -153,6 +157,10 @@ typedef struct {
byte_t btBRt; byte_t btBRt;
}tag_info_dep; }tag_info_dep;
/**
* @struct tag_info_iso14443a
* @brief NFC ISO14443A tag (MIFARE) information
*/
typedef struct { typedef struct {
byte_t abtAtqa[2]; byte_t abtAtqa[2];
byte_t btSak; byte_t btSak;
@ -162,6 +170,10 @@ typedef struct {
byte_t abtAts[36]; byte_t abtAts[36];
}tag_info_iso14443a; }tag_info_iso14443a;
/**
* @struct tag_info_felica
* @brief NFC FeLiCa tag information
*/
typedef struct { typedef struct {
uint32_t uiLen; uint32_t uiLen;
byte_t btResCode; byte_t btResCode;
@ -170,6 +182,10 @@ typedef struct {
byte_t abtSysCode[2]; byte_t abtSysCode[2];
}tag_info_felica; }tag_info_felica;
/**
* @struct tag_info_iso14443b
* @brief NFC ISO14443B tag information
*/
typedef struct { typedef struct {
byte_t abtAtqb[12]; byte_t abtAtqb[12];
byte_t abtId[4]; byte_t abtId[4];
@ -182,11 +198,19 @@ typedef struct {
byte_t abtInf[64]; byte_t abtInf[64];
}tag_info_iso14443b; }tag_info_iso14443b;
/**
* @struct tag_info_jewel
* @brief NFC Jewel tag information
*/
typedef struct { typedef struct {
byte_t btSensRes[2]; byte_t btSensRes[2];
byte_t btId[4]; byte_t btId[4];
}tag_info_jewel; }tag_info_jewel;
/**
* @union tag_info
* @brief Union between all kind of tags information structures.
*/
typedef union { typedef union {
tag_info_iso14443a tia; tag_info_iso14443a tia;
tag_info_felica tif; tag_info_felica tif;