summaryrefslogtreecommitdiffhomepage
path: root/doc/specs/SPECIFICATION_MACROS.md
blob: 3b0914543c7226700db33219af9c015e0c062df9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
===================================

# 0: General Information:

===================================

The NeKernel System uses macro to configure its compilation. Some of them shall not be defined at the same time to avoid run-time issues.

===================================

# 1: NeKernel/BootZ:

===================================

- `__nekernel_max_cores` -> Max SMP cores usable by NeKernel's scheduler.
- `__nekernel_boot_core_index` -> Index of the boot core (0, 1, or 3).
- `__nekernel_allow_non_nekernel_pe` -> Allow non-subsystem 17 to run on NeKernel.
- `__nekernel_halkit_include_processor` HALKit include directory for Processor.h
- `__nekernel_dma_pool_start` NeKernel DMA pool start.
- `__nekernel_dma_pool_size` NeKernel DMA pool size.

===================================

# 2: KernelTest:

===================================

- `__KT_TEST_MAIN` -> KernelTest entrypoint symbol.
- `KT_TESTING_ENABLED` -> Program is running under testing constraints.