mifare ultralight basic driver modules More...

Collaboration diagram for mifare ultralight basic driver function:

Data Structures
struct	mifare_ultralight_version_s
	mifare ultralight version structure definition More...
struct	mifare_ultralight_handle_s
	mifare ultralight handle structure definition More...
struct	mifare_ultralight_info_s
	mifare ultralight information structure definition More...

Typedefs
typedef struct mifare_ultralight_version_s	mifare_ultralight_version_t
	mifare ultralight version structure definition
typedef struct mifare_ultralight_handle_s	mifare_ultralight_handle_t
	mifare ultralight handle structure definition
typedef struct mifare_ultralight_info_s	mifare_ultralight_info_t
	mifare ultralight information structure definition

Enumerations
enum	mifare_ultralight_bool_t { MIFARE_ULTRALIGHT_BOOL_FALSE = 0x00 , MIFARE_ULTRALIGHT_BOOL_TRUE = 0x01 }
	mifare ultralight bool enumeration definition More...
enum	mifare_ultralight_type_t { MIFARE_ULTRALIGHT_TYPE_INVALID = 0x00 , MIFARE_ULTRALIGHT_TYPE_ULTRALIGHT = 0x01 }
	mifare ultralight type enumeration definition More...
enum	mifare_ultralight_storage_t { MIFARE_ULTRALIGHT_STORAGE_MF0UL11 = 0x13 , MIFARE_ULTRALIGHT_STORAGE_MF0UL21 = 0x28 }
	mifare ultralight storage enumeration definition More...
enum	mifare_ultralight_access_t { MIFARE_ULTRALIGHT_ACCESS_READ_PROTECTION = 7 , MIFARE_ULTRALIGHT_ACCESS_USER_CONF_PROTECTION = 6 }
	mifare_ultralight access enumeration definition More...
enum	mifare_ultralight_modulation_mode_t { MIFARE_ULTRALIGHT_MODULATION_MODE_NORMAL = 0x00 , MIFARE_ULTRALIGHT_MODULATION_MODE_STRONG = 0x01 }
	mifare ultralight modulation mode enumeration definition More...

Functions
uint8_t	mifare_ultralight_info (mifare_ultralight_info_t *info)
	get chip information
uint8_t	mifare_ultralight_init (mifare_ultralight_handle_t *handle)
	initialize the chip
uint8_t	mifare_ultralight_deinit (mifare_ultralight_handle_t *handle)
	close the chip
uint8_t	mifare_ultralight_set_storage (mifare_ultralight_handle_t *handle, mifare_ultralight_storage_t storage)
	set the storage
uint8_t	mifare_ultralight_get_storage (mifare_ultralight_handle_t handle, mifare_ultralight_storage_t storage)
	get the storage
uint8_t	mifare_ultralight_request (mifare_ultralight_handle_t handle, mifare_ultralight_type_t type)
	mifare_ultralight request
uint8_t	mifare_ultralight_wake_up (mifare_ultralight_handle_t handle, mifare_ultralight_type_t type)
	mifare_ultralight wake up
uint8_t	mifare_ultralight_halt (mifare_ultralight_handle_t *handle)
	mifare_ultralight halt
uint8_t	mifare_ultralight_anticollision_cl1 (mifare_ultralight_handle_t *handle, uint8_t id[4])
	mifare_ultralight anti collision cl1
uint8_t	mifare_ultralight_anticollision_cl2 (mifare_ultralight_handle_t *handle, uint8_t id[4])
	mifare_ultralight anti collision cl2
uint8_t	mifare_ultralight_select_cl1 (mifare_ultralight_handle_t *handle, uint8_t id[4])
	mifare_ultralight select cl1
uint8_t	mifare_ultralight_select_cl2 (mifare_ultralight_handle_t *handle, uint8_t id[4])
	mifare_ultralight select cl2
uint8_t	mifare_ultralight_get_version (mifare_ultralight_handle_t handle, mifare_ultralight_version_t version)
	mifare_ultralight get the version
