1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
RIOT/boards/native/doc.txt
Frederik Haxel 16eff9b6ed native: Linux/x86_64 support
Initial version to test 64 bit compatibility.

Instead of a separate board, the inital version for Linux/x86_64 is enabled
by setting the environment variable `NATIVE_64BIT=y` and compiling as usual.

Not currently implemented:
* Architectures other than x86_64 or operating systems other than Linux
    * No FreeBSD support
    * No Aarch support
* Rust support for x86_64
2024-01-30 16:33:19 +01:00

44 lines
1.3 KiB
Plaintext

/**
@defgroup boards_native Native Board
@ingroup boards
@brief Support for running RIOT in native
[Family: native](https://github.com/RIOT-OS/RIOT/wiki/Family:-native)
# Overview
![Terminal running RIOT native](https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/Native.jpg)
# Hardware
- CPU: Host CPU
- RAM: Host RAM
- Flash:
- for program execution: Host file system
- for the @ref drivers_periph_flashpage : emulated in RAM
- Network: Tap Interface
- UART: Runtime configurable - `/dev/tty*` are supported
- Timers: Host timer
- LEDs: One red and one green LED - state changes are printed to the UART
- PWM: Dummy PWM
- QDEC: Emulated according to PWM
- SPI: Runtime configurable - `/dev/spidev*` are supported (Linux host only)
- GPIO: Runtime configurable - `/dev/gpiochip*` are supported (Linux host only)
# Required packages
The `native` version of RIOT will produce a 32 bit binary by default.
To compile for x86_64 set the environment variable `NATIVE_64BIT=1`.
On Debian/Ubuntu you can install the required libraries with
```
sudo apt install gcc-multilib
```
Likewise, for the unittest execution, `libasan5` is needed for 32 bit binaries.
On Debian/Ubuntu you can install the required libraries with
```
sudo apt install lib32asan5
```
*/