pn532.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 TriaGnoSys GmbH
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "kernel_defines.h"
#include "mutex.h"
#include "periph/i2c.h"
#include "periph/spi.h"
#include "periph/gpio.h"
#include <stdint.h>
 
#if !IS_USED(MODULE_PN532_I2C) && !IS_USED(MODULE_PN532_SPI)
#error Please use either pn532_i2c and/or pn532_spi module to enable \
    the functionality on this device
#endif

typedef struct {
    union {
#if IS_USED(MODULE_PN532_I2C) || DOXYGEN
        i2c_t i2c;              
#endif
#if IS_USED(MODULE_PN532_SPI) || DOXYGEN
        spi_t spi;              
#endif
    };
    gpio_t reset;               
    gpio_t irq;                 
#if IS_USED(MODULE_PN532_SPI) || DOXYGEN
    gpio_t nss;                 
#endif
} pn532_params_t;

typedef enum {
    PN532_I2C,
    PN532_SPI
} pn532_mode_t;

typedef struct {
    const pn532_params_t *conf;     
    pn532_mode_t mode;              
    mutex_t trap;                   
} pn532_t;

#ifndef CONFIG_PN532_BUFFER_LEN
#define CONFIG_PN532_BUFFER_LEN     (64)
#endif

#define PN532_IC_VERSION(fwver)  ((fwver >> 24) & 0xff)
#define PN532_FW_VERSION(fwver)  ((fwver >> 16) & 0xff)
#define PN532_FW_REVISION(fwver) ((fwver >>  8) & 0xff)
#define PN532_FW_FEATURES(fwver) ((fwver) & 0xff)

typedef enum {
    PN532_SAM_NORMAL = 1,
    PN532_SAM_VIRTUAL,
    PN532_SAM_WIRED,
    PN532_SAM_DUAL
} pn532_sam_conf_mode_t;

typedef enum {
    PN532_BR_106_ISO_14443_A = 0,
    PN532_BR_212_FELICA,
    PN532_BR_424_FELICA,
    PN532_BR_106_ISO_14443_B,
    PN532_BR_106_JEWEL
} pn532_target_t;

typedef enum {
    ISO14443A_UNKNOWN,
    ISO14443A_MIFARE,
    ISO14443A_TYPE4
} nfc_iso14443a_type_t;

typedef struct {
    char target;                
    char auth;                  
    char id_len;                
    char sel_res;               
    unsigned sns_res;           
    nfc_iso14443a_type_t type;  
    char id[8];                 
} nfc_iso14443a_t;

typedef enum {
    PN532_MIFARE_KEY_A = 0x60,
    PN532_MIFARE_KEY_B = 0x61
} pn532_mifare_key_t;

#define PN532_ISO14443A_4_LEN_FROM_BUFFER(b) ((b[0] << 8) | b[1])

void pn532_reset(const pn532_t *dev);

int pn532_init(pn532_t *dev, const pn532_params_t *params, pn532_mode_t mode);
 
#if IS_USED(MODULE_PN532_I2C) || DOXYGEN
static inline int pn532_init_i2c(pn532_t *dev, const pn532_params_t *params)
{
    return pn532_init(dev, params, PN532_I2C);
}
#endif
 
#if IS_USED(MODULE_PN532_SPI) || DOXYGEN
static inline int pn532_init_spi(pn532_t *dev, const pn532_params_t *params)
{
    return pn532_init(dev, params, PN532_SPI);
}
#endif

int pn532_fw_version(pn532_t *dev, uint32_t *fw_ver);

int pn532_read_reg(pn532_t *dev, char *out, unsigned addr);

int pn532_write_reg(pn532_t *dev, unsigned addr, char val);

int pn532_sam_configuration(pn532_t *dev, pn532_sam_conf_mode_t mode, unsigned timeout);

int pn532_get_passive_iso14443a(pn532_t *dev, nfc_iso14443a_t *out, unsigned max_retries);

int pn532_mifareclassic_authenticate(pn532_t *dev, nfc_iso14443a_t *card,
                                     pn532_mifare_key_t keyid, char *key, unsigned block);

int pn532_mifareclassic_read(pn532_t *dev, char *odata, nfc_iso14443a_t *card, unsigned block);

int pn532_mifareclassic_write(pn532_t *dev, char *idata, nfc_iso14443a_t *card, unsigned block);

int pn532_mifareulight_read(pn532_t *dev, char *odata, nfc_iso14443a_t *card, unsigned page);

int pn532_iso14443a_4_activate(pn532_t *dev, nfc_iso14443a_t *card);

int pn532_iso14443a_4_read(pn532_t *dev, char *odata, nfc_iso14443a_t *card, unsigned offset,
                           char len);

void pn532_deselect_passive(pn532_t *dev, unsigned target_id);

void pn532_release_passive(pn532_t *dev, unsigned target_id);
 
#ifdef __cplusplus
}
#endif