LibDriver NTAG21X
Loading...
Searching...
No Matches
driver_ntag21x.h File Reference

driver ntag21x header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_ntag21x.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ntag21x_version_s
 ntag21x version structure definition More...
struct  ntag21x_handle_s
 ntag21x handle structure definition More...
struct  ntag21x_info_s
 ntag21x information structure definition More...

Macros

#define DRIVER_NTAG21X_LINK_INIT(HANDLE, STRUCTURE)
 initialize ntag21x_handle_t structure
#define DRIVER_NTAG21X_LINK_CONTACTLESS_INIT(HANDLE, FUC)
 link contactless_init function
#define DRIVER_NTAG21X_LINK_CONTACTLESS_DEINIT(HANDLE, FUC)
 link contactless_deinit function
#define DRIVER_NTAG21X_LINK_CONTACTLESS_TRANSCEIVER(HANDLE, FUC)
 link contactless_transceiver function
#define DRIVER_NTAG21X_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_NTAG21X_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function

Typedefs

typedef struct ntag21x_version_s ntag21x_version_t
 ntag21x version structure definition
typedef struct ntag21x_handle_s ntag21x_handle_t
 ntag21x handle structure definition
typedef struct ntag21x_info_s ntag21x_info_t
 ntag21x information structure definition

Enumerations

enum  ntag21x_bool_t { NTAG21X_BOOL_FALSE = 0x00 , NTAG21X_BOOL_TRUE = 0x01 }
 ntag21x bool enumeration definition More...
enum  ntag21x_type_t { NTAG21X_TYPE_INVALID = 0x00 , NTAG21X_TYPE_213_5_6 = 0x01 }
 ntag21x type enumeration definition More...
enum  ntag21x_capability_container_t { NTAG21X_CAPABILITY_CONTAINER_144_BYTE_NTAG213 = 0x00 , NTAG21X_CAPABILITY_CONTAINER_496_BYTE_NTAG215 = 0x01 , NTAG21X_CAPABILITY_CONTAINER_872_BYTE_NTAG216 = 0x02 }
 ntag21x capability container enumeration definition More...
enum  ntag21x_mirror_t { NTAG21X_MIRROR_NO_ASCII = 0x00 , NTAG21X_MIRROR_UID_ASCII = 0x01 , NTAG21X_MIRROR_NFC_COUNTER_ASCII = 0x02 , NTAG21X_MIRROR_UID_NFC_COUNTER_ASCII = 0x03 }
 ntag21x mirror enumeration definition More...
enum  ntag21x_mirror_byte_t { NTAG21X_MIRROR_BYTE_0 = 0x00 , NTAG21X_MIRROR_BYTE_1 = 0x01 , NTAG21X_MIRROR_BYTE_2 = 0x02 , NTAG21X_MIRROR_BYTE_3 = 0x03 }
 ntag21x mirror byte enumeration definition More...
enum  ntag21x_modulation_mode_t { NTAG21X_MODULATION_MODE_NORMAL = 0x00 , NTAG21X_MODULATION_MODE_STRONG = 0x01 }
 ntag21x modulation mode enumeration definition More...
enum  ntag21x_access_t { NTAG21X_ACCESS_READ_PROTECTION = 7 , NTAG21X_ACCESS_USER_CONF_PROTECTION = 6 , NTAG21X_ACCESS_NFC_COUNTER = 4 , NTAG21X_ACCESS_NFC_COUNTER_PASSWORD_PROTECTION = 3 }
 ntag21x access enumeration definition More...

Functions

uint8_t ntag21x_info (ntag21x_info_t *info)
 get chip information
uint8_t ntag21x_init (ntag21x_handle_t *handle)
 initialize the chip
uint8_t ntag21x_deinit (ntag21x_handle_t *handle)
 close the chip
uint8_t ntag21x_request (ntag21x_handle_t *handle, ntag21x_type_t *type)
 ntag21x request
uint8_t ntag21x_wake_up (ntag21x_handle_t *handle, ntag21x_type_t *type)
 ntag21x wake up
uint8_t ntag21x_halt (ntag21x_handle_t *handle)
 ntag21x halt
uint8_t ntag21x_anticollision_cl1 (ntag21x_handle_t *handle, uint8_t id[4])
 ntag21x anti collision cl1
uint8_t ntag21x_anticollision_cl2 (ntag21x_handle_t *handle, uint8_t id[4])
 ntag21x anti collision cl2
uint8_t ntag21x_select_cl1 (ntag21x_handle_t *handle, uint8_t id[4])
 ntag21x select cl1
uint8_t ntag21x_select_cl2 (ntag21x_handle_t *handle, uint8_t id[4])
 ntag21x select cl2
uint8_t ntag21x_get_version (ntag21x_handle_t *handle, ntag21x_version_t *version)
 ntag21x get the version
