{"id":34090488,"url":"https://github.com/esynr3z/corsair","last_synced_at":"2026-04-06T06:33:05.081Z","repository":{"id":39816494,"uuid":"310674835","full_name":"esynr3z/corsair","owner":"esynr3z","description":"Control and Status Register map generator for HDL projects","archived":false,"fork":false,"pushed_at":"2025-05-24T20:54:33.000Z","size":1235,"stargazers_count":128,"open_issues_count":4,"forks_count":41,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-01-06T22:24:20.079Z","etag":null,"topics":["asic","fpga","python","system-verilog","verilog"],"latest_commit_sha":null,"homepage":"https://corsair.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/esynr3z.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing.rst","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-06T18:23:26.000Z","updated_at":"2025-11-17T05:06:59.000Z","dependencies_parsed_at":"2024-10-23T03:53:29.592Z","dependency_job_id":"878f3889-4ac7-46f9-8363-b7eaf65ce302","html_url":"https://github.com/esynr3z/corsair","commit_stats":{"total_commits":236,"total_committers":6,"mean_commits":"39.333333333333336","dds":"0.14406779661016944","last_synced_commit":"907ad40a43ded049bd55e5a14e2adbefc2ec4005"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/esynr3z/corsair","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esynr3z%2Fcorsair","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esynr3z%2Fcorsair/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esynr3z%2Fcorsair/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esynr3z%2Fcorsair/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/esynr3z","download_url":"https://codeload.github.com/esynr3z/corsair/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esynr3z%2Fcorsair/sbom","scorecard":{"id":383506,"data":{"date":"2025-08-11","repo":{"name":"github.com/esynr3z/corsair","commit":"b6477b29f0dee65656c74f9c58beefa8e9e601be"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":7,"reason":"Found 13/17 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish-on-release.yml:1","Warn: no topLevel permission defined: .github/workflows/test-on-push.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-on-release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/esynr3z/corsair/publish-on-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-on-release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/esynr3z/corsair/publish-on-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-on-push.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/esynr3z/corsair/test-on-push.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-on-push.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/esynr3z/corsair/test-on-push.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/publish-on-release.yml:21","Warn: pipCommand not pinned by hash: .github/workflows/publish-on-release.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/test-on-push.yml:18","Warn: pipCommand not pinned by hash: .github/workflows/test-on-push.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/test-on-push.yml:20","Warn: downloadThenRun not pinned by hash: .github/workflows/test-on-push.yml:26","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 pipCommand dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2019-217 / GHSA-462w-v97r-4m45","Warn: Project is vulnerable to: PYSEC-2014-8 / GHSA-8r7q-cvjq-x353","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: PYSEC-2014-82 / GHSA-fqh9-2qgg-h84h","Warn: Project is vulnerable to: PYSEC-2021-66 / GHSA-g3rq-g295-4j3m","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: PYSEC-2019-220 / GHSA-hj2j-77xm-mc5v","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: PYSEC-2020-176 / GHSA-3pqx-4fqf-j49f","Warn: Project is vulnerable to: PYSEC-2020-96 / GHSA-6757-jp84-gxfx","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T16:01:53.642Z","repository_id":39816494,"created_at":"2025-08-18T16:01:53.642Z","updated_at":"2025-08-18T16:01:53.642Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31463014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"online","status_checked_at":"2026-04-06T02:00:07.287Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asic","fpga","python","system-verilog","verilog"],"created_at":"2025-12-14T14:20:31.909Z","updated_at":"2026-04-06T06:33:05.075Z","avatar_url":"https://github.com/esynr3z.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Corsair\n\n⚠️🚨⚠️ **The code for version 1.x is frozen — no new features or bug fixes will be made. More details in [release 2.x roadmap](https://github.com/esynr3z/corsair/discussions/97).** ⚠️🚨⚠️\n\n![corsair_logo](docs/img/logo.png)\n\n[![Documentation Status](https://readthedocs.org/projects/corsair/badge/?version=latest)](https://corsair.readthedocs.io/en/latest/?badge=latest)\n![PyTest Status](https://github.com/esynr3z/corsair/workflows/pytest/badge.svg)\n[![PyPI version](https://badge.fury.io/py/corsair.svg)](https://badge.fury.io/py/corsair)\n\n\nCorsair is a tool that makes it easy to create and maintain control and status register (CSR) map for any HDL project. It allows you to describe your register map in a single file and then generate HDL code, headers, documentation and other things. This effectively eliminates any mismatches between hardware, software and documentation of your IP-core.\n\n![corsair_flow](docs/img/corsair_flow.png)\n\n## Features\n\n- Various human-readable input formats: JSON, YAML or plain text table\n- HDL code generation: Verilog or VHDL module with register map, Verilog header or SystemVerilog package with parameters and definitions\n- Multi-protocol support: APB, AXI-Lite, Avalon-MM\n- Documentation generation: Markdown, AsciiDoc\n- Generation of software-related files: C header, Python module\n- Extensibility: support of external file generators\n- API: creation of custom workflow with corsair API\n\nCorsair documentation is on the [ReadTheDocs.io](https://corsair.readthedocs.io).\n\n## Install\n\nDepending on your system, Python 3 executable might be `python` or `python3`.\nIf there any permissions issues, add `--user` key to the installation scripts.\n\nTo install the latest stable release:\n\n```sh\npython3 -m pip install -U corsair\n```\n\n## Quick start\n\nThe best way to start is to create templates. You can create one for a register map in a format you like (choose onе from `json`, `yaml`, `txt`) :\n\n```sh\ncorsair -t yaml\n```\n\nThis generates two files: one for register map in the format specified `regs.yaml`, and other for configuration - `csrconfig`.\n\nRegister map consists of a collection of memory mapped registers (also referred as CSRs), and registers are made up of bit fields. For example, register map of one register looks like this in YAML:\n\n```yaml\nregmap:\n-   name: CTRL\n    description: Control register\n    address: 8\n    bitfields:\n    -   name: BAUD\n        description: Baudrate value\n        reset: 0\n        width: 2\n        lsb: 0\n        access: rw\n        hardware: o\n        enums:\n        -   name: B9600\n            description: 9600 baud\n            value: 0\n        -   name: B38400\n            description: 38400 baud\n            value: 1\n        -   name: B115200\n            description: 115200 baud\n            value: 2\n```\n\nTo know more about registers, bit fields and their attributes please check the [Register map](https://corsair.readthedocs.io/en/latest/regmap.html) documentation page.\n\nCorsair is configuration-file-oriented tool. By default, it uses INI configuration file `csrconfig`. It specifies all the things needed for generation - input register map file, global parameters and output files (also called targets). It may looks like this:\n\n```ini\n[globcfg]\ndata_width = 32\naddress_width = 16\nregister_reset = sync_pos\n\n[v_module]\npath = regs.v\ninterface = axil\ngenerator = Verilog\n\n[c_header]\npath = regs.h\ngenerator = CHeader\n```\n\nCheck the [Configuration file](https://corsair.readthedocs.io/en/latest/config.html) page to get more details about `csrconfig` and the [Introduction](https://corsair.readthedocs.io/en/latest/introduction.html) page to get general information about workflow.\n\n`csrconfig` also acts like a build script for corsair, so just run in the directory with `csrconfig` file:\n\n```sh\ncorsair\n```\n\nAnd then all the magic happens.\n\nThere are some additional options for overriding working directory, register map or configuration file - to get help simply run\n\n```sh\ncorsair -h\n```\n\nIf you looking for some more examples please check `examples` folder.\n\n## Development\n\nPlease follow the [Developer's Guide](https://corsair.readthedocs.io/en/latest/contributing.html).\n\n## License\n\nCorsair is licensed under [MIT License](LICENSE.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesynr3z%2Fcorsair","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fesynr3z%2Fcorsair","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesynr3z%2Fcorsair/lists"}