libfreefare/libfreefare/ntag21x.3
2017-06-27 10:50:50 +02:00

132 lines
4 KiB
Groff

.\" Copyright (C) 2010, 2017 Romain Tartiere, Martin Dagarin (SloCompTech)
.\"
.\" This program is free software: you can redistribute it and/or modify it
.\" under the terms of the GNU Lesser General Public License as published by the
.\" Free Software Foundation, either version 3 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
.\" more details.
.\"
.\" You should have received a copy of the GNU Lesser General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>
.\"
.Dd February 26, 2017
.Dt NTAG_21x 3
.Os
.\" _ _
.\" | \ | | __ _ _ __ ___ ___
.\" | \| |/ _` | '_ ` _ \ / _ \
.\" | |\ | (_| | | | | | | __/
.\" |_| \_|\__,_|_| |_| |_|\___|
.\"
.Sh NAME
.Nm ntag21x_connect ,
.Nm ntag21x_disconnect ,
.Nm ntag21x_read ,
.Nm ntag21x_read4 ,
.Nm ntag21x_fast_read ,
.Nm ntag21x_fast_read4 ,
.Nm ntag21x_write ,
.Nm ntag21x_compatibility_write ,
.Nd NTAG 213/215/216 Manipulation Functions
.\" _ _ _
.\" | | (_) |__ _ __ __ _ _ __ _ _
.\" | | | | '_ \| '__/ _` | '__| | | |
.\" | |___| | |_) | | | (_| | | | |_| |
.\" |_____|_|_.__/|_| \__,_|_| \__, |
.\" |___/
.Sh LIBRARY
Mifare card manipulation library (libfreefare, \-lfreefare)
.\" ____ _
.\" / ___| _ _ _ __ ___ _ __ ___(_)___
.\" \___ \| | | | '_ \ / _ \| '_ \/ __| / __|
.\" ___) | |_| | | | | (_) | |_) \__ \ \__ \
.\" |____/ \__, |_| |_|\___/| .__/|___/_|___/
.\" |___/ |_|
.Sh SYNOPSIS
.In freefare.h
.Ft int
.Fn ntag21x_connect "FreefareTag tag"
.Ft int
.Fn ntag21x_disconnect "FreefareTag tag"
.Ft int
.Fn ntag21x_read "FreefareTag tag" "uint8_t page" "uint8_t *data"
.Ft int
.Fn ntag21x_read4 "FreefareTag tag" "uint8_t page" "uint8_t *data"
.Ft int
.Fn ntag21x_fast_read "FreefareTag tag" "uint8_t start_page" "uint8_t end_page" "uint8_t *data"
.Ft int
.Fn ntag21x_fast_read4 "FreefareTag tag" "uint8_t page" "uint8_t *data"
.Ft int
.Fn ntag21x_write "FreefareTag tag" "uint8_t page" "uint8_t data[4]"
.Ft int
.Fn ntag21x_compatibility_write "FreefareTag tag" "uint8_t page" "uint8_t data[4]"
.\" ____ _ _ _
.\" | _ \ ___ ___ ___ _ __(_)_ __ | |_(_) ___ _ __
.\" | | | |/ _ \/ __|/ __| '__| | '_ \| __| |/ _ \| '_ \
.\" | |_| | __/\__ \ (__| | | | |_) | |_| | (_) | | | |
.\" |____/ \___||___/\___|_| |_| .__/ \__|_|\___/|_| |_|
.\" |_|
.Sh DESCRIPTION
The
.Fn ntag21x_*
functions allows management of NTAG213/215/216 tags.
.Pp
The
.Fn ntag21x_connect
function activates the specified
.Vt tag .
.Pp
A
.Vt page
of
.Vt data
can be read from a
.Vt tag
using
.Fn ntag21x_read ,
.Fn ntag21x_read4,
.Fn ntag21x_fast_read,
.Fn ntag21x_fast_read4,
and written
using
.Fn ntag21_write ,
.Fn ntag21x_compatibility_write .
.Pp
After usage, a
.Vt tag
is deactivated using
.Fn ntag21x_disconnect .
.\" ____ _ _
.\" | _ \ ___| |_ _ _ _ __ _ __ __ ____ _| |_ _ ___ ___
.\" | |_) / _ \ __| | | | '__| '_ \ \ \ / / _` | | | | |/ _ \/ __|
.\" | _ < __/ |_| |_| | | | | | | \ V / (_| | | |_| | __/\__ \
.\" |_| \_\___|\__|\__,_|_| |_| |_| \_/ \__,_|_|\__,_|\___||___/
.\"
.Sh RETURN VALUES
Unless stated otherwise, all functions return a value greater than or equal to
.Va 0
on success or
.Va -1
on failure.
.\" ____ _
.\" / ___| ___ ___ __ _| |___ ___
.\" \___ \ / _ \/ _ \ / _` | / __|/ _ \
.\" ___) | __/ __/ | (_| | \__ \ (_) |
.\" |____/ \___|\___| \__,_|_|___/\___/
.\"
.Sh SEE ALSO
.Xr freefare 3
.\" _ _ _
.\" / \ _ _| |_| |__ ___ _ __ ___
.\" / _ \| | | | __| '_ \ / _ \| '__/ __|
.\" / ___ \ |_| | |_| | | | (_) | | \__ \
.\" /_/ \_\__,_|\__|_| |_|\___/|_| |___/
.\"
.Sh AUTHORS
.An Romain Tartiere Aq romain@blogreen.org
.An Romuald Conty Aq romuald@libnfc.org
.An Martin Dagarin Aq SloCompTech@gmail.com