From 538e44be38f7bf694ae01c2ac8ccd97895e9dda2 Mon Sep 17 00:00:00 2001 From: Jesse Braham Date: Sat, 5 Sep 2020 10:54:22 -0700 Subject: [PATCH] Convert project to workspace in preparation of cargo-espflash --- .gitignore | 1 + Cargo.lock | 357 ------------------ Cargo.toml | 32 +- espflash/Cargo.toml | 29 ++ espflash/LICENSE | 339 +++++++++++++++++ {bootloader => espflash/bootloader}/README | 0 .../bootloader}/bootloader.bin | Bin {src => espflash/src}/chip/esp32.rs | 21 +- .../src}/chip/esp32/partition_table.rs | 3 +- {src => espflash/src}/chip/esp8266.rs | 9 +- {src => espflash/src}/chip/mod.rs | 0 {src => espflash/src}/connection.rs | 10 +- {src => espflash/src}/elf.rs | 3 +- {src => espflash/src}/encoder.rs | 0 {src => espflash/src}/error.rs | 0 {src => espflash/src}/flasher.rs | 3 +- {src => espflash/src}/lib.rs | 0 {src => espflash/src}/main.rs | 19 +- {tests => espflash/tests}/data/esp32 | Bin {tests => espflash/tests}/data/esp32.bin | Bin {tests => espflash/tests}/data/esp8266 | Bin {tests => espflash/tests}/data/esp8266.bin | Bin {tests => espflash/tests}/data/partitions.bin | Bin 23 files changed, 407 insertions(+), 419 deletions(-) delete mode 100644 Cargo.lock create mode 100644 espflash/Cargo.toml create mode 100644 espflash/LICENSE rename {bootloader => espflash/bootloader}/README (100%) rename {bootloader => espflash/bootloader}/bootloader.bin (100%) rename {src => espflash/src}/chip/esp32.rs (96%) rename {src => espflash/src}/chip/esp32/partition_table.rs (99%) rename {src => espflash/src}/chip/esp8266.rs (99%) rename {src => espflash/src}/chip/mod.rs (100%) rename {src => espflash/src}/connection.rs (98%) rename {src => espflash/src}/elf.rs (99%) rename {src => espflash/src}/encoder.rs (100%) rename {src => espflash/src}/error.rs (100%) rename {src => espflash/src}/flasher.rs (99%) rename {src => espflash/src}/lib.rs (100%) rename {src => espflash/src}/main.rs (85%) rename {tests => espflash/tests}/data/esp32 (100%) mode change 100755 => 100644 rename {tests => espflash/tests}/data/esp32.bin (100%) rename {tests => espflash/tests}/data/esp8266 (100%) mode change 100755 => 100644 rename {tests => espflash/tests}/data/esp8266.bin (100%) rename {tests => espflash/tests}/data/partitions.bin (100%) diff --git a/.gitignore b/.gitignore index ea8c4bf..4fffb2f 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +/Cargo.lock diff --git a/Cargo.lock b/Cargo.lock deleted file mode 100644 index 9a965d8..0000000 --- a/Cargo.lock +++ /dev/null @@ -1,357 +0,0 @@ -# This file is automatically @generated by Cargo. -# It is not intended for manual editing. -[[package]] -name = "ansi_term" -version = "0.11.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b" -dependencies = [ - "winapi", -] - -[[package]] -name = "binread" -version = "1.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a2b274b61a3e239ed71c3e2895a667382749ae3027b21448dea145dcdb1e59c7" -dependencies = [ - "binread_derive", -] - -[[package]] -name = "binread_derive" -version = "1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1df6b59fa62b960de9d0e82a9639d8b7af1678c7e12b05ad5dd697636d2f15ce" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "block-buffer" -version = "0.9.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4152116fd6e9dadb291ae18fc1ec3575ed6d84c29642d97890f4b4a3417297e4" -dependencies = [ - "generic-array", -] - -[[package]] -name = "bytemuck" -version = "1.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "92046dbb6f9332943252123f53623e0a6d513651af14967e2991c371ec20201c" -dependencies = [ - "bytemuck_derive", -] - -[[package]] -name = "bytemuck_derive" -version = "1.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "28dae23a39becf0b1c8f9198d7e9fc80aaf1ec1ee7428ec570f6a0269e59a9cc" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "cfg-if" -version = "0.1.10" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822" - -[[package]] -name = "cpuid-bool" -version = "0.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8aebca1129a03dc6dc2b127edd729435bbc4a37e1d5f4d7513165089ceb02634" - -[[package]] -name = "ctor" -version = "0.1.15" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "39858aa5bac06462d4dd4b9164848eb81ffc4aa5c479746393598fd193afa227" -dependencies = [ - "quote", - "syn", -] - -[[package]] -name = "difference" -version = "2.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "524cbf6897b527295dff137cec09ecf3a05f4fddffd7dfcd1585403449e74198" - -[[package]] -name = "digest" -version = "0.9.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d3dd60d1080a57a05ab032377049e0591415d2b31afd7028356dbf3cc6dcb066" -dependencies = [ - "generic-array", -] - -[[package]] -name = "espflash" -version = "0.1.0" -dependencies = [ - "binread", - "bytemuck", - "main_error", - "md5", - "pico-args", - "pretty_assertions", - "serial", - "sha2", - "slip-codec", - "thiserror", - "xmas-elf", -] - -[[package]] -name = "generic-array" -version = "0.14.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "501466ecc8a30d1d3b7fc9229b122b2ce8ed6e9d9223f1138d4babb253e51817" -dependencies = [ - "typenum", - "version_check", -] - -[[package]] -name = "ioctl-rs" -version = "0.1.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f7970510895cee30b3e9128319f2cefd4bde883a39f38baa279567ba3a7eb97d" -dependencies = [ - "libc", -] - -[[package]] -name = "libc" -version = "0.2.76" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "755456fae044e6fa1ebbbd1b3e902ae19e73097ed4ed87bb79934a867c007bc3" - -[[package]] -name = "main_error" -version = "0.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bb63bb1e282e0b6aba0addb1f0e87cb5181ea68142b2dfd21ba108f8e8088a64" - -[[package]] -name = "md5" -version = "0.7.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "490cc448043f947bae3cbee9c203358d62dbee0db12107a74be5c30ccfd09771" - -[[package]] -name = "opaque-debug" -version = "0.3.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "624a8340c38c1b80fd549087862da4ba43e08858af025b236e509b6649fc13d5" - -[[package]] -name = "output_vt100" -version = "0.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "53cdc5b785b7a58c5aad8216b3dfa114df64b0b06ae6e1501cef91df2fbdf8f9" -dependencies = [ - "winapi", -] - -[[package]] -name = "pico-args" -version = "0.3.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "28b9b4df73455c861d7cbf8be42f01d3b373ed7f02e378d55fa84eafc6f638b1" - -[[package]] -name = "pretty_assertions" -version = "0.6.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3f81e1644e1b54f5a68959a29aa86cde704219254669da328ecfdf6a1f09d427" -dependencies = [ - "ansi_term", - "ctor", - "difference", - "output_vt100", -] - -[[package]] -name = "proc-macro2" -version = "1.0.19" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "04f5f085b5d71e2188cb8271e5da0161ad52c3f227a661a3c135fdf28e258b12" -dependencies = [ - "unicode-xid", -] - -[[package]] -name = "quote" -version = "1.0.7" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "aa563d17ecb180e500da1cfd2b028310ac758de548efdd203e18f283af693f37" -dependencies = [ - "proc-macro2", -] - -[[package]] -name = "serial" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1237a96570fc377c13baa1b88c7589ab66edced652e43ffb17088f003db3e86" -dependencies = [ - "serial-core", - "serial-unix", - "serial-windows", -] - -[[package]] -name = "serial-core" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3f46209b345401737ae2125fe5b19a77acce90cd53e1658cda928e4fe9a64581" -dependencies = [ - "libc", -] - -[[package]] -name = "serial-unix" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f03fbca4c9d866e24a459cbca71283f545a37f8e3e002ad8c70593871453cab7" -dependencies = [ - "ioctl-rs", - "libc", - "serial-core", - "termios", -] - -[[package]] -name = "serial-windows" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "15c6d3b776267a75d31bbdfd5d36c0ca051251caafc285827052bc53bcdc8162" -dependencies = [ - "libc", - "serial-core", -] - -[[package]] -name = "sha2" -version = "0.9.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2933378ddfeda7ea26f48c555bdad8bb446bf8a3d17832dc83e380d444cfb8c1" -dependencies = [ - "block-buffer", - "cfg-if", - "cpuid-bool", - "digest", - "opaque-debug", -] - -[[package]] -name = "slip-codec" -version = "0.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b1951c7a9ecb8fc06621f53e0a22af4d9fb6ffdce0427ff3ee924d99ae5e765f" - -[[package]] -name = "syn" -version = "1.0.39" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "891d8d6567fe7c7f8835a3a98af4208f3846fba258c1bc3c31d6e506239f11f9" -dependencies = [ - "proc-macro2", - "quote", - "unicode-xid", -] - -[[package]] -name = "termios" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d5d9cf598a6d7ce700a4e6a9199da127e6819a61e64b68609683cc9a01b5683a" -dependencies = [ - "libc", -] - -[[package]] -name = "thiserror" -version = "1.0.20" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7dfdd070ccd8ccb78f4ad66bf1982dc37f620ef696c6b5028fe2ed83dd3d0d08" -dependencies = [ - "thiserror-impl", -] - -[[package]] -name = "thiserror-impl" -version = "1.0.20" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bd80fc12f73063ac132ac92aceea36734f04a1d93c1240c6944e23a3b8841793" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "typenum" -version = "1.12.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "373c8a200f9e67a0c95e62a4f52fbf80c23b4381c05a17845531982fa99e6b33" - -[[package]] -name = "unicode-xid" -version = "0.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564" - -[[package]] -name = "version_check" -version = "0.9.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b5a972e5669d67ba988ce3dc826706fb0a8b01471c088cb0b6110b805cc36aed" - -[[package]] -name = "winapi" -version = "0.3.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" -dependencies = [ - "winapi-i686-pc-windows-gnu", - "winapi-x86_64-pc-windows-gnu", -] - -[[package]] -name = "winapi-i686-pc-windows-gnu" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" - -[[package]] -name = "winapi-x86_64-pc-windows-gnu" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" - -[[package]] -name = "xmas-elf" -version = "0.7.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e74de9a366f6ab8c405fa6b371d9ac24943921fa14b3d64afcb202065c405f11" -dependencies = [ - "zero", -] - -[[package]] -name = "zero" -version = "0.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5f1bc8a6b2005884962297587045002d8cfb8dcec9db332f4ca216ddc5de82c5" diff --git a/Cargo.toml b/Cargo.toml index 607ab72..48fedc2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,28 +1,4 @@ -[package] -name = "espflash" -version = "0.1.0" -authors = ["Robin Appelman "] -edition = "2018" -license = "GPL-2.0" -description = "ESP8266 and ESP32 serial flasher" -repository = "https://github.com/icewind1991/espflash" - -[[bin]] -name = "espflash" - -[lib] - -[dependencies] -serial = "0.4" -slip-codec = "0.1.2" -bytemuck = { version = "1.4.0", features = ["derive"] } -xmas-elf = "0.7.0" -thiserror = "1.0.20" -pico-args = "0.3.4" -main_error = "0.1.1" -binread = "1.1.1" -sha2 = "0.9.1" -md5 = "0.7.0" - -[dev-dependencies] -pretty_assertions = "0.6.1" \ No newline at end of file +[workspace] +members = [ + "espflash", +] diff --git a/espflash/Cargo.toml b/espflash/Cargo.toml new file mode 100644 index 0000000..2baa1d2 --- /dev/null +++ b/espflash/Cargo.toml @@ -0,0 +1,29 @@ +[package] +name = "espflash" +version = "0.1.0" +authors = ["Robin Appelman "] +edition = "2018" +license = "GPL-2.0" +description = "ESP8266 and ESP32 serial flasher" +repository = "https://github.com/icewind1991/espflash" + +[[bin]] +name = "espflash" +path = "src/main.rs" + +[lib] + +[dependencies] +binread = "1.1.1" +bytemuck = { version = "1.4.0", features = ["derive"] } +main_error = "0.1.1" +md5 = "0.7.0" +pico-args = "0.3.4" +serial = "0.4" +sha2 = "0.9.1" +slip-codec = "0.1.2" +thiserror = "1.0.20" +xmas-elf = "0.7.0" + +[dev-dependencies] +pretty_assertions = "0.6.1" diff --git a/espflash/LICENSE b/espflash/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/espflash/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/bootloader/README b/espflash/bootloader/README similarity index 100% rename from bootloader/README rename to espflash/bootloader/README diff --git a/bootloader/bootloader.bin b/espflash/bootloader/bootloader.bin similarity index 100% rename from bootloader/bootloader.bin rename to espflash/bootloader/bootloader.bin diff --git a/src/chip/esp32.rs b/espflash/src/chip/esp32.rs similarity index 96% rename from src/chip/esp32.rs rename to espflash/src/chip/esp32.rs index 6194de7..5922956 100644 --- a/src/chip/esp32.rs +++ b/espflash/src/chip/esp32.rs @@ -1,4 +1,6 @@ -mod partition_table; +use std::borrow::Cow; +use std::io::Write; +use std::iter::once; use crate::chip::esp32::partition_table::PartitionTable; use crate::chip::{Chip, ChipType, ESPCommonHeader, SegmentHeader, ESP_MAGIC}; @@ -6,9 +8,8 @@ use crate::elf::{update_checksum, CodeSegment, FirmwareImage, RomSegment, ESP_CH use crate::Error; use bytemuck::{bytes_of, Pod, Zeroable}; use sha2::{Digest, Sha256}; -use std::borrow::Cow; -use std::io::Write; -use std::iter::once; + +mod partition_table; pub struct ESP32; @@ -159,11 +160,12 @@ impl ChipType for ESP32 { const IROM_ALIGN: u32 = 65536; const SEG_HEADER_LEN: u32 = 8; -/// Actual alignment (in data bytes) required for a segment header: positioned so that -/// after we write the next 8 byte header, file_offs % IROM_ALIGN == segment.addr % IROM_ALIGN +/// Actual alignment (in data bytes) required for a segment header: positioned +/// so that after we write the next 8 byte header, file_offs % IROM_ALIGN == +/// segment.addr % IROM_ALIGN /// -/// (this is because the segment's vaddr may not be IROM_ALIGNed, more likely is aligned -/// IROM_ALIGN+0x18 to account for the binary file header +/// (this is because the segment's vaddr may not be IROM_ALIGNed, more likely is +/// aligned IROM_ALIGN+0x18 to account for the binary file header fn get_segment_padding(offset: usize, segment: &CodeSegment) -> u32 { let align_past = (segment.addr % IROM_ALIGN) - SEG_HEADER_LEN; let pad_len = (IROM_ALIGN - ((offset as u32) % IROM_ALIGN)) + align_past; @@ -188,7 +190,8 @@ fn save_flash_segment( if segment_reminder < 0x24 { // Work around a bug in ESP-IDF 2nd stage bootloader, that it didn't map the - // last MMU page, if an IROM/DROM segment was < 0x24 bytes over the page boundary. + // last MMU page, if an IROM/DROM segment was < 0x24 bytes over the page + // boundary. data.write(&[0u8; 0x24][0..(0x24 - segment_reminder as usize)])?; } Ok(checksum) diff --git a/src/chip/esp32/partition_table.rs b/espflash/src/chip/esp32/partition_table.rs similarity index 99% rename from src/chip/esp32/partition_table.rs rename to espflash/src/chip/esp32/partition_table.rs index c87c499..ac89d41 100644 --- a/src/chip/esp32/partition_table.rs +++ b/espflash/src/chip/esp32/partition_table.rs @@ -1,6 +1,7 @@ -use md5::{Context, Digest}; use std::io::Write; +use md5::{Context, Digest}; + const MAX_PARTITION_LENGTH: usize = 0xC00; const PARTITION_TABLE_SIZE: usize = 0x1000; diff --git a/src/chip/esp8266.rs b/espflash/src/chip/esp8266.rs similarity index 99% rename from src/chip/esp8266.rs rename to espflash/src/chip/esp8266.rs index 6380cf9..3903f9f 100644 --- a/src/chip/esp8266.rs +++ b/espflash/src/chip/esp8266.rs @@ -1,12 +1,13 @@ +use std::borrow::Cow; +use std::io::Write; +use std::iter::once; +use std::mem::size_of; + use super::{ChipType, ESPCommonHeader, SegmentHeader, ESP_MAGIC}; use crate::chip::Chip; use crate::elf::{update_checksum, FirmwareImage, RomSegment, ESP_CHECKSUM_MAGIC}; use crate::Error; use bytemuck::bytes_of; -use std::borrow::Cow; -use std::io::Write; -use std::iter::once; -use std::mem::size_of; pub const IROM_MAP_START: u32 = 0x40200000; const IROM_MAP_END: u32 = 0x40300000; diff --git a/src/chip/mod.rs b/espflash/src/chip/mod.rs similarity index 100% rename from src/chip/mod.rs rename to espflash/src/chip/mod.rs diff --git a/src/connection.rs b/espflash/src/connection.rs similarity index 98% rename from src/connection.rs rename to espflash/src/connection.rs index 9640dc3..443098f 100644 --- a/src/connection.rs +++ b/espflash/src/connection.rs @@ -1,13 +1,13 @@ +use std::io::Write; +use std::thread::sleep; +use std::time::Duration; + use crate::encoder::SlipEncoder; -use crate::error::RomError; -use crate::Error; +use crate::error::{Error, RomError}; use binread::io::Cursor; use binread::{BinRead, BinReaderExt}; use serial::SerialPort; use slip_codec::Decoder; -use std::io::Write; -use std::thread::sleep; -use std::time::Duration; pub struct Connection { serial: Box, diff --git a/src/elf.rs b/espflash/src/elf.rs similarity index 99% rename from src/elf.rs rename to espflash/src/elf.rs index afc311b..c4d61b7 100644 --- a/src/elf.rs +++ b/espflash/src/elf.rs @@ -1,6 +1,7 @@ -use crate::chip::Chip; use std::borrow::Cow; use std::cmp::Ordering; + +use crate::chip::Chip; use xmas_elf::program::{SegmentData, Type}; use xmas_elf::ElfFile; diff --git a/src/encoder.rs b/espflash/src/encoder.rs similarity index 100% rename from src/encoder.rs rename to espflash/src/encoder.rs diff --git a/src/error.rs b/espflash/src/error.rs similarity index 100% rename from src/error.rs rename to espflash/src/error.rs diff --git a/src/flasher.rs b/espflash/src/flasher.rs similarity index 99% rename from src/flasher.rs rename to espflash/src/flasher.rs index c42f1dd..77d6eab 100644 --- a/src/flasher.rs +++ b/espflash/src/flasher.rs @@ -1,3 +1,5 @@ +use std::mem::size_of; + use crate::chip::Chip; use crate::connection::Connection; use crate::elf::FirmwareImage; @@ -7,7 +9,6 @@ use crate::Error; use bytemuck::__core::time::Duration; use bytemuck::{bytes_of, Pod, Zeroable}; use serial::SerialPort; -use std::mem::size_of; type Encoder<'a> = SlipEncoder<'a, Box>; diff --git a/src/lib.rs b/espflash/src/lib.rs similarity index 100% rename from src/lib.rs rename to espflash/src/lib.rs diff --git a/src/main.rs b/espflash/src/main.rs similarity index 85% rename from src/main.rs rename to espflash/src/main.rs index 31652f7..48b9c3f 100644 --- a/src/main.rs +++ b/espflash/src/main.rs @@ -1,23 +1,17 @@ -mod chip; -mod connection; -mod elf; -mod encoder; -mod error; -mod flasher; - -pub use error::Error; -use flasher::Flasher; -use main_error::MainError; -use serial::{BaudRate, SerialPort}; use std::fs::read; +use espflash::Flasher; +use main_error::MainError; +use pico_args::Arguments; +use serial::{BaudRate, SerialPort}; + fn help() -> Result<(), MainError> { println!("Usage: espflash [--ram] "); Ok(()) } fn main() -> Result<(), MainError> { - let mut args = pico_args::Arguments::from_env(); + let mut args = Arguments::from_env(); if args.contains(["-h", "--help"]) { return help(); @@ -43,7 +37,6 @@ fn main() -> Result<(), MainError> { })?; let mut flasher = Flasher::connect(serial)?; - let input_bytes = read(&input)?; if ram { diff --git a/tests/data/esp32 b/espflash/tests/data/esp32 old mode 100755 new mode 100644 similarity index 100% rename from tests/data/esp32 rename to espflash/tests/data/esp32 diff --git a/tests/data/esp32.bin b/espflash/tests/data/esp32.bin similarity index 100% rename from tests/data/esp32.bin rename to espflash/tests/data/esp32.bin diff --git a/tests/data/esp8266 b/espflash/tests/data/esp8266 old mode 100755 new mode 100644 similarity index 100% rename from tests/data/esp8266 rename to espflash/tests/data/esp8266 diff --git a/tests/data/esp8266.bin b/espflash/tests/data/esp8266.bin similarity index 100% rename from tests/data/esp8266.bin rename to espflash/tests/data/esp8266.bin diff --git a/tests/data/partitions.bin b/espflash/tests/data/partitions.bin similarity index 100% rename from tests/data/partitions.bin rename to espflash/tests/data/partitions.bin