summaryrefslogtreecommitdiff
path: root/docs/HEADERS.md
blob: f904006e29256c968b3139fb35ef5ab8c2bae6cf (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
31
32
33
34
35
36
37
38
39
40
41
42
43
# Headers

## comus

All kernel headers for the `comus` kernel. Each of these headers map directly
to c files in the kernel source tree besides the following.

### asm.h

Contains inline functions for calling x64/x86 assembly

### error.h

Kernel error codes
- Success (0)
- Failure (1)
- All other codes are specific failures

### keycodes.h

Kernel keycodes used in input.h
- ps2 driver uses these keycodes when mapping its scancodes

### limits.h

Maximum limists across multiple components of the kernel.
- max open files
- max filesystem disks
- max number of process
- etc...

## efi.h

Standard UEFI header. Read UEFI specification online for more information.

## elf.h

Standard ELF header. Read ELF specification online for more information.

## lib

Used for kernel c library code stored in `kernel/lib`