Go to file
Fabien Chouteau c6bb36d4a4 Create a CONTRIBUTING.md
This file is displayed when contributors start a pull request.

It can be improved in the future with contribution guidelines specific for ADL.
2017-02-22 18:03:18 +01:00
arch Merge pull request #158 from AdaCore/appveyor 2017-02-22 17:35:12 +01:00
boards Fix remaining errors from HAL derived types change 2017-02-21 13:49:11 +01:00
components HAL types: Revert UInt1 to Bit 2017-02-15 19:04:27 +01:00
docs Docs/design.md: Fix Components library name 2017-02-01 16:53:37 +01:00
embedded-runtimes@5cca890139 Bring back embeded-runtimes that was deleted by mistake 2016-11-08 19:47:48 +01:00
examples HAL: Make UInt8|16|32 derived from Interfaces types rather than subtypes 2017-02-13 21:18:34 +01:00
hal HAL types: Revert UInt1 to Bit 2017-02-15 19:04:27 +01:00
middleware HAL: Make UInt8|16|32 derived from Interfaces types rather than subtypes 2017-02-13 21:18:34 +01:00
scripts Continuous builder: Add a script to install optional dependencies 2017-02-21 13:19:06 +01:00
testsuite Fix Native.Filesystem after HAL type change 2017-02-13 21:30:25 +01:00
.gitignore .gitignore: Remove duplicate entry 2017-01-30 00:36:41 +01:00
.gitmodules Updated embedded runtimes submodule to use https instead of ssh 2016-08-19 07:53:04 -04:00
.travis.yml Add Travis-CI continuous integration setup file 2016-12-20 15:06:02 +01:00
CONTRIBUTING.md Create a CONTRIBUTING.md 2017-02-22 18:03:18 +01:00
LICENSE Add a LICENSE file and update the README 2016-11-08 20:18:16 +01:00
README.md Update README with Appveyor build badge 2017-02-21 13:51:13 +01:00
appveyor.yml Continuous builder: Add Appveyor Window continous builder config 2017-02-21 13:19:06 +01:00

README.md

Build Status Build status

Warning!

This repository uses git submodule, please clone with the --recursive option:

git clone --recursive https://github.com/AdaCore/Ada_Drivers_Library.git
  1. Introduction

This repository contains Ada source code and complete sample GNAT projects for selected bare-board platforms supported by GNAT. Initially the repository contains software for ARM platforms from a specific vendor, but we intend this to be a location for both AdaCore and the community in general to contribute support for additional processors, platforms, and vendors.

  1. License

All files are provided under a 3-clause Berkeley Software Distribution (BSD) license. As such, and within the conditions required by the license, the files are available both for proprietary ("commercial") and non-proprietary use.

For details, see the "LICENSE" file in the root directory.

  1. Requirements

The software is written in Ada 2012 and uses, for example, preconditions, postconditions, and the high-level iterator form of for-loops.

In addition, a GNAT implementation-defined pragma is used extensively. This pragma makes it possible to avoid explicit temporary copies when assigning components of types representing hardware registers requiring full word or full half-word accesses. The pragma is named Volatile_Full_Access. Those persons wishing to submit additions to the library should see the GNAT Reference Manual for details.

Therefore, building with the sources requires a compiler supporting both Ada 2012 and the GNAT-defined pragma Volatile_Full_Access. The "GNAT GPL 2016" compiler for ARM ELF is one such compiler (Download it here). A recent GNAT Pro compiler for that target will also suffice.

  1. Content

Initial provision is for the hardware in the STM32F4 family of 32-bit MCUs, as defined in the "RM0090 Reference Manual" (Doc ID 018909 Rev 6, Feb 2014) by STMicroelectronics and made available on the "STM32F4 Discovery" and the "STM32F429 Discovery" kit boards.

Specifically, there are low-level device drivers, higher-level component drivers, small demonstration programs for the drivers, and larger example applications. "Component" drivers are those that are implemented using the lower-level device drivers (e.g., SPI or GPIO), such as the gyroscope and accelerometer on the Discovery boards.

The small driver demonstration programs and the larger applications programs are provided as full projects, including GNAT project files, and are ready to build either within GPS or on the command-line.

Not all devices defined by the Reference Manual are supported, and not all those supported are complete. We encourage contributions of corrections, enhancements, and new drivers.

  1. Roadmap

Here is a list of projects that we are either dreaming about or already working on. If you are interested by one of those, please contact us on the projects's GitHub page.

  • ARM
  • STM32F4/7 USB drivers
  • Components
  • BlueNRG-MS (Bluetooth Low Energy Network Processor)
  • Services
  • Bluetooth Low Energy stack
  • USB stack
  1. Project using the Ada_Drivers_Library

(Add yours to the list!)