summaryrefslogtreecommitdiff
path: root/source/hal
diff options
context:
space:
mode:
Diffstat (limited to 'source/hal')
-rw-r--r--source/hal/readme.md7
-rw-r--r--source/hal/source/components/readme.md5
-rw-r--r--source/hal/source/platform/mps3/readme.md3
-rw-r--r--source/hal/source/platform/native/readme.md3
-rw-r--r--source/hal/source/platform/simple/readme.md3
5 files changed, 21 insertions, 0 deletions
diff --git a/source/hal/readme.md b/source/hal/readme.md
new file mode 100644
index 0000000..1757d5b
--- /dev/null
+++ b/source/hal/readme.md
@@ -0,0 +1,7 @@
+## HAL project
+
+This directory is the root of `Hardware Abstraction Layer` (HAL) library for this repo. The intention is for this layer
+to service higher layers to seamlessly use platform specific functionality via a single abstraction layer. HAL provides
+drivers for each target platform that the repository supports.
+
+See [Repository Structure](../../docs/documentation.md#repository-structure) for more details.
diff --git a/source/hal/source/components/readme.md b/source/hal/source/components/readme.md
new file mode 100644
index 0000000..0451f39
--- /dev/null
+++ b/source/hal/source/components/readme.md
@@ -0,0 +1,5 @@
+## HAL components
+
+This directory contains API and implementations for different modules that can be reused for different platforms.
+
+See [Repository Structure](../../../../docs/documentation.md#repository-structure) for more details.
diff --git a/source/hal/source/platform/mps3/readme.md b/source/hal/source/platform/mps3/readme.md
new file mode 100644
index 0000000..3ca937a
--- /dev/null
+++ b/source/hal/source/platform/mps3/readme.md
@@ -0,0 +1,3 @@
+## MPS3 platform drivers
+
+Project to provide HAL platform drivers for the Arm MPS3 FPGA/FVP targets.
diff --git a/source/hal/source/platform/native/readme.md b/source/hal/source/platform/native/readme.md
new file mode 100644
index 0000000..8c582b7
--- /dev/null
+++ b/source/hal/source/platform/native/readme.md
@@ -0,0 +1,3 @@
+## Native platform drivers
+
+Project to provide HAL platform drivers for native (host machine) target.
diff --git a/source/hal/source/platform/simple/readme.md b/source/hal/source/platform/simple/readme.md
new file mode 100644
index 0000000..8281439
--- /dev/null
+++ b/source/hal/source/platform/simple/readme.md
@@ -0,0 +1,3 @@
+## Simple platform drivers
+
+Project to provide HAL platform drivers for simple (minimal peripherals) target.