Function esp_idf_svc::sys::esp_ota_get_bootloader_description

source ยท 
pub unsafe extern "C" fn esp_ota_get_bootloader_description(
    bootloader_partition: *const esp_partition_t,
    desc: *mut esp_bootloader_desc_t,
) -> i32
Expand description

@brief Returns the description structure of the bootloader.

@param[in] bootloader_partition Pointer to bootloader partition. If NULL, then the current bootloader is used (the default location). offset = CONFIG_BOOTLOADER_OFFSET_IN_FLASH, size = CONFIG_PARTITION_TABLE_OFFSET - CONFIG_BOOTLOADER_OFFSET_IN_FLASH, @param[out] desc Structure of info about bootloader. @return

  • ESP_OK Successful.
  • ESP_ERR_NOT_FOUND Description structure is not found in the bootloader image. Magic byte is incorrect.
  • ESP_ERR_INVALID_ARG Arguments is NULL.
  • ESP_ERR_INVALID_SIZE Read would go out of bounds of the partition.
  • or one of error codes from lower-level flash driver.