https://github.com/vbe0201/faucon

NVIDIA Falcon Microprocessor Suite
https://github.com/vbe0201/faucon

assembler disassembler emulation emulator falcon faucon mcu microprocessor nvidia nvidia-gpu rust rust-lang toolchain

Last synced: 2 months ago
JSON representation

NVIDIA Falcon Microprocessor Suite

• Host: GitHub
• URL: https://github.com/vbe0201/faucon
• Owner: vbe0201
• License: apache-2.0
• Created: 2020-06-06T00:42:07.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-04-06T20:03:45.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T04:37:37.066Z (9 months ago)
• Topics: assembler, disassembler, emulation, emulator, falcon, faucon, mcu, microprocessor, nvidia, nvidia-gpu, rust, rust-lang, toolchain
• Language: Rust
• Homepage: https://vbe0201.github.io/faucon
• Size: 13.6 MB
• Stars: 47
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# faucon: NVIDIA Falcon Microprocessor Suite

[![Cargo Test](https://github.com/vbe0201/faucon/workflows/Cargo%20Test/badge.svg)](https://github.com/vbe0201/faucon)

[![Cargo D0c](https://github.com/vbe0201/faucon/workflows/Cargo%20Doc/badge.svg)](https://github.com/vbe0201/faucon)

[![Discord](https://img.shields.io/discord/269333940928512010?color=blue)](https://discord.gg/ZdqEhed)

[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](./README.md#license)

faucon aims to provide a comprehensive tooling suite for the Falcon microprocessors, including

an assembler, a  disassembler, a CPU emulator for debugging purposes, and documentation on the

architecture. For the time being, faucon explicitly targets the fuc5 generation of these MCUs.

See [the wiki](https://github.com/vbe0201/faucon/wiki) for architecture documentation.

## Components

- [`faucon-asm-derive`](./faucon-asm-derive): Internal implementation details of `faucon-asm`

- [`faucon-asm`](./faucon-asm): A crate for processing Falcon assembly, providing binary

disassembling capabilities

- [`faucon-emu`](./faucon-emu): Implementation of the CPU functionality for emulation

- [`faucon`](./src): Command-line interface for invoking and driving the provided tools

- [`examples`](./examples): Assembly examples on programming the Falcon hardware

## Setup

Coming soon.

## Contributing

The project is in a very early state and WIP. Contributions are welcome.

Contributions to code and documentation are heavily appreciated, may it be a bug fix,

a new feature, or improvement of the code or wiki documentation.

Feel free to join the [ReSwitched Discord server](https://discord.gg/ZdqEhed) and

reach out to `Vale#5252` in either #faucon or #switch-hacking-meta.

## Credits

- [Marcelina Kościelnicka](https://github.com/mwkmwkmwk) and contributors for the

[envytools](https://github.com/envytools/envytools)

project and the [Falcon LLVM backend insight](https://0x04.net/%7Emwk/Falcon.html)

- Switchbrew contributors for the [TSEC wiki page](https://switchbrew.org/wiki/TSEC)

- [Thog](https://github.com/Thog) and [hthh](https://github.com/hthh) for the

[ghidra-falcon](https://github.com/Thog/ghidra_falcon) project

## License

faucon is distributed under the terms of either the Apache License (Version 2.0) or the

MIT license, at the user's choice.

See [LICENSE-APACHE](./LICENSE-APACHE) and [LICENSE-MIT](./LICENSE-MIT) for details.

Contributions to the faucon project must be made under the terms of both licenses.