uint8_t	mifare_ultralight_read_counter (mifare_ultralight_handle_t handle, uint8_t addr, uint32_t cnt)
	mifare_ultralight read the counter
uint8_t	mifare_ultralight_increment_counter (mifare_ultralight_handle_t *handle, uint8_t addr, uint32_t cnt)
	mifare_ultralight increment the counter
uint8_t	mifare_ultralight_check_tearing_event (mifare_ultralight_handle_t handle, uint8_t addr, uint8_t flag)
	mifare_ultralight check the tearing event
uint8_t	mifare_ultralight_vcsl (mifare_ultralight_handle_t handle, uint8_t installation_identifier[16], uint8_t pcd_capabilities[4], uint8_t identifier)
	mifare_ultralight vcsl command
uint8_t	mifare_ultralight_read_signature (mifare_ultralight_handle_t *handle, uint8_t signature[32])
	mifare_ultralight read the signature
uint8_t	mifare_ultralight_get_serial_number (mifare_ultralight_handle_t *handle, uint8_t number[7])
	mifare_ultralight get the serial number
uint8_t	mifare_ultralight_read_four_pages (mifare_ultralight_handle_t *handle, uint8_t start_page, uint8_t data[16])
	mifare_ultralight read four pages
uint8_t	mifare_ultralight_read_page (mifare_ultralight_handle_t *handle, uint8_t page, uint8_t data[4])
	mifare_ultralight read page
uint8_t	mifare_ultralight_fast_read_page (mifare_ultralight_handle_t handle, uint8_t start_page, uint8_t stop_page, uint8_t data, uint16_t *len)
	mifare_ultralight fast read page
uint8_t	mifare_ultralight_compatibility_write_page (mifare_ultralight_handle_t *handle, uint8_t page, uint8_t data[4])
	mifare_ultralight compatibility write page
uint8_t	mifare_ultralight_write_page (mifare_ultralight_handle_t *handle, uint8_t page, uint8_t data[4])
	mifare_ultralight write page
uint8_t	mifare_ultralight_authenticate (mifare_ultralight_handle_t *handle, uint8_t pwd[4], uint8_t pack[2])
	mifare_ultralight authenticate
uint8_t	mifare_ultralight_set_password (mifare_ultralight_handle_t *handle, uint8_t pwd[4])
	mifare_ultralight set the password
uint8_t	mifare_ultralight_set_pack (mifare_ultralight_handle_t *handle, uint8_t pack[2])
	mifare_ultralight set the pack
uint8_t	mifare_ultralight_set_modulation_mode (mifare_ultralight_handle_t *handle, mifare_ultralight_modulation_mode_t mode)
	mifare_ultralight set the modulation mode
uint8_t	mifare_ultralight_get_modulation_mode (mifare_ultralight_handle_t handle, mifare_ultralight_modulation_mode_t mode)
	mifare_ultralight get the modulation mode
uint8_t	mifare_ultralight_set_protect_start_page (mifare_ultralight_handle_t *handle, uint8_t page)
	mifare_ultralight set the start page of protection
uint8_t	mifare_ultralight_get_protect_start_page (mifare_ultralight_handle_t handle, uint8_t page)
	mifare_ultralight get the start page of protection
uint8_t	mifare_ultralight_set_access (mifare_ultralight_handle_t *handle, mifare_ultralight_access_t access, mifare_ultralight_bool_t enable)
	mifare_ultralight enable or disable access
uint8_t	mifare_ultralight_get_access (mifare_ultralight_handle_t handle, mifare_ultralight_access_t access, mifare_ultralight_bool_t enable)
	mifare_ultralight get the access status
uint8_t	mifare_ultralight_set_authenticate_limitation (mifare_ultralight_handle_t *handle, uint8_t limit)
	mifare_ultralight set the authenticate limitation
uint8_t	mifare_ultralight_get_authenticate_limitation (mifare_ultralight_handle_t handle, uint8_t limit)
	mifare_ultralight get the authenticate limitation
