granicus.if.org Git - esp-idf/blob - components/spi_flash/flash_mmap.c

   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 #include <stdlib.h>
  16 #include <assert.h>
  17 #include <string.h>
  18 #include <stdio.h>
  19
  20 #include <freertos/FreeRTOS.h>
  21 #include <freertos/task.h>
  22 #include <freertos/semphr.h>
  23 #include <rom/spi_flash.h>
  24 #include <rom/cache.h>
  25 #include <soc/soc.h>
  26 #include <soc/dport_reg.h>
  27 #include "sdkconfig.h"
  28 #include "esp_ipc.h"
  29 #include "esp_attr.h"
  30 #include "esp_spi_flash.h"
  31 #include "esp_flash_encrypt.h"
  32 #include "esp_log.h"
  33 #include "cache_utils.h"
  34 #include "esp_spiram.h"
  35
  36 #ifndef NDEBUG
  37 // Enable built-in checks in queue.h in debug builds
  38 #define INVARIANTS
  39 #endif
  40 #include "rom/queue.h"
  41
  42 #define REGIONS_COUNT 4
  43 #define PAGES_PER_REGION 64
  44 #define INVALID_ENTRY_VAL 0x100
  45 #define VADDR0_START_ADDR 0x3F400000
  46 #define VADDR1_START_ADDR 0x40000000
  47 #define VADDR1_FIRST_USABLE_ADDR 0x400D0000
  48 #define PRO_IRAM0_FIRST_USABLE_PAGE ((VADDR1_FIRST_USABLE_ADDR - VADDR1_START_ADDR) / SPI_FLASH_MMU_PAGE_SIZE + 64)
  49
  50 /* Ensure pages in a region haven't been marked as written via
  51    spi_flash_mark_modified_region(). If the page has
  52    been written, flush the entire flash cache before returning.
  53
  54    This ensures stale cache entries are never read after fresh calls
  55    to spi_flash_mmap(), while keeping the number of cache flushes to a
  56    minimum.
  57
  58    Returns true if cache was flushed.
  59 */
  60
  61 static bool spi_flash_ensure_unmodified_region(size_t start_addr, size_t length);
  62
  63 typedef struct mmap_entry_{
  64     uint32_t handle;
  65     int page;
  66     int count;
  67     LIST_ENTRY(mmap_entry_) entries;
  68 } mmap_entry_t;
  69
  70
  71 static LIST_HEAD(mmap_entries_head, mmap_entry_) s_mmap_entries_head =
  72         LIST_HEAD_INITIALIZER(s_mmap_entries_head);
  73 static uint8_t s_mmap_page_refcnt[REGIONS_COUNT * PAGES_PER_REGION] = {0};
  74 static uint32_t s_mmap_last_handle = 0;
  75
  76
  77 static void IRAM_ATTR spi_flash_mmap_init()
  78 {
  79     if (s_mmap_page_refcnt[0] != 0) {
  80         return; /* mmap data already initialised */
  81     }
  82     DPORT_INTERRUPT_DISABLE();
  83     for (int i = 0; i < REGIONS_COUNT * PAGES_PER_REGION; ++i) {
  84         uint32_t entry_pro = DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[i]);
  85         uint32_t entry_app = DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_APP_FLASH_MMU_TABLE[i]);
  86
  87         if (entry_pro != entry_app) {
  88             // clean up entries used by boot loader
  89             entry_pro = DPORT_FLASH_MMU_TABLE_INVALID_VAL;
  90             DPORT_PRO_FLASH_MMU_TABLE[i] = DPORT_FLASH_MMU_TABLE_INVALID_VAL;
  91         }
  92         if ((entry_pro & INVALID_ENTRY_VAL) == 0 && (i == 0 || i == PRO_IRAM0_FIRST_USABLE_PAGE || entry_pro != 0)) {
  93             s_mmap_page_refcnt[i] = 1;
  94         } else {
  95             DPORT_PRO_FLASH_MMU_TABLE[i] = DPORT_FLASH_MMU_TABLE_INVALID_VAL;
  96             DPORT_APP_FLASH_MMU_TABLE[i] = DPORT_FLASH_MMU_TABLE_INVALID_VAL;
  97         }
  98     }
  99     DPORT_INTERRUPT_RESTORE();
 100 }
 101
 102 static void IRAM_ATTR get_mmu_region(spi_flash_mmap_memory_t memory, int* out_begin, int* out_size,uint32_t* region_addr)
 103 {
 104     if (memory == SPI_FLASH_MMAP_DATA) {
 105         // Vaddr0
 106         *out_begin = 0;
 107         *out_size = 64;
 108         *region_addr = VADDR0_START_ADDR;
 109     } else {
 110         // only part of VAddr1 is usable, so adjust for that
 111         *out_begin = PRO_IRAM0_FIRST_USABLE_PAGE;
 112         *out_size = 3 * 64 - *out_begin;
 113         *region_addr = VADDR1_FIRST_USABLE_ADDR;
 114     }
 115 }
 116
 117 esp_err_t IRAM_ATTR spi_flash_mmap(size_t src_addr, size_t size, spi_flash_mmap_memory_t memory,
 118                          const void** out_ptr, spi_flash_mmap_handle_t* out_handle)
 119 {
 120     esp_err_t ret;
 121     if (src_addr & 0xffff) {
 122         return ESP_ERR_INVALID_ARG;
 123     }
 124     if (src_addr + size > g_rom_flashchip.chip_size) {
 125         return ESP_ERR_INVALID_ARG;
 126     }
 127     // region which should be mapped
 128     int phys_page = src_addr / SPI_FLASH_MMU_PAGE_SIZE;
 129     int page_count = (size + SPI_FLASH_MMU_PAGE_SIZE - 1) / SPI_FLASH_MMU_PAGE_SIZE;
 130     //prepare a linear pages array to feed into spi_flash_mmap_pages
 131     int *pages=malloc(sizeof(int)*page_count);
 132     if (pages==NULL) {
 133         return ESP_ERR_NO_MEM;
 134     }
 135     for (int i = 0; i < page_count; i++) {
 136         pages[i] = phys_page+i;
 137     }
 138     ret=spi_flash_mmap_pages(pages, page_count, memory, out_ptr, out_handle);
 139     free(pages);
 140     return ret;
 141 }
 142
 143 esp_err_t IRAM_ATTR spi_flash_mmap_pages(int *pages, size_t page_count, spi_flash_mmap_memory_t memory,
 144                          const void** out_ptr, spi_flash_mmap_handle_t* out_handle)
 145 {
 146     esp_err_t ret;
 147     bool did_flush, need_flush = false;
 148     if (!page_count) {
 149         return ESP_ERR_INVALID_ARG;
 150     }
 151     for (int i = 0; i < page_count; i++) {
 152         if (pages[i] < 0 || pages[i]*SPI_FLASH_MMU_PAGE_SIZE >= g_rom_flashchip.chip_size) {
 153             return ESP_ERR_INVALID_ARG;
 154         }
 155     }
 156     mmap_entry_t* new_entry = (mmap_entry_t*) heap_caps_malloc(sizeof(mmap_entry_t), MALLOC_CAP_INTERNAL|MALLOC_CAP_8BIT);
 157     if (new_entry == 0) {
 158         return ESP_ERR_NO_MEM;
 159     }
 160
 161     spi_flash_disable_interrupts_caches_and_other_cpu();
 162
 163     did_flush = 0;
 164     for (int i = 0; i < page_count; i++) {
 165         if (spi_flash_ensure_unmodified_region(pages[i]*SPI_FLASH_MMU_PAGE_SIZE, SPI_FLASH_MMU_PAGE_SIZE)) {
 166             did_flush = 1;
 167         }
 168     }
 169     spi_flash_mmap_init();
 170     // figure out the memory region where we should look for pages
 171     int region_begin;   // first page to check
 172     int region_size;    // number of pages to check
 173     uint32_t region_addr;  // base address of memory region
 174     get_mmu_region(memory,&region_begin,&region_size,&region_addr);
 175     if (region_size < page_count) {
 176         return ESP_ERR_NO_MEM;
 177     }
 178     // The following part searches for a range of MMU entries which can be used.
 179     // Algorithm is essentially naïve strstr algorithm, except that unused MMU
 180     // entries are treated as wildcards.
 181     int start;
 182     // the " + 1" is a fix when loop the MMU table pages, because the last MMU page
 183     // is valid as well if it have not been used
 184     int end = region_begin + region_size - page_count + 1;
 185     for (start = region_begin; start < end; ++start) {
 186         int pageno = 0;
 187         int pos;
 188         DPORT_INTERRUPT_DISABLE();
 189         for (pos = start; pos < start + page_count; ++pos, ++pageno) {
 190             int table_val = (int) DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[pos]);
 191             uint8_t refcnt = s_mmap_page_refcnt[pos];
 192             if (refcnt != 0 && table_val != pages[pageno]) {
 193                 break;
 194             }
 195         }
 196         DPORT_INTERRUPT_RESTORE();
 197         // whole mapping range matched, bail out
 198         if (pos - start == page_count) {
 199             break;
 200         }
 201     }
 202     // checked all the region(s) and haven't found anything?
 203     if (start == end) {
 204         *out_handle = 0;
 205         *out_ptr = NULL;
 206         ret = ESP_ERR_NO_MEM;
 207     } else {
 208         // set up mapping using pages
 209         uint32_t pageno = 0;
 210         DPORT_INTERRUPT_DISABLE();
 211         for (int i = start; i != start + page_count; ++i, ++pageno) {
 212             // sanity check: we won't reconfigure entries with non-zero reference count
 213             uint32_t entry_pro = DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[i]);
 214             uint32_t entry_app = DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_APP_FLASH_MMU_TABLE[i]);
 215             assert(s_mmap_page_refcnt[i] == 0 ||
 216                     (entry_pro == pages[pageno] &&
 217                      entry_app == pages[pageno]));
 218             if (s_mmap_page_refcnt[i] == 0) {
 219                 if (entry_pro != pages[pageno] || entry_app != pages[pageno]) {
 220                     DPORT_PRO_FLASH_MMU_TABLE[i] = pages[pageno];
 221                     DPORT_APP_FLASH_MMU_TABLE[i] = pages[pageno];
 222                     need_flush = true;
 223                 }
 224             }
 225             ++s_mmap_page_refcnt[i];
 226         }
 227         DPORT_INTERRUPT_RESTORE();
 228         LIST_INSERT_HEAD(&s_mmap_entries_head, new_entry, entries);
 229         new_entry->page = start;
 230         new_entry->count = page_count;
 231         new_entry->handle = ++s_mmap_last_handle;
 232         *out_handle = new_entry->handle;
 233         *out_ptr = (void*) (region_addr + (start - region_begin) * SPI_FLASH_MMU_PAGE_SIZE);
 234         ret = ESP_OK;
 235     }
 236
 237     /* This is a temporary fix for an issue where some
 238        cache reads may see stale data.
 239
 240        Working on a long term fix that doesn't require invalidating
 241        entire cache.
 242     */
 243     if (!did_flush && need_flush) {
 244 #if CONFIG_SPIRAM_SUPPORT
 245         esp_spiram_writeback_cache();
 246 #endif
 247         Cache_Flush(0);
 248         Cache_Flush(1);
 249     }
 250
 251     spi_flash_enable_interrupts_caches_and_other_cpu();
 252     if (*out_ptr == NULL) {
 253         free(new_entry);
 254     }
 255     return ret;
 256 }
 257
 258 void IRAM_ATTR spi_flash_munmap(spi_flash_mmap_handle_t handle)
 259 {
 260     spi_flash_disable_interrupts_caches_and_other_cpu();
 261     mmap_entry_t* it;
 262     // look for handle in linked list
 263     for (it = LIST_FIRST(&s_mmap_entries_head); it != NULL; it = LIST_NEXT(it, entries)) {
 264         if (it->handle == handle) {
 265             // for each page, decrement reference counter
 266             // if reference count is zero, disable MMU table entry to
 267             // facilitate debugging of use-after-free conditions
 268             for (int i = it->page; i < it->page + it->count; ++i) {
 269                 assert(s_mmap_page_refcnt[i] > 0);
 270                 if (--s_mmap_page_refcnt[i] == 0) {
 271                     DPORT_PRO_FLASH_MMU_TABLE[i] = INVALID_ENTRY_VAL;
 272                     DPORT_APP_FLASH_MMU_TABLE[i] = INVALID_ENTRY_VAL;
 273                 }
 274             }
 275             LIST_REMOVE(it, entries);
 276             break;
 277         }
 278     }
 279     spi_flash_enable_interrupts_caches_and_other_cpu();
 280     if (it == NULL) {
 281         assert(0 && "invalid handle, or handle already unmapped");
 282     }
 283     free(it);
 284 }
 285
 286 void spi_flash_mmap_dump()
 287 {
 288     spi_flash_mmap_init();
 289     mmap_entry_t* it;
 290     for (it = LIST_FIRST(&s_mmap_entries_head); it != NULL; it = LIST_NEXT(it, entries)) {
 291         printf("handle=%d page=%d count=%d\n", it->handle, it->page, it->count);
 292     }
 293     for (int i = 0; i < REGIONS_COUNT * PAGES_PER_REGION; ++i) {
 294         if (s_mmap_page_refcnt[i] != 0) {
 295             printf("page %d: refcnt=%d paddr=%d\n",
 296                     i, (int) s_mmap_page_refcnt[i], DPORT_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[i]));
 297         }
 298     }
 299 }
 300
 301 uint32_t spi_flash_mmap_get_free_pages(spi_flash_mmap_memory_t memory)
 302 {
 303     spi_flash_mmap_init();
 304     int count = 0;
 305     int region_begin;   // first page to check
 306     int region_size;    // number of pages to check
 307     uint32_t region_addr;  // base address of memory region
 308     get_mmu_region(memory,&region_begin,&region_size,&region_addr);
 309     DPORT_INTERRUPT_DISABLE();
 310     for (int i = region_begin; i < region_begin + region_size; ++i) {
 311         if (s_mmap_page_refcnt[i] == 0 && DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[i]) == INVALID_ENTRY_VAL) {
 312             count++;
 313         }
 314     }
 315    DPORT_INTERRUPT_RESTORE();
 316     return count;
 317 }
 318
 319 /* 256-bit (up to 16MB of 64KB pages) bitset of all flash pages
 320    that have been written to since last cache flush.
 321
 322    Before mmaping a page, need to flush caches if that page has been
 323    written to.
 324
 325    Note: It's possible to do some additional performance tweaks to
 326    this algorithm, as we actually only need to flush caches if a page
 327    was first mmapped, then written to, then is about to be mmaped a
 328    second time. This is a fair bit more complex though, so unless
 329    there's an access pattern that this would significantly boost then
 330    it's probably not worth it.
 331 */
 332 static uint32_t written_pages[256/32];
 333
 334 static bool update_written_pages(size_t start_addr, size_t length, bool mark);
 335
 336 void IRAM_ATTR spi_flash_mark_modified_region(size_t start_addr, size_t length)
 337 {
 338     update_written_pages(start_addr, length, true);
 339 }
 340
 341 static IRAM_ATTR bool spi_flash_ensure_unmodified_region(size_t start_addr, size_t length)
 342 {
 343     return update_written_pages(start_addr, length, false);
 344 }
 345
 346 /* generic implementation for the previous two functions */
 347 static inline IRAM_ATTR bool update_written_pages(size_t start_addr, size_t length, bool mark)
 348 {
 349     /* align start_addr & length to full MMU pages */
 350     uint32_t page_start_addr = start_addr & ~(SPI_FLASH_MMU_PAGE_SIZE-1);
 351     length += (start_addr - page_start_addr);
 352     length = (length + SPI_FLASH_MMU_PAGE_SIZE - 1) & ~(SPI_FLASH_MMU_PAGE_SIZE-1);
 353     for (uint32_t addr = page_start_addr; addr < page_start_addr + length; addr += SPI_FLASH_MMU_PAGE_SIZE) {
 354         int page = addr / SPI_FLASH_MMU_PAGE_SIZE;
 355         if (page >= 256) {
 356             return false; /* invalid address */
 357         }
 358
 359         int idx = page / 32;
 360         uint32_t bit = 1 << (page % 32);
 361
 362         if (mark) {
 363             written_pages[idx] |= bit;
 364         } else if (written_pages[idx] & bit) {
 365             /* it is tempting to write a version of this that only
 366                flushes each CPU's cache as needed. However this is
 367                tricky because mmaped memory can be used on un-pinned
 368                cores, or the pointer passed between CPUs.
 369             */
 370 #if CONFIG_SPIRAM_SUPPORT
 371             esp_spiram_writeback_cache();
 372 #endif
 373             Cache_Flush(0);
 374 #ifndef CONFIG_FREERTOS_UNICORE
 375             Cache_Flush(1);
 376 #endif
 377             bzero(written_pages, sizeof(written_pages));
 378             return true;
 379         }
 380     }
 381     return false;
 382 }
 383
 384
 385 uint32_t spi_flash_cache2phys(const void *cached)
 386 {
 387     intptr_t c = (intptr_t)cached;
 388     size_t cache_page;
 389     if (c >= VADDR1_START_ADDR && c < VADDR1_FIRST_USABLE_ADDR) {
 390         /* IRAM address, doesn't map to flash */
 391         return SPI_FLASH_CACHE2PHYS_FAIL;
 392     }
 393     else if (c < VADDR1_FIRST_USABLE_ADDR) {
 394         /* expect cache is in DROM */
 395         cache_page = (c - VADDR0_START_ADDR) / SPI_FLASH_MMU_PAGE_SIZE;
 396     } else {
 397         /* expect cache is in IROM */
 398         cache_page = (c - VADDR1_START_ADDR) / SPI_FLASH_MMU_PAGE_SIZE + 64;
 399     }
 400
 401     if (cache_page >= 256) {
 402         /* cached address was not in IROM or DROM */
 403         return SPI_FLASH_CACHE2PHYS_FAIL;
 404     }
 405     uint32_t phys_page = DPORT_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[cache_page]);
 406     if (phys_page == INVALID_ENTRY_VAL) {
 407         /* page is not mapped */
 408         return SPI_FLASH_CACHE2PHYS_FAIL;
 409     }
 410     uint32_t phys_offs = phys_page * SPI_FLASH_MMU_PAGE_SIZE;
 411     return phys_offs | (c & (SPI_FLASH_MMU_PAGE_SIZE-1));
 412 }
 413
 414
 415 const void *spi_flash_phys2cache(uint32_t phys_offs, spi_flash_mmap_memory_t memory)
 416 {
 417     uint32_t phys_page = phys_offs / SPI_FLASH_MMU_PAGE_SIZE;
 418     int start, end, page_delta;
 419     intptr_t base;
 420
 421     if (memory == SPI_FLASH_MMAP_DATA) {
 422         start = 0;
 423         end = 64;
 424         base = VADDR0_START_ADDR;
 425         page_delta = 0;
 426     } else {
 427         start = PRO_IRAM0_FIRST_USABLE_PAGE;
 428         end = 256;
 429         base = VADDR1_START_ADDR;
 430         page_delta = 64;
 431     }
 432     DPORT_INTERRUPT_DISABLE();
 433     for (int i = start; i < end; i++) {
 434         if (DPORT_SEQUENCE_REG_READ((uint32_t)&DPORT_PRO_FLASH_MMU_TABLE[i]) == phys_page) {
 435             i -= page_delta;
 436             intptr_t cache_page =  base + (SPI_FLASH_MMU_PAGE_SIZE * i);
 437             DPORT_INTERRUPT_RESTORE();
 438             return (const void *) (cache_page | (phys_offs & (SPI_FLASH_MMU_PAGE_SIZE-1)));
 439         }
 440     }
 441     DPORT_INTERRUPT_RESTORE();
 442     return NULL;
 443 }