diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | README.rst | 46 | ||||
| -rwxr-xr-x | build.sh | 12 | ||||
| -rw-r--r-- | setup.py | 22 | ||||
| -rw-r--r-- | stm32ctl/__init__.py | 0 | ||||
| -rw-r--r-- | stm32ctl/__main__.py | 8 | ||||
| -rw-r--r-- | stm32ctl/args.py | 383 | ||||
| -rw-r--r-- | stm32ctl/client.py | 165 | ||||
| -rw-r--r-- | stm32ctl/connection.py | 269 | ||||
| -rw-r--r-- | stm32ctl/main.py | 173 |
11 files changed, 1754 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..583d76c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__ +/build @@ -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: + + {project} Copyright (C) {year} {fullname} + 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/README.rst b/README.rst new file mode 100644 index 0000000..f694a66 --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +stm32ctl +======== + +`stm32ctl` enables interaction with STM32 system bootloader based on +AN3155 USART protocol. + + +Requirements +------------ + +* python >=3.8 + + +Install +------- + +:: + + $ pip install stm32ctl + + +Run +--- + +... + + +License +------- + +stm32ctl - STM32 system bootloader control + +Copyright (C) 2022 Bozo Kopic + +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/>. diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..d03adf8 --- /dev/null +++ b/build.sh @@ -0,0 +1,12 @@ +#!/bin/sh + +set -e + +cd $(dirname -- "$0") + +PYTHON=${PYTHON:-python3} + +$PYTHON setup.py \ + build --build-base build \ + egg_info --egg-base build \ + bdist_wheel --dist-dir build diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..f4c38af --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +from pathlib import Path +from setuptools import setup + + +readme = (Path(__file__).parent / 'README.rst').read_text() + + +setup( + name='stm32ctl', + version='0.0.1', + description='STM32 system bootloader control', + long_description=readme, + long_description_content_type='text/x-rst', + url='https://github.com/bozokopic/stm32ctl', + packages=['stm32ctl'], + license='GPLv3', + classifiers=[ + 'Programming Language :: Python :: 3', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)'], + install_requires=['hat-aio~=0.6.3', + 'hat-drivers~=0.5.15'], + entry_points={'console_scripts': ['stm32ctl = stm32ctl.main:main']}) diff --git a/stm32ctl/__init__.py b/stm32ctl/__init__.py new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/stm32ctl/__init__.py diff --git a/stm32ctl/__main__.py b/stm32ctl/__main__.py new file mode 100644 index 0000000..97d2bb2 --- /dev/null +++ b/stm32ctl/__main__.py @@ -0,0 +1,8 @@ +import sys + +from stm32ctl.main import main + + +if __name__ == '__main__': + sys.argv[0] = 'stm32ctl' + sys.exit(main()) diff --git a/stm32ctl/args.py b/stm32ctl/args.py new file mode 100644 index 0000000..c351804 --- /dev/null +++ b/stm32ctl/args.py @@ -0,0 +1,383 @@ +from pathlib import Path +import getopt +import sys +import typing + + +class InfoArgs(typing.NamedTuple): + pass + + +class ReadArgs(typing.NamedTuple): + address: int = 0x0800_0000 + size: int = 64 * 1024 + path: Path = Path('-') + progress: bool = False + verify: bool = False + + +class WriteArgs(typing.NamedTuple): + address: int = 0x0800_0000 + path: Path = Path('-') + progress: bool = False + verify: bool = False + + +class EraseArgs(typing.NamedTuple): + pages: typing.Optional[typing.List[int]] = None + + +class ExecuteArgs(typing.NamedTuple): + address: int = 0x0800_0000 + + +class ProtectionArgs(typing.NamedTuple): + protect_read: bool = False + unprotect_read: bool = False + protect_write: bool = False + unprotect_write: bool = False + + +ActArgs = typing.Union[InfoArgs, + ReadArgs, + WriteArgs, + ExecuteArgs, + EraseArgs, + ProtectionArgs] + + +class Args(typing.NamedTuple): + port: str = '/dev/ttyUSB0' + baudrate: int = 115200 + skip_init: bool = False + log: typing.Optional[str] = None + actions: typing.List[ActArgs] = [] + + +usage = r"""Usage: + stm32ctl [<global_option>]... [<action> [<action_option>]...]... + +STM32 system bootloader control + +Actions: + info show device informations + read read binary data + write write binary data + erase erase flash memory + execute start application execution + protection change read/write protection + +Global options: + --help show usage + --port PORT serial port (default /dev/ttyUSB0) + --baudrate N serial baudrate (default 115200) + --skip-init skip communication initialization + --log {CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET} + enable logging with provided minimal level + +Read options: + --address ADDR starting address (default 0x0800_0000) + --size N number of bytes (default 64K) + --path PATH output file path or '-' for stdout (default '-') + --progress show progress + --verify verify read data + +Write options: + --address ADDR starting address (default 0x0800_0000) + --path PATH input file path or '-' for stdin (default '-') + --progress show progress + --verify verify written data + +Erase options: + --pages {N|N1-N2},... + erase pages (or pages range) instead of all memory + +Execute options: + --address ADDR starting address (default 0x0800_0000) + +Protection options: + --protect-read protect read operations + --unprotect-read unprotect read operations + --protect-write protect write operations + --unprotect-write unprotect write operations +""" + + +def parse_args(argv: typing.List[str] + ) -> Args: + names = ['help', 'port=', 'baudrate=', 'skip-init', 'log='] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = Args(actions=[]) + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + elif name == '--port': + args = args._replace(port=_parse_int(value)) + + elif name == '--baudrate': + args = args._replace(baudrate=_parse_int(value)) + + elif name == '--skip-init': + args = args._replace(skip_init=True) + + elif name == '--log': + if value not in {'CRITICAL', 'ERROR', 'WARNING', 'INFO', + 'DEBUG', 'NOTSET'}: + print('invalid log level', file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = args._replace(log=value) + + else: + raise ValueError('unsupported name') + + while rest: + if rest[0] == 'info': + info_args, rest = _parse_info_args(rest) + args.actions.append(info_args) + + elif rest[0] == 'read': + read_args, rest = _parse_read_args(rest) + args.actions.append(read_args) + + elif rest[0] == 'write': + write_args, rest = _parse_write_args(rest) + args.actions.append(write_args) + + elif rest[0] == 'erase': + erase_args, rest = _parse_erase_args(rest) + args.actions.append(erase_args) + + elif rest[0] == 'execute': + execute_args, rest = _parse_execute_args(rest) + args.actions.append(execute_args) + + elif rest[0] == 'protection': + protection_args, rest = _parse_protection_args(rest) + args.actions.append(protection_args) + + else: + print('unknown action', rest[0], file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + return args + + +def _parse_info_args(argv): + names = ['help'] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = InfoArgs() + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + else: + raise ValueError('unsupported name') + + return args, rest + + +def _parse_read_args(argv): + names = ['help', 'address=', 'size=', 'path=', 'progress', 'verify'] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = ReadArgs() + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + elif name == '--address': + args = args._replace(address=_parse_int(value)) + + elif name == '--size': + args = args._replace(size=_parse_int(value)) + + elif name == '--path': + args = args._replace(path=Path(value)) + + elif name == '--progress': + args = args._replace(progress=True) + + elif name == '--verify': + args = args._replace(verify=True) + + else: + raise ValueError('unsupported name') + + return args, rest + + +def _parse_write_args(argv): + names = ['help', 'address=', 'path=', 'progress', 'verify'] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = WriteArgs() + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + elif name == '--address': + args = args._replace(address=_parse_int(value)) + + elif name == '--path': + args = args._replace(path=Path(value)) + + elif name == '--progress': + args = args._replace(progress=True) + + elif name == '--verify': + args = args._replace(verify=True) + + else: + raise ValueError('unsupported name') + + return args, rest + + +def _parse_erase_args(argv): + names = ['help', 'pages='] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = EraseArgs() + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + elif name == '--pages': + args = args._replace(pages=sorted(_parse_pages(value))) + + else: + raise ValueError('unsupported name') + + return args, rest + + +def _parse_execute_args(argv): + names = ['help', 'address='] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = ExecuteArgs() + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + elif name == '--address': + args = args._replace(address=_parse_int(value)) + + else: + raise ValueError('unsupported name') + + return args, rest + + +def _parse_protection_args(argv): + names = ['help', 'protect-read', 'unprotect-read', 'protect-write', + 'unprotect-write'] + + try: + result, rest = getopt.getopt(argv[1:], '', names) + + except getopt.GetoptError as e: + print(e, file=sys.stderr) + print(usage, file=sys.stderr) + sys.exit(1) + + args = ProtectionArgs() + for name, value in result: + if name == '--help': + print(usage, file=sys.stderr) + sys.exit(1) + + elif name == '--protect-read': + args = args._replace(protect_read=True) + + elif name == '--unprotect-read': + args = args._replace(unprotect_read=True) + + elif name == '--protect-write': + args = args._replace(protect_write=True) + + elif name == '--unprotect-write': + args = args._replace(unprotect_write=True) + + else: + raise ValueError('unsupported name') + + return args, rest + + +def _parse_int(x): + if x.endswith('K'): + return _parse_int(x[:-1]) * 1024 + + if x.startswith('0x'): + return int(x, base=16) + + return int(x) + + +def _parse_pages(value): + for segment in value.split(','): + if not segment: + continue + + if '-' not in segment: + yield int(segment) + continue + + start_str, stop_str = segment.split('-', 1) + start, stop = int(start_str), int(stop_str) + yield from range(start, stop + 1) diff --git a/stm32ctl/client.py b/stm32ctl/client.py new file mode 100644 index 0000000..d0b97aa --- /dev/null +++ b/stm32ctl/client.py @@ -0,0 +1,165 @@ +import collections +import itertools +import struct +import typing +import enum + +from hat import aio + +from stm32ctl.connection import (CmdType, + connect) + + +ProgressCb = typing.Callable[[int, int], None] + + +class Protection(enum.Enum): + PROTECT_READ = 0 + UNPROTECT_READ = 1 + PROTECT_WRITE = 2 + UNPROTECT_WRITE = 3 + + +class Info(typing.NamedTuple): + version: int + chip_id: int + device_id: bytes + flash_size: int + + +async def create_client(port: str, + baudrate: int, + skip_init: bool + ) -> 'Client': + client = Client() + client._conn = await connect(port=port, + baudrate=baudrate, + skip_init=skip_init) + + try: + res = await client._conn.get_commands() + client._version = res.version + client._cmd_types = res.cmd_types + + except Exception: + await aio.uncancellable(client.async_close()) + raise + + return client + + +class Client(aio.Resource): + + @property + def async_group(self): + return self._conn.async_group + + async def get_info(self) -> Info: + if CmdType.GET_CHIP_ID not in self._cmd_types: + raise Exception('get chip id not supported') + + if CmdType.READ not in self._cmd_types: + raise Exception('read not supported') + + chip_id = await self._conn.get_chip_id() + device_id = await self._conn.read(0x1FFF_F7E8, 12) + flash_size_bytes = await self._conn.read(0x1FFF_F7E0, 2) + + flash_size = struct.unpack('<H', flash_size_bytes)[0] * 1024 + + return Info(version=self._version, + chip_id=chip_id, + device_id=device_id, + flash_size=flash_size) + + async def set_protection(self, protection: Protection): + if protection == Protection.PROTECT_READ: + if CmdType.PROTECT_READ not in self._cmd_types: + raise Exception('protect read not supported') + + await self._conn.protect_read() + + elif protection == Protection.UNPROTECT_READ: + if CmdType.UNPROTECT_READ not in self._cmd_types: + raise Exception('unprotect read not supported') + + await self._conn.unprotect_read() + + elif protection == Protection.PROTECT_WRITE: + if CmdType.PROTECT_WRITE not in self._cmd_types: + raise Exception('protect write not supported') + + await self._conn.protect_write() + + elif protection == Protection.UNPROTECT_WRITE: + if CmdType.UNPROTECT_WRITE not in self._cmd_types: + raise Exception('unprotect write not supported') + + await self._conn.unprotect_write() + + else: + raise ValueError('unsupported protection') + + async def read(self, + start_address: int, + size: int, + progress_cb: typing.Optional[ProgressCb] = None + ) -> bytes: + if CmdType.READ not in self._cmd_types: + raise Exception('read not supported') + + if progress_cb: + total_size = size + read_size = 0 + progress_cb(read_size, total_size) + + segments = collections.deque() + while size > 0: + segment_size = min(size, 0x100) + segment = await self._conn.read(start_address, segment_size) + + segments.append(segment) + start_address += segment_size + size -= segment_size + + if progress_cb: + read_size += segment_size + progress_cb(read_size, total_size) + + return bytes(itertools.chain.from_iterable(segments)) + + async def write(self, + start_address: int, + data: bytes, + progress_cb: typing.Optional[ProgressCb] = None): + if CmdType.WRITE not in self._cmd_types: + raise Exception('write not supported') + + if progress_cb: + total_size = len(data) + written_size = 0 + progress_cb(written_size, total_size) + + data = memoryview(data) + while data: + segment_size = min(len(data), 0x100) + await self._conn.write(start_address, data[:segment_size]) + + data = data[segment_size:] + start_address += segment_size + + if progress_cb: + written_size += segment_size + progress_cb(written_size, total_size) + + async def erase(self, pages: typing.Optional[typing.List[int]] = None): + if CmdType.ERASE not in self._cmd_types: + raise Exception('erase not supported') + + await self._conn.erase(pages) + + async def execute(self, start_address: int): + if CmdType.EXECUTE not in self._cmd_types: + raise Exception('execute not supported') + + await self._conn.execute(start_address) diff --git a/stm32ctl/connection.py b/stm32ctl/connection.py new file mode 100644 index 0000000..8c8a582 --- /dev/null +++ b/stm32ctl/connection.py @@ -0,0 +1,269 @@ +import enum +import typing +import struct +import itertools +import logging + +from hat import aio +from hat.drivers import serial + + +mlog = logging.getLogger(__name__) + + +class CmdType(enum.Enum): + GET_COMMANDS = 0x00 + GET_PROTECTION = 0x01 + GET_CHIP_ID = 0x02 + READ = 0x11 + EXECUTE = 0x21 + WRITE = 0x31 + ERASE = 0x43 + ERASE_EXTENDED = 0x44 + SPECIAL = 0x50 + SPECIAL_EXTENDED = 0x51 + PROTECT_READ = 0x82 + UNPROTECT_READ = 0x92 + PROTECT_WRITE = 0x63 + UNPROTECT_WRITE = 0x73 + CHECK_CRC = 0xA1 + + +class CommandsRes(typing.NamedTuple): + version: int + cmd_types: typing.Set[CmdType] + + +class ProtectionRes(typing.NamedTuple): + version: int + status: int + counter: int + + +async def connect(port: str, + baudrate: int, + skip_init: bool + ) -> 'Connection': + conn = Connection() + + mlog.debug('opening serial endpoint on %s', port) + conn._conn = await serial.create(port, + baudrate=baudrate, + parity=serial.Parity.EVEN) + + if skip_init: + return conn + + try: + mlog.debug('sending initial byte') + await conn._conn.write(b'\x7F') + await conn._receive_ack() + + except Exception: + await aio.uncancellable(conn.async_close()) + raise + + return conn + + +class Connection(aio.Resource): + + @property + def async_group(self): + return self._conn.async_group + + async def get_commands(self) -> CommandsRes: + mlog.debug('sending get commands command') + await self._send([CmdType.GET_COMMANDS.value]) + + count_bytes = await self._conn.read(1) + count = count_bytes[0] + + version_bytes = await self._conn.read(1) + version = version_bytes[0] + mlog.debug('received version %s', version) + + cmd_types_bytes = await self._conn.read(count) + cmd_types = {CmdType(i) for i in cmd_types_bytes} + + if mlog.isEnabledFor(logging.DEBUG): + mlog.debug('received supported commands (%s)', + ', '.join(hex(i.value) for i in cmd_types)) + + await self._receive_ack() + + return CommandsRes(version, cmd_types) + + async def get_protection(self) -> ProtectionRes: + mlog.debug('sending get protection command') + await self._send([CmdType.GET_PROTECTION.value]) + + version_bytes = await self._conn.read(1) + version = version_bytes[0] + mlog.debug('received version %s', version) + + protection_bytes = await self._conn.read(2) + status, counter = protection_bytes + mlog.debug('received status %s and counter %s', status, counter) + + await self._receive_ack() + + return ProtectionRes(version, status, counter) + + async def get_chip_id(self) -> int: + mlog.debug('sending get chip id command') + await self._send([CmdType.GET_CHIP_ID.value]) + + count_bytes = await self._conn.read(1) + count = count_bytes[0] + + chip_id_bytes = await self._conn.read(count + 1) + chip_id = int.from_bytes(chip_id_bytes, byteorder='big') + mlog.debug('received chip id %s', chip_id) + + await self._receive_ack() + + return chip_id + + async def read(self, + start_address: int, + size: int + ) -> bytes: + if size > 0x100: + raise ValueError('unsupported size') + + mlog.debug('sending read command') + await self._send([CmdType.READ.value]) + + mlog.debug('sending start address %s', start_address) + start_address_bytes = struct.pack('>I', start_address) + await self._send(start_address_bytes) + + mlog.debug('sending size %s', size) + await self._send([size - 1]) + + data = await self._conn.read(size) + + return data + + async def write(self, + start_address: int, + data: bytes): + size = len(data) + if size > 0x100 or size < 1: + raise ValueError('unsupported data') + + mlog.debug('sending write command') + await self._send([CmdType.WRITE.value]) + + mlog.debug('sending start address %s', start_address) + start_address_bytes = struct.pack('>I', start_address) + await self._send(start_address_bytes) + + mlog.debug('sending write data (length %s)', len(data)) + await self._send(itertools.chain([size - 1], data)) + + async def execute(self, start_address: int): + mlog.debug('sending execute command') + await self._send([CmdType.EXECUTE.value]) + + mlog.debug('sending start address %s', start_address) + start_address_bytes = struct.pack('>I', start_address) + await self._send(start_address_bytes) + + async def erase(self, pages: typing.Optional[typing.List[int]] = None): + if pages is not None: + size = len(pages) + if size < 1 or size > 0xFF: + raise ValueError('unsupported pages length') + + mlog.debug('sending erase command') + await self._send([CmdType.ERASE.value]) + + if pages is None: + mlog.debug('sending erase all pages') + await self._send([0xFF]) + return + + if mlog.isEnabledFor(logging.DEBUG): + log_data = (f'count {size}' if size > 10 + else f'pages {", ".join(str(page) for page in pages)}') + mlog.debug('sending erase pages (%s)', log_data) + + await self._send(itertools.chain([size - 1], pages)) + + async def erase_extended(self): + raise NotImplementedError() + + async def protect_read(self): + mlog.debug('sending protect read command') + await self._send([CmdType.PROTECT_READ.value]) + + await self._receive_ack() + + async def unprotect_read(self): + mlog.debug('sending unprotect read command') + await self._send([CmdType.UNPROTECT_READ.value]) + + await self._receive_ack() + + async def protect_write(self): + raise NotImplementedError() + + async def unprotect_write(self): + mlog.debug('sending unprotect write command') + await self._send([CmdType.UNPROTECT_WRITE.value]) + + await self._receive_ack() + + async def special(self): + raise NotImplementedError() + + async def special_extended(self): + raise NotImplementedError() + + async def check_crc(self) -> int: + raise NotImplementedError() + + async def _send(self, data): + data_with_checksum = bytes(_get_data_with_checksum(data)) + + if mlog.isEnabledFor(logging.DEBUG): + size = len(data_with_checksum) + log_data = (f'length {size}' if size > 10 + else data_with_checksum.hex(' ')) + mlog.debug('sending data with checksum (%s)', log_data) + + await self._conn.write(data_with_checksum) + + await self._receive_ack() + + async def _receive_ack(self): + mlog.debug('waiting for ACK') + res = await self._conn.read(1) + + if res == b'\x1f': + raise Exception('received NACK') + + if res != b'\x79': + raise Exception(f'received unknown response: 0x{res[0]:02x}') + + mlog.debug('received ACK') + + +def _get_data_with_checksum(data): + count = 0 + crc = 0 + + for i in data: + crc = 0xFF & (crc ^ i) + count += 1 + yield i + + if count < 1: + raise ValueError('invalid data size') + + if count < 2: + crc = 0xFF & ~crc + + yield crc diff --git a/stm32ctl/main.py b/stm32ctl/main.py new file mode 100644 index 0000000..3090f41 --- /dev/null +++ b/stm32ctl/main.py @@ -0,0 +1,173 @@ +from pathlib import Path +import asyncio +import contextlib +import functools +import io +import logging.config +import sys + +from hat import aio + +from stm32ctl.args import (InfoArgs, + ReadArgs, + WriteArgs, + EraseArgs, + ExecuteArgs, + ProtectionArgs, + Args, + parse_args) +from stm32ctl.client import (Protection, + create_client) + + +def main(): + args = parse_args(sys.argv) + + if args.log: + _set_logging(args.log) + + stdin, sys.stdin = sys.stdin.detach(), None + stdout, sys.stdout = sys.stdout.detach(), None + + with contextlib.suppress(asyncio.CancelledError): + aio.run_asyncio(async_main(args, stdin, stdout)) + + +async def async_main(args: Args, + stdin: io.BufferedReader, + stdout: io.BufferedWriter): + client = await create_client(port=args.port, + baudrate=args.baudrate, + skip_init=args.skip_init) + + try: + for action_args in args.actions: + if isinstance(action_args, InfoArgs): + await _act_info(client, action_args, stdout) + + elif isinstance(action_args, ReadArgs): + await _act_read(client, action_args, stdout, not args.log) + + elif isinstance(action_args, WriteArgs): + await _act_write(client, action_args, stdin, not args.log) + + elif isinstance(action_args, EraseArgs): + await _act_erase(client, action_args) + + elif isinstance(action_args, ExecuteArgs): + await _act_execute(client, action_args) + + elif isinstance(action_args, ProtectionArgs): + await _act_protection(client, action_args) + + else: + raise ValueError('unsupported action') + + finally: + await client.async_close() + + +def _set_logging(log_level): + logging.config.dictConfig({ + 'version': 1, + 'formatters': { + 'formater': { + 'format': '[%(asctime)s %(levelname)s %(name)s] %(message)s'}}, + 'handlers': { + 'handler': { + 'class': 'logging.StreamHandler', + 'formatter': 'formater', + 'level': log_level}}, + 'root': { + 'level': log_level, + 'handlers': ['handler']}, + 'disable_existing_loggers': False}) + + +async def _act_info(client, args, stdout): + info = await client.get_info() + + stdout.write( + f'version: 0x{info.version:02x}\n' + f'chip id: 0x{info.chip_id:04x}\n' + f'device id: {info.device_id.hex(" ")}\n' + f'flash size: {info.flash_size / 1024}K\n'.encode('utf-8')) + stdout.flush() + + +async def _act_read(client, args, stdout, dynamic_progress): + # TODO verify + + if args.progress and dynamic_progress: + progress_cb = functools.partial(_print_progress, '\rreading:', '') + + elif args.progress: + progress_cb = functools.partial(_print_progress, 'reading:', '\n') + + else: + progress_cb = None + + data = await client.read(args.address, args.size, progress_cb) + + if args.progress and dynamic_progress: + print(file=sys.stderr, flush=True) + + if args.path == Path('-'): + stdout.write(data) + stdout.flush() + + else: + args.path.write_bytes(data) + + +async def _act_write(client, args, stdin, dynamic_progress): + # TODO verify + + data = (stdin.read() if args.path == Path('-') + else args.path.read_bytes()) + + if args.progress and dynamic_progress: + progress_cb = functools.partial(_print_progress, '\rwriting:', '') + + elif args.progress: + progress_cb = functools.partial(_print_progress, 'writing:', '\n') + + else: + progress_cb = None + + await client.write(args.address, data, progress_cb) + + if args.progress and dynamic_progress: + print(file=sys.stderr, flush=True) + + +async def _act_erase(client, args): + await client.erase(args.pages) + + +async def _act_execute(client, args): + await client.execute(args.address) + + +async def _act_protection(client, args): + if args.protect_read: + await client.set_protection(Protection.PROTECT_READ) + + if args.unprotect_read: + await client.set_protection(Protection.UNPROTECT_READ) + + if args.protect_write: + await client.set_protection(Protection.PROTECT_WRITE) + + if args.unprotect_write: + await client.set_protection(Protection.UNPROTECT_WRITE) + + +def _print_progress(msg, end, current, total): + print(msg, f'{current}/{total} ({int(100 * current / total)}%)', + end=end, file=sys.stderr, flush=True) + + +if __name__ == '__main__': + sys.argv[0] = 'stm32ctl' + sys.exit(main()) |