{"id":21943649,"url":"https://github.com/ben-marshall/microcoder","last_synced_at":"2025-10-13T06:07:53.080Z","repository":{"id":95888204,"uuid":"92603866","full_name":"ben-marshall/microcoder","owner":"ben-marshall","description":"Define custom assembly-like instructions and use them to write programs which are transpiled into synthesisable Verilog code.","archived":false,"fork":false,"pushed_at":"2019-01-08T22:29:33.000Z","size":124,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T18:01:57.148Z","etag":null,"topics":["assembly","microcode","microcontroller","synthesis","verilog"],"latest_commit_sha":null,"homepage":"http://microcoder.readthedocs.io/README/","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/ben-marshall.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2017-05-27T14:31:26.000Z","updated_at":"2024-12-16T06:05:07.000Z","dependencies_parsed_at":"2023-03-13T16:43:56.688Z","dependency_job_id":null,"html_url":"https://github.com/ben-marshall/microcoder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-marshall%2Fmicrocoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-marshall%2Fmicrocoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-marshall%2Fmicrocoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-marshall%2Fmicrocoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ben-marshall","download_url":"https://codeload.github.com/ben-marshall/microcoder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250306638,"owners_count":21408926,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["assembly","microcode","microcontroller","synthesis","verilog"],"created_at":"2024-11-29T03:33:49.130Z","updated_at":"2025-10-13T06:07:48.043Z","avatar_url":"https://github.com/ben-marshall.png","language":"Python","readme":"\n# uCode\n\n[![Documentation Status](https://readthedocs.org/projects/microcoder/badge/?version=latest)](http://microcoder.readthedocs.io/README/)\n\nA toy project for turning user-defined assembly-like programs into \nsynthesisable verilog code. This verilog code can then be implemented on\nan FPGA.\n\nMore information on what this tool might be used for is found \n[here](docs/usage.md).\n\n---\n\n## Aims\n\nThe aim for this project is to allow people to define a set of their own\nassembly-like *micro-instructions* using a very simple syntax. Using these\ndefinitions, they can then write programs which are then transpiled into a\nverilog state-machine. These programs then communicate with the outside world\nusing custom IO ports.\n\n## Progress\n\nCurrently, one can use the tool to:\n\n- Define arbitrary instructions, with arguments and their own set of\n  operations on those arguments.\n- Define arbitrary inputs and outputs to the micro-code program, known as \n  *ports*.\n- Define global state variables which the instructions can access and modfy.\n- Write assembly-like programs, with basic blocks, instructions and\n  conditional jumps between those blocks.\n\nWithin each block, instructions can read and write the program ports, as well\nas the global state variables.\n\n## Documentation\n\nAll documentation is found in the [docs/](./docs/) folder of the project.\nThese same files are also hosted on \n[microcoder.readthedocs.io](http://microcoder.readthedocs.io/README/).\n\n## Examples\n\nThere are some simple examples bundled with the repositiory:\n\n**Counter** - This is a really boring counter which simply counts down\nfrom 10 and then loops. Forever.\n\n```sh\n$\u003e make all run EXAMPLE=count\n```\n\n**Fibonacci** - This program takes an `n` value, and computes the `n`'th\nnumber in the Fibonacci sequence.\n\n```sh\n$\u003e make all run EXAMPLE=fibonacci\n```\n\n**DMA** - An example of a DMA memcopy co-processor which coppies multiple\nwords from one memory base address to another.\n\n```sh\n$\u003e make all run EXAMPLE=dma\n```\n\nThe output wave files for both examples are written to `work/waves.vcd`. This\ncan be viewed using a program like\n[GTKWave](http://iverilog.wikia.com/wiki/GTKWAVE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-marshall%2Fmicrocoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fben-marshall%2Fmicrocoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-marshall%2Fmicrocoder/lists"}