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

add some Doxygen documentation.

Browse source
This commit is contained in:
Audrey Diacre 2012-01-31 09:49:43 +00:00
parent 17c4a09c8f
commit 3d393e58a9
12 changed files with 174 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/nfc/nfc-emulation.h
View file

@ -17,6 +17,11 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>
*/
/**
* @file nfc-emulation.h
* @brief Provide a small API to ease emulation in libnfc
*/
#ifndef __NFC_EMULATION_H__
#define __NFC_EMULATION_H__
@ -30,13 +35,20 @@ extern "C" {
struct nfc_emulator;
struct nfc_emulation_state_machine;
/**
* @struct nfc_emulator
* @brief NFC emulator structure
*/
struct nfc_emulator {
nfc_target *target;
struct nfc_emulation_state_machine *state_machine;
void *user_data;
};
/**
* @struct nfc_emulation_state_machine
* @brief NFC emulation state machine structure
*/
struct nfc_emulation_state_machine {
int (*io)(struct nfc_emulator *emulator, const uint8_t *data_in, const size_t data_in_len, uint8_t *data_out, const size_t data_out_len);
void *data;

73
include/nfc/nfc.h
View file

@ -115,18 +115,67 @@ extern "C" {
NFC_EXPORT const char *nfc_version (void);
/* Error codes */
#define NFC_SUCCESS 0 // No error
#define NFC_EIO -1 // Input / output error, device will not be usable anymore
#define NFC_EINVARG -2 // Invalid argument(s)
#define NFC_EDEVNOTSUPP -3 // Operation not supported by device
#define NFC_ENOTSUCHDEV -4 // No such device
#define NFC_EOVFLOW -5 // Buffer overflow
#define NFC_ETIMEOUT -6 // Operation timed out
#define NFC_EOPABORTED -7 // Operation aborted (by user)
#define NFC_ENOTIMPL -8 // Not (yet) implemented
#define NFC_ETGRELEASED -10 // Target released
#define NFC_ERFTRANS -20 // Error while RF transmission
#define NFC_ECHIP -90 // Device's internal chip error
/** @ingroup error
* @hideinitializer
* Success (no error)
*/
#define NFC_SUCCESS 0
/** @ingroup error
* @hideinitializer
* Input / output error, device will not be usable anymore
*/
#define NFC_EIO -1
/** @ingroup error
* @hideinitializer
* Invalid argument(s)
*/
#define NFC_EINVARG -2
/** @ingroup error
* @hideinitializer
* Operation not supported by device
*/
#define NFC_EDEVNOTSUPP -3
/** @ingroup error
* @hideinitializer
* No such device
*/
#define NFC_ENOTSUCHDEV -4
/** @ingroup error
* @hideinitializer
* Buffer overflow
*/
#define NFC_EOVFLOW -5
/** @ingroup error
* @hideinitializer
* Operation timed out
*/
#define NFC_ETIMEOUT -6
/** @ingroup error
* @hideinitializer
* Operation aborted (by user)
*/
#define NFC_EOPABORTED -7
/** @ingroup error
* @hideinitializer
* Not (yet) implemented
*/
#define NFC_ENOTIMPL -8
/** @ingroup error
* @hideinitializer
* Target released
*/
#define NFC_ETGRELEASED -10
/** @ingroup error
* @hideinitializer
* Error while RF transmission
*/
#define NFC_ERFTRANS -20
/** @ingroup error
* @hideinitializer
* Device's internal chip error
*/
#define NFC_ECHIP -90
# ifdef __cplusplus
}