esp-idf/components/esp_app_format/Kconfig.projbuild

menu "Application manager"

    config APP_COMPILE_TIME_DATE
        bool "Use time/date stamp for app"
        default y
        depends on !APP_REPRODUCIBLE_BUILD
        help
            If set, then the app will be built with the current time/date stamp. It is stored in the app description
            structure. If not set, time/date stamp will be excluded from app image. This can be useful for getting the
            same binary image files made from the same source, but at different times.

    config APP_EXCLUDE_PROJECT_VER_VAR
        bool "Exclude PROJECT_VER from firmware image"
        default n
        help
            The PROJECT_VER variable from the build system will not affect the firmware image.
            This value will not be contained in the esp_app_desc structure.

    config APP_EXCLUDE_PROJECT_NAME_VAR
        bool "Exclude PROJECT_NAME from firmware image"
        default n
        help
            The PROJECT_NAME variable from the build system will not affect the firmware image.
            This value will not be contained in the esp_app_desc structure.

    config APP_PROJECT_VER_FROM_CONFIG
        bool "Get the project version from Kconfig"
        default n
        help
            If this is enabled, then config item APP_PROJECT_VER will be used for the variable PROJECT_VER.
            Other ways to set PROJECT_VER will be ignored.

    config APP_PROJECT_VER
        string "Project version"
        default "1"
        depends on APP_PROJECT_VER_FROM_CONFIG
        help
            Project version

    config APP_RETRIEVE_LEN_ELF_SHA
        int "The length of APP ELF SHA is stored in RAM(chars)"
        default 9
        range 8 64
        help
            At startup, the app will read the embedded APP ELF SHA-256 hash value from flash
            and convert it into a string and store it in a RAM buffer.
            This ensures the panic handler and core dump will be able to print this string
            even when cache is disabled.
            The size of the buffer is APP_RETRIEVE_LEN_ELF_SHA plus the null terminator.
            Changing this value will change the size of this buffer, in bytes.

endmenu # "Application manager"
esp32: Add firmware version to app Added a new structure esp_app_desc_t. It has info about firmware: version, secure_version, project_name, time/date build and IDF version. Added the ability to add a custom structure with a description of the firmware. The esp_app_desc_t is located in fixed place in start of ROM secotor. It is located after structures esp_image_header_t and esp_image_segment_header_t. app_version is filed from PROJECT_VER variable (if set in custom make file) or PROJECT_PATH/version.txt or git repo (git describe). Add API to get app_desc from partition. 2018-10-05 08:29:07 -04:00			`menu "Application manager"`

Correct Kconfigs according to the coding style 2019-01-25 11:10:53 -05:00			`config APP_COMPILE_TIME_DATE`
			`bool "Use time/date stamp for app"`
			`default y`
esp_bootloader_format: Adds bootloader description structure to read bootloader version from app Closes https://github.com/espressif/esp-idf/issues/8800 Closes https://github.com/espressif/esp-idf/issues/9132 2022-12-13 12:16:56 -05:00			`depends on !APP_REPRODUCIBLE_BUILD`
Correct Kconfigs according to the coding style 2019-01-25 11:10:53 -05:00			`help`
			`If set, then the app will be built with the current time/date stamp. It is stored in the app description`
			`structure. If not set, time/date stamp will be excluded from app image. This can be useful for getting the`
			`same binary image files made from the same source, but at different times.`
esp32: Add firmware version to app Added a new structure esp_app_desc_t. It has info about firmware: version, secure_version, project_name, time/date build and IDF version. Added the ability to add a custom structure with a description of the firmware. The esp_app_desc_t is located in fixed place in start of ROM secotor. It is located after structures esp_image_header_t and esp_image_segment_header_t. app_version is filed from PROJECT_VER variable (if set in custom make file) or PROJECT_PATH/version.txt or git repo (git describe). Add API to get app_desc from partition. 2018-10-05 08:29:07 -04:00
Correct Kconfigs according to the coding style 2019-01-25 11:10:53 -05:00			`config APP_EXCLUDE_PROJECT_VER_VAR`
			`bool "Exclude PROJECT_VER from firmware image"`
			`default n`
			`help`
			`The PROJECT_VER variable from the build system will not affect the firmware image.`
			`This value will not be contained in the esp_app_desc structure.`
app_update: Add EXCLUDE option Added two options for PROJECT_NAME and PROJECT_VER variables to exclude them from the firmware image. Closes: https://github.com/espressif/esp-idf/issues/2803 2018-12-13 02:45:27 -05:00
Correct Kconfigs according to the coding style 2019-01-25 11:10:53 -05:00			`config APP_EXCLUDE_PROJECT_NAME_VAR`
			`bool "Exclude PROJECT_NAME from firmware image"`
			`default n`
			`help`
			`The PROJECT_NAME variable from the build system will not affect the firmware image.`
			`This value will not be contained in the esp_app_desc structure.`
app_update: Add EXCLUDE option Added two options for PROJECT_NAME and PROJECT_VER variables to exclude them from the firmware image. Closes: https://github.com/espressif/esp-idf/issues/2803 2018-12-13 02:45:27 -05:00
build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig 2019-11-27 06:01:40 -05:00			`config APP_PROJECT_VER_FROM_CONFIG`
			`bool "Get the project version from Kconfig"`
			`default n`
			`help`
			`If this is enabled, then config item APP_PROJECT_VER will be used for the variable PROJECT_VER.`
			`Other ways to set PROJECT_VER will be ignored.`

			`config APP_PROJECT_VER`
			`string "Project version"`
			`default "1"`
			`depends on APP_PROJECT_VER_FROM_CONFIG`
			`help`
			`Project version`

app_update: Fix case when elf file SHA256 should be printed by panic handler while cache is disabled Closes: IDF-1342 2020-02-07 05:57:55 -05:00			`config APP_RETRIEVE_LEN_ELF_SHA`
			`int "The length of APP ELF SHA is stored in RAM(chars)"`
esp_app_format: IRAM space optimization 2023-05-04 05:14:46 -04:00			`default 9`
app_update: Fix case when elf file SHA256 should be printed by panic handler while cache is disabled Closes: IDF-1342 2020-02-07 05:57:55 -05:00			`range 8 64`
			`help`
esp_app_format: IRAM space optimization 2023-05-04 05:14:46 -04:00			`At startup, the app will read the embedded APP ELF SHA-256 hash value from flash`
			`and convert it into a string and store it in a RAM buffer.`
			`This ensures the panic handler and core dump will be able to print this string`
			`even when cache is disabled.`
			`The size of the buffer is APP_RETRIEVE_LEN_ELF_SHA plus the null terminator.`
			`Changing this value will change the size of this buffer, in bytes.`
app_update: Fix case when elf file SHA256 should be printed by panic handler while cache is disabled Closes: IDF-1342 2020-02-07 05:57:55 -05:00
Correct Kconfigs according to the coding style 2019-01-25 11:10:53 -05:00			`endmenu # "Application manager"`