libnfc/src/lib/nfc-types.h

/**
 * Public platform independent Near Field Communication (NFC) library
 * 
 * Copyright (C) 2009, Roel Verdult
 * 
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 * 
 * 
 * @file nfc-types.h
 * @brief Define NFC types
 */

#ifndef __NFC_TYPES_H__
#define __NFC_TYPES_H__

/**
 * @file types.h
 * @brief libnfc-defined types
 *
 * Define libnfc specific types: typedef, enum, struct, etc.
 */
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

typedef uint8_t byte_t;

typedef enum {
  NC_PN531                    = 0x10,
  NC_PN532                    = 0x20,
  NC_PN533                    = 0x30,
} nfc_chip_t;

struct driver_callbacks;                // Prototype the callback struct

typedef void*               nfc_device_spec_t; // Device connection specification

#define DEVICE_NAME_LENGTH  256
/**
 * @struct nfc_device_t
 * @brief NFC device information
 */
typedef struct {
/** Callback functions for handling device specific wrapping */
  const struct driver_callbacks* pdc;
/** Device name string, including device wrapper firmware */
  char acName[DEVICE_NAME_LENGTH];
/** PN53X chip type, this is useful for some "bug" work-arounds */
  nfc_chip_t nc;
/** Pointer to the device connection specification */
 nfc_device_spec_t nds;
/** This represents if the PN53X device was initialized succesful */
  bool bActive;
/** Is the crc automaticly added, checked and removed from the frames */
  bool bCrc;
/** Does the PN53x chip handles parity bits, all parities are handled as data */
  bool bPar;
/** The last tx bits setting, we need to reset this if it does not apply anymore */
  uint8_t ui8TxBits;
} nfc_device_t;


/**
 * @struct nfc_device_desc_t
 * @brief NFC device description
 *
 * This struct is used to try to connect to a specified nfc device when nfc_connect(...)
 */
typedef struct {
  /** Driver name (ie. PN532)*/
  char* pcDriver;
  /** Port (ie. /dev/ttyUSB0) */
  char* pcPort;
  /** Port speed (ie. 115200) */
  uint32_t uiSpeed;
  /** Device index for backward compatibility (used to choose one specific device in USB or PSCS devices list) */
  uint32_t uiIndex;
} nfc_device_desc_t;

/**
 * @struct driver_callbacks
 * @brief Generic structure to handle NFC device functions.
 */
struct driver_callbacks {
  /** Driver name */
  const char* acDriver;
  /** Connect callback */
  nfc_device_t* (*connect)(const nfc_device_desc_t* pndd);
  /** Transceive callback */
  bool (*transceive)(const nfc_device_spec_t nds, const byte_t* pbtTx, const size_t szTxLen, byte_t* pbtRx, size_t* pszRxLen);
  /** Disconnect callback */
  void (*disconnect)(nfc_device_t* pnd);
};

// Compiler directive, set struct alignment to 1 byte_t for compatibility
#pragma pack(1)

/**
 * @enum nfc_device_option_t
 * @brief NFC device option
 */
typedef enum {
/** Let the PN53X chip handle the CRC bytes. This means that the chip appends the CRC bytes to the frames that are transmitted. It will parse the last bytes from received frames as incoming CRC bytes. They will be verified against the used modulation and protocol. If an frame is expected with incorrect CRC bytes this option should be disabled. Example frames where this is useful are the ATQA and UID+BCC that are transmitted without CRC bytes during the anti-collision phase of the ISO14443-A protocol. */
  NDO_HANDLE_CRC              = 0x00,
/** Parity bits in the network layer of ISO14443-A are by default generated and validated in the PN53X chip. This is a very convenient feature. On certain times though it is useful to get full control of the transmitted data. The proprietary MIFARE Classic protocol uses for example custom (encrypted) parity bits. For interoperability it is required to be completely compatible, including the arbitrary parity bits. When this option is disabled, the functions to communicating bits should be used. */
  NDO_HANDLE_PARITY           = 0x01,
/** This option can be used to enable or disable the electronic field of the NFC device. */
  NDO_ACTIVATE_FIELD          = 0x10,
/** The internal CRYPTO1 co-processor can be used to transmit messages encrypted. This option is automatically activated after a successful MIFARE Classic authentication. */
  NDO_ACTIVATE_CRYPTO1        = 0x11,
/** The default configuration defines that the PN53X chip will try indefinitely to invite a tag in the field to respond. This could be desired when it is certain a tag will enter the field. On the other hand, when this is uncertain, it will block the application. This option could best be compared to the (NON)BLOCKING option used by (socket)network programming. */
  NDO_INFINITE_SELECT         = 0x20,
/** If this option is enabled, frames that carry less than 4 bits are allowed. According to the standards these frames should normally be handles as invalid frames. */
  NDO_ACCEPT_INVALID_FRAMES   = 0x30,
/** If the NFC device should only listen to frames, it could be useful to let it gather multiple frames in a sequence. They will be stored in the internal FIFO of the PN53X chip. This could be retrieved by using the receive data functions. Note that if the chip runs out of bytes (FIFO = 64 bytes long), it will overwrite the first received frames, so quick retrieving of the received data is desirable. */
  NDO_ACCEPT_MULTIPLE_FRAMES  = 0x31
} nfc_device_option_t;