uint8_t	mifare_ultralight_set_virtual_card_type_identifier (mifare_ultralight_handle_t *handle, uint8_t identifier)
	mifare_ultralight set the virtual card type identifier
uint8_t	mifare_ultralight_get_virtual_card_type_identifier (mifare_ultralight_handle_t handle, uint8_t identifier)
	mifare_ultralight get the virtual card type identifier
uint8_t	mifare_ultralight_set_lock (mifare_ultralight_handle_t *handle, uint8_t lock[5])
	mifare_ultralight set the lock
uint8_t	mifare_ultralight_get_lock (mifare_ultralight_handle_t *handle, uint8_t lock[5])
	mifare_ultralight get the lock
uint8_t	mifare_ultralight_read_otp (mifare_ultralight_handle_t *handle, uint8_t data[4])
	mifare_ultralight read otp page
uint8_t	mifare_ultralight_write_otp (mifare_ultralight_handle_t *handle, uint8_t data[4])
	mifare_ultralight write otp page

Detailed Description

mifare ultralight basic driver modules

Typedef Documentation

◆ mifare_ultralight_handle_t

typedef struct mifare_ultralight_handle_s mifare_ultralight_handle_t

mifare ultralight handle structure definition

◆ mifare_ultralight_info_t

typedef struct mifare_ultralight_info_s mifare_ultralight_info_t

mifare ultralight information structure definition

◆ mifare_ultralight_version_t

typedef struct mifare_ultralight_version_s mifare_ultralight_version_t

mifare ultralight version structure definition

Enumeration Type Documentation

◆ mifare_ultralight_access_t

enum mifare_ultralight_access_t

mifare_ultralight access enumeration definition

Enumerator
MIFARE_ULTRALIGHT_ACCESS_READ_PROTECTION	enable or disable read access protection
MIFARE_ULTRALIGHT_ACCESS_USER_CONF_PROTECTION	enable or disable user configuration protection

Definition at line 89 of file driver_mifare_ultralight.h.

◆ mifare_ultralight_bool_t

enum mifare_ultralight_bool_t

mifare ultralight bool enumeration definition

Enumerator
MIFARE_ULTRALIGHT_BOOL_FALSE	false
MIFARE_ULTRALIGHT_BOOL_TRUE	true

Definition at line 62 of file driver_mifare_ultralight.h.

◆ mifare_ultralight_modulation_mode_t

enum mifare_ultralight_modulation_mode_t

mifare ultralight modulation mode enumeration definition

Enumerator
MIFARE_ULTRALIGHT_MODULATION_MODE_NORMAL	normal
MIFARE_ULTRALIGHT_MODULATION_MODE_STRONG	strong

Definition at line 98 of file driver_mifare_ultralight.h.

◆ mifare_ultralight_storage_t

enum mifare_ultralight_storage_t

mifare ultralight storage enumeration definition

Enumerator
MIFARE_ULTRALIGHT_STORAGE_MF0UL11	20 pages
MIFARE_ULTRALIGHT_STORAGE_MF0UL21	41 pages

Definition at line 80 of file driver_mifare_ultralight.h.

◆ mifare_ultralight_type_t

enum mifare_ultralight_type_t

mifare ultralight type enumeration definition

Enumerator
MIFARE_ULTRALIGHT_TYPE_INVALID	invalid
MIFARE_ULTRALIGHT_TYPE_ULTRALIGHT	ultralight

Definition at line 71 of file driver_mifare_ultralight.h.

Function Documentation

◆ mifare_ultralight_anticollision_cl1()

uint8_t mifare_ultralight_anticollision_cl1	(	mifare_ultralight_handle_t *	handle,
		uint8_t	id[4] )

mifare_ultralight anti collision cl1

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*id	pointer to an id buffer

Returns

status code

0 success
1 anti collision cl1 failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 check error

Note: none

Definition at line 524 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_anticollision_cl2()

uint8_t mifare_ultralight_anticollision_cl2	(	mifare_ultralight_handle_t *	handle,
		uint8_t	id[4] )

mifare_ultralight anti collision cl2

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*id	pointer to an id buffer

