crewID/libnfc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation improvements.

Browse source
This commit is contained in:
Romuald Conty 2010-08-18 12:39:32 +00:00
parent 0c19124984
commit 43694183ff
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
libnfc/nfc.c
View file

@ -543,7 +543,6 @@ nfc_initiator_list_passive_targets(nfc_device_t* pnd, const nfc_modulation_t nmI
} }
/** /**
* @fn nfc_initiator_deselect_target(const nfc_device_t* pnd);
* @brief Deselect a selected passive or emulated tag * @brief Deselect a selected passive or emulated tag
* @return Returns true if action was successfully performed; otherwise returns false. * @return Returns true if action was successfully performed; otherwise returns false.
* @param pnd nfc_device_t struct pointer that represent currently used device * @param pnd nfc_device_t struct pointer that represent currently used device
@ -576,7 +575,6 @@ nfc_initiator_poll_targets(const nfc_device_t* pnd,
} }
/** /**
* @fn nfc_initiator_transceive_bits(const nfc_device_t* pnd, const byte_t* pbtTx, const size_t szTxBits, const byte_t* pbtTxPar, byte_t* pbtRx, size_t* pszRxBits, byte_t* pbtRxPar)
* @brief Transceive raw bit-frames * @brief Transceive raw bit-frames
* @return Returns true if action was successfully performed; otherwise returns false. * @return Returns true if action was successfully performed; otherwise returns false.
* @param pbtTx contains a byte array of the frame that needs to be transmitted. * @param pbtTx contains a byte array of the frame that needs to be transmitted.
@ -684,10 +682,10 @@ bool nfc_initiator_transceive_dep_bytes(const nfc_device_t* pnd, const byte_t* p
} }
/** /**
* @brief Transceive byte and APDU frames * @brief Send raw data to target then retrieve raw data from target
* @return Returns true if action was successfully performed; otherwise returns false. * @return Returns true if action was successfully performed; otherwise returns false.
* *
* The reader will transmit the supplied bytes in pbtTx to the target (tag). * The reader will transmit the supplied bytes (\a pbtTx) to the target in raw mode: PN53x will not handle input neither output data.
* It waits for the response and stores the received bytes in the pbtRx byte array. * It waits for the response and stores the received bytes in the pbtRx byte array.
* The parity bits are handled by the PN53X chip. The CRC can be generated automatically or handled manually. * The parity bits are handled by the PN53X chip. The CRC can be generated automatically or handled manually.
* Using this function, frames can be communicated very fast via the NFC reader to the tag. * Using this function, frames can be communicated very fast via the NFC reader to the tag.