diff options
author | Josh Rahm <joshuarahm@gmail.com> | 2023-01-18 22:29:32 -0700 |
---|---|---|
committer | Josh Rahm <joshuarahm@gmail.com> | 2023-01-18 22:29:32 -0700 |
commit | d93ca841f64cfe6a5ddcb45510becadd83358d84 (patch) | |
tree | 8741945dc2069bde9aa6473f4c529d55e7f1da4c | |
parent | adb7d9e96ed55c7be5bf2da435c1e568dc11ab8f (diff) | |
download | ch573-d93ca841f64cfe6a5ddcb45510becadd83358d84.tar.gz ch573-d93ca841f64cfe6a5ddcb45510becadd83358d84.tar.bz2 ch573-d93ca841f64cfe6a5ddcb45510becadd83358d84.zip |
Start implementing ch-flash.
This is a program forked from isp55e0, but with the ability to wait for
the device to be plugged in before flashing.
I will perhaps add other fetaures to the program which will work better
with my workflow, but this is the big change for now.
-rw-r--r-- | ch-flash/.clang-format | 11 | ||||
-rw-r--r-- | ch-flash/.gitignore | 2 | ||||
-rw-r--r-- | ch-flash/COPYING | 674 | ||||
-rw-r--r-- | ch-flash/Makefile | 5 | ||||
-rw-r--r-- | ch-flash/README.md | 15 | ||||
-rw-r--r-- | ch-flash/ch-flash.c | 776 | ||||
-rw-r--r-- | ch-flash/ch-flash.h | 182 |
7 files changed, 1665 insertions, 0 deletions
diff --git a/ch-flash/.clang-format b/ch-flash/.clang-format new file mode 100644 index 0000000..567ff11 --- /dev/null +++ b/ch-flash/.clang-format @@ -0,0 +1,11 @@ +BasedOnStyle: Google +IndentWidth: 2 +BreakBeforeBraces: Custom +BraceWrapping: + AfterFunction: true +AllowShortFunctionsOnASingleLine: InlineOnly +AlignAfterOpenBracket: AlwaysBreak +BinPackArguments: false +BinPackParameters: false +ExperimentalAutoDetectBinPacking: false +AllowAllParametersOfDeclarationOnNextLine: true diff --git a/ch-flash/.gitignore b/ch-flash/.gitignore new file mode 100644 index 0000000..ba09941 --- /dev/null +++ b/ch-flash/.gitignore @@ -0,0 +1,2 @@ +*.o +ch-flash diff --git a/ch-flash/COPYING b/ch-flash/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/ch-flash/COPYING @@ -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/ch-flash/Makefile b/ch-flash/Makefile new file mode 100644 index 0000000..ba21548 --- /dev/null +++ b/ch-flash/Makefile @@ -0,0 +1,5 @@ +ch-flash: ch-flash.c ch-flash.h + gcc -O2 -o ch-flash ch-flash.c -lusb-1.0 + +clean: + rm -rf ch-flash diff --git a/ch-flash/README.md b/ch-flash/README.md new file mode 100644 index 0000000..6fcf010 --- /dev/null +++ b/ch-flash/README.md @@ -0,0 +1,15 @@ +# ch-flash + +A program for flashing the CH573 devices. + +this is a fork of [](https://github.com/frank-zago/isp55e0.git) with the notable +difference that it will wait for the CH573 device to be connected if one is not +connected already. + +This has the benefit of not needing to "race the clock" when flashing the device +because the CH537 (or at least the ones I have) have an unstable usb interface +and will disconnect and reset after several seconds of being connected to the +machine. + +With this new utility one can run the flash program and then connect the device +when it will be flashed. diff --git a/ch-flash/ch-flash.c b/ch-flash/ch-flash.c new file mode 100644 index 0000000..548487d --- /dev/null +++ b/ch-flash/ch-flash.c @@ -0,0 +1,776 @@ +/* + * ISP-55E0 - an ISP programmer for some WinChipHead MCU families + * Copyright 2021 Frank Zago + * + * 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/>. + */ + +#include "ch-flash.h" + +#include <err.h> +#include <errno.h> +#include <fcntl.h> +#include <getopt.h> +#include <libusb-1.0/libusb.h> +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <sys/stat.h> +#include <sys/types.h> +#include <unistd.h> + +/* Profile of supported chips */ +static const struct ch_profile profiles[] = { + { + .name = "CH549", + .family = 0x12, + .type = 0x49, + .code_flash_size = 61440, + .data_flash_size = 1024, + .mcu_id_len = 8, + .need_last_write = true, + }, + { + .name = "CH551", + .family = 0x11, + .type = 0x51, + .code_flash_size = 10240, + .data_flash_size = 128, + .mcu_id_len = 4, + }, + { + .name = "CH552", + .family = 0x11, + .type = 0x52, + .code_flash_size = 14336, + .data_flash_size = 128, + .mcu_id_len = 4, + }, + { + .name = "CH554", + .family = 0x11, + .type = 0x54, + .code_flash_size = 14336, + .data_flash_size = 128, + .mcu_id_len = 4, + }, + { + .name = "CH559", + .family = 0x11, + .type = 0x59, + .code_flash_size = 61440, + .data_flash_size = 1024, + .mcu_id_len = 4, + }, + { + .name = "CH573", + .family = 0x13, + .type = 0x73, + .code_flash_size = 458752, + .data_flash_size = 32768, + .mcu_id_len = 8, + }, + { + .name = "CH579", + .family = 0x13, + .type = 0x79, + .code_flash_size = 256000, + .data_flash_size = 2048, + .mcu_id_len = 8, + .clear_cfg_rom_read = true, + }, + { + .name = "CH32F103", + .family = 0x14, + .type = 0x3f, + .code_flash_size = 65536, + .mcu_id_len = 8, + .need_remove_wp = true, + .need_last_write = true, + }, + { + .name = "CH32V103", + .family = 0x15, + .type = 0x3f, + .code_flash_size = 65536, + .mcu_id_len = 8, + .need_remove_wp = true, + .need_last_write = true, + }, + { + .name = "CH582", + .family = 0x16, + .type = 0x82, + .code_flash_size = 458752, + .data_flash_size = 32768, + .mcu_id_len = 8, + }, + {}}; + +static const struct option long_options[] = { + {"code-verify", required_argument, 0, 'c'}, + {"debug", no_argument, 0, 'd'}, + {"code-flash", required_argument, 0, 'f'}, + {"help", no_argument, 0, 'h'}, + {"data-flash", required_argument, 0, 'k'}, + {"data-verify", required_argument, 0, 'l'}, + {"data-dump", required_argument, 0, 'm'}, + {0, 0, 0, 0}}; + +static void usage(void) +{ + printf("ISP programmer for some WinChipHead MCUs\n"); + printf("Options:\n"); + printf(" --code-flash, -f firmware to flash\n"); + printf(" --code-verify, -c verify existing firwmare\n"); + printf(" --data-flash, -k data to flash\n"); + printf(" --data-verify, -l verify existing data\n"); + printf(" --data-dump, -m dump the data flash to a file\n"); + printf(" --debug, -d turn debug traces on\n"); + printf(" --help, -h this help\n"); +} + +static void hexdump(const char *name, const void *data, int len) +{ + const uint8_t *p = data; + int i; + + printf("Dump - %s\n", name); + for (i = 0; i < len; i++) { + if (i && (i % 16) == 0) printf("\n"); + + printf("%02x ", *p++); + } + printf("\n"); +} + +/* Open and claim the USB device */ +static void open_usb_device(struct device *dev) +{ + int ret; + + libusb_context *ctx; + ret = libusb_init(&ctx); + if (ret) errx(EXIT_FAILURE, "Can't initialize USB"); + + printf("Opening device with vid and pid\n"); + + do { + dev->usb_h = libusb_open_device_with_vid_pid(NULL, 0x4348, 0x55e0); + if (dev->usb_h != NULL) { + break; + } + fprintf(stderr, "Waiting for CH5xx device in ISP Mode ...\n"); + libusb_handle_events(ctx); + } while (1); + + printf("Detaching from kernel\n"); + ret = libusb_set_auto_detach_kernel_driver(dev->usb_h, 1); + if (ret) errx(EXIT_FAILURE, "Can't detach the device from the kernel"); + + ret = libusb_claim_interface(dev->usb_h, 0); + if (ret) errx(EXIT_FAILURE, "Can't claim the USB device\n"); +} + +/* Send a request, get a reply */ +static int transfer( + struct device *dev, void *req, int req_len, void *resp, int resp_len) +{ + int len; + int ret; + + ret = + libusb_bulk_transfer(dev->usb_h, EP_OUT, req, req_len, &len, USB_TIMEOUT); + if (ret) return -EIO; + + if (dev->debug) hexdump("request", req, len); + + ret = libusb_bulk_transfer( + dev->usb_h, EP_IN, resp, resp_len, &len, USB_TIMEOUT); + if (ret) return -EIO; + + if (dev->debug) hexdump("response", resp, len); + + return 0; +} + +static void set_chip_profile(struct device *dev, uint8_t family, uint8_t type) +{ + const struct ch_profile *profile = profiles; + + while (profile->name) { + if (profile->family == family && profile->type == type) { + dev->profile = profile; + dev->fw.max_flash_size = profile->code_flash_size; + dev->data.max_flash_size = profile->data_flash_size; + dev->data_dump.max_flash_size = profile->data_flash_size; + return; + } + + profile++; + } + + errx( + EXIT_FAILURE, + "Device family 0x%02x type 0x%02x is not supported\n", + family, + type); +} + +static void read_chip_type(struct device *dev) +{ + struct req_get_chip_type req = { + .hdr.command = CMD_CHIP_TYPE, + .hdr.data_len = sizeof(req) - sizeof(req.hdr), + .string = "MCU ISP & WCH.CN", + }; + struct resp_chip_type resp; + int ret; + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Can't get the device type"); + + if (resp.family == 0) + errx(EXIT_FAILURE, "Chip is hosed. Reset or power cycle it."); + + set_chip_profile(dev, resp.family, resp.type); +} + +static void read_config(struct device *dev) +{ + struct req_read_config req = { + .hdr.command = CMD_READ_CONFIG, + .hdr.data_len = sizeof(req) - sizeof(req.hdr), + .what = 0x1f, + }; + struct resp_read_config resp; + int ret; + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Can't get the device configuration"); + + dev->bv = be32toh(resp.bootloader_version); + memcpy(dev->id, resp.id, dev->profile->mcu_id_len); + memcpy(dev->config_data, resp.config_data, sizeof(dev->config_data)); +} + +/* Write some configuration. Hardcoded for now. */ +static void write_config(struct device *dev) +{ + struct req_write_config req = { + .hdr.command = CMD_WRITE_CONFIG, + .hdr.data_len = sizeof(req) - sizeof(req.hdr), + .what = 0x07, + }; + struct resp_write_config resp; + int ret; + + memcpy(req.config_data, dev->config_data, sizeof(req.config_data)); + + if (dev->profile->need_remove_wp && req.config_data[0] == 0xff) + req.config_data[0] = 0xa5; + + if (dev->profile->clear_cfg_rom_read) { + /* CH579 - the CFG_ROM_READ must be cleared, otherwise + * flashing will fail. + */ + req.config_data[8] &= ~0x80; + } + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Can't write the new configuration"); +} + +/* Erase the flash */ +static void erase_code_flash(struct device *dev) +{ + struct req_erase_flash req = { + .hdr.command = CMD_ERASE_CODE_FLASH, + .hdr.data_len = sizeof(req) - sizeof(req.hdr), + }; + struct resp_erase_flash resp; + int length; + int ret; + + /* Erase length is in KiB blocks, with a minimum of 8KiB */ + length = ((dev->fw.len + 1023) & ~1023) / 1024; + if (length < 8) length = 8; + + req.length = length; + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Can't erase the code flash"); + + if (resp.return_code != 0x00) + errx(EXIT_FAILURE, "The device refused to erase the code flash"); +} + +static void load_file(struct device *dev, struct content *info) +{ + struct stat statbuf; + int ret; + int fd; + + fd = open(info->filename, O_RDONLY); + if (fd == -1) err(EXIT_FAILURE, "Can't open the firmware file"); + + ret = fstat(fd, &statbuf); + if (ret == -1) err(EXIT_FAILURE, "Can't get firmware file size"); + + /* Round up to 8 bytes boundary as upload protocol requires + * it. Extra bytes are zeroes. */ + info->len = (statbuf.st_size + 7) & ~7; + + if (info->len > info->max_flash_size) + errx(EXIT_FAILURE, "Firmware cannot fit in flash"); + + info->buf = malloc(info->len); + if (info->buf == NULL) + errx(EXIT_FAILURE, "Can't allocate %zd bytes for the firmware", info->len); + + memset(info->buf, 0xff, info->len); + + /* TODO: loop until all read, or use mmap instead. */ + ret = read(fd, info->buf, statbuf.st_size); + if (ret != statbuf.st_size) err(EXIT_FAILURE, "Can't read firmware file"); + + close(fd); +} + +/* Encrypt (or decrypt) some data */ +static void encrypt(const struct device *dev, struct content *info) +{ + uint8_t *p; + int i; + + p = info->buf; + for (i = 0; i < info->len; i++) { + *p++ ^= dev->xor_key[i % XOR_KEY_LEN]; + } + + info->encrypted = !info->encrypted; +} + +/* Create the local key to encrypt the data to send */ +static void create_key(struct device *dev) +{ + uint8_t sum; + int i; + + sum = 0; + for (i = 0; i < dev->profile->mcu_id_len; i++) sum += dev->id[i]; + + for (i = 0; i < XOR_KEY_LEN; i++) dev->xor_key[i] = sum; + dev->xor_key[7] += dev->profile->type; +} + +/* Send the encryption key */ +static void send_key(struct device *dev) +{ + static struct req_set_key req = { + .hdr.command = CMD_SET_KEY, + .hdr.data_len = 0x1e, + }; + struct resp_set_key resp; + int ret; + uint8_t sum; + int i; + + sum = 0; + for (i = 0; i < XOR_KEY_LEN; i++) sum += dev->xor_key[i]; + + ret = transfer( + dev, + &req, + sizeof(struct req_hdr) + req.hdr.data_len, + &resp, + sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Can't set the key"); + + if (resp.key_checksum != sum) + errx(EXIT_FAILURE, "The device refused the key"); +} + +/* read or write code flash, or write data flash */ +static int flash_rw( + struct device *dev, int cmd, struct content *info, int *offset_out) +{ + struct req_flash_rw req = { + .hdr.command = cmd, + }; + struct resp_flash_rw resp; + int offset; + int to_send; + int len; + int ret; + + /* Send the firmware in 56 bytes chunks */ + offset = 0; + to_send = info->len; + while (to_send) { + req.offset = offset; + + len = sizeof(req.data); + if (len > to_send) len = to_send; + + req.hdr.data_len = len + 5; + + memcpy(&req.data, &info->buf[offset], len); + + ret = transfer( + dev, + &req, + sizeof(struct req_hdr) + req.hdr.data_len, + &resp, + sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Write failure at offset %d", offset); + + if (resp.return_code != 0) { + *offset_out = offset; + return resp.return_code; + } + + to_send -= len; + offset += len; + } + + if (cmd == CMD_WRITE_CODE_FLASH && dev->profile->need_last_write) { + /* The CH32Fx need a last empty write. */ + req.offset = info->len; + req.hdr.data_len = 5; + + ret = transfer( + dev, + &req, + sizeof(struct req_hdr) + req.hdr.data_len, + &resp, + sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Write failure at offset %d", offset); + + if (resp.return_code != 0) { + *offset_out = offset; + return resp.return_code; + } + } + + return 0; +} + +static void write_code_flash(struct device *dev) +{ + int offset; + int ret; + + ret = flash_rw(dev, CMD_WRITE_CODE_FLASH, &dev->fw, &offset); + if (ret) errx(EXIT_FAILURE, "Write code flash failure at offset %d", offset); +} + +static void verify_code_flash(struct device *dev) +{ + int offset; + int ret; + + ret = flash_rw(dev, CMD_CMP_CODE_FLASH, &dev->fw, &offset); + if (ret) errx(EXIT_FAILURE, "Check code flash failure at offset %d", offset); +} + +static void erase_data_flash(struct device *dev) +{ + struct req_erase_data_flash req = { + .hdr.command = CMD_ERASE_DATA_FLASH, + }; + struct resp_erase_data_flash resp; + size_t length; + int ret; + + /* Erase length is in KiB blocks, with a minimum of 1KiB */ + length = ((dev->profile->data_flash_size + 1023) & ~1023) / 1024; + if (length < 1) length = 1; + + req.len = length; + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Can't erase the data flash"); + + if (resp.return_code != 0x00) + errx(EXIT_FAILURE, "The device refused to erase the data flash"); +} + +static void write_data_flash(struct device *dev) +{ + int ret; + int offset; + + ret = flash_rw(dev, CMD_WRITE_DATA_FLASH, &dev->data, &offset); + if (ret) errx(EXIT_FAILURE, "Write data flash failure at offset %d", offset); +} + +static void read_data_flash(struct device *dev) +{ + struct req_read_data_flash req = { + .hdr.command = CMD_READ_DATA_FLASH, + }; + struct resp_read_data_flash resp; + int to_read; + int offset; + int len; + int ret; + + to_read = dev->data_dump.max_flash_size; + + dev->data_dump.len = to_read; + dev->data_dump.buf = calloc(1, to_read); + if (!dev->data_dump.buf) + errx(EXIT_FAILURE, "Can't allocate %u bytes for the data flash", to_read); + + offset = 0; + + while (to_read) { + req.offset = offset; + + len = sizeof(resp.data); + if (len > to_read) len = to_read; + + req.len = len; + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + if (ret) errx(EXIT_FAILURE, "Data read failure at offset %d", offset); + + if (resp.return_code != 0) + errx(EXIT_FAILURE, "Data read failure at offset %d", offset); + + memcpy(&dev->data_dump.buf[offset], resp.data, len); + + to_read -= len; + offset += len; + } +} + +static void verify_data_flash(struct device *dev) +{ + if (dev->data.encrypted) { + /* The data was just written previously to the flash, + * and encrypted. It needs to been decrypted now so + * the comparison can happen. */ + encrypt(dev, &dev->data); + } + + if (memcmp(dev->data.buf, dev->data_dump.buf, dev->data.len) != 0) + errx(EXIT_FAILURE, "Data flash doesn't match"); +} + +static void dump_data_flash(struct device *dev) +{ + int fd; + int ret; + + fd = creat(dev->data_dump.filename, 0600); + if (fd == -1) + err(EXIT_FAILURE, "Can't create the file to dump the data flash"); + + ret = write(fd, dev->data_dump.buf, dev->data.max_flash_size); + if (ret == -1) err(EXIT_FAILURE, "Can't dump the data flash"); + + if (ret != dev->profile->data_flash_size) + err(EXIT_FAILURE, "Can't dump all the data flash to file"); + + close(fd); +} + +/* Reboot the device */ +static void reboot_device(struct device *dev) +{ + struct req_reboot req = { + .hdr.command = CMD_REBOOT, + .hdr.data_len = sizeof(req) - sizeof(req.hdr), + .option = 0x01, + }; + struct resp_reboot resp; + int ret; + + ret = transfer(dev, &req, sizeof(req), &resp, sizeof(resp)); + + /* 2.4.0 bootloaders do not respond. 2.8.0 does. */ + if (!dev->wait_reboot_resp) return; + + if (ret) errx(EXIT_FAILURE, "Can't reboot the device"); + + if (resp.return_code != 0x00) + errx(EXIT_FAILURE, "The device refused to reboot"); +} + +int main(int argc, char *argv[]) +{ + struct device dev = {}; + bool do_code_flash = false; + bool do_code_verify = false; + bool do_data_flash = false; + bool do_data_verify = false; + bool do_data_dump = false; + int c; + int i; + + while (1) { + int option_index = 0; + + c = getopt_long(argc, argv, "c:df:hk:l:m:", long_options, &option_index); + if (c == -1) break; + + switch (c) { + case 0: + printf("option %s", long_options[option_index].name); + if (optarg) printf(" with arg %s", optarg); + printf("\n"); + break; + case 'c': + dev.fw.filename = optarg; + do_code_verify = true; + break; + case 'd': + dev.debug = true; + break; + case 'f': + dev.fw.filename = optarg; + do_code_flash = true; + do_code_verify = true; /* always verify after flashing */ + break; + case 'k': + dev.data.filename = optarg; + do_data_flash = true; + do_data_verify = true; + break; + case 'l': + dev.data.filename = optarg; + do_data_verify = true; + break; + case 'm': + dev.data_dump.filename = optarg; + do_data_dump = true; + break; + case 'h': + usage(); + return EXIT_SUCCESS; + default: + return EXIT_FAILURE; + } + } + + if (optind < argc) errx(EXIT_FAILURE, "Extra argument: %s", argv[optind]); + + printf("Opening USB Device\n"); + open_usb_device(&dev); + printf("Reading device.\n"); + read_chip_type(&dev); + printf("Found device %s\n", dev.profile->name); + + read_config(&dev); + + printf( + "Bootloader version %d.%d.%d\n", + (dev.bv >> 16) & 0xff, + (dev.bv >> 8) & 0xff, + dev.bv & 0xff); + + printf("Unique chip ID "); + for (i = 0; i < dev.profile->mcu_id_len; i++) { + if (i > 0) printf("-"); + printf("%02x", dev.id[i]); + } + printf("\n"); + + /* check bootloader version */ + switch (dev.bv) { + case 0x020301: + case 0x020400: + dev.wait_reboot_resp = false; + break; + + case 0x020500: + case 0x020600: + case 0x020800: + case 0x020900: + dev.wait_reboot_resp = true; + break; + + default: + errx(EXIT_FAILURE, "This bootloader version is not supported"); + } + + create_key(&dev); + + if (do_code_flash || do_code_verify) { + load_file(&dev, &dev.fw); + encrypt(&dev, &dev.fw); + } + + if (do_data_flash || do_data_verify) load_file(&dev, &dev.data); + + if (do_code_flash || do_code_verify || do_data_flash) send_key(&dev); + + /* Code flash */ + + if (do_code_flash) { + write_config(&dev); + + erase_code_flash(&dev); + write_code_flash(&dev); + + printf("Code flashing successful\n"); + } + + if (do_code_verify) { + verify_code_flash(&dev); + + printf("Firmware is good\n"); + } + + /* Data flash */ + + if (do_data_flash) { + encrypt(&dev, &dev.data); + erase_data_flash(&dev); + write_data_flash(&dev); + + printf("Data flashing successful\n"); + } + + if (do_data_verify || do_data_dump) read_data_flash(&dev); + + if (do_data_verify) { + verify_data_flash(&dev); + + printf("Data flash is good\n"); + } + + if (do_data_dump) { + dump_data_flash(&dev); + + printf("Dumped data flash to file\n"); + } + + if (do_code_flash) reboot_device(&dev); + + return 0; +} + +/* + * Local Variables: + * mode: c + * c-file-style: "linux" + * indent-tabs-mode: t + * tab-width: 8 + * End: + */ diff --git a/ch-flash/ch-flash.h b/ch-flash/ch-flash.h new file mode 100644 index 0000000..331dc3e --- /dev/null +++ b/ch-flash/ch-flash.h @@ -0,0 +1,182 @@ +/* Endpoints to use */ +#define EP_OUT 0x02 +#define EP_IN 0x82 + +#define XOR_KEY_LEN 8 + +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> +#include <libusb-1.0/libusb.h> + +/* Profile of a specific CH device */ +struct ch_profile { + const char *name; + + uint8_t type; /* CH554 -> 0x54, ... */ + uint8_t family; /* CH55x-> 0x11, CH57x -> 0x13, ...*/ + + int mcu_id_len; /* Number of bytes in the unique ID */ + + int code_flash_size; + int data_flash_size; + + bool need_remove_wp; /* remove CH32 write protect */ + bool need_last_write; /* chip needs an empty write */ + bool clear_cfg_rom_read; /* Flashing will fail if this bit is set */ +}; + +/* Content of either a file or one of the flash section */ +struct content { + char *filename; + bool encrypted; /* whether the data in buf has been encrypted */ + size_t len; + size_t max_flash_size; + uint8_t *buf; +}; + +/* Current device */ +struct device { + const struct ch_profile *profile; + bool debug; + struct content fw; + struct content data; /* read data from */ + struct content data_dump; /* write the data flash into */ + libusb_device_handle *usb_h; + uint32_t bv; /* bootloader version */ + uint8_t id[8]; + uint8_t config_data[12]; + uint8_t xor_key[XOR_KEY_LEN]; + bool wait_reboot_resp; /* wait for reboot command response */ +}; + +/* Enough to erase the flash. */ +#define USB_TIMEOUT 5000 + +#define CMD_CHIP_TYPE 0xa1 +#define CMD_REBOOT 0xa2 +#define CMD_SET_KEY 0xa3 +#define CMD_ERASE_CODE_FLASH 0xa4 +#define CMD_WRITE_CODE_FLASH 0xa5 +#define CMD_CMP_CODE_FLASH 0xa6 +#define CMD_READ_CONFIG 0xa7 +#define CMD_WRITE_CONFIG 0xa8 +#define CMD_ERASE_DATA_FLASH 0xa9 +#define CMD_WRITE_DATA_FLASH 0xaa +#define CMD_READ_DATA_FLASH 0xab + +struct req_hdr { + uint8_t command; + uint16_t data_len; /* Number of bytes after the header */ +} __attribute__((__packed__)); + +struct resp_hdr { + uint8_t command; + uint8_t _u0; + uint8_t data_len; /* Number of bytes after the header */ + uint8_t _u1; /* possibly part of the length */ +} __attribute__((__packed__)); + +struct req_get_chip_type { + struct req_hdr hdr; + uint8_t type; /* CH554 -> 0x54, ... */ + uint8_t family; /* CH55x-> 0x11, CH57x -> 0x13, ...*/ + uint8_t string[16]; /* "MCU ISP & WCH.CN" */ +} __attribute__((__packed__)); + +struct resp_chip_type { + struct resp_hdr hdr; + uint8_t type; /* CH554 -> 0x54, ... */ + uint8_t family; /* CH55x-> 0x11, CH57x -> 0x13, ...*/ +} __attribute__((__packed__)); + +struct req_read_config { + struct req_hdr hdr; + uint16_t what; /* bitfield of config types? */ +} __attribute__((__packed__)); + +struct resp_read_config { + struct resp_hdr hdr; + uint16_t what; /* same as command */ + uint8_t config_data[12]; /* various configuration bits */ + uint32_t bootloader_version; /* in big endian */ + uint8_t id[7]; /* chip unique ID */ + uint8_t id_checksum; +} __attribute__((__packed__)); + +struct req_write_config { + struct req_hdr hdr; + uint16_t what; /* bitfield of config types? */ + uint8_t config_data[12]; +} __attribute__((__packed__)); + +struct resp_write_config { + struct resp_hdr hdr; + uint16_t return_code; +} __attribute__((__packed__)); + +struct req_set_key { + struct req_hdr hdr; + uint8_t data[64]; /* obfuscated crap */ +} __attribute__((__packed__)); + +struct resp_set_key { + struct resp_hdr hdr; + uint16_t key_checksum; +} __attribute__((__packed__)); + +struct req_erase_flash { + struct req_hdr hdr; + uint16_t length; /* size in KiB, possibly just 1 byte to code it. */ + uint16_t _u1; +} __attribute__((__packed__)); + +struct resp_erase_flash { + struct resp_hdr hdr; + uint16_t return_code; +} __attribute__((__packed__)); + +struct req_flash_rw { + struct req_hdr hdr; + uint32_t offset; /* ROM offset */ + uint8_t _u1; /* some checksum? */ + uint8_t data[56]; +} __attribute__((__packed__)); + +struct resp_flash_rw { + struct resp_hdr hdr; + uint16_t return_code; +} __attribute__((__packed__)); + +struct req_reboot { + struct req_hdr hdr; + uint8_t option; +} __attribute__((__packed__)); + +struct resp_reboot { + struct resp_hdr hdr; + uint16_t return_code; +} __attribute__((__packed__)); + +struct req_erase_data_flash { + struct req_hdr hdr; + uint32_t _u1; + uint8_t len; /* length in KB? */ +} __attribute__((__packed__)); + +struct resp_erase_data_flash { + struct resp_hdr hdr; + uint16_t return_code; +} __attribute__((__packed__)); + +struct req_read_data_flash { + struct req_hdr hdr; + uint32_t offset; /* Data offset */ + uint16_t len; +} __attribute__((__packed__)); + +struct resp_read_data_flash { + struct resp_hdr hdr; + uint16_t return_code; + uint8_t data[58]; +} __attribute__((__packed__)); |