[ { "path": ".clang-format", "content": "# clang-format configuration file. Intended for clang-format >= 14.\n#\n# For more information, see:\n#\n# Documentation/process/clang-format.rst\n# https://clang.llvm.org/docs/ClangFormat.html\n# https://clang.llvm.org/docs/ClangFormatStyleOptions.html\n#\n---\nAlignAfterOpenBracket: AlwaysBreak\nAlignArrayOfStructures: None\nAlignConsecutiveAssignments: false\nAlignConsecutiveDeclarations: false\nAlignConsecutiveMacros: true\nAlignEscapedNewlines: Left\nAlignOperands: DontAlign\nAlignTrailingComments: true\nAllowAllArgumentsOnNextLine: false\nAllowAllParametersOfDeclarationOnNextLine: false\nAllowShortBlocksOnASingleLine: true\nAllowShortCaseLabelsOnASingleLine: false\nAllowShortFunctionsOnASingleLine: None\nAllowShortIfStatementsOnASingleLine: false\nAllowShortLoopsOnASingleLine: false\nAlwaysBreakAfterDefinitionReturnType: None\nAlwaysBreakAfterReturnType: None\nAlwaysBreakBeforeMultilineStrings: false\nAttributeMacros: ['ADDAPI', 'ADDCALL']\nBinPackArguments: false\nBinPackParameters: false\nBraceWrapping:\n AfterControlStatement: false\n AfterEnum: false\n AfterFunction: true\n AfterStruct: false\n AfterUnion: false\n BeforeElse: false\n IndentBraces: false\n SplitEmptyFunction: true\n SplitEmptyRecord: true\nBreakBeforeBinaryOperators: None\nBreakBeforeBraces: Custom\nBreakBeforeTernaryOperators: false\nBreakStringLiterals: false\nColumnLimit: 90\nContinuationIndentWidth: 8\nDerivePointerAlignment: false\nDisableFormat: false\nExperimentalAutoDetectBinPacking: false\nIncludeBlocks: Preserve\nIncludeCategories:\n - Regex: '.*'\n Priority: 1\nIndentCaseLabels: false\nIndentGotoLabels: false\nIndentPPDirectives: BeforeHash\nIndentWidth: 8\nIndentWrappedFunctionNames: false\nKeepEmptyLinesAtTheStartOfBlocks: false\nMaxEmptyLinesToKeep: 1\nPenaltyBreakAssignment: 0\nPenaltyBreakBeforeFirstCallParameter: 0\nPenaltyBreakOpenParenthesis: 0\nPenaltyExcessCharacter: 100\nPenaltyReturnTypeOnItsOwnLine: 1000\nPointerAlignment: Left\nReflowComments: false\nSeparateDefinitionBlocks: Always\nSortIncludes: false\nSpaceAfterCStyleCast: true\nSpaceBeforeAssignmentOperators: true\nSpaceBeforeParens: ControlStatements\nSpaceInEmptyParentheses: false\nSpacesBeforeTrailingComments: 1\nSpacesInCStyleCastParentheses: false\nSpacesInParentheses: false\nSpacesInSquareBrackets: false\nTabWidth: 8\nUseTab: ForContinuationAndIndentation\n...\n" }, { "path": ".gitattributes", "content": "*.brd linguist-language=KiCad\n" }, { "path": ".github/ISSUE_TEMPLATE/bug-report.yml", "content": "name: Bug Report \ndescription: Submit a bug report\nlabels: [\"bug report\"]\nbody:\n - type: markdown\n attributes:\n value: |\n Thank you for taking the time to fill out this bug report!\n - type: dropdown\n id: issue-type\n attributes: \n label: What type of issue is this? \n options:\n - transient - occurring only once\n - intermittent - occurring irregularly\n - permanent - occurring repeatedly\n validations:\n required: true\n - type: textarea\n id: issue\n attributes:\n label: What issue are you facing? \n placeholder: Please describe what you have encountered\n validations:\n required: true\n - type: textarea\n id: reproduce-issue\n attributes:\n label: What are the steps to reproduce this? \n placeholder: Please provide the steps to reproduce this issue\n validations:\n required: true \n - type: textarea\n id: logs\n attributes:\n label: Can you provide any logs? (output, errors, etc.)\n placeholder: Please provide any logs you might have that illustrate the issue\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false" }, { "path": ".github/ISSUE_TEMPLATE/documentation-request.yml", "content": "name: Documentation \ndescription: Make a request regarding HackRF documentation \nlabels: [\"documentation\"]\nbody:\n - type: markdown\n attributes:\n value: |\n Thank you for taking the time to help Great Scott Gadgets improve the HackRF One documentation! \n - type: textarea\n id: documentation-request\n attributes:\n label: What would you like us to add to or change about the HackRF One documentation?\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/feature-request.yml", "content": "name: Feature Request \ndescription: File a feature request\nlabels: [\"enhancement\"]\nbody:\n - type: markdown\n attributes:\n value: |\n Thank you for taking the time to fill out this feature request form! \n - type: textarea\n id: feature-request\n attributes:\n label: What feature would you like to see and why?\n description: Please be as detailed as possible with your feature request.\n validations:\n required: true\n " }, { "path": ".github/ISSUE_TEMPLATE/question.yml", "content": "name: Question \ndescription: Ask a question not covered by current hackrf.rtfd.io documentation \nlabels: [\"question\"]\nbody:\n - type: markdown\n attributes:\n value: |\n Thank you for taking the time to ask your question! If you need technical support, want to open a feature request, or need to file a bug report, please abandon this issue, open a new issue, and choose the correct template. If you do not choose the correct template, you will be asked to re-open your issue with the correct template. \n - type: textarea\n id: question\n attributes:\n label: What would you like to know?\n validations:\n required: true" }, { "path": ".github/ISSUE_TEMPLATE/technical-support.yml", "content": "name: Technical Support Request\ndescription: File a technical support request\nlabels: [\"technical support\"]\nbody:\n - type: markdown\n attributes:\n value: |\n Thank you for taking the time to fill out this technical support request form! Please note that technical support requests can expect a response time of two weeks. \n - type: textarea\n id: expected-outcome\n attributes:\n label: What outcome were you hoping for?\n placeholder: Please be detailed in what you expected to happen\n validations:\n required: true\n - type: textarea\n id: actual-outcome\n attributes:\n label: What outcome actually happened? \n placeholder: Please be detailed in what did happen\n validations:\n required: true\n - type: textarea\n id: operating-systems\n attributes:\n label: What operating systems are you seeing the problem on?\n validations:\n required: true\n - type: textarea\n id: hackrf_info-output\n attributes:\n label: What is the output of ```hackrf_info```?\n description: Please put the output of the command in the box below or indicate N/A. \n validations:\n required: true\n - type: textarea\n id: third-party-software\n attributes:\n label: Are you using any third-party software?\n description: Please list the software you are using with your HackRF or indicate N/A. Please list version numbers where possible. \n placeholder: GNU Radio, GQRX, etc. \n validations:\n required: true\n - type: textarea\n id: third-party-hardware\n attributes:\n label: Are you using any third-party hardware? \n description: Please list any hardware you are using with your HackRF or indicate N/A. \n placeholder: portapack, specialized antenna, etc. \n validations:\n required: true\n" }, { "path": ".github/workflows/build.yml", "content": "name: Build\n\non:\n push:\n pull_request:\n\n # Run automatically every monday\n schedule:\n - cron: 1 12 * * 1\n\nenv:\n\n # Override OSX architecture detection. Required for CMake versions < 3.19.2.\n CMAKE_OSX_ARCHITECTURES: arm64\n\njobs:\n host:\n strategy:\n matrix:\n sys:\n - {os: 'macos', shell: 'bash'}\n - {os: 'ubuntu', shell: 'bash'}\n - {os: 'windows', shell: 'pwsh'}\n - {os: 'windows', shell: 'msys2'}\n cmake: ['3.10.0', '3.16.0', '3.21.0', '4.0.0', 'latest']\n exclude:\n # GitHub runners use Visual Studio 2022. Support added in CMake 3.21.\n - sys: {os: 'windows', shell: 'pwsh'}\n cmake: '3.10.0'\n - sys: {os: 'windows', shell: 'pwsh'}\n cmake: '3.16.0'\n # MSYS2 always supplies the latest cmake.\n - sys: {os: 'windows', shell: 'msys2'}\n cmake: '3.10.0'\n - sys: {os: 'windows', shell: 'msys2'}\n cmake: '3.16.0'\n - sys: {os: 'windows', shell: 'msys2'}\n cmake: '3.21.0'\n - sys: {os: 'windows', shell: 'msys2'}\n cmake: '4.0.0'\n include:\n - sys: {os: 'windows', shell: 'pwsh'}\n cmake_args: >-\n -DPKG_CONFIG_EXECUTABLE=C:/vcpkg/installed/x64-windows/tools/pkgconf/pkgconf.exe\n -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake\n --install-prefix=$env:GITHUB_WORKSPACE/install\n - sys: {os: 'windows', shell: 'msys2'}\n cmake_args: >-\n --install-prefix=/usr/local\n\n # Don't cancel all builds when one fails\n fail-fast: false\n runs-on: ${{ matrix.sys.os }}-latest\n\n defaults:\n run:\n shell: '${{ matrix.sys.shell }} {0}'\n\n steps:\n - uses: actions/checkout@v4\n\n - name: Setup cmake\n uses: jwlawson/actions-setup-cmake@v2\n with:\n cmake-version: ${{ matrix.cmake }}\n if: matrix.sys.shell != 'msys2'\n\n - name: Install dependencies (macOS)\n run: brew install fftw\n if: matrix.sys.os == 'macos'\n\n - name: Install dependencies (Ubuntu)\n run: |\n sudo apt update\n sudo apt install libfftw3-dev libusb-1.0-0-dev\n if: matrix.sys.os == 'ubuntu'\n\n - name: Install dependencies (Windows)\n run: vcpkg install --triplet=x64-windows libusb fftw3 pthreads pkgconf\n if: matrix.sys.os == 'windows' && matrix.sys.shell != 'msys2'\n\n - name: Setup MSYS (Windows)\n if: matrix.sys.os == 'windows' && matrix.sys.shell == 'msys2'\n uses: msys2/setup-msys2@v2\n with:\n msystem: UCRT64\n install: >-\n git\n make\n mingw-w64-ucrt-x86_64-cmake\n mingw-w64-ucrt-x86_64-toolchain\n mingw-w64-ucrt-x86_64-libusb\n mingw-w64-ucrt-x86_64-fftw\n\n # Build libhackrf and hackrf-tools together\n\n - name: Configure & Build\n run: |\n cmake -E make_directory host/build\n cd host/build\n cmake .. -DCMAKE_BUILD_TYPE=Release ${{matrix.cmake_args}}\n cmake --build . --config Release\n\n # Build libhackrf ONLY\n\n - name: Configure & Build (libhackrf)\n run: |\n cmake -E make_directory host/libhackrf/build\n cd host/libhackrf/build\n cmake .. -DCMAKE_BUILD_TYPE=Release ${{ matrix.cmake_args }}\n cmake --build . --config Release\n\n - name: Install (libhackrf)\n run: |\n sudo cmake --install host/libhackrf/build --config Release\n if: matrix.sys.os != 'windows' && matrix.cmake != '3.10.0'\n\n - name: Install (libhackrf, CMake 3.10)\n run: |\n sudo cmake --build host/libhackrf/build --target install --config Release\n if: matrix.sys.os != 'windows' && matrix.cmake == '3.10.0'\n\n - name: Install (libhackrf, Windows)\n run: cmake --install host/libhackrf/build --config Release\n if: matrix.sys.os == 'windows'\n\n # Build hackrf-tools ONLY\n\n - name: Configure & Build (hackrf-tools)\n run: |\n cmake -E make_directory host/hackrf-tools/build\n cd host/hackrf-tools/build\n cmake .. -DCMAKE_BUILD_TYPE=Release ${{ matrix.cmake_args }}\n cmake --build . --config Release\n\n - name: Install (hackrf-tools)\n run: |\n sudo cmake --install host/hackrf-tools/build --config Release\n if: matrix.sys.os != 'windows' && matrix.cmake != '3.10.0'\n\n - name: Install (hackrf-tools, CMake 3.10)\n run: |\n sudo cmake --build host/hackrf-tools/build --target install --config Release\n if: matrix.sys.os != 'windows' && matrix.cmake == '3.10.0'\n\n - name: Install (hackrf-tools, Windows)\n run: cmake --install host/hackrf-tools/build --config Release\n if: matrix.sys.os == 'windows'\n\n # Publish the contents of install/bin (which should be the combination libhackrf and host-tools) for Windows\n - name: Publish Artifacts (Windows)\n uses: actions/upload-artifact@v4\n with:\n name: hackrf-tools-windows\n path: ${{github.workspace}}/install/bin\n if: matrix.sys.os == 'windows' && matrix.cmake == 'latest' && matrix.sys.shell == 'pwsh'\n\n firmware:\n strategy:\n matrix:\n os: ['macos', 'ubuntu', 'windows']\n board: ['HACKRF_ONE', 'JAWBREAKER', 'RAD1O', 'PRALINE']\n cmake: ['3.10.0', 'latest']\n exclude:\n - os: 'windows'\n cmake: '3.10.0'\n\n # Don't cancel all builds when one fails\n fail-fast: false\n runs-on: ${{ matrix.os }}-latest\n\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n\n - name: Setup cmake\n uses: jwlawson/actions-setup-cmake@v2\n with:\n cmake-version: ${{ matrix.cmake }}\n if: matrix.os != 'windows'\n\n - name: Install Arm GNU Toolchain\n uses: carlosperate/arm-none-eabi-gcc-action@v1\n if: matrix.os != 'windows'\n\n - name: Install dependencies (macOS)\n run: |\n brew install dfu-util\n python3 -m venv environment && source environment/bin/activate\n python3 -m pip install PyYAML\n if: matrix.os == 'macos'\n\n - name: Install dependencies (Ubuntu)\n run: |\n python3 -m venv environment && source environment/bin/activate\n python3 -m pip install PyYAML\n sudo apt install dfu-util\n if: matrix.os == 'ubuntu'\n\n - name: Build libopencm3\n shell: bash\n working-directory: ${{github.workspace}}/firmware/libopencm3/\n run: |\n source ../../environment/bin/activate\n make\n if: matrix.os != 'windows'\n\n - name: Create Build Environment\n run: cmake -E make_directory ${{github.workspace}}/firmware/build\n if: matrix.os != 'windows'\n\n - name: Configure CMake\n shell: bash\n working-directory: ${{github.workspace}}/firmware/build\n run: cmake $GITHUB_WORKSPACE/firmware/ -DCMAKE_BUILD_TYPE=Release -DBOARD=${{ matrix.board }}\n if: matrix.os != 'windows'\n\n - name: Build\n working-directory: ${{github.workspace}}/firmware/build\n shell: bash\n run: |\n source ../../environment/bin/activate\n cmake --build . --config Release\n if: matrix.os != 'windows'\n\n - name: Setup MSYS (Windows)\n if: matrix.os == 'windows'\n uses: msys2/setup-msys2@v2\n with:\n msystem: UCRT64\n update: true\n install: >-\n git\n make\n mingw-w64-ucrt-x86_64-arm-none-eabi-gcc\n mingw-w64-ucrt-x86_64-cmake\n mingw-w64-ucrt-x86_64-dfu-util\n mingw-w64-ucrt-x86_64-python-yaml\n\n - name: Build with MSYS (Windows)\n if: matrix.os == 'windows'\n shell: msys2 {0}\n run: |\n mkdir firmware/build\n cd firmware/build\n cmake -G \"MSYS Makefiles\" -DCMAKE_BUILD_TYPE=Release -DBOARD=${{ matrix.board }} ..\n make\n" }, { "path": ".github/workflows/clang-format-check.yml", "content": "name: Check code style\non: [push, pull_request]\njobs:\n formatting-check:\n name: clang-format\n runs-on: ubuntu-latest\n strategy:\n matrix:\n path:\n - check: 'host/libhackrf/src'\n exclude: ''\n - check: 'host/hackrf-tools/src'\n exclude: ''\n - check: 'firmware/common'\n exclude: 'firmware/common/xapp058'\n - check: 'firmware/hackrf_usb'\n exclude: ''\n steps:\n - uses: actions/checkout@v4\n - name: Run clang-format-action\n uses: jidicula/clang-format-action@v4.6.2\n with:\n clang-format-version: '14'\n check-path: ${{ matrix.path['check'] }}\n exclude-regex: ${{ matrix.path['exclude'] }}\n" }, { "path": ".gitignore", "content": "# Compiled output\n*.bin\n*.d\n*.elf\n*.hex\n*.srec\nhost/build/\nhost/**/build\ninstall/\n\n# Operating system spew\n.DS_Store\n.Spotlight-V100\n.Trashes\nehthumbs.db\nThumbs.db\n\n# Editor junk\n*.swp\n*.sublime-project\n*.sublime-workspace\n.vscode*\n\n# Documentation Stuff\ndocs/build/\n\n# Xilinx tools create an enormous amount of poop:\nfirmware/cpld/**/isim/\nfirmware/cpld/**/_ngo/\nfirmware/cpld/**/_xmsgs/\nfirmware/cpld/**/iseconfig/\nfirmware/cpld/**/*_html/\nfirmware/cpld/**/xlnx_auto_0_xdb/\nfirmware/cpld/**/xst/\nfirmware/cpld/**/_*.cmd\nfirmware/cpld/**/_*.log\nfirmware/cpld/**/*.bld\nfirmware/cpld/**/*.chk\nfirmware/cpld/**/*.cmd\nfirmware/cpld/**/*.cmd_log\nfirmware/cpld/**/*.csv\nfirmware/cpld/**/*.cxt\nfirmware/cpld/**/*.dat\nfirmware/cpld/**/*.err\nfirmware/cpld/**/*.exe\nfirmware/cpld/**/*.gise\nfirmware/cpld/**/*.gyd\nfirmware/cpld/**/*.html\nfirmware/cpld/**/*.ini\nfirmware/cpld/**/*.ipf\nfirmware/cpld/**/*.log\nfirmware/cpld/**/*.lso\nfirmware/cpld/**/*.mfd\nfirmware/cpld/**/*.ng[acdr]\nfirmware/cpld/**/*.pad\nfirmware/cpld/**/*.phd\nfirmware/cpld/**/*.pnx\nfirmware/cpld/**/*.prj\nfirmware/cpld/**/*.rpt\nfirmware/cpld/**/*.stx\nfirmware/cpld/**/*.syr\nfirmware/cpld/**/*.tim\nfirmware/cpld/**/*.tspec\nfirmware/cpld/**/*.vm6\nfirmware/cpld/**/*.wcfg\nfirmware/cpld/**/*.wdb\nfirmware/cpld/**/*.xml\nfirmware/cpld/**/*.xmsgs\nfirmware/cpld/**/*.xrpt\nfirmware/cpld/**/*.xsl\nfirmware/cpld/**/*.xst\nfirmware/cpld/**/*.xwbt\n\nfirmware/**/build\n\n*.pyc\n" }, { "path": ".gitmodules", "content": "[submodule \"firmware/libopencm3\"]\n\tpath = firmware/libopencm3\n\turl = https://github.com/mossmann/libopencm3.git\n[submodule \"hardware/gsg-kicad-lib\"]\n\tpath = hardware/gsg-kicad-lib\n\turl = https://github.com/greatscottgadgets/gsg-kicad-lib.git\n" }, { "path": ".readthedocs.yaml", "content": "# .readthedocs.yaml\n# Read the Docs configuration file\n# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\n\n# Required\nversion: 2\n\n# Set the OS, Python version and other tools \nbuild:\n os: ubuntu-22.04\n tools:\n python: \"3.12\"\n\n# Build documentation in the \"docs/\" directory with Sphinx\nsphinx:\n configuration: docs/source/conf.py\n\n# Build PDF for docs\nformats:\n - pdf\n\npython:\n install:\n - requirements: docs/requirements.txt\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nstraithe@greatscottgadgets.com.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "COPYING", "content": "\t\t GNU GENERAL PUBLIC LICENSE\n\t\t Version 2, June 1991\n\n Copyright (C) 1989, 1991 Free Software Foundation, Inc.\n 51 Franklin Street, Boston, MA 02110-1301 USA\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n\t\t\t Preamble\n\n The licenses for most software are designed to take away your\nfreedom to share and change it. By contrast, the GNU General Public\nLicense is intended to guarantee your freedom to share and change free\nsoftware--to make sure the software is free for all its users.\tThis\nGeneral Public License applies to most of the Free Software\nFoundation's software and to any other program whose authors commit to\nusing it. (Some other Free Software Foundation software is covered by\nthe GNU Library General Public License instead.) You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice.\tOur General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthis service if you wish), that you receive source code or can get it\nif you want it, that you can change the software or use pieces of it\nin new free programs; and that you know you can do these things.\n\n To protect your rights, we need to make restrictions that forbid\nanyone to deny you these rights or to ask you to surrender the rights.\nThese restrictions translate to certain responsibilities for you if you\ndistribute copies of the software, or if you modify it.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must give the recipients all the rights that\nyou have. You must make sure that they, too, receive or can get the\nsource code. And you must show them these terms so they know their\nrights.\n\n We protect your rights with two steps: (1) copyright the software, and\n(2) offer you this license which gives you legal permission to copy,\ndistribute and/or modify the software.\n\n Also, for each author's protection and ours, we want to make certain\nthat everyone understands that there is no warranty for this free\nsoftware. If the software is modified by someone else and passed on, we\nwant its recipients to know that what they have is not the original, so\nthat any problems introduced by others will not reflect on the original\nauthors' reputations.\n\n Finally, any free program is threatened constantly by software\npatents. We wish to avoid the danger that redistributors of a free\nprogram will individually obtain patent licenses, in effect making the\nprogram proprietary. To prevent this, we have made it clear that any\npatent must be licensed for everyone's free use or not licensed at all.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n\t\t GNU GENERAL PUBLIC LICENSE\n TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION\n\n 0. This License applies to any program or other work which contains\na notice placed by the copyright holder saying it may be distributed\nunder the terms of this General Public License. The \"Program\", below,\nrefers to any such program or work, and a \"work based on the Program\"\nmeans either the Program or any derivative work under copyright law:\nthat is to say, a work containing the Program or a portion of it,\neither verbatim or with modifications and/or translated into another\nlanguage. (Hereinafter, translation is included without limitation in\nthe term \"modification\".) Each licensee is addressed as \"you\".\n\nActivities other than copying, distribution and modification are not\ncovered by this License; they are outside its scope. The act of\nrunning the Program is not restricted, and the output from the Program\nis covered only if its contents constitute a work based on the\nProgram (independent of having been made by running the Program).\nWhether that is true depends on what the Program does.\n\n 1. You may copy and distribute verbatim copies of the Program's\nsource code as you receive it, in any medium, provided that you\nconspicuously and appropriately publish on each copy an appropriate\ncopyright notice and disclaimer of warranty; keep intact all the\nnotices that refer to this License and to the absence of any warranty;\nand give any other recipients of the Program a copy of this License\nalong with the Program.\n\nYou may charge a fee for the physical act of transferring a copy, and\nyou may at your option offer warranty protection in exchange for a fee.\n\n 2. You may modify your copy or copies of the Program or any portion\nof it, thus forming a work based on the Program, and copy and\ndistribute such modifications or work under the terms of Section 1\nabove, provided that you also meet all of these conditions:\n\n a) You must cause the modified files to carry prominent notices\n stating that you changed the files and the date of any change.\n\n b) You must cause any work that you distribute or publish, that in\n whole or in part contains or is derived from the Program or any\n part thereof, to be licensed as a whole at no charge to all third\n parties under the terms of this License.\n\n c) If the modified program normally reads commands interactively\n when run, you must cause it, when started running for such\n interactive use in the most ordinary way, to print or display an\n announcement including an appropriate copyright notice and a\n notice that there is no warranty (or else, saying that you provide\n a warranty) and that users may redistribute the program under\n these conditions, and telling the user how to view a copy of this\n License. (Exception: if the Program itself is interactive but\n does not normally print such an announcement, your work based on\n the Program is not required to print an announcement.)\n\nThese requirements apply to the modified work as a whole. If\nidentifiable sections of that work are not derived from the Program,\nand can be reasonably considered independent and separate works in\nthemselves, then this License, and its terms, do not apply to those\nsections when you distribute them as separate works. But when you\ndistribute the same sections as part of a whole which is a work based\non the Program, the distribution of the whole must be on the terms of\nthis License, whose permissions for other licensees extend to the\nentire whole, and thus to each and every part regardless of who wrote it.\n\nThus, it is not the intent of this section to claim rights or contest\nyour rights to work written entirely by you; rather, the intent is to\nexercise the right to control the distribution of derivative or\ncollective works based on the Program.\n\nIn addition, mere aggregation of another work not based on the Program\nwith the Program (or with a work based on the Program) on a volume of\na storage or distribution medium does not bring the other work under\nthe scope of this License.\n\n 3. You may copy and distribute the Program (or a work based on it,\nunder Section 2) in object code or executable form under the terms of\nSections 1 and 2 above provided that you also do one of the following:\n\n a) Accompany it with the complete corresponding machine-readable\n source code, which must be distributed under the terms of Sections\n 1 and 2 above on a medium customarily used for software interchange; or,\n\n b) Accompany it with a written offer, valid for at least three\n years, to give any third party, for a charge no more than your\n cost of physically performing source distribution, a complete\n machine-readable copy of the corresponding source code, to be\n distributed under the terms of Sections 1 and 2 above on a medium\n customarily used for software interchange; or,\n\n c) Accompany it with the information you received as to the offer\n to distribute corresponding source code. (This alternative is\n allowed only for noncommercial distribution and only if you\n received the program in object code or executable form with such\n an offer, in accord with Subsection b above.)\n\nThe source code for a work means the preferred form of the work for\nmaking modifications to it. For an executable work, complete source\ncode means all the source code for all modules it contains, plus any\nassociated interface definition files, plus the scripts used to\ncontrol compilation and installation of the executable. However, as a\nspecial exception, the source code distributed need not include\nanything that is normally distributed (in either source or binary\nform) with the major components (compiler, kernel, and so on) of the\noperating system on which the executable runs, unless that component\nitself accompanies the executable.\n\nIf distribution of executable or object code is made by offering\naccess to copy from a designated place, then offering equivalent\naccess to copy the source code from the same place counts as\ndistribution of the source code, even though third parties are not\ncompelled to copy the source along with the object code.\n\n 4. You may not copy, modify, sublicense, or distribute the Program\nexcept as expressly provided under this License. Any attempt\notherwise to copy, modify, sublicense or distribute the Program is\nvoid, and will automatically terminate your rights under this License.\nHowever, parties who have received copies, or rights, from you under\nthis License will not have their licenses terminated so long as such\nparties remain in full compliance.\n\n 5. You are not required to accept this License, since you have not\nsigned it. However, nothing else grants you permission to modify or\ndistribute the Program or its derivative works. These actions are\nprohibited by law if you do not accept this License. Therefore, by\nmodifying or distributing the Program (or any work based on the\nProgram), you indicate your acceptance of this License to do so, and\nall its terms and conditions for copying, distributing or modifying\nthe Program or works based on it.\n\n 6. Each time you redistribute the Program (or any work based on the\nProgram), the recipient automatically receives a license from the\noriginal licensor to copy, distribute or modify the Program subject to\nthese terms and conditions. You may not impose any further\nrestrictions on the recipients' exercise of the rights granted herein.\nYou are not responsible for enforcing compliance by third parties to\nthis License.\n\n 7. If, as a consequence of a court judgment or allegation of patent\ninfringement or for any other reason (not limited to patent issues),\nconditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot\ndistribute so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you\nmay not distribute the Program at all.\tFor example, if a patent\nlicense would not permit royalty-free redistribution of the Program by\nall those who receive copies directly or indirectly through you, then\nthe only way you could satisfy both it and this License would be to\nrefrain entirely from distribution of the Program.\n\nIf any portion of this section is held invalid or unenforceable under\nany particular circumstance, the balance of the section is intended to\napply and the section as a whole is intended to apply in other\ncircumstances.\n\nIt is not the purpose of this section to induce you to infringe any\npatents or other property right claims or to contest validity of any\nsuch claims; this section has the sole purpose of protecting the\nintegrity of the free software distribution system, which is\nimplemented by public license practices. Many people have made\ngenerous contributions to the wide range of software distributed\nthrough that system in reliance on consistent application of that\nsystem; it is up to the author/donor to decide if he or she is willing\nto distribute software through any other system and a licensee cannot\nimpose that choice.\n\nThis section is intended to make thoroughly clear what is believed to\nbe a consequence of the rest of this License.\n\n 8. If the distribution and/or use of the Program is restricted in\ncertain countries either by patents or by copyrighted interfaces, the\noriginal copyright holder who places the Program under this License\nmay add an explicit geographical distribution limitation excluding\nthose countries, so that distribution is permitted only in or among\ncountries not thus excluded. In such case, this License incorporates\nthe limitation as if written in the body of this License.\n\n 9. The Free Software Foundation may publish revised and/or new versions\nof the General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\nEach version is given a distinguishing version number.\tIf the Program\nspecifies a version number of this License which applies to it and \"any\nlater version\", you have the option of following the terms and conditions\neither of that version or of any later version published by the Free\nSoftware Foundation. If the Program does not specify a version number of\nthis License, you may choose any version ever published by the Free Software\nFoundation.\n\n 10. If you wish to incorporate parts of the Program into other free\nprograms whose distribution conditions are different, write to the author\nto ask for permission.\tFor software which is copyrighted by the Free\nSoftware Foundation, write to the Free Software Foundation; we sometimes\nmake exceptions for this. Our decision will be guided by the two goals\nof preserving the free status of all derivatives of our free software and\nof promoting the sharing and reuse of software generally.\n\n\t\t\t NO WARRANTY\n\n 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY\nFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN\nOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES\nPROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED\nOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS\nTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE\nPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,\nREPAIR OR CORRECTION.\n\n 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR\nREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,\nINCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING\nOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED\nTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY\nYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER\nPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE\nPOSSIBILITY OF SUCH DAMAGES.\n\n\t\t END OF TERMS AND CONDITIONS\n\n\t How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nconvey the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) 19yy\t\n\n This program is free software; you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation; either version 2 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program; if not, write to the Free Software\n Foundation, Inc., 51 Franklin Street, Boston, MA 02110-1301 USA\n\n\nAlso add information on how to contact you by electronic and paper mail.\n\nIf the program is interactive, make it output a short notice like this\nwhen it starts in an interactive mode:\n\n Gnomovision version 69, Copyright (C) 19yy name of author\n Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, the commands you use may\nbe called something other than `show w' and `show c'; they could even be\nmouse-clicks or menu items--whatever suits your program.\n\nYou should also get your employer (if you work as a programmer) or your\nschool, if any, to sign a \"copyright disclaimer\" for the program, if\nnecessary. Here is a sample; alter the names:\n\n Yoyodyne, Inc., hereby disclaims all copyright interest in the program\n `Gnomovision' (which makes passes at compilers) written by James Hacker.\n\n , 1 April 1989\n Ty Coon, President of Vice\n\nThis General Public License does not permit incorporating your program into\nproprietary programs. If your program is a subroutine library, you may\nconsider it more useful to permit linking proprietary applications with the\nlibrary. If this is what you want to do, use the GNU Library General\nPublic License instead of this License.\n" }, { "path": "Dockerfile", "content": "# Environment for HackRF HIL testing with Jenkins CI\nFROM ubuntu:22.04\nUSER root\n\n# Copy usb hub script from Jenkins' container\nCOPY --from=gsg-jenkins /startup/hubs.py /startup/hubs.py\nCOPY --from=gsg-jenkins /startup/.hubs /startup/.hubs\nRUN ln -s /startup/hubs.py /usr/local/bin/hubs\n\n# Override interactive installations and install software dependencies\nENV DEBIAN_FRONTEND=noninteractive\nRUN apt-get update && apt-get install -y \\\n build-essential \\\n cmake \\\n curl \\\n dfu-util \\\n gcc-arm-none-eabi \\\n git \\\n libfftw3-dev \\\n libusb-1.0-0-dev \\\n pkg-config \\\n python3 \\\n python3-pip \\\n python3-yaml \\\n usbutils \\\n && rm -rf /var/lib/apt/lists/*\n\n# Install USB hub PPPS dependencies\nRUN pip3 install numpy python-dotenv git+https://github.com/CapableRobot/CapableRobot_USBHub_Driver --upgrade\nRUN curl -L https://github.com/mvp/uhubctl/archive/refs/tags/v2.5.0.tar.gz > uhubctl-2.5.0.tar.gz \\\n && mkdir uhubctl-2.5.0 \\\n && tar -xvzf uhubctl-2.5.0.tar.gz -C uhubctl-2.5.0 --strip-components 1 \\\n && rm uhubctl-2.5.0.tar.gz \\\n && cd uhubctl-2.5.0 \\\n && make \\\n && make install\n\n# Inform Docker that the container is listening on port 8080 at runtime\nEXPOSE 8080\n" }, { "path": "Jenkinsfile", "content": "import org.jenkinsci.plugins.workflow.steps.FlowInterruptedException\n\npipeline {\n agent any\n stages {\n stage('Build Docker Image') {\n steps {\n sh 'docker build -t hackrf https://github.com/greatscottgadgets/hackrf.git'\n }\n }\n stage('Test HackRF One') {\n agent {\n docker {\n image 'hackrf'\n reuseNode true\n args '''--group-add=20 --group-add=46 --device-cgroup-rule=\"c 189:* rmw\" \\\n --device-cgroup-rule=\"c 166:* rmw\" -v /dev/bus/usb:/dev/bus/usb \\\n -v /tmp/req_pipe:/tmp/req_pipe -v /tmp/res_pipe:/tmp/res_pipe'''\n }\n }\n steps {\n sh './ci-scripts/install_host.sh'\n sh './ci-scripts/build_h1_firmware.sh'\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs all off'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n retry(3) {\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs h1_eut reset'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n sh 'sleep 1s'\n sh './ci-scripts/test_host.sh'\n }\n retry(3) {\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs h1_tester h1_eut reset'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n sh 'sleep 1s'\n script {\n try {\n // Allow 5 minutes for the test to run\n timeout(time: 5, unit: 'MINUTES') {\n sh '''python3 ci-scripts/hackrf_test.py --ci --log log \\\n --hostdir host/build/hackrf-tools/src/ \\\n --fwupdate firmware/hackrf_usb/build/ \\\n --tester 0000000000000000325866e629a25623 \\\n --eut RunningFromRAM --unattended --rev r4'''\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"HackRF One Test timeout limit reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs all off'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n }\n retry(3) {\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs h1_eut reset'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n sh 'sleep 1s'\n sh 'python3 ci-scripts/test_sgpio_debug.py'\n }\n }\n }\n stage('Test HackRF Pro') {\n agent {\n docker {\n image 'hackrf'\n reuseNode true\n args '''--group-add=20 --group-add=46 --device-cgroup-rule=\"c 189:* rmw\" \\\n --device-cgroup-rule=\"c 166:* rmw\" -v /dev/bus/usb:/dev/bus/usb \\\n -v /tmp/req_pipe:/tmp/req_pipe -v /tmp/res_pipe:/tmp/res_pipe'''\n }\n }\n steps {\n sh './ci-scripts/install_host.sh'\n sh './ci-scripts/build_hpro_firmware.sh'\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs all off'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n retry(3) {\n script {\n try {\n // Allow 20 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs hpro_eut reset'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n sh 'sleep 1s'\n sh './ci-scripts/test_host.sh'\n }\n retry(3) {\n script {\n try {\n // Allow 10 seconds for the USB hub port power server to respond\n timeout(time: 20, unit: 'SECONDS') {\n sh 'hubs hpro_tester hpro_eut reset'\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"USB hub port power server command timeout reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n sh 'sleep 1s'\n script {\n try {\n // Allow 5 minutes for the test to run\n timeout(time: 5, unit: 'MINUTES') {\n sh '''python3 ci-scripts/hackrf_pro_test.py --ci --log log \\\n --hostdir host/build/hackrf-tools/src \\\n --fwupdate firmware/hackrf_usb/build \\\n --tester 0000000000000000a06063c82338145f \\\n --eut RunningFromRAM -p --rev r1.2'''\n }\n } catch (FlowInterruptedException err) {\n // Check if the cause was specifically an exceeded timeout\n def cause = err.getCauses().get(0)\n if (cause instanceof org.jenkinsci.plugins.workflow.steps.TimeoutStepExecution.ExceededTimeout) {\n echo \"HackRF Pro Test timeout limit reached.\"\n throw err // Re-throw the exception to fail the build\n } else {\n echo \"Build interrupted for another reason.\"\n throw err // Re-throw the exception to fail the build\n }\n } catch (Exception err) {\n echo \"An unrelated error occurred: ${err.getMessage()}\"\n throw err\n }\n }\n }\n }\n }\n }\n post {\n always {\n cleanWs(cleanWhenNotBuilt: false,\n deleteDirs: true,\n disableDeferredWipeout: true,\n notFailBuild: true)\n }\n }\n}\n" }, { "path": "Readme.md", "content": "# HackRF\n\nThis repository contains hardware designs and software for HackRF,\na low cost, open source Software Defined Radio platform.\n\n![HackRF One](https://raw.github.com/mossmann/hackrf/master/docs/images/HackRF-One-fd0-0009.jpeg)\n\n(photo by fd0 from https://github.com/fd0/hackrf-one-pictures)\n\nprincipal author: Michael Ossmann \n\nInformation on HackRF and purchasing HackRF: https://greatscottgadgets.com/hackrf/\n\n--------------------\n\n# Documentation\n\nDocumentation for HackRF can be viewed on [Read the Docs](https://hackrf.readthedocs.io/en/latest/). The raw documentation files for HackRF are in the [docs folder](https://github.com/mossmann/hackrf/tree/master/docs) in this repository and can be built locally by installing [Sphinx Docs](https://www.sphinx-doc.org/en/master/usage/installation.html) and running `make html`. Documentation changes can be submitted through pull request and suggestions can be made as GitHub issues. \n\nTo create a PDF of the HackRF documentation from the HackRF repository while on Ubuntu:\n* run `sudo apt install latexmk texlive-latex-extra`\n* navigate to hackrf/docs on command line\n* run the command `make latex`\n* run the command `make latexpdf`\n\n--------------------\n\n# Getting Help\n\nBefore asking for help with HackRF, check to see if your question is listed on the [troubleshooting page](https://hackrf.readthedocs.io/en/latest/troubleshooting.html).\n\nFor assistance with HackRF general use or development, please look at the [issues on the GitHub project](https://github.com/greatscottgadgets/hackrf/issues). This is the preferred place to ask questions so that others may locate the answer to your question in the future.\n\nWe invite you to join our community discussions on [Discord](https://discord.gg/rsfMw3rsU8). Note that while technical support requests are welcome here, we do not have support staff on duty at all times. Be sure to also submit an issue on GitHub if you've found a bug or if you want to ensure that your request will be tracked and not overlooked.\n\nIf you wish to see past discussions and questions about HackRF, you may also view the [mailing list archives](https://pairlist9.pair.net/pipermail/hackrf-dev/).\n\nGitHub issues on this repository that are labelled \"technical support\" by Great Scott Gadgets employees can expect a response time of two weeks. We currently do not have expected response times for other GitHub issues or pull requests for this repository. \n" }, { "path": "TRADEMARK", "content": "\"HackRF\" is a trademark of Great Scott Gadgets. Permission to use the trademark\nwith attribution to Great Scott Gadgets is granted to all licensees of HackRF for\nthe sole purpose of naming or describing copies or derived works. (See COPYING.)\n" }, { "path": "ci-scripts/build_h1_firmware.sh", "content": "#!/bin/bash\nset -e\ngit submodule init\ngit submodule update\ncd firmware/hackrf_usb\ncmake -B build\ncmake --build build\ncd ../..\n" }, { "path": "ci-scripts/build_hpro_firmware.sh", "content": "#!/bin/bash\nset -e\ngit submodule init\ngit submodule update\ncd firmware/hackrf_usb\ncmake -DBOARD=PRALINE -B build\ncmake --build build\ncd ../..\n" }, { "path": "ci-scripts/hackrf_pro_test.py", "content": "#!/usr/bin/env python3\n\nimport sys\nimport subprocess\nimport time\nimport os, shutil\nimport usb\nfrom datetime import datetime\nfrom dataclasses import dataclass\nimport argparse\nimport numpy as np\nimport traceback\nimport re\n\nDFU_UTIL = \"/usr/bin/dfu-util\"\nTMP_DIR = \"/tmp/\"\nWAVEFORM = TMP_DIR + \"waveform100\"\nNOISE = TMP_DIR + \"noise\"\nVENDOR_ID = 0x1d50\nPRODUCT_ID = 0x6089\nDFU_VENDOR_ID = 0x1fc9\nDFU_PRODUCT_ID = 0x000c\nONE_MHZ = 1000000\nTIMEOUT = 5\nMAX_PPM = 20\nMAX_BASELINE = -20\nSIGNAL_THRESHOLD = -25\nMAX_DC_DBC = -27\nMAX_M_DBC = -27\nMAX_MH2_DBC = -40\nMAX_H2_DBC = -39\nMAX_OTHER_DBC = -34\nLP2_CORRECTION = 10\nMAX_POWER = -10\nIF_REQUIRED_MIN = 2320\nIF_REQUIRED_MAX = 2580\nIF_TEST_RANGE = 256\nSLEEP_TIME = 0.05 # seconds to wait between start of TX and start of RX\n\n@dataclass\nclass TestCase():\n name: str\n freq: int\n amp: bool\n direction: str\n base_ecode: int\n rx_lna_gain: int\n rx_vga_gain: int\n tx_gain: int\n\n# Try to keep rx_lna_gain and rx_vga_gain between 8 and 32.\nbp1txamp = TestCase(name=\"BP1-TX-amp\", freq=2500, amp=True, direction=\"tx\",\n base_ecode=320, rx_lna_gain=8, rx_vga_gain=16, tx_gain=5)\nlp1txamp = TestCase(name=\"LP1-TX-amp\", freq=915, amp=True, direction=\"tx\",\n base_ecode=420, rx_lna_gain=8, rx_vga_gain=16, tx_gain=14)\nlp2txamp = TestCase(name=\"LP2-TX-amp\", freq=12, amp=True, direction=\"tx\",\n base_ecode=2420, rx_lna_gain=8, rx_vga_gain=16, tx_gain=13)\nhp1txamp = TestCase(name=\"HP1-TX-amp\", freq=5995, amp=True, direction=\"tx\",\n base_ecode=520, rx_lna_gain=32, rx_vga_gain=16, tx_gain=18)\n\nbp1txnoamp = TestCase(name=\"BP1-TX-noamp\", freq=2500, amp=False, direction=\"tx\",\n base_ecode=350, rx_lna_gain=16, rx_vga_gain=16, tx_gain=14)\nlp1txnoamp = TestCase(name=\"LP1-TX-noamp\", freq=915, amp=False, direction=\"tx\",\n base_ecode=450, rx_lna_gain=16, rx_vga_gain=12, tx_gain=27)\nlp2txnoamp = TestCase(name=\"LP2-TX-noamp\", freq=12, amp=False, direction=\"tx\",\n base_ecode=2450, rx_lna_gain=16, rx_vga_gain=18, tx_gain=20)\nhp1txnoamp = TestCase(name=\"HP1-TX-noamp\", freq=5995, amp=False, direction=\"tx\",\n base_ecode=550, rx_lna_gain=32, rx_vga_gain=24, tx_gain=19)\n\n# Much of the information in the RX test cases is a duplication of information\n# in the TX test cases, but it's easier to keep legacy error codes this way.\nbp1rxamp = TestCase(name=\"BP1-RX-amp\", freq=2500, amp=True, direction=\"rx\",\n base_ecode=620, rx_lna_gain=8, rx_vga_gain=16, tx_gain=16)\nlp1rxamp = TestCase(name=\"LP1-RX-amp\", freq=915, amp=True, direction=\"rx\",\n base_ecode=720, rx_lna_gain=16, rx_vga_gain=16, tx_gain=18)\nlp2rxamp = TestCase(name=\"LP2-RX-amp\", freq=12, amp=True, direction=\"rx\",\n base_ecode=2720, rx_lna_gain=16, rx_vga_gain=16, tx_gain=18)\nhp1rxamp = TestCase(name=\"HP1-RX-amp\", freq=5995, amp=True, direction=\"rx\",\n base_ecode=820, rx_lna_gain=16, rx_vga_gain=28, tx_gain=38)\n\nbp1rxnoamp = TestCase(name=\"BP1-RX-noamp\", freq=2500, amp=False, direction=\"rx\",\n base_ecode=650, rx_lna_gain=16, rx_vga_gain=16, tx_gain=15)\nlp1rxnoamp = TestCase(name=\"LP1-RX-noamp\", freq=915, amp=False, direction=\"rx\",\n base_ecode=750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=35)\nlp2rxnoamp = TestCase(name=\"LP2-RX-noamp\", freq=12, amp=False, direction=\"rx\",\n base_ecode=2750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=38)\nhp1rxnoamp = TestCase(name=\"HP1-RX-noamp\", freq=5995, amp=False, direction=\"rx\",\n base_ecode=850, rx_lna_gain=16, rx_vga_gain=36, tx_gain=46)\n\npraline_rf_test_cases = (\n bp1txamp, lp1txamp, lp2txamp, hp1txamp,\n bp1txnoamp, lp1txnoamp, lp2txnoamp, hp1txnoamp,\n bp1rxamp, lp1rxamp, lp2rxamp, hp1rxamp,\n bp1rxnoamp, lp1rxnoamp, lp2rxnoamp, hp1rxnoamp)\n\n# Praline r1.1.0 requires different gain configuration\nr110_bp1rxnoamp = TestCase(name=\"BP1-RX-noamp\", freq=2500, amp=False, direction=\"rx\",\n base_ecode=650, rx_lna_gain=16, rx_vga_gain=16, tx_gain=15)\nr110_lp1rxnoamp = TestCase(name=\"LP1-RX-noamp\", freq=915, amp=False, direction=\"rx\",\n base_ecode=750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=35)\nr110_lp2rxnoamp = TestCase(name=\"LP2-RX-noamp\", freq=12, amp=False, direction=\"rx\",\n base_ecode=2750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=38)\nr110_hp1rxnoamp = TestCase(name=\"HP1-RX-noamp\", freq=5995, amp=False, direction=\"rx\",\n base_ecode=850, rx_lna_gain=16, rx_vga_gain=36, tx_gain=46)\n\nr110_bp1txamp = TestCase(name=\"BP1-TX-amp\", freq=2500, amp=True, direction=\"tx\",\n base_ecode=320, rx_lna_gain=8, rx_vga_gain=16, tx_gain=5)\nr110_lp1txamp = TestCase(name=\"LP1-TX-amp\", freq=915, amp=True, direction=\"tx\",\n base_ecode=420, rx_lna_gain=8, rx_vga_gain=16, tx_gain=10)\nr110_lp2txamp = TestCase(name=\"LP2-TX-amp\", freq=12, amp=True, direction=\"tx\",\n base_ecode=2420, rx_lna_gain=8, rx_vga_gain=16, tx_gain=12)\nr110_hp1txamp = TestCase(name=\"HP1-TX-amp\", freq=5995, amp=True, direction=\"tx\",\n base_ecode=520, rx_lna_gain=32, rx_vga_gain=16, tx_gain=17)\n\nr110_bp1txnoamp = TestCase(name=\"BP1-TX-noamp\", freq=2500, amp=False, direction=\"tx\",\n base_ecode=350, rx_lna_gain=16, rx_vga_gain=16, tx_gain=13)\nr110_lp1txnoamp = TestCase(name=\"LP1-TX-noamp\", freq=915, amp=False, direction=\"tx\",\n base_ecode=450, rx_lna_gain=16, rx_vga_gain=12, tx_gain=23)\nr110_lp2txnoamp = TestCase(name=\"LP2-TX-noamp\", freq=12, amp=False, direction=\"tx\",\n base_ecode=2450, rx_lna_gain=16, rx_vga_gain=18, tx_gain=18)\nr110_hp1txnoamp = TestCase(name=\"HP1-TX-noamp\", freq=5995, amp=False, direction=\"tx\",\n base_ecode=550, rx_lna_gain=32, rx_vga_gain=24, tx_gain=18)\n\nr110_bp1rxamp = TestCase(name=\"BP1-RX-amp\", freq=2500, amp=True, direction=\"rx\",\n base_ecode=620, rx_lna_gain=8, rx_vga_gain=16, tx_gain=16)\nr110_lp1rxamp = TestCase(name=\"LP1-RX-amp\", freq=915, amp=True, direction=\"rx\",\n base_ecode=720, rx_lna_gain=16, rx_vga_gain=16, tx_gain=8)\nr110_lp2rxamp = TestCase(name=\"LP2-RX-amp\", freq=12, amp=True, direction=\"rx\",\n base_ecode=2720, rx_lna_gain=16, rx_vga_gain=16, tx_gain=10)\nr110_hp1rxamp = TestCase(name=\"HP1-RX-amp\", freq=5995, amp=True, direction=\"rx\",\n base_ecode=820, rx_lna_gain=16, rx_vga_gain=28, tx_gain=25)\n\nr110_bp1rxnoamp = TestCase(name=\"BP1-RX-noamp\", freq=2500, amp=False, direction=\"rx\",\n base_ecode=650, rx_lna_gain=16, rx_vga_gain=16, tx_gain=15)\nr110_lp1rxnoamp = TestCase(name=\"LP1-RX-noamp\", freq=915, amp=False, direction=\"rx\",\n base_ecode=750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=24)\nr110_lp2rxnoamp = TestCase(name=\"LP2-RX-noamp\", freq=12, amp=False, direction=\"rx\",\n base_ecode=2750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=28)\nr110_hp1rxnoamp = TestCase(name=\"HP1-RX-noamp\", freq=5995, amp=False, direction=\"rx\",\n base_ecode=850, rx_lna_gain=16, rx_vga_gain=36, tx_gain=30)\n\npraline_r110_rf_test_cases = (\n r110_bp1txamp, r110_lp1txamp, r110_lp2txamp, r110_hp1txamp,\n r110_bp1txnoamp, r110_lp1txnoamp, r110_lp2txnoamp, r110_hp1txnoamp,\n r110_bp1rxamp, r110_lp1rxamp, r110_lp2rxamp, r110_hp1rxamp,\n r110_bp1rxnoamp, r110_lp1rxnoamp, r110_lp2rxnoamp, r110_hp1rxnoamp)\n\nifmin = TestCase(name=\"IF-min\", freq=IF_REQUIRED_MIN, amp=None, direction=None,\n base_ecode=None, rx_lna_gain=16, rx_vga_gain=16, tx_gain=12)\nifmax = TestCase(name=\"IF-max\", freq=IF_REQUIRED_MAX, amp=None, direction=None,\n base_ecode=None, rx_lna_gain=16, rx_vga_gain=16, tx_gain=18)\n\nppm = TestCase(name=\"PPM\", freq=2507, amp=False, direction=None,\n base_ecode=None, rx_lna_gain=16, rx_vga_gain=16, tx_gain=18)\n\nnoise = TestCase(name=\"Noise\", freq=2550, amp=True, direction=None,\n base_ecode=None, rx_lna_gain=40, rx_vga_gain=52, tx_gain=None)\n\nr9_tester_cal = [1.1, 0.4, 0.4, 1.1, 0.8, 0.2, 0.6, 1.6, -0.4, -1.2, -1.1, 1.1, -1.4, -0.9, 0.1, 1.8]\nr9_eut_cal = [-1.1, -1.6, -1.4, -1.3, -1.3, -0.9, 0.1, 1.8, 0.8, 1.1, 0.9, -0.2, 0.9, 0.2, 0.6, 1.5]\nog_tester_cal = [-0.4, -0.3, -0.2, -0.4, -0.8, -0.5, -0., -0.1, 1.4, 2., 1.6, -0.1, 1.5, 0.7, 0.5, -0.3]\nog_eut_cal = [1.8, 1.8, 1.6, 2., 1.3, 0.7, 0.5, -0.3, 0.2, -0.3, -0.5, 1.2, -0.8, -0.5, -0., -0.1]\n\nemessages = {\n 1: \"Wrong device placed in DFU mode\",\n 2: \"DFU device not found\",\n 3: \"Failed to parse a serial number from hackrf_info\",\n 4: \"No path to hackrf host tools found. Please provide a directory via --hostdir\",\n 5: \"\"\"Specified TESTER binary directory must be different from the found EUT bin directory\n If shared TESTER/EUT binary directory is intended, omit --testerdir\"\"\",\n 6: \"Unable to parse valid serial number from connected devices\",\n 7: \"TESTER and EUT cannot be the same device\",\n 8: \"Invalid TESTER unit, please use a HackRF One\",\n 9: \"Invalid EUT unit, please use a HackRF Pro\",\n 10: \"Clock readback failed\",\n 11: \"SGPIO RX test failed\",\n 12: \"Loopback test failed\",\n 13: \"Self-test failed, see above\",\n 14: \"FPGA configuration failed\",\n 15: \"Multiple self-test failures, see above\",\n 16: \"Mixer self-test failed\",\n 17: \"Transceiver self-test failed\",\n 18: \"32kHz oscillator test failed\",\n 19: \"Too many devices found using unique host tool directory\",\n 20: \"Factory TESTER device not found\",\n 21: \"Factory EUT device not found\",\n 22: \"SGPIO RX test timed out\",\n 23: \"Loopback test timed out\",\n 24: \"FPGA SPI test failed\",\n 60: \"Unable to program firmware via DFU\",\n 65: \"EUT not detected after DFU programming\",\n 70: \"Unable to program SPI flash\",\n 75: \"EUT not detected after flashing\",\n 76: \"Unable to reset EUT\",\n 77: \"Unable to reset TESTER\",\n 78: \"EUT not detected after reset\",\n 79: \"TESTER not detected after reset\",\n 80: \"Could not find EUT\",\n 81: \"Could not find TESTER\",\n 82: \"Found multiple candidate EUTs\",\n 83: \"Found multiple candidate TESTERs\",\n 84: \"EUT running from RAM instead of flash\",\n 85: \"TESTER running from RAM instead of flash\",\n 86: \"Couldn't parse hackrf_info output\",\n 87: \"hackrf_info command failed\",\n 88: \"Incorrect EUT hardware revision\",\n 89: \"Incorrect TESTER hardware revision\",\n 90: \"EUT has incorrect manufacturer pin strap\",\n 91: \"TESTER has incorrect manufacturer pin strap\",\n 92: \"No HackRFs found\",\n 99: \"Incorrect device name\",\n 100: \"EUT couldn't verify clkgen register\",\n 101: \"TESTER couldn't verify clkgen register\",\n 120: \"EUT couldn't verify xcvr register\",\n 121: \"TESTER couldn't verify xcvr register\",\n 140: \"EUT couldn't verify mixer register\",\n 141: \"TESTER couldn't verify mixer register\",\n 150: \"Failed RX for IF verification\",\n 152: \"Couldn't parse received power\",\n 154: \"Received power out of bounds\",\n 160: \"Insufficient IF range\",\n 170: \"RX operation failed\",\n 172: \"Couldn't parse hackrf_sweep output\",\n 180: \"Subprocess timed out\",\n 190: \"Failed to configure LEDs\",\n 200: \"hackrf_clock command failed\",\n 210: \"TESTER failed to detect EUT CLKOUT\",\n 211: \"EUT failed to detect TESTER CLKOUT\",\n 212: \"TESTER detected spurious CLKIN\",\n 213: \"EUT detected spurious CLKIN\",\n 220: \"Failed TESTER CLKIN activation RX\",\n 221: \"Failed EUT CLKIN activation RX\",\n 230: \"Failed TESTER PLL check\",\n 231: \"Failed EUT PLL check\",\n 232: \"TESTER PLL failed to lock\",\n 233: \"EUT PLL failed to lock\",\n 240: \"Clock synchronization failure\",\n 250: \"Failed PPM detection sweep\",\n 252: \"Couldn't parse PPM test sweep data\",\n 254: \"TESTER couldn't detect PPM test transmission\",\n 255: \"EUT couldn't detect PPM test transmission\",\n 260: \"Frequency error exceeds limit\",\n 300: \"Failed baseline RX\",\n 302: \"Couldn't parse baseline RX power\",\n 306: \"Baseline RX power too high\",\n 310: \"Failed noise RX\",\n 311: \"Couldn't parse noise RX power\",\n 312: \"Noise RX power out of range\",\n 313: \"Required noise gain out of range\",\n 315: \"Couldn't read noise RX file\",\n 316: \"Too little variation in ADC bit\",\n 317: \"ADC bit correlates strongly with another bit\",\n\t321: \"Excessive TX DC offset in AMP txbp1\",\n\t322: \"insufficient signal strength in AMP txbp1\",\n\t323: \"AMP txbp1 clipping\",\n\t325: \"peak found at unexpected frequency in AMP txbp1\",\n\t330: \"harmonics detected in AMP txbp1\",\n\t335: \"neighbor magnitude exceeded in AMP txbp1\",\n\t340: \"neighbor magnitude exceeded in AMP txbp1\",\n\t345: \"spectrum mirrored or inverted in AMP txbp1\",\n\t350: \"excessive power out of channel in AMP txbp1\",\n\t351: \"Excessive TX DC offset in NOAMP txbp1\",\n\t352: \"insufficient signal strength in NOAMP txbp1\",\n\t353: \"NOAMP txbp1 clipping\",\n\t355: \"peak found at unexpected frequency in NOAMP txbp1\",\n\t360: \"harmonics detected in NOAMP txbp1\",\n\t365: \"neighbor magnitude exceeded in NOAMP txbp1\",\n\t370: \"neighbor magnitude exceeded in NOAMP txbp1\",\n\t375: \"spectrum mirrored or inverted in NOAMP txbp1\",\n\t380: \"excessive power out of channel in NOAMP txbp1\",\n\t421: \"Excessive TX DC offset in AMP txlp1\",\n\t422: \"insufficient signal strength in AMP txlp1\",\n\t423: \"AMP txlp1 clipping\",\n\t425: \"peak found at unexpected frequency in AMP txlp1\",\n\t430: \"harmonics detected in AMP txlp1\",\n\t435: \"neighbor magnitude exceeded in AMP txlp1\",\n\t440: \"neighbor magnitude exceeded in AMP txlp1\",\n\t445: \"spectrum mirrored or inverted in AMP txlp1\",\n\t450: \"excessive power out of channel in AMP txlp1\",\n\t451: \"Excessive TX DC offset in NOAMP txlp1\",\n\t452: \"insufficient signal strength in NOAMP txlp1\",\n\t453: \"NOAMP txlp1 clipping\",\n\t455: \"peak found at unexpected frequency in NOAMP txlp1\",\n\t460: \"harmonics detected in NOAMP txlp1\",\n\t465: \"neighbor magnitude exceeded in NOAMP txlp1\",\n\t470: \"neighbor magnitude exceeded in NOAMP txlp1\",\n\t475: \"spectrum mirrored or inverted in NOAMP txlp1\",\n\t480: \"excessive power out of channel in NOAMP txlp1\",\n\t2421: \"Excessive TX DC offset in AMP txlp2\",\n\t2422: \"insufficient signal strength in AMP txlp2\",\n\t2423: \"AMP txlp2 clipping\",\n\t2425: \"peak found at unexpected frequency in AMP txlp2\",\n\t2430: \"harmonics detected in AMP txlp2\",\n\t2435: \"neighbor magnitude exceeded in AMP txlp2\",\n\t2440: \"neighbor magnitude exceeded in AMP txlp2\",\n\t2445: \"spectrum mirrored or inverted in AMP txlp2\",\n\t2450: \"excessive power out of channel in AMP txlp2\",\n\t2451: \"Excessive TX DC offset in NOAMP txlp2\",\n\t2452: \"insufficient signal strength in NOAMP txlp2\",\n\t2453: \"NOAMP txlp2 clipping\",\n\t2455: \"peak found at unexpected frequency in NOAMP txlp2\",\n\t2460: \"harmonics detected in NOAMP txlp2\",\n\t2465: \"neighbor magnitude exceeded in NOAMP txlp2\",\n\t2470: \"neighbor magnitude exceeded in NOAMP txlp2\",\n\t2475: \"spectrum mirrored or inverted in NOAMP txlp2\",\n\t2480: \"excessive power out of channel in NOAMP txlp2\",\n\t521: \"Excessive TX DC offset in AMP txhp1\",\n\t522: \"insufficient signal strength in AMP txhp1\",\n\t523: \"AMP txhp1 clipping\",\n\t525: \"peak found at unexpected frequency in AMP txhp1\",\n\t530: \"harmonics detected in AMP txhp1\",\n\t535: \"neighbor magnitude exceeded in AMP txhp1\",\n\t540: \"neighbor magnitude exceeded in AMP txhp1\",\n\t545: \"spectrum mirrored or inverted in AMP txhp1\",\n\t550: \"excessive power out of channel in AMP txhp1\",\n\t551: \"Excessive TX DC offset in NOAMP txhp1\",\n\t552: \"insufficient signal strength in NOAMP txhp1\",\n\t553: \"NOAMP txhp1 clipping\",\n\t555: \"peak found at unexpected frequency in NOAMP txhp1\",\n\t560: \"harmonics detected in NOAMP txhp1\",\n\t565: \"neighbor magnitude exceeded in NOAMP txhp1\",\n\t570: \"neighbor magnitude exceeded in NOAMP txhp1\",\n\t575: \"spectrum mirrored or inverted in NOAMP txhp1\",\n\t580: \"excessive power out of channel in NOAMP txhp1\",\n\t621: \"Excessive TX DC offset in AMP rxbp1\",\n\t622: \"insufficient signal strength in AMP rxbp1\",\n\t623: \"AMP rxbp1 clipping\",\n\t625: \"peak found at unexpected frequency in AMP rxbp1\",\n\t630: \"harmonics detected in AMP rxbp1\",\n\t635: \"neighbor magnitude exceeded in AMP rxbp1\",\n\t640: \"neighbor magnitude exceeded in AMP rxbp1\",\n\t645: \"spectrum mirrored or inverted in AMP rxbp1\",\n\t650: \"excessive power out of channel in AMP rxbp1\",\n\t651: \"Excessive TX DC offset in NOAMP rxbp1\",\n\t652: \"insufficient signal strength in NOAMP rxbp1\",\n\t653: \"NOAMP rxbp1 clipping\",\n\t655: \"peak found at unexpected frequency in NOAMP rxbp1\",\n\t660: \"harmonics detected in NOAMP rxbp1\",\n\t665: \"neighbor magnitude exceeded in NOAMP rxbp1\",\n\t670: \"neighbor magnitude exceeded in NOAMP rxbp1\",\n\t675: \"spectrum mirrored or inverted in NOAMP rxbp1\",\n\t680: \"excessive power out of channel in NOAMP rxbp1\",\n\t721: \"Excessive TX DC offset in AMP rxlp1\",\n\t722: \"insufficient signal strength in AMP rxlp1\",\n\t723: \"AMP rxlp1 clipping\",\n\t725: \"peak found at unexpected frequency in AMP rxlp1\",\n\t730: \"harmonics detected in AMP rxlp1\",\n\t735: \"neighbor magnitude exceeded in AMP rxlp1\",\n\t740: \"neighbor magnitude exceeded in AMP rxlp1\",\n\t745: \"spectrum mirrored or inverted in AMP rxlp1\",\n\t750: \"excessive power out of channel in AMP rxlp1\",\n\t751: \"Excessive TX DC offset in NOAMP rxlp1\",\n\t752: \"insufficient signal strength in NOAMP rxlp1\",\n\t753: \"NOAMP rxlp1 clipping\",\n\t755: \"peak found at unexpected frequency in NOAMP rxlp1\",\n\t760: \"harmonics detected in NOAMP rxlp1\",\n\t765: \"neighbor magnitude exceeded in NOAMP rxlp1\",\n\t770: \"neighbor magnitude exceeded in NOAMP rxlp1\",\n\t775: \"spectrum mirrored or inverted in NOAMP rxlp1\",\n\t780: \"excessive power out of channel in NOAMP rxlp1\",\n\t2721: \"Excessive TX DC offset in AMP rxlp2\",\n\t2722: \"insufficient signal strength in AMP rxlp2\",\n\t2723: \"AMP rxlp2 clipping\",\n\t2725: \"peak found at unexpected frequency in AMP rxlp2\",\n\t2730: \"harmonics detected in AMP rxlp2\",\n\t2735: \"neighbor magnitude exceeded in AMP rxlp2\",\n\t2740: \"neighbor magnitude exceeded in AMP rxlp2\",\n\t2745: \"spectrum mirrored or inverted in AMP rxlp2\",\n\t2750: \"excessive power out of channel in AMP rxlp2\",\n\t2751: \"Excessive TX DC offset in NOAMP rxlp2\",\n\t2752: \"insufficient signal strength in NOAMP rxlp2\",\n\t2753: \"NOAMP rxlp2 clipping\",\n\t2755: \"peak found at unexpected frequency in NOAMP rxlp2\",\n\t2760: \"harmonics detected in NOAMP rxlp2\",\n\t2765: \"neighbor magnitude exceeded in NOAMP rxlp2\",\n\t2770: \"neighbor magnitude exceeded in NOAMP rxlp2\",\n\t2775: \"spectrum mirrored or inverted in NOAMP rxlp2\",\n\t2780: \"excessive power out of channel in NOAMP rxlp2\",\n\t821: \"Excessive TX DC offset in AMP rxhp1\",\n\t822: \"insufficient signal strength in AMP rxhp1\",\n\t823: \"AMP rxhp1 clipping\",\n\t825: \"peak found at unexpected frequency in AMP rxhp1\",\n\t830: \"harmonics detected in AMP rxhp1\",\n\t835: \"neighbor magnitude exceeded in AMP rxhp1\",\n\t840: \"neighbor magnitude exceeded in AMP rxhp1\",\n\t845: \"spectrum mirrored or inverted in AMP rxhp1\",\n\t850: \"excessive power out of channel in AMP rxhp1\",\n\t851: \"Excessive TX DC offset in NOAMP rxhp1\",\n\t852: \"insufficient signal strength in NOAMP rxhp1\",\n\t853: \"NOAMP rxhp1 clipping\",\n\t855: \"peak found at unexpected frequency in NOAMP rxhp1\",\n\t860: \"harmonics detected in NOAMP rxhp1\",\n\t865: \"neighbor magnitude exceeded in NOAMP rxhp1\",\n\t870: \"neighbor magnitude exceeded in NOAMP rxhp1\",\n\t875: \"spectrum mirrored or inverted in NOAMP rxhp1\",\n\t880: \"excessive power out of channel in NOAMP rxhp1\",\n\t3000: \"BP TX failure\",\n\t3010: \"BP RX failure\",\n\t3020: \"HP TX failure\",\n\t3030: \"HP RX failure\",\n\t3040: \"LP TX failure\",\n\t3050: \"LP RX failure\",\n\t3060: \"TX AMP failure\",\n\t3070: \"RX AMP failure\",\n\t3080: \"AMP bypass failure\",\n\t3090: \"LPF failure\",\n\t3100: \"HPF failure\",\n\t3110: \"mixer bypass failure\",\n\t3120: \"mixer failure\",\n\t3130: \"TX failure\",\n\t3140: \"RX failure\",\n\t3150: \"mixer TX failure\",\n\t3160: \"mixer RX failure\",\n\t3170: \"LP2 TX failure\",\n\t3180: \"LP2 RX failure\",\n\t3190: \"LP2 TX/RX failure\",\n\t3200: \"total RF failure\",\n\t3210: \"multiple RF failures, see list above\",\n\t3220: \"multiple clipping failures\",\n\t3230: \"TX clipping failure\",\n\t3240: \"RX clipping failure\"\n}\n\ndef fail_rf(errors):\n # check for combinations of RF errors\n ecode = 0\n eset = set(errors)\n\n # error affects only bp tx\n if ((322 in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3000\n errors.append(ecode)\n\n # error affects only bp rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3010\n errors.append(ecode)\n\n # error affects only hp tx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3020\n errors.append(ecode)\n\n # error affects only hp rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 in eset)):\n ecode = 3030\n errors.append(ecode)\n\n # error affects only lp tx (both lp1 and lp2)\n if ((322 not in eset) and (422 in eset) and (2422 in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3040\n errors.append(ecode)\n\n # error affects only lp rx (both lp1 and lp2)\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 in eset) and (2722 in eset) and (822 not in eset)):\n ecode = 3050\n errors.append(ecode)\n\n # error in tx amp path\n if ((2422 in eset) and (352 not in eset) and (452 not in eset) and (2452 not in eset)):\n ecode = 3060\n errors.append(ecode)\n\n # error in rx amp path\n if ((2722 in eset) and (652 not in eset) and (752 not in eset) and (2752 not in eset)):\n ecode = 3070\n errors.append(ecode)\n\n # error in amp bypass path\n if ((352 in eset) and (452 in eset) and (2452 in eset) and (652 in eset) and (752 in eset) and (2752 in eset) and (322 not in eset) and (422 not in eset) and (2422 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset)):\n ecode = 3080\n errors.append(ecode)\n\n # error in lpf path\n if (((422 in eset) and (2422 in eset)) and ((722 in eset) and (2722 in eset)) and ((322 not in eset) and (622 not in eset)) and ((522 not in eset) and (822 not in eset))):\n ecode = 3090\n errors.append(ecode)\n\n # error in hpf path\n if (((522 in eset) and (822 in eset)) and ((322 not in eset) and (622 not in eset)) and ((422 not in eset) and (2422 not in eset) and (722 not in eset) and (2722 not in eset))):\n ecode = 3100\n errors.append(ecode)\n\n # error affects both mixer bypass paths\n if ((322 in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3110\n errors.append(ecode)\n\n # error in mixer tx/rx\n if ((322 not in eset) and ((422 in eset) or (2422 in eset)) and (522 in eset) and (622 not in eset) and ((722 in eset) or (2722 in eset) or (822 in eset))):\n ecode = 3120\n errors.append(ecode)\n\n if ((322 not in eset) and ((422 in eset) or (2422 in eset) or (522 in eset)) and (622 not in eset) and ((722 in eset) and (2722 in eset) and (822 in eset))):\n ecode = 3120\n errors.append(ecode)\n\n # error in all tx, no rx\n if ((322 in eset) and (422 in eset) and (2422 in eset) and (522 in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset) and (352 in eset) and (452 in eset) and (2452 in eset) and (552 in eset)):\n ecode = 3130\n errors.append(ecode)\n\n # error in all rx, no tx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 in eset) and (722 in eset) and (2722 in eset) and (822 in eset) and (652 in eset) and (752 in eset) and (2752 in eset) and (852 in eset)):\n ecode = 3140\n errors.append(ecode)\n\n # error in all mixer tx\n if ((322 not in eset) and (422 in eset) and (2422 in eset) and (522 in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3150\n errors.append(ecode)\n\n # error in all mixer rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 in eset) and (2722 in eset) and (822 in eset)):\n ecode = 3160\n errors.append(ecode)\n\n # error affecting only lp2 tx\n if ((322 not in eset) and (422 not in eset) and (2422 in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset) and (2752 in eset)):\n ecode = 3170\n errors.append(ecode)\n\n # error affecting only lp2 rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 in eset) and (822 not in eset) and (2752 in eset)):\n ecode = 3180\n errors.append(ecode)\n\n # error affecting only lp2 rx/tx\n if ((322 not in eset) and (422 not in eset) and (2422 in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 in eset) and (822 not in eset)):\n ecode = 3190\n errors.append(ecode)\n\n # error in all rx/tx\n if ((322 in eset) and (422 in eset) and (2422 in eset) and (522 in eset) and (622 in eset) and (722 in eset) and (2722 in eset) and (822 in eset)):\n ecode = 3200\n errors.append(ecode)\n\n # If there are clipping failures, we can't trust the other RF results, so fail().\n tx_clipping_count = 0\n rx_clipping_count = 0\n for code in (323, 353, 423, 453, 2423, 2453, 523, 553):\n if code in eset:\n tx_clipping_count += 1\n for code in (623, 653, 723, 753, 2723, 2753, 823, 853):\n if code in eset:\n rx_clipping_count += 1\n if tx_clipping_count > 1 and rx_clipping_count == 0:\n fail(3230)\n elif tx_clipping_count == 0 and rx_clipping_count > 1:\n fail(3240)\n elif tx_clipping_count > 0 and rx_clipping_count > 0:\n fail(3220)\n\n elif (not ecode) and (len(errors) > 1):\n # multiple failures without a logical grouping\n ecode = 3210\n errors.append(ecode)\n\n for error in errors[:-1]:\n out(f\"RF failure {error}: {emessages[error]}\")\n fail(errors[-1])\n\ndef log(message=\"\"):\n if args.log:\n with open(args.log, \"a\") as log_file:\n print(message, file=log_file)\n return\n\ndef out(message=\"\"):\n log(message)\n print(message)\n\ndef fail(error_code):\n out(f\"FAIL {error_code}: {emessages[error_code]}\")\n sys.exit(2)\n\nclass HackRF:\n def __init__(self, name, bin_dir, serial, mf_check, id=None, revision=None, unique_bin=False, factory_test=False):\n self.name = name\n self.bin_dir = bin_dir\n self.unique_bin = unique_bin\n self.id = None\n self.revision = None\n self.serial = None\n self.clkout_connected = False\n self.tester_cal = [0] * 16\n self.eut_cal = [0] * 16\n self.errors = []\n self.unit_number = 0\n self.partner = None\n\n if self.name == \"TESTER\":\n self.unit_number = 1\n elif self.name == \"EUT\":\n self.rf_test_cases = praline_rf_test_cases\n else:\n fail(99)\n\n info = subprocess.run([bin_dir + \"/hackrf_info\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n log(info.stdout + info.stderr)\n if info.returncode != 0 or \"failed\" in info.stderr:\n fail(87)\n\n # parse the hackrf_info output\n count = info.stdout.count(\"Found HackRF\")\n if count < 1:\n fail(92)\n if count > 1 and self.name == \"TESTER\" and self.unique_bin:\n fail(83)\n if mf_check and \"does not appear to have been manufactured by Great Scott Gadgets\" in info.stdout:\n fail(90 + self.unit_number)\n\n try:\n sn = \"\"\n devices_list = [d.strip() for d in info.stdout.split(\"Found HackRF\") if d.strip()]\n for device in devices_list:\n sn_found = re.search(r'Serial number: \\w+', device)\n if sn_found:\n sn = sn_found.group(0).split(': ')[1]\n\n id_found = re.search(r'Board ID Number: .', device)\n if id_found:\n id = id_found.group(0).split(': ')[1]\n\n rev_found = re.search(r'Hardware Revision: .+', device)\n if rev_found:\n rev = rev_found.group(0).split(': ')[1]\n\n if sn == serial:\n self.serial = sn\n self.id = id\n self.revision = rev\n break\n\n out(f\"{self.name} Serial number: {self.serial}\")\n out(f\"{self.name} Board ID: {self.id}\")\n out(f\"{self.name} Hardware Revision: {self.revision}\")\n out(f\"{self.name} binary directory {self.bin_dir}\")\n except:\n out(traceback.format_exc())\n fail(6)\n\n if self.serial == None:\n fail(80 + self.unit_number)\n\n if self.name == \"TESTER\" and factory_test and (self.id != \"2\" and self.id != \"4\"):\n fail(8)\n elif self.name == \"EUT\" and factory_test and self.id != \"5\":\n fail(9)\n\n if revision and self.revision != revision:\n fail(88 + self.unit_number)\n\n if self.revision == \"r9\":\n self.tester_cal = r9_tester_cal\n self.eut_cal = r9_eut_cal\n else:\n self.tester_cal = og_tester_cal\n self.eut_cal = og_eut_cal\n\n if self.name == \"EUT\" and self.id == \"5\" and self.revision == \"r1.1\":\n self.rf_test_cases = praline_r110_rf_test_cases\n\n def clkin(self):\n if self.name == \"EUT\" and self.id == \"5\":\n debug = subprocess.run([self.bin_dir + \"/hackrf_debug\", \"-d\", self.serial,\n \"-C\", \"0\"])\n command = subprocess.run([self.bin_dir + \"/hackrf_clock\", \"-i\", \"-d\",\n self.serial], capture_output=True, encoding=\"utf-8\",\n timeout=TIMEOUT)\n if command.returncode != 0:\n log(command.stdout + command.stderr)\n out(f\"{self.name} CLKIN request failed\")\n fail(200)\n if \"no clock signal detected\" in command.stdout:\n log(f\"{self.name}: no clock signal detected\")\n return False\n elif \"clock signal detected\" in command.stdout:\n log(f\"{self.name}: clock signal detected\")\n return True\n else:\n log(command.stdout + command.stderr)\n out(f\"Couldn't parse {self.name} CLKIN status\")\n fail(200)\n\n # Warning: Avoid clock loops by disabling your partner's CLKOUT before\n # enabling your own.\n def clkout(self, enable):\n command = subprocess.run([self.bin_dir + \"/hackrf_clock\", \"-o\",\n \"1\" if enable else \"0\", \"-d\", self.serial], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n if command.returncode != 0:\n log(command.stdout + command.stderr)\n out(f\"{self.name} CLKOUT control failed\")\n fail(200)\n\n if self.partner and self.clkout_connected:\n timeout = time.time() + 1\n while time.time() < timeout:\n if self.partner.clkin() == enable:\n break\n if self.partner.clkin() != enable:\n if enable:\n fail(210 + self.unit_number)\n else:\n if self.name == \"EUT\":\n out(\"Note: use --tcxo to use TCXO or external reference on TESTER\")\n fail(212 + self.unit_number)\n\n # transceiver operation to switch clock source\n source = \"CLKIN\" if enable else \"crystal\"\n log(f\"switching {self.partner.name} to {source}\")\n receive = subprocess.run([self.partner.bin_dir + \"/hackrf_transfer\", \"-d\",\n self.partner.serial, \"-n1\", \"-r\", \"/dev/null\", \"-f\", \"2500000000\",\n \"-a\", \"0\", \"-l\", \"0\", \"-g\", \"0\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n fail(220 + self.unit_number)\n\n # confirm that PLL locked to new source\n expected_value = \"0x01\" if (enable and self.partner.revision != \"r9\") else \"0x51\"\n timeout = time.time() + 1\n while time.time() < timeout:\n debug = subprocess.run([self.partner.bin_dir + \"/hackrf_debug\", \"-d\",\n self.partner.serial, \"-srn0\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n log(debug.stdout)\n if debug.returncode != 0:\n log(debug.stderr)\n fail(230 + self.unit_number)\n if expected_value in debug.stdout:\n break\n if expected_value not in debug.stdout:\n fail(232 + self.unit_number)\n time.sleep(0.1)\n else:\n time.sleep(0.2)\n\n def test_clkout(self):\n assert self.clkout_connected\n self.partner.clkout(False)\n self.clkout(True)\n frequency_error_ppm = self.clock_error_ppm()\n log(f\"{self.name}->{self.partner.name} CLK: {frequency_error_ppm} ppm\")\n if abs(frequency_error_ppm) > 1:\n out(f\"{self.partner.name} CLKIN: unexpected frequency error while synchronized\")\n fail(240)\n\n def test_clkin(self):\n self.partner.test_clkout()\n\n def clock_error_ppm(self):\n # ppm.freq is in MHz, but we use it as Hz for the FFT bin width,\n # resulting in bins with a width of 1 ppm of the transmission\n # frequency.\n bin_width = str(ppm.freq)\n tx_frequency = str(ppm.freq * ONE_MHZ)\n sweep_range = f\"{ppm.freq-1}:{ppm.freq+19}\"\n expected_bin = round(ONE_MHZ/ppm.freq)\n\n log(f\"{self.name} transmitting to {self.partner.name} for PPM measurement\")\n transmit = subprocess.Popen([self.bin_dir + \"/hackrf_transfer\", \"-d\",\n self.serial, \"-c\", \"127\", \"-a\", \"0\", \"-x\", f\"{ppm.tx_gain}\", \"-f\",\n tx_frequency], stdout=subprocess.PIPE, stderr=subprocess.PIPE,\n encoding=\"utf-8\")\n\n time.sleep(SLEEP_TIME)\n sweep = subprocess.run([self.partner.bin_dir + \"/hackrf_sweep\", \"-d\",\n self.partner.serial, \"-N\", \"13\", \"-w\", bin_width, \"-f\", sweep_range, \"-a\",\n \"0\", \"-l\", f\"{ppm.rx_lna_gain}\", \"-g\", f\"{ppm.rx_vga_gain}\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if sweep.returncode != 0:\n log(sweep.stdout + sweep.stderr)\n fail(250)\n\n # parse the hackrf_sweep output\n try:\n rows = sweep.stdout.split(\"\\n\")\n # Note: skipping data from the first twelve sweeps until issue #1230 is resolved.\n row = rows[48].split(\", \")\n bins = [float(bin) for bin in row[6:]]\n peak_bin = bins.index(max(bins))\n frequency_error_ppm = peak_bin - expected_bin\n except:\n log(sweep.stdout + sweep.stderr)\n log(traceback.format_exc())\n fail(252)\n\n log(f\"PPM max bin {peak_bin} power: {bins[peak_bin]}\")\n for row in rows[0:49:4]:\n bins = [float(bin) for bin in row.split(\", \")[6:]]\n peak_bin = bins.index(max(bins))\n log(f\"peak bin {peak_bin}: {bins[peak_bin]}\")\n if max(bins) < SIGNAL_THRESHOLD:\n fail(254 + self.unit_number)\n transmit.terminate()\n tx_out, tx_err = transmit.communicate(timeout=TIMEOUT)\n if transmit.returncode != 0:\n log(tx_out + tx_err)\n out(f\"Warning: {self.name} PPM test transmit failed\")\n return frequency_error_ppm\n\n def test_xtal(self):\n self.clkout(False)\n self.partner.clkout(False)\n frequency_error_ppm = self.clock_error_ppm()\n out(f\"{self.name} crystal frequency error: {frequency_error_ppm} ppm\")\n if abs(frequency_error_ppm) > MAX_PPM:\n fail(260)\n\n def verify_register(self, target, address, value):\n command = subprocess.run([self.bin_dir + \"/hackrf_debug\",\n f\"--{target}\", \"--register\", address, \"--read\", \"--device\",\n self.serial], capture_output=True, encoding=\"UTF-8\")\n log(f\"Checking {target} register {address}\")\n if value in command.stdout:\n return True\n else:\n log(\"Unexpected result:\")\n log(command.stdout + command.stderr)\n return False\n\n def test_clkgen(self):\n if not self.verify_register(\"si5351\", \"2\", \"0x03\"):\n fail(100 + self.unit_number)\n\n def test_mixer(self):\n if not self.verify_register(\"rffc5072\", \"2\", \"0x9055\"):\n fail(140 + self.unit_number)\n\n def test_xcvr(self):\n if not self.verify_register(\"max283\", \"28\", \"0x0c0\"):\n fail(120 + self.unit_number)\n\n def test_serial(self):\n log(f\"Testing {self.name} serial communications\")\n self.test_clkgen()\n self.test_mixer()\n self.test_xcvr()\n\n # Ensure that hackrf_transfer works and that the received power is within\n # the expected range with no transmission active.\n def baseline_rx(self, test_case):\n # Test at the TX tuning frequency of measure_rf()\n center_freq = (test_case.freq * ONE_MHZ) + 1500000\n receive = subprocess.run([self.bin_dir + \"/hackrf_transfer\", \"-d\",\n self.serial, \"-n10000\", \"-r\", \"/dev/null\", \"-f\",\n f\"{center_freq}\", \"-a\", \"0\", \"-l\", f\"{test_case.rx_lna_gain}\",\n \"-g\", f\"{test_case.rx_vga_gain}\", \"-b\",\n \"1750000\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n log(f\"Failed {self.name} {test_case.name} baseline RX\")\n fail(300)\n\n output = str(receive.stderr).split()\n try:\n power = float(output[output.index(\"power\") + 1])\n except:\n log(receive.stdout + receive.stderr)\n log(traceback.format_exc())\n log(f\"Couldn't parse {self.name} {test_case.name} baseline RX power\")\n fail(302)\n # The theoretical minimum power is about -48 dB. The expected power is\n # about -30 dB.\n log(f\"{self.name} {test_case.name} baseline power: {power}\")\n if power > MAX_BASELINE:\n fail(306)\n\n # Check the ADC for shorts or other unexpected behavior by sampling\n # amplified noise.\n def noise_rx(self, test_case):\n num_samples = 1000\n log(f\"Testing {self.name} {test_case.name}\")\n center_freq = test_case.freq * ONE_MHZ\n\n low_gain = 0\n high_gain = 16\n while high_gain > low_gain:\n gain = (high_gain + low_gain) // 2\n receive = subprocess.run([self.bin_dir + \"/hackrf_transfer\", \"-d\",\n self.serial, \"-n\", f\"{num_samples*10}\", \"-r\", f\"{NOISE}\", \"-f\",\n f\"{center_freq}\", \"-a\", \"1\" if test_case.amp else \"0\", \"-l\",\n f\"{test_case.rx_lna_gain}\", \"-g\", f\"{gain*2 + 32}\", \"-b\",\n \"28000000\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n fail(310)\n output = str(receive.stderr).split()\n try:\n power = float(output[output.index(\"power\") + 1])\n except:\n log(receive.stdout + receive.stderr)\n log(traceback.format_exc())\n fail(311)\n log(f\"{self.name} {test_case.name} RX power at -g {gain*2 + 32}: {power}\")\n if power > -2:\n high_gain = gain\n elif power > -5:\n break\n else:\n low_gain = gain + 1\n\n # We want the power to be between -1 and -9 dB to ensure that all eight\n # bits are flipped without much clipping.\n if power < -9 or power > -1:\n fail(312)\n elif gain > 16 or gain < 4:\n fail(313)\n\n bit_count = [0] * 8\n matches = []\n for bit in range(8):\n matches.append([0] * 8)\n\n try:\n file = open(f\"{NOISE}\", \"rb\")\n data = file.read()\n assert len(data) == num_samples * 20\n data = data[-num_samples*2:]\n for byte in data:\n for bit in range(8):\n bit_count[bit] += (byte>>bit)&1\n for match_bit in range(bit + 1, 8):\n if (byte>>bit)&1 == (byte>>match_bit)&1:\n matches[bit][match_bit] += 1\n except:\n fail(315)\n log(f\"{self.name} ADC bit counts: {bit_count}\")\n log(f\"{self.name} ADC bit matches: {matches}\")\n for bit in range(7):\n if bit_count[bit] < (0.2 * len(data)) or bit_count[bit] > (0.8 * len(data)):\n log(f\"{self.name} ADC bit {bit} set in {bit_count[bit]} out of {len(data)} bytes\")\n fail(316)\n # Check for correlations between adjacent bits except between 6 and 7 (highest).\n #for match_bit in range(bit + 1, 7):\n for match_bit in range(bit + 1, 8):\n if matches[bit][match_bit] > (0.999 * len(data)):\n out(f\"{self.name} ADC bit {bit} correlates with bit {match_bit}\")\n fail(317)\n # DC bias can cause bit 7 to be predominantly unchanged, so only\n # error if there is less than 1% variation.\n if bit_count[7] < (0.001 * len(data)) or bit_count[bit] > (0.999 * len(data)):\n out(f\"{self.name} ADC bit 7 set in {bit_count[7]} out of {len(data)} bytes\")\n fail(316)\n\n def analyze_transfer(self, transfer, test_case):\n # parse the hackrf_transfer output\n output = str(transfer.stderr).split()\n try:\n power = float(output[output.index(\"power\") + 1])\n except:\n log(transfer.stdout + transfer.stderr)\n log(traceback.format_exc())\n fail(152)\n log(f\"{test_case.name} power at {test_case.freq} MHz: {power}\")\n\n if test_case.base_ecode:\n if power < SIGNAL_THRESHOLD:\n log(f\"{test_case.name} signal not strong enough\")\n self.errors.append(test_case.base_ecode + 2)\n if power > -3:\n log(f\"{test_case.name} signal clipping\")\n self.errors.append(test_case.base_ecode + 3)\n elif power < -48 or power > 0:\n fail(154)\n return power\n\n # Verify that signal power at a given IF in MHz is detected.\n def verify_if_tuning(self, test_case):\n transmit = subprocess.Popen([self.bin_dir + \"/hackrf_transfer\", \"-d\",\n self.serial, \"-c\", \"127\", \"-a\", \"0\", \"-x\", f\"{test_case.tx_gain}\",\n \"-i\", f\"{test_case.freq*ONE_MHZ}\", \"-m\", \"0\", \"-F\"],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding=\"utf-8\")\n\n time.sleep(SLEEP_TIME)\n receive = subprocess.run([self.partner.bin_dir + \"/hackrf_transfer\", \"-d\",\n self.partner.serial, \"-n10000\", \"-r\", \"/dev/null\", \"-f\",\n f\"{(test_case.freq+1)*ONE_MHZ}\", \"-a\", \"0\", \"-l\",\n f\"{test_case.rx_lna_gain}\", \"-g\", f\"{test_case.rx_vga_gain}\", \"-b\",\n \"2500000\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n transmit.terminate()\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n fail(150)\n\n power = self.analyze_transfer(receive, test_case)\n\n tx_out, tx_err = transmit.communicate(timeout=TIMEOUT)\n if transmit.returncode != 0:\n log(tx_out + tx_err)\n out(f\"Warning: {self.name} IF transmit failed\")\n return power > SIGNAL_THRESHOLD\n\n def test_if_range(self, min_case, max_case):\n low_end = IF_REQUIRED_MIN - (IF_TEST_RANGE // 2)\n min_freq = IF_REQUIRED_MIN + (IF_TEST_RANGE // 2)\n while min_freq > low_end:\n min_case.freq = (min_freq + low_end) // 2\n if self.verify_if_tuning(min_case):\n min_freq = min_case.freq\n else:\n low_end = min_case.freq + 1\n\n high_end = IF_REQUIRED_MAX + (IF_TEST_RANGE // 2)\n max_freq = IF_REQUIRED_MAX - (IF_TEST_RANGE // 2)\n while max_freq < high_end:\n max_case.freq = (max_freq + high_end + 1) // 2\n if self.verify_if_tuning(max_case):\n max_freq = max_case.freq\n else:\n high_end = max_case.freq - 1\n\n out(f\"{self.name} IF range: {min_freq}-{max_freq} MHz\")\n if min_freq > IF_REQUIRED_MIN or max_freq < IF_REQUIRED_MAX:\n fail(160)\n\n def analyze_sweep(self, sweep, test_case):\n eut_cal = self.eut_cal[self.rf_test_cases.index(test_case)]\n tester_cal = self.partner.tester_cal[self.rf_test_cases.index(test_case)]\n correction = LP2_CORRECTION if test_case.freq < 30 else 0\n\n # parse the hackrf_sweep output\n try:\n rows = sweep.stdout.split(\"\\n\")\n # Note: skipping data from the first twelve sweeps until issue #1230 is resolved.\n bins = np.zeros(225)\n # average 10 sweeps\n row_count = 0\n for row in rows[48:88:4]:\n bins += np.array([float(x) for x in row.split(\", \")[6:231]])\n row_count += 1\n assert row_count == 10\n bins /= 10\n # log the raw hackrf_sweep data before calibration\n log(f\"{', '.join(rows[12].split(', ')[:6])}, {np.array2string(bins, separator=', ', max_line_width=3000)[1:-1]}\")\n # apply calibration\n bins -= eut_cal\n bins -= tester_cal\n peak_bin = bins.argmax()\n except:\n log(sweep.stdout + sweep.stderr)\n log(traceback.format_exc())\n out(f\"Couldn't parse {test_case.name} sweep data\")\n fail(172)\n\n # ensure acceptable performance\n log(f\"peak ({peak_bin}) {test_case.name}: {bins[peak_bin]:.2f}\")\n if bins[peak_bin] < SIGNAL_THRESHOLD:\n for row in rows[0:88:4]:\n bins = [float(bin) for bin in row.split(\", \")[6:]]\n peak_bin = bins.index(max(bins))\n log(f\"peak bin {peak_bin}: {bins[peak_bin]}\")\n log(f\"{test_case.name} signal not strong enough\")\n self.errors.append(test_case.base_ecode + 2)\n return bins[peak_bin]\n elif bins[peak_bin] > MAX_POWER:\n log(f\"{test_case.name} signal clipping\")\n self.errors.append(test_case.base_ecode + 3)\n return bins[peak_bin]\n tx_dc_power_dbc = bins[112] - bins[peak_bin]\n if tx_dc_power_dbc > MAX_DC_DBC + correction:\n log(f\"{test_case.name} excessive TX DC offset {tx_dc_power_dbc:.1f} dBc\")\n self.errors.append(test_case.base_ecode + 1)\n if peak_bin == 157:\n log(f\"{test_case.name} TX spectrum inverted\")\n self.errors.append(test_case.base_ecode + 25)\n return bins[peak_bin]\n elif peak_bin == 112:\n log(f\"{test_case.name} peak found at DC\")\n self.errors.append(test_case.base_ecode + 1)\n return bins[peak_bin]\n elif peak_bin >= 52 and peak_bin < 67:\n log(f\"{test_case.name} peak found at adjacent frequency\")\n self.errors.append(test_case.base_ecode + 15)\n return bins[peak_bin]\n elif peak_bin > 67 and peak_bin <= 82:\n log(f\"{test_case.name} peak found at adjacent frequency\")\n self.errors.append(test_case.base_ecode + 20)\n return bins[peak_bin]\n elif peak_bin != 67:\n log(f\"{test_case.name} peak found at unexpected frequency\")\n self.errors.append(test_case.base_ecode + 5)\n return bins[peak_bin]\n\n if bins[157] - bins[67] > MAX_M_DBC + correction:\n log(f\"{test_case.name} TX spectrum mirrored\")\n self.errors.append(test_case.base_ecode + 25)\n if (bins[22] - bins[67]) > MAX_H2_DBC + correction:\n log(f\"{test_case.name} excessive TX harmonic (bin 22): {bins[22]}\")\n self.errors.append(test_case.base_ecode + 10)\n if (bins[202] - bins[67]) > MAX_MH2_DBC + correction:\n log(f\"{test_case.name} excessive TX harmonic (bin 202): {bins[202]}\")\n self.errors.append(test_case.base_ecode + 10)\n worst_other_dbc = -999\n worst_other_bin = 999\n for i in range(225):\n # Skip various frequencies where spurs are expected (most of which have their own tests above).\n if (i < 52 and i != 22) or (i > 82 and i < 111) or (i > 113 and i < 156) or (i > 158 and i != 202):\n other_dbc = bins[i] - bins[67]\n if other_dbc > worst_other_dbc:\n worst_other_dbc = other_dbc\n worst_other_bin = i\n if worst_other_dbc > MAX_OTHER_DBC + correction:\n log(f\"{test_case.name} excessive power at unexpected frequency ({worst_other_bin}: {bins[worst_other_bin]})\")\n self.errors.append(test_case.base_ecode + 30)\n log(f\"h2 (22) {test_case.name}: {(bins[22] - bins[67]):.2f}\")\n log(f\"DC (112) {test_case.name}: {(bins[112] - bins[67]):.2f}\")\n log(f\"m (157) {test_case.name}: {(bins[157] - bins[67]):.2f}\")\n log(f\"mh2 (202) {test_case.name}: {(bins[202] - bins[67]):.2f}\")\n log(f\"other ({worst_other_bin}) {test_case.name}: {worst_other_dbc:.2f}\")\n #FIXME look in another row for RX inversion?\n return bins[peak_bin]\n\n def measure_rf(self, test_case, sweep=True):\n log(f\"Executing RF test case {test_case.name}, sweep={sweep}\")\n if test_case.direction == \"tx\":\n transmitter = self\n tx_amp = \"1\" if test_case.amp else \"0\"\n receiver = self.partner\n rx_amp = \"0\"\n elif test_case.direction == \"rx\":\n transmitter = self.partner\n tx_amp = \"0\"\n receiver = self\n rx_amp = \"1\" if test_case.amp else \"0\"\n else:\n out(f\"Error: Invalid direction in {test_case.name}\")\n sys.exit(1)\n\n # The nominal test frequency (as specified in test_case) is 1 MHz above\n # the low end of the sweep range. The transmitted signal is 500 kHz\n # above the nominal frequency, and the tuning (center) frequency of the\n # transmitting device is 1 MHz above that.\n tx_center_freq = (test_case.freq * ONE_MHZ) + 1500000\n sweep_range = f\"{test_case.freq-1}:{test_case.freq+19}\"\n\n transmit = subprocess.Popen([transmitter.bin_dir + \"/hackrf_transfer\", \"-d\",\n transmitter.serial, \"-R\", \"-t\", WAVEFORM, \"-a\", tx_amp, \"-x\",\n f\"{test_case.tx_gain}\", \"-f\", str(tx_center_freq)],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding=\"utf-8\")\n\n time.sleep(SLEEP_TIME)\n if sweep:\n receive = subprocess.run([receiver.bin_dir + \"/hackrf_sweep\",\n \"-d\", receiver.serial, \"-N\", \"22\", \"-w\", \"22222\", \"-f\",\n sweep_range, \"-a\", rx_amp, \"-l\", f\"{test_case.rx_lna_gain}\",\n \"-g\", f\"{test_case.rx_vga_gain}\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n else:\n receive = subprocess.run([receiver.bin_dir + \"/hackrf_transfer\",\n \"-d\", receiver.serial, \"-n10000\", \"-r\", \"/dev/null\", \"-f\",\n f\"{(test_case.freq)*ONE_MHZ}\", \"-a\", rx_amp, \"-l\",\n f\"{test_case.rx_lna_gain}\", \"-g\", f\"{test_case.rx_vga_gain}\",\n \"-b\", \"2500000\"], capture_output=True, encoding=\"utf-8\",\n timeout=TIMEOUT)\n transmit.terminate()\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n log(f\"{receiver.name} Failed RX, sweep={sweep}\")\n fail(170)\n\n if sweep:\n rssi = self.analyze_sweep(receive, test_case)\n else:\n rssi = self.analyze_transfer(receive, test_case)\n\n tx_out, tx_err = transmit.communicate(timeout=TIMEOUT)\n if transmit.returncode != 0:\n out(tx_out + tx_err)\n out(f\"Warning: {transmitter.name} transmit failed\")\n return rssi\n\n def test_rf_preliminary(self):\n results = []\n\n for test_case in (self.rf_test_cases):\n if test_case.amp == False:\n if test_case.direction == \"rx\":\n self.baseline_rx(test_case)\n elif self.partner:\n self.partner.baseline_rx(test_case)\n\n self.noise_rx(noise)\n # FIXME test for RX DC offset?\n\n if not self.partner:\n out(\"Skipping RF tests\")\n return\n\n for test_case in (self.rf_test_cases):\n results.append(int(round(self.measure_rf(test_case, sweep=False) - (SIGNAL_THRESHOLD + 11))))\n\n log(f\"Preliminary results: {results}\")\n if self.errors:\n fail_rf(self.errors)\n\n def test_rf(self):\n assert self.partner\n results = []\n\n for test_case in (self.rf_test_cases):\n results.append(int(round(self.measure_rf(test_case, sweep=True) - (SIGNAL_THRESHOLD + 5))))\n\n out(f\"RF results summary: {results}\")\n if self.errors:\n fail_rf(self.errors)\n\n def activate_leds(self, enable):\n if enable:\n out(f\"Activating {self.name} LEDs\")\n state = 7\n else:\n state = 1\n # Always illuminate MCU LED on Praline.\n if self.id == \"5\":\n state |= 8\n command = subprocess.run([self.bin_dir + \"/hackrf_debug\", \"-d\", self.serial, \"--leds\",\n f\"{state}\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if command.returncode != 0:\n log(command.stdout + command.stderr)\n log(f\"Failed to configure {self.name} LEDs ({state})\")\n fail(190)\n\n def debug_selftest(self):\n errors = []\n\n debug = subprocess.run([self.bin_dir + \"/hackrf_debug\", \"-to\", \"-d\", self.serial],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n log(debug.stdout + debug.stderr)\n\n fpga_test_found = re.search(r'FPGA configuration: \\w+', debug.stdout)\n if fpga_test_found:\n if fpga_test_found.group(0).split(': ')[-1] != \"PASS\":\n errors.append(14)\n else:\n out(\"Failure to find FPGA configuration result. Wrong firmware version? Continuing...\")\n\n # Check for FPGA SPI result only if FPGA configuration passed.\n if len(errors) == 0:\n sgpio_test_found = re.search(r'FPGA SPI: \\w+', debug.stdout)\n if sgpio_test_found:\n if sgpio_test_found.group(0).split(': ')[-1] != \"PASS\":\n errors.append(24)\n else:\n out(\"Failure to find FPGA SPI test result. Wrong firmware version? Continuing...\")\n\n # Check for SGPIO result only if FPGA configuration and SPI passed.\n if len(errors) == 0:\n sgpio_test_found = re.search(r'SGPIO RX test: \\w+', debug.stdout)\n if sgpio_test_found:\n if sgpio_test_found.group(0).split(': ')[-1] == \"TIMEOUT\":\n errors.append(22)\n elif sgpio_test_found.group(0).split(': ')[-1] == \"FAIL\":\n errors.append(11)\n else:\n out(\"Failure to find sgpio test result. Wrong firmware version? Continuing...\")\n\n # Check for loopback result only if FPGA, SPI, and SGPIO passed.\n if len(errors) == 0:\n loopback_test_found = re.search(r'Loopback test: \\w+', debug.stdout)\n if loopback_test_found:\n if loopback_test_found.group(0).split(': ')[-1] == \"TIMEOUT\":\n errors.append(23)\n elif loopback_test_found.group(0).split(': ')[-1] == \"FAIL\":\n errors.append(12)\n else:\n out(\"Failure to find loopback test result. Wrong firmware version? Continuing...\")\n\n clock_found = re.search(r'Clock: \\w+, \\w+: \\d, readback: \\w+', debug.stdout)\n if clock_found:\n if clock_found.group(0).split(': ')[-1] != \"OK\":\n errors.append(10)\n else:\n out(\"Failure to find clock results. Wrong firmware version? Continuing...\")\n\n mixer_found = re.search(r'Mixer: \\w+, ID: \\d+', debug.stdout)\n if mixer_found:\n if mixer_found.group(0).split(': ')[-1] != \"4416\":\n errors.append(16)\n else:\n out(\"Failure to find mixer results. Wrong firmware version? Continuing...\")\n\n # Check for transceiver result only if FPGA configuration passed.\n if 14 not in errors:\n xcvr_found = re.search(r'Transceiver: \\w+, RSSI mux test: \\w+', debug.stdout)\n if xcvr_found:\n if xcvr_found.group(0).split(': ')[-1] != \"PASS\":\n errors.append(17)\n else:\n out(\"Failure to find transceiver results. Wrong firmware version? Continuing...\")\n\n rtc_found = re.search(r'RTC test result: \\w+', debug.stdout)\n if rtc_found:\n if rtc_found.group(0).split(': ')[-1] != \"PASS\":\n errors.append(18)\n else:\n out(\"Failure to find 32kHz oscillator results. Wrong firmware version? Continuing...\")\n\n # Provide entire self-test report if there is an unrecognized self-test failure\n if len(errors) == 0:\n selftest_found = re.search(r'Self-test result: \\w+', debug.stdout)\n if selftest_found:\n if selftest_found.group(0).split(': ')[-1] != \"PASS\":\n out(debug.stdout)\n fail(13)\n else:\n out(\"Failure to find selftest results. Wrong firmware version? Continuing...\")\n\n # Report multiple self-test failures\n if len(errors) > 1:\n for error in errors:\n out(f\"Self-test failure {error}: {emessages[error]}\")\n fail(15)\n\n if len(errors) > 0:\n fail(errors[-1])\n\n def reset(self):\n out(f\"Resetting {self.name}\")\n spiflash = subprocess.run([self.bin_dir + \"/hackrf_spiflash\", \"-d\", self.serial, \"-R\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if spiflash.returncode != 0:\n out(spiflash.stdout + spiflash.stderr)\n fail(76 + self.unit_number)\n\n then = time.time()\n device_found = False\n while time.time() < (then + 5):\n time.sleep(1)\n info = subprocess.run([self.bin_dir + \"/hackrf_info\"],\n capture_output=True, timeout=TIMEOUT)\n if self.serial in info.stdout.decode('utf-8', errors='ignore'):\n device_found = True\n break\n time.sleep(0.1)\n if not device_found:\n fail(78 + self.unit_number)\n\n\n# This waveform is a full-scale complex exponential with a frequency of -1/10 the\n# sample rate. When transmitted at 10 Msps, the frequency is 1 MHz below the\n# center frequency.\n\ndef write_waveform():\n tx_bytes = b'\\x7f\\x00\\x67\\xb5\\x27\\x87\\xd9\\x87\\x99\\xb5\\x81\\x00\\x99\\x4b\\xd9\\x79\\x27\\x79\\x67\\x4b'\n # defective waveform with DC offset:\n #tx_bytes = b'\\x7f\\x10\\x67\\xa5\\x27\\x97\\xd9\\x97\\x99\\xc5\\x81\\x10\\x99\\x5b\\xd9\\x7f\\x27\\x7f\\x67\\x5b'\n # defective waveform with missing Q channel:\n #tx_bytes = b'\\x7f\\x00\\x67\\x00\\x27\\x00\\xd9\\x00\\x99\\x00\\x81\\x00\\x99\\x00\\xd9\\x00\\x27\\x00\\x67\\x00'\n with open(WAVEFORM, \"wb\") as bin_file:\n for i in range(50000): # 1MB file size\n bin_file.write(tx_bytes)\n\n\ndef program(bin_dir, fw_dir, serial, unattended=False):\n binary = \"hackrf_usb.bin\"\n dfu_stub = \"hackrf_usb.dfu\"\n\n # EUTs in unattended (including Jenkins CI) setups have pins jumped to always boot into DFU mode, so resetting is undesirable\n if unattended:\n reset_write = \"-w\"\n else:\n reset_write = \"-Rw\"\n\n if not usb.core.find(idVendor=DFU_VENDOR_ID, idProduct=DFU_PRODUCT_ID):\n print(\"ACTION REQUIRED: Press and release EUT RESET button while holding DFU button.\")\n while not usb.core.find(idVendor=DFU_VENDOR_ID, idProduct=DFU_PRODUCT_ID):\n time.sleep(0.1)\n\n out(\"Programming EUT in DFU mode\")\n dfu = subprocess.run([f\"{DFU_UTIL}\", \"--device\",\n f\"{DFU_VENDOR_ID}:{DFU_PRODUCT_ID}\", \"--alt\", \"0\", \"--download\",\n f\"{fw_dir}/{dfu_stub}\"], capture_output=True, encoding=\"utf-8\",\n timeout=TIMEOUT)\n out(dfu.stdout + dfu.stderr)\n\n #dfu-util: unable to read DFU status after completion (LIBUSB_ERROR_IO)\n # despite successful download; present as of at least dfu-util 0.11\n if \"Download done.\" not in dfu.stdout:\n fail(60)\n\n # Wait for device to boot from DFU.\n then = time.time()\n dfu_device_found = False\n while time.time() < (then + 50):\n dfu_info = subprocess.run([bin_dir + \"/hackrf_info\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n\n if \"RunningFromRAM\" in dfu_info.stdout:\n if serial in dfu_info.stdout and serial != \"RunningFromRAM\":\n fail(1)\n else:\n dfu_device_found = True\n break\n time.sleep(0.1)\n if not dfu_device_found:\n fail(2)\n\n out(\"Programming EUT SPI flash\")\n spiflash = subprocess.run([bin_dir + \"/hackrf_spiflash\", \"-d\",\n \"RunningFromRAM\", reset_write, f\"{fw_dir}/{binary}\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT+20)\n if spiflash.returncode != 0:\n log(spiflash.stdout + spiflash.stderr)\n fail(70)\n\n then = time.time()\n device_found = False\n while time.time() < (then + 5):\n time.sleep(1)\n flash_info = subprocess.run([bin_dir + \"/hackrf_info\"], capture_output=True,\n timeout=TIMEOUT)\n if serial == \"RunningFromRAM\" and not unattended:\n try:\n devices_list = [d.strip() for d in flash_info.stdout.decode('utf-8', errors='ignore').split(\"Found HackRF\") if d.strip()]\n for device in devices_list:\n sn_found = re.search(r'Serial number: \\w+', device)\n if sn_found:\n serial = sn_found.group(0).split(': ')[1]\n except:\n log(traceback.format_exc())\n fail(6)\n if serial in flash_info.stdout.decode('utf-8', errors='ignore'):\n device_found = True\n break\n time.sleep(0.1)\n if not device_found:\n fail(75)\n\n\ndef find_sn(name, bin_dir, factory_test, claimed_sns=[]):\n while True:\n sn_list = []\n info = subprocess.run([bin_dir + \"/hackrf_info\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n try:\n sn = \"\"\n devices_list = [d.strip() for d in info.stdout.split(\"Found HackRF\") if d.strip()]\n for device in devices_list:\n sn_found = re.search(r'Serial number: \\w+', device)\n if sn_found:\n new_sn = sn_found.group(0).split(': ')[1]\n if new_sn not in claimed_sns:\n sn_list.append(new_sn)\n except:\n log(traceback.format_exc())\n fail(6)\n\n if factory_test:\n if len(sn_list) > 1:\n fail(19)\n elif len(sn_list) < 1:\n if name == \"TESTER\":\n fail(20)\n elif name == \"EUT\":\n fail(21)\n else:\n sn = sn_list[0]\n break\n else:\n if len(sn_list) > 1:\n out(f\"\\nPotential {name}(s) found:\\n\")\n for i in range(len(sn_list)):\n out(f\"{i}: {sn_list[i]}\")\n choice = int(input(f\"\\nEnter the index of your target {name}s serial number: \"))\n if 0 <= choice < len(sn_list):\n sn = sn_list[choice]\n break\n else:\n out(\"Incorrect choice, try again.\")\n elif len(sn_list) == 1:\n sn = sn_list[0]\n break\n else:\n fail(3)\n return sn\n\n\ndef get_version():\n version = subprocess.run([\"git\", \"log\", \"-n\" \"1\", \"--format=%h\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if version.returncode != 0:\n return \"2026.01.3+\"\n elif version.returncode == 0:\n dirty = subprocess.run([\"git\", \"status\", \"-s\", \"--untracked-files=no\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if dirty.stdout != \"\":\n dirty_flag = \"*\"\n else:\n dirty_flag = \"\"\n return f\"git-{version.stdout.strip()}{dirty_flag}\"\n\n\ndef main():\n\n write_waveform()\n\n parser = argparse.ArgumentParser(description=\"Utility for testing HackRF One\")\n parser.add_argument(\"-c\", \"--noclk\", action=\"store_true\", help=\"skip CLKIN, CLKOUT, and PPM tests\")\n parser.add_argument(\"-i\", \"--noif\", action=\"store_true\", help=\"skip IF tuning range test\")\n parser.add_argument(\"-l\", \"--loop\", action=\"store_true\", help=\"repeat the test until terminated with ctrl-c\")\n parser.add_argument(\"-m\", \"--manufacturer\", action=\"store_true\", help=\"check the manufacturer of target devices\")\n parser.add_argument(\"-r\", \"--rev\", metavar=\" or \\\"any\\\"\", type=str,\n help=\"check EUT pin straps for specific hardware revision (default: \\\"r9\\\")\",\n default=\"r9\")\n parser.add_argument(\"-s\", \"--solo\", action=\"store_true\", help=\"perform limited tests on a single EUT with no TESTER\")\n parser.add_argument(\"-t\", \"--tcxo\", action=\"store_true\", help=\"skip CLKIN/CLKOUT tests and use TCXO instead\")\n parser.add_argument(\"-E\", \"--eut\", metavar=\"\", type=str,\n help=\"EUT serial number\")\n parser.add_argument(\"-T\", \"--tester\", metavar=\"\", type=str,\n help=\"TESTER serial number\")\n parser.add_argument(\"-f\", \"--fwupdate\", metavar=\"\", type=str,\n help=\"update firmware with binaries from specified directory\")\n parser.add_argument(\"-H\", \"--hostdir\", metavar=\"\", type=str,\n help=\"location of installed hackrf host tools, will attempt to find them if omitted\")\n parser.add_argument(\"-b\", \"--testerdir\", metavar=\"\", type=str,\n help=\"necessary only if EUT/TESTER have separate host binaries\")\n parser.add_argument(\"-C\", \"--ci\", action=\"store_true\", help=\"For use with Jenkins CI user\")\n parser.add_argument(\"-p\", \"--praline\", action=\"store_true\", help=\"Force Praline mode\")\n parser.add_argument(\"-F\", \"--factory\", action=\"store_true\", help=\"Force factory test mode\")\n parser.add_argument(\"-u\", \"--unattended\", action=\"store_true\", help=\"For use with unattended hardware\")\n parser.add_argument(\"-L\", \"--log\", metavar=\"\", type=str,\n help=\"log file location\")\n global args\n args = parser.parse_args()\n\n if args.ci:\n user = \"jenkins\"\n else:\n user = os.getlogin()\n\n if \"any\" in args.rev.lower():\n args.rev = None\n elif args.rev.lower() == \"r1\" or args.rev.lower() == \"r4\":\n args.rev = \"older than r6\"\n\n if args.hostdir:\n eut_host_dir = args.hostdir\n else:\n try:\n eut_host_dir = os.path.dirname(shutil.which('hackrf_info'))\n except:\n fail(4)\n\n if args.testerdir:\n if args.testerdir == eut_host_dir:\n fail(5)\n else:\n tester_host_dir = args.testerdir\n else:\n tester_host_dir = eut_host_dir\n\n unique_bin = (tester_host_dir != eut_host_dir)\n count = 0\n\n while True:\n log()\n log(\"================================\")\n log(datetime.now())\n log(sys.argv)\n log(f\"user: {user}\")\n log(f\"version: {get_version()}\")\n log(f\"pid: {os.getpid()}\")\n if args.loop:\n log(f\"repeat count: {count}\")\n log(\"================================\")\n log()\n\n if args.eut:\n eut_sn = args.eut\n else:\n if args.tester:\n eut_sn = find_sn(\"EUT\", eut_host_dir, args.factory, [args.tester])\n else:\n eut_sn = find_sn(\"EUT\", eut_host_dir, args.factory)\n if args.tester:\n tester_sn = args.tester\n else:\n tester_sn = find_sn(\"TESTER\", tester_host_dir, args.factory, [eut_sn])\n\n if eut_sn == tester_sn:\n fail(7)\n\n # TODO: check if the provided firmware directory exists\n if args.fwupdate:\n program(eut_host_dir, args.fwupdate, eut_sn, args.unattended)\n eut_sn = find_sn(\"EUT\", eut_host_dir, args.factory, [tester_sn])\n\n if not args.rev:\n out(\"Skipping EUT hardware revision check\")\n eut = HackRF(\"EUT\", eut_host_dir, eut_sn, args.manufacturer, revision=args.rev, factory_test=args.factory)\n\n if args.solo:\n tester = None\n else:\n tester = HackRF(\"TESTER\", tester_host_dir, tester_sn, args.manufacturer, unique_bin=unique_bin, factory_test=args.factory)\n tester.partner = eut\n eut.partner = tester\n\n out(\"\\nTest started, please wait...\")\n if args.solo:\n eut.clkout_connected = False\n elif args.noclk:\n eut.clkout_connected = False\n tester.clkout_connected = False\n elif args.tcxo:\n eut.clkout_connected = False\n tester.clkout_connected = True\n else:\n eut.clkout_connected = True\n tester.clkout_connected = True\n\n if count > 0 and not args.fwupdate:\n eut.activate_leds(False)\n\n if not args.unattended:\n eut.reset()\n eut.debug_selftest()\n # limited RF test without clock synchronization\n eut.test_rf_preliminary()\n\n if args.noclk or args.solo:\n out(\"Skipping CLKIN, CLKOUT, and PPM tests\")\n else:\n eut.test_xtal()\n if not args.tcxo:\n eut.test_clkout()\n eut.test_clkin()\n\n eut.clkout(False)\n\n if tester:\n tester.clkout(True)\n\n if args.tcxo:\n if args.solo:\n out(\"Error: --solo is incompatible with --tcxo\")\n sys.exit(1)\n if tester.clkin():\n out(\"Using TCXO on TESTER\")\n else:\n out(\"Warning: No TCXO or external clock detected on TESTER\")\n out(\"Skipping CLKOUT test\")\n if not args.noclk and not eut.clkin():\n fail(211)\n\n # full RF test with clock synchronization\n if tester:\n eut.test_rf()\n\n if args.noif or args.solo:\n out(\"Skipping IF tuning range test\")\n else:\n eut.test_if_range(ifmin, ifmax)\n\n eut.activate_leds(True)\n\n if (args.solo or args.noif or args.noclk or args.tcxo or not args.rev):\n out(\"Limited test complete\")\n else:\n out(\"PASS if all 6 LEDs active with correct color\")\n\n count += 1\n if not args.loop:\n break\n\n\nif __name__ == \"__main__\":\n try:\n main()\n except KeyboardInterrupt:\n print()\n out(\"KeyboardInterrupt\")\n sys.exit(0)\n except subprocess.TimeoutExpired:\n log(traceback.format_exc())\n fail(180)\n" }, { "path": "ci-scripts/hackrf_test.py", "content": "#!/usr/bin/env python3\n\nimport sys\nimport subprocess\nimport time\nimport os, shutil\nimport usb\nfrom datetime import datetime\nfrom dataclasses import dataclass\nimport argparse\nimport numpy as np\nimport traceback\nimport re\n\nDFU_UTIL = \"/usr/bin/dfu-util\"\nTMP_DIR = \"/tmp/\"\nWAVEFORM = TMP_DIR + \"waveform100\"\nNOISE = TMP_DIR + \"noise\"\nVENDOR_ID = 0x1d50\nPRODUCT_ID = 0x6089\nDFU_VENDOR_ID = 0x1fc9\nDFU_PRODUCT_ID = 0x000c\nONE_MHZ = 1000000\nTIMEOUT = 5\nMAX_PPM = 40\nMAX_BASELINE = -20\nSIGNAL_THRESHOLD = -25\nMAX_DC_DBC = -33\nMAX_M_DBC = -27\nMAX_MH2_DBC = -40\nMAX_H2_DBC = -39\nMAX_OTHER_DBC = -34\nLP2_CORRECTION = 10\nMAX_POWER = -10\nIF_REQUIRED_MIN = 2300\nIF_REQUIRED_MAX = 2700\nIF_TEST_RANGE = 256\nSLEEP_TIME = 0.05 # seconds to wait between start of TX and start of RX\n\n@dataclass\nclass TestCase():\n name: str\n freq: int\n amp: bool\n direction: str\n base_ecode: int\n rx_lna_gain: int\n rx_vga_gain: int\n tx_gain: int\n\n# Try to keep rx_lna_gain and rx_vga_gain between 8 and 32.\nbp1txamp = TestCase(name=\"BP1-TX-amp\", freq=2665, amp=True, direction=\"tx\",\n base_ecode=320, rx_lna_gain=16, rx_vga_gain=16, tx_gain=14)\nlp1txamp = TestCase(name=\"LP1-TX-amp\", freq=915, amp=True, direction=\"tx\",\n base_ecode=420, rx_lna_gain=16, rx_vga_gain=16, tx_gain=27)\nlp2txamp = TestCase(name=\"LP2-TX-amp\", freq=2, amp=True, direction=\"tx\",\n base_ecode=2420, rx_lna_gain=8, rx_vga_gain=16, tx_gain=30)\nhp1txamp = TestCase(name=\"HP1-TX-amp\", freq=5995, amp=True, direction=\"tx\",\n base_ecode=520, rx_lna_gain=32, rx_vga_gain=28, tx_gain=37)\n\nbp1txnoamp = TestCase(name=\"BP1-TX-noamp\", freq=2665, amp=False, direction=\"tx\",\n base_ecode=350, rx_lna_gain=16, rx_vga_gain=16, tx_gain=23)\nlp1txnoamp = TestCase(name=\"LP1-TX-noamp\", freq=915, amp=False, direction=\"tx\",\n base_ecode=450, rx_lna_gain=16, rx_vga_gain=16, tx_gain=39)\nlp2txnoamp = TestCase(name=\"LP2-TX-noamp\", freq=2, amp=False, direction=\"tx\",\n base_ecode=2450, rx_lna_gain=8, rx_vga_gain=16, tx_gain=47)\nhp1txnoamp = TestCase(name=\"HP1-TX-noamp\", freq=5995, amp=False, direction=\"tx\",\n base_ecode=550, rx_lna_gain=32, rx_vga_gain=32, tx_gain=44)\n\n# Much of the information in the RX test cases is a duplication of information\n# in the TX test cases, but it's easier to keep legacy error codes this way.\nbp1rxamp = TestCase(name=\"BP1-RX-amp\", freq=2665, amp=True, direction=\"rx\",\n base_ecode=620, rx_lna_gain=16, rx_vga_gain=16, tx_gain=14)\nlp1rxamp = TestCase(name=\"LP1-RX-amp\", freq=915, amp=True, direction=\"rx\",\n base_ecode=720, rx_lna_gain=16, rx_vga_gain=16, tx_gain=29)\nlp2rxamp = TestCase(name=\"LP2-RX-amp\", freq=2, amp=True, direction=\"rx\",\n base_ecode=2720, rx_lna_gain=8, rx_vga_gain=16, tx_gain=33)\nhp1rxamp = TestCase(name=\"HP1-RX-amp\", freq=5995, amp=True, direction=\"rx\",\n base_ecode=820, rx_lna_gain=32, rx_vga_gain=28, tx_gain=39)\n\nbp1rxnoamp = TestCase(name=\"BP1-RX-noamp\", freq=2665, amp=False, direction=\"rx\",\n base_ecode=650, rx_lna_gain=16, rx_vga_gain=16, tx_gain=23)\nlp1rxnoamp = TestCase(name=\"LP1-RX-noamp\", freq=915, amp=False, direction=\"rx\",\n base_ecode=750, rx_lna_gain=16, rx_vga_gain=16, tx_gain=39)\nlp2rxnoamp = TestCase(name=\"LP2-RX-noamp\", freq=2, amp=False, direction=\"rx\",\n base_ecode=2750, rx_lna_gain=8, rx_vga_gain=16, tx_gain=47)\nhp1rxnoamp = TestCase(name=\"HP1-RX-noamp\", freq=5995, amp=False, direction=\"rx\",\n base_ecode=850, rx_lna_gain=32, rx_vga_gain=32, tx_gain=44)\n\nifmin = TestCase(name=\"IF-min\", freq=IF_REQUIRED_MIN, amp=None, direction=None,\n base_ecode=None, rx_lna_gain=16, rx_vga_gain=16, tx_gain=33)\nifmax = TestCase(name=\"IF-max\", freq=IF_REQUIRED_MAX, amp=None, direction=None,\n base_ecode=None, rx_lna_gain=16, rx_vga_gain=16, tx_gain=33)\n\nppm = TestCase(name=\"PPM\", freq=2707, amp=False, direction=None,\n base_ecode=None, rx_lna_gain=16, rx_vga_gain=16, tx_gain=26)\n\nnoise = TestCase(name=\"Noise\", freq=6000, amp=True, direction=None,\n base_ecode=None, rx_lna_gain=40, rx_vga_gain=52, tx_gain=None)\n\nall_rf_test_cases = (\n bp1txamp, lp1txamp, lp2txamp, hp1txamp,\n bp1txnoamp, lp1txnoamp, lp2txnoamp, hp1txnoamp,\n bp1rxamp, lp1rxamp, lp2rxamp, hp1rxamp,\n bp1rxnoamp, lp1rxnoamp, lp2rxnoamp, hp1rxnoamp)\n\nr9_tester_cal = [1.1, 0.4, 0.4, 1.1, 0.8, 0.2, 0.6, 1.6, -0.4, -1.2, -1.1, 1.1, -1.4, -0.9, 0.1, 1.8]\nr9_eut_cal = [-1.1, -1.6, -1.4, -1.3, -1.3, -0.9, 0.1, 1.8, 0.8, 1.1, 0.9, -0.2, 0.9, 0.2, 0.6, 1.5]\nog_tester_cal = [-0.4, -0.3, -0.2, -0.4, -0.8, -0.5, -0., -0.1, 1.4, 2., 1.6, -0.1, 1.5, 0.7, 0.5, -0.3]\nog_eut_cal = [1.8, 1.8, 1.6, 2., 1.3, 0.7, 0.5, -0.3, 0.2, -0.3, -0.5, 1.2, -0.8, -0.5, -0., -0.1]\n\nemessages = {\n # TODO: replace the placeholder code according to each fail instance\n 1: \"Placeholder error code\",\n 60: \"Unable to program firmware via DFU\",\n 65: \"EUT not detected after DFU programming\",\n 70: \"Unable to program SPI flash\",\n 75: \"EUT not detected after flashing\",\n 80: \"Could not find EUT\",\n 81: \"Could not find TESTER\",\n 82: \"Found multiple candidate EUTs\",\n 83: \"Found multiple candidate TESTERs\",\n 84: \"EUT running from RAM instead of flash\",\n 85: \"TESTER running from RAM instead of flash\",\n 86: \"Couldn't parse hackrf_info output\",\n 88: \"Incorrect EUT hardware revision\",\n 89: \"Incorrect TESTER hardware revision\",\n 90: \"EUT has incorrect manufacturer pin strap\",\n 91: \"TESTER has incorrect manufacturer pin strap\",\n 99: \"Incorrect device name\",\n 100: \"EUT couldn't verify clkgen register\",\n 101: \"TESTER couldn't verify clkgen register\",\n 120: \"EUT couldn't verify xcvr register\",\n 121: \"TESTER couldn't verify xcvr register\",\n 140: \"EUT couldn't verify mixer register\",\n 141: \"TESTER couldn't verify mixer register\",\n 150: \"Failed RX for IF verification\",\n 152: \"Couldn't parse received power\",\n 154: \"Received power out of bounds\",\n 160: \"Insufficient IF range\",\n 170: \"RX operation failed\",\n 172: \"Couldn't parse hackrf_sweep output\",\n 180: \"Subprocess timed out\",\n 190: \"Failed to configure LEDs\",\n 200: \"hackrf_clock command failed\",\n 210: \"TESTER failed to detect EUT CLKOUT\",\n 211: \"EUT failed to detect TESTER CLKOUT\",\n 212: \"TESTER detected spurious CLKIN\",\n 213: \"EUT detected spurious CLKIN\",\n 220: \"Failed TESTER CLKIN activation RX\",\n 221: \"Failed EUT CLKIN activation RX\",\n 230: \"Failed TESTER PLL check\",\n 231: \"Failed EUT PLL check\",\n 232: \"TESTER PLL failed to lock\",\n 233: \"EUT PLL failed to lock\",\n 240: \"Clock synchronization failure\",\n 250: \"Failed PPM detection sweep\",\n 252: \"Couldn't parse PPM test sweep data\",\n 254: \"TESTER couldn't detect PPM test transmission\",\n 255: \"EUT couldn't detect PPM test transmission\",\n 260: \"Frequency error exceeds limit\",\n 300: \"Failed baseline RX\",\n 302: \"Couldn't parse baseline RX power\",\n 306: \"Baseline RX power too high\",\n 310: \"Failed noise RX\",\n 311: \"Couldn't parse noise RX power\",\n 312: \"Noise RX power out of range\",\n 313: \"Required noise gain out of range\",\n 315: \"Couldn't read noise RX file\",\n 316: \"Too little variation in ADC bit\",\n 317: \"ADC bit correlates strongly with another bit\",\n\t321: \"Excessive TX DC offset in AMP txbp1\",\n\t322: \"insufficient signal strength in AMP txbp1\",\n\t323: \"AMP txbp1 clipping\",\n\t325: \"peak found at unexpected frequency in AMP txbp1\",\n\t330: \"harmonics detected in AMP txbp1\",\n\t335: \"neighbor magnitude exceeded in AMP txbp1\",\n\t340: \"neighbor magnitude exceeded in AMP txbp1\",\n\t345: \"spectrum mirrored or inverted in AMP txbp1\",\n\t350: \"excessive power out of channel in AMP txbp1\",\n\t351: \"Excessive TX DC offset in NOAMP txbp1\",\n\t352: \"insufficient signal strength in NOAMP txbp1\",\n\t353: \"NOAMP txbp1 clipping\",\n\t355: \"peak found at unexpected frequency in NOAMP txbp1\",\n\t360: \"harmonics detected in NOAMP txbp1\",\n\t365: \"neighbor magnitude exceeded in NOAMP txbp1\",\n\t370: \"neighbor magnitude exceeded in NOAMP txbp1\",\n\t375: \"spectrum mirrored or inverted in NOAMP txbp1\",\n\t380: \"excessive power out of channel in NOAMP txbp1\",\n\t421: \"Excessive TX DC offset in AMP txlp1\",\n\t422: \"insufficient signal strength in AMP txlp1\",\n\t423: \"AMP txlp1 clipping\",\n\t425: \"peak found at unexpected frequency in AMP txlp1\",\n\t430: \"harmonics detected in AMP txlp1\",\n\t435: \"neighbor magnitude exceeded in AMP txlp1\",\n\t440: \"neighbor magnitude exceeded in AMP txlp1\",\n\t445: \"spectrum mirrored or inverted in AMP txlp1\",\n\t450: \"excessive power out of channel in AMP txlp1\",\n\t451: \"Excessive TX DC offset in NOAMP txlp1\",\n\t452: \"insufficient signal strength in NOAMP txlp1\",\n\t453: \"NOAMP txlp1 clipping\",\n\t455: \"peak found at unexpected frequency in NOAMP txlp1\",\n\t460: \"harmonics detected in NOAMP txlp1\",\n\t465: \"neighbor magnitude exceeded in NOAMP txlp1\",\n\t470: \"neighbor magnitude exceeded in NOAMP txlp1\",\n\t475: \"spectrum mirrored or inverted in NOAMP txlp1\",\n\t480: \"excessive power out of channel in NOAMP txlp1\",\n\t2421: \"Excessive TX DC offset in AMP txlp2\",\n\t2422: \"insufficient signal strength in AMP txlp2\",\n\t2423: \"AMP txlp2 clipping\",\n\t2425: \"peak found at unexpected frequency in AMP txlp2\",\n\t2430: \"harmonics detected in AMP txlp2\",\n\t2435: \"neighbor magnitude exceeded in AMP txlp2\",\n\t2440: \"neighbor magnitude exceeded in AMP txlp2\",\n\t2445: \"spectrum mirrored or inverted in AMP txlp2\",\n\t2450: \"excessive power out of channel in AMP txlp2\",\n\t2451: \"Excessive TX DC offset in NOAMP txlp2\",\n\t2452: \"insufficient signal strength in NOAMP txlp2\",\n\t2453: \"NOAMP txlp2 clipping\",\n\t2455: \"peak found at unexpected frequency in NOAMP txlp2\",\n\t2460: \"harmonics detected in NOAMP txlp2\",\n\t2465: \"neighbor magnitude exceeded in NOAMP txlp2\",\n\t2470: \"neighbor magnitude exceeded in NOAMP txlp2\",\n\t2475: \"spectrum mirrored or inverted in NOAMP txlp2\",\n\t2480: \"excessive power out of channel in NOAMP txlp2\",\n\t521: \"Excessive TX DC offset in AMP txhp1\",\n\t522: \"insufficient signal strength in AMP txhp1\",\n\t523: \"AMP txhp1 clipping\",\n\t525: \"peak found at unexpected frequency in AMP txhp1\",\n\t530: \"harmonics detected in AMP txhp1\",\n\t535: \"neighbor magnitude exceeded in AMP txhp1\",\n\t540: \"neighbor magnitude exceeded in AMP txhp1\",\n\t545: \"spectrum mirrored or inverted in AMP txhp1\",\n\t550: \"excessive power out of channel in AMP txhp1\",\n\t551: \"Excessive TX DC offset in NOAMP txhp1\",\n\t552: \"insufficient signal strength in NOAMP txhp1\",\n\t553: \"NOAMP txhp1 clipping\",\n\t555: \"peak found at unexpected frequency in NOAMP txhp1\",\n\t560: \"harmonics detected in NOAMP txhp1\",\n\t565: \"neighbor magnitude exceeded in NOAMP txhp1\",\n\t570: \"neighbor magnitude exceeded in NOAMP txhp1\",\n\t575: \"spectrum mirrored or inverted in NOAMP txhp1\",\n\t580: \"excessive power out of channel in NOAMP txhp1\",\n\t621: \"Excessive TX DC offset in AMP rxbp1\",\n\t622: \"insufficient signal strength in AMP rxbp1\",\n\t623: \"AMP rxbp1 clipping\",\n\t625: \"peak found at unexpected frequency in AMP rxbp1\",\n\t630: \"harmonics detected in AMP rxbp1\",\n\t635: \"neighbor magnitude exceeded in AMP rxbp1\",\n\t640: \"neighbor magnitude exceeded in AMP rxbp1\",\n\t645: \"spectrum mirrored or inverted in AMP rxbp1\",\n\t650: \"excessive power out of channel in AMP rxbp1\",\n\t651: \"Excessive TX DC offset in NOAMP rxbp1\",\n\t652: \"insufficient signal strength in NOAMP rxbp1\",\n\t653: \"NOAMP rxbp1 clipping\",\n\t655: \"peak found at unexpected frequency in NOAMP rxbp1\",\n\t660: \"harmonics detected in NOAMP rxbp1\",\n\t665: \"neighbor magnitude exceeded in NOAMP rxbp1\",\n\t670: \"neighbor magnitude exceeded in NOAMP rxbp1\",\n\t675: \"spectrum mirrored or inverted in NOAMP rxbp1\",\n\t680: \"excessive power out of channel in NOAMP rxbp1\",\n\t721: \"Excessive TX DC offset in AMP rxlp1\",\n\t722: \"insufficient signal strength in AMP rxlp1\",\n\t723: \"AMP rxlp1 clipping\",\n\t725: \"peak found at unexpected frequency in AMP rxlp1\",\n\t730: \"harmonics detected in AMP rxlp1\",\n\t735: \"neighbor magnitude exceeded in AMP rxlp1\",\n\t740: \"neighbor magnitude exceeded in AMP rxlp1\",\n\t745: \"spectrum mirrored or inverted in AMP rxlp1\",\n\t750: \"excessive power out of channel in AMP rxlp1\",\n\t751: \"Excessive TX DC offset in NOAMP rxlp1\",\n\t752: \"insufficient signal strength in NOAMP rxlp1\",\n\t753: \"NOAMP rxlp1 clipping\",\n\t755: \"peak found at unexpected frequency in NOAMP rxlp1\",\n\t760: \"harmonics detected in NOAMP rxlp1\",\n\t765: \"neighbor magnitude exceeded in NOAMP rxlp1\",\n\t770: \"neighbor magnitude exceeded in NOAMP rxlp1\",\n\t775: \"spectrum mirrored or inverted in NOAMP rxlp1\",\n\t780: \"excessive power out of channel in NOAMP rxlp1\",\n\t2721: \"Excessive TX DC offset in AMP rxlp2\",\n\t2722: \"insufficient signal strength in AMP rxlp2\",\n\t2723: \"AMP rxlp2 clipping\",\n\t2725: \"peak found at unexpected frequency in AMP rxlp2\",\n\t2730: \"harmonics detected in AMP rxlp2\",\n\t2735: \"neighbor magnitude exceeded in AMP rxlp2\",\n\t2740: \"neighbor magnitude exceeded in AMP rxlp2\",\n\t2745: \"spectrum mirrored or inverted in AMP rxlp2\",\n\t2750: \"excessive power out of channel in AMP rxlp2\",\n\t2751: \"Excessive TX DC offset in NOAMP rxlp2\",\n\t2752: \"insufficient signal strength in NOAMP rxlp2\",\n\t2753: \"NOAMP rxlp2 clipping\",\n\t2755: \"peak found at unexpected frequency in NOAMP rxlp2\",\n\t2760: \"harmonics detected in NOAMP rxlp2\",\n\t2765: \"neighbor magnitude exceeded in NOAMP rxlp2\",\n\t2770: \"neighbor magnitude exceeded in NOAMP rxlp2\",\n\t2775: \"spectrum mirrored or inverted in NOAMP rxlp2\",\n\t2780: \"excessive power out of channel in NOAMP rxlp2\",\n\t821: \"Excessive TX DC offset in AMP rxhp1\",\n\t822: \"insufficient signal strength in AMP rxhp1\",\n\t823: \"AMP rxhp1 clipping\",\n\t825: \"peak found at unexpected frequency in AMP rxhp1\",\n\t830: \"harmonics detected in AMP rxhp1\",\n\t835: \"neighbor magnitude exceeded in AMP rxhp1\",\n\t840: \"neighbor magnitude exceeded in AMP rxhp1\",\n\t845: \"spectrum mirrored or inverted in AMP rxhp1\",\n\t850: \"excessive power out of channel in AMP rxhp1\",\n\t851: \"Excessive TX DC offset in NOAMP rxhp1\",\n\t852: \"insufficient signal strength in NOAMP rxhp1\",\n\t853: \"NOAMP rxhp1 clipping\",\n\t855: \"peak found at unexpected frequency in NOAMP rxhp1\",\n\t860: \"harmonics detected in NOAMP rxhp1\",\n\t865: \"neighbor magnitude exceeded in NOAMP rxhp1\",\n\t870: \"neighbor magnitude exceeded in NOAMP rxhp1\",\n\t875: \"spectrum mirrored or inverted in NOAMP rxhp1\",\n\t880: \"excessive power out of channel in NOAMP rxhp1\",\n\t3000: \"BP TX failure\",\n\t3010: \"BP RX failure\",\n\t3020: \"HP TX failure\",\n\t3030: \"HP RX failure\",\n\t3040: \"LP TX failure\",\n\t3050: \"LP RX failure\",\n\t3060: \"TX AMP failure\",\n\t3070: \"RX AMP failure\",\n\t3080: \"AMP bypass failure\",\n\t3090: \"LPF failure\",\n\t3100: \"HPF failure\",\n\t3110: \"mixer bypass failure\",\n\t3120: \"mixer failure\",\n\t3130: \"TX failure\",\n\t3140: \"RX failure\",\n\t3150: \"mixer TX failure\",\n\t3160: \"mixer RX failure\",\n\t3170: \"LP2 TX failure\",\n\t3180: \"LP2 RX failure\",\n\t3190: \"LP2 TX/RX failure\",\n\t3200: \"total RF failure\",\n\t3210: \"multiple RF failures, see list above\",\n\t3220: \"multiple clipping failures\"\n}\n\ndef fail_rf(errors):\n # check for combinations of RF errors\n ecode = 0\n eset = set(errors)\n\n # error affects only bp tx\n if ((322 in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3000\n errors.append(ecode)\n\n # error affects only bp rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3010\n errors.append(ecode)\n\n # error affects only hp tx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3020\n errors.append(ecode)\n\n # error affects only hp rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 in eset)):\n ecode = 3030\n errors.append(ecode)\n\n # error affects only lp tx (both lp1 and lp2)\n if ((322 not in eset) and (422 in eset) and (2422 in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3040\n errors.append(ecode)\n\n # error affects only lp rx (both lp1 and lp2)\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 in eset) and (2722 in eset) and (822 not in eset)):\n ecode = 3050\n errors.append(ecode)\n\n # error in tx amp path\n if ((2422 in eset) and (352 not in eset) and (452 not in eset) and (2452 not in eset)):\n ecode = 3060\n errors.append(ecode)\n\n # error in rx amp path\n if ((2722 in eset) and (652 not in eset) and (752 not in eset) and (2752 not in eset)):\n ecode = 3070\n errors.append(ecode)\n\n # error in amp bypass path\n if ((352 in eset) and (452 in eset) and (2452 in eset) and (652 in eset) and (752 in eset) and (2752 in eset) and (322 not in eset) and (422 not in eset) and (2422 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset)):\n ecode = 3080\n errors.append(ecode)\n\n # error in lpf path\n if (((422 in eset) and (2422 in eset)) and ((722 in eset) and (2722 in eset)) and ((322 not in eset) and (622 not in eset)) and ((522 not in eset) and (822 not in eset))):\n ecode = 3090\n errors.append(ecode)\n\n # error in hpf path\n if (((522 in eset) and (822 in eset)) and ((322 not in eset) and (622 not in eset)) and ((422 not in eset) and (2422 not in eset) and (722 not in eset) and (2722 not in eset))):\n ecode = 3100\n errors.append(ecode)\n\n # error affects both mixer bypass paths\n if ((322 in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3110\n errors.append(ecode)\n\n # error in mixer tx/rx\n if ((322 not in eset) and ((422 in eset) or (2422 in eset)) and (522 in eset) and (622 not in eset) and ((722 in eset) or (2722 in eset) or (822 in eset))):\n ecode = 3120\n errors.append(ecode)\n\n if ((322 not in eset) and ((422 in eset) or (2422 in eset) or (522 in eset)) and (622 not in eset) and ((722 in eset) and (2722 in eset) and (822 in eset))):\n ecode = 3120\n errors.append(ecode)\n\n # error in all tx, no rx\n if ((322 in eset) and (422 in eset) and (2422 in eset) and (522 in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset) and (352 in eset) and (452 in eset) and (2452 in eset) and (552 in eset)):\n ecode = 3130\n errors.append(ecode)\n\n # error in all rx, no tx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 in eset) and (722 in eset) and (2722 in eset) and (822 in eset) and (652 in eset) and (752 in eset) and (2752 in eset) and (852 in eset)):\n ecode = 3140\n errors.append(ecode)\n\n # error in all mixer tx\n if ((322 not in eset) and (422 in eset) and (2422 in eset) and (522 in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset)):\n ecode = 3150\n errors.append(ecode)\n\n # error in all mixer rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 in eset) and (2722 in eset) and (822 in eset)):\n ecode = 3160\n errors.append(ecode)\n\n # error affecting only lp2 tx\n if ((322 not in eset) and (422 not in eset) and (2422 in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 not in eset) and (822 not in eset) and (2752 in eset)):\n ecode = 3170\n errors.append(ecode)\n\n # error affecting only lp2 rx\n if ((322 not in eset) and (422 not in eset) and (2422 not in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 in eset) and (822 not in eset) and (2752 in eset)):\n ecode = 3180\n errors.append(ecode)\n\n # error affecting only lp2 rx/tx\n if ((322 not in eset) and (422 not in eset) and (2422 in eset) and (522 not in eset) and (622 not in eset) and (722 not in eset) and (2722 in eset) and (822 not in eset)):\n ecode = 3190\n errors.append(ecode)\n\n # error in all rx/tx\n if ((322 in eset) and (422 in eset) and (2422 in eset) and (522 in eset) and (622 in eset) and (722 in eset) and (2722 in eset) and (822 in eset)):\n ecode = 3200\n errors.append(ecode)\n\n clipping_count = 0\n for code in (323, 423, 2423, 523, 353, 453, 2453, 553, 623, 723, 2723, 823, 653, 753, 2753, 853):\n if code in eset:\n clipping_count += 1\n if clipping_count > 2:\n ecode = 3220\n errors.append(ecode)\n elif (not ecode) and (len(errors) > 1):\n # multiple failures without a logical grouping\n ecode = 3210\n errors.append(ecode)\n\n for error in errors[:-1]:\n out(f\"RF failure {error}: {emessages[error]}\")\n fail(errors[-1])\n\ndef log(message=\"\"):\n if args.log:\n with open(args.log, \"a\") as log_file:\n print(message, file=log_file)\n return\n\ndef out(message=\"\"):\n log(message)\n print(message)\n\ndef fail(error_code):\n out(f\"FAIL {error_code}: {emessages[error_code]}\")\n sys.exit(2)\n\nclass HackRF:\n def __init__(self, name, bin_dir, serial, mf_check, revision=None, unique_bin=False):\n self.name = name\n self.bin_dir = bin_dir\n self.unique_bin = unique_bin\n self.revision = None\n self.serial = None\n self.clkout_connected = False\n self.tester_cal = [0] * 16\n self.eut_cal = [0] * 16\n self.errors = []\n self.unit_number = 0\n self.partner = None\n\n if self.name == \"TESTER\":\n self.unit_number = 1\n elif self.name != \"EUT\":\n fail(99)\n\n info = subprocess.run([bin_dir + \"hackrf_info\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n log(info.stdout + info.stderr)\n if info.returncode != 0 or \"failed\" in info.stderr:\n fail(80 + self.unit_number)\n\n # parse the hackrf_info output\n count = info.stdout.count(\"Found HackRF\")\n if count < 1:\n fail(80 + self.unit_number)\n if count > 1 and self.name == \"TESTER\" and self.unique_bin:\n fail(83)\n if mf_check and \"does not appear to have been manufactured by Great Scott Gadgets\" in info.stdout:\n fail(90 + self.unit_number)\n try:\n devices_list = re.findall(r'Found HackRF\\n.+\\n.+\\n.+\\n.+\\n.+\\n.+', info.stdout)\n for device in devices_list:\n sn = re.search(r'Serial number: \\w+', device).group().split(': ')[1]\n rev = re.search(r'Hardware Revision: .+', device).group().split(': ')[1]\n if sn == serial:\n self.serial = sn\n self.revision = rev\n break\n out(f\"{self.name} serial number: {self.serial}\")\n out(f\"{self.name} revision: {self.revision}\")\n out(f\"{self.name} binary directory {self.bin_dir}\")\n except:\n log(traceback.format_exc())\n fail(1)\n\n if revision and self.revision != revision:\n fail(88 + self.unit_number)\n\n if self.revision == \"r9\":\n self.tester_cal = r9_tester_cal\n self.eut_cal = r9_eut_cal\n else:\n self.tester_cal = og_tester_cal\n self.eut_cal = og_eut_cal\n\n def clkin(self):\n command = subprocess.run([self.bin_dir + \"hackrf_clock\", \"-i\", \"-d\",\n self.serial], capture_output=True, encoding=\"utf-8\",\n timeout=TIMEOUT)\n if command.returncode != 0:\n log(command.stdout + command.stderr)\n out(f\"{self.name} CLKIN request failed\")\n fail(200)\n if \"no clock signal detected\" in command.stdout:\n log(f\"{self.name}: no clock signal detected\")\n return False\n elif \"clock signal detected\" in command.stdout:\n log(f\"{self.name}: clock signal detected\")\n return True\n else:\n log(command.stdout + command.stderr)\n out(f\"Couldn't parse {self.name} CLKIN status\")\n fail(200)\n\n # Warning: Avoid clock loops by disabling your partner's CLKOUT before\n # enabling your own.\n def clkout(self, enable):\n command = subprocess.run([self.bin_dir + \"hackrf_clock\", \"-o\",\n \"1\" if enable else \"0\", \"-d\", self.serial], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n if command.returncode != 0:\n log(command.stdout + command.stderr)\n out(f\"{self.name} CLKOUT control failed\")\n fail(200)\n\n if self.partner and self.clkout_connected:\n timeout = time.time() + 1\n while time.time() < timeout:\n if self.partner.clkin() == enable:\n break\n if self.partner.clkin() != enable:\n if enable:\n fail(210 + self.unit_number)\n else:\n if self.name == \"EUT\":\n out(\"Note: use --tcxo to use TCXO or external reference on TESTER\")\n fail(212 + self.unit_number)\n\n # transceiver operation to switch clock source\n source = \"CLKIN\" if enable else \"crystal\"\n log(f\"switching {self.partner.name} to {source}\")\n receive = subprocess.run([self.partner.bin_dir + \"hackrf_transfer\", \"-d\",\n self.partner.serial, \"-n1\", \"-r\", \"/dev/null\", \"-f\", \"2500000000\",\n \"-a\", \"0\", \"-l\", \"0\", \"-g\", \"0\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n fail(220 + self.unit_number)\n\n # confirm that PLL locked to new source\n expected_value = \"0x01\" if (enable and self.partner.revision != \"r9\") else \"0x51\"\n timeout = time.time() + 1\n while time.time() < timeout:\n debug = subprocess.run([self.partner.bin_dir + \"hackrf_debug\", \"-d\",\n self.partner.serial, \"-srn0\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n log(debug.stdout)\n if debug.returncode != 0:\n log(debug.stderr)\n fail(230 + self.unit_number)\n if expected_value in debug.stdout:\n break\n if expected_value not in debug.stdout:\n fail(232 + self.unit_number)\n time.sleep(0.1)\n else:\n time.sleep(0.2)\n\n def test_clkout(self):\n assert self.clkout_connected\n self.partner.clkout(False)\n self.clkout(True)\n frequency_error_ppm = self.clock_error_ppm()\n log(f\"{self.name}->{self.partner.name} CLK: {frequency_error_ppm} ppm\")\n if abs(frequency_error_ppm) > 1:\n out(f\"{self.partner.name} CLKIN: unexpected frequency error while synchronized\")\n fail(240)\n\n def test_clkin(self):\n self.partner.test_clkout()\n\n def clock_error_ppm(self):\n # ppm.freq is in MHz, but we use it as Hz for the FFT bin width,\n # resulting in bins with a width of 1 ppm of the transmission\n # frequency.\n bin_width = str(ppm.freq)\n tx_frequency = str(ppm.freq * ONE_MHZ)\n sweep_range = f\"{ppm.freq-1}:{ppm.freq+19}\"\n expected_bin = round(ONE_MHZ/ppm.freq)\n\n log(f\"{self.name} transmitting to {self.partner.name} for PPM measurement\")\n transmit = subprocess.Popen([self.bin_dir + \"hackrf_transfer\", \"-d\",\n self.serial, \"-c\", \"127\", \"-a\", \"0\", \"-x\", f\"{ppm.tx_gain}\", \"-f\",\n tx_frequency], stdout=subprocess.PIPE, stderr=subprocess.PIPE,\n encoding=\"utf-8\")\n\n time.sleep(SLEEP_TIME)\n sweep = subprocess.run([self.partner.bin_dir + \"hackrf_sweep\", \"-d\",\n self.partner.serial, \"-N\", \"13\", \"-w\", bin_width, \"-f\", sweep_range, \"-a\",\n \"0\", \"-l\", f\"{ppm.rx_lna_gain}\", \"-g\", f\"{ppm.rx_vga_gain}\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if sweep.returncode != 0:\n log(sweep.stdout + sweep.stderr)\n fail(250)\n\n # parse the hackrf_sweep output\n try:\n rows = sweep.stdout.split(\"\\n\")\n # Note: skipping data from the first twelve sweeps until issue #1230 is resolved.\n row = rows[48].split(\", \")\n bins = [float(bin) for bin in row[6:]]\n peak_bin = bins.index(max(bins))\n frequency_error_ppm = peak_bin - expected_bin\n except:\n log(sweep.stdout + sweep.stderr)\n log(traceback.format_exc())\n fail(252)\n\n log(f\"PPM max bin {peak_bin} power: {bins[peak_bin]}\")\n for row in rows[0:49:4]:\n bins = [float(bin) for bin in row.split(\", \")[6:]]\n peak_bin = bins.index(max(bins))\n log(f\"peak bin {peak_bin}: {bins[peak_bin]}\")\n if max(bins) < SIGNAL_THRESHOLD:\n fail(254 + self.unit_number)\n transmit.terminate()\n tx_out, tx_err = transmit.communicate(timeout=TIMEOUT)\n if transmit.returncode != 0:\n log(tx_out + tx_err)\n out(f\"Warning: {self.name} PPM test transmit failed\")\n return frequency_error_ppm\n\n def test_xtal(self):\n self.clkout(False)\n self.partner.clkout(False)\n frequency_error_ppm = self.clock_error_ppm()\n out(f\"{self.name} crystal frequency error: {frequency_error_ppm} ppm\")\n if abs(frequency_error_ppm) > MAX_PPM:\n fail(260)\n\n def verify_register(self, target, address, value):\n command = subprocess.run([self.bin_dir + \"hackrf_debug\",\n f\"--{target}\", \"--register\", address, \"--read\", \"--device\",\n self.serial], capture_output=True, encoding=\"UTF-8\")\n log(f\"Checking {target} register {address}\")\n if value in command.stdout:\n return True\n else:\n log(\"Unexpected result:\")\n log(command.stdout + command.stderr)\n return False\n\n def test_clkgen(self):\n if not self.verify_register(\"si5351\", \"2\", \"0x03\"):\n fail(100 + self.unit_number)\n\n def test_mixer(self):\n if not self.verify_register(\"rffc5072\", \"2\", \"0x9055\"):\n fail(140 + self.unit_number)\n\n def test_xcvr(self):\n if not self.verify_register(\"max283\", \"28\", \"0x0c0\"):\n fail(120 + self.unit_number)\n\n def test_serial(self):\n log(f\"Testing {self.name} serial communications\")\n self.test_clkgen()\n self.test_mixer()\n self.test_xcvr()\n\n # Ensure that hackrf_transfer works and that the received power is within\n # the expected range with no transmission active.\n def baseline_rx(self, test_case):\n # Test at the TX tuning frequency of measure_rf()\n center_freq = (test_case.freq * ONE_MHZ) + 1500000\n receive = subprocess.run([self.bin_dir + \"hackrf_transfer\", \"-d\",\n self.serial, \"-n10000\", \"-r\", \"/dev/null\", \"-f\",\n f\"{center_freq}\", \"-a\", \"0\", \"-l\", f\"{test_case.rx_lna_gain}\",\n \"-g\", f\"{test_case.rx_vga_gain}\", \"-b\",\n \"1750000\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n log(f\"Failed {self.name} {test_case.name} baseline RX\")\n fail(300)\n\n output = str(receive.stderr).split()\n try:\n power = float(output[output.index(\"power\") + 1])\n except:\n log(receive.stdout + receive.stderr)\n log(traceback.format_exc())\n log(f\"Couldn't parse {self.name} {test_case.name} baseline RX power\")\n fail(302)\n # The theoretical minimum power is about -48 dB. The expected power is\n # about -30 dB.\n log(f\"{self.name} {test_case.name} baseline power: {power}\")\n if power > MAX_BASELINE:\n fail(306)\n\n # Check the ADC for shorts or other unexpected behavior by sampling\n # amplified noise.\n def noise_rx(self, test_case):\n num_samples = 1000\n log(f\"Testing {self.name} {test_case.name}\")\n center_freq = test_case.freq * ONE_MHZ\n\n low_gain = 0\n high_gain = 16\n while high_gain > low_gain:\n gain = (high_gain + low_gain) // 2\n receive = subprocess.run([self.bin_dir + \"hackrf_transfer\", \"-d\",\n self.serial, \"-n\", f\"{num_samples*10}\", \"-r\", f\"{NOISE}\", \"-f\",\n f\"{center_freq}\", \"-a\", \"1\" if test_case.amp else \"0\", \"-l\",\n f\"{test_case.rx_lna_gain}\", \"-g\", f\"{gain*2 + 32}\", \"-b\",\n \"28000000\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n fail(310)\n output = str(receive.stderr).split()\n try:\n power = float(output[output.index(\"power\") + 1])\n except:\n log(receive.stdout + receive.stderr)\n log(traceback.format_exc())\n fail(311)\n log(f\"{self.name} {test_case.name} RX power at -g {gain*2 + 32}: {power}\")\n if power > -2:\n high_gain = gain\n elif power > -5:\n break\n else:\n low_gain = gain + 1\n\n # We want the power to be between -1 and -6 dB to ensure that all eight\n # bits are flipped without much clipping.\n if power < -6 or power > -1:\n fail(312)\n elif gain > 14 or gain < 4:\n fail(313)\n\n bit_count = [0] * 8\n matches = []\n for bit in range(8):\n matches.append([0] * 8)\n\n try:\n file = open(f\"{NOISE}\", \"rb\")\n data = file.read()\n assert len(data) == num_samples * 20\n data = data[-num_samples*2:]\n for byte in data:\n for bit in range(8):\n bit_count[bit] += (byte>>bit)&1\n for match_bit in range(bit + 1, 8):\n if (byte>>bit)&1 == (byte>>match_bit)&1:\n matches[bit][match_bit] += 1\n except:\n fail(315)\n log(f\"{self.name} ADC bit counts: {bit_count}\")\n log(f\"{self.name} ADC bit matches: {matches}\")\n for bit in range(7):\n if bit_count[bit] < (0.2 * len(data)) or bit_count[bit] > (0.8 * len(data)):\n log(f\"{self.name} ADC bit {bit} set in {bit_count[bit]} out of {len(data)} bytes\")\n fail(316)\n # Check for correlations between adjacent bits except between 6 and 7 (highest).\n #for match_bit in range(bit + 1, 7):\n for match_bit in range(bit + 1, 8):\n if matches[bit][match_bit] > (0.999 * len(data)):\n out(f\"{self.name} ADC bit {bit} correlates with bit {match_bit}\")\n fail(317)\n # DC bias can cause bit 7 to be predominantly unchanged, so only\n # error if there is less than 1% variation.\n if bit_count[7] < (0.001 * len(data)) or bit_count[bit] > (0.999 * len(data)):\n out(f\"{self.name} ADC bit 7 set in {bit_count[7]} out of {len(data)} bytes\")\n fail(316)\n\n def analyze_transfer(self, transfer, test_case):\n # parse the hackrf_transfer output\n output = str(transfer.stderr).split()\n try:\n power = float(output[output.index(\"power\") + 1])\n except:\n log(transfer.stdout + transfer.stderr)\n log(traceback.format_exc())\n fail(152)\n log(f\"{test_case.name} power at {test_case.freq} MHz: {power}\")\n\n if test_case.base_ecode:\n if power < SIGNAL_THRESHOLD:\n log(f\"{test_case.name} signal not strong enough\")\n self.errors.append(test_case.base_ecode + 2)\n if power > -3:\n log(f\"{test_case.name} signal clipping\")\n self.errors.append(test_case.base_ecode + 3)\n elif power < -48 or power > 0:\n fail(154)\n return power\n\n # Verify that signal power at a given IF in MHz is detected.\n def verify_if_tuning(self, test_case):\n transmit = subprocess.Popen([self.bin_dir + \"hackrf_transfer\", \"-d\",\n self.serial, \"-c\", \"127\", \"-a\", \"0\", \"-x\", f\"{test_case.tx_gain}\",\n \"-i\", f\"{test_case.freq*ONE_MHZ}\", \"-m\", \"0\", \"-F\"],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding=\"utf-8\")\n\n time.sleep(SLEEP_TIME)\n receive = subprocess.run([self.partner.bin_dir + \"hackrf_transfer\", \"-d\",\n self.partner.serial, \"-n10000\", \"-r\", \"/dev/null\", \"-f\",\n f\"{(test_case.freq+1)*ONE_MHZ}\", \"-a\", \"0\", \"-l\",\n f\"{test_case.rx_lna_gain}\", \"-g\", f\"{test_case.rx_vga_gain}\", \"-b\",\n \"2500000\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n transmit.terminate()\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n fail(150)\n\n power = self.analyze_transfer(receive, test_case)\n\n tx_out, tx_err = transmit.communicate(timeout=TIMEOUT)\n if transmit.returncode != 0:\n log(tx_out + tx_err)\n out(f\"Warning: {self.name} IF transmit failed\")\n return power > SIGNAL_THRESHOLD\n\n def test_if_range(self, min_case, max_case):\n low_end = IF_REQUIRED_MIN - IF_TEST_RANGE + 1\n min_freq = IF_REQUIRED_MIN + 1\n while min_freq > low_end:\n min_case.freq = (min_freq + low_end) // 2\n if self.verify_if_tuning(min_case):\n min_freq = min_case.freq\n else:\n low_end = min_case.freq + 1\n\n high_end = IF_REQUIRED_MAX + IF_TEST_RANGE - 1\n max_freq = IF_REQUIRED_MAX - 1\n while max_freq < high_end:\n max_case.freq = (max_freq + high_end + 1) // 2\n if self.verify_if_tuning(max_case):\n max_freq = max_case.freq\n else:\n high_end = max_case.freq - 1\n\n out(f\"{self.name} IF range: {min_freq}-{max_freq} MHz\")\n if min_freq > IF_REQUIRED_MIN or max_freq < IF_REQUIRED_MAX:\n fail(160)\n\n def analyze_sweep(self, sweep, test_case):\n eut_cal = self.eut_cal[all_rf_test_cases.index(test_case)]\n tester_cal = self.partner.tester_cal[all_rf_test_cases.index(test_case)]\n correction = LP2_CORRECTION if test_case.freq < 30 else 0\n\n # parse the hackrf_sweep output\n try:\n rows = sweep.stdout.split(\"\\n\")\n # Note: skipping data from the first twelve sweeps until issue #1230 is resolved.\n bins = np.zeros(225)\n # average 10 sweeps\n row_count = 0\n for row in rows[48:88:4]:\n bins += np.array([float(x) for x in row.split(\", \")[6:231]])\n row_count += 1\n assert row_count == 10\n bins /= 10\n # log the raw hackrf_sweep data before calibration\n log(f\"{', '.join(rows[12].split(', ')[:6])}, {np.array2string(bins, separator=', ', max_line_width=3000)[1:-1]}\")\n # apply calibration\n bins -= eut_cal\n bins -= tester_cal\n peak_bin = bins.argmax()\n except:\n log(sweep.stdout + sweep.stderr)\n log(traceback.format_exc())\n out(f\"Couldn't parse {test_case.name} sweep data\")\n fail(172)\n\n # ensure acceptable performance\n log(f\"peak ({peak_bin}) {test_case.name}: {bins[peak_bin]:.2f}\")\n if bins[peak_bin] < SIGNAL_THRESHOLD:\n for row in rows[0:88:4]:\n bins = [float(bin) for bin in row.split(\", \")[6:]]\n peak_bin = bins.index(max(bins))\n log(f\"peak bin {peak_bin}: {bins[peak_bin]}\")\n log(f\"{test_case.name} signal not strong enough\")\n self.errors.append(test_case.base_ecode + 2)\n return bins[peak_bin]\n elif bins[peak_bin] > MAX_POWER:\n log(f\"{test_case.name} signal clipping\")\n self.errors.append(test_case.base_ecode + 3)\n return bins[peak_bin]\n tx_dc_power_dbc = bins[112] - bins[peak_bin]\n if tx_dc_power_dbc > MAX_DC_DBC + correction:\n log(f\"{test_case.name} excessive TX DC offset {tx_dc_power_dbc:.1f} dBc\")\n self.errors.append(test_case.base_ecode + 1)\n if peak_bin == 157:\n log(f\"{test_case.name} TX spectrum inverted\")\n self.errors.append(test_case.base_ecode + 25)\n return bins[peak_bin]\n elif peak_bin == 112:\n log(f\"{test_case.name} peak found at DC\")\n self.errors.append(test_case.base_ecode + 1)\n return bins[peak_bin]\n elif peak_bin >= 52 and peak_bin < 67:\n log(f\"{test_case.name} peak found at adjacent frequency\")\n self.errors.append(test_case.base_ecode + 15)\n return bins[peak_bin]\n elif peak_bin > 67 and peak_bin <= 82:\n log(f\"{test_case.name} peak found at adjacent frequency\")\n self.errors.append(test_case.base_ecode + 20)\n return bins[peak_bin]\n elif peak_bin != 67:\n log(f\"{test_case.name} peak found at unexpected frequency\")\n self.errors.append(test_case.base_ecode + 5)\n return bins[peak_bin]\n\n if bins[157] - bins[67] > MAX_M_DBC + correction:\n log(f\"{test_case.name} TX spectrum mirrored\")\n self.errors.append(test_case.base_ecode + 25)\n if (bins[22] - bins[67]) > MAX_H2_DBC + correction:\n log(f\"{test_case.name} excessive TX harmonic (bin 22): {bins[22]}\")\n self.errors.append(test_case.base_ecode + 10)\n if (bins[202] - bins[67]) > MAX_MH2_DBC + correction:\n log(f\"{test_case.name} excessive TX harmonic (bin 202): {bins[202]}\")\n self.errors.append(test_case.base_ecode + 10)\n worst_other_dbc = -999\n worst_other_bin = 999\n for i in range(225):\n # Skip various frequencies where spurs are expected (most of which have their own tests above).\n if (i < 52 and i != 22) or (i > 82 and i < 111) or (i > 113 and i < 156) or (i > 158 and i != 202):\n other_dbc = bins[i] - bins[67]\n if other_dbc > worst_other_dbc:\n worst_other_dbc = other_dbc\n worst_other_bin = i\n if worst_other_dbc > MAX_OTHER_DBC + correction:\n log(f\"{test_case.name} excessive power at unexpected frequency ({worst_other_bin}: {bins[worst_other_bin]})\")\n self.errors.append(test_case.base_ecode + 30)\n log(f\"h2 (22) {test_case.name}: {(bins[22] - bins[67]):.2f}\")\n log(f\"DC (112) {test_case.name}: {(bins[112] - bins[67]):.2f}\")\n log(f\"m (157) {test_case.name}: {(bins[157] - bins[67]):.2f}\")\n log(f\"mh2 (202) {test_case.name}: {(bins[202] - bins[67]):.2f}\")\n log(f\"other ({worst_other_bin}) {test_case.name}: {worst_other_dbc:.2f}\")\n #FIXME look in another row for RX inversion?\n return bins[peak_bin]\n\n def measure_rf(self, test_case, sweep=True):\n log(f\"Executing RF test case {test_case.name}, sweep={sweep}\")\n if test_case.direction == \"tx\":\n transmitter = self\n tx_amp = \"1\" if test_case.amp else \"0\"\n receiver = self.partner\n rx_amp = \"0\"\n elif test_case.direction == \"rx\":\n transmitter = self.partner\n tx_amp = \"0\"\n receiver = self\n rx_amp = \"1\" if test_case.amp else \"0\"\n else:\n out(f\"Error: Invalid direction in {test_case.name}\")\n sys.exit(1)\n\n # The nominal test frequency (as specified in test_case) is 1 MHz above\n # the low end of the sweep range. The transmitted signal is 500 kHz\n # above the nominal frequency, and the tuning (center) frequency of the\n # transmitting device is 1 MHz above that.\n tx_center_freq = (test_case.freq * ONE_MHZ) + 1500000\n sweep_range = f\"{test_case.freq-1}:{test_case.freq+19}\"\n\n transmit = subprocess.Popen([transmitter.bin_dir + \"hackrf_transfer\", \"-d\",\n transmitter.serial, \"-R\", \"-t\", WAVEFORM, \"-a\", tx_amp, \"-x\",\n f\"{test_case.tx_gain}\", \"-f\", str(tx_center_freq)],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding=\"utf-8\")\n\n time.sleep(SLEEP_TIME)\n if sweep:\n receive = subprocess.run([receiver.bin_dir + \"hackrf_sweep\",\n \"-d\", receiver.serial, \"-N\", \"22\", \"-w\", \"22222\", \"-f\",\n sweep_range, \"-a\", rx_amp, \"-l\", f\"{test_case.rx_lna_gain}\",\n \"-g\", f\"{test_case.rx_vga_gain}\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n else:\n receive = subprocess.run([receiver.bin_dir + \"hackrf_transfer\",\n \"-d\", receiver.serial, \"-n10000\", \"-r\", \"/dev/null\", \"-f\",\n f\"{(test_case.freq)*ONE_MHZ}\", \"-a\", rx_amp, \"-l\",\n f\"{test_case.rx_lna_gain}\", \"-g\", f\"{test_case.rx_vga_gain}\",\n \"-b\", \"2500000\"], capture_output=True, encoding=\"utf-8\",\n timeout=TIMEOUT)\n transmit.terminate()\n if receive.returncode != 0:\n log(receive.stdout + receive.stderr)\n log(f\"{receiver.name} Failed RX, sweep={sweep}\")\n fail(170)\n\n if sweep:\n rssi = self.analyze_sweep(receive, test_case)\n else:\n rssi = self.analyze_transfer(receive, test_case)\n\n tx_out, tx_err = transmit.communicate(timeout=TIMEOUT)\n if transmit.returncode != 0:\n out(tx_out + tx_err)\n out(f\"Warning: {transmitter.name} transmit failed\")\n return rssi\n\n def test_rf_preliminary(self):\n results = []\n\n for test_case in (all_rf_test_cases):\n if test_case.amp == False:\n if test_case.direction == \"rx\":\n self.baseline_rx(test_case)\n elif self.partner:\n self.partner.baseline_rx(test_case)\n\n self.noise_rx(noise)\n # FIXME test for RX DC offset?\n\n if not self.partner:\n out(\"Skipping RF tests\")\n return\n\n for test_case in (all_rf_test_cases):\n results.append(int(round(self.measure_rf(test_case, sweep=False) - (SIGNAL_THRESHOLD + 11))))\n\n log(f\"Preliminary results: {results}\")\n if self.errors:\n fail_rf(self.errors)\n\n def test_rf(self):\n assert self.partner\n results = []\n\n for test_case in (all_rf_test_cases):\n results.append(int(round(self.measure_rf(test_case, sweep=True) - (SIGNAL_THRESHOLD + 5))))\n\n out(f\"RF results summary: {results}\")\n if self.errors:\n fail_rf(self.errors)\n\n def activate_leds(self, enable):\n if enable:\n out(f\"Activating {self.name} LEDs\")\n state = 7\n else:\n state = 1\n command = subprocess.run([self.bin_dir + \"hackrf_debug\", \"-d\", self.serial, \"--leds\",\n f\"{state}\"], capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if command.returncode != 0:\n log(command.stdout + command.stderr)\n log(f\"Failed to configure {self.name} LEDs ({state})\")\n fail(190)\n\n\n# This waveform is a full-scale complex exponential with a frequency of -1/10 the\n# sample rate. When transmitted at 10 Msps, the frequency is 1 MHz below the\n# center frequency.\n\ndef write_waveform():\n tx_bytes = b'\\x7f\\x00\\x67\\xb5\\x27\\x87\\xd9\\x87\\x99\\xb5\\x81\\x00\\x99\\x4b\\xd9\\x79\\x27\\x79\\x67\\x4b'\n # defective waveform with DC offset:\n #tx_bytes = b'\\x7f\\x10\\x67\\xa5\\x27\\x97\\xd9\\x97\\x99\\xc5\\x81\\x10\\x99\\x5b\\xd9\\x7f\\x27\\x7f\\x67\\x5b'\n # defective waveform with missing Q channel:\n #tx_bytes = b'\\x7f\\x00\\x67\\x00\\x27\\x00\\xd9\\x00\\x99\\x00\\x81\\x00\\x99\\x00\\xd9\\x00\\x27\\x00\\x67\\x00'\n with open(WAVEFORM, \"wb\") as bin_file:\n for i in range(50000): # 1MB file size\n bin_file.write(tx_bytes)\n\n\ndef program(bin_dir, fw_dir, serial, unattended=False):\n if \"build\" in fw_dir:\n binary = \"hackrf_usb.bin\"\n dfu_stub = \"hackrf_usb.dfu\"\n else:\n binary = \"hackrf_one_usb.bin\"\n dfu_stub = \"hackrf_one_usb.dfu\"\n\n # EUTs in unattended (including Jenkins CI) setups have pins jumped to always boot into DFU mode, so resetting is undesirable\n if unattended:\n reset_write = \"-w\"\n else:\n reset_write = \"-Rw\"\n\n if not usb.core.find(idVendor=DFU_VENDOR_ID, idProduct=DFU_PRODUCT_ID):\n print(\"ACTION REQUIRED: Press and release EUT RESET button while holding DFU button.\")\n while not usb.core.find(idVendor=DFU_VENDOR_ID, idProduct=DFU_PRODUCT_ID):\n time.sleep(0.1)\n\n out(\"Programming EUT in DFU mode\")\n dfu = subprocess.run([f\"{DFU_UTIL}\", \"--device\",\n f\"{DFU_VENDOR_ID}:{DFU_PRODUCT_ID}\", \"--alt\", \"0\", \"--download\",\n f\"{fw_dir}{dfu_stub}\"], capture_output=True, encoding=\"utf-8\",\n timeout=TIMEOUT)\n\n #dfu-util: unable to read DFU status after completion (LIBUSB_ERROR_IO)\n # despite successful download; present as of at least dfu-util 0.11\n if \"Download done.\" not in dfu.stdout:\n fail(60)\n\n # Wait for device to boot from DFU.\n then = time.time()\n dfu_device_found = False\n while time.time() < (then + 50):\n dfu_info = subprocess.run([bin_dir + \"hackrf_info\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n\n if \"RunningFromRAM\" in dfu_info.stdout:\n if serial in dfu_info.stdout and serial != \"RunningFromRAM\":\n out(\"wrong device in DFU mode\")\n fail(1)\n else:\n dfu_device_found = True\n break\n time.sleep(0.1)\n if not dfu_device_found:\n out(\"DFU device not found\")\n fail(1)\n\n out(\"Programming EUT SPI flash\")\n spiflash = subprocess.run([bin_dir + \"hackrf_spiflash\", \"-d\",\n \"RunningFromRAM\", reset_write, f\"{fw_dir}{binary}\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if spiflash.returncode != 0:\n log(spiflash.stdout + spiflash.stderr)\n fail(70)\n\n then = time.time()\n device_found = False\n while time.time() < (then + 5):\n flash_info = subprocess.run([bin_dir + \"hackrf_info\"], capture_output=True,\n timeout=TIMEOUT)\n\n if serial in flash_info.stdout.decode('utf-8', errors='ignore'):\n device_found = True\n break\n time.sleep(0.1)\n if not device_found:\n fail(75)\n\n\ndef find_sn(name, bin_dir, claimed_sns=[]):\n while True:\n sn_list = []\n info = subprocess.run([bin_dir + \"hackrf_info\"], capture_output=True,\n encoding=\"utf-8\", timeout=TIMEOUT)\n devices_list = re.findall(r'Found HackRF\\n.+\\n.+\\n.+\\n.+\\n.+\\n.+', info.stdout)\n\n out(f\"\\nPotential {name}(s) found:\\n\")\n for device in devices_list:\n new_sn = re.search(r'Serial number: \\w+', device).group().split(': ')[1]\n if new_sn not in claimed_sns:\n sn_list.append(new_sn)\n if len(sn_list) > 1:\n for i in range(len(sn_list)):\n out(f\"{i}: {sn_list[i]}\")\n choice = int(input(f\"\\nEnter the index of your target {name}s serial number: \"))\n if 0 <= choice < len(sn_list):\n sn = sn_list[choice]\n break\n else:\n out(\"Incorrect choice, try again.\")\n elif len(sn_list) == 1:\n sn = sn_list[0]\n out(f\"{sn}\\n\")\n break\n else:\n out(\"Failed to parse a serial number from hackrf_info\")\n fail(1)\n return sn\n\n\ndef get_version():\n version = subprocess.run([\"git\", \"log\", \"-n\" \"1\", \"--format=%h\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if version.returncode != 0:\n return \"2026.01.3+\"\n elif version.returncode == 0:\n dirty = subprocess.run([\"git\", \"status\", \"-s\", \"--untracked-files=no\"],\n capture_output=True, encoding=\"utf-8\", timeout=TIMEOUT)\n if dirty.stdout != \"\":\n dirty_flag = \"*\"\n else:\n dirty_flag = \"\"\n return f\"git-{version.stdout.strip()}{dirty_flag}\"\n\n\ndef main():\n\n write_waveform()\n\n parser = argparse.ArgumentParser(description=\"Utility for testing HackRF One\")\n parser.add_argument(\"-c\", \"--noclk\", action=\"store_true\", help=\"skip CLKIN, CLKOUT, and PPM tests\")\n parser.add_argument(\"-i\", \"--noif\", action=\"store_true\", help=\"skip IF tuning range test\")\n parser.add_argument(\"-l\", \"--loop\", action=\"store_true\", help=\"repeat the test until terminated with ctrl-c\")\n parser.add_argument(\"-m\", \"--manufacturer\", action=\"store_true\", help=\"check the manufacturer of target devices\")\n parser.add_argument(\"-r\", \"--rev\", metavar=\" or \\\"any\\\"\", type=str,\n help=\"check EUT pin straps for specific hardware revision (default: \\\"r9\\\")\",\n default=\"r9\")\n parser.add_argument(\"-s\", \"--solo\", action=\"store_true\", help=\"perform limited tests on a single EUT with no TESTER\")\n parser.add_argument(\"-t\", \"--tcxo\", action=\"store_true\", help=\"skip CLKIN/CLKOUT tests and use TCXO instead\")\n parser.add_argument(\"-E\", \"--eut\", metavar=\"\", type=str,\n help=\"EUT serial number\")\n parser.add_argument(\"-T\", \"--tester\", metavar=\"\", type=str,\n help=\"TESTER serial number\")\n parser.add_argument(\"-f\", \"--fwupdate\", metavar=\"\", type=str,\n help=\"update firmware with binaries from specified directory\")\n parser.add_argument(\"-H\", \"--hostdir\", metavar=\"\", type=str,\n help=\"location of installed hackrf host tools, will attempt to find them if omitted\")\n parser.add_argument(\"-b\", \"--testerdir\", metavar=\"\", type=str,\n help=\"necessary only if EUT/TESTER have separate host binaries\")\n parser.add_argument(\"-C\", \"--ci\", action=\"store_true\", help=\"For use with Jenkins CI user\")\n parser.add_argument(\"-u\", \"--unattended\", action=\"store_true\", help=\"For use with unattended hardware\")\n parser.add_argument(\"-L\", \"--log\", metavar=\"\", type=str,\n help=\"log file location\")\n global args\n args = parser.parse_args()\n\n if args.ci:\n user = \"jenkins\"\n else:\n user = os.getlogin()\n\n if \"any\" in args.rev.lower():\n args.rev = None\n elif args.rev.lower() == \"r1\" or args.rev.lower() == \"r4\":\n args.rev = \"older than r6\"\n\n if args.hostdir:\n eut_host_dir = args.hostdir\n else:\n try:\n eut_host_dir = os.path.dirname(shutil.which('hackrf_info')) + \"/\"\n except:\n out(\"No path to hackrf host tools found. Please provide a directory via --hostdir\")\n fail(1)\n\n if args.testerdir:\n if args.testerdir == eut_host_dir:\n out(\"Specified TESTER bin directory must be different from the found EUT bin directory\")\n out(\"If shared TESTER/EUT bin directory is intended, omit --testerdir\")\n fail(1)\n else:\n tester_host_dir = args.testerdir\n else:\n tester_host_dir = eut_host_dir\n\n unique_bin = (tester_host_dir != eut_host_dir)\n count = 0\n\n while True:\n out()\n out(\"================================\")\n out(datetime.now())\n out(sys.argv)\n out(f\"user: {user}\")\n out(f\"version: {get_version()}\")\n out(f\"pid: {os.getpid()}\")\n if args.loop:\n out(f\"repeat count: {count}\")\n out(\"================================\")\n out()\n\n if args.eut:\n eut_sn = args.eut\n else:\n if args.tester:\n eut_sn = find_sn(\"EUT\", eut_host_dir, [args.tester])\n else:\n eut_sn = find_sn(\"EUT\", eut_host_dir)\n if args.tester:\n tester_sn = args.tester\n else:\n tester_sn = find_sn(\"TESTER\", tester_host_dir, [eut_sn])\n\n if eut_sn == tester_sn:\n out(\"TESTER and EUT cannot be the same device\")\n fail(1)\n\n if args.fwupdate:\n program(eut_host_dir, args.fwupdate, eut_sn, args.unattended)\n\n if not args.rev:\n out(\"Skipping EUT hardware revision check\")\n eut = HackRF(\"EUT\", eut_host_dir, eut_sn, args.manufacturer, revision=args.rev)\n\n if args.solo:\n tester = None\n else:\n tester = HackRF(\"TESTER\", tester_host_dir, tester_sn, args.manufacturer, unique_bin=unique_bin)\n tester.test_serial()\n tester.partner = eut\n eut.partner = tester\n\n out(\"Testing EUT\")\n\n if args.solo:\n eut.clkout_connected = False\n elif args.noclk:\n eut.clkout_connected = False\n tester.clkout_connected = False\n elif args.tcxo:\n eut.clkout_connected = False\n tester.clkout_connected = True\n else:\n eut.clkout_connected = True\n tester.clkout_connected = True\n\n if count > 0 and not args.fw_update:\n eut.activate_leds(False)\n\n eut.test_serial()\n\n # limited RF test without clock synchronization\n eut.test_rf_preliminary()\n\n if args.noclk or args.solo:\n out(\"Skipping CLKIN, CLKOUT, and PPM tests\")\n else:\n eut.test_xtal()\n if not args.tcxo:\n eut.test_clkout()\n eut.test_clkin()\n\n eut.clkout(False)\n\n if tester:\n tester.clkout(True)\n\n if args.tcxo:\n if args.solo:\n out(\"Error: --solo is incompatible with --tcxo\")\n sys.exit(1)\n if tester.clkin():\n out(\"Using TCXO on TESTER\")\n else:\n out(\"Warning: No TCXO or external clock detected on TESTER\")\n out(\"Skipping CLKOUT test\")\n if not args.noclk and not eut.clkin():\n fail(211)\n\n # full RF test with clock synchronization\n if tester:\n eut.test_rf()\n\n if args.noif or args.solo:\n out(\"Skipping IF tuning range test\")\n else:\n eut.test_if_range(ifmin, ifmax)\n\n eut.activate_leds(True)\n\n out()\n if (args.solo or args.noif or args.noclk or args.tcxo or not args.rev):\n out(\"Limited test complete\")\n else:\n out(\"PASS if all 6 LEDs active\")\n\n count += 1\n if not args.loop:\n break\n\n\nif __name__ == \"__main__\":\n try:\n main()\n except KeyboardInterrupt:\n print()\n out(\"KeyboardInterrupt\")\n sys.exit(0)\n except subprocess.TimeoutExpired:\n log(traceback.format_exc())\n fail(180)\n" }, { "path": "ci-scripts/install_host.sh", "content": "#!/bin/bash\nset -e\ncd host\ncmake -B build\ncmake --build build\ncd ..\n" }, { "path": "ci-scripts/test-debug.py", "content": "#!/usr/bin/python3\nimport sys\nimport subprocess\n\nPASS, FAIL = range(2)\nEUT = \"RunningFromRAM\"\n\n\ndef check_debug(target, register, reg_val):\n hackrf_debug = subprocess.run([\"host/build/hackrf-tools/src/hackrf_debug\",\n f\"--{target}\", \"--register\", register,\n \"--read\", \"--device\", EUT],\n capture_output=True, encoding=\"UTF-8\")\n\n if reg_val in hackrf_debug.stdout:\n print(f\"hackrf_debug --{target} passed.\")\n return PASS\n else:\n print(f\"hackrf_debug --{target} failed.\")\n return FAIL\n\n\ndef main():\n results = [\n check_debug(\"si5351c\", \"2\", \"0x03\"),\n check_debug(\"max2837\", \"3\", \"0x1b9\"),\n check_debug(\"rffc5072\", \"2\", \"0x9055\"),\n ]\n\n if FAIL not in results:\n sys.exit(PASS)\n else:\n sys.exit(FAIL)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": "ci-scripts/test-firmware-flash.sh", "content": "#!/bin/bash\nhost/build/hackrf-tools/src/hackrf_spiflash -w firmware/hackrf_usb/build/hackrf_usb.bin\nEXIT_CODE=\"$?\"\nif [ \"$EXIT_CODE\" == \"1\" ]\nthen\n echo \"No HackRF found! Disconnected? Exiting..\"\n exit $EXIT_CODE\nelif [ \"$EXIT_CODE\" == \"0\" ]\nthen\n echo \"Firmware successfully flashed!\"\nelif [ \"$EXIT_CODE\" == \"127\" ]\nthen\n echo \"Host tool installation failed! Exiting..\"\n exit $EXIT_CODE\nelse\n echo \"Unknown error\"\n exit $EXIT_CODE\nfi\n" }, { "path": "ci-scripts/test-firmware-program.sh", "content": "#!/bin/bash\ndfu-util --device 1fc9:000c --alt 0 --download firmware/hackrf_usb/build/hackrf_usb.dfu\nsleep 1s\nEXIT_CODE=\"$?\"\nif [ \"$EXIT_CODE\" == \"0\" ]\nthen\n echo \"DFU installation success! Exiting..\"\n exit $EXIT_CODE\nelif [ \"$EXIT_CODE\" == \"74\" ]\nthen\n echo \"No DFU capable USB device available! Disconnected? Exiting..\"\n exit 1\nelif [ \"$EXIT_CODE\" == \"127\" ]\nthen\n echo \"dfu-util installation failed! Exiting..\"\n exit $EXIT_CODE\nelse\n echo \"Unhandled exception\"\n exit $EXIT_CODE\nfi\n" }, { "path": "ci-scripts/test-transfer.py", "content": "#!/usr/bin/python3\nimport subprocess\nimport time\nimport sys\nfrom os import environ\n\nEUT = environ.get('EUT')\nTESTER = environ.get('TESTER')\nPASS, FAIL = range(2)\n\n\ndef write_bytes():\n tx_bytes = b'\\x7f\\x00\\x59\\x59\\x00\\x7f\\xa7\\x59\\x81\\x00\\xa7\\xa7\\x00\\x81\\x59\\xa7'\n with open(\"/tmp/binary100\", \"wb\") as bin_file:\n for i in range(62500): # 1MB file size\n bin_file.write(tx_bytes)\n\n\ndef capture_signal(sweep_range, tx_gain, rx_lna_gain, rx_vga_gain, freq=None,\n if_freq=None, lo_freq=None, image_reject=0):\n\n test_type = sys.argv[1]\n if test_type == \"tx\":\n transmitter = EUT\n receiver = TESTER\n elif test_type == \"rx\":\n transmitter = TESTER\n receiver = EUT\n else:\n print(f\"Invalid command-line argument: {test_type}. Use tx or rx\")\n sys.exit(1)\n\n if if_freq == None:\n transmit = subprocess.Popen([\"host/build/hackrf-tools/src/hackrf_transfer\",\n \"-d\", transmitter, \"-R\", \"-t\", \"/tmp/binary100\",\n \"-a\", \"0\", \"-x\", tx_gain, \"-f\", freq],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n else:\n transmit = subprocess.Popen([\"host/build/hackrf-tools/src/hackrf_transfer\",\n \"-d\", transmitter, \"-R\", \"-t\", \"/tmp/binary100\",\n \"-a\", \"0\", \"-x\", tx_gain, \"-i\", if_freq,\n \"-o\", lo_freq, \"-m\", image_reject],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n\n time.sleep(1)\n sweep = subprocess.Popen([\"host/build/hackrf-tools/src/hackrf_sweep\",\n \"-d\", receiver, \"-N\", \"2\", \"-w\", \"333333\",\n \"-f\", sweep_range, \"-a\", \"0\", \"-l\", rx_lna_gain,\n \"-g\", rx_vga_gain],\n stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n sweep.wait()\n transmit.terminate()\n transmit.wait()\n\n # parse the hackrf_sweep output\n data, stderr = sweep.communicate()\n data = data.decode(\"utf-8\")\n data = data.split(\"\\n\")\n print(data[4])\n data = data[4] # Note: using data from the 2nd sweep until issue #1230 is resolved.\n data = data.split(\", \")\n data = data[6:21]\n bins = [float(bin) for bin in data]\n return bins\n\n\ndef check_signal(freq, bins):\n signal = bins.pop(1)\n signal_threshold = -25\n max_power = -10\n result = PASS\n\n if signal < signal_threshold:\n print(f\"Signal not strong enough at {freq} MHz\")\n result = FAIL\n elif signal > max_power:\n print(f\"Received signal exceeded maximum power at {freq} MHz\")\n result = 1\n\n for bin in bins:\n if bin > max_power or bin > signal:\n print(f\"Non-target bin power exceeded max power threshold at {freq} MHz\")\n result = FAIL\n break\n\n return result\n\n\ndef main():\n write_bytes()\n tester_hub_on = subprocess.Popen([\"hubs\", \"hackrf\", \"reset\"])\n tester_hub_on.wait()\n time.sleep(1)\n eut_clkout_on = subprocess.Popen([\"host/build/hackrf-tools/src/hackrf_clock\",\n \"-o\", \"1\", \"-d\", EUT])\n tester_clkout_off = subprocess.Popen([\"host/build/hackrf-tools/src/hackrf_clock\",\n \"-o\", \"0\", \"-d\", TESTER])\n eut_clkout_on.wait()\n tester_clkout_off.wait()\n\n _9_5Mhz_data = capture_signal(sweep_range=\"9:29\", tx_gain=\"38\", rx_lna_gain=\"16\",\n rx_vga_gain=\"16\", if_freq=\"2628250000\",\n lo_freq=\"2620000000\", image_reject=\"1\")\n _915_5Mhz_data = capture_signal(sweep_range=\"915:935\", tx_gain=\"38\", rx_lna_gain=\"16\",\n rx_vga_gain=\"16\", if_freq=\"2540750000\",\n lo_freq=\"3455000000\", image_reject=\"1\")\n _2665_5Mhz_data = capture_signal(sweep_range=\"2665:2685\", tx_gain=\"26\", rx_lna_gain=\"16\",\n rx_vga_gain=\"16\", freq=\"2664250000\")\n _5999_5Mhz_data = capture_signal(sweep_range=\"5999:6019\", tx_gain=\"37\", rx_lna_gain=\"32\",\n rx_vga_gain=\"40\", if_freq=\"2540750000\",\n lo_freq=\"3460000000\", image_reject=\"2\")\n\n lp1_result = check_signal(9.5, _9_5Mhz_data)\n lp2_result = check_signal(915.5, _915_5Mhz_data)\n bp_result = check_signal(2665.5, _2665_5Mhz_data)\n hp_result = check_signal(5999.5, _5999_5Mhz_data)\n results = [lp1_result, lp2_result, bp_result, hp_result]\n\n if FAIL in results:\n sys.exit(FAIL)\n else:\n sys.exit(PASS)\n\n\nif __name__ == \"__main__\":\n main()\n\n" }, { "path": "ci-scripts/test_host.sh", "content": "#!/bin/bash\nhost/build/hackrf-tools/src/hackrf_info\nEXIT_CODE=\"$?\"\nif [ \"$EXIT_CODE\" == \"1\" ]\nthen\n echo \"Host tool installation success! Exiting..\"\n exit 0\nelif [ \"$EXIT_CODE\" == \"0\" ]\nthen\n echo \"Failed to boot HackRF into DFU mode! Check DFU pin jumper. Exiting..\"\n exit 1\nelif [ \"$EXIT_CODE\" == \"127\" ]\nthen\n echo \"Host tool installation failed! Exiting..\"\n exit $EXIT_CODE\nelse\n echo \"god have mercy on your soul\"\n exit $EXIT_CODE\nfi\n" }, { "path": "ci-scripts/test_sgpio_debug.py", "content": "#!/usr/bin/python3\nimport os\nimport sys\nimport subprocess\nfrom pathlib import Path\n\nFILENAME = f\"/tmp/rx_100kB_{str(os.getpid())}\"\n\n\ndef program_device():\n # build new firmware with SGPIO_DEBUG mode enabled\n print(\"Programming device...\")\n fw_dir = os.getcwd() + \"/firmware/hackrf_usb/build\"\n del_dir = subprocess.run([\"rm\", \"-rf\", \"firmware/hackrf_usb/build\"])\n mk_dir = subprocess.run([\"mkdir\", \"firmware/hackrf_usb/build\"])\n cmake = subprocess.run([\"cmake\", \"-D\", \"SGPIO_DEBUG=1\", \"..\"],\n cwd=fw_dir, stdout=subprocess.DEVNULL)\n make = subprocess.run([\"make\"],\n cwd=fw_dir, stdout=subprocess.DEVNULL)\n program = subprocess.run([\"./ci-scripts/test-firmware-program.sh\"],\n stdout=subprocess.DEVNULL)\n\n\ndef capture():\n shortfall_count = -1\n capture_tries = 0\n\n while shortfall_count != 0:\n print(\"Capturing data...\")\n rx_100kB = subprocess.run([\"host/build/hackrf-tools/src/hackrf_transfer\",\n \"-r\", FILENAME, \"-d\", \"RunningFromRAM\",\n \"-n\", \"50000\", \"-s\", \"20000000\"],\n capture_output=True, encoding=\"UTF-8\")\n print(rx_100kB.stdout)\n print(rx_100kB.stderr)\n print(f\"Wrote capture data to file: {FILENAME}\")\n\n debug_state_proc = subprocess.run([\"host/build/hackrf-tools/src/hackrf_debug\", \"--state\"],\n capture_output=True, encoding=\"UTF-8\")\n print(debug_state_proc.stdout)\n print(debug_state_proc.stderr)\n capture_tries += 1\n debug_state = debug_state_proc.stdout.split(\"\\n\")\n shortfalls_line = [s for s in debug_state if s.startswith(\"Number of shortfalls\")]\n shortfall_count = [int(c) for c in shortfalls_line[0].split() if c.isdigit()][0]\n\n if capture_tries == 10:\n print(\"Unable to transmit data with 0 shortfalls. \" \\\n \"This is not indicative of a device failure. \" \\\n \"Likely an issue with the testing infrastructure.\")\n sys.exit(1)\n\n\ndef check_bytes():\n print(f\"Checking length of {FILENAME}\")\n rx_data = Path(FILENAME).read_bytes()\n if len(rx_data) != 100000: # file should be 100k bytes when using 50k samples\n print(f\"ERROR: Only {str(len(rx_data))} bytes found in file, expected 100k.\")\n sys.exit(1)\n else:\n print(\"Correct file size found.\")\n\n # check that each byte = prev_byte + 1 except at wraparound bounds\n print(\"Checking bytes...\")\n for i in range(1, len(rx_data)):\n if rx_data[i-1] != rx_data[i] - 1:\n if not (rx_data[i] == 0 and rx_data[i-1] == 255):\n print(f\"ERROR: Incorrect data value found at location {str(i)} in {FILENAME}:\")\n # print up to 5 values starting from at most 1 value before error occurence\n j = -1\n while j < 4:\n if i + j < len(rx_data) and i + j > -1:\n print(f\"{str(i+j)} : {str(rx_data[i+j])}\")\n j = j + 1\n sys.exit(1)\n print(\"Successfully validated all bytes in file.\\nSGPIO debug test passed.\")\n\n\ndef main():\n program_device()\n capture()\n check_bytes()\n\n\nif __name__ == \"__main__\":\n main()\n\n" }, { "path": "docs/.readthedocs.yaml", "content": "build:\n os: \"ubuntu-20.04\"\n tools: \n python: \"3.9\"\n\nsphinx:\n configuration: conf.py\n\npython: \n install:\n - requirements: requirements.txt" }, { "path": "docs/Makefile", "content": "# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = source\nBUILDDIR = build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)" }, { "path": "docs/doxygen/Doxyfile", "content": "# Doxyfile 1.9.1\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the configuration\n# file that follow. The default is UTF-8 which is also the encoding used for all\n# text before the first occurrence of this tag. Doxygen uses libiconv (or the\n# iconv built into libc) for the transcoding. See\n# https://www.gnu.org/software/libiconv/ for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = \"libhackrf\"\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER =\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF = \"HackRF SDR platform library\"\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO =\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY =\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-\n# directories (in 2 levels) under the output directory of each output format and\n# will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,\n# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),\n# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,\n# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),\n# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,\n# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,\n# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,\n# Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all generated output in the proper direction.\n# Possible values are: None, LTR, RTL and Context.\n# The default value is: None.\n\nOUTPUT_TEXT_DIRECTION = None\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = NO\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF = \"The $name class\" \\\n \"The $name widget\" \\\n \"The $name file\" \\\n is \\\n provides \\\n specifies \\\n contains \\\n represents \\\n a \\\n an \\\n the\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH =\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = YES\n\n# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line\n# such as\n# /***************\n# as being the beginning of a Javadoc-style comment \"banner\". If set to NO, the\n# Javadoc-style will behave just like regular comments and it will not be\n# interpreted by doxygen.\n# The default value is: NO.\n\nJAVADOC_BANNER = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# By default Python docstrings are displayed as preformatted text and doxygen's\n# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the\n# doxygen's special commands can be used and the contents of the docstring\n# documentation blocks is shown as doxygen documentation.\n# The default value is: YES.\n\nPYTHON_DOCSTRING = YES\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:\\n\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". You can put \\n's in the value part of an alias to insert\n# newlines (in the resulting output). You can put ^^ in the value part of an\n# alias to insert a newline as if a physical newline was in the original file.\n# When you need a literal { or } or , in the value part of an alias you have to\n# escape them by means of a backslash (\\), this can lead to conflicts with the\n# commands \\{ and \\} for these it is advised to use the version @{ and @} or use\n# a double escape (\\\\{ and \\\\})\n\nALIASES =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = YES\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice\n# sources only. Doxygen will then generate output that is more tailored for that\n# language. For instance, namespaces will be presented as modules, types will be\n# separated into more groups, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_SLICE = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,\n# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,\n# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:\n# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser\n# tries to guess whether the code is fixed or free formatted code, this is the\n# default for Fortran type files). For instance to make doxygen treat .inc files\n# as Fortran files (default is PHP), and .f files as C (default is Fortran),\n# use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen. When specifying no_extension you should add\n# * to the FILE_PATTERNS.\n#\n# Note see also the list of default file extension mappings.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See https://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 5.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 5\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = YES\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = YES\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use\n# during processing. When set to 0 doxygen will based this on the number of\n# cores available in the system. You can set it explicitly to a value larger\n# than 0 to get more control over the balance between CPU load and processing\n# speed. At this moment only the input processing can be done using multiple\n# threads. Since this is still an experimental feature the default is set to 1,\n# which efficively disables parallel processing. Please report any issues you\n# encounter. Generating dot graphs in parallel is controlled by the\n# DOT_NUM_THREADS setting.\n# Minimum value: 0, maximum value: 32, default value: 1.\n\nNUM_PROC_THREADS = 1\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = YES\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = NO\n\n# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual\n# methods of a class will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIV_VIRTUAL = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = YES\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = NO\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If this flag is set to YES, the name of an unnamed parameter in a declaration\n# will be determined by the corresponding definition. By default unnamed\n# parameters remain unnamed in the output.\n# The default value is: YES.\n\nRESOLVE_UNNAMED_PARAMS = YES\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# declarations. If set to NO, these declarations will be included in the\n# documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# With the correct setting of option CASE_SENSE_NAMES doxygen will better be\n# able to match the capabilities of the underlying filesystem. In case the\n# filesystem is case sensitive (i.e. it supports files in the same directory\n# whose names only differ in casing), the option must be set to YES to properly\n# deal with such files in case they appear in the input. For filesystems that\n# are not case sensitive the option should be be set to NO to properly deal with\n# output files written for symbols that only differ in casing, such as for two\n# classes, one named CLASS and the other named Class, and to also support\n# references to files without having to specify the exact matching casing. On\n# Windows (including Cygwin) and MacOS, users should typically set this option\n# to NO, whereas on Linux or other Unix flavors it should typically be set to\n# YES.\n# The default value is: system dependent.\n\nCASE_SENSE_NAMES = YES\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= NO\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = NO\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = NO\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = YES\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as not documenting some parameters\n# in a documented function, or documenting parameters that don't exist or using\n# markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong or incomplete\n# parameter documentation, but not about the absence of documentation. If\n# EXTRACT_ALL is set to YES then this flag will automatically be disabled.\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = YES\n\n# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS\n# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but\n# at the end of the doxygen process doxygen will return with a non-zero status.\n# Possible values are: NO, YES and FAIL_ON_WARNINGS.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = \"../../host/libhackrf/src/hackrf.h\" \n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see:\n# https://www.gnu.org/software/libiconv/) for the list of possible encodings.\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by doxygen.\n#\n# Note the list of default checked file patterns might differ from the list of\n# default file extension mappings.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,\n# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,\n# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,\n# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),\n# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,\n# *.ucf, *.qsf and *.ice.\n\nFILE_PATTERNS = *.c \\\n *.cc \\\n *.cxx \\\n *.cpp \\\n *.c++ \\\n *.java \\\n *.ii \\\n *.ixx \\\n *.ipp \\\n *.i++ \\\n *.inl \\\n *.idl \\\n *.ddl \\\n *.odl \\\n *.h \\\n *.hh \\\n *.hxx \\\n *.hpp \\\n *.h++ \\\n *.cs \\\n *.d \\\n *.php \\\n *.php4 \\\n *.php5 \\\n *.phtml \\\n *.inc \\\n *.m \\\n *.markdown \\\n *.md \\\n *.mm \\\n *.dox \\\n *.py \\\n *.pyw \\\n *.f90 \\\n *.f95 \\\n *.f03 \\\n *.f08 \\\n *.f18 \\\n *.f \\\n *.for \\\n *.vhd \\\n *.vhdl \\\n *.ucf \\\n *.qsf \\\n *.ice\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = NO\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE =\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# AClass::ANamespace, ANamespace::*Test\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories use the pattern */test/*\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS = *\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE = \n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = NO\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# entity all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see https://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the\n# clang parser (see:\n# http://clang.llvm.org/) for more accurate parsing at the cost of reduced\n# performance. This can be particularly helpful with template rich C++ code for\n# which doxygen's built-in parser lacks the necessary type information.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n# The default value is: NO.\n\nCLANG_ASSISTED_PARSING = NO\n\n# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to\n# YES then doxygen will add the directory of each input to the include path.\n# The default value is: YES.\n\nCLANG_ADD_INC_PATHS = YES\n\n# If clang assisted parsing is enabled you can provide the compiler with command\n# line options that you would normally use when invoking the compiler. Note that\n# the include paths will already be set by doxygen for the files and directories\n# specified with INPUT and INCLUDE_PATH.\n# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\n\nCLANG_OPTIONS =\n\n# If clang assisted parsing is enabled you can provide the clang parser with the\n# path to the directory containing a file called compile_commands.json. This\n# file is the compilation database (see:\n# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the\n# options used when the source files were built. This is equivalent to\n# specifying the -p option to a clang tool, such as clang-check. These options\n# will then be passed to the parser. Any options specified with CLANG_OPTIONS\n# will be added as well.\n# Note: The availability of this option depends on whether or not doxygen was\n# generated with the -Duse_libclang=ON option for CMake.\n\nCLANG_DATABASE_PATH =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = NO\n\n# In case all classes in a project start with a common prefix, all classes will\n# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n# can be used to specify a prefix (or a list of prefixes) that should be ignored\n# while generating the index headers.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = YES\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list). For an example see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET =\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a colorwheel, see\n# https://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use grayscales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n# page will contain the date and time when the page was generated. Setting this\n# to YES can help to show when doxygen was last run and thus if the\n# documentation is up to date.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_TIMESTAMP = NO\n\n# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML\n# documentation will contain a main index with vertical navigation menus that\n# are dynamically created via JavaScript. If disabled, the navigation index will\n# consists of multiple levels of tabs that are statically embedded in every HTML\n# page. Disable this option to support browsers that do not have JavaScript,\n# like the Qt help browser.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_MENUS = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see:\n# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To\n# create a documentation set, doxygen will generate a Makefile in the HTML\n# output directory. Running make will produce the docset in that directory and\n# running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy\n# genXcode/_index.html for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# (see:\n# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the main .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location (absolute path\n# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to\n# run qhelpgenerator on the generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine-tune the look of the index. As an example, the default style\n# sheet generated by doxygen has an example that shows how to put an image at\n# the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n# the same information as the tab index, you could consider setting\n# DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 1\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg\n# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see\n# https://inkscape.org) to generate formulas as SVG images instead of PNGs for\n# the HTML output. These images will generally look nicer at scaled resolutions.\n# Possible values are: png (the default) and svg (looks nicer but requires the\n# pdf2svg or inkscape tool).\n# The default value is: png.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FORMULA_FORMAT = png\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# Use the FORMULA_TRANSPARENT tag to determine whether or not the images\n# generated for formulas are transparent PNGs. Transparent PNGs are not\n# supported properly for IE 6.0, but are supported on all modern browsers.\n#\n# Note that when changing this option you need to delete any form_*.png files in\n# the HTML output directory before the changes have effect.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_TRANSPARENT = YES\n\n# The FORMULA_MACROFILE can contain LaTeX \\newcommand and \\renewcommand commands\n# to create new LaTeX commands to be used in formulas as building blocks. See\n# the section \"Including formulas\" for details.\n\nFORMULA_MACROFILE =\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# https://www.mathjax.org) which uses client side JavaScript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. See the MathJax site (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility), NativeMML (i.e. MathML) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from https://www.mathjax.org before deployment.\n# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see:\n# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /