Xous Documentation

DEPRECATED

this has been moved to the wiki home page

DEPRACATED CONTENT BELOW

A lot of Xous documentation is happening in the form of README.md files in the relevant subdirectories. This page tries to create a single place where all the relevant README.md's are linked for easy searching.

Microkernel Core

• Quickstart is on the main page
• Memory layout
• Processes
• Syscalls
• Startup Sequence
• Boot arguments
• Loader Stage 1 loader for the kernel

OS Services

• Services describes the various servers that compose the services provided by the Xous microkernel. Note: this link should be updated to point to the main branch once these docs are merged.
• Push Events
• GAM Graphical Abstraction Manager
• xous-names Name resolution for server IDs

Hardware Abstractions

• UTRA Hardware register access abstraction for Xous
• Peripheral access conventions Goals for hardware register abstractions
• COM Protocol between the embedded controller (EC) and the main SoC

Hardware Documentation

• SoC register set
• EC register set
• Hardware design files PDFs of schematics are in the "mainboard-*" directories

Meta-Issues

• imports How imported repositories that are not yet stand-alone crates are managed
• Emulation
• Tools Helper tools to build bootable images