AMiRo-OS

each driver can be activated individually as required. Interface functions allow

for bidirectional comunication with an operating system. On the one hand drivers

access according hardware interfaces via defined interface functions (which need

to be implemented by the operating system) and any applications (or the

operating system itself) can take advantage of the drivers by their individual

interfaces. The abstraction layer of the hardware interfaces is called

"periphAL", which is defined by this project.

./

│ The project root directory contains this file, a license.html file as well as

│ a Makefile that allows to easily integrate the project. Furthermore, two

│ interface headers are provided: amiro-lld.h and periphALtypes.h. These are

│ entry points for any utilizing superproject, so it is not required (and not

│ recommended) to include each driver individually.

│

├── include/

│     Each driver defines exactly one include header in this directory. By

│     convention these files are named by the form

│     alld_<product_name>.h

│     <product_name> is a placeholder for the exact name of the according

│     hardware, or the product familiy, if the driver is compatible with all

│     parts.

│

├── source/

│     Any source files are placed in this directory. Usually there is a single

│     file for each driver. If multiple files are necessary, these should be

│     placed in an accordingly named subfolder. Names of folders and files

│     should comply to the aforementioned convention.

│

└── templates/

      AMiRo-LLD requires an implementation of the defined interface and an

      configuration header to be accessible in the include paths at compile

      time. Template files for both can be found in this folder. It is

      recommended to place according implementations of these templated not in

      the AMiRo-LLD project, but the superproject which includes AMiRo-LLD.