Returns

status code

0 success
1 anti collision cl2 failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 check error

Note: none

Definition at line 589 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_authenticate()

uint8_t mifare_ultralight_authenticate	(	mifare_ultralight_handle_t *	handle,
		uint8_t	pwd[4],
		uint8_t	pack[2] )

mifare_ultralight authenticate

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*pwd	pointer to a pwd buffer
[in]	*pack	pointer to a pack buffer

Returns

status code

0 success
1 authenticate failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error
6 pack check failed

Note: none

Definition at line 1660 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_check_tearing_event()

uint8_t mifare_ultralight_check_tearing_event	(	mifare_ultralight_handle_t *	handle,
		uint8_t	addr,
		uint8_t *	flag )

mifare_ultralight check the tearing event

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	addr	check address
[out]	*flag	pointer to a flag buffer

Returns

status code

0 success
1 check tearing event failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error
6 addr > 0x2

Note: 0 <= addr <= 2

Definition at line 1015 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_compatibility_write_page()

uint8_t mifare_ultralight_compatibility_write_page	(	mifare_ultralight_handle_t *	handle,
		uint8_t	page,
		uint8_t	data[4] )

mifare_ultralight compatibility write page

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	page	page of write
[in]	*data	pointer to a data buffer

Returns

status code

0 success
1 compatibility write page failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error

Note: none

Definition at line 1511 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_deinit()

uint8_t mifare_ultralight_deinit ( mifare_ultralight_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to a mifare_ultralight handle structure

Returns

status code

0 success
1 contactless deinit failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 323 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_fast_read_page()

uint8_t mifare_ultralight_fast_read_page	(	mifare_ultralight_handle_t *	handle,
		uint8_t	start_page,
		uint8_t	stop_page,
		uint8_t *	data,
		uint16_t *	len )

mifare_ultralight fast read page

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	start_page	start page
[in]	stop_page	stop page
[out]	*data	pointer to a data buffer
[in,out]	*len	pointer to a data length buffer

Returns

status code

0 success
1 fast read page failed
2 handle is NULL
3 handle is not initialized
4 stop_page < start_page
5 stop_page - start_page + 1 is over 15
6 len is invalid
7 output_len is invalid
8 crc error

Note: stop_page - start_page + 1 <= 15 4 * (stop_page - start_page + 1) < len

Definition at line 1424 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_access()

uint8_t mifare_ultralight_get_access	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_access_t	access,
		mifare_ultralight_bool_t *	enable )

mifare_ultralight get the access status

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	access	set access
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
1 get access failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2069 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_authenticate_limitation()

uint8_t mifare_ultralight_get_authenticate_limitation	(	mifare_ultralight_handle_t *	handle,
		uint8_t *	limit )

mifare_ultralight get the authenticate limitation

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*limit	pointer to an authenticate limitation buffer

Returns

status code

0 success
1 get authenticate limitation failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2160 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_lock()

uint8_t mifare_ultralight_get_lock	(	mifare_ultralight_handle_t *	handle,
		uint8_t	lock[5] )

mifare_ultralight get the lock

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*lock	pointer to a lock buffer

Returns

status code

0 success
1 get lock failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 2388 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_modulation_mode()

uint8_t mifare_ultralight_get_modulation_mode	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_modulation_mode_t *	mode )

mifare_ultralight get the modulation mode

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*mode	pointer to a modulation mode buffer

Returns

status code

0 success
1 get modulation mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1900 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_protect_start_page()

uint8_t mifare_ultralight_get_protect_start_page	(	mifare_ultralight_handle_t *	handle,
		uint8_t *	page )

mifare_ultralight get the start page of protection

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*page	pointer to a start page buffer

Returns

status code

0 success
1 get protect start page failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1983 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_serial_number()

uint8_t mifare_ultralight_get_serial_number	(	mifare_ultralight_handle_t *	handle,
		uint8_t	number[7] )

mifare_ultralight get the serial number

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*number	pointer to a number buffer

Returns