////////////////////////////////////////////////////////////////////
// nfc_reader_list_passive - using InListPassiveTarget 

/**
 * @enum nfc_modulation_t
 * @brief NFC modulation
 */
typedef enum {
/** ISO14443-A (NXP MIFARE) http://en.wikipedia.org/wiki/MIFARE */
  NM_ISO14443A_106  = 0x00,
/** JIS X 6319-4 (Sony Felica) http://en.wikipedia.org/wiki/FeliCa */
  NM_FELICA_212     = 0x01,
/** JIS X 6319-4 (Sony Felica) http://en.wikipedia.org/wiki/FeliCa */
  NM_FELICA_424     = 0x02,
/** ISO14443-B http://en.wikipedia.org/wiki/ISO/IEC_14443 */
  NM_ISO14443B_106  = 0x03,
/** Jewel Topaz (Innovision Research & Development) */
  NM_JEWEL_106      = 0x04,
/** Active DEP */
  NM_ACTIVE_DEP = 0x05,
/** Passive DEP */
  NM_PASSIVE_DEP = 0x06,
} nfc_modulation_t;

/**
 * @struct nfc_target_info_t_dep
 * @brief NFC tag information in Data Exchange Protocol
 */
typedef struct {
  byte_t NFCID3i[10];
  byte_t btDID;
  byte_t btBSt;
  byte_t btBRt;
} nfc_dep_info_t;

/**
 * @struct nfc_target_info_t_iso14443a
 * @brief NFC ISO14443A tag (MIFARE) information
 */
typedef struct {
  byte_t abtAtqa[2];
  byte_t btSak;
  size_t szUidLen;
  byte_t abtUid[10];
  size_t szAtsLen;
  byte_t abtAts[36];
} nfc_iso14443a_info_t;

/**
 * @struct nfc_target_info_t_felica
 * @brief NFC FeLiCa tag information
 */
typedef struct {
  size_t szLen;
  byte_t btResCode;
  byte_t abtId[8];
  byte_t abtPad[8];
  byte_t abtSysCode[2];
} nfc_felica_info_t;

/**
 * @struct nfc_target_info_t_iso14443b
 * @brief NFC ISO14443B tag information
 */
typedef struct {
  byte_t abtAtqb[12];
  byte_t abtId[4];
  byte_t btParam1;
  byte_t btParam2;
  byte_t btParam3;
  byte_t btParam4;
  byte_t btCid;
  size_t szInfLen;
  byte_t abtInf[64];
} nfc_iso14443b_info_t;

/**
 * @struct nfc_target_info_t_jewel
 * @brief NFC Jewel tag information
 */
typedef struct {
  byte_t btSensRes[2];
  byte_t btId[4];
} nfc_jewel_info_t;

/**
 * @union nfc_target_info_t
 * @brief Union between all kind of tags information structures.
 */
typedef union {
  nfc_iso14443a_info_t nai;
  nfc_felica_info_t nfi;
  nfc_iso14443b_info_t nbi;
  nfc_jewel_info_t nji;
  nfc_dep_info_t ndi;
} nfc_target_info_t;

////////////////////////////////////////////////////////////////////
// InDataExchange, MIFARE Classic card 

typedef enum {
  MC_AUTH_A         = 0x60,
  MC_AUTH_B         = 0x61,
  MC_READ           = 0x30,
  MC_WRITE          = 0xA0,
  MC_TRANSFER       = 0xB0,
  MC_DECREMENT      = 0xC0,
  MC_INCREMENT      = 0xC1,
  MC_STORE          = 0xC2,
}mifare_cmd;

// MIFARE Classic command params
typedef struct {
  byte_t abtKey[6];
  byte_t abtUid[4];
}mifare_param_auth;

typedef struct {
  byte_t abtData[16];
}mifare_param_data;

typedef struct {
  byte_t abtValue[4];
}mifare_param_value;

typedef union {
  mifare_param_auth mpa;
  mifare_param_data mpd;
  mifare_param_value mpv;
}mifare_param;

// Reset struct alignment to default
#pragma pack()

#endif // _LIBNFC_TYPES_H_