https://github.com/YoWASP/vscode
YoWASP toolchain for Visual Studio Code
https://github.com/YoWASP/vscode
Last synced: 12 months ago
JSON representation
YoWASP toolchain for Visual Studio Code
- Host: GitHub
- URL: https://github.com/YoWASP/vscode
- Owner: YoWASP
- License: isc
- Created: 2023-12-12T16:41:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T19:24:54.000Z (about 2 years ago)
- Last Synced: 2024-08-10T14:21:22.306Z (almost 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 5.96 MB
- Stars: 14
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# YoWASP Toolchain for VS Code
**Run [Python][], [Yosys][], [nextpnr][], [openFPGALoader][], ... in VS Code without installation.**
This extension runs the open source FPGA toolchain *anywhere you can run VS Code*. Windows, Linux, macOS, Chromebooks, corporate networks, even [vscode.dev][]! Add it to VS Code, wait a few minutes, and get a bitstream; simple as that.
[python]: https://python.org/
[yosys]: https://github.com/YosysHQ/yosys
[nextpnr]: https://github.com/YosysHQ/nextpnr
[openFPGALoader]: https://github.com/trabucayre/openFPGALoader
[vscode.dev]: https://vscode.dev
## Getting started
After adding the [extension][] to VS Code, open workspace settings as JSON and add the commands you would like to run to build your design. For example, the demo above uses:
```json
{
"yowaspToolchain.buildCommands": [
["yosys", "top.v", "-p", "synth_ice40", "-o", "top.json"],
["nextpnr-ice40", "--hx8k", "--json", "top.json", "--asc", "top.asc"],
["icepack", "top.asc", "top.bin"]
]
}
```
Then, invoke `YoWASP Toolchain: Build...` and enjoy the output in the terminal.
[extension]: https://marketplace.visualstudio.com/items?itemName=yowasp.toolchain
## Technical details
This extension is a part of the [YoWASP project][yowasp], which provides WebAssembly-based builds of the open source FPGA toolchain for several platforms. The JavaScript packages are published under the [`@yowasp/*`][yowasp-npm] namespace on [NPM][] and delivered by [jsDelivr][] (thanks! =^_^=). The extension itself does not include any toolchain code; rather, it parses the `package.json` metadata of the toolchain packages and imports their entry points, which contain all the code necessary to run the tools.
In addition to the FPGA toolchain, this extension can also run [Python][] code using [Pyodide][]. Similarly to the FPGA tools, the extension itself does not include a Python implementation, but uses artifacts built by the Pyodide project and delivered by [jsDelivr][]. This makes it possible to build designs implemented in the [Amaranth][] language.
[yowasp]: https://yowasp.org
[yowasp-npm]: https://npmjs.org/org/yowasp
[npm]: https://npmjs.org/
[jsdelivr]: https://www.jsdelivr.com/
[pyodide]: https://pyodide.org/
[amaranth]: https://amaranth-lang.org/
## Configuring delivery
### FPGA toolchain
By default, this extension downloads the latest version of each tool (which can be up to 7 days out of date due to caching) from the [jsDelivr][] network. This may not always be the preferred option (in particular, it means builds are not reproducible), so the exact versions and delivery endpoints are configurable. The default configuration is:
```json
{
"yowaspToolchain.bundleBaseURL": "https://cdn.jsdelivr.net/npm/",
"yowaspToolchain.bundles": [
"@spade-lang/spade",
"@yowasp/yosys@release",
"@yowasp/nextpnr-ice40@release",
"@yowasp/nextpnr-ecp5@release"
"@yowasp/nextpnr-machxo2@release",
"@yowasp/nextpnr-nexus@release",
"@yowasp/openfpgaloader"
]
}
```
To require the use of a specific tool version, append `@` to the bundle locator, e.g. `"@yowasp/yosys@0.37.13-dev.628"`.
To use the tool bundle provided at a specific URL, use an absolute URL as the bundle locator instead, e.g. `"http://localhost:8000/yosys/"`. The extension expects to find a built, unpacked NPM package at the provided URL; in this example, it will fetch metadata from `http://localhost:8000/yosys/package.json`.
To use a different CDN, change the base URL. Bundle locators that are not absolute URLs are appended to the base URL.
[@yowasp]: https://npmjs.com/org/yowasp
### Python language
This extension supports the Python language thanks to the [Pyodide][] project. Its version and delivery is configurable as well. The default configuration is:
```json
{
"yowaspToolchain.pyodideBaseURL": "https://cdn.jsdelivr.net/pyodide/v0.24.1/"
}
```
Using a version other than the default one is not recommended because Pyodide does not have a stable API (yet).
## License
The YoWASP extension is distributed under the terms of the [ISC license](LICENSE.txt).
In addition, it includes a compiled Node extension that includes [libusb](https://github.com/libusb/libusb) and is thus subject to the [LGPL](https://github.com/libusb/libusb/blob/master/COPYING); this is used only on desktop VS Code. The compiled extension binaries are copied directly from the [usb](https://www.npmjs.com/package/usb) package.