amd-ucode-patch 1.0.0__tar.gz

amd_ucode_patch-1.0.0/.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

amd_ucode_patch-1.0.0/.github/workflows/build.yml

@@ -0,0 +1,61 @@
+name: Build
+on: [push, pull_request]
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - "pypy3.11"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        - "3.13"
+        - "3.14"
+  
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip 
+          pip install hatch
+
+      - name: Build
+        run: hatch build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        with:
+          name: python_${{ matrix.python-version }}
+          path: dist/
+
+
+  publish_pypi:
+    name: Publish to PyPi
+    needs: [build]
+    if: contains(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/amd-ucode-patch
+    permissions:
+      id-token: write
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+      with:
+        name: python_3.13
+        path: dist/
+
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # release/v1

amd_ucode_patch-1.0.0/.github/workflows/codeql.yml

@@ -0,0 +1,91 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '27 22 * * 0'
+
+permissions: read-all
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: actions
+          build-mode: none
+        - language: python
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
+
+    # Add any setup steps before running the `github/codeql-action/init` action.
+    # This includes steps like installing compilers or runtimes (`actions/setup-node`
+    # or others). This is typically only required for manual builds.
+    # - name: Setup runtime (example)
+    #   uses: actions/setup-example@v1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # 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.
+
+        # For more 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
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ 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: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4
+      with:
+        category: "/language:${{matrix.language}}"

amd_ucode_patch-1.0.0/.github/workflows/scorecard.yml

@@ -0,0 +1,43 @@
+name: Scorecard
+
+on:
+  branch_protection_rule:
+  schedule:
+    - cron: '27 22 * * 0'
+  push:
+    branches: [ "main" ]
+
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+
+      - name: Run analysis
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      - name: Upload to code-scanning
+        uses: github/codeql-action/upload-sarif@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2
+        with:
+          sarif_file: results.sarif

amd_ucode_patch-1.0.0/.gitignore

@@ -0,0 +1,2 @@
+# Python
+__pycache__/

amd_ucode_patch-1.0.0/LICENSE.md

@@ -0,0 +1,360 @@
+# GNU GENERAL PUBLIC LICENSE
+
+Version 2, June 1991
+
+    Copyright (C) 1989, 1991 Free Software Foundation, Inc.  
+    <https://fsf.org/>
+
+    Everyone is permitted to copy and distribute verbatim copies
+    of this license document, but changing it is not allowed.
+
+## Preamble
+
+The licenses for most software are designed to take away your freedom
+to share and change it. By contrast, the GNU General Public License is
+intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if
+you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on,
+we want its recipients to know that what they have is not the
+original, so that any problems introduced by others will not reflect
+on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at
+all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+## TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+**0.** This License applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License. The
+"Program", below, refers to any such program or work, and a "work
+based on the Program" means either the Program or any derivative work
+under copyright law: that is to say, a work containing the Program or
+a portion of it, either verbatim or with modifications and/or
+translated into another language. (Hereinafter, translation is
+included without limitation in the term "modification".) Each licensee
+is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the Program
+(independent of having been made by running the Program). Whether that
+is true depends on what the Program does.
+
+**1.** You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a
+fee.
+
+**2.** You may modify your copy or copies of the Program or any
+portion of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+  
+**a)** You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+
+  
+**b)** You must cause any work that you distribute or publish, that in
+whole or in part contains or is derived from the Program or any part
+thereof, to be licensed as a whole at no charge to all third parties
+under the terms of this License.
+
+  
+**c)** If the modified program normally reads commands interactively
+when run, you must cause it, when started running for such interactive
+use in the most ordinary way, to print or display an announcement
+including an appropriate copyright notice and a notice that there is
+no warranty (or else, saying that you provide a warranty) and that
+users may redistribute the program under these conditions, and telling
+the user how to view a copy of this License. (Exception: if the
+Program itself is interactive but does not normally print such an
+announcement, your work based on the Program is not required to print
+an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+**3.** You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+  
+**a)** Accompany it with the complete corresponding machine-readable
+source code, which must be distributed under the terms of Sections 1
+and 2 above on a medium customarily used for software interchange; or,
+
+  
+**b)** Accompany it with a written offer, valid for at least three
+years, to give any third party, for a charge no more than your cost of
+physically performing source distribution, a complete machine-readable
+copy of the corresponding source code, to be distributed under the
+terms of Sections 1 and 2 above on a medium customarily used for
+software interchange; or,
+
+  
+**c)** Accompany it with the information you received as to the offer
+to distribute corresponding source code. (This alternative is allowed
+only for noncommercial distribution and only if you received the
+program in object code or executable form with such an offer, in
+accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+**4.** You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt otherwise
+to copy, modify, sublicense or distribute the Program is void, and
+will automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+**5.** You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+**6.** Each time you redistribute the Program (or any work based on
+the Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+**7.** If, as a consequence of a court judgment or allegation of
+patent infringement or for any other reason (not limited to patent
+issues), conditions are imposed on you (whether by court order,
+agreement or otherwise) that contradict the conditions of this
+License, they do not excuse you from the conditions of this License.
+If you cannot distribute so as to satisfy simultaneously your
+obligations under this License and any other pertinent obligations,
+then as a consequence you may not distribute the Program at all. For
+example, if a patent license would not permit royalty-free
+redistribution of the Program by all those who receive copies directly
+or indirectly through you, then the only way you could satisfy both it
+and this License would be to refrain entirely from distribution of the
+Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+**8.** If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+**9.** The Free Software Foundation may publish revised and/or new
+versions of the General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Program does not specify a
+version number of this License, you may choose any version ever
+published by the Free Software Foundation.
+
+**10.** If you wish to incorporate parts of the Program into other
+free programs whose distribution conditions are different, write to
+the author to ask for permission. For software which is copyrighted by
+the Free Software Foundation, write to the Free Software Foundation;
+we sometimes make exceptions for this. Our decision will be guided by
+the two goals of preserving the free status of all derivatives of our
+free software and of promoting the sharing and reuse of software
+generally.
+
+**NO WARRANTY**
+
+**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+## How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    one line to give the program's name and an idea of what it does.
+    Copyright (C) yyyy  name of author
+
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation; either version 2
+    of the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+    type `show w'.  This is free software, and you are welcome
+    to redistribute it under certain conditions; type `show c' 
+    for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than \`show w' and
+\`show c'; they could even be mouse-clicks or menu items--whatever
+suits your program.
+
+You should also get your employer (if you work as a programmer) or
+your school, if any, to sign a "copyright disclaimer" for the program,
+if necessary. Here is a sample; alter the names:
+
+    Yoyodyne, Inc., hereby disclaims all copyright
+    interest in the program `Gnomovision'
+    (which makes passes at compilers) written 
+    by James Hacker.
+
+    signature of Moe Ghoul, 1 April 1989
+    Moe Ghoul, President of Vice
+
+This General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library,
+you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+[GNU Lesser General Public
+License](https://www.gnu.org/licenses/lgpl.html) instead of this
+License.

amd_ucode_patch-1.0.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: amd-ucode-patch
+Version: 1.0.0
+Summary: A Python library for parsing and interpreting AMD microcode patch files
+Project-URL: Homepage, https://github.com/amd-zenith/amd-ucode-patch
+Project-URL: Repository, https://github.com/amd-zenith/amd-ucode-patch
+Project-URL: Issues, https://github.com/amd-zenith/amd-ucode-patch/issues
+Author: Kaya Erchiran
+Author-email: Antonio Vázquez Blanco <antoniovazquezblanco@gmail.com>
+License-Expression: GPL-2.0-or-later
+License-File: LICENSE.md
+Keywords: amd,microcode,parser,patch,ucode,x86
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: rich
+Description-Content-Type: text/markdown
+
+# AMD Microcode Patch
+
+[![Build](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/build.yml/badge.svg)](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/build.yml)
+[![CodeQL](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/codeql.yml/badge.svg)](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/codeql.yml)
+[![PyPI version](https://img.shields.io/pypi/v/amd-ucode-patch.svg)](https://pypi.org/project/amd-ucode-patch/)
+[![Python versions](https://img.shields.io/pypi/pyversions/amd-ucode-patch.svg)](https://pypi.org/project/amd-ucode-patch/)
+[![Snyk package health](https://img.shields.io/badge/Snyk-package%20health-4C4A73?logo=snyk&logoColor=white)](https://snyk.io/advisor/python/amd-ucode-patch)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/amd-zenith/amd-ucode-patch/badge)](https://scorecard.dev/viewer/?uri=github.com/amd-zenith/amd-ucode-patch)
+
+A Python library for parsing and interpreting AMD microcode patch files.
+
+## Installation
+
+```bash
+pip install amd-ucode-patch
+```
+
+## Command line tools
+
+Installing the package provides the following command line tools.
+
+### `amd_ucode_patch_info`
+
+Inspect one or more AMD microcode patch files and print their header
+information as a table.
+
+```bash
+amd_ucode_patch_info <files...> [-f {text,md,csv}]
+```
+
+Arguments:
+
+- `files`: One or more patch files to inspect. Glob patterns (e.g. `*.bin` or `**/*.bin`) are expanded automatically.
+- `-f`, `--format`: Output format. One of:
+  - `text` (default): A table rendered for the terminal.
+  - `md`: A Markdown table.
+  - `csv`: Comma separated values.
+
+For every patch file the following fields are reported: file name, date, update revision, loader ID, processor revision, CPUID, family, model, stepping, autorun, encrypted and body size.
+
+## Library usage
+
+The package can also be used programmatically:
+
+```python
+from amd_ucode_patch.parse import ucode_patch_parse
+
+patch = ucode_patch_parse("firmware.bin")
+print(patch.header.cpuid_str)
+print(patch.header.update_revision)
+```

amd_ucode_patch-1.0.0/README.md

@@ -0,0 +1,51 @@
+# AMD Microcode Patch
+
+[![Build](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/build.yml/badge.svg)](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/build.yml)
+[![CodeQL](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/codeql.yml/badge.svg)](https://github.com/amd-zenith/amd-ucode-patch/actions/workflows/codeql.yml)
+[![PyPI version](https://img.shields.io/pypi/v/amd-ucode-patch.svg)](https://pypi.org/project/amd-ucode-patch/)
+[![Python versions](https://img.shields.io/pypi/pyversions/amd-ucode-patch.svg)](https://pypi.org/project/amd-ucode-patch/)
+[![Snyk package health](https://img.shields.io/badge/Snyk-package%20health-4C4A73?logo=snyk&logoColor=white)](https://snyk.io/advisor/python/amd-ucode-patch)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/amd-zenith/amd-ucode-patch/badge)](https://scorecard.dev/viewer/?uri=github.com/amd-zenith/amd-ucode-patch)
+
+A Python library for parsing and interpreting AMD microcode patch files.
+
+## Installation
+
+```bash
+pip install amd-ucode-patch
+```
+
+## Command line tools
+
+Installing the package provides the following command line tools.
+
+### `amd_ucode_patch_info`
+
+Inspect one or more AMD microcode patch files and print their header
+information as a table.
+
+```bash
+amd_ucode_patch_info <files...> [-f {text,md,csv}]
+```
+
+Arguments:
+
+- `files`: One or more patch files to inspect. Glob patterns (e.g. `*.bin` or `**/*.bin`) are expanded automatically.
+- `-f`, `--format`: Output format. One of:
+  - `text` (default): A table rendered for the terminal.
+  - `md`: A Markdown table.
+  - `csv`: Comma separated values.
+
+For every patch file the following fields are reported: file name, date, update revision, loader ID, processor revision, CPUID, family, model, stepping, autorun, encrypted and body size.
+
+## Library usage
+
+The package can also be used programmatically:
+
+```python
+from amd_ucode_patch.parse import ucode_patch_parse
+
+patch = ucode_patch_parse("firmware.bin")
+print(patch.header.cpuid_str)
+print(patch.header.update_revision)
+```

amd_ucode_patch-1.0.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "amd-ucode-patch"
+dynamic = ["version"]
+authors = [
+  { name="Antonio Vázquez Blanco", email="antoniovazquezblanco@gmail.com" },
+  { name="Kaya Erchiran" },
+]
+description = "A Python library for parsing and interpreting AMD microcode patch files"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "GPL-2.0-or-later"
+license-files = ["LICENSE.md"]
+keywords = ["amd", "microcode", "ucode", "patch", "parser", "x86"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Hardware",
+    "Topic :: Utilities",
+]
+dependencies = [
+  "rich",
+]
+
+[project.urls]
+Homepage = "https://github.com/amd-zenith/amd-ucode-patch"
+Repository = "https://github.com/amd-zenith/amd-ucode-patch"
+Issues = "https://github.com/amd-zenith/amd-ucode-patch/issues"
+
+[project.scripts]
+amd_ucode_patch_info = "amd_ucode_patch.cli_info:main"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/amd_ucode_patch"]

amd_ucode_patch-1.0.0/src/amd_ucode_patch/banner.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+'''
+Banner for the CLI tools.
+'''
+
+BANNER = r'''
+ _____ _____ ____         _____       _     
+|  _  |     |    \    _ _|     |___ _| |___ 
+|     | | | |  |  |  | | |   --| . | . | -_|
+|__|__|_|_|_|____/   |___|_____|___|___|___|
+         _____     _       _                
+        |  _  |___| |_ ___| |_              
+        |   __| .'|  _|  _|   |             
+        |__|  |__,|_| |___|_|_|             
+'''

amd_ucode_patch-1.0.0/src/amd_ucode_patch/cli_info.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+'''
+A command line tool to print information about AMD uCode patch files.
+'''
+
+import glob
+import argparse
+from pathlib import Path
+from rich import box
+from rich.console import Console
+from rich.table import Table
+from .banner import BANNER
+from .parse import ucode_patch_parse
+
+COLS = ["File", "Date", "Upd. Rev", "Loader ID", "Proc. Rev", "CPUID", "Family", "Model", "Stepping", "Autorun", "Encrypted", "Body size"]
+
+
+def expand_paths(patterns):
+    for pattern in patterns:
+        matches = sorted(glob.glob(pattern, recursive=True))
+        if not matches:
+            yield Path(pattern)
+            continue
+        for match in matches:
+            yield Path(match)
+
+
+def _row_fields(path, patch):
+    return (
+        str(path),
+        f"{patch.header.year:04d}-{patch.header.month:02d}-{patch.header.day:02d}",
+        f"{patch.header.update_revision:08x}",
+        f"{patch.header.loader_id:04x}",
+        f"{patch.header.processor_rev_id:04x}",
+        patch.header.cpuid_str,
+        f"0x{patch.header.cpu_family:02x}",
+        f"0x{patch.header.cpu_model:02x}",
+        f"0x{patch.header.cpu_stepping:02x}",
+        f"{patch.verified_header.autorun if patch.verified_header is not None else ''}",
+        f"{patch.verified_header.encrypted if patch.verified_header is not None else ''}",
+        f"{len(patch.body)}",
+    )
+
+def print_table(console: Console, paths, format):
+    table = Table(*COLS, box=format)
+    for path in paths:
+        try:
+            patch = ucode_patch_parse(path)
+            table.add_row(*_row_fields(path, patch))
+        except Exception as e:
+            console.log(f"Error parsing {path}: {e}")
+    console.print(table)
+
+
+def print_csv(console: Console, paths):
+    console.print(",".join(COLS))
+    for path in paths:
+        patch = ucode_patch_parse(path)
+        console.print(",".join(_row_fields(path, patch)))
+
+
+def main():
+    console = Console()
+    console.print(BANNER, highlight=False)
+
+    parser = argparse.ArgumentParser(description="Inspect AMD microcode patch files.")
+    parser.add_argument("files", nargs="+", help="Patch files to inspect")
+    parser.add_argument("-f", "--format", choices=["text", "md", "csv"], default="text")
+    args = parser.parse_args()
+
+    paths = expand_paths(args.files)
+    if args.format == "text":
+        print_table(console, paths, box.HEAVY_HEAD)
+    elif args.format == "md":
+        print_table(console, paths, box.MARKDOWN)
+    elif args.format == "csv":
+        print_csv(console, paths)
+
+
+if __name__ == "__main__":
+    main()

amd_ucode_patch-1.0.0/src/amd_ucode_patch/naming.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+from .structures.ucode_patch import UcodePatch
+
+def ucode_patch_name(patch: UcodePatch, enc_override=None) -> str:
+    # Format should be:
+    # family<family>_cpuid<cpuid>_rev<revision>_date<yyyymmdd>_enc<ee>.bin
+    # The _enc<ee> suffix is only present when a verified header exists.
+    name = f"family{patch.header.cpu_family:02x}_cpuid{patch.header.cpuid_str}_rev{patch.header.update_revision:08x}_date{patch.header.year:04}{patch.header.month:02}{patch.header.day:02}"
+    if patch.verified_header is not None:
+        enc = patch.verified_header.encrypted if enc_override is None else enc_override
+        name += f"_enc{enc:02}"
+    name += ".bin"
+    return name

amd_ucode_patch-1.0.0/src/amd_ucode_patch/parse.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+from pathlib import Path
+from .structures.ucode_patch import UcodePatch
+
+def ucode_patch_parse(file: Path) -> UcodePatch:
+    with file.open("rb") as f:
+        return UcodePatch.from_bytes(f.read())

amd_ucode_patch-1.0.0/src/amd_ucode_patch/structures/ucode_patch.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+from dataclasses import dataclass
+from .ucode_patch_header import UcodePatchHeader
+from .verified_header import VerifiedHeader
+
+
+@dataclass
+class UcodePatch:
+    header: UcodePatchHeader
+    signature: bytes
+    public_key: bytes
+    verified_header: VerifiedHeader | None
+    body: bytes
+
+
+    @staticmethod
+    def from_bytes(buf: bytes) -> "UcodePatch":
+        header = UcodePatchHeader.from_bytes(buf)
+        verified_header = None if header.cpu_family < 0x16 else VerifiedHeader.from_bytes(buf[800::])
+        body_start_pos = UcodePatchHeader.SIZE + 256 + 512 + (0 if verified_header is None else VerifiedHeader.SIZE)
+        return UcodePatch(
+            header=header,
+            signature=buf[UcodePatchHeader.SIZE:UcodePatchHeader.SIZE+256],
+            public_key=buf[UcodePatchHeader.SIZE+256:UcodePatchHeader.SIZE+256+512],
+            verified_header=verified_header,
+            body=buf[body_start_pos::]
+        )

amd_ucode_patch-1.0.0/src/amd_ucode_patch/structures/ucode_patch_header.py

@@ -0,0 +1,126 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import struct
+from dataclasses import dataclass
+
+def _weird_hex_as_dec(x: int) -> int:
+    return int(f"{x:x}", 10)
+
+
+def _dec_as_weird_hex(x: int) -> int:
+    return int(str(x), 16)
+
+
+@dataclass
+class UcodePatchHeader:
+    '''
+    https://github.com/torvalds/linux/blob/3544d5ce36f403db6e5c994f526101c870ffe9fe/arch/x86/kernel/cpu/microcode/amd.c#L70
+    
+    Original structure:
+    struct microcode_header_amd {
+        u32	data_code;
+        u32	patch_id;
+        u16	mc_patch_data_id;
+        u8	mc_patch_data_len;
+        u8	init_flag;
+        u32	mc_patch_data_checksum;
+        u32	nb_dev_id;
+        u32	sb_dev_id;
+        u16	processor_rev_id;
+        u8	nb_rev_id;
+        u8	sb_rev_id;
+        u8	bios_api_rev;
+        u8	reserved1[3];
+        u32	match_reg[8];
+    } __packed;
+
+    data_code is in reality a date. We split that into u16, u8, u8.
+    patch_id is referred to as revision in many other places.
+    '''
+    FMT = "<HBB I HBB I II H BBBBBB"
+    SIZE = struct.calcsize(FMT)
+
+    year: int
+    day: int
+    month: int
+    update_revision: int
+    loader_id: int
+    unk0: int
+    unk1: int
+    unk2: int
+    unk3: int
+    unk4: int
+    processor_rev_id: int
+    unk5: int
+    unk6: int
+    unk7: int
+    unk8: int
+    unk9: int
+    unk10: int
+
+    @property
+    def cpu_family(self) -> int:
+        return 0xf + (self.processor_rev_id >> 12)
+
+    @property
+    def cpu_model(self) -> int:
+        return (self.processor_rev_id >> 4) & 0xf
+    
+    @property
+    def cpu_stepping(self) -> int:
+        return self.processor_rev_id & 0xf
+
+    @property
+    def cpuid_str(self) -> str:
+        hi = (self.processor_rev_id >> 8) & 0xFF
+        lo = self.processor_rev_id & 0xFF
+        return f"00{hi:02X}0F{lo:02X}"
+
+    @staticmethod
+    def from_bytes(buf: bytes) -> "UcodePatchHeader":
+        if len(buf) < UcodePatchHeader.SIZE:
+            raise ValueError("not enough bytes for AMD header")
+        chunk = buf[0:UcodePatchHeader.SIZE]
+        vals = struct.unpack(UcodePatchHeader.FMT, chunk)
+        return UcodePatchHeader(
+            year=_weird_hex_as_dec(vals[0]),
+            day=_weird_hex_as_dec(vals[1]),
+            month=_weird_hex_as_dec(vals[2]),
+            update_revision=vals[3],
+            loader_id=vals[4],
+            unk0=vals[5],
+            unk1=vals[6],
+            unk2=vals[7],
+            unk3=vals[8],
+            unk4=vals[9],
+            processor_rev_id=vals[10],
+            unk5=vals[11],
+            unk6=vals[12],
+            unk7=vals[13],
+            unk8=vals[14],
+            unk9=vals[15],
+            unk10=vals[16],
+        )
+
+    def to_bytes(self) -> bytes:
+        return struct.pack(
+            UcodePatchHeader.FMT,
+            _dec_as_weird_hex(self.year),
+            _dec_as_weird_hex(self.day),
+            _dec_as_weird_hex(self.month),
+            self.update_revision,
+            self.loader_id,
+            self.unk0,
+            self.unk1,
+            self.unk2,
+            self.unk3,
+            self.unk4,
+            self.processor_rev_id,
+            self.unk5,
+            self.unk6,
+            self.unk7,
+            self.unk8,
+            self.unk9,
+            self.unk10,
+        )

amd_ucode_patch-1.0.0/src/amd_ucode_patch/structures/verified_header.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import struct
+from dataclasses import dataclass
+
+
+
+@dataclass
+class VerifiedHeader:
+    FMT = "<BB BB I"
+    SIZE = struct.calcsize(FMT)
+
+    autorun: int
+    encrypted: int
+    unk0: int
+    unk1: int
+    update_revision: int
+
+    @staticmethod
+    def from_bytes(buf: bytes) -> "VerifiedHeader":
+        if len(buf) < VerifiedHeader.SIZE:
+            raise ValueError("not enough bytes for AMD verified header")
+        chunk = buf[0:VerifiedHeader.SIZE]
+        vals = struct.unpack(VerifiedHeader.FMT, chunk)
+        return VerifiedHeader(
+            autorun=vals[0],
+            encrypted=vals[1],
+            unk0=vals[2],
+            unk1=vals[3],
+            update_revision=vals[4],
+        )
+
+    def to_bytes(self) -> bytes:
+        return struct.pack(
+            VerifiedHeader.FMT,
+            self.autorun,
+            self.encrypted,
+            self.unk0,
+            self.unk1,
+            self.update_revision,
+        )