status code

0 success
1 get serial number failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 1217 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_storage()

uint8_t mifare_ultralight_get_storage	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_storage_t *	storage )

get the storage

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*storage	pointer to a set storage buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 236 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_version()

uint8_t mifare_ultralight_get_version	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_version_t *	version )

mifare_ultralight get the version

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*version	pointer to a version structure

Returns

status code

0 success
1 get version failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 788 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_get_virtual_card_type_identifier()

uint8_t mifare_ultralight_get_virtual_card_type_identifier	(	mifare_ultralight_handle_t *	handle,
		uint8_t *	identifier )

mifare_ultralight get the virtual card type identifier

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*identifier	pointer to a virtual card type identifier buffer

Returns

status code

0 success
1 get virtual card type identifier failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2243 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_halt()

uint8_t mifare_ultralight_halt ( mifare_ultralight_handle_t * handle )

mifare_ultralight halt

Parameters

[in] *handle pointer to a mifare_ultralight handle structure

Returns

status code

0 success
1 halt failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 485 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_increment_counter()

uint8_t mifare_ultralight_increment_counter	(	mifare_ultralight_handle_t *	handle,
		uint8_t	addr,
		uint32_t	cnt )

mifare_ultralight increment the counter

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	addr	read counter address
[in]	cnt	increment counter

Returns

status code

0 success
1 increment counter failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error
6 addr > 0x2

Note: 0 <= addr <= 2

Definition at line 945 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_info()

uint8_t mifare_ultralight_info ( mifare_ultralight_info_t * info )

get chip information

Parameters

[out] *info pointer to a mifare_ultralight info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 2639 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_init()

uint8_t mifare_ultralight_init ( mifare_ultralight_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to a mifare_ultralight handle structure

Returns

status code

0 success
1 contactless initialization failed
2 handle is NULL
3 linked functions is NULL

Note: none

Definition at line 262 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_read_counter()

uint8_t mifare_ultralight_read_counter	(	mifare_ultralight_handle_t *	handle,
		uint8_t	addr,
		uint32_t *	cnt )

mifare_ultralight read the counter

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	addr	read counter address
[out]	*cnt	pointer to a counter buffer

Returns

status code

0 success
1 read counter failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error
6 addr > 0x2

Note: 0 <= addr <= 2

Definition at line 872 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_read_four_pages()

uint8_t mifare_ultralight_read_four_pages	(	mifare_ultralight_handle_t *	handle,
		uint8_t	start_page,
		uint8_t	data[16] )

mifare_ultralight read four pages

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	start_page	start page of read
[out]	*data	pointer to a data buffer

Returns

status code

0 success
1 read four pages failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 1288 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_read_otp()

uint8_t mifare_ultralight_read_otp	(	mifare_ultralight_handle_t *	handle,
		uint8_t	data[4] )

mifare_ultralight read otp page

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*data	pointer to a data buffer

Returns

status code

0 success
1 read otp page failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 2484 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_read_page()

uint8_t mifare_ultralight_read_page	(	mifare_ultralight_handle_t *	handle,
		uint8_t	page,
		uint8_t	data[4] )

mifare_ultralight read page

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	page	page of read
[out]	*data	pointer to a data buffer

Returns

status code

0 success
1 read page failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 1353 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_read_signature()

uint8_t mifare_ultralight_read_signature	(	mifare_ultralight_handle_t *	handle,
		uint8_t	signature[32] )

mifare_ultralight read the signature

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*signature	pointer to a signature buffer

Returns

status code

0 success
1 read signature failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 1153 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_request()

uint8_t mifare_ultralight_request	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_type_t *	type )

mifare_ultralight request

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*type	pointer to a type buffer

Returns

status code

0 success
1 request failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 type is invalid

Note: none

Definition at line 361 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_select_cl1()

uint8_t mifare_ultralight_select_cl1	(	mifare_ultralight_handle_t *	handle,
		uint8_t	id[4] )

mifare_ultralight select cl1

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*id	pointer to an id buffer

