|
| 1 | +/* |
| 2 | + * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD |
| 3 | + * |
| 4 | + * SPDX-License-Identifier: Apache-2.0 |
| 5 | + */ |
| 6 | +#pragma once |
| 7 | + |
| 8 | +#include "sdkconfig.h" |
| 9 | +#include "esp_assert.h" |
| 10 | +#include "esp_flash_partitions.h" |
| 11 | + |
| 12 | +#define MSPI_TIMING_MSPI1_IS_INVOLVED CONFIG_ESPTOOLPY_FLASHFREQ_120M //This means esp flash driver needs to be notified |
| 13 | +#define MSPI_TIMING_CONFIG_NUM_MAX 32 //This should be larger than the max available timing config num |
| 14 | +#define MSPI_TIMING_TEST_DATA_LEN 128 |
| 15 | +#define MSPI_TIMING_PSRAM_TEST_DATA_ADDR 0x100000 |
| 16 | + |
| 17 | +//--------------------------------------FLASH Sampling Mode --------------------------------------// |
| 18 | +#define MSPI_TIMING_FLASH_STR_MODE 1 |
| 19 | +//--------------------------------------FLASH Module Clock --------------------------------------// |
| 20 | +#if CONFIG_ESPTOOLPY_FLASHFREQ_20M |
| 21 | +#define MSPI_TIMING_FLASH_MODULE_CLOCK 20 |
| 22 | +#elif CONFIG_ESPTOOLPY_FLASHFREQ_40M |
| 23 | +#define MSPI_TIMING_FLASH_MODULE_CLOCK 40 |
| 24 | +#elif CONFIG_ESPTOOLPY_FLASHFREQ_80M |
| 25 | +#define MSPI_TIMING_FLASH_MODULE_CLOCK 80 |
| 26 | +#elif CONFIG_ESPTOOLPY_FLASHFREQ_120M |
| 27 | +#define MSPI_TIMING_FLASH_MODULE_CLOCK 120 |
| 28 | +#endif |
| 29 | +//------------------------------------FLASH Needs Tuning or not-------------------------------------// |
| 30 | +#define MSPI_TIMING_FLASH_NEEDS_TUNING 0 |
| 31 | + |
| 32 | +//--------------------------------------PSRAM Sampling Mode --------------------------------------// |
| 33 | +#define MSPI_TIMING_PSRAM_STR_MODE 1 |
| 34 | +//--------------------------------------PSRAM Module Clock --------------------------------------// |
| 35 | +#if CONFIG_SPIRAM |
| 36 | +#if CONFIG_SPIRAM_SPEED_40M |
| 37 | +#define MSPI_TIMING_PSRAM_MODULE_CLOCK 40 |
| 38 | +#elif CONFIG_SPIRAM_SPEED_80M |
| 39 | +#define MSPI_TIMING_PSRAM_MODULE_CLOCK 80 |
| 40 | +#endif |
| 41 | +#else //Disable PSRAM |
| 42 | +#define MSPI_TIMING_PSRAM_MODULE_CLOCK 10 //Define this to 10MHz |
| 43 | +#endif |
| 44 | +//------------------------------------PSRAM Needs Tuning or not-------------------------------------// |
| 45 | +#if MSPI_TIMING_PSRAM_STR_MODE |
| 46 | +#define MSPI_TIMING_PSRAM_NEEDS_TUNING (MSPI_TIMING_PSRAM_MODULE_CLOCK > 40) |
| 47 | +#endif |
| 48 | + |
| 49 | +///////////////////////////////////// FLASH/PSRAM CORE CLOCK ///////////////////////////////////// |
| 50 | +#if ((CONFIG_ESPTOOLPY_FLASHFREQ_80M && !CONFIG_SPIRAM) || (CONFIG_ESPTOOLPY_FLASHFREQ_80M && CONFIG_SPIRAM_SPEED_80M)) |
| 51 | +#define MSPI_TIMING_FLASH_EXPECTED_CORE_CLK_MHZ 80 |
| 52 | +#define MSPI_TIMING_PSRAM_EXPECTED_CORE_CLK_MHZ 80 |
| 53 | +#define MSPI_TIMING_FLASH_CONSECUTIVE_LEN_MAX 6 |
| 54 | +#else |
| 55 | +#define MSPI_TIMING_FLASH_EXPECTED_CORE_CLK_MHZ 240 |
| 56 | +#define MSPI_TIMING_PSRAM_EXPECTED_CORE_CLK_MHZ 240 |
| 57 | +#define MSPI_TIMING_FLASH_CONSECUTIVE_LEN_MAX 4 |
| 58 | +#endif |
| 59 | + |
| 60 | +//------------------------------------------Determine the Core Clock-----------------------------------------------// |
| 61 | +/** |
| 62 | + * @note |
| 63 | + * Limitation 1: |
| 64 | + * MSPI FLASH and PSRAM share the core clock register. Therefore, |
| 65 | + * the expected CORE CLOCK frequencies should be the same. |
| 66 | + */ |
| 67 | +#if MSPI_TIMING_FLASH_NEEDS_TUNING && MSPI_TIMING_PSRAM_NEEDS_TUNING |
| 68 | +ESP_STATIC_ASSERT(MSPI_TIMING_FLASH_EXPECTED_CORE_CLK_MHZ == MSPI_TIMING_PSRAM_EXPECTED_CORE_CLK_MHZ, "FLASH and PSRAM Mode configuration are not supported"); |
| 69 | +#define MSPI_TIMING_CORE_CLOCK_MHZ MSPI_TIMING_FLASH_EXPECTED_CORE_CLK_MHZ |
| 70 | + |
| 71 | +//If only FLASH needs tuning, the core clock COULD be as FLASH expected |
| 72 | +#elif MSPI_TIMING_FLASH_NEEDS_TUNING && !MSPI_TIMING_PSRAM_NEEDS_TUNING |
| 73 | +ESP_STATIC_ASSERT(MSPI_TIMING_FLASH_EXPECTED_CORE_CLK_MHZ % MSPI_TIMING_PSRAM_MODULE_CLOCK == 0, "FLASH and PSRAM Mode configuration are not supported"); |
| 74 | +#define MSPI_TIMING_CORE_CLOCK_MHZ MSPI_TIMING_FLASH_EXPECTED_CORE_CLK_MHZ |
| 75 | + |
| 76 | +//If only PSRAM needs tuning, the core clock COULD be as PSRAM expected |
| 77 | +#elif !MSPI_TIMING_FLASH_NEEDS_TUNING && MSPI_TIMING_PSRAM_NEEDS_TUNING |
| 78 | +ESP_STATIC_ASSERT(MSPI_TIMING_PSRAM_EXPECTED_CORE_CLK_MHZ % MSPI_TIMING_FLASH_MODULE_CLOCK == 0, "FLASH and PSRAM Mode configuration are not supported"); |
| 79 | +#define MSPI_TIMING_CORE_CLOCK_MHZ MSPI_TIMING_PSRAM_EXPECTED_CORE_CLK_MHZ |
| 80 | + |
| 81 | +#else |
| 82 | +#define MSPI_TIMING_CORE_CLOCK_MHZ 80 |
| 83 | +#endif |
| 84 | + |
| 85 | + |
| 86 | +//------------------------------------------Helper Macros to get FLASH/PSRAM tuning configs-----------------------------------------------// |
| 87 | +#define __GET_TUNING_CONFIG(type, core_clock, module_clock, mode) \ |
| 88 | + (mspi_timing_config_t) { .tuning_config_table = MSPI_TIMING_##type##_CONFIG_TABLE_CORE_CLK_##core_clock##M_MODULE_CLK_##module_clock##M_##mode, \ |
| 89 | + .available_config_num = MSPI_TIMING_##type##_CONFIG_NUM_CORE_CLK_##core_clock##M_MODULE_CLK_##module_clock##M_##mode, \ |
| 90 | + .default_config_id = MSPI_TIMING_##type##_DEFAULT_CONFIG_ID_CORE_CLK_##core_clock##M_MODULE_CLK_##module_clock##M_##mode } |
| 91 | + |
| 92 | +#define _GET_TUNING_CONFIG(type, core_clock, module_clock, mode) __GET_TUNING_CONFIG(type, core_clock, module_clock, mode) |
| 93 | + |
| 94 | +#define MSPI_TIMING_FLASH_GET_TUNING_CONFIG(core_clock_mhz, module_clock_mhz, mode) _GET_TUNING_CONFIG(FLASH, core_clock_mhz, module_clock_mhz, mode) |
| 95 | +#define MSPI_TIMING_PSRAM_GET_TUNING_CONFIG(core_clock_mhz, module_clock_mhz, mode) _GET_TUNING_CONFIG(PSRAM, core_clock_mhz, module_clock_mhz, mode) |
| 96 | + |
| 97 | + |
| 98 | +/** |
| 99 | + * Timing Tuning Parameters |
| 100 | + */ |
| 101 | +//FLASH: core clock 80M, module clock 80M, STR mode |
| 102 | +#define MSPI_TIMING_FLASH_CONFIG_TABLE_CORE_CLK_80M_MODULE_CLK_80M_STR_MODE {{2, 2, 1}, {2, 1, 1}, {2, 0, 1}, {0, 0, 0}, {3, 1, 2}, {2, 3, 2}, {2, 2, 2}, {2, 1, 2}, {2, 0, 2}, {0, 0, 1}, {3, 1, 3}, {2, 3, 3}, {2, 2, 3}, {2, 1, 3}} |
| 103 | +#define MSPI_TIMING_FLASH_CONFIG_NUM_CORE_CLK_80M_MODULE_CLK_80M_STR_MODE 14 |
| 104 | +#define MSPI_TIMING_FLASH_DEFAULT_CONFIG_ID_CORE_CLK_80M_MODULE_CLK_80M_STR_MODE 4 |
| 105 | + |
| 106 | +//PSRAM: core clock 240M, module clock 120M, STR mode |
| 107 | +#define MSPI_TIMING_PSRAM_CONFIG_TABLE_CORE_CLK_240M_MODULE_CLK_120M_STR_MODE {{2, 0, 1}, {0, 0, 0}, {2, 2, 2}, {2, 1, 2}, {2, 0, 2}, {0, 0, 1}, {2, 2, 3}, {2, 1, 3}, {2, 0, 3}, {0, 0, 2}, {2, 2, 4}, {2, 1, 4}} |
| 108 | +#define MSPI_TIMING_PSRAM_CONFIG_NUM_CORE_CLK_240M_MODULE_CLK_120M_STR_MODE 12 |
| 109 | +#define MSPI_TIMING_PSRAM_DEFAULT_CONFIG_ID_CORE_CLK_240M_MODULE_CLK_120M_STR_MODE 4 |
| 110 | + |
| 111 | +//PSRAM: core clock 240M, module clock 80M, STR mode |
| 112 | +#define MSPI_TIMING_PSRAM_CONFIG_TABLE_CORE_CLK_240M_MODULE_CLK_80M_STR_MODE {{2, 2, 1}, {2, 1, 1}, {2, 0, 1}, {0, 0, 0}, {3, 1, 2}, {2, 3, 2}, {2, 2, 2}, {2, 1, 2}, {2, 0, 2}, {0, 0, 1}, {3, 1, 3}, {2, 3, 3}, {2, 2, 3}, {2, 1, 3}} |
| 113 | +#define MSPI_TIMING_PSRAM_CONFIG_NUM_CORE_CLK_240M_MODULE_CLK_80M_STR_MODE 14 |
| 114 | +#define MSPI_TIMING_PSRAM_DEFAULT_CONFIG_ID_CORE_CLK_240M_MODULE_CLK_80M_STR_MODE 4 |
| 115 | + |
| 116 | +//PSRAM: core clock 80M, module clock 80M, STR mode |
| 117 | +#define MSPI_TIMING_PSRAM_CONFIG_TABLE_CORE_CLK_80M_MODULE_CLK_80M_STR_MODE {{2, 2, 1}, {2, 1, 1}, {2, 0, 1}, {0, 0, 0}, {3, 1, 2}, {2, 3, 2}, {2, 2, 2}, {2, 1, 2}, {2, 0, 2}, {0, 0, 1}, {3, 1, 3}, {2, 3, 3}, {2, 2, 3}, {2, 1, 3}} |
| 118 | +#define MSPI_TIMING_PSRAM_CONFIG_NUM_CORE_CLK_80M_MODULE_CLK_80M_STR_MODE 14 |
| 119 | +#define MSPI_TIMING_PSRAM_DEFAULT_CONFIG_ID_CORE_CLK_80M_MODULE_CLK_80M_STR_MODE 4 |
0 commit comments