System

System library contains tools and utilities that make RIOT an actual operating system. More...

Detailed Description

System library contains tools and utilities that make RIOT an actual operating system.

Modules
	5x5 Font 'Mineplex'
	The Mineplex font for containing 5x5 pixel ASCII characters.
	A minimal, non-destructive URI parser
	A minimal, non-destructive parser for URI references.
	A terminal progress bar
	Manage a progress bar on the standard output.
	Analog data conversion utilities
	Utility functions for converting analog data samples.
	Arduino
	Arduino in RIOT.
	Auto-initialization
	Auto initialize modules.
	Benchmark
	Framework for running simple runtime benchmarks.
	Binary coded decimal
	Library to de- and encode binary coded decimals.
	Bitfields
	Bitfields of arbitrary length.
	Bloom filter
	Bloom filter library.
	Board reset via USB CDC ACM
	Trigger a board reset via USB CDC ACM.
	Bottom Half Processor
	Base implementation of Bottom Half Processor module for generic IRQ offloading.
	Busy Waiting low-level helpers
	This modules provides helper functions for busy waiting on short intervals before timers are initialized, e.g.
	C++ Unittests
	RIOT unit tests for C++.
	C++ new and delete operator module
	This module provides the new and delete operators for platforms that do not use libstdc++.
	C25519 cryptographic library
	Curve25519 and Ed25519 for low-memory systems.
	Callback multiplexer
	cb_mux provides utilities for storing, retrieving, and managing callback information in a singly linked list.
	Color
	The color sys module supports handling RGB and HSV color.
	CongURE - A Congestion control framework
	Congestion control utilizing re-usable elements
	Crypto
	RIOT provides a collection of block cipher ciphers, different operation modes and cryptographic hash algorithms.
	Data Compression Libraries
	Provides compression libraries and utilities for RIOT.
	Direct pin control for debugging/profiling
	ECC
	A collection of error correction code (ECC) algorithms.
	EEPROM registration
	eepreg provides a facility to easily manage the locations of data stored in EEPROM via a meta-data registry.
	Entropy Sources
	Collection of different Entropy Sources.
	Error correction codes
	Error correction function libraries.
	Event Queue
	Provides an Event loop.
	FIDO2 - Fast Identity Online 2
	Description of the FIDO2 CTAP implementation in RIOT.
	FUZZING utilities
	Various utilities for fuzzing network applications.
	File systems
	File system libraries.
	Fractional integer operations
	This header provides some functions for scaling integers by fractions, while preserving as many bits as possible.
	Hashes
	A collection of hash algorithms.
	Helpers for pointer tagging
	Helpers to manipulate partitions (slots) on internal flash
	IRQ Disable Debug helper
	Debug time spent with IRQ disabled.
	ISR Pipe
	ISR -> userspace pipe.
	Initialization of USB Device Firmware
	Upgrade for riotboot.
	Layered PM Infrastructure
	This module provides a base infrastructure that MCU's may use to implement periph/pm.
	Lightweight Morse encoder
	Provides slim Morse encoding functionality.
	Locally Unique ID Generator
	Generate system wide (locally) unique IDs.
	Magic values for riotboot
	Math libraries and utilities
	Provides math libraries and utilities for RIOT.
	Memory management
	Provides memory management implementations and utilities.
	Millisecond interval event timers
	Provides timers for events up to $2^{32}$ milliseconds in the future.
	Minimal netdev Ethernet device processing
	Minimal netdev IEEE 802.15.4 device processing
	NanoCBOR library
	CBOR encoder and decoder library for tiny devices.
	Object dump
	Allows to print out data dumps of memory regions in hexadecimal or/and ASCII representation.
	POSIX wrapper for RIOT
	POSIX header files.
	PS
	Show list with all threads.
	PSA Cryptographic API
	Implements the PSA Crypto API specification.
	Phydat
	Generic data container for physical data and utility functions.
	Pipe IPC
	Generic pipe implementation.
	Platform-independent access to architecture
	details
	Pointer Compression
	Provides 32bit -> 16bit pointer compression.
	RFC 4122 compliant UUID's
	Provides RFC 4122 compliant UUID's.
	RIOT header helpers and tools
	The header contains.
	RTC helpers
	Common RTC helper functions.
	Random
	Pseudo Random Number Generator (PRNG)
	Round Robin Scheduler
	This module module provides round robin scheduling for all runable threads within each not masked priority.
	SAUL registry
	Global sensor/actuator registry for SAUL devices.
	SRAM PUF
	SRAM based physically unclonable function (PUF)
	STDIO abstraction
	Simple standard input/output (STDIO) abstraction for RIOT.
	SUIT secure firmware OTA upgrade infrastructure
	SUIT manifest handling.
	Schedstatistics
	When including this module scheduler statistics (schedstat_t) for a thread will be updated on every sched_run().
	Semaphores
	Lightweight semaphore implementation.
	SenML
	Basic SenML types.
	Serial Bootloader Protocol
	Serialization
	Utilities for data serialization.
	Shell
	Simple shell interpreter.
	Shell lock
	Simple module to provide a password protection for the shell.
	Stack Smashing Protector
	Stack Smashing protector.
	String formatting (fmt)
	Provides simple string formatting functions.
	System Buses for common events
	System core clock
	Test interactive synchronization
	Utility function for synchronizing before a test.
	Test result output
	Utility function for abstraction of test result output format.
	Thread safe ringbuffer
	Thread-safe ringbuffer implementation.
	Time unit representations
	Timestamp representation, computation, and conversion.
	Timex
	Timestamp representation, computation, and conversion.
	Tiny strerror() implementation
	Tiny strerror() implementation.
	Trickle Timer
	Implementation of a generic Trickle Algorithm (RFC 6206)
	TweetNaCl high-security cryptographic library
	Provides the TweetNaCl high-security cryptographic library.
	UDP benchmark
	URI template processor
	URI template processor.
	USB
	Configuration defines for USB peripheral devices.
	Ultra-lightweight Javascript for Internet Of Things
	Provides Javascript support for RIOT.
	Unittests
	RIOT Unittests based on the EmbUnit Framework.
	Universal Address Container
	universal address container
	Utilities to influence the order of auto-initialized modules
	Utility functions for atomic access
	This modules adds some utility functions to perform atomic accesses.
	Utility functions that are missing in <tt>string.h</tt>
	This header provides utility functions that the standard C libs string.h lacks, such as explicit_bzero.
	Utility functions, macros, and types for
	read-only memory
	Virtual File System (VFS) layer
	Provides an interface for accessing files and directories from different devices and file systems.
	app_metadata
	Module for the application metadata.
	chunked Ringbuffer
	Implementation of a Ringbuffer to store chunks of data.
	endian conversions as provided by most libcs
	This module provides architecture-independent access to architecture details.
	expect() utility function
	imath: Integer Math functions
	This modules provides some integer-only math functions.
	inverse Semaphores
	Lightweight inverse semaphore implementation.
	iolist scatter / gather IO
	Provides linked-list scatter / gather IO.
	log_color: Colored log module
	This module implements a logging module with colored output.
	log_printfnoformat: puts log module
	This module implements an example logging module using puts to just print the format string saving on the number of libraries need.
	riotboot flash writer
	small Protocol Buffers library
	Provides a protocol buffers library to RIOT.
	unaligned memory access methods
	Provides functions for safe unaligned memory accesses.
	utlist
	Basic linked list operation definitions.
	xtimer high level timer abstraction layer (deprecated)
	Provides a high level timer module to register timers, get current system time, and let a thread sleep for a certain amount of time.
	ztimer high level timer abstraction layer
	High level timer abstraction layer.

Files
file	bit.h
	Bit access macros with bit-banding support for Cortex-M based CPUs.
file	byteorder.h
	Functions to work with different byte orders.
file	frac.h
file	trace.h
	Trace program flows.