aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomasz Kramkowski <tk@the-tk.com>2016-11-23 21:23:09 +0000
committerTomasz Kramkowski <tk@the-tk.com>2016-11-23 21:23:30 +0000
commit464847c5b25588448e550017a6d91447c076b944 (patch)
treecb48ce0793232ab0046ac1ad18ad50862ed77f5c
downloadhktool-464847c5b25588448e550017a6d91447c076b944.tar.gz
hktool-464847c5b25588448e550017a6d91447c076b944.tar.xz
hktool-464847c5b25588448e550017a6d91447c076b944.zip
init commit
-rw-r--r--.gitignore7
-rw-r--r--LICENSE674
-rw-r--r--Makefile43
-rw-r--r--README.md30
-rw-r--r--data/AT90USB12861
-rw-r--r--data/AT90USB1621
-rw-r--r--data/AT90USB6461
-rw-r--r--data/ATMEGA32U41
-rw-r--r--data/MK20DX1281
-rw-r--r--data/MK20DX2561
-rw-r--r--data/MKL26Z641
-rw-r--r--halfkay.c164
-rw-r--r--halfkay.h33
-rw-r--r--hktool.1161
-rw-r--r--hktool.c124
-rw-r--r--log.c99
-rw-r--r--log.h42
-rw-r--r--params.c330
-rw-r--r--params.h27
-rw-r--r--util.c132
-rw-r--r--util.h34
21 files changed, 1907 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..538659a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+*.o
+hktool
+
+*.d
+
+tags
+TAGS
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/LICENSE
@@ -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>.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..f1abf21
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,43 @@
+VERSION != git describe --tags 2>/dev/null || echo "0.1"
+PROG := hktool
+MANPAGE := hktool.1
+
+WARNINGS := -Wall -Wcast-align -Wcast-qual -Wextra -Wpedantic -Wformat=2 \
+ -Winit-self -Wmissing-prototypes -Wpointer-arith -Wshadow \
+ -Wstrict-prototypes -Wsuggest-attribute=format \
+ -Wsuggest-attribute=noreturn
+
+PKG_CONFIG ?= pkg-config
+
+LIBS := libusb-1.0
+CPPFLAGS = -DVERSION=\"$(VERSION)\" -D_POSIX_C_SOURCE=200809L
+CFLAGS = -std=c11 -O2 -flto $(WARNINGS) -MMD -MP $(shell $(PKG_CONFIG) --cflags $(LIBS))
+LDFLAGS = -Wl,--as-needed -O2 -flto
+LDLIBS = $(shell $(PKG_CONFIG) --libs $(LIBS))
+
+OBJ := hktool.o halfkay.o log.o params.o util.o
+
+PREFIX ?= /usr/local
+
+bindir = /bin
+datarootdir = /share
+mandir = /man
+
+all: $(PROG)
+$(PROG): $(OBJ)
+
+debug: all
+debug: CFLAGS += -ggdb -Og -Werror
+debug: LDFLAGS += -ggdb -Og
+
+install: $(PROG) $(MANPAGE)
+ install -Dm755 -s $(PROG) $(DESTDIR)$(PREFIX)$(bindir)
+ install -Dm644 ./data/* -t $(DESTDIR)$(PREFIX)$(datarootdir)/$(PROG)/
+ install -Dm644 $(MANPAGE) $(DESTDIR)$(PREFIX)$(mandir)/man1/
+
+clean:
+ $(RM) $(OBJ) $(OBJ:.o=.d) $(PROG)
+
+-include $(OBJ:.o=.d)
+
+.PHONY: all debug install clean
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3bdcbcc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+hktool
+======
+
+Simple HalfKay loader / rebooter.
+
+Reasoning
+---------
+
+hktool was created as a basic replacement for teensy-loader-cli.
+teensy-loader-cli was a fundamentally messy and confusing implementation of the
+HalfKay protocol used by the boot loader chips / code used in Teensy devices.
+
+This reimplementation is a libusb only rewrite of the old loader with a much
+simplified command line interface and a design which aims for easy end user
+extensibility to support future Teensy devices. This means that if PJRC release
+a new teensy device based on a new chip, it should be possible (unless the
+HalfKay protocol changes considerably) to simply add a new definition for the
+device in the form of a simple plain text file.
+
+Dependencies
+------------
+
+ - (make) GNU Make (or compatible)
+ - libusb 1.0 (or compatible)
+
+Compilation and Installation
+----------------------------
+
+Notes on Implementation
+-----------------------
diff --git a/data/AT90USB1286 b/data/AT90USB1286
new file mode 100644
index 0000000..c74528c
--- /dev/null
+++ b/data/AT90USB1286
@@ -0,0 +1 @@
+0x1fc00 256 2 8 Teensy++ 2.0
diff --git a/data/AT90USB162 b/data/AT90USB162
new file mode 100644
index 0000000..f44a27a
--- /dev/null
+++ b/data/AT90USB162
@@ -0,0 +1 @@
+0x3e00 128 2 0 Teensy 1.0
diff --git a/data/AT90USB646 b/data/AT90USB646
new file mode 100644
index 0000000..9a579d6
--- /dev/null
+++ b/data/AT90USB646
@@ -0,0 +1 @@
+0xfc00 256 2 8 Teensy++ 1.0
diff --git a/data/ATMEGA32U4 b/data/ATMEGA32U4
new file mode 100644
index 0000000..3ee4081
--- /dev/null
+++ b/data/ATMEGA32U4
@@ -0,0 +1 @@
+0x7e00 128 2 0 Teensy 2.0
diff --git a/data/MK20DX128 b/data/MK20DX128
new file mode 100644
index 0000000..dc965b7
--- /dev/null
+++ b/data/MK20DX128
@@ -0,0 +1 @@
+0x20000 1024 64 0 Teensy 3.0
diff --git a/data/MK20DX256 b/data/MK20DX256
new file mode 100644
index 0000000..59db8fe
--- /dev/null
+++ b/data/MK20DX256
@@ -0,0 +1 @@
+0x40000 1024 64 0 Teensy 3.1
diff --git a/data/MKL26Z64 b/data/MKL26Z64
new file mode 100644
index 0000000..adce771
--- /dev/null
+++ b/data/MKL26Z64
@@ -0,0 +1 @@
+0xf800 512 64 0 Teensy LC
diff --git a/halfkay.c b/halfkay.c
new file mode 100644
index 0000000..c2a92a9
--- /dev/null
+++ b/halfkay.c
@@ -0,0 +1,164 @@
+/* HalfKay implementation
+ * Based on Teensy Loader (cli) (http://www.pjrc.com/teensy/loader_cli.html)
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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/>.
+ */
+
+#define _DEFAULT_SOURCE
+#include <assert.h>
+#include <errno.h>
+#include <libusb-1.0/libusb.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "halfkay.h"
+#include "log.h"
+
+enum {
+ HK_USB_VID = 0x16c0,
+ HK_USB_PID = 0x0478,
+ HK_USB_REQTYP = (LIBUSB_ENDPOINT_OUT \
+ | LIBUSB_REQUEST_TYPE_CLASS \
+ | LIBUSB_RECIPIENT_INTERFACE),
+ HK_USB_REQ = LIBUSB_REQUEST_SET_CONFIGURATION,
+ HK_USB_VAL = 0x200,
+};
+
+libusb_device_handle *hk_usb_hnd;
+
+static inline void libusb_err(const char *action, int code)
+{
+ error(0, "libusb %s failed: %s", action, libusb_strerror(code));
+}
+
+static void usbopen(void)
+{
+ int rc;
+
+ rc = libusb_init(NULL);
+ if (libusb_init(NULL) != LIBUSB_SUCCESS)
+ libusb_err("init", rc);
+
+ hk_usb_hnd = libusb_open_device_with_vid_pid(NULL, HK_USB_VID, HK_USB_PID);
+ if (!hk_usb_hnd)
+ error(0, "HalfKay device not found");
+
+ libusb_set_auto_detach_kernel_driver(hk_usb_hnd, 1);
+ rc = libusb_claim_interface(hk_usb_hnd, 0);
+ if (rc < 0)
+ libusb_err("claim", rc);
+}
+
+static void usbclose(void)
+{
+ libusb_release_interface(hk_usb_hnd, 0);
+ libusb_close(hk_usb_hnd);
+ libusb_exit(NULL);
+}
+
+static void usbsendcmd(void *data, size_t size, bool firstxfer)
+{
+ unsigned int timeout = firstxfer ? 3000 : 2000;
+ int rc;
+
+ rc = libusb_control_transfer(hk_usb_hnd, HK_USB_REQTYP, HK_USB_REQ,
+ HK_USB_VAL, 0, data, size, timeout);
+
+ if (rc < 0)
+ libusb_err("transfer", rc);
+
+ /* TODO: Replace this with the correct way to handle a halt... ffs idiot */
+ usleep(10000); /* HalfKay says no if you write too fast */
+}
+
+static void fmtcmd(void *_dest, const struct flashparams *fp, size_t addr)
+{
+ unsigned char *dest = _dest;
+
+ addr >>= fp->addrshft;
+ for (size_t i = 0; i < fp->cmdsz; i++)
+ dest[i] = (addr >> (i * CHAR_BIT)) & 0xFF;
+}
+
+int flash(const struct flashparams *fp, const char *file)
+{
+ FILE *f;
+ unsigned char *cmd;
+ size_t tsize;
+
+ assert(file);
+
+ /* TODO: move checks to parser */
+ /*if (!fp->blksz || !(fp->blksz & fp->blksz - 1))*/
+ /*error(0, "Block size is not a power of 2");*/
+ /*if (fp->memsz % fp->blksz)*/
+ /*error(0, "Memory size is not divisible by block size");*/
+
+ tsize = fp->blksz + fp->cmdsz;
+
+ f = fopen(file, "rb");
+ if (!f)
+ error(errno, EMSG_OPEN, file);
+
+ /* TODO: precalc and check ovf */
+ cmd = malloc(tsize);
+ if (!cmd)
+ error(errno, EMSG_ALLOC);
+
+ usbopen();
+
+ for (size_t blkaddr = 0; blkaddr < fp->memsz; blkaddr += fp->blksz) {
+ size_t count;
+
+ fmtcmd(cmd, fp, blkaddr);
+ count = fread(cmd + fp->cmdsz, 1, fp->blksz, f);
+ if (count == 0)
+ break;
+ if (count < fp->blksz) {
+ memset(cmd + fp->cmdsz + count, 0, fp->blksz - count);
+ }
+
+ usbsendcmd(cmd, tsize, blkaddr == 0);
+ }
+
+ if (!feof(f))
+ fprintf(stderr, "Device ran out of space during writing!");
+
+ usbclose();
+
+ free(cmd);
+ fclose(f);
+
+ return 0;
+}
+
+int reboot(const struct flashparams *fp)
+{
+ size_t tsize = fp->blksz + fp->cmdsz;
+ unsigned char *cmd = malloc(tsize);
+
+ usbopen();
+
+ fmtcmd(cmd, fp, SIZE_MAX);
+ usbsendcmd(cmd, tsize, true);
+
+ usbclose();
+
+ return 0;
+}
diff --git a/halfkay.h b/halfkay.h
new file mode 100644
index 0000000..baa34af
--- /dev/null
+++ b/halfkay.h
@@ -0,0 +1,33 @@
+/* HalfKay implementation
+ * Based on Teensy Loader (cli) (http://www.pjrc.com/teensy/loader_cli.html)
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#ifndef HALFKAY_H
+#define HALFKAY_H
+
+struct flashparams {
+ size_t memsz;
+ size_t blksz;
+ size_t cmdsz;
+ size_t addrshft;
+};
+
+int flash(const struct flashparams *fp, const char *file);
+int reboot(const struct flashparams *fp);
+
+#endif /* HALFKAY_H */
diff --git a/hktool.1 b/hktool.1
new file mode 100644
index 0000000..12b8f81
--- /dev/null
+++ b/hktool.1
@@ -0,0 +1,161 @@
+'\" t
+.TH "HKTOOL" "1" "2016-05-22" "hktool 0.1" "hktool Manual"
+
+.SH "NAME"
+hktool \- a simple HalfKay protocol flashing tool
+
+.SH "SYNOPSIS"
+.BR hktool\ [ -hlvr ]
+.RB [ -f
+.IR file ]
+.RB [ -- ]
+.I mcu
+
+.SH "DESCRIPTION"
+hktool is a HalfKay protocol flashing tool. hktool is currently only able to
+flash to one connected device at a time, if multiple devices are connected,
+only one will be flashed. hktool is designed to flash raw binary data and NOT
+intel hex files. Converting from intel hex files to binary data can be easily
+done with
+.BR objcopy (1).
+The main advantages of hktool over the teensy loader command line tool is that
+devices are not hard coded, additionally, the command line interface is
+noticeably simpler.
+
+.SH "OPTIONS"
+.BI \-f\ file
+.RS
+Flash specified binary file to the device. Specifying '-' as the file name
+causes hktool to read input from stdin.
+.RE
+
+.B \-h
+.RS
+Show help.
+.RE
+
+.B \-l
+.RS
+Show a list of supported devices.
+.RE
+
+.B \-v
+.RS
+Show version and license information.
+.RE
+
+.B \-r
+.RS
+Reboot device (if specified with -f, will happen after flashing).
+.RE
+
+.SH "NOTES"
+.SS Device parameter files
+The list of devices that hktool can flash can be configured, either by creating
+device parameter file and passing it to hktool as a relative path in the mcu
+argument, or by adding more device parameter files to the hktool data
+directories.
+
+hktool searches for data in the hktool subdirectory of any directories found in
+the XDG_DATA_DIRS environment variable (which should be a colon delimited list
+of directories), if this variable is not set or empty then hktool proceeds as
+if XDG_DATA_DIRS was set to "/usr/local/share:/usr/local". Device parameter
+files should bear the name of the device and should be located directly in the
+hktool subdirectory of the aforementioned locations. If two or more files are
+found to have the same name, the file which was found first will be used.
+Directories are processed in the order that they appear in the XDG_DATA_DIRS
+environment variable.
+
+The format of the device parameter files is very simple. These files should
+consist of only one line detailing the flashing parameters and optionally the
+canonical board name. The files are formatted as such:
+
+.RS 4
+.I memory_size block_size command_size address_shift
+.RI [ board_name ]
+.RE
+
+For example, to create a file for the Teensy 3.1 place a file with the name
+"MK20DX256" in one of the aforementioned locations and include the contents:
+
+.RS 4
+0x40000 1024 64 0 Teensy 3.1
+.RE
+
+This would describe a Teensy 3.1 which hosts MK20DX256 MCU with a memory size
+of 262144 bytes, memory block size of 1024 bytes, HalfKay transfer prefix size
+of 64 bytes with no shift applied to the write address. (Also note: the board
+name can be multiple words in length.)
+
+The table below shows the details for all the Teensy boards as of writing of
+this man page.
+
+.TS
+box;
+lb lb rb rb rb rb
+l l r r r r .
+Chip Board Memory Block Prefix Shift
+AT90USB162 Teensy 1.0 0x3e00 128 2 0
+AT90USB646 Teensy++ 1.0 0xfc00 256 2 8
+AT90USB1286 Teensy++ 2.0 0x1fc00 256 2 8
+ATMEGA32U4 Teensy 2.0 0x7e00 128 2 0
+MK20DX128 Teensy 3.0 0x20000 1024 64 0
+MK20DX256 Teensy 3.1 0x40000 1024 64 0
+MKL26Z64 Teensy LC 0xf800 512 64 0
+.TE
+
+.SS Unprivileged flashing
+To be able to flash as an unprivileged user, udev must be configured correctly,
+the rules recommended by PJRC can be found at:
+\%http://www.pjrc.com/teensy/49-teensy.rules
+
+.SS Converting from intel hex to binary
+Converting from an intel hex file to a binary file is very simple with the use
+of the
+.BR objcopy (1)
+program:
+
+.RS 4
+objcopy -I ihex -O binary in.hex out.bin
+.RE
+
+.SH "BUGS"
+If multiple devices are connected at the same time, the device which will be
+flashed is unspecified.
+
+Providing unusual but valid flashing parameters to hktool will cause it to exit
+(usually from an allocation failure). This is unlikely to happen during correct
+operation.
+
+If you find any other bugs, please report them to hktool.bugs@the-tk.com
+
+.SH "FILES"
+.TP
+.I /etc/hktoolrc
+System device list configuration file.
+.TP
+.IR $XDG_CONFIG_HOME/hktoolrc " or " ~/.config/hktoolrc
+User device list configuration file (XDG will be preferred).
+
+.SH "EXAMPLES"
+hktool -f blink.bin MK20DX256
+.RS
+Flash the file "blink.bin" to a connected Teensy 3.1 board which is currently
+in HalfKay bootloader mode.
+.RE
+
+hktool -r ATMEGA32U4
+.RS
+Reboot a connected Teensy 2.0 board which is currently in HalfKay bootloader
+mode.
+.RE
+
+hktool -f prog.bin -r MKL26Z64
+.RS
+Flash the file "prog.bin" to a connected Teensy LC board which is currently in
+HalfKay bootloader mode and then reboot the device out of bootloader mode.
+.RE
+
+.SH "SEE ALSO"
+.BR objcopy (1),
+.BR udev (7)
diff --git a/hktool.c b/hktool.c
new file mode 100644
index 0000000..3a5f3ab
--- /dev/null
+++ b/hktool.c
@@ -0,0 +1,124 @@
+/* HalfKay loader - Load binary data to HalfKay protocol based MCUs.
+ * Based on Teensy Loader (cli) (http://www.pjrc.com/teensy/loader_cli.html)
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdbool.h>
+#include <unistd.h>
+
+#include "halfkay.h"
+#include "log.h"
+#include "params.h"
+
+#ifndef VERSION
+#define VERSION "unknown version"
+#endif
+
+#define USAGE "[-hlvr] [-f file] [--] mcu"
+
+static void help(void)
+{
+ fprintf(stderr,
+ "Options:\n"
+ " -f file Specify binary file to flash to the device.\n"
+ " -h Show this help.\n"
+ " -l Show a list of supported devices.\n"
+ " -v Show version and license information.\n"
+ " -r Reboot the device.\n"
+ "\n"
+ "Please check the hktool(1) man page for more information.\n"
+ "Report bugs to: <hktool.bugs@the-tk.com>\n"
+ "hktool home page: https://the-tk.com/projects/hktool\n");
+}
+
+static void version(void)
+{
+ fprintf(stderr,
+ "hktool %s\n"
+ "Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>\n"
+ "License GPLv3: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n"
+ "This is free software: you are free to change and redistribute it.\n"
+ "There is NO WARRANTY, to the extent permitted by law.\n",
+ VERSION);
+}
+
+int main(int argc, char **argv)
+{
+ bool doflash = false, doreboot = false;
+ char *flashfile = NULL;
+ int opt;
+ struct flashparams fp;
+
+ argv0 = argv[0] != NULL ? argv[0] : "hktool";
+
+ while (opt = getopt(argc, argv, "f:h-lvr"), opt != -1) {
+ switch (opt) {
+ case 'f':
+ doflash = true;
+ flashfile = optarg;
+ break;
+ case 'h':
+ fprintf(stderr, "Usage: %s " USAGE "\n", argv[0]);
+ help();
+ return EXIT_SUCCESS;
+ break;
+ case 'l':
+ listparams();
+ return EXIT_SUCCESS;
+ break;
+ case 'v':
+ version();
+ return EXIT_SUCCESS;
+ break;
+ case 'r':
+ doreboot = true;
+ break;
+ case '?':
+ fprintf(stderr, "Usage: %s " USAGE "\n", argv[0]);
+ return EXIT_FAILURE;
+ break;
+ default:
+ error(0, "getopt returned unexpected value");
+ }
+ }
+
+ if (optind >= argc)
+ error(0, "No MCU specified\nUsage: %s " USAGE, argv[0]);
+
+ if (!doflash && !doreboot)
+ error(0, "Nothing to do");
+
+ if (argc - optind > 1)
+ error(0, "Invalid number of arguments\nUsage: %s " USAGE, argv[0]);
+
+ if (getparams(&fp, argv[optind]) != 0)
+ return EXIT_FAILURE;
+
+ if (doflash) {
+ printf("flashing\n");
+ if (flash(&fp, flashfile) != 0)
+ return EXIT_FAILURE;
+ }
+ if (doreboot) {
+ printf("rebooting\n");
+ if (reboot(&fp) != 0)
+ return EXIT_FAILURE;
+ }
+}
diff --git a/log.c b/log.c
new file mode 100644
index 0000000..39730bf
--- /dev/null
+++ b/log.c
@@ -0,0 +1,99 @@
+/* log.c -- Error and warning messages.
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#include <assert.h>
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "log.h"
+
+const char *argv0;
+
+void error(int errnum, const char *fmt, ...)
+{
+ assert(fmt);
+
+ va_list va;
+
+ fprintf(stderr, "%s: error: ", argv0);
+
+ va_start(va, fmt);
+ vfprintf(stderr, fmt, va);
+ va_end(va);
+
+ if (errnum)
+ fprintf(stderr, ": %s", strerror(errnum));
+
+ fputc('\n', stderr);
+
+ exit(EXIT_FAILURE);
+}
+
+void errorat(int errnum, const char *file, long line, const char *fmt, ...)
+{
+ assert(file && fmt);
+
+ va_list va;
+
+ fprintf(stderr, "%s:%s:%ld: error: ", argv0, file, line);
+
+ va_start(va, fmt);
+ vfprintf(stderr, fmt, va);
+ va_end(va);
+
+ if (errnum)
+ fprintf(stderr, ": %s", strerror(errnum));
+
+ fputc('\n', stderr);
+
+ exit(EXIT_FAILURE);
+}
+
+void warning(int errnum, const char *fmt, ...)
+{
+ va_list ap;
+
+ fprintf(stderr, "%s: warning: ", argv0);
+
+ va_start(ap, fmt);
+ vfprintf(stderr, fmt, ap);
+ va_end(ap);
+
+ if (errnum)
+ fprintf(stderr, ": %s", strerror(errnum));
+
+ fputc('\n', stderr);
+}
+
+void warningat(int errnum, const char *file, long line, const char *fmt, ...)
+{
+ va_list ap;
+
+ fprintf(stderr, "%s:%s:%ld: warning: ", argv0, file, line);
+
+ va_start(ap, fmt);
+ vfprintf(stderr, fmt, ap);
+ va_end(ap);
+
+ if (errnum)
+ fprintf(stderr, ": %s", strerror(errnum));
+
+ fputc('\n', stderr);
+}
diff --git a/log.h b/log.h
new file mode 100644
index 0000000..d6ae299
--- /dev/null
+++ b/log.h
@@ -0,0 +1,42 @@
+/* log.h -- Error and warning messages.
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#ifndef LOG_H
+#define LOG_H
+
+#include <stdnoreturn.h>
+
+#define EMSG_ALLOC "Could not allocate memory"
+#define EMSG_OPEN "Could not open '%s'"
+#define EMSG_READ "Could not read '%s'"
+#define EMSG_SZOP "Arithmetic operation on size_t would wrap"
+#define EMSG_GNOMEM "A call to glob ran out of memory"
+
+extern const char *argv0;
+
+noreturn void error(int errnum, const char *fmt, ...)
+ __attribute__ ((format(printf, 2, 3)));
+noreturn void errorat(int errnum, const char *file, long line, const char *fmt, ...)
+ __attribute__ ((format(printf, 4, 5)));
+
+void warning(int errnum, const char *fmt, ...)
+ __attribute__ ((format(printf, 2, 3)));
+void warningat(int errnum, const char *file, long line, const char *fmt, ...)
+ __attribute__ ((format(printf, 4, 5)));
+
+#endif /* LOG_H */
diff --git a/params.c b/params.c
new file mode 100644
index 0000000..6e0286c
--- /dev/null
+++ b/params.c
@@ -0,0 +1,330 @@
+/* params.c -- Device parameter file handling.
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#include <assert.h>
+#include <ctype.h>
+#include <dirent.h>
+#include <errno.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <glob.h>
+
+#include "halfkay.h"
+#include "log.h"
+#include "params.h"
+#include "util.h"
+
+/* TODO: make this dynamic */
+#define SZMAX_PFILE 1024
+
+struct params {
+ char *chip;
+ char *board;
+ struct flashparams fp;
+};
+
+static int paramc = 0;
+static struct params *paramv = NULL;
+
+/* addparams: add a param definition to the param list */
+static void addparams(struct params *p)
+{
+ static int avail = 1;
+
+ for (int i = 0; i < paramc; i++) {
+ if (xstrcasecmp(paramv[i].chip, p->chip) != 0)
+ continue;
+ return;
+ }
+
+ if (paramc >= avail - 1) {
+ avail = szmul(avail, 2);
+ paramv = xrealloc(paramv, szmul(avail, sizeof *paramv));
+ }
+
+ paramv[paramc].chip = xstrdup(p->chip);
+ paramv[paramc].board = p->board != NULL ? xstrdup(p->board) : NULL;
+ paramv[paramc].fp = p->fp;
+ paramc++;
+}
+
+static void freeparams(struct params *p)
+{
+ free(p->chip);
+ free(p->board);
+ free(p);
+}
+
+/* atosz: convert string to size_t */
+static int atosz(size_t *size, char *str)
+{
+ unsigned long long val;
+ char *endptr;
+
+ assert(size);
+ assert(str);
+
+ /* for some silly reason strtoull actually allows negatives */
+ if (str[0] == '-')
+ return -1;
+
+ errno = 0;
+ val = strtoull(str, &endptr, 0);
+ if (errno || *endptr)
+ return -1;
+
+ if (val > SIZE_MAX)
+ return -1;
+
+ *size = val;
+
+ return 0;
+}
+
+/* TODO: remove the need for freeparams by not allocating this */
+/* readparams: read a file's param definition */
+static struct params *readparams(const char *file)
+{
+ const char *chip, *board;
+ struct flashparams fp;
+ struct params *par;
+ size_t contsz;
+ char cont[SZMAX_PFILE], *tok;
+ FILE *f;
+
+ assert(file);
+
+ chip = file;
+ for (size_t i = 0; i < strlen(file); i++)
+ if (file[i] == '/')
+ chip = &file[i + 1];
+
+ assert(chip[0]);
+
+ f = fopen(file, "r");
+ if (f == NULL) {
+ warning(errno, EMSG_OPEN, file);
+ NULL;
+ }
+
+ contsz = fread(cont, 1, SZMAX_PFILE, f);
+ if (contsz >= sizeof cont) {
+ warning(0, "Parameter file '%s' is longer than %zu",
+ file, sizeof cont - 1);
+ contsz = sizeof cont - 1;
+ }
+ for (size_t i = 0; i < contsz; i++) {
+ if (cont[i] == '\0') {
+ warning(0, "Parameter file '%s' contains null byte", file);
+ cont[i] = ' ';
+ } else if (isspace(cont[i]) || !isprint(cont[i])) {
+ cont[i] = ' ';
+ }
+ }
+ cont[contsz] = '\0';
+
+ tok = strtok(cont, " ");
+ if (tok == NULL)
+ goto fail;
+ if (atosz(&fp.memsz, tok) != 0)
+ goto fail;
+
+ tok = strtok(NULL, " ");
+ if (tok == NULL)
+ goto fail;
+ if (atosz(&fp.blksz, tok) != 0)
+ goto fail;
+
+ tok = strtok(NULL, " ");
+ if (tok == NULL)
+ goto fail;
+ if (atosz(&fp.cmdsz, tok) != 0)
+ goto fail;
+
+ tok = strtok(NULL, " ");
+ if (tok == NULL)
+ goto fail;
+ if (atosz(&fp.addrshft, tok) != 0)
+ goto fail;
+
+ board = strtok(NULL, "");
+
+ par = xmalloc(sizeof *par);
+ par->chip = xstrdup(chip);
+ par->board = board != NULL ? xstrdup(board) : NULL;
+ par->fp = fp;
+
+fail:
+ if (par == NULL)
+ warning(0, "Parameter file '%s' is malformed", file);
+ fclose(f);
+
+ return par;
+}
+
+/* getdirs: returns a NULL terminated list of data paths */
+static char **getdirs(void)
+{
+ static const char *globsuffix = "/hktool/*";
+ char **dirs, *xddirs, *tok;
+ size_t len = 0, avail = 1;
+
+ xddirs = getenv("XDG_DATA_DIRS");
+ if (!xddirs || !*xddirs)
+ xddirs = "/usr/local/share:/usr/share";
+ xddirs = xstrdup(xddirs);
+
+ for (char *s = xddirs; tok = strtok(s, ":"), tok != NULL; s = NULL) {
+ size_t slen;
+
+ if (tok[0] == '\\')
+ continue;
+
+ if (len >= avail - 1) {
+ avail = szmul(avail, 2);
+ dirs = xrealloc(dirs, szmul(avail, sizeof *dirs));
+ }
+
+ slen = szadd(strlen(tok), strlen(globsuffix));
+ dirs[len] = xstrmalloc(slen);
+ snprintf(dirs[len], slen + 1, "%s%s", tok, globsuffix);
+ len++;
+ }
+
+ free(xddirs);
+
+ dirs[len++] = NULL;
+ dirs = xrealloc(dirs, szmul(len, sizeof *dirs));
+
+ return dirs;
+}
+
+/* freedirs: frees list returned by getdirs */
+static void freedirs(char **dirs)
+{
+ assert(dirs);
+
+ for (size_t i = 0; dirs[i]; i++)
+ free(dirs[i]);
+ free(dirs);
+}
+
+/* loadparams: locate and load all param files */
+static void loadparams(void)
+{
+ char **dirs;
+ glob_t globbuf;
+
+ if (paramv != NULL)
+ return;
+
+ dirs = getdirs();
+
+ for (int i = 0; dirs[i]; i++) {
+ int ret;
+
+ ret = glob(dirs[i], i != 0 ? GLOB_APPEND : 0, NULL, &globbuf);
+ if (ret == GLOB_NOSPACE)
+ error(0, EMSG_GNOMEM);
+ if (ret == GLOB_NOMATCH)
+ continue;
+ if (ret == GLOB_ABORTED) {
+ warning(0, "A call to glob resulted in a read error");
+ continue;
+ }
+ }
+
+ freedirs(dirs);
+
+ for (size_t i = 0; i < globbuf.gl_pathc; i++) {
+ struct params *par;
+ par = readparams(globbuf.gl_pathv[i]);
+ if (par == NULL)
+ continue;
+ addparams(par);
+ freeparams(par);
+ }
+
+ globfree(&globbuf);
+}
+
+static int b16len(size_t n)
+{
+ return snprintf(NULL, 0, "%zx", n);
+}
+
+/* listparams: display a list of found parameter files */
+void listparams(void)
+{
+ int lengths[5] = { 0 };
+
+ loadparams();
+
+ for (int i = 0; i < paramc; i++) {
+ int clengths[5];
+
+ clengths[0] = strlen(paramv[i].chip);
+ clengths[1] = b16len(paramv[i].fp.memsz);
+ clengths[2] = b16len(paramv[i].fp.blksz);
+ clengths[3] = b16len(paramv[i].fp.cmdsz);
+ clengths[4] = b16len(paramv[i].fp.addrshft);
+
+ for (int j = 0; j < 5; j++)
+ if (clengths[j] > lengths[j])
+ lengths[j] = clengths[j];
+ }
+
+ for (int i = 0; i < paramc; i++)
+ printf("%-*s - (0x%.*zx 0x%.*zx 0x%.*zx 0x%.*zx) %s\n",
+ lengths[0], paramv[i].chip,
+ lengths[1], paramv[i].fp.memsz, lengths[2], paramv[i].fp.blksz,
+ lengths[3], paramv[i].fp.cmdsz, lengths[4], paramv[i].fp.addrshft,
+ paramv[i].board != NULL ? paramv[i].board : "");
+}
+
+/* getparams: return the flash params for the specified MCU */
+int getparams(struct flashparams *fp, const char *mcufile)
+{
+ assert(fp);
+ assert(mcufile);
+
+ loadparams();
+
+ if (strchr(mcufile, '/') != NULL) {
+ struct params *par;
+ par = readparams(mcufile);
+ if (par == NULL)
+ return -1;
+ *fp = par->fp;
+ freeparams(par);
+ return 0;
+ }
+
+ for (int i = 0; i < paramc; i++) {
+ if (xstrcasecmp(paramv[i].chip, mcufile) == 0) {
+ *fp = paramv[i].fp;
+ return 0;
+ }
+ }
+
+ warning(0, "'%s' is not a valid MCU name", mcufile);
+
+ return -1;
+}
diff --git a/params.h b/params.h
new file mode 100644
index 0000000..468af8c
--- /dev/null
+++ b/params.h
@@ -0,0 +1,27 @@
+/* params.c -- Device parameter file handling.
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#ifndef PARAMS_H
+#define PARAMS_H
+
+#include "halfkay.h"
+
+void listparams(void);
+int getparams(struct flashparams *fp, const char *mcufile);
+
+#endif /* PARAMS_H */
diff --git a/util.c b/util.c
new file mode 100644
index 0000000..a8c3729
--- /dev/null
+++ b/util.c
@@ -0,0 +1,132 @@
+/* util.c -- Various error checking wrappers and utilities.
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Some contents of this file (indicated below) are based on work covered by
+ * the following copyright and permission notice:
+ *
+ * Copyright (c) 2008 Otto Moerbeek <otto@drijf.net>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+#include <assert.h>
+#include <errno.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+#include <ctype.h>
+
+#include "log.h"
+#include "util.h"
+
+/* szadd: checked size_t addition */
+size_t szadd(size_t a, size_t b)
+{
+ if (SIZE_MAX - a < b)
+ error(0, EMSG_SZOP);
+
+ return a + b;
+}
+
+/* szmul: checked size_t multiplication
+ * License information can be found at the top of this file */
+size_t szmul(size_t a, size_t b)
+{
+#define MUL_NO_OVERFLOW ((size_t)1 << (sizeof (size_t) * 4))
+ if ((a >= MUL_NO_OVERFLOW || b >= MUL_NO_OVERFLOW) &&
+ a > 0 && SIZE_MAX / a < b)
+ error(0, EMSG_SZOP);
+#undef MUL_NO_OVERFLOW
+
+ return a * b;
+}
+
+/* xstrmalloc: allocate for a string (+1) or exit with error */
+void *xstrmalloc(size_t size)
+{
+ size_t nsize;
+
+ nsize = size + 1;
+ if (nsize < size)
+ error(0, EMSG_ALLOC);
+
+ return xmalloc(nsize);
+}
+
+/* xstrdup: duplicae string or exit with error */
+char *xstrdup(const char *s)
+{
+ char *ret;
+
+ assert(s);
+
+ ret = xstrmalloc(strlen(s));
+ strcpy(ret, s);
+
+ return ret;
+}
+
+/* xrealloc: reallocate or exit with error */
+void *xrealloc(void *p, size_t size)
+{
+ p = realloc(p, size);
+ if (!p)
+ error(errno, EMSG_ALLOC);
+
+ return p;
+}
+
+/* xmalloc: allocate or exit with error */
+void *xmalloc(size_t size)
+{
+ return xrealloc(NULL, size);
+}
+
+/* xstrcut: cut out a bit of a string into a new string */
+char *xstrcut(const char *s, size_t offt, size_t len)
+{
+ char *ret;
+
+ ret = xstrmalloc(len);
+ strncpy(ret, s + offt, len + 1);
+
+ return ret;
+}
+
+/* xstrcasecmp: case insensitive strcmp */
+int xstrcasecmp(const char *s1, const char *s2)
+{
+ while (toupper(*s1++) == toupper(*s2++))
+ if (*s1 == '\0' || *s2 == '\0')
+ break;
+ if (*s1 == *s2)
+ return 0;
+ if (*s1 < *s2)
+ return -1;
+ return 1;
+}
diff --git a/util.h b/util.h
new file mode 100644
index 0000000..356366c
--- /dev/null
+++ b/util.h
@@ -0,0 +1,34 @@
+/* util.h -- Various error checking wrappers and utilities.
+ *
+ * Copyright (C) 2016 Tomasz Kramkowski <tk@the-tk.com>
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#ifndef UTIL_H
+#define UTIL_H
+
+#include <stdbool.h>
+#include <stddef.h>
+
+size_t szadd(size_t a, size_t b);
+size_t szmul(size_t a, size_t b);
+void *xstrmalloc(size_t size);
+char *xstrdup(const char *s);
+void *xmalloc(size_t size);
+void *xrealloc(void *p, size_t size);
+char *xstrcut(const char *s, size_t offt, size_t len);
+int xstrcasecmp(const char *s1, const char *s2);
+
+#endif /* UTIL_H */