michael/zephyr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: handle arch / soc / board docs in new hardware model

Browse Source 
Updates to Zephyr Kconfig doc generation for new hardware model.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
This commit is contained in:
Torsten Rasmussen
2023-12-22 12:16:51 +01:00
committed by Carles Cufi
parent b4db917de9
commit 12e375f826
1 changed files with 45 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
doc/_extensions/zephyr/kconfig/__init__.py
View File

@@ -28,8 +28,10 @@ Options
${BASE_PATH}/modules/${MODULE_NAME}/Kconfig.
"""
import argparse
import json
import os
import re
import sys
from itertools import chain
from pathlib import Path
@@ -61,6 +63,8 @@ KCONFIGLIB = SCRIPTS / "kconfig"
sys.path.insert(0, str(KCONFIGLIB))
import kconfiglib
import list_boards
import list_hardware
import zephyr_module
@@ -84,9 +88,46 @@ def kconfig_load(app: Sphinx) -> Tuple[kconfiglib.Kconfig, Dict[str, str]]:
f.write(kconfig)
(Path(td) / 'soc').mkdir(exist_ok=True)
root_args = argparse.Namespace(**{'soc_roots': [Path(ZEPHYR_BASE)]})
v2_systems = list_hardware.find_v2_systems(root_args)
soc_folders = {soc.folder for soc in v2_systems.get_socs()}
with open(Path(td) / "soc" / "Kconfig.defconfig", "w") as f:
f.write('')
with open(Path(td) / "soc" / "Kconfig.soc", "w") as f:
for folder in soc_folders:
f.write('source "' + os.path.join(folder, 'Kconfig.soc') + '"\n')
with open(Path(td) / "soc" / "Kconfig", "w") as f:
for folder in soc_folders:
f.write('osource "' + os.path.join(folder, 'Kconfig') + '"\n')
(Path(td) / 'arch').mkdir(exist_ok=True)
root_args = argparse.Namespace(**{'arch_roots': [Path(ZEPHYR_BASE)], 'arch': None})
v2_archs = list_hardware.find_v2_archs(root_args)
kconfig = ""
for arch in v2_archs['archs']:
kconfig += 'source "' + str(Path(arch['path']) / 'Kconfig') + '"\n'
with open(Path(td) / "arch" / "Kconfig", "w") as f:
f.write(kconfig)
(Path(td) / 'boards').mkdir(exist_ok=True)
root_args = argparse.Namespace(**{'board_roots': [Path(ZEPHYR_BASE)],
'soc_roots': [Path(ZEPHYR_BASE)], 'board': None})
v2_boards = list_boards.find_v2_boards(root_args)
with open(Path(td) / "boards" / "Kconfig.boards", "w") as f:
for board in v2_boards:
board_str = 'BOARD_' + re.sub(r"[^a-zA-Z0-9_]", "_", board.name).upper()
f.write('config ' + board_str + '\n')
f.write('\t bool\n')
for identifier in list_boards.board_v2_identifiers(board):
board_str = 'BOARD_' + re.sub(r"[^a-zA-Z0-9_]", "_", identifier).upper()
f.write('config ' + board_str + '\n')
f.write('\t bool\n')
f.write('source "' + os.path.join(board.dir, 'Kconfig.') + board.name + '"\n\n')
# base environment
os.environ["ZEPHYR_BASE"] = str(ZEPHYR_BASE)
os.environ["srctree"] = str(ZEPHYR_BASE)
@@ -96,8 +137,10 @@ def kconfig_load(app: Sphinx) -> Tuple[kconfiglib.Kconfig, Dict[str, str]]:
# include all archs and boards
os.environ["ARCH_DIR"] = "arch"
os.environ["ARCH"] = "[!v][!2]*"
os.environ["BOARD_DIR"] = "boards/*/*"
os.environ["HWM_SCHEME"] = "v1"
os.environ["HWM_SCHEME"] = "v2"
os.environ["BOARD"] = "boards"
os.environ["BOARD_DIR"] = str(Path(td) / "boards")
# insert external Kconfigs to the environment
module_paths = dict()