diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..c868d22 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,77 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ "main" ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ "main" ] + schedule: + - cron: '36 12 * * 3' + workflow_dispatch: + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Use only 'java' to analyze code written in Java, Kotlin or both + # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml new file mode 100644 index 0000000..fc387f0 --- /dev/null +++ b/.github/workflows/python-package.yml @@ -0,0 +1,41 @@ +# This workflow will install Python dependencies, run tests and lint with a variety of Python versions +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: Python package + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + workflow_dispatch: + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] + + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install flake8 pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml new file mode 100644 index 0000000..8c265de --- /dev/null +++ b/.github/workflows/python-publish.yml @@ -0,0 +1,43 @@ +# This workflow will upload a Python Package using Twine when a release is created +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Upload Python Package + +on: + release: + types: [published] + workflow_dispatch: + push: + tags: + - "*" # Push events to matching tags + +permissions: + contents: read + +jobs: + deploy: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + - name: Build package + run: python -m build + - name: Publish package + uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..70cd689 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/.venv/ +/pypicoboot.egg-info/ +*.pyc diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc1cf12 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# pypicoboot +Pico Boot tools for Python + +## Introduction + +Pico Boot is a tool in Python to communicate with RP2040, RP2350 and RP2354 boards. + +## Install + +``` +pip install pypicoboot +``` + +## Usage + +pypicoboot can be used as a Python module (picoboot.py) or through command line (picotool.py). diff --git a/picoboot/__init__.py b/picoboot/__init__.py new file mode 100644 index 0000000..cac31ee --- /dev/null +++ b/picoboot/__init__.py @@ -0,0 +1,2 @@ +from ._version import __version__ +from .picoboot import PicoBoot diff --git a/picoboot/_version.py b/picoboot/_version.py new file mode 100644 index 0000000..64b8e34 --- /dev/null +++ b/picoboot/_version.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +""" +/* + * This file is part of the pypicoboot distribution (https://github.com/polhenarejos/pypicoboot). + * Copyright (c) 2025 Pol Henarejos. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +""" + +__version__ = "1.0" diff --git a/picoboot/core/__init__.py b/picoboot/core/__init__.py new file mode 100644 index 0000000..b02681c --- /dev/null +++ b/picoboot/core/__init__.py @@ -0,0 +1 @@ +from .enums import * diff --git a/picoboot/core/enums.py b/picoboot/core/enums.py new file mode 100644 index 0000000..6c17624 --- /dev/null +++ b/picoboot/core/enums.py @@ -0,0 +1,5 @@ +import enum + +class NamedIntEnum(enum.IntEnum): + def __str__(self): + return self.name diff --git a/picoboot/picoboot.py b/picoboot/picoboot.py new file mode 100644 index 0000000..c256914 --- /dev/null +++ b/picoboot/picoboot.py @@ -0,0 +1,457 @@ +# picoboot.py +from binascii import hexlify +from typing import Optional +import usb.core +import usb.util +import struct +import itertools +from picoboot.core.enums import NamedIntEnum +from picoboot.utils import uint_to_int + +# Valors per defecte segons el datasheet (es poden canviar via OTP) :contentReference[oaicite:4]{index=4} +DEFAULT_VID = 0x2E8A +DEFAULT_PID_RP2040 = 0x0003 +DEFAULT_PID_RP2350 = 0x000F + +PICOBOOT_MAGIC = 0x431FD10B + +# Bit 7 = direcció de transferència de dades (IN si està posat) :contentReference[oaicite:5]{index=5} +CMD_DIR_IN = 0x80 + +# IDs de comanda (secció 5.6.4) :contentReference[oaicite:6]{index=6} +class CommandID(NamedIntEnum): + EXCLUSIVE_ACCESS = 0x01 + FLASH_ERASE = 0x03 + READ = 0x84 + WRITE = 0x05 + EXIT_XIP = 0x06 + ENTER_XIP = 0x07 + REBOOT2 = 0x0A + GET_INFO = 0x8B + OTP_READ = 0x8C + OTP_WRITE = 0x0D + +# Control requests (secció 5.6.5) :contentReference[oaicite:7]{index=7} +class ControlRequest(NamedIntEnum): + REQ_INTERFACE_RESET = 0x41 + REQ_GET_COMMAND_STATUS = 0x42 + BMREQ_RESET = 0x41 # Host->Device, Class, Interface + BMREQ_GET_STATUS = 0xC1 # Device->Host, Class, Interface + +class InfoType(NamedIntEnum): + SYS = 0x01 + PARTITION = 0x02 + UF2_TARGET_PARTITION = 0x03 + UF2_STATUS = 0x04 + +class SysInfoFlags(NamedIntEnum): + CHIP_INFO = 0x01 + CRITICAL = 0x02 + CPU = 0x04 + FLASH = 0x08 + BOOT_RANDOM = 0x10 + NONCE = 0x20 + BOOT_INFO = 0x40 + +class CriticalRegister(NamedIntEnum): + SECURE_BOOT = 0x01 + SECURE_DEBUG_DISABLE = 0x02 + DEBUG_DISABLE = 0x04 + DEFAULT_ARCHSEL = 0x08 + GLITCH_DETECTOR_ENABLE = 0x10 + GLITCH_DETECTOR_SENS = 0x60 + ARM_DISABLE = 0x10000 + RISCV_DISABLE = 0x20000 + +class DiagnosticPartition(NamedIntEnum): + REGION_SEARCHED = 0x01 + INVALID_BLOCK_LOOPS = 0x02 + VALID_BLOCK_LOOPS = 0x04 + VALID_IMAGE_DEFAULTS = 0x08 + HAS_PARTITION_TABLE = 0x10 + CONSIDERED = 0x20 + CHOSEN = 0x40 + PARTITION_TABLE_MATCHING_KEY_FOR_VERIFY = 0x80 + PARTITION_TABLE_HASH_FOR_VERIFY = 0x100 + PARTITION_TABLE_VERIFIED_OK = 0x200 + IMAGE_DEF_MATCHING_KEY_FOR_VERIFY = 0x400 + IMAGE_DEF_HASH_FOR_VERIFY = 0x800 + IMAGE_DEF_VERIFIED_OK = 0x1000 + LOAD_MAP_ENTRIES_LOADED = 0x2000 + IMAGE_LAUNCHED = 0x4000 + IMAGE_CONDITION_FAILURES = 0x8000 + +class PartitionInfoType(NamedIntEnum): + PARTITION_0 = 0 + PARTITION_1 = 1 + PARTITION_2 = 2 + PARTITION_3 = 3 + PARTITION_4 = 4 + PARTITION_5 = 5 + PARTITION_6 = 6 + PARTITION_7 = 7 + PARTITION_8 = 8 + PARTITION_9 = 9 + PARTITION_10 = 10 + PARTITION_11 = 11 + PARTITION_12 = 12 + PARTITION_13 = 13 + PARTITION_14 = 14 + PARTITION_15 = 15 + NONE = -1 + SLOT_0 = -2 + SLOT_1 = -3 + IMAGE = -4 + +class Model(NamedIntEnum): + RP2040 = 0x01754d + RP2350 = 0x02754d + UNKNOWN = 0x000000 + +class Addresses(NamedIntEnum): + BOOTROM_MAGIC = 0x00000010 + +class PicoBootError(Exception): + pass + +class PicoBoot: + + def __init__(self, dev: usb.core.Device, intf, ep_out, ep_in) -> None: + self.dev = dev + self.intf = intf + self.ep_out = ep_out + self.ep_in = ep_in + self._token_counter = itertools.count(1) + self.interface_reset() + + @classmethod + def open(cls, vid: int = DEFAULT_VID, pid: list[int] = [DEFAULT_PID_RP2040, DEFAULT_PID_RP2350], serial: Optional[str] = None) -> "PicoBoot": + class find_pids(object): + def __init__(self, pids): + self._pids = pids + def __call__(self, device): + if device.idProduct in self._pids: + return True + return False + + devices = usb.core.find(find_all=True, custom_match=find_pids(pid)) + devices = list(devices) if devices is not None else [] + if not devices: + raise PicoBootError("No RP2350 device found in PICOBOOT mode") + + dev = None + if serial is None: + dev = devices[0] + else: + for d in devices: + try: + s = usb.util.get_string(d, d.iSerialNumber) + except usb.core.USBError: + continue + if s == serial: + dev = d + break + if dev is None: + raise PicoBootError("No device found with this serial number") + + # Ensure active configuration + # macOS does not allow detach_kernel_driver, and often returns Access Denied + try: + if dev.is_kernel_driver_active(0): + dev.detach_kernel_driver(0) + except usb.core.USBError: + # If it fails, we continue anyway. It's normal on macOS. + pass + except NotImplementedError: + # Also fine on backends that don't implement the function + pass + + dev.set_configuration() + cfg = dev.get_active_configuration() + + intf = None + for i in cfg: + if i.bInterfaceClass == 0xFF and i.bInterfaceSubClass == 0 and i.bInterfaceProtocol == 0: + intf = i + break + if intf is None: + raise PicoBootError("No interface found with PICOBOOT at the device") + + #usb.util.claim_interface(dev, intf.bInterfaceNumber) + + ep_in = ep_out = None + for ep in intf.endpoints(): + if usb.util.endpoint_direction(ep.bEndpointAddress) == usb.util.ENDPOINT_IN: + ep_in = ep + else: + ep_out = ep + + if ep_in is None or ep_out is None: + raise PicoBootError("No PICOBOOT BULK_IN/BULK_OUT endpoints found") + + return cls(dev, intf, ep_out, ep_in) + + def interface_reset(self) -> None: + self.dev.ctrl_transfer( + ControlRequest.BMREQ_RESET, + ControlRequest.REQ_INTERFACE_RESET, + 0, + self.intf.bInterfaceNumber, + None + ) + + def get_command_status(self) -> dict: + data = self.dev.ctrl_transfer( + ControlRequest.BMREQ_GET_STATUS, + ControlRequest.REQ_GET_COMMAND_STATUS, + 0, + self.intf.bInterfaceNumber, + 16, + ) + b = bytes(data) + dToken, dStatusCode = struct.unpack_from(" int: + return next(self._token_counter) & 0xFFFFFFFF + + def _build_command(self, cmd_id: CommandID, args: bytes = b"", transfer_length: int = 0, token: Optional[int] = None) -> tuple[int, bytes]: + if token is None: + token = self._next_token() + if len(args) > 16: + raise ValueError("Too many args: maximum 16 bytes") + bCmdSize = len(args) + args = args.ljust(16, b"\x00") + header = struct.pack( + " bytes: + is_in = bool(cmd_id & CMD_DIR_IN) + + if transfer_length is None: + transfer_length = 0 if data_out is None else len(data_out) + + token, header = self._build_command(cmd_id, args=args, transfer_length=transfer_length) + print(f"Sending command {cmd_id} (0x{cmd_id:02X}) with token {token} (0x{token:08X}) and transfer_length {transfer_length}") + + self.ep_out.write(header, timeout=timeout) + + data_in = b"" + + if transfer_length: + if is_in: + remaining = transfer_length + chunks = [] + maxpkt = self.ep_in.wMaxPacketSize + while remaining > 0: + chunk = bytes(self.ep_in.read(min(maxpkt, remaining), timeout=timeout)) + if not chunk: + break + chunks.append(chunk) + remaining -= len(chunk) + data_in = b"".join(chunks) + if len(data_in) != transfer_length: + raise PicoBootError(f"Expected {transfer_length} bytes, got {len(data_in)}") + else: + if data_out is None or len(data_out) < transfer_length: + raise ValueError("data_out missing or too short for OUT command") + self.ep_out.write(data_out[:transfer_length], timeout=timeout) + + try: + if is_in: + self.ep_out.write(b"", timeout=timeout) + else: + ack = self.ep_in.read(1, timeout=timeout) + except usb.core.USBError: + raise PicoBootError("No ACK received after command") + + return data_in + + + def flash_erase(self, addr: int, size: int): + if addr % 4096 != 0 or size % 4096 != 0: + raise ValueError("addr i size must be aligned to 4kB") + args = struct.pack(" bytes: + args = struct.pack(" None: + if addr % 256 != 0 or len(data) % 256 != 0: + raise ValueError("addr i len(data) must be aligned/multiple of 256 bytes") + args = struct.pack(" int: + args = struct.pack(" None: + self._send_command(CommandID.EXIT_XIP, transfer_length=0) + + def exclusive_access(self) -> None: + self._send_command(CommandID.EXCLUSIVE_ACCESS, args=struct.pack(" str: + data = self.flash_read(Addresses.BOOTROM_MAGIC, 4) + (magic,) = struct.unpack(" Optional[int]: + FLASH_BASE = 0x10000000 + PAGE_SIZE = 256 + + self.interface_reset() + self.exclusive_access() + + pages = self.flash_read(FLASH_BASE, 2 * PAGE_SIZE) + + if pages[:PAGE_SIZE] == pages[PAGE_SIZE:]: + if (pages[:PAGE_SIZE] == b'\xFF' * PAGE_SIZE): + print("Flash appears to be erased") + self.flash_write(FLASH_BASE, b'\x50\x49\x43\x4F' + b'\xFF' * (PAGE_SIZE - 4)) + return self.guess_flash_size() + + candidates = [ + 8*1024*1024, + 4*1024*1024, + 2*1024*1024, + 1*1024*1024, + 512*1024, + 256*1024, + ] + + for size in candidates: + new_pages = self.flash_read(FLASH_BASE + size, 2 * PAGE_SIZE) + if new_pages == pages: + continue + else: + return size * 2 + + return candidates[-1] + + + def get_info(self, info_type: InfoType, param0: int = 0, max_len: int = 32) -> bytes: + args = struct.pack(" dict: + return { + 'value': value, + 'region_searched': bool(value & DiagnosticPartition.REGION_SEARCHED), + 'invalid_block_loops': bool(value & DiagnosticPartition.INVALID_BLOCK_LOOPS), + 'valid_block_loops': bool(value & DiagnosticPartition.VALID_BLOCK_LOOPS), + 'valid_image_defaults': bool(value & DiagnosticPartition.VALID_IMAGE_DEFAULTS), + 'has_partition_table': bool(value & DiagnosticPartition.HAS_PARTITION_TABLE), + 'considered': bool(value & DiagnosticPartition.CONSIDERED), + 'chosen': bool(value & DiagnosticPartition.CHOSEN), + 'partition_table_matching_key_for_verify': bool(value & DiagnosticPartition.PARTITION_TABLE_MATCHING_KEY_FOR_VERIFY), + 'partition_table_hash_for_verify': bool(value & DiagnosticPartition.PARTITION_TABLE_HASH_FOR_VERIFY), + 'partition_table_verified_ok': bool(value & DiagnosticPartition.PARTITION_TABLE_VERIFIED_OK), + 'image_def_matching_key_for_verify': bool(value & DiagnosticPartition.IMAGE_DEF_MATCHING_KEY_FOR_VERIFY), + 'image_def_hash_for_verify': bool(value & DiagnosticPartition.IMAGE_DEF_HASH_FOR_VERIFY), + 'image_def_verified_ok': bool(value & DiagnosticPartition.IMAGE_DEF_VERIFIED_OK), + 'load_map_entries_loaded': bool(value & DiagnosticPartition.LOAD_MAP_ENTRIES_LOADED), + 'image_launched': bool(value & DiagnosticPartition.IMAGE_LAUNCHED), + 'image_condition_failures': bool(value & DiagnosticPartition.IMAGE_CONDITION_FAILURES), + } + + def get_info_sys(self, flags: SysInfoFlags = SysInfoFlags.CHIP_INFO | SysInfoFlags.CRITICAL | SysInfoFlags.CPU | SysInfoFlags.FLASH | SysInfoFlags.BOOT_RANDOM | SysInfoFlags.BOOT_INFO) -> dict: + data = self.get_info(InfoType.SYS, param0=flags, max_len=256) + if len(data) < 24: + raise PicoBootError("INFO_SYS response too short") + + offset = 0 + (count,rflags,) = struct.unpack_from("> 5, + 'arm_disable': bool(critical_flags & CriticalRegister.ARM_DISABLE), + 'riscv_disable': bool(critical_flags & CriticalRegister.RISCV_DISABLE), + } + + if (rflags & SysInfoFlags.CPU): + (architecture,) = struct.unpack_from("> 12 + bits0 = (flash_size & 0x0F00) >> 8 + print(bits0, bits1) + ret['flash_size'] = { + 'slot0': 4096 << bits0 if bits0 != 0 else 0, + 'slot1': 4096 << bits1 if bits1 != 0 else 0, + 'raw': flash_size, + } + if (rflags & SysInfoFlags.BOOT_RANDOM): + (boot_random0, boot_random1, boot_random2, boot_random3) = struct.unpack_from("> 16 + d0 = (w1 & 0x0000FFFF) + ret['boot_info'] = { + 'tbyb': uint_to_int((w0 & 0xFF000000) >> 24), + 'recent_boot_partition': PartitionInfoType(uint_to_int((w0 & 0x00FF0000) >> 16)), + 'boot_type_recent_boot': uint_to_int((w0 & 0x0000FF00) >> 8), + 'recent_boot_diagnostic_partition': PartitionInfoType(uint_to_int((w0 & 0x000000FF))), + 'recent_boot_diagnostic': uint_to_int((w1 & 0xFFFFFFFF)), + 'last_reboot_param0': uint_to_int(w2), + 'last_reboot_param1': uint_to_int(w3), + 'diagnostic_slot1': PicoBoot.build_diagnostic_partition_info(d1), + 'diagnostic_slot0': PicoBoot.build_diagnostic_partition_info(d0), + } + return ret diff --git a/picoboot/tools/picotool.py b/picoboot/tools/picotool.py new file mode 100644 index 0000000..4d7320a --- /dev/null +++ b/picoboot/tools/picotool.py @@ -0,0 +1,6 @@ +from picoboot import PicoBoot + +pb = PicoBoot.open() +data = pb.guess_flash_size() +print(data) + diff --git a/picoboot/utils.py b/picoboot/utils.py new file mode 100644 index 0000000..3b62ea5 --- /dev/null +++ b/picoboot/utils.py @@ -0,0 +1,25 @@ +""" +/* + * This file is part of the pypicoboot distribution (https://github.com/polhenarejos/pypicoboot). + * Copyright (c) 2025 Pol Henarejos. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +""" + +def uint_to_int(value: int, bits: int = 8) -> int: + """Interpret the unsigned integer `value` as a signed integer with `bits` bits.""" + mask = (1 << bits) - 1 + value &= mask # ensure value fits in `bits` + sign_bit = 1 << (bits - 1) + return value - (1 << bits) if (value & sign_bit) else value \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..4f0ce4b --- /dev/null +++ b/setup.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- +""" +/* + * This file is part of the pypicoboot distribution (https://github.com/polhenarejos/pypicoboot). + * Copyright (c) 2025 Pol Henarejos. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +""" + +from setuptools import setup +from setuptools import find_packages + +import re, sys +VERSIONFILE = 'picoboot/_version.py' +verstrline = open(VERSIONFILE, 'rt').read() +VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]" +mo = re.search(VSRE, verstrline, re.M) +if mo: + version = mo.group(1) +else: + raise RuntimeError("Unable to find version string in %s." % (VERSIONFILE,)) + +INSTALL_REQUIRES = [ + 'setuptools', + 'pyusb' +] + +if sys.platform.startswith('win32'): + INSTALL_REQUIRES.append("pywin32") + +try: + import pypandoc + long_description = pypandoc.convert_file('README.md', 'rst') +except(IOError, ImportError): + long_description = open('README.md').read() + +setup( + name='pypicoboot', + packages=['picoboot','picoboot/tools'], + version=version, + description='Pico Boot for Python', + license='AGPL', + license_files='LICENSE', + author="Pol Henarejos", + author_email='pol.henarejos@cttc.es', + url='https://github.com/polhenarejos/pypicoboot', + long_description=long_description, + long_description_content_type='text/markdown', + python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*', + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Intended Audience :: System Administrators', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + 'Operating System :: POSIX :: Linux', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Topic :: Security', + 'Topic :: System :: Installation/Setup', + 'Topic :: System :: Networking', + 'Topic :: System :: Systems Administration', + 'Topic :: Utilities', + ], + install_requires=INSTALL_REQUIRES, + include_package_data=True, + entry_points={ + 'console_scripts': [ + ], + }, +) diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_000_init.py b/tests/test_000_init.py new file mode 100644 index 0000000..87ec7b5 --- /dev/null +++ b/tests/test_000_init.py @@ -0,0 +1,3 @@ +def test_init(): + pass +