diff options
| author | Kshitij Sisodia <kshitij.sisodia@arm.com> | 2022-08-18 12:54:34 +0100 |
|---|---|---|
| committer | Nina Drozd <nina.drozd@arm.com> | 2022-08-25 14:32:02 +0000 |
| commit | c9f1717d227e21ebfab72cceee90b1f8f8522867 (patch) | |
| tree | 991e1cb1b921f4cbe6cc88edc1797eb0eafba4cc /source/hal | |
| parent | 271c69e8e364361f3e4c839a10a4f29ef4c9c866 (diff) | |
| download | ml-embedded-evaluation-kit-c9f1717d227e21ebfab72cceee90b1f8f8522867.tar.gz | |
MLECO-3252: Minor documentation additions
Documentation md files added under source tree with links to
the main docs. Minor updates to FAQs for MLECO-3251 as well.
Change-Id: Ifdcc587f2fcf77228fd46e211d3f9c3963bc9b97
Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
Diffstat (limited to 'source/hal')
| -rw-r--r-- | source/hal/readme.md | 7 | ||||
| -rw-r--r-- | source/hal/source/components/readme.md | 5 | ||||
| -rw-r--r-- | source/hal/source/platform/mps3/readme.md | 3 | ||||
| -rw-r--r-- | source/hal/source/platform/native/readme.md | 3 | ||||
| -rw-r--r-- | source/hal/source/platform/simple/readme.md | 3 |
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. |