readme.md
1===============================================================================
2# hal folder
3===============================================================================
4
5The HAL folder provides support code for use by the bare metal drivers for the
6fabric IP cores.
7The HAL folder contains files using a combination of C and assembly source code.
8
9The hal folder should be included in a PolarFire SoC Embedded project under the
10platform directory. See location in the drawing below.
11
12The hal folder contains:
13
14* register access functions
15* assert macros
16
17### Project directory strucutre, showing where hal folder sits.
18
19 +---------+ +-----------+
20 | src +----->|application|
21 +---------+ | +-----------+
22 |
23 | +-----------+
24 +-->|modules |
25 | +-----------+
26 |
27 | +-----------+ +---------+
28 +-->|platform +---->|config |
29 +-----------+ | +---------+
30 |
31 | +---------+
32 +->|drivers |
33 | +---------+
34 |
35 | +---------+
36 +->|hal |
37 | +---------+
38 |
39 | +---------+
40 +->|mpfs_hal |
41 +---------+
