Compare commits
19 Commits
Author | SHA1 | Date |
---|---|---|
Arti Zirk | 0c1783a47c | |
Arti Zirk | 0f5a58fa50 | |
Arti Zirk | 3c69228743 | |
Arti Zirk | c7fa127581 | |
Arti Zirk | e3312dd394 | |
Arti Zirk | 10dfdb5a1b | |
Arti Zirk | 185ec07134 | |
Arti Zirk | 6a271e8f48 | |
Arti Zirk | fdfeabbcaa | |
Arti Zirk | 41d61f9752 | |
Arti Zirk | 08870f2b9b | |
Arti Zirk | da84a7de9d | |
Arti Zirk | 9c135dac88 | |
Arti Zirk | 111699cae1 | |
Arti Zirk | 6cb4dd0157 | |
Silver Kits | 6751621dbe | |
Silver Kits | 11d7c2cecd | |
Silver Kits | c55ff6b1c0 | |
Silver Kits | 4dde6ad12f |
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU 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 General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
23
README.md
23
README.md
|
@ -1,4 +1,4 @@
|
|||
# I237 Hardware Programming
|
||||
# I237 Door Access program
|
||||
|
||||
This here is my repository for hardware programming course at
|
||||
Estonian IT College that is based around a
|
||||
|
@ -39,3 +39,24 @@ git checkout lab02
|
|||
```
|
||||
|
||||
Don't forget to `make clean` after each checkout!
|
||||
|
||||
# License
|
||||
|
||||
```Text
|
||||
Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
|
||||
This file is part of I237 Door Access program.
|
||||
|
||||
I237 Door Access is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
I237 Door Access 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 General Public License
|
||||
along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
```
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
# Arduino Mega RFID-RC522 wiring
|
||||
|
||||
## Introduction
|
||||
|
||||
**NB! RFID-RC522 requires only 3.3 V DC input voltage. Never connect it to 5V input.**
|
||||
|
||||
<div class=pagebreak></div>
|
||||
|
||||
## Wiring illustration
|
||||
|
||||
![arduino-mega-rfid-rc522-wiring.png](arduino-mega-rfid-rc522-wiring.png)
|
||||
|
||||
## Wiring table
|
||||
|
||||
| Signal | ATMega2560 port and pin | Arduino Mega 2560 pin | 5V to 3V converter | RFID-RC522 | Wire colour in illustration |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| Slave select | PORTB 0 | 53 | - | SDA | White |
|
||||
| SPI clock | PORTB 1 | 52 | - | SCK | Orange |
|
||||
| Master out slave in | PORTB 2 | 51 | - | MOSI | Green |
|
||||
| Master in slave out | PORTB 3 | 50 | - | MISO | Yellow |
|
||||
| RF522 reset | PORTL 0 | 49 | - | RST | Brown |
|
||||
| Ground | GND | GND | GND | GND | Black |
|
||||
| 5 V DC | - | 5V | VIN | - | Red |
|
||||
| 3,3 V DC | - | - | VOUT | 3.3 V | Red |
|
||||
|
Binary file not shown.
After Width: | Height: | Size: 140 KiB |
|
@ -0,0 +1,2 @@
|
|||
|
||||
Library homepage is at www.randomport.com
|
|
@ -0,0 +1,20 @@
|
|||
#ifndef MAT_HWDEFS_H
|
||||
#define MAT_HWDEFS_H
|
||||
|
||||
#define DDR(x) (*(&x - 1))
|
||||
#define PIN(x) (*(&x - 2))
|
||||
|
||||
#define MFRC522_SS_PORT PORTB
|
||||
#define MFRC522_SS_BIT 0
|
||||
|
||||
#define MFRC522_RST_PORT PORTL
|
||||
#define MFRC522_RST_BIT 0
|
||||
|
||||
#define SCK_DDR DDRB
|
||||
#define SCK_BIT DDB1
|
||||
#define MOSI_DDR DDRB
|
||||
#define MOSI_BIT DDB2
|
||||
#define MISO_DDR DDRB
|
||||
#define MISO_BIT DDB3
|
||||
|
||||
#endif
|
|
@ -0,0 +1,7 @@
|
|||
#ifndef MAT_HWDEFS_H
|
||||
#define MAT_HWDEFS_H
|
||||
|
||||
#define DDR(x) (*(&x - 1))
|
||||
#define PIN(x) (*(&x - 2))
|
||||
|
||||
#endif
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,253 @@
|
|||
#ifndef MFRC522_h
|
||||
#define MFRC522_h
|
||||
|
||||
#include <inttypes.h>
|
||||
|
||||
typedef uint8_t bool;
|
||||
typedef uint8_t byte;
|
||||
typedef uint16_t word;
|
||||
|
||||
// MFRC522 registers. Described in chapter 9 of the datasheet.
|
||||
// When using SPI all addresses are shifted one bit left in the "SPI address byte" (section 8.1.2.3)
|
||||
enum PCD_Register {
|
||||
// Page 0: Command and status
|
||||
// 0x00 // reserved for future use
|
||||
CommandReg = 0x01 << 1, // starts and stops command execution
|
||||
ComIEnReg = 0x02 << 1, // enable and disable interrupt request control bits
|
||||
DivIEnReg = 0x03 << 1, // enable and disable interrupt request control bits
|
||||
ComIrqReg = 0x04 << 1, // interrupt request bits
|
||||
DivIrqReg = 0x05 << 1, // interrupt request bits
|
||||
ErrorReg = 0x06 << 1, // error bits showing the error status of the last command executed
|
||||
Status1Reg = 0x07 << 1, // communication status bits
|
||||
Status2Reg = 0x08 << 1, // receiver and transmitter status bits
|
||||
FIFODataReg = 0x09 << 1, // input and output of 64 byte FIFO buffer
|
||||
FIFOLevelReg = 0x0A << 1, // number of bytes stored in the FIFO buffer
|
||||
WaterLevelReg = 0x0B << 1, // level for FIFO underflow and overflow warning
|
||||
ControlReg = 0x0C << 1, // miscellaneous control registers
|
||||
BitFramingReg = 0x0D << 1, // adjustments for bit-oriented frames
|
||||
CollReg = 0x0E << 1, // bit position of the first bit-collision detected on the RF interface
|
||||
// 0x0F // reserved for future use
|
||||
|
||||
// Page 1:Command
|
||||
// 0x10 // reserved for future use
|
||||
ModeReg = 0x11 << 1, // defines general modes for transmitting and receiving
|
||||
TxModeReg = 0x12 << 1, // defines transmission data rate and framing
|
||||
RxModeReg = 0x13 << 1, // defines reception data rate and framing
|
||||
TxControlReg = 0x14 << 1, // controls the logical behavior of the antenna driver pins TX1 and TX2
|
||||
TxASKReg = 0x15 << 1, // controls the setting of the transmission modulation
|
||||
TxSelReg = 0x16 << 1, // selects the internal sources for the antenna driver
|
||||
RxSelReg = 0x17 << 1, // selects internal receiver settings
|
||||
RxThresholdReg = 0x18 << 1, // selects thresholds for the bit decoder
|
||||
DemodReg = 0x19 << 1, // defines demodulator settings
|
||||
// 0x1A // reserved for future use
|
||||
// 0x1B // reserved for future use
|
||||
MfTxReg = 0x1C << 1, // controls some MIFARE communication transmit parameters
|
||||
MfRxReg = 0x1D << 1, // controls some MIFARE communication receive parameters
|
||||
// 0x1E // reserved for future use
|
||||
SerialSpeedReg = 0x1F << 1, // selects the speed of the serial UART interface
|
||||
|
||||
// Page 2: Configuration
|
||||
// 0x20 // reserved for future use
|
||||
CRCResultRegH = 0x21 << 1, // shows the MSB and LSB values of the CRC calculation
|
||||
CRCResultRegL = 0x22 << 1,
|
||||
// 0x23 // reserved for future use
|
||||
ModWidthReg = 0x24 << 1, // controls the ModWidth setting?
|
||||
// 0x25 // reserved for future use
|
||||
RFCfgReg = 0x26 << 1, // configures the receiver gain
|
||||
GsNReg = 0x27 << 1, // selects the conductance of the antenna driver pins TX1 and TX2 for modulation
|
||||
CWGsPReg = 0x28 << 1, // defines the conductance of the p-driver output during periods of no modulation
|
||||
ModGsPReg = 0x29 << 1, // defines the conductance of the p-driver output during periods of modulation
|
||||
TModeReg = 0x2A << 1, // defines settings for the internal timer
|
||||
TPrescalerReg = 0x2B << 1, // the lower 8 bits of the TPrescaler value. The 4 high bits are in TModeReg.
|
||||
TReloadRegH = 0x2C << 1, // defines the 16-bit timer reload value
|
||||
TReloadRegL = 0x2D << 1,
|
||||
TCounterValueRegH = 0x2E << 1, // shows the 16-bit timer value
|
||||
TCounterValueRegL = 0x2F << 1,
|
||||
|
||||
// Page 3:Test Registers
|
||||
// 0x30 // reserved for future use
|
||||
TestSel1Reg = 0x31 << 1, // general test signal configuration
|
||||
TestSel2Reg = 0x32 << 1, // general test signal configuration
|
||||
TestPinEnReg = 0x33 << 1, // enables pin output driver on pins D1 to D7
|
||||
TestPinValueReg = 0x34 << 1, // defines the values for D1 to D7 when it is used as an I/O bus
|
||||
TestBusReg = 0x35 << 1, // shows the status of the internal test bus
|
||||
AutoTestReg = 0x36 << 1, // controls the digital self test
|
||||
VersionReg = 0x37 << 1, // shows the software version
|
||||
AnalogTestReg = 0x38 << 1, // controls the pins AUX1 and AUX2
|
||||
TestDAC1Reg = 0x39 << 1, // defines the test value for TestDAC1
|
||||
TestDAC2Reg = 0x3A << 1, // defines the test value for TestDAC2
|
||||
TestADCReg = 0x3B << 1 // shows the value of ADC I and Q channels
|
||||
// 0x3C // reserved for production tests
|
||||
// 0x3D // reserved for production tests
|
||||
// 0x3E // reserved for production tests
|
||||
// 0x3F // reserved for production tests
|
||||
};
|
||||
|
||||
// MFRC522 comands. Described in chapter 10 of the datasheet.
|
||||
enum PCD_Command {
|
||||
PCD_Idle = 0x00, // no action, cancels current command execution
|
||||
PCD_Mem = 0x01, // stores 25 bytes into the internal buffer
|
||||
PCD_GenerateRandomID = 0x02, // generates a 10-byte random ID number
|
||||
PCD_CalcCRC = 0x03, // activates the CRC coprocessor or performs a self test
|
||||
PCD_Transmit = 0x04, // transmits data from the FIFO buffer
|
||||
PCD_NoCmdChange = 0x07, // no command change, can be used to modify the CommandReg register bits without affecting the command, for example, the PowerDown bit
|
||||
PCD_Receive = 0x08, // activates the receiver circuits
|
||||
PCD_Transceive = 0x0C, // transmits data from FIFO buffer to antenna and automatically activates the receiver after transmission
|
||||
PCD_MFAuthent = 0x0E, // performs the MIFARE standard authentication as a reader
|
||||
PCD_SoftReset = 0x0F // resets the MFRC522
|
||||
};
|
||||
|
||||
// Commands sent to the PICC.
|
||||
enum PICC_Command {
|
||||
// The commands used by the PCD to manage communication with several PICCs (ISO 14443-3, Type A, section 6.4)
|
||||
PICC_CMD_REQA = 0x26, // REQuest command, Type A. Invites PICCs in state IDLE to go to READY and prepare for anticollision or selection. 7 bit frame.
|
||||
PICC_CMD_WUPA = 0x52, // Wake-UP command, Type A. Invites PICCs in state IDLE and HALT to go to READY(*) and prepare for anticollision or selection. 7 bit frame.
|
||||
PICC_CMD_CT = 0x88, // Cascade Tag. Not really a command, but used during anti collision.
|
||||
PICC_CMD_SEL_CL1 = 0x93, // Anti collision/Select, Cascade Level 1
|
||||
PICC_CMD_SEL_CL2 = 0x95, // Anti collision/Select, Cascade Level 1
|
||||
PICC_CMD_SEL_CL3 = 0x97, // Anti collision/Select, Cascade Level 1
|
||||
PICC_CMD_HLTA = 0x50, // HaLT command, Type A. Instructs an ACTIVE PICC to go to state HALT.
|
||||
// The commands used for MIFARE Classic (from http://www.nxp.com/documents/data_sheet/MF1S503x.pdf, Section 9)
|
||||
// Use PCD_MFAuthent to authenticate access to a sector, then use these commands to read/write/modify the blocks on the sector.
|
||||
// The read/write commands can also be used for MIFARE Ultralight.
|
||||
PICC_CMD_MF_AUTH_KEY_A = 0x60, // Perform authentication with Key A
|
||||
PICC_CMD_MF_AUTH_KEY_B = 0x61, // Perform authentication with Key B
|
||||
PICC_CMD_MF_READ = 0x30, // Reads one 16 byte block from the authenticated sector of the PICC. Also used for MIFARE Ultralight.
|
||||
PICC_CMD_MF_WRITE = 0xA0, // Writes one 16 byte block to the authenticated sector of the PICC. Called "COMPATIBILITY WRITE" for MIFARE Ultralight.
|
||||
PICC_CMD_MF_DECREMENT = 0xC0, // Decrements the contents of a block and stores the result in the internal data register.
|
||||
PICC_CMD_MF_INCREMENT = 0xC1, // Increments the contents of a block and stores the result in the internal data register.
|
||||
PICC_CMD_MF_RESTORE = 0xC2, // Reads the contents of a block into the internal data register.
|
||||
PICC_CMD_MF_TRANSFER = 0xB0, // Writes the contents of the internal data register to a block.
|
||||
// The commands used for MIFARE Ultralight (from http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf, Section 8.6)
|
||||
// The PICC_CMD_MF_READ and PICC_CMD_MF_WRITE can also be used for MIFARE Ultralight.
|
||||
PICC_CMD_UL_WRITE = 0xA2 // Writes one 4 byte page to the PICC.
|
||||
};
|
||||
|
||||
// MIFARE constants that does not fit anywhere else
|
||||
enum MIFARE_Misc {
|
||||
MF_ACK = 0xA, // The MIFARE Classic uses a 4 bit ACK/NAK. Any other value than 0xA is NAK.
|
||||
MF_KEY_SIZE = 6 // A Mifare Crypto1 key is 6 bytes.
|
||||
};
|
||||
|
||||
// PICC types we can detect. Remember to update PICC_GetTypeName() if you add more.
|
||||
enum PICC_Type {
|
||||
PICC_TYPE_UNKNOWN = 0,
|
||||
PICC_TYPE_ISO_14443_4 = 1, // PICC compliant with ISO/IEC 14443-4
|
||||
PICC_TYPE_ISO_18092 = 2, // PICC compliant with ISO/IEC 18092 (NFC)
|
||||
PICC_TYPE_MIFARE_MINI = 3, // MIFARE Classic protocol, 320 bytes
|
||||
PICC_TYPE_MIFARE_1K = 4, // MIFARE Classic protocol, 1KB
|
||||
PICC_TYPE_MIFARE_4K = 5, // MIFARE Classic protocol, 4KB
|
||||
PICC_TYPE_MIFARE_UL = 6, // MIFARE Ultralight or Ultralight C
|
||||
PICC_TYPE_MIFARE_PLUS = 7, // MIFARE Plus
|
||||
PICC_TYPE_TNP3XXX = 8, // Only mentioned in NXP AN 10833 MIFARE Type Identification Procedure
|
||||
PICC_TYPE_NOT_COMPLETE = 255 // SAK indicates UID is not complete.
|
||||
};
|
||||
|
||||
// Return codes from the functions in this class. Remember to update GetStatusCodeName() if you add more.
|
||||
enum StatusCode {
|
||||
STATUS_OK = 1, // Success
|
||||
STATUS_ERROR = 2, // Error in communication
|
||||
STATUS_COLLISION = 3, // Collission detected
|
||||
STATUS_TIMEOUT = 4, // Timeout in communication.
|
||||
STATUS_NO_ROOM = 5, // A buffer is not big enough.
|
||||
STATUS_INTERNAL_ERROR = 6, // Internal error in the code. Should not happen ;-)
|
||||
STATUS_INVALID = 7, // Invalid argument.
|
||||
STATUS_CRC_WRONG = 8, // The CRC_A does not match
|
||||
STATUS_MIFARE_NACK = 9 // A MIFARE PICC responded with NAK.
|
||||
};
|
||||
|
||||
// A struct used for passing the UID of a PICC.
|
||||
typedef struct {
|
||||
byte size; // Number of bytes in the UID. 4, 7 or 10.
|
||||
byte uidByte[10];
|
||||
byte sak; // The SAK (Select acknowledge) byte returned from the PICC after successful selection.
|
||||
} Uid;
|
||||
|
||||
// A struct used for passing a MIFARE Crypto1 key
|
||||
typedef struct {
|
||||
byte keyByte[MF_KEY_SIZE];
|
||||
} MIFARE_Key;
|
||||
|
||||
// Member variables
|
||||
//Uid uid; // Used by PICC_ReadCardSerial().
|
||||
|
||||
// Size of the MFRC522 FIFO
|
||||
//static const byte FIFO_SIZE = 64; // The FIFO is 64 bytes.
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Functions for setting up the Arduino
|
||||
//-----------------------------------------------------------------------------------
|
||||
void MFRC522_init(void);
|
||||
void setSPIConfig(void);
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Basic interface functions for communicating with the MFRC522
|
||||
//-----------------------------------------------------------------------------------
|
||||
void PCD_WriteRegister(byte reg, byte value);
|
||||
void PCD_WriteRegister2(byte reg, byte count, byte *values);
|
||||
byte PCD_ReadRegister(byte reg);
|
||||
void PCD_ReadRegister2(byte reg, byte count, byte *values, byte rxAlign);
|
||||
void setBitMask(unsigned char reg, unsigned char mask);
|
||||
void PCD_SetRegisterBitMask(byte reg, byte mask);
|
||||
void PCD_ClearRegisterBitMask(byte reg, byte mask);
|
||||
byte PCD_CalculateCRC(byte *data, byte length, byte *result);
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Functions for manipulating the MFRC522
|
||||
//-----------------------------------------------------------------------------------
|
||||
byte PCD_Init(void);
|
||||
byte PCD_Reset(void);
|
||||
void PCD_AntennaOn(void);
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Functions for communicating with PICCs
|
||||
//-----------------------------------------------------------------------------------
|
||||
byte PCD_TransceiveData(byte *sendData, byte sendLen, byte *backData, byte *backLen, byte *validBits, byte rxAlign, bool checkCRC);
|
||||
byte PCD_CommunicateWithPICC(byte command, byte waitIRq, byte *sendData, byte sendLen, byte *backData, byte *backLen, byte *validBits, byte rxAlign, bool checkCRC);
|
||||
|
||||
byte PICC_RequestA(byte *bufferATQA, byte *bufferSize);
|
||||
byte PICC_WakeupA(byte *bufferATQA, byte *bufferSize);
|
||||
byte PICC_REQA_or_WUPA( byte command, byte *bufferATQA, byte *bufferSize);
|
||||
byte PICC_Select(Uid *uid, byte validBits);
|
||||
byte PICC_HaltA(void);
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Functions for communicating with MIFARE PICCs
|
||||
//-----------------------------------------------------------------------------------
|
||||
byte PCD_Authenticate(byte command, byte blockAddr, MIFARE_Key *key, Uid *uid);
|
||||
void PCD_StopCrypto1(void);
|
||||
byte MIFARE_Read(byte blockAddr, byte *buffer, byte *bufferSize);
|
||||
byte MIFARE_Write(byte blockAddr, byte *buffer, byte bufferSize);
|
||||
byte MIFARE_Decrement(byte blockAddr, long delta);
|
||||
byte MIFARE_Increment(byte blockAddr, long delta);
|
||||
byte MIFARE_Restore(byte blockAddr);
|
||||
byte MIFARE_Transfer(byte blockAddr);
|
||||
byte MIFARE_Ultralight_Write(byte page, byte *buffer, byte bufferSize);
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Support functions
|
||||
//-----------------------------------------------------------------------------------
|
||||
byte PCD_MIFARE_Transceive( byte *sendData, byte sendLen, bool acceptTimeout);
|
||||
const char *GetStatusCodeName(byte code);
|
||||
byte PICC_GetType(byte sak);
|
||||
const char *PICC_GetTypeName(byte type);
|
||||
void PICC_DumpToSerial(Uid *uid);
|
||||
void PICC_DumpMifareClassicToSerial(Uid *uid, byte piccType, MIFARE_Key *key);
|
||||
void PICC_DumpMifareClassicSectorToSerial(Uid *uid, MIFARE_Key *key, byte sector);
|
||||
void PICC_DumpMifareUltralightToSerial(void);
|
||||
void MIFARE_SetAccessBits(byte *accessBitBuffer, byte g0, byte g1, byte g2, byte g3);
|
||||
|
||||
//-----------------------------------------------------------------------------------
|
||||
// Convenience functions - does not add extra functionality
|
||||
//-----------------------------------------------------------------------------------
|
||||
bool PICC_IsNewCardPresent(void);
|
||||
bool PICC_ReadCardSerial(Uid* uid);
|
||||
|
||||
/*
|
||||
private:
|
||||
byte _chipSelectPin; // Arduino pin connected to MFRC522's SPI slave select input (Pin 24, NSS, active low)
|
||||
byte _resetPowerDownPin; // Arduino pin connected to MFRC522's reset and power down input (Pin 6, NRSTPD, active low)
|
||||
byte MIFARE_TwoStepHelper(byte command, byte blockAddr, long data);
|
||||
*/
|
||||
|
||||
#endif
|
|
@ -0,0 +1,98 @@
|
|||
/**
|
||||
|
||||
SPI methods are not interrupt driven - they wait until SPI operation completes.
|
||||
If you're using CMT and would prefer switching to another task while SPI operation
|
||||
is in progress, you can define SPI_USE_CMT in swdefs.h. This requires CMT_MUTEX_FUNC.
|
||||
|
||||
Also, SS (CS) is not controlled by these methods. It's the responsibility of the user.
|
||||
|
||||
@file spi.c
|
||||
@brief SPI routines
|
||||
@author Matej Kogovsek (matej@hamradio.si)
|
||||
@copyright LGPL 2.1
|
||||
@note This file is part of mat-stm32f1-lib
|
||||
*/
|
||||
|
||||
#include <inttypes.h>
|
||||
#include <avr/io.h>
|
||||
#include <avr/interrupt.h>
|
||||
|
||||
#include "spi.h"
|
||||
#include "hwdefs.h"
|
||||
|
||||
#ifdef SPI_USE_CMT
|
||||
#warning SPI using cmt
|
||||
#include "cmt.h"
|
||||
struct cmt_mutex spi_mutex;
|
||||
#endif
|
||||
|
||||
#ifndef SPCR0
|
||||
#define SPCR0 SPCR
|
||||
#define SPE0 SPE
|
||||
#define MSTR0 MSTR
|
||||
#define SPSR0 SPSR
|
||||
#define SPDR0 SPDR
|
||||
#define SPIF0 SPIF
|
||||
#endif
|
||||
|
||||
/**
|
||||
@brief Initialize SPI interface.
|
||||
|
||||
Although SPI can have different clock phase and polarity, I have never ran across anything that uses other
|
||||
than low polarity and 1st edge phase. Therefore these parameters are implied and not variable. As are 8 bit
|
||||
words and MSB first.
|
||||
@param[in] fdiv Baudrate prescaler, F_CPU dependent
|
||||
*/
|
||||
void spi_init(uint8_t fdiv)
|
||||
{
|
||||
if( SPCR0 & _BV(SPE0) ) return;
|
||||
|
||||
#ifdef SPI_USE_CMT
|
||||
spi_mutex.ac = 0;
|
||||
#endif
|
||||
|
||||
// make SCK, MOSI pins outputs and MISO an input
|
||||
SCK_DDR |= _BV(SCK_BIT);
|
||||
MOSI_DDR |= _BV(MOSI_BIT);
|
||||
MISO_DDR &= ~_BV(MISO_BIT);
|
||||
|
||||
// init SPI, MSB first, SCK low when idle
|
||||
SPCR0 = _BV(SPE0) | _BV(MSTR0) | (fdiv & 3);
|
||||
SPSR0 = (fdiv >> 2) & 1;
|
||||
}
|
||||
|
||||
/**
|
||||
@brief Send and receive byte (NSS not controlled)
|
||||
@param[in] d Byte to send
|
||||
@return byte received
|
||||
*/
|
||||
uint8_t spi_rw(uint8_t d)
|
||||
{
|
||||
#ifdef SPI_USE_CMT
|
||||
cmt_acquire(&spi_mutex);
|
||||
#endif
|
||||
|
||||
SPCR0 |= _BV(MSTR0);
|
||||
SPDR0 = d;
|
||||
while( !(SPSR0 & _BV(SPIF0)) ) {
|
||||
#ifdef SPI_USE_CMT
|
||||
cmt_delay_ticks(0);
|
||||
#endif
|
||||
}
|
||||
d = SPDR0;
|
||||
|
||||
#ifdef SPI_USE_CMT
|
||||
cmt_release(&spi_mutex);
|
||||
#endif
|
||||
|
||||
return d;
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// INTERRUPTS
|
||||
// ------------------------------------------------------------------
|
||||
|
||||
ISR(SPI_STC_vect)
|
||||
{
|
||||
//
|
||||
}
|
|
@ -0,0 +1,13 @@
|
|||
#ifndef MAT_SPI_H
|
||||
#define MAT_SPI_H
|
||||
|
||||
#include <inttypes.h>
|
||||
#include <avr/io.h>
|
||||
|
||||
// init SPI
|
||||
void spi_init(uint8_t fdiv);
|
||||
|
||||
// send a byte over SPI
|
||||
uint8_t spi_rw(uint8_t d);
|
||||
|
||||
#endif
|
|
@ -1,3 +1,21 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include <stdlib.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <avr/pgmspace.h>
|
||||
|
@ -6,6 +24,9 @@
|
|||
#include "hmi_msg.h"
|
||||
#include "print_helper.h"
|
||||
#include "cli_microrl.h"
|
||||
#include "../lib/matejx_avr_lib/mfrc522.h"
|
||||
#include "rfid.h"
|
||||
|
||||
|
||||
typedef struct cli_cmd {
|
||||
PGM_P cmd;
|
||||
|
@ -19,7 +40,11 @@ const cli_cmd_t cli_cmds[] = {
|
|||
{help_cmd, help_help, cli_print_help, 0},
|
||||
{ver_cmd, ver_help, cli_print_ver, 0},
|
||||
{ascii_cmd, ascii_help, cli_print_ascii_tbls, 0},
|
||||
{month_cmd, month_help, cli_handle_month, 1}
|
||||
{month_cmd, month_help, cli_handle_month, 1},
|
||||
{read_cmd, read_help, cli_rfid_read, 0},
|
||||
{add_cmd, add_help, cli_rfid_add, 1},
|
||||
{remove_cmd, remove_help, cli_rfid_remove, 1},
|
||||
{list_cmd, list_help, cli_rfid_list, 0}
|
||||
};
|
||||
|
||||
|
||||
|
@ -42,7 +67,6 @@ char cli_get_char(void)
|
|||
void cli_print_help(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
putc('\n', stdout);
|
||||
printf_P(PSTR(CLI_HELP_MSG "\n"));
|
||||
|
||||
for (uint8_t i = 0; i < NUM_ELEMS(cli_cmds); i++) {
|
||||
|
@ -68,7 +92,6 @@ void print_version(FILE *stream)
|
|||
void cli_print_ver(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
putc('\n', stdout);
|
||||
print_version(stdout);
|
||||
}
|
||||
|
||||
|
@ -76,7 +99,6 @@ void cli_print_ver(const char *const *argv)
|
|||
void cli_print_ascii_tbls(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
putc('\n', stdout);
|
||||
// ASCII table print
|
||||
print_ascii_tbl(stdout);
|
||||
unsigned char ascii[128];
|
||||
|
@ -89,7 +111,6 @@ void cli_print_ascii_tbls(const char *const *argv)
|
|||
|
||||
void cli_handle_month(const char *const *argv)
|
||||
{
|
||||
putc('\n', stdout);
|
||||
lcd_goto(0x40); // Got to the beginning of the next line
|
||||
char spaces_to_print = 16;
|
||||
for (int i = 0; i < 6; i++) {
|
||||
|
@ -111,16 +132,73 @@ void cli_handle_month(const char *const *argv)
|
|||
}
|
||||
|
||||
|
||||
void cli_rfid_read(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
Uid uid;
|
||||
Uid *uid_ptr = &uid;
|
||||
if (PICC_IsNewCardPresent()) {
|
||||
printf(CARD_SELECTED_MSG "\n");
|
||||
PICC_ReadCardSerial(uid_ptr);
|
||||
printf_P(PSTR(UID_SIZE_MSG "\n"), uid.size);
|
||||
printf_P(PSTR(UID_SAK_MSG"\n"), uid.sak);
|
||||
printf_P(PSTR(CARD_UID_MSG));
|
||||
for (byte i = 0; i < uid.size; i++) {
|
||||
printf("%02X", uid.uidByte[i]);
|
||||
}
|
||||
putc('\n', stdout);
|
||||
} else {
|
||||
printf_P((PSTR(CARD_NOT_SELECTED)));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void cli_rfid_add(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
Uid uid;
|
||||
card_t card;
|
||||
if (PICC_IsNewCardPresent()) {
|
||||
PICC_ReadCardSerial(&uid);
|
||||
card.uid_size = uid.size;
|
||||
memcpy(&card.uid, &uid.uidByte, uid.size);
|
||||
char *user = malloc(strlen(argv[1]) + 1);
|
||||
if(!user) {
|
||||
printf_P(PSTR(OUT_OF_MEMORY_MSG "\n"));
|
||||
return;
|
||||
}
|
||||
strcpy(user, argv[1]);
|
||||
card.user = user;
|
||||
rfid_add_card(&card);
|
||||
free(user); // card user has ben copied to the linked list
|
||||
} else {
|
||||
printf_P(PSTR(UNABLE_TO_DETECT_CARD_MSG "\n"));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void cli_rfid_remove(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
rfid_remove_card_by_user(argv[1]);
|
||||
}
|
||||
|
||||
|
||||
void cli_rfid_list(const char *const *argv)
|
||||
{
|
||||
(void) argv;
|
||||
rfid_list_cards();
|
||||
}
|
||||
|
||||
|
||||
void cli_print_cmd_error(void)
|
||||
{
|
||||
putc('\n', stdout);
|
||||
printf_P(PSTR(CLI_NO_CMD "\n"));
|
||||
}
|
||||
|
||||
|
||||
void cli_print_cmd_arg_error(void)
|
||||
{
|
||||
putc('\n', stdout);
|
||||
printf_P(PSTR(CLI_ARGS_MSG "\n"));
|
||||
}
|
||||
|
||||
|
@ -129,6 +207,7 @@ int cli_execute(int argc, const char *const *argv)
|
|||
{
|
||||
for (uint8_t i = 0; i < NUM_ELEMS(cli_cmds); i++) {
|
||||
if (!strcmp_P(argv[0], cli_cmds[i].cmd)) {
|
||||
putc('\n', stdout);
|
||||
// Test do we have correct arguments to run command
|
||||
// Function arguments count shall be defined in struct
|
||||
if ((argc - 1) != cli_cmds[i].func_argc) {
|
||||
|
@ -142,7 +221,7 @@ int cli_execute(int argc, const char *const *argv)
|
|||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
putc('\n', stdout);
|
||||
cli_print_cmd_error();
|
||||
return 0;
|
||||
}
|
||||
|
|
|
@ -1,9 +1,27 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef _CLI_MICRORL_H_
|
||||
#define _CLI_MICRORL_H_
|
||||
|
||||
#define NUM_ELEMS(x) (sizeof(x) / sizeof((x)[0]))
|
||||
#define UART_STATUS_MASK 0x00FF
|
||||
|
||||
|
||||
void cli_print(const char * str);
|
||||
char cli_get_char(void);
|
||||
void cli_print_help(const char *const *argv);
|
||||
|
@ -11,6 +29,10 @@ void print_version(FILE *stream);
|
|||
void cli_print_ver(const char *const *argv);
|
||||
void cli_print_ascii_tbls(const char *const *argv);
|
||||
void cli_handle_month(const char *const *argv);
|
||||
void cli_rfid_read(const char *const *argv);
|
||||
void cli_rfid_add(const char *const *argv);
|
||||
void cli_rfid_remove(const char *const *argv);
|
||||
void cli_rfid_list(const char *const *argv);
|
||||
void cli_print_cmd_error(void);
|
||||
void cli_print_cmd_arg_error(void);
|
||||
int cli_execute(int argc, const char *const *argv);
|
||||
|
|
|
@ -1,6 +1,24 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include <avr/pgmspace.h>
|
||||
#include "hmi_msg.h"
|
||||
|
||||
|
||||
static const char m1[] PROGMEM = "January";
|
||||
static const char m2[] PROGMEM = "February";
|
||||
static const char m3[] PROGMEM = "March";
|
||||
|
@ -18,3 +36,12 @@ const char ascii_cmd[] PROGMEM = ASCII_CMD;
|
|||
const char ascii_help[] PROGMEM = ASCII_HELP;
|
||||
const char month_cmd[] PROGMEM = MONTH_CMD;
|
||||
const char month_help[] PROGMEM = MONTH_HELP;
|
||||
const char read_cmd[] PROGMEM = READ_CMD;
|
||||
const char read_help[] PROGMEM = READ_HELP;
|
||||
const char add_cmd[] PROGMEM = ADD_CMD;
|
||||
const char add_help[] PROGMEM = ADD_HELP;
|
||||
const char remove_cmd[] PROGMEM = REMOVE_CMD;
|
||||
const char remove_help[] PROGMEM = REMOVE_HELP;
|
||||
const char list_cmd[] PROGMEM = LIST_CMD;
|
||||
const char list_help[] PROGMEM = LIST_HELP;
|
||||
const char access_denied_msg[] PROGMEM = ACCESS_DENIED_MSG;
|
||||
|
|
|
@ -1,24 +1,73 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef _HMI_MSG_H_
|
||||
#define _HMI_MSG_H_
|
||||
|
||||
|
||||
#define PROG_VERSION "Version: %S built on: %S %S"
|
||||
#define LIBC_VERSION "avr-libc version: %S avr-gcc version: %S"
|
||||
#define STUD_NAME "Arti Zirk"
|
||||
#define GET_MONTH_MSG "Enter Month name first letter >"
|
||||
#define UPTIME_MSG "Uptime: %lu s"
|
||||
|
||||
#define HELP_CMD "help"
|
||||
#define HELP_HELP "Get help"
|
||||
#define VER_CMD "version"
|
||||
#define VER_HELP "Print FW version"
|
||||
#define ASCII_CMD "ascii"
|
||||
#define ASCII_HELP "print ASCII tables"
|
||||
#define MONTH_CMD "month"
|
||||
#define MONTH_HELP "Find matching month from lookup list. Usage: month <string>"
|
||||
#define CLI_HELP_MSG "Implemented commands:"
|
||||
#define CLI_NO_CMD "Command not implemented.\n Use <help> to get help."
|
||||
#define CLI_ARGS_MSG "To few or to many arguments for this command\nUse <help>"
|
||||
|
||||
#define HELP_CMD "help"
|
||||
#define HELP_HELP "Get help"
|
||||
|
||||
#define VER_CMD "version"
|
||||
#define VER_HELP "Print FW version"
|
||||
|
||||
#define ASCII_CMD "ascii"
|
||||
#define ASCII_HELP "print ASCII tables"
|
||||
|
||||
#define MONTH_CMD "month"
|
||||
#define MONTH_HELP "Find matching month from lookup list. Usage: month <string>"
|
||||
|
||||
#define READ_CMD "read"
|
||||
#define READ_HELP "Read and print out card info that is currently in proximity of the reader"
|
||||
|
||||
#define ADD_CMD "add"
|
||||
#define ADD_HELP "Add a new card to the system. Usage: add <username>"
|
||||
|
||||
#define REMOVE_CMD "remove"
|
||||
#define REMOVE_HELP "Remove a card from the system. Usage: remove <username>"
|
||||
|
||||
#define LIST_CMD "list"
|
||||
#define LIST_HELP "List all added cards"
|
||||
|
||||
#define ACCESS_DENIED_MSG "Access denied!"
|
||||
#define NOT_ADDING_CARD_MSG1 "Found card \""
|
||||
#define NOT_ADDING_CARD_MSG2 "\", not adding it again."
|
||||
#define OUT_OF_MEMORY_MSG "Out of memory. Please remove cards."
|
||||
#define NO_CARDS_ADDED_MSG "No cards added"
|
||||
#define CARD_NOT_FOUND_MSG "Card not found"
|
||||
#define LINKED_LIST_ERROR_MSG "Invalid situation when removing card"
|
||||
#define UNABLE_TO_DETECT_CARD_MSG "Unable to detect card."
|
||||
#define CARD_SELECTED_MSG "Card selected!"
|
||||
#define UID_SIZE_MSG "UID size: 0x%02X"
|
||||
#define UID_SAK_MSG "UID sak: 0x%02X"
|
||||
#define CARD_UID_MSG "Card UID: "
|
||||
#define CARD_NOT_SELECTED "Unable to select card.\n"
|
||||
|
||||
|
||||
extern PGM_P const months[];
|
||||
|
||||
extern const char help_cmd[];
|
||||
|
@ -29,5 +78,15 @@ extern const char ascii_cmd[];
|
|||
extern const char ascii_help[];
|
||||
extern const char month_cmd[];
|
||||
extern const char month_help[];
|
||||
extern const char read_cmd[];
|
||||
extern const char read_help[];
|
||||
extern const char add_cmd[];
|
||||
extern const char add_help[];
|
||||
extern const char remove_cmd[];
|
||||
extern const char remove_help[];
|
||||
extern const char list_cmd[];
|
||||
extern const char list_help[];
|
||||
extern const char access_denied_msg[];
|
||||
|
||||
|
||||
#endif /* _HMI_MSG_H_ */
|
||||
|
|
114
src/main.c
114
src/main.c
|
@ -1,6 +1,23 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <time.h>
|
||||
#include <util/atomic.h>
|
||||
#include <avr/io.h>
|
||||
#include <avr/interrupt.h>
|
||||
#include <avr/pgmspace.h>
|
||||
|
@ -12,19 +29,29 @@
|
|||
#include "../lib/hd44780_111/hd44780.h"
|
||||
#include "../lib/helius_microrl/microrl.h"
|
||||
#include "cli_microrl.h"
|
||||
#include "../lib/matejx_avr_lib/mfrc522.h"
|
||||
#include "rfid.h"
|
||||
|
||||
|
||||
// uart0 and uart3 will run at this speed
|
||||
#define BAUDRATE 9600
|
||||
|
||||
// For configuring arduino mega pin 25
|
||||
#define LED_INIT DDRA |= _BV(DDA3);
|
||||
#define LED_INIT DDRA |= _BV(DDA3)
|
||||
#define DOOR_INIT DDRA |= _BV(DDA1)
|
||||
#define LED_TOGGLE PORTA ^= _BV(PORTA3)
|
||||
#define DOOR_OPEN PORTA |= _BV(PORTA1)
|
||||
#define DOOR_CLOSE PORTA &= ~_BV(PORTA1)
|
||||
#define UART_STATUS_MASK 0x00FF
|
||||
|
||||
// Current system time
|
||||
volatile uint32_t system_time;
|
||||
|
||||
// Create microrl object and pointer on it
|
||||
static microrl_t rl;
|
||||
static microrl_t *prl = &rl;
|
||||
|
||||
|
||||
static inline void init_system_clock(void)
|
||||
{
|
||||
TCCR5A = 0; // Clear control register A
|
||||
|
@ -35,12 +62,32 @@ static inline void init_system_clock(void)
|
|||
}
|
||||
|
||||
|
||||
static inline uint32_t time(void)
|
||||
{
|
||||
uint32_t cur_time;
|
||||
ATOMIC_BLOCK(ATOMIC_FORCEON) {
|
||||
cur_time = system_time;
|
||||
}
|
||||
return cur_time;
|
||||
}
|
||||
|
||||
|
||||
static inline void init_rfid_reader(void)
|
||||
{
|
||||
MFRC522_init();
|
||||
PCD_Init();
|
||||
}
|
||||
|
||||
|
||||
static inline void init_hw (void)
|
||||
{
|
||||
// IO init
|
||||
/// Set arduino pin 25 as output
|
||||
// Set arduino pin 25 as output
|
||||
LED_INIT;
|
||||
|
||||
// Set Arduino pin 23 as output
|
||||
DOOR_INIT;
|
||||
|
||||
// System clock
|
||||
init_system_clock();
|
||||
|
||||
|
@ -54,10 +101,14 @@ static inline void init_hw (void)
|
|||
lcd_init();
|
||||
lcd_clrscr();
|
||||
|
||||
// Init RFID-RC522
|
||||
init_rfid_reader();
|
||||
|
||||
// Enable interupts
|
||||
sei();
|
||||
}
|
||||
|
||||
|
||||
static inline void start_ui (void)
|
||||
{
|
||||
print_version(stderr);
|
||||
|
@ -68,6 +119,7 @@ static inline void start_ui (void)
|
|||
lcd_puts_P(PSTR(STUD_NAME));
|
||||
}
|
||||
|
||||
|
||||
static inline void start_cli(void)
|
||||
{
|
||||
// Call init with ptr to microrl instance and print callback
|
||||
|
@ -76,10 +128,11 @@ static inline void start_cli(void)
|
|||
microrl_set_execute_callback (prl, cli_execute);
|
||||
}
|
||||
|
||||
|
||||
static inline void heartbeat (void)
|
||||
{
|
||||
static time_t time_prev;
|
||||
time_t time_cur = time(NULL);
|
||||
static uint32_t time_prev;
|
||||
uint32_t time_cur = time();
|
||||
if (time_cur <= time_prev) {
|
||||
return;
|
||||
}
|
||||
|
@ -89,6 +142,54 @@ static inline void heartbeat (void)
|
|||
}
|
||||
|
||||
|
||||
static inline void handle_door()
|
||||
{
|
||||
Uid uid;
|
||||
card_t card;
|
||||
uint32_t time_cur = time();
|
||||
static uint32_t message_start;
|
||||
static uint32_t door_open_start;
|
||||
if (PICC_IsNewCardPresent()) {
|
||||
PICC_ReadCardSerial(&uid);
|
||||
card.uid_size = uid.size;
|
||||
memcpy(&card.uid, &uid.uidByte, uid.size);
|
||||
card.user = NULL;
|
||||
card_t *found_card = rfid_find_card(&card);
|
||||
if (found_card) {
|
||||
lcd_goto(0x40);
|
||||
lcd_puts(found_card->user);
|
||||
for (int8_t i = 16 - strlen(found_card->user); i > -1; i--) {
|
||||
lcd_putc(' ');
|
||||
}
|
||||
DOOR_OPEN;
|
||||
} else {
|
||||
DOOR_CLOSE;
|
||||
lcd_goto(0x40);
|
||||
lcd_puts_P(access_denied_msg);
|
||||
for (int8_t i = 16 - strlen_P(access_denied_msg); i > -1; i--) {
|
||||
lcd_putc(' ');
|
||||
}
|
||||
}
|
||||
door_open_start = time_cur;
|
||||
message_start = time_cur;
|
||||
}
|
||||
|
||||
if ((message_start + 5) < time_cur) {
|
||||
// clean the screen once again in 10 secconds so that cli command
|
||||
// `month` could show found months for some time
|
||||
message_start = time_cur + 5;
|
||||
lcd_goto(0x40);
|
||||
for (int8_t i = 16; i > -1; i--) {
|
||||
lcd_putc(' ');
|
||||
}
|
||||
}
|
||||
|
||||
if ((door_open_start + 2) < time_cur) {
|
||||
DOOR_CLOSE;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
int main (void)
|
||||
{
|
||||
init_hw();
|
||||
|
@ -99,6 +200,7 @@ int main (void)
|
|||
heartbeat();
|
||||
// CLI commands are handled in cli_execute()
|
||||
microrl_insert_char (prl, cli_get_char());
|
||||
handle_door();
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -106,5 +208,5 @@ int main (void)
|
|||
// System clock
|
||||
ISR(TIMER5_COMPA_vect)
|
||||
{
|
||||
system_tick();
|
||||
system_time++;
|
||||
}
|
||||
|
|
|
@ -1,7 +1,25 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include <stdio.h>
|
||||
#include <avr/pgmspace.h>
|
||||
#include "print_helper.h"
|
||||
|
||||
|
||||
int print_ascii_tbl (FILE *stream)
|
||||
{
|
||||
for (char c = ' '; c <= '~'; c++) {
|
||||
|
|
|
@ -1,3 +1,20 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef _PRINT_HELPER_H_
|
||||
#define _PRINT_HELPER_H_
|
||||
|
||||
|
|
|
@ -0,0 +1,165 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include <stdlib.h>
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <avr/pgmspace.h>
|
||||
#include "rfid.h"
|
||||
#include "hmi_msg.h"
|
||||
|
||||
|
||||
card_t *head = NULL;
|
||||
|
||||
|
||||
void rfid_print_card(const card_t *card)
|
||||
{
|
||||
for (uint8_t i = 0; i < card->uid_size; i++) {
|
||||
printf("%02X", card->uid[i]);
|
||||
}
|
||||
printf(": %s", card->user);
|
||||
}
|
||||
|
||||
|
||||
card_t* rfid_find_card(const card_t *card)
|
||||
{
|
||||
if (head != NULL) {
|
||||
card_t *current;
|
||||
current = head;
|
||||
while (current != NULL) {
|
||||
if ((current->uid_size != card->uid_size) ||
|
||||
!memcmp(current->uid, card->uid, current->uid_size) ||
|
||||
((card->user != NULL) && !strcmp(current->user, card->user))) {
|
||||
|
||||
return current;
|
||||
}
|
||||
current = current->next;
|
||||
}
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
||||
void rfid_add_card(const card_t *card)
|
||||
{
|
||||
card_t *found_card = rfid_find_card(card);
|
||||
if (found_card) {
|
||||
printf_P(PSTR(NOT_ADDING_CARD_MSG1));
|
||||
rfid_print_card(found_card);
|
||||
printf_P(PSTR(NOT_ADDING_CARD_MSG2 "\n"));
|
||||
return;
|
||||
}
|
||||
|
||||
// Card doesn't exist, add it
|
||||
card_t *new_card;
|
||||
char *new_card_user;
|
||||
new_card = malloc(sizeof(card_t));
|
||||
new_card_user = malloc(strlen(card->user) + 1);
|
||||
if (!new_card || !new_card_user) {
|
||||
printf_P(PSTR(OUT_OF_MEMORY_MSG "\n"));
|
||||
free(new_card_user);
|
||||
free(new_card);
|
||||
return;
|
||||
}
|
||||
|
||||
// Copy card data
|
||||
new_card->uid_size = card->uid_size;
|
||||
memcpy(new_card->uid, card->uid, card->uid_size);
|
||||
strcpy(new_card_user, card->user);
|
||||
new_card->user = new_card_user;
|
||||
new_card->next = NULL;
|
||||
|
||||
// Update card list
|
||||
if (head == NULL) {
|
||||
head = new_card;
|
||||
} else {
|
||||
card_t *current;
|
||||
current = head;
|
||||
while (current->next != NULL) {
|
||||
current = current->next;
|
||||
}
|
||||
current->next = new_card;
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
void rfid_list_cards(void)
|
||||
{
|
||||
if (head == NULL) {
|
||||
printf_P(PSTR(NO_CARDS_ADDED_MSG "\n"));
|
||||
} else {
|
||||
card_t *current;
|
||||
current = head;
|
||||
while (current->next != NULL) {
|
||||
rfid_print_card(current);
|
||||
putc('\n', stdout);
|
||||
current = current->next;
|
||||
}
|
||||
rfid_print_card(current);
|
||||
putc('\n', stdout);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void rfid_remove_card_by_user(const char *user)
|
||||
{
|
||||
card_t *curr;
|
||||
card_t *prev;
|
||||
curr = head;
|
||||
prev = NULL;
|
||||
if (head == NULL) {
|
||||
printf_P(PSTR(NO_CARDS_ADDED_MSG "\n"));
|
||||
return;
|
||||
} else {
|
||||
while (curr->next != NULL) {
|
||||
if (strcmp(curr->user, user) == 0) {
|
||||
break;
|
||||
}
|
||||
prev = curr;
|
||||
curr = curr->next;
|
||||
}
|
||||
}
|
||||
if (strcmp(curr->user, user) == 0) {
|
||||
if (prev == NULL && curr->next == NULL) {
|
||||
// this is the single card in the list
|
||||
free(curr->user);
|
||||
free(curr);
|
||||
head = NULL;
|
||||
} else if (prev == NULL && curr->next != NULL) {
|
||||
// this is the first card in the list, with more after it
|
||||
head = curr->next;
|
||||
free(curr->user);
|
||||
free(curr);
|
||||
} else if (prev != NULL && curr->next != NULL) {
|
||||
// this card is somewhere in the middle of the list
|
||||
prev->next = curr->next;
|
||||
free(curr->user);
|
||||
free(curr);
|
||||
} else if (prev != NULL && curr->next == NULL) {
|
||||
// this is the last card in the list
|
||||
prev->next = NULL;
|
||||
free(curr->user);
|
||||
free(curr);
|
||||
} else {
|
||||
printf_P(PSTR(LINKED_LIST_ERROR_MSG "\n"));
|
||||
}
|
||||
} else {
|
||||
printf_P(PSTR(CARD_NOT_FOUND_MSG));
|
||||
}
|
||||
}
|
|
@ -0,0 +1,34 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef _RFID_H_
|
||||
#define _RFID_H_
|
||||
|
||||
typedef struct card {
|
||||
uint8_t uid_size;
|
||||
uint8_t uid[10];
|
||||
char *user;
|
||||
struct card *next;
|
||||
} card_t;
|
||||
|
||||
extern card_t *head;
|
||||
extern card_t* rfid_find_card(const card_t *card);
|
||||
extern void rfid_add_card(const card_t *card);
|
||||
extern void rfid_list_cards(void);
|
||||
extern void rfid_remove_card_by_user(const char *user);
|
||||
|
||||
#endif /* _RFID_H_ */
|
|
@ -1,9 +1,28 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include <avr/io.h>
|
||||
#include <stdio.h>
|
||||
#include "../lib/andygock_avr-uart/uart.h"
|
||||
|
||||
|
||||
#define UART_STATUS_MASK 0x00FF
|
||||
|
||||
|
||||
int uart0_putc_wrap(char c, FILE *stream)
|
||||
{
|
||||
(void) stream;
|
||||
|
@ -16,6 +35,7 @@ int uart0_putc_wrap(char c, FILE *stream)
|
|||
return 0;
|
||||
}
|
||||
|
||||
|
||||
int uart0_getc_wrap(FILE *stream)
|
||||
{
|
||||
(void) stream;
|
||||
|
@ -26,6 +46,7 @@ int uart0_getc_wrap(FILE *stream)
|
|||
return uart0_getc() & UART_STATUS_MASK;
|
||||
}
|
||||
|
||||
|
||||
int uart3_putc_wrap(char c, FILE *stream)
|
||||
{
|
||||
(void) stream;
|
||||
|
|
|
@ -1,3 +1,20 @@
|
|||
/* Copyright (C) 2016 Arti Zirk <arti.zirk@gmail.com>
|
||||
*
|
||||
* This file is part of I237 Door Access program.
|
||||
*
|
||||
* I237 Door Access is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* I237 Door Access 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 General Public License
|
||||
* along with I237 Door Access. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef _UART_WRAP_H_
|
||||
#define _UART_WRAP_H_
|
||||
|
||||
|
|
Loading…
Reference in New Issue