Returns

status code

0 success
1 select cl1 failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 sak error

Note: none

Definition at line 654 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_select_cl2()

uint8_t mifare_ultralight_select_cl2	(	mifare_ultralight_handle_t *	handle,
		uint8_t	id[4] )

mifare_ultralight select cl2

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*id	pointer to an id buffer

Returns

status code

0 success
1 select cl2 failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 sak error

Note: none

Definition at line 721 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_access()

uint8_t mifare_ultralight_set_access	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_access_t	access,
		mifare_ultralight_bool_t	enable )

mifare_ultralight enable or disable access

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	access	set access
[in]	enable	bool value

Returns

status code

0 success
1 set access failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2022 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_authenticate_limitation()

uint8_t mifare_ultralight_set_authenticate_limitation	(	mifare_ultralight_handle_t *	handle,
		uint8_t	limit )

mifare_ultralight set the authenticate limitation

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	limit	authenticate limitation

Returns

status code

0 success
1 set authenticate limitation failed
2 handle is NULL
3 handle is not initialized
4 limit > 7

Note: none

Definition at line 2108 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_lock()

uint8_t mifare_ultralight_set_lock	(	mifare_ultralight_handle_t *	handle,
		uint8_t	lock[5] )

mifare_ultralight set the lock

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*lock	pointer to a lock buffer

Returns

status code

0 success
1 set lock failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error

Note: byte0
bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
lock_page_7 lock_page_6 lock_page_5 lock_page_4 lock_otp block_page_15_10 block_page_9_4 bock_otp
byte1
bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
lock_page_15 lock_page_14 lock_page_13 lock_page_12 lock_page_11 lock_page_10 lock_page_9 lock_page_8
byte2
bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
lock_page_30-31 lock_page_28-29 lock_page_26-27 lock_page_24-25 lock_page_22-23 lock_page_20-21 lock_page_18-19 lock_page_16-17 byte3
bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
rfui rfui rfui rfui rfui rfui lock_page_34-35 lock_page_32-22 byte4
bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
rfui rfui rfui block_page_32_35 block_page_28_31 block_page_24_27 block_page_20_23 block_page_16_19

Definition at line 2297 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_modulation_mode()

uint8_t mifare_ultralight_set_modulation_mode	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_modulation_mode_t	mode )

mifare_ultralight set the modulation mode

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	mode	modulation mode

Returns

status code

0 success
1 set modulation mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1854 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_pack()

uint8_t mifare_ultralight_set_pack	(	mifare_ultralight_handle_t *	handle,
		uint8_t	pack[2] )

mifare_ultralight set the pack

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*pack	pointer to a pack buffer

Returns

status code

0 success
1 set pack failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error

Note: none

Definition at line 1794 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_password()

uint8_t mifare_ultralight_set_password	(	mifare_ultralight_handle_t *	handle,
		uint8_t	pwd[4] )

mifare_ultralight set the password

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*pwd	pointer to a password buffer

Returns

status code

0 success
1 set pwd failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error

Note: none

Definition at line 1732 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_protect_start_page()

uint8_t mifare_ultralight_set_protect_start_page	(	mifare_ultralight_handle_t *	handle,
		uint8_t	page )

mifare_ultralight set the start page of protection

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	page	start page

Returns

status code

0 success
1 set protect start page failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1938 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_storage()

uint8_t mifare_ultralight_set_storage	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_storage_t	storage )

set the storage

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	storage	set storage

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 210 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_set_virtual_card_type_identifier()

uint8_t mifare_ultralight_set_virtual_card_type_identifier	(	mifare_ultralight_handle_t *	handle,
		uint8_t	identifier )

mifare_ultralight set the virtual card type identifier

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	identifier	virtual card type identifier

Returns

status code

0 success
1 set virtual card type identifier failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2198 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_vcsl()

uint8_t mifare_ultralight_vcsl	(	mifare_ultralight_handle_t *	handle,
		uint8_t	installation_identifier[16],
		uint8_t	pcd_capabilities[4],
		uint8_t *	identifier )

