From 697141d65c2a2cfc93d3d12c85a1288813560408 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Sat, 14 Oct 2023 00:52:41 +0300 Subject: [PATCH] Initial commit --- .ci/aptPackagesToInstall.txt | 0 .ci/pythonPackagesToInstallFromGit.txt | 0 .editorconfig | 12 + .github/.templateMarker | 1 + .github/dependabot.yml | 8 + .github/workflows/CI.yml | 15 + .gitignore | 24 + .gitlab-ci.yml | 51 ++ .reuse/dep5 | 10 + COPYING.md | 675 +++++++++++++++++++++++++ Code_Of_Conduct.md | 1 + LICENSES/GPL-3.0-or-later.md | 1 + LICENSES/Unlicense.md | 27 + MANIFEST.in | 4 + ReadMe.md | 17 + pyproject.toml | 46 ++ samples/etalons/test.cbor | Bin 0 -> 316 bytes samples/etalons/test.dts | 53 ++ samples/etalons/test.fex | 12 + samples/etalons/test.json | 49 ++ samples/etalons/test.msgpack | Bin 0 -> 316 bytes samples/etalons/test.pon | 1 + samples/etalons/test.ubj | Bin 0 -> 427 bytes samples/etalons/test.yaml | 40 ++ samples/test.bin | Bin 0 -> 552 bytes sunxi_fex/__init__.py | 1 + sunxi_fex/__main__.py | 273 ++++++++++ sunxi_fex/kaitai/__init__.py | 0 28 files changed, 1321 insertions(+) create mode 100644 .ci/aptPackagesToInstall.txt create mode 100644 .ci/pythonPackagesToInstallFromGit.txt create mode 100644 .editorconfig create mode 100644 .github/.templateMarker create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/CI.yml create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 .reuse/dep5 create mode 100644 COPYING.md create mode 100644 Code_Of_Conduct.md create mode 100644 LICENSES/GPL-3.0-or-later.md create mode 100644 LICENSES/Unlicense.md create mode 100644 MANIFEST.in create mode 100644 ReadMe.md create mode 100644 pyproject.toml create mode 100644 samples/etalons/test.cbor create mode 100644 samples/etalons/test.dts create mode 100644 samples/etalons/test.fex create mode 100644 samples/etalons/test.json create mode 100644 samples/etalons/test.msgpack create mode 100644 samples/etalons/test.pon create mode 100644 samples/etalons/test.ubj create mode 100644 samples/etalons/test.yaml create mode 100644 samples/test.bin create mode 100644 sunxi_fex/__init__.py create mode 100755 sunxi_fex/__main__.py create mode 100644 sunxi_fex/kaitai/__init__.py diff --git a/.ci/aptPackagesToInstall.txt b/.ci/aptPackagesToInstall.txt new file mode 100644 index 0000000..e69de29 diff --git a/.ci/pythonPackagesToInstallFromGit.txt b/.ci/pythonPackagesToInstallFromGit.txt new file mode 100644 index 0000000..e69de29 diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c9162b9 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +indent_style = tab +indent_size = 4 +insert_final_newline = true +end_of_line = lf + +[*.{yml,yaml}] +indent_style = space +indent_size = 2 diff --git a/.github/.templateMarker b/.github/.templateMarker new file mode 100644 index 0000000..5e3a3e0 --- /dev/null +++ b/.github/.templateMarker @@ -0,0 +1 @@ +KOLANICH/python_project_boilerplate.py diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..89ff339 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" + allow: + - dependency-type: "all" diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 0000000..7fe33b3 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,15 @@ +name: CI +on: + push: + branches: [master] + pull_request: + branches: [master] + +jobs: + build: + runs-on: ubuntu-22.04 + steps: + - name: typical python workflow + uses: KOLANICH-GHActions/typical-python-workflow@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..865b0a4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +/sunxi_fex/kaitai +/kaitai_struct_formats + +/samples/*.json +/samples/*.yaml +/samples/*.bson +/samples/*.cbor +/samples/*.msgpack +/samples/*.ubj +/samples/*.dts +/samples/*.pon + + +__pycache__ +*.pyc +*.pyo +/*.egg-info +*.srctrlbm +*.srctrldb +build +dist +.eggs +monkeytype.sqlite3 +/.ipynb_checkpoints diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..c559996 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,51 @@ +image: registry.gitlab.com/kolanich-subgroups/docker-images/fixed_python:latest + +variables: + DOCKER_DRIVER: overlay2 + SAST_ANALYZER_IMAGE_TAG: latest + SAST_DISABLE_DIND: "true" + SAST_CONFIDENCE_LEVEL: 5 + CODECLIMATE_VERSION: latest + +include: + - template: SAST.gitlab-ci.yml + - template: Code-Quality.gitlab-ci.yml + - template: License-Management.gitlab-ci.yml + +build: + tags: + - shared + - linux + stage: build + variables: + GIT_DEPTH: "1" + PYTHONUSERBASE: ${CI_PROJECT_DIR}/python_user_packages + + before_script: + - export PATH="$PATH:$PYTHONUSERBASE/bin" # don't move into `variables` + - apt-get update + # todo: + #- apt-get -y install + #- pip3 install --upgrade + #- python3 ./fix_python_modules_paths.py + + script: + - python3 -m build -nw bdist_wheel + - mv ./dist/*.whl ./dist/sunxi_fex-0.CI-py3-none-any.whl + - pip3 install --upgrade ./dist/*.whl + - coverage run --source=sunxi_fex -m --branch pytest --junitxml=./rspec.xml ./tests/test.py + - coverage report -m + - coverage xml + + coverage: "/^TOTAL(?:\\s+\\d+){4}\\s+(\\d+%).+/" + + cache: + paths: + - $PYTHONUSERBASE + + artifacts: + paths: + - dist + reports: + junit: ./rspec.xml + cobertura: ./coverage.xml diff --git a/.reuse/dep5 b/.reuse/dep5 new file mode 100644 index 0000000..03bd34a --- /dev/null +++ b/.reuse/dep5 @@ -0,0 +1,10 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Source: https://example.com/jane/project + +Files: * +Copyright: 2021 KOLANICH +License: Unlicense + +Files: sunxi_fex/* +Copyright: 2021 KOLANICH +License: GPL-3.0-or-later diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/COPYING.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/Code_Of_Conduct.md b/Code_Of_Conduct.md new file mode 100644 index 0000000..bcaa2bf --- /dev/null +++ b/Code_Of_Conduct.md @@ -0,0 +1 @@ +No codes of conduct! \ No newline at end of file diff --git a/LICENSES/GPL-3.0-or-later.md b/LICENSES/GPL-3.0-or-later.md new file mode 100644 index 0000000..0c9476f --- /dev/null +++ b/LICENSES/GPL-3.0-or-later.md @@ -0,0 +1 @@ +../COPYING.md \ No newline at end of file diff --git a/LICENSES/Unlicense.md b/LICENSES/Unlicense.md new file mode 100644 index 0000000..7f6e5ae --- /dev/null +++ b/LICENSES/Unlicense.md @@ -0,0 +1,27 @@ +Unlicense (Public Domain) +============================ + +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to <> diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..20f0fa8 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include UNLICENSE +include *.md +include tests +include .editorconfig diff --git a/ReadMe.md b/ReadMe.md new file mode 100644 index 0000000..60b727a --- /dev/null +++ b/ReadMe.md @@ -0,0 +1,17 @@ +sunxi_fex.py +============ +~~[wheel (GHA via `nightly.link`)](https://nightly.link/KOLANICH-libs/sunxi_fex.py/workflows/CI/master/sunxi_fex-0.CI-py3-none-any.whl)~~ +~~[![GitHub Actions](https://github.com/KOLANICH-libs/sunxi_fex.py/workflows/CI/badge.svg)](https://github.com/KOLANICH-libs/sunxi_fex.py/actions/)~~ +[![Libraries.io Status](https://img.shields.io/librariesio/github/KOLANICH-libs/sunxi_fex.py.svg)](https://libraries.io/github/KOLANICH-libs/sunxi_fex.py) +[GPL-3.0-or-later](./COPYING.md) +[![Code style: antiflash](https://img.shields.io/badge/code%20style-antiflash-FFF.svg)](https://codeberg.org/KOLANICH-tools/antiflash.py) + +A library for parsing [sunxi FEX format](https://linux-sunxi.org/Fex_Guide). Implemented via Kaitai Struct spec. +And a CLI tool for reserializing the contents of fex files in a human-readable and human-editable format. + +License +======= + +Unlike my other libs, this one [is licensed](./COPYING.md) under GNU GPL v3 GPL-3.0-or-later or any later version. **This is only to satisfy https://github.com/linux-sunxi/sunxi-tools [GPL-2.0-or-later license ![license badge](https://img.shields.io/github/license/linux-sunxi/sunxi-tools)](https://github.com/linux-sunxi/sunxi-tools/blob/master/LICENSE.md)**, because the knowledge required to specify this format was reverse-engineered from source code (see doc-ref of the Kaitai Struct spec) of that free and open source tool. Also from that tool some principles of conversion back to `fex` were taken, namely the idea that `0xFFFFFFFF` must be `default` and the principle of generating names for ports. + +I am OK with relicensing my original contributions that are within this repo under [`Unlicense`](https://unlicense.org/), but I am not sure that the authors of [sunxi-tools](https://github.com/linux-sunxi/sunxi-tools) ([Alejandro Mery aka @amery](https://github.com/amery) and [@n1tehawk](https://github.com/n1tehawk)) are OK. They have chosen GPL, and the purpose of GPL is to be as viral as possible. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..fb0d1a9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,46 @@ +[build-system] +requires = ["setuptools>=61.2.0", "wheel", "setuptools_scm[toml]>=3.4.3", "kaitaiStructCompile[toml]"] +build-backend = "setuptools.build_meta" + +[project] +name = "sunxi_fex" +authors = [{name = "KOLANICH"}] +description = "A parser for sunxi fex format" +readme = "ReadMe.md" +keywords = ["sunxi_fex"] +license = {text = "GPL-3.0-or-later"} +classifiers = [ + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Development Status :: 4 - Beta", + "Environment :: Other Environment", + "Intended Audience :: Developers", + "License :: OSI Approved", + "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)", + "Operating System :: OS Independent", + "Topic :: Software Development :: Libraries :: Python Modules", +] +urls = {Homepage = "https://codeberg.org/KFmts/sunxi_fex.py"} +requires-python = ">=3.4" +dependencies = ["kaitaistruct"] +dynamic = ["version"] + +[tool.additional-dependencies] +cli = ["plumbum"] + +[tool.setuptools] +zip-safe = true +include-package-data = false + +[tool.setuptools.packages] +find = {namespaces = false} + +[tool.setuptools_scm] + +[tool.kaitai.repos."https://codeberg.org/KFmts/kaitai_struct_formats.git"."sunxi_fex"] +update = true +localPath = "kaitai_struct_formats" # rel to pyproject.toml dir +outputDir = "sunxi_fex/kaitai" # rel to localPath + +[tool.kaitai.repos."https://codeberg.org/KFmts/kaitai_struct_formats.git"."sunxi_fex".formats.sunxi_fex] +path = "firmware/sunxi_fex" diff --git a/samples/etalons/test.cbor b/samples/etalons/test.cbor new file mode 100644 index 0000000000000000000000000000000000000000..618b2a381f5d5639505eba349b3666fc517d0c56 GIT binary patch literal 316 zcma)%O%j4I429+A5^^~wHmSB2$}}m$4LpD+(9s*ZMxYB9jH7Rn)%WGiyP*)vU7x@R z7|jx*l0!#z(+V&_TQas1eCFLaYS literal 0 HcmV?d00001 diff --git a/samples/etalons/test.dts b/samples/etalons/test.dts new file mode 100644 index 0000000..5e6b103 --- /dev/null +++ b/samples/etalons/test.dts @@ -0,0 +1,53 @@ +/dts-v1/; + +/ { + soc@ { + test { + kaitai = "struct"; + version = <0x18894>; + is_awesome; + } + ports { + python { + data = <0x4>; + drive = <0x3>; + idx = <0x1>; + muxsel = <0x1>; + port = <0x1>; + pull = <0x2>; + }; + js { + data = <0xffffffff>; + drive = <0x3>; + idx = <0x1>; + muxsel = <0x1>; + port = <0x2>; + pull = <0x2>; + }; + scala { + data = <0xffffffff>; + drive = <0xffffffff>; + idx = <0x1>; + muxsel = <0x1>; + port = <0x3>; + pull = <0x2>; + }; + java { + data = <0xffffffff>; + drive = <0xffffffff>; + idx = <0x1>; + muxsel = <0x1>; + port = <0x4>; + pull = <0xffffffff>; + }; + rust { + data = <0xffffffff>; + drive = <0xffffffff>; + idx = <0x1>; + muxsel = <0xffffffff>; + port = <0xffff>; + pull = <0xffffffff>; + }; + } + }; +}; \ No newline at end of file diff --git a/samples/etalons/test.fex b/samples/etalons/test.fex new file mode 100644 index 0000000..b7d3664 --- /dev/null +++ b/samples/etalons/test.fex @@ -0,0 +1,12 @@ +[test] +kaitai = "struct" +version = 100500 +is_awesome = + +[ports] +python = port:PA01<1><2><3><4> +js = port:PB01<1><2><3> +scala = port:PC01<1><2> +java = port:PD01<1> +rust = port:power1 + diff --git a/samples/etalons/test.json b/samples/etalons/test.json new file mode 100644 index 0000000..c84deb6 --- /dev/null +++ b/samples/etalons/test.json @@ -0,0 +1,49 @@ +{ + "test": { + "kaitai": "struct", + "version": 100500, + "is_awesome": true + }, + "ports": { + "python": { + "data": 4, + "drive": 3, + "idx": 1, + "muxsel": 1, + "port": 1, + "pull": 2 + }, + "js": { + "data": 4294967295, + "drive": 3, + "idx": 1, + "muxsel": 1, + "port": 2, + "pull": 2 + }, + "scala": { + "data": 4294967295, + "drive": 4294967295, + "idx": 1, + "muxsel": 1, + "port": 3, + "pull": 2 + }, + "java": { + "data": 4294967295, + "drive": 4294967295, + "idx": 1, + "muxsel": 1, + "port": 4, + "pull": 4294967295 + }, + "rust": { + "data": 4294967295, + "drive": 4294967295, + "idx": 1, + "muxsel": 4294967295, + "port": 65535, + "pull": 4294967295 + } + } +} \ No newline at end of file diff --git a/samples/etalons/test.msgpack b/samples/etalons/test.msgpack new file mode 100644 index 0000000000000000000000000000000000000000..a4eedb417c57a63138abd4870d5d21bacbb6b163 GIT binary patch literal 316 zcma)%K@Ng25JfF;Pcwlg77HbvDdJY6;Q*dMOHI6nYq?T|cHx2;{fk+>H$VSii6b4| z76gHCNZRCdZ@EUH>T$*T%R}HAb{tj3pF^WG;mI|7+Nk<$3n0jbLW`ECH&JxVRi;BO znVrGu8Yz=&iIE)rl&^FW=>c<)un>Z~tVp9|OKAUgvfzY=RvV<>U6Gw9y}bX}Zx?-} AxBvhE literal 0 HcmV?d00001 diff --git a/samples/etalons/test.pon b/samples/etalons/test.pon new file mode 100644 index 0000000..82da1ca --- /dev/null +++ b/samples/etalons/test.pon @@ -0,0 +1 @@ +OrderedDict([('test', {'kaitai': 'struct', 'version': 100500, 'is_awesome': True}), ('ports', {'python': OrderedDict([('data', 4), ('drive', 3), ('idx', 1), ('muxsel', 1), ('port', 1), ('pull', 2)]), 'js': OrderedDict([('data', 4294967295), ('drive', 3), ('idx', 1), ('muxsel', 1), ('port', 2), ('pull', 2)]), 'scala': OrderedDict([('data', 4294967295), ('drive', 4294967295), ('idx', 1), ('muxsel', 1), ('port', 3), ('pull', 2)]), 'java': OrderedDict([('data', 4294967295), ('drive', 4294967295), ('idx', 1), ('muxsel', 1), ('port', 4), ('pull', 4294967295)]), 'rust': OrderedDict([('data', 4294967295), ('drive', 4294967295), ('idx', 1), ('muxsel', 4294967295), ('port', 65535), ('pull', 4294967295)])})]) \ No newline at end of file diff --git a/samples/etalons/test.ubj b/samples/etalons/test.ubj new file mode 100644 index 0000000000000000000000000000000000000000..ed06ac8cdbed8e90e7a9638c3bd9ecf475d8d9b2 GIT binary patch literal 427 zcmbV|!485j42A^;CO(@t?b$T2#Nl9M?GQtD_W^ug9cUmS5)*sbvh@49{yhkm#64se zRE+8X8L@Ra!?u-{l&SS5x<6p2=!92ErjkbwX=5x?fSMbhP2GbikP!r=g;lMD1QJzr z5J6VCj-(DZF(BjVw1(J2Tn53&?Kh#Gp?>0V(0uTea@4qDn2js{NM?~JvHja4-kxcm Z2Vvb1=hwxiwnaSi`018(+mg|ei1sB> zfr>(2vqwqB2F?ySTIV@Q5!LVx$X*$*Od4!ql~}WOZ0tD+c5n(T!$)<|Y)|?>+Amy9 zu3PCrHZ=TBfz-8aia!>J{4CO%YACjVRR3ioAUqp5jgg4YA})4Qzo>|NjgcH cm&~II{jdH;i2tpNCLw2{zAABF_4pO*2S!LpqyPW_ literal 0 HcmV?d00001 diff --git a/sunxi_fex/__init__.py b/sunxi_fex/__init__.py new file mode 100644 index 0000000..8f5a120 --- /dev/null +++ b/sunxi_fex/__init__.py @@ -0,0 +1 @@ +from .kaitai.sunxi_fex import * diff --git a/sunxi_fex/__main__.py b/sunxi_fex/__main__.py new file mode 100755 index 0000000..2612e10 --- /dev/null +++ b/sunxi_fex/__main__.py @@ -0,0 +1,273 @@ +#!/usr/bin/env python3 + +import argparse +import configparser +import sys +from io import StringIO +from abc import ABC, abstractmethod + +from kaitaistruct import KaitaiStruct +from plumbum import cli + +from collections import OrderedDict + +from . import SunxiFex + +from pathlib import Path + +indent = "\t" +opener = " {" +closer = "}" +terminator = ";" +assignment = " = " +rootNode = "/" +closerWithTerminator = closer + terminator + +Type = SunxiFex.Level2Node.Level3Node.Type + + +def ksReprGen(struct): + return ((str(k), getattr(struct, k)) for k in dir(struct) if k[0] != "_" and not hasattr(KaitaiStruct, k) and not isinstance(getattr(struct, k), type)) + + +class Printer: + @abstractmethod + def __call__(this, parsed): + raise NotImplementedError + + EXT = None + + +class FdtPrinter(Printer): + EXT = "dts" + + @classmethod + def arrayRepr(cls, v): + return "<" + ", ".join(hex(el) for el in v) + ">" + + @classmethod + def u32Repr(cls, v): + return cls.arrayRepr((v,)) + + @classmethod + def gpioU32Repr(cls, v): + res = [opener] + if v.name: + res.append(indent * 4 + "name" + cls.fdtReprByType(v.name) + terminator) + for k, v in ksReprGen(v.descriptor): + res.append(indent * 4 + k + cls.fdtReprByType(v) + terminator) + res.append(indent * 3 + closer) + return "\n".join(res) + + reprTypeMapper = { + str: lambda cls, v: assignment + '"' + v.replace('"', '\\"') + '"', + int: lambda cls, v: assignment + cls.u32Repr(v), + list: lambda cls, v: assignment + cls.arrayRepr(v) + } + + @classmethod + def fdtReprByType(cls, v): + return cls.reprTypeMapper[type(v)](cls, v) + + typPrinterMapping = { + Type.string: reprTypeMapper[str], + Type.u32: reprTypeMapper[int], + Type.empty: lambda cls, v: "", + Type.gpio_u32: lambda cls, v: cls.gpioU32Repr(v), + } + + @classmethod + def fdtReprByTypeEnum(cls, typ, v): + return cls.typPrinterMapping[typ](cls, v) + + @classmethod + def _generate(cls, parsed): + yield "/dts-v1/;" + yield "" + yield rootNode + opener + + yield indent + "soc@" + opener + for l2el in parsed.level_2: + yield indent * 2 + l2el.key + opener + for l3el in l2el.level_3: + # yield "#" + indent * 3 + l3el.key, l3el.type + yield indent * 3 + l3el.key + cls.fdtReprByTypeEnum(l3el.type, l3el.value) + terminator + yield indent * 2 + closer + + yield indent + closerWithTerminator + yield closerWithTerminator + + @classmethod + def __call__(cls, parsed): + return "\n".join(cls._generate(parsed)) + + +class FexPrinter(Printer): + EXT = "fex" + + @classmethod + def filterGpioValue(cls, v): + if v == 0xFFFFFFFF: + return "default" + else: + return str(v) + + @classmethod + def gpioU32Repr(cls, v): + d = v.descriptor + + if v.name: + name = v.name + else: + pn = str(d.idx) + if d.port != 0xFFFF: + pLetter = chr(ord("A") + d.port - 1) + pn = "0" * (2 - len(pn)) + pn + name = "P" + pLetter + pn + else: + name = "power" + pn + + return "port:" + name + "<" + cls.filterGpioValue(d.muxsel) + "><" + cls.filterGpioValue(d.pull) + "><" + cls.filterGpioValue(d.drive) + "><" + cls.filterGpioValue(d.data) + ">" + + typPrinterMapping = { + Type.string: lambda cls, v: '"' + v.replace('"', '\\"') + '"', + Type.empty: lambda cls, v: "", + Type.gpio_u32: lambda cls, v: cls.gpioU32Repr(v), + } + + @classmethod + def fdtReprByTypeEnum(cls, typ, v): + return cls.typPrinterMapping.get(typ, lambda cls, v: v)(cls, v) + + @classmethod + def __call__(cls, parsed): + ini = configparser.ConfigParser() + + for l2el in parsed.level_2: + l2ini = ini[l2el.key] = OrderedDict((l3el.key, cls.fdtReprByTypeEnum(l3el.type, l3el.value)) for l3el in l2el.level_3) + with StringIO() as f: + ini.write(f) + return f.getvalue() + + +defaultFileName = "./soc-cfg" + +printers = OrderedDict(( + ("fex", FexPrinter), + ("fdt", FdtPrinter) +)) + +class TransformerzPrinter(Printer): + TRANSFORMER = None + + @classmethod + def gpioU32Repr(cls, v): + return OrderedDict(ksReprGen(v.descriptor)) + + @classmethod + def fdtReprByTypeEnum(cls, typ, v): + if typ == Type.gpio_u32: + return cls.gpioU32Repr(v) + elif typ == Type.empty: + return True + return v + + @classmethod + def __call__(cls, parsed): + dic = OrderedDict() + + for l2el in parsed.level_2: + l2ini = dic[l2el.key] = {l3el.key: cls.fdtReprByTypeEnum(l3el.type, l3el.value) for l3el in l2el.level_3} + + return cls.TRANSFORMER.unprocess(dic) + + +def transformerzPrinterFactory(transformer: "transformerz.core.Transformer") -> TransformerzPrinter: + class ThisPrinter(TransformerzPrinter): + TRANSFORMER = transformer + + @property + def EXT(self): + return self.TRANSFORMER.fileExtension + + return ThisPrinter + + +try: + from transformerz.serialization.json import jsonFancySerializer +except ImportError: + pass +else: + printers["json"] = transformerzPrinterFactory(jsonFancySerializer) + +try: + from transformerz.serialization.yaml import yamlSerializer +except ImportError: + pass +else: + printers["yaml"] = transformerzPrinterFactory(yamlSerializer) + +try: + from transformerz.serialization.pon import ponSerializer +except ImportError: + pass +else: + class PonSerializer(transformerzPrinterFactory(ponSerializer)): + EXT = "pon" + + printers["pon"] = PonSerializer + +try: + from transformerz.serialization.cbor import cborSerializer +except ImportError: + pass +else: + printers["cbor"] = transformerzPrinterFactory(cborSerializer) + +try: + from transformerz.serialization.msgpack import msgpackSerializer +except ImportError: + pass +else: + printers["msgpack"] = transformerzPrinterFactory(msgpackSerializer) + +try: + from transformerz.serialization.ubjson import ubjsonSerializer +except ImportError: + pass +else: + printers["ubjson"] = transformerzPrinterFactory(ubjsonSerializer) + + +class CLI(cli.Application): + """fex reserializer""" + + printerIds = cli.SwitchAttr("-O", cli.Set(*printers.keys(), csv=True), default="fex", help="Type of output") + + def main(self, *files: cli.ExistingFile): + + for pI in self.printerIds: + printerCtor = printers[pI] + printer = printerCtor() + + if not files: + print("Assumming that the data is in", defaultFileName, file=sys.stderr) + files = (defaultFileName,) + + for f in files: + f = Path(f) + parsed = SunxiFex.from_file(f) + + stem = f.name if f.suffix.lower() != ".bin" else f.stem + + ofn = f.parent / (stem + "." + printer.EXT) + r = printer(parsed) + + if isinstance(r, str): + ofn.write_text(r) + else: + ofn.write_bytes(r) + + +if __name__ == "__main__": + CLI.run() diff --git a/sunxi_fex/kaitai/__init__.py b/sunxi_fex/kaitai/__init__.py new file mode 100644 index 0000000..e69de29