Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-01 02:30:52 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat(esp_blockdev): add build-time ioctl command reservation overlap checker

Browse Source 
(cherry picked from commit a9f545bcea)
This commit is contained in:
Tomáš Rohlínek
2026-06-30 16:53:44 +02:00
committed by Martin Vychodil
parent 93056b5253
commit 0188e1fe7b
10 changed files with 805 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/esp_blockdev/include/esp_blockdev.h
+58
View File
@@ -25,6 +25,55 @@ extern "C" {
* See the in-code comments and README.md for more details.
*/
/**
* @brief Register a reserved ioctl command value or inclusive range for overlap checking
*
* These macros are machine-readable markers for the build-time checker. They do not affect
* normal builds unless @c ESP_BLOCKDEV_CHECK_CMD_OVERLAP is defined.
*
* Register reservation declarations in headers or other files that are appended to
* @c ESP_BLOCKDEV_IOCTL_DEF_FILES.
*
* @code{c}
* ESP_BLOCKDEV_RESERVE_CMD_RANGE(nand_flash, ESP_BLOCKDEV_CMD_SYSTEM_BASE + 10, ESP_BLOCKDEV_CMD_SYSTEM_BASE + 20);
* ESP_BLOCKDEV_RESERVE_CMD(sdcard, ESP_BLOCKDEV_CMD_USER_BASE + 1);
* @endcode
*/
/** @cond */
#ifdef ESP_BLOCKDEV_CHECK_CMD_OVERLAP
#define ESP_BLOCKDEV_RESERVE_CMD_RANGE(component, start, end) \
ESP_BLOCKDEV_RESERVE_MARKER(component, (start), (end))
#define ESP_BLOCKDEV_RESERVE_CMD(component, start) \
ESP_BLOCKDEV_RESERVE_CMD_RANGE(component, start, start)
#else
/** @endcond */
/**
* @brief Reserve an inclusive range of ioctl command values for build-time overlap checking
*
* @param component Unquoted identifier naming the owning component
* @param start First command value in the range (0x00–0xFF)
* @param end Last command value in the range (0x00–0xFF, >= start)
*/
#define ESP_BLOCKDEV_RESERVE_CMD_RANGE(component, start, end)
/**
* @brief Reserve a single ioctl command value for build-time overlap checking
*
* Equivalent to ``ESP_BLOCKDEV_RESERVE_CMD_RANGE(component, start, start)``.
*
* @param component Unquoted identifier naming the owning component
* @param start The command value to reserve (0x00–0xFF)
*/
#define ESP_BLOCKDEV_RESERVE_CMD(component, start)
/** @cond */
#endif
/** @endcond */
/**
* @defgroup esp_blockdev_ioctl_cmds Block device ioctl commands
*
@@ -34,6 +83,8 @@ extern "C" {
* @{
*/
/* --- ESP_BLOCKDEV_CMD_ reservation section begin --- */
#define ESP_BLOCKDEV_CMD_SYSTEM_BASE 0x00 /*!< System commands base value */
#define ESP_BLOCKDEV_CMD_USER_BASE 0x80 /*!< User commands base value */
@@ -76,6 +127,13 @@ extern "C" {
*/
#define ESP_BLOCKDEV_CMD_ERASE_CONTENTS (ESP_BLOCKDEV_CMD_SYSTEM_BASE + 1)
/** @cond */
/** Reserve the core esp_blockdev commands for overlap checking */
ESP_BLOCKDEV_RESERVE_CMD_RANGE(esp_blockdev, ESP_BLOCKDEV_CMD_SYSTEM_BASE, ESP_BLOCKDEV_CMD_SYSTEM_BASE + 1);
/** @endcond */
/* --- ESP_BLOCKDEV_CMD_ reservation section end --- */
/** @} */
/**