pn532.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: LGPL-3.0-or-later AND BSD-3-Clause
 *
 * Public PN532 driver header. Portions derive from Adafruit_PN532
 * (Copyright (c) 2012, Adafruit Industries; BSD-3-Clause). See
 * NOTICES.md at the repo root for the full notice.
 */

 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
#include "driver/spi_master.h"
#include "driver/i2c_master.h"   /* new IDF v5.x master API */
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ── Card / protocol constants ──────────────────────────────────── */

/* cppcheck-suppress misra-c2012-2.5 */
#define PN532_MIFARE_ISO14443A  (0x00U)

#define PN532_MAX_APDU_LEN      (252U)

#define PN532_I2C_ADDRESS       (0x24U)
 
/* ── Transport selector ─────────────────────────────────────────── */

typedef enum {
    PN532_TRANSPORT_SPI, 
    PN532_TRANSPORT_I2C, 
} pn532_transport_t;
 
/* ── Configuration structure ────────────────────────────────────── */

typedef struct {
    pn532_transport_t transport; 
 
    /* ── SPI fields (used when transport == PN532_TRANSPORT_SPI) ── */
    spi_host_device_t spi_host;    
    int               pin_mosi;   
    int               pin_miso;   
    int               pin_sclk;   
    int               pin_cs;     
    bool              skip_bus_init; 
 
    /* ── I²C fields (used when transport == PN532_TRANSPORT_I2C) ── */
    int      i2c_port;    
    int      pin_sda;     
    int      pin_scl;     
    int      pin_irq;     
    int      pin_rst;     
    uint32_t i2c_clock_hz; 
} pn532_config_t;
 
/* ── Runtime device state ───────────────────────────────────────── */

typedef struct {
    pn532_transport_t transport; 
 
    /* ── SPI state ── */
    spi_device_handle_t spi;    
    int                 pin_cs; 
 
    /* ── I²C state ── */
    i2c_master_bus_handle_t i2c_bus; 
    i2c_master_dev_handle_t i2c_dev; 
    int                     pin_irq; 
    int                     pin_rst; 
} pn532_t;
 
/* ── Public API ─────────────────────────────────────────────────── */

esp_err_t pn532_init(pn532_t *dev, const pn532_config_t *config);

uint32_t pn532_get_firmware_version(pn532_t *dev);

bool pn532_sam_config(pn532_t *dev);

uint32_t pn532_read_passive_target_id(pn532_t *dev, uint8_t cardbaudrate);

bool pn532_send_apdu(pn532_t *dev, const uint8_t *apdu, uint8_t apdu_len,
                     uint8_t *response, uint16_t *response_len);

bool pn532_release_target(pn532_t *dev);
 /* end of pn532_driver group */
 
#ifdef __cplusplus
}
#endif