Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/mifare_ultralight
MIFARE Ultralight full function driver library for general MCU and Linux.
https://github.com/libdriver/mifare_ultralight
c full-function-driver linux mcu mifare-ultralight rf
Last synced: 29 days ago
JSON representation
MIFARE Ultralight full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/mifare_ultralight
- Owner: libdriver
- License: mit
- Created: 2022-05-26T06:14:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T14:44:22.000Z (2 months ago)
- Last Synced: 2024-09-26T11:20:44.058Z (about 1 month ago)
- Topics: c, full-function-driver, linux, mcu, mifare-ultralight, rf
- Language: C
- Homepage: https://www.libdriver.com
- Size: 3.43 MB
- Stars: 55
- Watchers: 12
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
## LibDriver MIFARE_Ultralight
[](/misra/README.md) [](https://www.libdriver.com/docs/mifare_ultralight/index.html) [](/LICENSE)
NXP Semiconductors developed the MIFARE Ultralight EV1 MF0ULx1 for use in a contactless smart ticket, smart card, or token in combination with a Proximity Coupling Device (PCD). The MF0ULx1 is designed to work in an ISO/IEC 14443 Type-A compliant environment. The target applications include single trip or limited use tickets in public transport networks, loyalty cards or day passes for events. The MF0ULx1 serves as a replacement for conventional ticketing solutions such as paper tickets, magnetic stripe tickets or coins. It serves as a ticketing counterpart to contactless card families such as MIFARE DESFire or MIFARE Plus.The MIFARE Ultralight EV1 is succeeding the MIFARE Ultralight ticketing IC and is fully functional backward compatible. Its enhanced feature and command set enables more efficient implementations and offers more flexibility in system designs.The mechanical and electrical specifications of MIFARE Ultralight EV1 are tailored to meet the requirements of inlay and paper ticket manufacturers.
LibDriver MIFARE_Ultralight is the full function driver of MIFARE_Ultralight launched by LibDriver.It provides the function of read page, write page and so on. LibDriver is MISRA compliant.
This repository includes submodule and you shold add "--recursive" to clone the whole project.
```shell
git clone https://github.com/libdriver/mifare_ultralight.git --recursive
```
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver MIFARE_Ultralight source files.
/interface includes LibDriver MIFARE_Ultralight RF platform independent template.
/test includes LibDriver MIFARE_Ultralight driver test code and this code can test the chip necessary function simply.
/example includes LibDriver MIFARE_Ultralight sample code.
/doc includes LibDriver MIFARE_Ultralight offline document.
/datasheet includes MIFARE_Ultralight 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 RF platform independent template and finish your platform RF driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
### Usage
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#### example basic
```C
#include "driver_mifare_ultralight_basic.h"
uint8_t res;
uint8_t i;
uint8_t id[8];
uint8_t signature[32];
uint8_t number[7];
uint8_t data[16];
uint8_t lock[5];
uint8_t pwd[4];
uint8_t pack[2];
uint32_t cnt;
uint8_t flag;
uint16_t len;
mifare_ultralight_storage_t type;
mifare_ultralight_version_t version;
/* init */
res = mifare_ultralight_basic_init();
if (res != 0)
{
return 1;
}
/* search */
res = mifare_ultralight_basic_search(&type, id, 50);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
/* ouput the type */
if (type == MIFARE_ULTRALIGHT_STORAGE_MF0UL11)
{
mifare_ultralight_interface_debug_print("mifare_ultralight: find mf0ul11 card.\n");
}
else if (type == MIFARE_ULTRALIGHT_STORAGE_MF0UL21)
{
mifare_ultralight_interface_debug_print("mifare_ultralight: find mf0ul21 card.\n");
}
else
{
mifare_ultralight_interface_debug_print("mifare_ultralight: invalid type.\n");
}
mifare_ultralight_interface_debug_print("mifare_ultralight: id is ");
for (i = 0; i < 8; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", id[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* get the version */
res = mifare_ultralight_basic_get_version(&version);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: fixed_header is 0x%02X\n", version.fixed_header);
mifare_ultralight_interface_debug_print("mifare_ultralight: vendor_id is 0x%02X\n", version.vendor_id);
mifare_ultralight_interface_debug_print("mifare_ultralight: product_type is 0x%02X\n", version.product_type);
mifare_ultralight_interface_debug_print("mifare_ultralight: product_subtype is 0x%02X\n", version.product_subtype);
mifare_ultralight_interface_debug_print("mifare_ultralight: major_product_version is 0x%02X\n", version.major_product_version);
mifare_ultralight_interface_debug_print("mifare_ultralight: minor_product_version is 0x%02X\n", version.minor_product_version);
mifare_ultralight_interface_debug_print("mifare_ultralight: storage_size is 0x%02X\n", version.storage_size);
mifare_ultralight_interface_debug_print("mifare_ultralight: protocol_type is 0x%02X\n", version.protocol_type);
...
/* read the signature */
res = mifare_ultralight_basic_read_signature(signature);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: signature is ");
for (i = 0; i < 32; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", signature[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* get the serial number */
res = mifare_ultralight_basic_get_serial_number(number);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: serial number is ");
for (i = 0; i < 7; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", id[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* read data */
res = mifare_ultralight_basic_read(0, data);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: read page %d: ", 0);
for (i = 0; i < 4; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", data[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* read data */
res = mifare_ultralight_basic_read_four_pages(0, data);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: read page %d: ", 0);
for (i = 0; i < 16; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", data[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* read the counter */
res = mifare_ultralight_basic_read_counter(0, &cnt);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("addr %d read counter %d.\n", 0, cnt);
...
/* check the tearing event */
res = mifare_ultralight_basic_check_tearing_event(0, &flag);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("addr %d check the tearing event 0x%02X.\n", 0, flag);
...
/* read otp */
res = mifare_ultralight_basic_read_otp(data);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("read otp 0x%02X 0x%02X 0x%02X 0x%02X.\n", data[0], data[1], data[2], data[3]);
...
/* write data */
res = mifare_ultralight_basic_write(0, data);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: write page %d: ", 0);
for (i = 0; i < 4; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", data[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* read pages */
len = 8;
res = mifare_ultralight_basic_read_pages((0, 0, data, &len);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: read pages %d - %d: ", 0, 0);
for (i = 0; i < len; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", data[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* write otp */
res = mifare_ultralight_basic_write_otp(data);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("write otp 0x%02X 0x%02X 0x%02X 0x%02X.\n", data[0], data[1], data[2], data[3]);
...
/* increment the counter */
res = mifare_ultralight_basic_increment_counter(0, 1);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("addr %d increment counter %d.\n", 0, 1);
...
/* set the lock */
res = mifare_ultralight_basic_set_lock(lock);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: lock is ");
for (i = 0; i < 5; i++)
{
mifare_ultralight_interface_debug_print("0x%02X ", lock[i]);
}
mifare_ultralight_interface_debug_print("\n");
...
/* set the static lock */
res = mifare_ultralight_basic_set_modulation_mode(mode);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
...
/* set protect start page */
res = mifare_ultralight_basic_set_protect_start_page(255);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: set protect start page %d.\n", 255);
...
/* set authenticate limitation */
res = mifare_ultralight_basic_set_authenticate_limitation(7);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
mifare_ultralight_interface_debug_print("mifare_ultralight: set authenticate limitation %d.\n", 7);
...
/* authenticate */
res = mifare_ultralight_basic_authenticate(pwd, pack);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
...
/* set the access */
res = mifare_ultralight_basic_set_access(MIFARE_ULTRALIGHT_ACCESS_USER_CONF_PROTECTION, MIFARE_ULTRALIGHT_BOOL_FALSE);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
...
/* set the password pack */
res = mifare_ultralight_basic_set_password_pack(pwd, pack);
if (res != 0)
{
(void)mifare_ultralight_basic_deinit();
return 1;
}
...
mifare_ultralight_interface_debug_print("mifare_ultralight: set password 0x%02X 0x%02X 0x%02X 0x%02X ok.\n",
pwd[0], pwd[1], pwd[2], pwd[3]);
mifare_ultralight_interface_debug_print("mifare_ultralight: set pack 0x%02X 0x%02X ok.\n", pack[0], pack[1]);
...
(void)mifare_ultralight_basic_deinit();
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/mifare_ultralight/index.html](https://www.libdriver.com/docs/mifare_ultralight/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 send an e-mail to [email protected].