commit 84949f63eecad2cd6343d36efd9b27d49d274445 Author: heck Date: Wed Aug 9 16:48:52 2023 +0200 init 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. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec222a7 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# FVFLASH + +A flash tool for the fv-1 chip for macos. + +Use case: fv-1 using a ch341 connected to the eeprom as a serial to i2c converter. +The aim is to have a "as simple as possible to use" uploader for people using e.g. the SpinCAD designer to create programs + +# Build Dependecies + +`port install libusb-devel` + +# Build +go into dir `src`. +`make` + +# Resources +forked from https://github.com/stefanct/ch341eepromtool + + + + diff --git a/src/Makefile b/src/Makefile new file mode 100644 index 0000000..15617d2 --- /dev/null +++ b/src/Makefile @@ -0,0 +1,36 @@ +-include build.conf.deploy_macos + +TARGET=fvflash + +# default config +SYS_PREFIX?=/opt/local + +# System +SYS_INC_PATH?=$(SYS_PREFIX)/include +SYS_LIB_PATH?=$(SYS_PREFIX)/lib + +CFLAGS+=-std=c99 -MMD -MP -Wno-format-extra-args -Wno-deprecated-declarations +CFLAGS+=-isystem$(SYS_INC_PATH) -fvisibility=hidden + +LDFLAGS+=-DMACOSX_DEPLOYMENT_TARGET=11.00 -framework Foundation -framework IOKit -framework Security + +SRC=$(wildcard *.c) +OBJ=$(subst .c,.o,$(SRC)) +DEPENDS=$(subst .c,.d,$(SRC)) + +ifneq ($(MAKECMDGOALS),clean) + -include $(DEPENDS) +endif + +.PHONY: all clean uninstall install +.DEFAULT_GOAL := all + +all: $(TARGET) + +$(TARGET): $(OBJ) + $(CXX) $(LDFLAGS) $(SYS_LIB_PATH)/libusb-1.0.a $(OBJ) -o "$@" + +clean: + rm $(OBJ) $(TARGET) $(DEPENDS) + + diff --git a/src/ch341eeprom.c b/src/ch341eeprom.c new file mode 100644 index 0000000..cadb522 --- /dev/null +++ b/src/ch341eeprom.c @@ -0,0 +1,236 @@ +// +// ch341eeprom programmer version 0.1 (Beta) +// +// Programming tool for the 24Cxx serial EEPROMs using the Winchiphead CH341A IC +// +// (c) December 2011 asbokid +// +// 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 . + +#include +//#include +#include +#include +#include +#include +#include +#include +#include "ch341eeprom.h" + +FILE *debugout, *verbout; +uint8_t *readbuf = NULL; + +int main(int argc, char **argv) { + int i, ret = 0, eepromsize = 0, bytesread = 0; + uint8_t debug = FALSE, verbose = FALSE; + struct libusb_device_handle *devHandle = NULL; + char *filename = NULL, eepromname[12], operation = 0; + FILE *fp; + + static char version_msg[] = + "ch341eeprom - an i2c EEPROM programming tool for the WCH CH341a IC\n" \ + "Version " CH341TOOLVERSION " copyright (c) 2011 asbokid \n\n" \ + "This program comes with asbolutely no warranty; This is free software,\n" \ + "and you are welcome to redistribute it under certain conditions:\n" \ + "GNU GPL v3 License: http://www.gnu.org/licenses/gpl.html\n"; + + static char usage_msg[] = + "Usage:\n" \ + " -h, --help display this text\n" \ + " -v, --verbose verbose output\n" \ + " -d, --debug debug output\n" \ + " -s, --size size of EEPROM {24c32|24c64}\n" \ + " -e, --erase erase EEPROM (fill with 0xff)\n" \ + " -w, --write write EEPROM with image from filename\n" \ + " -r, --read read EEPROM and save image to filename\n\n" \ + "Example: ch341eeprom -v -s 24c64 -w bootrom.bin\n"; + + static struct option longopts[] = { + {"help", no_argument, 0, 'h'}, + {"verbose", no_argument, 0, 'v'}, + {"debug", no_argument, 0, 'd'}, + {"erase", no_argument, 0, 'e'}, + {"size", required_argument, 0, 's'}, + {"read", required_argument, 0, 'r'}, + {"write", required_argument, 0, 'w'}, + {0, 0, 0, 0} + }; + + while (TRUE) { + int32_t optidx = 0; + int8_t c = getopt_long(argc,argv,"hvdes:w:r:", longopts, &optidx); + if (c == -1) + break; + + switch (c) { + case 'h': fprintf(stdout, "%s\n%s", version_msg, usage_msg); + return 0; + case 'v': verbose = TRUE; + break; + case 'd': debug = TRUE; + break; + case 's': if((eepromsize = parseEEPsize(optarg)) > 0) + strncpy(eepromname, optarg, 10); + break; + case 'e': if(!operation) + operation = 'e'; + else { + fprintf(stderr, "Conflicting command line options\n"); + goto shutdown; + } + break; + case 'r': if(!operation) { + operation = 'r'; + filename = (char *) malloc(strlen(optarg)+1); + strcpy(filename, optarg); + } else { + fprintf(stderr, "Conflicting command line options\n"); + goto shutdown; + } + break; + case 'w': if(!operation) { + operation = 'w'; + filename = (char *) malloc(strlen(optarg)+1); + strcpy(filename, optarg); + } else { + fprintf(stderr, "Conflicting command line options\n"); + goto shutdown; + } + break; + default : + case '?': fprintf(stdout, "%s", version_msg); + fprintf(stderr, "%s", usage_msg); + goto shutdown; + } + } + + debugout = (debug == TRUE) ? stdout : fopen("/dev/null","w"); + verbout = (verbose == TRUE) ? stdout : fopen("/dev/null","w"); + fprintf(debugout, "Debug Enabled\n"); + + if(!operation) { + fprintf(stderr, "%s\n%s", version_msg, usage_msg); + goto shutdown; + } + + if(eepromsize <= 0) { + fprintf(stderr, "Invalid EEPROM size\n"); + goto shutdown; + } + + readbuf = (uint8_t *) malloc(MAX_EEPROM_SIZE); // space to store loaded EEPROM + if(!readbuf) { + fprintf(stderr, "Couldnt malloc space needed for EEPROM image\n"); + goto shutdown; + } + + if(!(devHandle = ch341configure(USB_LOCK_VENDOR, USB_LOCK_PRODUCT))) { + fprintf(stderr, "Couldnt configure USB device\n", USB_LOCK_VENDOR, USB_LOCK_PRODUCT); + goto shutdown; + } + fprintf(verbout, "Configured USB device\n", USB_LOCK_VENDOR, USB_LOCK_PRODUCT); + + if(ch341setstream(devHandle, CH341_I2C_STANDARD_SPEED) < 0) { + fprintf(stderr, "Couldnt set i2c bus speed\n"); + goto shutdown; + } + fprintf(verbout, "Set i2c bus speed to [100kHz]\n"); + + switch(operation) { + case 'r': // read + memset(readbuf, 0xff, MAX_EEPROM_SIZE); + + if(ch341readEEPROM(devHandle, readbuf, eepromsize) < 0) { + fprintf(stderr, "Couldnt read [%d] bytes from [%s] EEPROM\n", eepromsize, eepromname); + goto shutdown; + } + fprintf(stdout, "Read [%d] bytes from [%s] EEPROM\n", eepromsize, eepromname); + for(i=0;i eepromsize) + fprintf(stdout, "Truncated to [%d] bytes for [%s] EEPROM\n", eepromsize, eepromname); + + if(ch341writeEEPROM(devHandle, readbuf, eepromsize) < 0) { + fprintf(stderr,"Failed to write [%d] bytes from [%s] to [%s] EEPROM\n", eepromsize, filename, eepromname); + goto shutdown; + } + fprintf(stdout, "Wrote [%d] bytes to [%s] EEPROM\n", eepromsize, eepromname); + break; + case 'e': // erase + memset(readbuf, 0xff, MAX_EEPROM_SIZE); + if(ch341writeEEPROM(devHandle, readbuf, eepromsize) < 0) { + fprintf(stderr,"Failed to erase [%d] bytes of [%s] EEPROM\n", eepromsize, eepromname); + goto shutdown; + } + fprintf(stdout, "Erased [%d] bytes of [%s] EEPROM\n", eepromsize, eepromname); + break; + default: + fprintf(stderr, "Unknown option\n"); + goto shutdown; + } + +shutdown: + if(readbuf) + free(readbuf); + if(filename) + free(filename); + if(devHandle) { + libusb_release_interface(devHandle, DEFAULT_INTERFACE); + fprintf(debugout, "Released device interface [%d]\n", DEFAULT_INTERFACE); + libusb_close(devHandle); + fprintf(verbout, "Closed USB device\n"); + libusb_exit(NULL); + } + return 0; +} + diff --git a/src/ch341eeprom.h b/src/ch341eeprom.h new file mode 100644 index 0000000..6eab42e --- /dev/null +++ b/src/ch341eeprom.h @@ -0,0 +1,152 @@ +// libUSB driver for the ch341a in i2c mode +// +// Copyright 2011 asbokid + +#define CH341TOOLVERSION "0.5" + +#define USB_LOCK_VENDOR 0x1a86 // Dev : (1a86) QinHeng Electronics +#define USB_LOCK_PRODUCT 0x5512 // (5512) CH341A in i2c mode + + +#define MAX_EEPROM_SIZE 16384 + +#define BULK_WRITE_ENDPOINT 0x02 +#define BULK_READ_ENDPOINT 0x82 +#define DEFAULT_INTERFACE 0x00 + +#define DEFAULT_CONFIGURATION 0x01 +#define DEFAULT_TIMEOUT 300 // 300mS for USB timeouts + +#define IN_BUF_SZ 0x100 +#define EEPROM_WRITE_BUF_SZ 0x2b // only for 24c64 / 24c32 ?? +#define EEPROM_READ_BULKIN_BUF_SZ 0x20 +#define EEPROM_READ_BULKOUT_BUF_SZ 0x65 + +// Based on (closed-source) DLL V1.9 for USB by WinChipHead (c) 2005. +// Supports USB chips: CH341, CH341A + +#define mCH341_PACKET_LENGTH 32 +#define mCH341_PKT_LEN_SHORT 8 + +#define mCH341_ENDP_INTER_UP 0x81 +#define mCH341_ENDP_INTER_DOWN 0x01 +#define mCH341_ENDP_DATA_UP 0x82 +#define mCH341_ENDP_DATA_DOWN 0x02 + +#define mCH341_VENDOR_READ 0xC0 +#define mCH341_VENDOR_WRITE 0x40 + +#define mCH341_PARA_INIT 0xB1 +#define mCH341_I2C_STATUS 0x52 +#define mCH341_I2C_COMMAND 0x53 + +#define mCH341_PARA_CMD_R0 0xAC +#define mCH341_PARA_CMD_R1 0xAD +#define mCH341_PARA_CMD_W0 0xA6 +#define mCH341_PARA_CMD_W1 0xA7 +#define mCH341_PARA_CMD_STS 0xA0 + +#define mCH341A_CMD_SET_OUTPUT 0xA1 +#define mCH341A_CMD_IO_ADDR 0xA2 +#define mCH341A_CMD_PRINT_OUT 0xA3 +#define mCH341A_CMD_SPI_STREAM 0xA8 +#define mCH341A_CMD_SIO_STREAM 0xA9 +#define mCH341A_CMD_I2C_STREAM 0xAA +#define mCH341A_CMD_UIO_STREAM 0xAB + +#define mCH341A_BUF_CLEAR 0xB2 +#define mCH341A_I2C_CMD_X 0x54 +#define mCH341A_DELAY_MS 0x5E +#define mCH341A_GET_VER 0x5F + +#define mCH341_EPP_IO_MAX ( mCH341_PACKET_LENGTH - 1 ) +#define mCH341A_EPP_IO_MAX 0xFF + +#define mCH341A_CMD_IO_ADDR_W 0x00 +#define mCH341A_CMD_IO_ADDR_R 0x80 + +#define mCH341A_CMD_I2C_STM_STA 0x74 +#define mCH341A_CMD_I2C_STM_STO 0x75 +#define mCH341A_CMD_I2C_STM_OUT 0x80 +#define mCH341A_CMD_I2C_STM_IN 0xC0 +#define mCH341A_CMD_I2C_STM_MAX ( min( 0x3F, mCH341_PACKET_LENGTH ) ) +#define mCH341A_CMD_I2C_STM_SET 0x60 +#define mCH341A_CMD_I2C_STM_US 0x40 +#define mCH341A_CMD_I2C_STM_MS 0x50 +#define mCH341A_CMD_I2C_STM_DLY 0x0F +#define mCH341A_CMD_I2C_STM_END 0x00 + +#define mCH341A_CMD_UIO_STM_IN 0x00 +#define mCH341A_CMD_UIO_STM_DIR 0x40 +#define mCH341A_CMD_UIO_STM_OUT 0x80 +#define mCH341A_CMD_UIO_STM_US 0xC0 +#define mCH341A_CMD_UIO_STM_END 0x20 + +#define mCH341_PARA_MODE_EPP 0x00 +#define mCH341_PARA_MODE_EPP17 0x00 +#define mCH341_PARA_MODE_EPP19 0x01 +#define mCH341_PARA_MODE_MEM 0x02 + + +#define CH341_I2C_LOW_SPEED 0 // low speed - 20kHz +#define CH341_I2C_STANDARD_SPEED 1 // standard speed - 100kHz +#define CH341_I2C_FAST_SPEED 2 // fast speed - 400kHz +#define CH341_I2C_HIGH_SPEED 3 // high speed - 750kHz + +// CH341a READ EEPROM setup packet for the 24c64 +// this needs putting into a struct to allow convenient access to individual elements + +#define CH341_EEPROM_READ_SETUP_CMD "\xaa\x74\x83\xa0\x00\x00\x74\x81\xa1\xe0\x00\x00\x06\x04\x00\x00" \ + "\x00\x00\x00\x00\x40\x00\x00\x00\x11\x4d\x40\x77\xcd\xab\xba\xdc" \ + "\xaa\xe0\x00\x00\xc4\xf1\x12\x00\x11\x4d\x40\x77\xf0\xf1\x12\x00" \ + "\xd9\x8b\x41\x7e\x00\xf0\xfd\x7f\xf0\xf1\x12\x00\x5a\x88\x41\x7e" \ + "\xaa\xe0\x00\x00\x2a\x88\x41\x7e\x06\x04\x00\x00\x11\x4d\x40\x77" \ + "\xe8\xf3\x12\x00\x14\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00" \ + "\xaa\xdf\xc0\x75\x00" + +// for 24c64 +#define CH341_EEPROM_READ_NEXT_CMD "\xaa\x74\x83\xa0\x00\x00\x74\x81\xa1\xe0\x00\x00\x10\x00\x00\x00" \ + "\x00\x00\x00\x00\x8c\xf1\x12\x00\x01\x00\x00\x00\x00\x00\x00\x00" \ + "\xaa\xe0\x00\x00\x4c\xf1\x12\x00\x5d\x22\xd7\x5a\xdc\xf1\x12\x00" \ + "\x8f\x04\x44\x7e\x30\x88\x41\x7e\xff\xff\xff\xff\x2a\x88\x41\x7e" \ + "\xaa\xe0\x00\x7e\x00\x00\x00\x00\x69\x0e\x3c\x00\x12\x01\x19\x00" \ + "\x0f\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x9c\x2e\x68\x00" \ + "\xaa\xdf\xc0\x75\x00" +#define CH341_EEPROM_READ_CMD_SZ 0x65 + +#define MIN(a,b) (((a)<(b))?(a):(b)) +#define MAX(a,b) (((a)>(b))?(a):(b)) + +#define TRUE 1 +#define FALSE 0 + +struct EEPROM { + char *name; + uint32_t size; +}; + +const static struct EEPROM eepromlist[] = { +//{ "24c01", 128 }, // 1kbit = 128 bits +//{ "24c02", 256 }, +//{ "24c04", 512 }, +//{ "24c08", 1024 }, +//{ "24c16", 2048 }, + { "24c32", 4096 }, // 32kbit = 4kbyte + { "24c64", 8192 }, +//{ "24c128", 16384 }, +//{ "24c256", 32768 }, +//{ "24c512", 65536 }, +//{ "24c1024", 131072}, + { 0, 0} +}; + + +int32_t ch341readEEPROM(struct libusb_device_handle *devHandle, uint8_t *buf, uint32_t bytes); +int32_t ch341writeEEPROM(struct libusb_device_handle *devHandle, uint8_t *buf, uint32_t bytes); +struct libusb_device_handle *ch341configure(uint16_t vid, uint16_t pid); +int32_t ch341setstream(struct libusb_device_handle *devHandle, uint32_t speed); +int32_t parseEEPsize(char *eepromname); + +// callback functions for async USB transfers +void cbBulkIn(struct libusb_transfer *transfer); +void cbBulkOut(struct libusb_transfer *transfer); diff --git a/src/ch341funcs.c b/src/ch341funcs.c new file mode 100644 index 0000000..c6229ec --- /dev/null +++ b/src/ch341funcs.c @@ -0,0 +1,368 @@ +// +// ch341eeprom programmer version 0.1 (Beta) +// +// Programming tool for the 24Cxx serial EEPROMs using the Winchiphead CH341A IC +// +// (c) December 2011 asbokid +// +// 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 . + +#include +//#include +#include +#include +#include +#include +#include "ch341eeprom.h" + +extern FILE *debugout, *verbout; +uint32_t getnextpkt; // set by the callback function +uint32_t syncackpkt; // synch / ack flag used by BULK OUT cb function +uint16_t byteoffset; +extern uint8_t *readbuf; + +// -------------------------------------------------------------------------- +// ch341configure() +// lock USB device for exclusive use +// claim default interface +// set default configuration +// retrieve device descriptor +// identify device revision +// returns *usb device handle + +struct libusb_device_handle *ch341configure(uint16_t vid, uint16_t pid) { + + struct libusb_device *dev; + struct libusb_device_handle *devHandle; + int32_t ret=0, ret2 = 0; // set to < 0 to indicate USB errors + uint32_t i = 0, j = 0; + int32_t currentConfig = 0; + + uint8_t ch341DescriptorBuffer[0x12]; + uint8_t ch341InBuffer[IN_BUF_SZ]; // 0x100 bytes in size + uint8_t ch341OutBuffer[EEPROM_READ_BULKOUT_BUF_SZ]; + + ret = libusb_init(NULL); + if(ret < 0) { + fprintf(stderr, "Couldnt initialise libusb\n"); + return NULL; + } + + libusb_set_debug(NULL, 3); // maximum debug logging level + + fprintf(verbout, "Searching USB buses for WCH CH341a i2c EEPROM programmer [%04x:%04x]\n", + USB_LOCK_VENDOR, USB_LOCK_PRODUCT); + + if(!(devHandle = libusb_open_device_with_vid_pid(NULL, USB_LOCK_VENDOR, USB_LOCK_PRODUCT))) { + fprintf(stderr, "Couldn't open device [%04x:%04x]\n", USB_LOCK_VENDOR, USB_LOCK_PRODUCT); + return NULL; + } + + if(!(dev = libusb_get_device(devHandle))) { + fprintf(stderr, "Couldnt get bus number and address of device\n"); + return NULL; + } + + fprintf(verbout, "Found [%04x:%04x] as device [%d] on USB bus [%d]\n", USB_LOCK_VENDOR, USB_LOCK_PRODUCT, + libusb_get_device_address(dev), libusb_get_bus_number(dev)); + + fprintf(verbout, "Opened device [%04x:%04x]\n", USB_LOCK_VENDOR, USB_LOCK_PRODUCT); + + + if(libusb_kernel_driver_active(devHandle, DEFAULT_INTERFACE)) { + ret = libusb_detach_kernel_driver(devHandle, DEFAULT_INTERFACE); + if(ret) { + fprintf(stderr, "Failed to detach kernel driver: '%s'\n", strerror(-ret)); + return NULL; + } else + fprintf(verbout, "Detached kernel driver\n"); + } + + ret = libusb_get_configuration(devHandle, ¤tConfig); + if(ret) { + fprintf(stderr, "Failed to get current device configuration: '%s'\n", strerror(-ret)); + return NULL; + } + + if(currentConfig != DEFAULT_CONFIGURATION) + ret = libusb_set_configuration(devHandle, currentConfig); + + if(ret) { + fprintf(stderr, "Failed to set device configuration to %d: '%s'\n", DEFAULT_CONFIGURATION, strerror(-ret)); + return NULL; + } + + ret = libusb_claim_interface(devHandle, DEFAULT_INTERFACE); // interface 0 + + if(ret) { + fprintf(stderr, "Failed to claim interface %d: '%s'\n", DEFAULT_INTERFACE, strerror(-ret)); + return NULL; + } + + fprintf(verbout, "Claimed device interface [%d]\n", DEFAULT_INTERFACE); + + ret = libusb_get_descriptor(devHandle, LIBUSB_DT_DEVICE, 0x00, ch341DescriptorBuffer, 0x12); + + if(ret < 0) { + fprintf(stderr, "Failed to get device descriptor: '%s'\n", strerror(-ret)); + return NULL; + } + + fprintf(verbout, "Device reported its revision [%d.%02d]\n", + ch341DescriptorBuffer[12], ch341DescriptorBuffer[13]); + + for(i=0;i<0x12;i++) + fprintf(debugout,"%02x ", ch341DescriptorBuffer[i]); + fprintf(debugout,"\n"); + + return devHandle; +} + + +// -------------------------------------------------------------------------- +// ch341setstream() +// set the i2c bus speed (speed: 0 = 20kHz; 1 = 100kHz, 2 = 400kHz, 3 = 750kHz) +int32_t ch341setstream(struct libusb_device_handle *devHandle, uint32_t speed) { + int32_t ret, i; + uint8_t ch341outBuffer[EEPROM_READ_BULKOUT_BUF_SZ], *outptr; + int32_t actuallen = 0; + + outptr = ch341outBuffer; + + *outptr++ = mCH341A_CMD_I2C_STREAM; + *outptr++ = mCH341A_CMD_I2C_STM_SET | (speed & 0x3); + *outptr = mCH341A_CMD_I2C_STM_END; + + ret = libusb_bulk_transfer(devHandle, BULK_WRITE_ENDPOINT, ch341outBuffer, 3, &actuallen, DEFAULT_TIMEOUT); + + if(ret < 0) { + fprintf(stderr, "ch341setstream(): Failed write %d bytes '%s'\n", 3, strerror(-ret)); + return -1; + } + + fprintf(debugout, "ch341setstream(): Wrote %d bytes: ", 3); + for(i=0; i < 3; i++) + fprintf(debugout, "%02x ", ch341outBuffer[i]); + fprintf(debugout, "\n"); + return 0; +} + +// -------------------------------------------------------------------------- +// ch341readEEPROM() +// read n bytes from device (in packets of 32 bytes) +int32_t ch341readEEPROM(struct libusb_device_handle *devHandle, uint8_t *buffer, uint32_t bytestoread) { + + uint8_t ch341outBuffer[EEPROM_READ_BULKOUT_BUF_SZ]; + uint8_t ch341inBuffer[IN_BUF_SZ]; // 0x100 bytes + int32_t ret = 0, i, exitflag = 0, readpktcount; + uint32_t actuallen = 0; + struct libusb_transfer *xferBulkIn, *xferBulkOut; + struct timeval tv = {0, 100}; // our async polling interval + + xferBulkIn = libusb_alloc_transfer(0); + xferBulkOut = libusb_alloc_transfer(0); + + if(!xferBulkIn || !xferBulkOut) { + fprintf(stderr, "Couldnt allocate USB transfer structures\n"); + return -1; + } + + fprintf(debugout, "Allocated USB transfer structures\n"); + + memset(ch341inBuffer, 0, EEPROM_READ_BULKIN_BUF_SZ); + memcpy(ch341outBuffer, CH341_EEPROM_READ_SETUP_CMD, EEPROM_READ_BULKOUT_BUF_SZ); + + libusb_fill_bulk_transfer(xferBulkIn, devHandle, BULK_READ_ENDPOINT, ch341inBuffer, + EEPROM_READ_BULKIN_BUF_SZ, cbBulkIn, NULL, DEFAULT_TIMEOUT); + + libusb_fill_bulk_transfer(xferBulkOut, devHandle, BULK_WRITE_ENDPOINT, + ch341outBuffer, EEPROM_READ_BULKOUT_BUF_SZ,cbBulkOut, NULL, DEFAULT_TIMEOUT); + + fprintf(debugout, "Filled USB transfer structures\n"); + + libusb_submit_transfer(xferBulkIn); + fprintf(debugout, "Submitted BULK IN start packet\n"); + libusb_submit_transfer(xferBulkOut); + fprintf(debugout, "Submitted BULK OUT setup packet\n"); + + readbuf = buffer; + + byteoffset = 0; + + while (byteoffset < bytestoread) { + fprintf(stdout, "Read [%d] of [%d] bytes \r", byteoffset, bytestoread); + ret = libusb_handle_events_timeout(NULL, &tv); + + if (ret < 0 || getnextpkt == -1) { // indicates an error + fprintf(stderr, "ret from libusb_handle_timeout = %d\n", ret); + fprintf(stderr, "getnextpkt = %d\n", getnextpkt); + fprintf(stderr, "USB read error : %s\n", strerror(-ret)); + goto out_deinit; + } + if(getnextpkt == 1) { // callback function reports a new BULK IN packet received + getnextpkt = 0; // reset the flag + readpktcount++; // increment the read packet counter + byteoffset += EEPROM_READ_BULKIN_BUF_SZ; + fprintf(debugout, "\nRe-submitting transfer request to BULK IN endpoint\n"); + libusb_submit_transfer(xferBulkIn); // re-submit request for next BULK IN packet of EEPROM data + if(syncackpkt) + syncackpkt = 0; + // if 4th packet received, we are at end of 0x80 byte data block, + // if it is not the last block, then resubmit request for data + if(readpktcount==4 && byteoffset < bytestoread) { + fprintf(debugout, "\nSubmitting next transfer request to BULK OUT endpoint\n"); + readpktcount = 0; + + memcpy(ch341outBuffer, CH341_EEPROM_READ_NEXT_CMD, CH341_EEPROM_READ_CMD_SZ); + ch341outBuffer[4] = (uint8_t) (byteoffset >> 8 & 0xff); // MSB (big-endian) byte address + ch341outBuffer[5] = (uint8_t) (byteoffset & 0xff); // LSB of 16-bit byte address + + libusb_fill_bulk_transfer(xferBulkOut, devHandle, BULK_WRITE_ENDPOINT, ch341outBuffer, + EEPROM_READ_BULKOUT_BUF_SZ, cbBulkOut, NULL, DEFAULT_TIMEOUT); + + libusb_submit_transfer(xferBulkOut);// update transfer struct (with new EEPROM page offset) + // and re-submit next transfer request to BULK OUT endpoint + } + } + } + +out_deinit: + libusb_free_transfer(xferBulkIn); + libusb_free_transfer(xferBulkOut); + return 0; +} + +// Callback function for async bulk in comms +void cbBulkIn(struct libusb_transfer *transfer) { + int i; + + switch(transfer->status) { + case LIBUSB_TRANSFER_COMPLETED: + // display the contents of the BULK IN data buffer + fprintf(debugout,"\ncbBulkIn(): status %d - Read %d bytes\n",transfer->status,transfer->actual_length); + + for(i=0; i < transfer->actual_length; i++) { + if(!(i%16)) + fprintf(debugout, "\n "); + fprintf(debugout, "%02x ", transfer->buffer[i]); + } + fprintf(debugout, "\n"); + // copy read data to our EEPROM buffer + memcpy(readbuf + byteoffset, transfer->buffer, transfer->actual_length); + getnextpkt = 1; + break; + default: + fprintf(stderr, "\ncbBulkIn: error : %d\n", transfer->status); + getnextpkt = -1; + } + return; +} + +// Callback function for async bulk out comms +void cbBulkOut(struct libusb_transfer *transfer) { + syncackpkt = 1; + fprintf(debugout, "\ncbBulkOut(): Sync/Ack received: status %d\n", transfer->status); + return; +} + +// -------------------------------------------------------------------------- +// ch341writeEEPROM() +// write n bytes to 24c32/24c64 device (in packets of 32 bytes) +int32_t ch341writeEEPROM(struct libusb_device_handle *devHandle, uint8_t *buffer, uint32_t bytesum) { + + uint8_t ch341outBuffer[EEPROM_WRITE_BUF_SZ], *outptr, *bufptr; + int32_t ret = 0, i; + uint16_t byteoffset = 0, bytes = bytesum; + uint8_t addrbytecount = 3; // 24c32 and 24c64 (and other 24c??) use 3 bytes for addressing + int32_t actuallen = 0; + + bufptr = buffer; + + while(bytes) { + outptr = ch341outBuffer; + *outptr++ = mCH341A_CMD_I2C_STREAM; + *outptr++ = mCH341A_CMD_I2C_STM_STA; + *outptr++ = mCH341A_CMD_I2C_STM_OUT + addrbytecount + MIN(bytes, 25); + *outptr++ = 0xa0; // EEPROM device address + *outptr++ = (uint8_t) (byteoffset >> 8 & 0xff); // MSB (big-endian) byte address + *outptr++ = (uint8_t) (byteoffset & 0xff); // LSB of 16-bit byte address + + memcpy(outptr, bufptr, MIN(bytes, 25)); // payload has two parts: 25 bytes & up to 7 more bytes + + outptr += MIN(bytes, 25); + bufptr += MIN(bytes, 25); + bytes -= MIN(bytes, 25); + + *outptr++ = mCH341A_CMD_I2C_STM_END; + + if(bytes) { + *outptr++ = mCH341A_CMD_I2C_STREAM; + *outptr++ = mCH341A_CMD_I2C_STM_OUT + MIN(bytes, 7); + memcpy(outptr, bufptr, MIN(bytes, 7)); + + outptr += MIN(bytes, 7); + bufptr += MIN(bytes, 7); + bytes -= MIN(bytes, 7); + } + + *outptr++ = mCH341A_CMD_I2C_STM_STO; + *outptr = mCH341A_CMD_I2C_STM_END; + + byteoffset += 0x20; + + for(i=0; i < EEPROM_WRITE_BUF_SZ; i++) { + if(!(i%0x10)) + fprintf(debugout, "\n%04x : ", i); + fprintf(debugout, "%02x ", ch341outBuffer[i]); + } + fprintf(debugout, "\n"); + + ret = libusb_bulk_transfer(devHandle, BULK_WRITE_ENDPOINT, + ch341outBuffer, EEPROM_WRITE_BUF_SZ, &actuallen, DEFAULT_TIMEOUT); + + if(ret < 0) { + fprintf(stderr, "Failed to write to EEPROM: '%s'\n", strerror(-ret)); + return -1; + } + + fprintf(debugout, "Writing [aa 5a 00] to EEPROM\n"); // Magic CH341a packet! Undocumented, unknown purpose + + outptr = ch341outBuffer; + *outptr++ = mCH341A_CMD_I2C_STREAM; + *outptr++ = 0x5a; // what is this 0x5a?? + *outptr++ = mCH341A_CMD_I2C_STM_END; + + ret = libusb_bulk_transfer(devHandle, BULK_WRITE_ENDPOINT, ch341outBuffer, 3, &actuallen, DEFAULT_TIMEOUT); + + if(ret < 0) { + fprintf(stderr, "Failed to write to EEPROM: '%s'\n", strerror(-ret)); + return -1; + } + fprintf(stdout, "Written [%d] of [%d] bytes \r", bytes, bytesum); + } + return 0; +} + + +// -------------------------------------------------------------------------- +// parseEEPsize() +// passed an EEPROM name (case-sensitive), returns its byte size +int32_t parseEEPsize(char *eepromname) { + int i; + + for(i=0; eepromlist[i].size; i++) + if(strstr(eepromlist[i].name, eepromname)) + return(eepromlist[i].size); + return -1; +}