docs: Improve/clarify partition, OTA & SPI flash docs

Related to #313 https://github.com/espressif/esp-idf/issues/313
This commit is contained in:
Angus Gratton
2017-02-17 12:43:55 +11:00
parent 4494e15ecf
commit 1f3a2e900c
11 changed files with 340 additions and 187 deletions

View File

@@ -106,14 +106,13 @@ void IRAM_ATTR call_start_cpu0()
}
/**
* @function : load_partition_table
* @description: Parse partition table, get useful data such as location of
* OTA info sector, factory app sector, and test app sector.
/** @brief Load partition table
*
* @inputs: bs bootloader state structure used to save the data
* @return: return true, if the partition table is loaded (and MD5 checksum is valid)
* Parse partition table, get useful data such as location of
* OTA data partition, factory app partition, and test app partition.
*
* @param bs bootloader state structure used to save read data
* @return return true if the partition table was succesfully loaded and MD5 checksum is valid.
*/
bool load_partition_table(bootloader_state_t* bs)
{