English | 简体中文 | 繁體中文 | 日本語 | Deutsch | 한국어
LibDriver MFRC522
The MFRC522 is a highly integrated reader/writer IC for contactless communication at 13.56 MHz. The MFRC522 reader supports ISO/IEC 14443 A/MIFARE and NTAG.The MFRC522’s internal transmitter is able to drive a reader/writer antenna designed to communicate with ISO/IEC 14443 A/MIFARE cards and transponders without additional active circuitry. The receiver module provides a robust and efficient implementation for demodulating and decoding signals from ISO/IEC 14443 A/MIFARE compatible cards and transponders. The digital module manages the complete ISO/IEC 14443 A framing and error detection (parity and CRC) functionality.
LibDriver MFRC522 is the full function driver of MFRC522 launched by LibDriver.It provides the function of contactless communication, crc calculation, random generation and so on. LibDriver is MISRA compliant.
LibDriver MFRC522 provides the full function driver of MFRC522, but it does not include MIFARE Classic, MIFARE Ultralight, NTAG21x and other drivers.
MIFARE Classic driver can refer to https://github.com/hepingood/mifare_classic
MIFARE Ultralight driver can refer to https://github.com/hepingood/mifare_ultralight
NTAG21x drive can refer to https://github.com/hepingood/ntag21x
Table of Contents
Instruction
/src includes LibDriver MFRC522 source files.
/interface includes LibDriver MFRC522 IIC, SPI, UART platform independent template.
/test includes LibDriver MFRC522 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver MFRC522 sample code.
/doc includes LibDriver MFRC522 offline document.
/datasheet includes MFRC522 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
Install
Reference /interface IIC, SPI, UART platform independent template and finish your platform IIC, SPI, UART driver.
Add /src, /interface and /example to your project.
Usage
example basic
#include "driver_mfrc522_basic.h"
uint8_t i;
uint8_t buf[25];
uint16_t crc;
char crc_input[] = "libdriver";
uint8_t in_buf[64];
uint8_t in_len;
uint8_t out_len;
uint8_t out_buf[64];
static void a_callback(uint16_t type)
{
switch (type)
{
case MFRC522_INTERRUPT_MFIN_ACT :
{
mfrc522_interface_debug_print("mfrc522: irq mfin act.\n");
break;
}
case MFRC522_INTERRUPT_CRC :
{
break;
}
case MFRC522_INTERRUPT_TX :
{
break;
}
case MFRC522_INTERRUPT_RX :
{
break;
}
case MFRC522_INTERRUPT_IDLE :
{
break;
}
case MFRC522_INTERRUPT_HI_ALERT :
{
break;
}
case MFRC522_INTERRUPT_LO_ALERT :
{
break;
}
case MFRC522_INTERRUPT_ERR :
{
mfrc522_interface_debug_print("mfrc522: irq err.\n");
break;
}
case MFRC522_INTERRUPT_TIMER :
{
mfrc522_interface_debug_print("mfrc522: irq timer.\n");
break;
}
default :
{
mfrc522_interface_debug_print("mfrc522: irq unknown code.\n");
break;
}
}
}
...
/* interrupt init */
g_gpio_irq = mfrc522_interrupt_irq_handler;
res = gpio_interrupt_init();
if (res != 0)
{
return 1;
}
/* init */
res = mfrc522_basic_init(MFRC522_INTERFACE_SPI, 0x00, a_callback);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
...
/* get the random */
res = mfrc522_basic_generate_random(buf);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
for (i = 0; i < 25; i++)
{
mfrc522_interface_debug_print("0x%02X ", buf[i]);
}
mfrc522_interface_debug_print("\n");
...
/* calculate the crc */
res = mfrc522_basic_calculate_crc((uint8_t *)crc_input, (uint8_t)strlen(crc_input), &crc);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
mfrc522_interface_debug_print("%s crc is 0x%04X.\n", argv[4], crc);
...
/* set the input */
in_buf[0] = 0x26;
in_len = 1;
out_len = 64;
res = mfrc522_basic_transceiver(in_buf, in_len, out_buf, &out_len);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
for (i = 0; i < 25; i++)
{
mfrc522_interface_debug_print("0x%02X ", out_buf[i]);
}
mfrc522_interface_debug_print("\n");
...
/* deinit */
(void)mfrc522_basic_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 0;Document
Online documents: https://www.libdriver.com/docs/mfrc522/index.html.
Offline documents: /doc/html/index.html.
Contributing
Please refer to CONTRIBUTING.md.
License
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Contact Us
Please sent an e-mail to [email protected].