From 39569406de065e6c9ff30555c8efb429149fa200 Mon Sep 17 00:00:00 2001 From: Sandeep Gundlupet Raju Date: Tue, 18 Jul 2023 16:13:46 -0600 Subject: README: Update the docs on variables Update READE docs on list of variables used in machine conf. Signed-off-by: Sandeep Gundlupet Raju Fixed a couple of typos Signed-off-by: Mark Hatle --- meta-xilinx-core/conf/machine/README | 75 +++++++++++++++++++++++++++++++++--- 1 file changed, 69 insertions(+), 6 deletions(-) diff --git a/meta-xilinx-core/conf/machine/README b/meta-xilinx-core/conf/machine/README index 5361dc81..0b018b61 100644 --- a/meta-xilinx-core/conf/machine/README +++ b/meta-xilinx-core/conf/machine/README @@ -142,20 +142,83 @@ you should not use : override values for the same reason. Note, not every machine file will have all of these variables, only the ones you need to override should be set. +Variables set before required inclusion file: +Variables that changes based on hw design or board specific requirement must be +set before required inclusion file else pre-expansion value defined in generic +machine conf will be set. This way user can also override these variables from +local.conf + System wide setting: TUNE_FEATURES:tune- - Specific tune features external-hdf recipe from meta-xilinx-tools: -HDF_MACHINE - Used by the recipe to find the correct XSA -HDF_EXT - only xsa is supported, legacy variable -HDF_BASE - protocol if not using the default external-hdf repository -HDF_PATH - path to the repository or XSA file +HDF_MACHINE - Machine to load from reference defign xsa using hdf-examples recipe +HDF_EXT - Only ".xsa" externsion is supported, legacy variable. +HDF_BASE - Download protocol (file://, git://, http:// or https://) protocol if + not using the default external-hdf repository. +HDF_PATH - Path to the repository or XSA file + +fs-boot recipe from meta-xilinx-tools: +YAML_SERIAL_CONSOLE_STDIN:pn-fs-boot - YAML based uart stdin configuration for +MicroBlaze. Example: axi_uartlite_0 or axi_uart16550_0 etc,. +YAML_SERIAL_CONSOLE_STDOUT:pn-fs-boot - YAML based uart stdout configuration for +MicroBlaze. Example: axi_uartlite_0 or axi_uart16550_0 etc,. +YAML_MAIN_MEMORY_CONFIG:pn-fs-boot - YAML based DDR4 or MIG configuration for +MicroBlaze. Example: DDR4_0 or MIG_7SERIES_0 etc,. +YAML_FLASH_MEMORY_CONFIG:pn-fs-boot - YAML based flash configuration for +MicroBlaze. Example: axi_emc_0 or axi_quad_spi_0 etc,. +XSCTH_PROC:pn-fs-boot - Processor IP used while configuring embeddedsw compoments. +Example: microblaze_0 or microblaze_1 etc,. + +fsbl-firmware recipe from meta-xilinx-tools: +YAML_SERIAL_CONSOLE_STDIN:pn-fsbl-firmware - YAML based FSBL uart stdin configuration +for Zynq-7000 and ZynqMP devices. +YAML_SERIAL_CONSOLE_STDOUT:pn-fsbl-firmware - YAML based FSBL uart stdout configuration +for Zynq-7000 and ZynqMP devices. + +pmu-firmware recipe from meta-xilinx-tools: +YAML_SERIAL_CONSOLE_STDIN:pn-pmu-firmware - YAML based PMUFW uart stdin configuration +for ZynqMP devices. +YAML_SERIAL_CONSOLE_STDOUT:pn-pmu-firmware - YAML based PMUFW uart stdout configuration +for ZynqMP devices. + +plm-firmware recipe from meta-xilinx-tools: +YAML_SERIAL_CONSOLE_STDIN:pn-plm-firmware - YAML based PLM uart stdin configuration +for Versal devices. +YAML_SERIAL_CONSOLE_STDOUT:pn-fplmsbl-firmware - YAML based PLM uart stdout +configuration for Versal devices. device-tree recipe from meta-xilinx-tools: -YAML_DT_BOARD_FLAGS - flags used for dtgen +YAML_CONSOLE_DEVICE_CONFIG:pn-device-tree - YAML based uart console configuration +for all device families. Example: axi_uartlite_0 or psu_uart_0 etc,. +YAML_MAIN_MEMORY_CONFIG:pn-device-tree - YAML based memory configuration for all +device families. Example: DDR4_0 or PS7_DDR_0 or PSU_DDR_0 etc,. +XSCTH_PROC:pn-device-tree - Processor IP used while configuring device-tree +compoments. Example: microblaze_0 or microblaze_1 etc,. +YAML_DT_BOARD_FLAGS:pn-device-tree - YAML based configuration for setting eval +board specific dtsi files available in DTG repo. + +arm-trusted-firmware recipe from meta-xilinx-core: +ATF_CONSOLE_DEFAULT - Uart console configuration for all aarch64 device families. +Example: pl011 or cadence or cadence1 etc,. +TFA_BL33_LOAD - BL33 preloadded base address to EXTRA_OEMAKE for aarch64. u-boot-xlnx recipe from meta-xilinx-core: UBOOT_MACHINE - Name of the defconfig to use -HAS_PLATFORM_INIT - List of defconfig files available for u-boot +HAS_PLATFORM_INIT - List of defconfig files available for u-boot only for SPL boot. + +u-boot-xlnx-scr recipe from meta-xilinx-core: +DDR_BASEADDR - Base address for DDR used for loading the images from u-boot env. +SKIP_APPEND_BASEADDR - Skip appending ${DDR_BASEADDR} for image offsets. + +Varibable set after required inclusion file: +Varibables that does not intend to change must be set before required inclusion +file. + +external-hdf recipe from meta-xilinx-tools: +HDF_MACHINE - Used by the recipe to find the correct XSA +HDF_EXT - only xsa is supported, legacy variable +HDF_BASE - protocol if not using the default external-hdf repository +HDF_PATH - path to the repository or XSA file ...and more... -- cgit v1.2.3-54-g00ecf