Guillaume Souchere
2f982107dc
heap: Wrap the function hook feature under a configuration
...
also update heap_debug.rst and mem_alloc.rst to provide information about the feature
2023-03-23 04:50:49 +00:00
Sudeep Mohanty
371fe114bc
docs: Updated chip independednt api-reference chapters for c6 and h2
2023-02-03 15:00:27 +01:00
Guillaume Souchere
5dc0481d21
heap: add documentation about the function placement in IRAM and its usage in ISR
...
This commits adds a internal.md file in the heap directory to clarify the idea behind
which functions is placed in IRAM or in flash.
A section in mem_alloc.rst documentation is added to specify which functions from the
heap component API can be used in interrupt handlers.
2022-11-24 10:31:14 +01:00
Linda
a8ae91dd96
docs: update the usage of MALLOC_CAP_32BIT on ESP32 chips
2022-11-22 10:05:28 +08:00
Guillaume Souchere
abe56e2bbe
docs: add section in ram-uasge.rst to clarify DRAM limitations on esp32.
...
The sections details that only 160KB of DRAM can be used for statically allocated data.
Reference this new section in mem_alloc.rst and memory-types.rst.
2022-11-15 07:40:25 +01:00
Marius Vikhammer
7d629e8c84
docs: reorder content in mem_alloc section
...
We should avoid hiding sections between long lists of API documentation.
2022-09-02 16:16:02 +08:00
Marius Vikhammer
e1f27cf31b
heap: remove misleading info about malloc being equivalent to heap_caps_malloc(p, MALLOC_CAP_8BIT)
...
The actual memory allocated for malloc() depends on a lot of factors, see heap_caps_malloc_default()
Closes https://github.com/espressif/esp-idf/issues/7659
2022-09-01 11:39:34 +08:00
Marius Vikhammer
d7053c38cc
docs: fix broken links
2022-05-07 13:09:41 +08:00
Marius Vikhammer
a6543f0d21
docs: fix broken references to misc API functions and types.
2022-03-27 16:46:57 +08:00
Angus Gratton
492b061cbc
doc: update the memory types and startup docs
2021-03-31 09:37:28 +11:00
Marius Vikhammer
91439e3818
docs: updated system api-reference chapters for C3
2021-03-15 18:51:12 +08:00
Marius Vikhammer
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
Marius Vikhammer
d56ea52ea1
doc: EN doc update and fixed warnings
2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69
doc: Update English pages with generic target name
2020-02-07 16:37:43 +11:00
Angus Gratton
e6211c7864
docs: add new top-level docs builder that builds docs for a single chip
2020-02-07 16:37:43 +11:00
Angus Gratton
0f27c38855
docs: Add notes about thread safety and using heap from ISRs
...
Closes https://github.com/espressif/esp-idf/issues/3768
2019-07-12 11:09:00 +10:00
Angus Gratton
47bbb107a8
build system: Use CMake-based build system as default when describing commands
2019-07-08 17:31:27 +10:00
Angus Gratton
a3a1cc080e
docs: Add some more explanation about heap, memory types
2018-11-30 12:29:38 +11:00
Jeroen Domburg
81e35a142a
Spiram: Add option to reserve MMU banks; add himem API to make use of those banks
2018-10-15 14:32:58 +08:00
krzychb
097adc3a33
Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available
2018-03-13 21:57:08 +01:00