mifare_ultralight vcsl command

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*installation_identifier	pointer to an installation identifier buffer
[in]	*pcd_capabilities	pointer to a pcd capabilities buffer
[out]	*identifier	pointer to an identifier buffer

Returns

status code

0 success
1 vcsl failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 crc error

Note: none

Definition at line 1087 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_wake_up()

uint8_t mifare_ultralight_wake_up	(	mifare_ultralight_handle_t *	handle,
		mifare_ultralight_type_t *	type )

mifare_ultralight wake up

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[out]	*type	pointer to a type buffer

Returns

status code

0 success
1 wake up failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 type is invalid

Note: none

Definition at line 424 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_write_otp()

uint8_t mifare_ultralight_write_otp	(	mifare_ultralight_handle_t *	handle,
		uint8_t	data[4] )

mifare_ultralight write otp page

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	*data	pointer to a data buffer

Returns

status code

0 success
1 write otp page failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error

Note: none

Definition at line 2548 of file driver_mifare_ultralight.c.

◆ mifare_ultralight_write_page()

uint8_t mifare_ultralight_write_page	(	mifare_ultralight_handle_t *	handle,
		uint8_t	page,
		uint8_t	data[4] )

mifare_ultralight write page

Parameters

[in]	*handle	pointer to a mifare_ultralight handle structure
[in]	page	page of write
[in]	*data	pointer to a data buffer

Returns

status code

0 success
1 write page failed
2 handle is NULL
3 handle is not initialized
4 output_len is invalid
5 ack error

Note: none

Definition at line 1596 of file driver_mifare_ultralight.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ mifare_ultralight_handle_t

◆ mifare_ultralight_info_t

◆ mifare_ultralight_version_t

Enumeration Type Documentation

◆ mifare_ultralight_access_t

◆ mifare_ultralight_bool_t

◆ mifare_ultralight_modulation_mode_t

◆ mifare_ultralight_storage_t

◆ mifare_ultralight_type_t

Function Documentation

◆ mifare_ultralight_anticollision_cl1()

◆ mifare_ultralight_anticollision_cl2()

◆ mifare_ultralight_authenticate()

◆ mifare_ultralight_check_tearing_event()

◆ mifare_ultralight_compatibility_write_page()

◆ mifare_ultralight_deinit()

◆ mifare_ultralight_fast_read_page()

◆ mifare_ultralight_get_access()

◆ mifare_ultralight_get_authenticate_limitation()

◆ mifare_ultralight_get_lock()

◆ mifare_ultralight_get_modulation_mode()

◆ mifare_ultralight_get_protect_start_page()

◆ mifare_ultralight_get_serial_number()

◆ mifare_ultralight_get_storage()

◆ mifare_ultralight_get_version()

◆ mifare_ultralight_get_virtual_card_type_identifier()

◆ mifare_ultralight_halt()

◆ mifare_ultralight_increment_counter()

◆ mifare_ultralight_info()

◆ mifare_ultralight_init()

◆ mifare_ultralight_read_counter()

◆ mifare_ultralight_read_four_pages()

◆ mifare_ultralight_read_otp()

◆ mifare_ultralight_read_page()

◆ mifare_ultralight_read_signature()

◆ mifare_ultralight_request()

◆ mifare_ultralight_select_cl1()

◆ mifare_ultralight_select_cl2()

◆ mifare_ultralight_set_access()

◆ mifare_ultralight_set_authenticate_limitation()

◆ mifare_ultralight_set_lock()

◆ mifare_ultralight_set_modulation_mode()

◆ mifare_ultralight_set_pack()

◆ mifare_ultralight_set_password()

◆ mifare_ultralight_set_protect_start_page()

◆ mifare_ultralight_set_storage()

◆ mifare_ultralight_set_virtual_card_type_identifier()

◆ mifare_ultralight_vcsl()

◆ mifare_ultralight_wake_up()

◆ mifare_ultralight_write_otp()

◆ mifare_ultralight_write_page()