uint8_t ntag21x_read_four_pages (ntag21x_handle_t *handle, uint8_t start_page, uint8_t data[16])
 ntag21x read four pages
uint8_t ntag21x_read_page (ntag21x_handle_t *handle, uint8_t page, uint8_t data[4])
 ntag21x read page
uint8_t ntag21x_fast_read_page (ntag21x_handle_t *handle, uint8_t start_page, uint8_t stop_page, uint8_t *data, uint16_t *len)
 ntag21x fast read page
uint8_t ntag21x_compatibility_write_page (ntag21x_handle_t *handle, uint8_t page, uint8_t data[4])
 ntag21x compatibility write page
uint8_t ntag21x_write_page (ntag21x_handle_t *handle, uint8_t page, uint8_t data[4])
 ntag21x write page
uint8_t ntag21x_read_counter (ntag21x_handle_t *handle, uint32_t *cnt)
 ntag21x read the counter
uint8_t ntag21x_read_signature (ntag21x_handle_t *handle, uint8_t signature[32])
 ntag21x read the signature
uint8_t ntag21x_get_serial_number (ntag21x_handle_t *handle, uint8_t number[7])
 ntag21x get the serial number
uint8_t ntag21x_get_capability_container (ntag21x_handle_t *handle, ntag21x_capability_container_t *container)
 ntag21x get the capability container
uint8_t ntag21x_set_password (ntag21x_handle_t *handle, uint8_t pwd[4])
 ntag21x set the password
uint8_t ntag21x_set_pack (ntag21x_handle_t *handle, uint8_t pack[2])
 ntag21x set the pack
uint8_t ntag21x_authenticate (ntag21x_handle_t *handle, uint8_t pwd[4], uint8_t pack[2])
 ntag21x authenticate
uint8_t ntag21x_set_dynamic_lock (ntag21x_handle_t *handle, uint8_t lock[3])
 ntag21x set the dynamic lock
uint8_t ntag21x_get_dynamic_lock (ntag21x_handle_t *handle, uint8_t lock[3])
 ntag21x get the dynamic lock
uint8_t ntag21x_set_static_lock (ntag21x_handle_t *handle, uint8_t lock[2])
 ntag21x set the static lock
uint8_t ntag21x_get_static_lock (ntag21x_handle_t *handle, uint8_t lock[2])
 ntag21x get the static lock
uint8_t ntag21x_set_mirror (ntag21x_handle_t *handle, ntag21x_mirror_t mirror)
 ntag21x set the mirror
uint8_t ntag21x_get_mirror (ntag21x_handle_t *handle, ntag21x_mirror_t *mirror)
 ntag21x get the mirror
uint8_t ntag21x_set_mirror_byte (ntag21x_handle_t *handle, ntag21x_mirror_byte_t byte)
 ntag21x set the mirror byte
uint8_t ntag21x_get_mirror_byte (ntag21x_handle_t *handle, ntag21x_mirror_byte_t *byte)
 ntag21x get the mirror byte
uint8_t ntag21x_set_modulation_mode (ntag21x_handle_t *handle, ntag21x_modulation_mode_t mode)
 ntag21x set the modulation mode
uint8_t ntag21x_get_modulation_mode (ntag21x_handle_t *handle, ntag21x_modulation_mode_t *mode)
 ntag21x get the modulation mode
uint8_t ntag21x_set_mirror_page (ntag21x_handle_t *handle, uint8_t page)
 ntag21x set the mirror page
uint8_t ntag21x_get_mirror_page (ntag21x_handle_t *handle, uint8_t *page)
 ntag21x get the mirror page
uint8_t ntag21x_set_protect_start_page (ntag21x_handle_t *handle, uint8_t page)
 ntag21x set the start page of protection
uint8_t ntag21x_get_protect_start_page (ntag21x_handle_t *handle, uint8_t *page)
 ntag21x get the start page of protection
uint8_t ntag21x_set_access (ntag21x_handle_t *handle, ntag21x_access_t access, ntag21x_bool_t enable)
 ntag21x enable or disable access
uint8_t ntag21x_get_access (ntag21x_handle_t *handle, ntag21x_access_t access, ntag21x_bool_t *enable)
 ntag21x get the access status
uint8_t ntag21x_set_authenticate_limitation (ntag21x_handle_t *handle, uint8_t limit)
 ntag21x set the authenticate limitation
uint8_t ntag21x_get_authenticate_limitation (ntag21x_handle_t *handle, uint8_t *limit)
 ntag21x get the authenticate limitation
uint8_t ntag21x_transceiver (ntag21x_handle_t *handle, uint8_t *in_buf, uint8_t in_len, uint8_t *out_buf, uint8_t *out_len)
 transceiver data

Detailed Description

driver ntag21x header file

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.

Version
1.0.0
Author
Shifeng Li
Date
2022-06-30

history

Date Version Author Description
2022/06/30 1.0 Shifeng Li first upload

Definition in file driver_ntag21x.h.