granicus.if.org Git - esp-idf/blob - components/spi_flash/include/esp_partition.h

   1 // Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 #ifndef __ESP_PARTITION_H__
  16 #define __ESP_PARTITION_H__
  17
  18 #include <stdint.h>
  19 #include <stdbool.h>
  20 #include <stddef.h>
  21 #include "esp_err.h"
  22 #include "esp_spi_flash.h"
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * @file esp_partition.h
  30  * @brief Partition APIs
  31  */
  32
  33
  34 /**
  35  * @brief Partition type
  36  * @note Keep this enum in sync with PartitionDefinition class gen_esp32part.py
  37  */
  38 typedef enum {
  39     ESP_PARTITION_TYPE_APP = 0x00,       //!< Application partition type
  40     ESP_PARTITION_TYPE_DATA = 0x01,      //!< Data partition type
  41 } esp_partition_type_t;
  42
  43 /**
  44  * @brief Partition subtype
  45  * @note Keep this enum in sync with PartitionDefinition class gen_esp32part.py
  46  */
  47 typedef enum {
  48     ESP_PARTITION_SUBTYPE_APP_FACTORY = 0x00,                                 //!< Factory application partition
  49     ESP_PARTITION_SUBTYPE_APP_OTA_MIN = 0x10,                                 //!< Base for OTA partition subtypes
  50     ESP_PARTITION_SUBTYPE_APP_OTA_0 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 0,  //!< OTA partition 0
  51     ESP_PARTITION_SUBTYPE_APP_OTA_1 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 1,  //!< OTA partition 1
  52     ESP_PARTITION_SUBTYPE_APP_OTA_2 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 2,  //!< OTA partition 2
  53     ESP_PARTITION_SUBTYPE_APP_OTA_3 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 3,  //!< OTA partition 3
  54     ESP_PARTITION_SUBTYPE_APP_OTA_4 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 4,  //!< OTA partition 4
  55     ESP_PARTITION_SUBTYPE_APP_OTA_5 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 5,  //!< OTA partition 5
  56     ESP_PARTITION_SUBTYPE_APP_OTA_6 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 6,  //!< OTA partition 6
  57     ESP_PARTITION_SUBTYPE_APP_OTA_7 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 7,  //!< OTA partition 7
  58     ESP_PARTITION_SUBTYPE_APP_OTA_8 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 8,  //!< OTA partition 8
  59     ESP_PARTITION_SUBTYPE_APP_OTA_9 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 9,  //!< OTA partition 9
  60     ESP_PARTITION_SUBTYPE_APP_OTA_10 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 10,//!< OTA partition 10
  61     ESP_PARTITION_SUBTYPE_APP_OTA_11 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 11,//!< OTA partition 11
  62     ESP_PARTITION_SUBTYPE_APP_OTA_12 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 12,//!< OTA partition 12
  63     ESP_PARTITION_SUBTYPE_APP_OTA_13 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 13,//!< OTA partition 13
  64     ESP_PARTITION_SUBTYPE_APP_OTA_14 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 14,//!< OTA partition 14
  65     ESP_PARTITION_SUBTYPE_APP_OTA_15 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 15,//!< OTA partition 15
  66     ESP_PARTITION_SUBTYPE_APP_OTA_MAX = 15,                                   //!< Max subtype of OTA partition
  67     ESP_PARTITION_SUBTYPE_APP_TEST = 0x20,                                    //!< Test application partition
  68
  69     ESP_PARTITION_SUBTYPE_DATA_OTA = 0x00,                                    //!< OTA selection partition
  70     ESP_PARTITION_SUBTYPE_DATA_PHY = 0x01,                                    //!< PHY init data partition
  71     ESP_PARTITION_SUBTYPE_DATA_NVS = 0x02,                                    //!< NVS partition
  72
  73     ESP_PARTITION_SUBTYPE_DATA_ESPHTTPD = 0x80,                               //!< ESPHTTPD partition
  74     ESP_PARTITION_SUBTYPE_DATA_FAT = 0x81,                                    //!< FAT partition
  75     ESP_PARTITION_SUBTYPE_DATA_SPIFFS = 0x82,                                 //!< SPIFFS partition
  76
  77     ESP_PARTITION_SUBTYPE_ANY = 0xff,                                         //!< Used to search for partitions with any subtype
  78 } esp_partition_subtype_t;
  79
  80 /**
  81  * @brief Convenience macro to get esp_partition_subtype_t value for the i-th OTA partition
  82  */
  83 #define ESP_PARTITION_SUBTYPE_OTA(i) ((esp_partition_subtype_t)(ESP_PARTITION_SUBTYPE_APP_OTA_MIN + ((i) & 0xf)))
  84
  85 /**
  86  * @brief Opaque partition iterator type
  87  */
  88 typedef struct esp_partition_iterator_opaque_* esp_partition_iterator_t;
  89
  90 /**
  91  * @brief partition information structure
  92  */
  93 typedef struct {
  94     esp_partition_type_t type;          /*!< partition type (app/data) */
  95     esp_partition_subtype_t subtype;    /*!< partition subtype */
  96     uint32_t address;                   /*!< starting address of the partition in flash */
  97     uint32_t size;                      /*!< size of the partition, in bytes */
  98     char label[17];                     /*!< partition label, zero-terminated ASCII string */
  99     bool encrypted;                     /*!< flag is set to true if partition is encrypted */
 100 } esp_partition_t;
 101
 102 /**
 103  * @brief Find partition based on one or more parameters
 104  *
 105  * @param type Partition type, one of esp_partition_type_t values
 106  * @param subtype Partition subtype, one of esp_partition_subtype_t values.
 107  *                To find all partitions of given type, use
 108  *                ESP_PARTITION_SUBTYPE_ANY.
 109  * @param label (optional) Partition label. Set this value if looking
 110  *             for partition with a specific name. Pass NULL otherwise.
 111  *
 112  * @return iterator which can be used to enumerate all the partitions found,
 113  *         or NULL if no partitions were found.
 114  *         Iterator obtained through this function has to be released
 115  *         using esp_partition_iterator_release when not used any more.
 116  */
 117 esp_partition_iterator_t esp_partition_find(esp_partition_type_t type, esp_partition_subtype_t subtype, const char* label);
 118
 119 /**
 120  * @brief Find first partition based on one or more parameters
 121  *
 122  * @param type Partition type, one of esp_partition_type_t values
 123  * @param subtype Partition subtype, one of esp_partition_subtype_t values.
 124  *                To find all partitions of given type, use
 125  *                ESP_PARTITION_SUBTYPE_ANY.
 126  * @param label (optional) Partition label. Set this value if looking
 127  *             for partition with a specific name. Pass NULL otherwise.
 128  *
 129  * @return pointer to esp_partition_t structure, or NULL if no partition is found.
 130  *         This pointer is valid for the lifetime of the application.
 131  */
 132 const esp_partition_t* esp_partition_find_first(esp_partition_type_t type, esp_partition_subtype_t subtype, const char* label);
 133
 134 /**
 135  * @brief Get esp_partition_t structure for given partition
 136  *
 137  * @param iterator  Iterator obtained using esp_partition_find. Must be non-NULL.
 138  *
 139  * @return pointer to esp_partition_t structure. This pointer is valid for the lifetime
 140  *         of the application.
 141  */
 142 const esp_partition_t* esp_partition_get(esp_partition_iterator_t iterator);
 143
 144 /**
 145  * @brief Move partition iterator to the next partition found
 146  *
 147  * Any copies of the iterator will be invalid after this call.
 148  *
 149  * @param iterator Iterator obtained using esp_partition_find. Must be non-NULL.
 150  *
 151  * @return NULL if no partition was found, valid esp_partition_iterator_t otherwise.
 152  */
 153 esp_partition_iterator_t esp_partition_next(esp_partition_iterator_t iterator);
 154
 155 /**
 156  * @brief Release partition iterator
 157  *
 158  * @param iterator Iterator obtained using esp_partition_find. Must be non-NULL.
 159  *
 160  */
 161 void esp_partition_iterator_release(esp_partition_iterator_t iterator);
 162
 163 /**
 164  * @brief Read data from the partition
 165  *
 166  * @param partition Pointer to partition structure obtained using
 167  *                  esp_partition_find_first or esp_partition_get.
 168  *                  Must be non-NULL.
 169  * @param dst Pointer to the buffer where data should be stored.
 170  *            Pointer must be non-NULL and buffer must be at least 'size' bytes long.
 171  * @param src_offset Address of the data to be read, relative to the
 172  *                   beginning of the partition.
 173  * @param size Size of data to be read, in bytes.
 174  *
 175  * @return ESP_OK, if data was read successfully;
 176  *         ESP_ERR_INVALID_ARG, if src_offset exceeds partition size;
 177  *         ESP_ERR_INVALID_SIZE, if read would go out of bounds of the partition;
 178  *         or one of error codes from lower-level flash driver.
 179  */
 180 esp_err_t esp_partition_read(const esp_partition_t* partition,
 181                              size_t src_offset, void* dst, size_t size);
 182
 183 /**
 184  * @brief Write data to the partition
 185  *
 186  * Before writing data to flash, corresponding region of flash needs to be erased.
 187  * This can be done using esp_partition_erase_range function.
 188  *
 189  * @param partition Pointer to partition structure obtained using
 190  *                  esp_partition_find_first or esp_partition_get.
 191  *                  Must be non-NULL.
 192  * @param dst_offset Address where the data should be written, relative to the
 193  *                   beginning of the partition.
 194  * @param src Pointer to the source buffer.  Pointer must be non-NULL and
 195  *            buffer must be at least 'size' bytes long.
 196  * @param size Size of data to be written, in bytes.
 197  *
 198  * @note Prior to writing to flash memory, make sure it has been erased with
 199  *       esp_partition_erase_range call.
 200  *
 201  * @return ESP_OK, if data was written successfully;
 202  *         ESP_ERR_INVALID_ARG, if dst_offset exceeds partition size;
 203  *         ESP_ERR_INVALID_SIZE, if write would go out of bounds of the partition;
 204  *         or one of error codes from lower-level flash driver.
 205  */
 206 esp_err_t esp_partition_write(const esp_partition_t* partition,
 207                              size_t dst_offset, const void* src, size_t size);
 208
 209 /**
 210  * @brief Erase part of the partition
 211  *
 212  * @param partition Pointer to partition structure obtained using
 213  *                  esp_partition_find_first or esp_partition_get.
 214  *                  Must be non-NULL.
 215  * @param start_addr Address where erase operation should start. Must be aligned
 216  *                   to 4 kilobytes.
 217  * @param size Size of the range which should be erased, in bytes.
 218  *                   Must be divisible by 4 kilobytes.
 219  *
 220  * @return ESP_OK, if the range was erased successfully;
 221  *         ESP_ERR_INVALID_ARG, if iterator or dst are NULL;
 222  *         ESP_ERR_INVALID_SIZE, if erase would go out of bounds of the partition;
 223  *         or one of error codes from lower-level flash driver.
 224  */
 225 esp_err_t esp_partition_erase_range(const esp_partition_t* partition,
 226                                     uint32_t start_addr, uint32_t size);
 227
 228 /**
 229  * @brief Configure MMU to map partition into data memory
 230  *
 231  * Unlike spi_flash_mmap function, which requires a 64kB aligned base address,
 232  * this function doesn't impose such a requirement.
 233  * If offset results in a flash address which is not aligned to 64kB boundary,
 234  * address will be rounded to the lower 64kB boundary, so that mapped region
 235  * includes requested range.
 236  * Pointer returned via out_ptr argument will be adjusted to point to the
 237  * requested offset (not necessarily to the beginning of mmap-ed region).
 238  *
 239  * To release mapped memory, pass handle returned via out_handle argument to
 240  * spi_flash_munmap function.
 241  *
 242  * @param partition Pointer to partition structure obtained using
 243  *                  esp_partition_find_first or esp_partition_get.
 244  *                  Must be non-NULL.
 245  * @param offset Offset from the beginning of partition where mapping should start.
 246  * @param size Size of the area to be mapped.
 247  * @param memory  Memory space where the region should be mapped
 248  * @param out_ptr  Output, pointer to the mapped memory region
 249  * @param out_handle  Output, handle which should be used for spi_flash_munmap call
 250  *
 251  * @return ESP_OK, if successful
 252  */
 253 esp_err_t esp_partition_mmap(const esp_partition_t* partition, uint32_t offset, uint32_t size,
 254                              spi_flash_mmap_memory_t memory,
 255                              const void** out_ptr, spi_flash_mmap_handle_t* out_handle);
 256
 257
 258 #ifdef __cplusplus
 259 }
 260 #endif
 261
 262
 263 #endif /* __ESP_PARTITION_H__ */