config.h

Go to the documentation of this file.

 
#ifndef ICARUS_CONFIG_H
#define ICARUS_CONFIG_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * VERSION INFORMATION
 * ========================================================================= */
 
#define ICARUS_VERSION_MAJOR    0
#define ICARUS_VERSION_MINOR    2
#define ICARUS_VERSION_PATCH    0
#define ICARUS_VERSION_STRING   "0.2.0"
 
/* ============================================================================
 * KERNEL CONFIGURATION
 * ========================================================================= */
 
#define ICARUS_MAX_TASKS            128
 
#define ICARUS_MAX_SEMAPHORES       64
 
#define ICARUS_MAX_MESSAGE_QUEUES   64
 
#define ICARUS_MAX_MESSAGE_BYTES    512
 
#define ICARUS_STACK_WORDS          512
 
#define ICARUS_DATA_WORDS           512 
 
#define ICARUS_TICKS_PER_TASK       50
 
#define ICARUS_MAX_TASK_NAME_LEN    32
 
 
/* ============================================================================
 * MEMORY CONFIGURATION
 * ========================================================================= */
 
#define ICARUS_USE_DTCM             1
 
#define ICARUS_USE_ITCM             1
 
 
/* ============================================================================
 * SECTION PLACEMENT MACROS
 *
 * These macros annotate functions and data with their intended memory region.
 *
 * Memory region mapping:
 *   ITCM_FUNC      → .itcm        (hot-path code: handlers, wrappers, context switch)
 *   DTCM_DATA_PRIV → .dtcm_priv   (privileged-only kernel data: task_list,
 *                                   semaphore_list, scheduler state)
 *   DTCM_DATA_OBC  → .dtcm_obc    (OBC application hot data, unprivileged RW)
 *
 * MPU protection:
 *   - ITCM (.itcm): Read-only + Execute for all (Region 0)
 *     * Prevents code modification attacks
 *     * Kernel handlers protected by ARM exception architecture
 *   - DTCM (.dtcm_priv): Privileged-only RW (Region 5, subregions 0-3)
 *     * Kernel data isolated from unprivileged tasks
 *     * Access via SVC call gates only
 *   - DTCM (.dtcm_obc): Full access RW (Region 3, upper 64KB)
 *     * Zero wait-state data for OBC application hot paths
 * ========================================================================= */
 
#ifndef HOST_TEST
#  define ITCM_FUNC       __attribute__((section(".itcm")))
#  define DTCM_DATA_PRIV  __attribute__((section(".dtcm_priv")))
#  define DTCM_DATA_OBC   __attribute__((section(".dtcm_obc")))
#  define BKPRAM_DATA     __attribute__((section(".ram_d3")))
#else
#  define ITCM_FUNC
#  define DTCM_DATA_PRIV
#  define DTCM_DATA_OBC
#  define BKPRAM_DATA
#endif
 
/* ============================================================================
 * DEBUG CONFIGURATION
 * ========================================================================= */
 
#define ICARUS_ENABLE_ASSERTS       1
 
#define ICARUS_ENABLE_STATS         0
 
#define ICARUS_PRINT_BUFFER_BYTES   64
 
#define ICARUS_MAX_PRINT_RETRIES    4
 
 
/* ============================================================================
 * DISPLAY CONFIGURATION
 * ========================================================================= */
 
#define ICARUS_ENABLE_HEARTBEAT_VIS 1
 
#define ICARUS_HEARTBEAT_ON_TICKS   437
 
#define ICARUS_HEARTBEAT_OFF_TICKS  479
 
 
/* ============================================================================
 * COMPILE-TIME VALIDATION
 * ========================================================================= */
 
#if (ICARUS_STACK_WORDS % 2) != 0
#error "ICARUS_STACK_WORDS must be even for 8-byte stack alignment (ARM ABI)"
#endif
 
#if (ICARUS_PRINT_BUFFER_BYTES > 64)
#error "ICARUS_PRINT_BUFFER_BYTES must be <= 64 for USB FS CDC packet sizing"
#endif
 
#if (ICARUS_MAX_TASKS > 255)
#error "ICARUS_MAX_TASKS must be <= 255 (uint8_t index)"
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ICARUS_CONFIG_H */