Skip to content

Commit

Permalink
xtensa-build-zephyr.py: clarify XTENSA_SYSTEM and XTENSA_CORE in --help
Browse files Browse the repository at this point in the history
This has always been mysterious, try to shed a bit of light.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
  • Loading branch information
marc-hb authored and lgirdwood committed Mar 1, 2024
1 parent a90ed21 commit 1b0c084
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
3 changes: 3 additions & 0 deletions scripts/set_xtensa_params.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
#
# Not all variables are used in all use cases. Some are.
#
# Find some information about XTENSA_SYSTEM and XTENSA_CORE in
# ./scripts/xtensa-build-zephyr.py --help
#
# The variables used by Zephyr are duplicated in
# xtensa-build-zephyr.py, please keep in sync!

Expand Down
24 changes: 16 additions & 8 deletions scripts/xtensa-build-zephyr.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,19 +169,27 @@ def parse_args():
parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter,
epilog=(

f"""This script supports XtensaTools but only when installed in a specific
directory structure, example:
f"""This script supports XtensaTools but only when installed in a specific directory
structure where a single --xtensa-core is registered per --xtensa-system registry, example
below. Different layouts may or may not work.
myXtensa/
└── install/
├── builds/
│   ├── RD-2012.5{xtensa_tools_version_postfix}
│   │   └── Intel_HiFiEP/
│   └── RG-2017.8{xtensa_tools_version_postfix}
│   ├── LX4_langwell_audio_17_8/
│   └── X4H3I16w2D48w3a_2017_8/
│ ├── RD-2012.5{xtensa_tools_version_postfix}
│ │ └── Intel_HiFiEP/config/ # XTENSA_SYSTEM registry
│ │ ├── default-params
│ │ └── Intel_HiFiEP-params # single, default XTENSA_CORE per registry
│ └── RG-2017.8{xtensa_tools_version_postfix}
│ ├── LX4_langwell_audio_17_8/config/
│ │ ├── default-params
│ │ └── LX4_langwell_audio_17_8-params
│ └── X4H3I16w2D48w3a_2017_8/config/
│ ├── default-params
│ └── X4H3I16w2D48w3a_2017_8-params
└── tools/
├── RD-2012.5{xtensa_tools_version_postfix}
   └── XtensaTools
└── XtensaTools
└── RG-2017.8{xtensa_tools_version_postfix}
└── XtensaTools/
Expand Down

0 comments on commit 1b0c084

Please sign in to comment.