display.h

Go to the documentation of this file.

/*
 * display.h
 *
 *  Created on: Jan 24, 2026
 *      Author: Souham Biswas
 *      GitHub: https://github.com/ironhide23586/icarus-os-core
 */
 
#ifndef DISPLAY_H_
#define DISPLAY_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Includes ------------------------------------------------------------------*/
#include <stdint.h>
#include <stdbool.h>
#include <stdio.h>
 
/* Exported constants --------------------------------------------------------*/
// Feature flags
#define ENABLE_HEARTBEAT_VISUALIZATION  1  // Set to 1 to enable, 0 to disable heartbeat visualization
 
// Terminal row assignments for fixed-position rendering
#define ROW_HEADER    1
#define ROW_SEPARATOR 9
#if ENABLE_HEARTBEAT_VISUALIZATION
#define ROW_HEARTBEAT 10
#define ROW_TASK_A    11
#define ROW_TASK_B    12
#define ROW_TASK_C    13
#else
#define ROW_TASK_A    11
#define ROW_TASK_B    12
#define ROW_TASK_C    13
#endif
 
#define BAR_WIDTH     40
#define BAR_COL_START 6  // Column where bar starts (after "[A] ")
 
// Vertical bar configuration (for semaphore visualization)
#define VBAR_HEIGHT   10  // Height of vertical bar in rows
#define VBAR_COL      70  // Column position for vertical bar
 
// Task period durations (in ticks) - longer = slower, more visible animation
#define HEARTBEAT_ON_TICKS   437   // Heartbeat LED on duration (437ms)
#define HEARTBEAT_OFF_TICKS  479   // Heartbeat LED off duration (479ms)
#define HEARTBEAT_PERIOD_TICKS (HEARTBEAT_ON_TICKS + HEARTBEAT_OFF_TICKS)  // Total period (916ms)
#define TASK_A_PERIOD_TICKS  2000  // Task A period duration
#define TASK_B_PERIOD_TICKS  4000  // Task B period duration (2x slower than A)
#define TASK_C_PERIOD_TICKS  3000  // Task C period duration
 
// Rendering and timing configuration
#define RENDER_INTERVAL_TICKS  20  // How often to update the display (in ticks)
#define CYCLE_PAUSE_TICKS      100 // Pause between cycles (in ticks)
 
/* Exported functions prototypes ---------------------------------------------*/
void display_init(void);
 
void display_render_bar(uint8_t row, const char* task_name, uint32_t elapsed_ticks, uint32_t period_ticks);
 
void display_render_banner(uint8_t row, const char* task_name, bool is_on);
 
void display_render_vbar(uint8_t start_row, uint8_t col, uint32_t count, uint32_t max_count);
 
void display_render_pipe(uint8_t start_row, uint8_t col, const char* label,
                         uint8_t count, uint8_t max_count,
                         uint8_t last_sent, uint8_t last_recv,
                         bool show_sent, bool show_recv);
 
void display_render_producer(uint8_t row, const char* task_name, 
                             uint32_t elapsed_ticks, uint32_t period_ticks,
                             uint8_t msg_value, bool show_msg);
 
void display_render_consumer(uint8_t row, const char* task_name,
                             uint32_t elapsed_ticks, uint32_t period_ticks,
                             uint8_t msg_value, bool show_msg);
 
// Message history configuration
#define MSG_HISTORY_LEN     8    // Number of messages to show in history
#define MSG_HISTORY_MAX_BYTES 4  // Max bytes per message to display
 
typedef struct {
    uint8_t data[MSG_HISTORY_MAX_BYTES];  // Message data
    uint8_t len;                           // Actual message length
    uint8_t source_id;                     // Producer ID (0, 1, etc.) or 0xFF for unknown
    bool is_send;                          // true = sent, false = received
} msg_history_entry_t;
 
typedef struct {
    msg_history_entry_t entries[MSG_HISTORY_LEN];
    uint8_t head;       // Next write position
    uint8_t count;      // Number of valid entries
} msg_history_t;
 
void msg_history_init(msg_history_t* hist);
 
void msg_history_add(msg_history_t* hist, const uint8_t* data, uint8_t len, 
                     uint8_t source_id, bool is_send);
 
void display_render_msg_history(uint8_t row, uint8_t col, msg_history_t* hist, const char* label);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DISPLAY_H_ */