patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

x86: gen_idt.py: add docstring

Browse source 
Provide additional details on what this script does.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2019-02-24 11:57:23 -08:00 committed by Andrew Boie
parent e64d18b343
commit 9a7355dfad
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
arch/x86/gen_idt.py
View file

@ -4,6 +4,30 @@
#
# SPDX-License-Identifier: Apache-2.0
"""Generate Interrupt Descriptor Table for x86 CPUs.
This script generates the interrupt descriptor table (IDT) for x86.
Please consule the IA Architecture SW Developer Manual, volume 3,
for more details on this data structure.
This script accepts as input the zephyr_prebuilt.elf binary,
which is a link of the Zephyr kernel without various build-time
generated data structures (such as the IDT) inserted into it.
This kernel image has been properly padded such that inserting
these data structures will not disturb the memory addresses of
other symbols. From the kernel binary we read a special section
"intList" which contains the desired interrupt routing configuration
for the kernel, populated by instances of the IRQ_CONNECT() macro.
This script outputs three binary tables:
1. The interrupt descriptor table itself.
2. A bitfield indicating which vectors in the IDT are free for
installation of dynamic interrupts at runtime.
3. An array which maps configured IRQ lines to their associated
vector entries in the IDT, used to program the APIC at runtime.
"""
import argparse
import sys
import struct