/****************************************************************************
 * arch/xtensa/include/esp32/memory_layout.h
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/* The heap overview:
 *
 * CONFIG_HEAP2_BASE                         eg. 3f80 0000
 *     :
 *     : g_mmheap (CONFIG_ESP32_SPIRAM)
 *     :
 * CONFIG_HEAP2_BASE + CONFIG_HEAP2_SIZE     eg. 3fc0 0000
 *
 * HEAP_REGION0_START                        3ffa e6f0
 *     :
 *     : g_mmheap region0
 *     :
 * HEAP_REGION0_END                          3ffa fff0
 *     :
 * _sheap                                    eg. 3ffc 8c6c
 *     :
 *     : g_mmheap region1
 *     :
 * HEAP_REGION1_END                              3ffd fff0
 *     :
 *     : ROM data
 *     :
 *---------------------------------------------------------------------
 * if !CONFIG_SMP
 *
 * HEAP_REGION2_START                            3ffe 0450
 *     :
 *     : g_iheap (CONFIG_XTENSA_IMEM_USE_SEPARATE_HEAP)
 *     :
 * HEAP_REGION2_START + CONFIG_XTENSA_IMEM_REGION_SIZE
 *     :
 *     : g_mmheap region2
 *     :
 *---------------------------------------------------------------------
 * if CONFIG_SMP
 *
 * HEAP_REGION2_START                            3ffe 0450
 *     :
 *     : g_mmheap region2
 *     :
 * HEAP_REGION2_END                              3ffe 3f10
 *     :
 *     : ROM data
 *     :
 * HEAP_REGION3_START                            3ffe 5240
 *     :
 *     : g_iheap (CONFIG_XTENSA_IMEM_USE_SEPARATE_HEAP)
 *     :
 * HEAP_REGION3_START + CONFIG_XTENSA_IMEM_REGION_SIZE
 *     :
 *     : g_mmheap region3
 *     :
 *---------------------------------------------------------------------
 * _eheap                                        4000 0000
 */

/* This region is supposed to be part of the ROM data.  However, the ROM
 * isn't using the last 6KB, so we get it as heap. It's called REGION0
 * because it starts before _sheap.
 * Although this region is adjacent to 0x3ffb0000 (start of static memory)
 * we don't add it to static memory but we add it as heap.  The reason is the
 * Bluetooth controller uses a fixed 64KB region at the start of 0x3ffb0000.
 * It's cleaner, from a source code perspective, to start static memory at
 * 0x3ffb0000 and get what's before that as heap.
 */

#define HEAP_REGION0_START  0x3ffae6f0
#define HEAP_REGION0_END    0x3ffafff0

/* Region 1 of the heap is the area from the end of the .data section to the
 * beginning of the ROM data.  The start address is defined from the linker
 * script as "_sheap".  The end is defined here, as follows:
 */

#define HEAP_REGION1_END    0x3ffdfff0

/* Region 2 of the heap is the area from the end of the ROM data to the end
 * of DRAM.  The linker script has already set "_eheap" as the end of DRAM,
 * the following defines the start of region2.
 * N.B: That ROM data consists of 2 regions, one per CPU.  If SMP is not
 * enabled include APP's region with the heap.
 *
 * When an internal heap is enabled this region starts at an offset equal to
 * the size of the internal heap.
 *
 * The QEMU bootloader image is slightly different than the chip's one.
 * The ROM on PRO and APP CPUs uses different regions for static data.
 * In QEMU, however, we load only one ROM binary, taken from the PRO CPU,
 * and it is used by both CPUs.  So, in QEMU, if we allocate PRO CPUs region
 * early, it will be clobbered once the APP CPU starts.
 * We can delay the allocation to when everything has started through the
 * board_late_initiliaze hook, as is done for the APP data, however this
 * should be fixed from QEMU side.  The following macros, then, just skip
 * PRO CPU's regions when a QEMU image generation is enabled with SMP.
 */

#if defined(CONFIG_ESP32_QEMU_IMAGE) && defined(CONFIG_SMP)
#  define HEAP_REGION2_START  0x3ffe7e40
#else
#  define HEAP_REGION2_START  0x3ffe0450
#endif

#ifdef CONFIG_SMP
#  define HEAP_REGION2_END    0x3ffe3f10
#  define HEAP_REGION3_START  0x3ffe5240
#endif

#ifdef CONFIG_XTENSA_IMEM_USE_SEPARATE_HEAP
#  define	XTENSA_IMEM_REGION_SIZE	CONFIG_XTENSA_IMEM_REGION_SIZE
#else
#  define	XTENSA_IMEM_REGION_SIZE	0
#endif

/* Internal heap starts at the end of the ROM data.
 * This is either the start of region2 if SMP is disabled or start of region3
 * if SMP is enabled.
 */

#ifndef CONFIG_SMP
#  define ESP32_IMEM_START  HEAP_REGION2_START
#else
#  define ESP32_IMEM_START  HEAP_REGION3_START
#endif

/* Region of unused ROM App data */

#define HEAP_REGION_ROMAPP_START  0x3ffe4360
#define HEAP_REGION_ROMAPP_END    0x3ffe5230