CM: Debug functions & types start with 'CM'

This is to differentiate similarly named functions in the kernel.
coderarjob · Nov 30, 2024 · 72ba30c · 72ba30c
1 parent 7c7c01c
commit 72ba30c
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 36 deletions.
diff --git a/include/cm/debug.h b/include/cm/debug.h
@@ -7,24 +7,28 @@
 #pragma once
 
 #if defined(DEBUG) && defined(PORT_E9_ENABLED)
-    typedef enum DebugLogType {
-        DEBUG_LOG_TYPE_INFO,
-        DEBUG_LOG_TYPE_FUNC,
-        DEBUG_LOG_TYPE_ERROR,
-        DEBUG_LOG_TYPE_WARN,
-    } DebugLogType;
+typedef enum CM_DebugLogType {
+    CM_DEBUG_LOG_TYPE_INFO,
+    CM_DEBUG_LOG_TYPE_FUNC,
+    CM_DEBUG_LOG_TYPE_ERROR,
+    CM_DEBUG_LOG_TYPE_WARN,
+} CM_DebugLogType;
 
-    void debug_log_ndu (DebugLogType type, const char* func, UINT line, char* fmt, ...);
+void cm_debug_log_ndu (CM_DebugLogType type, const char* func, UINT line, char* fmt, ...);
 
-    #define INFO(...)       debug_log_ndu (DEBUG_LOG_TYPE_INFO, __func__, __LINE__, __VA_ARGS__)
-    #define ERROR(...)      debug_log_ndu (DEBUG_LOG_TYPE_ERROR, __func__, __LINE__, __VA_ARGS__)
-    #define FUNC_ENTRY(...) debug_log_ndu (DEBUG_LOG_TYPE_FUNC, __func__, __LINE__, "" __VA_ARGS__)
-    #define WARN(...)       debug_log_ndu (DEBUG_LOG_TYPE_WARN, __func__, __LINE__, __VA_ARGS__)
+    #define CM_DBG_INFO(...) \
+        cm_debug_log_ndu (CM_DEBUG_LOG_TYPE_INFO, __func__, __LINE__, __VA_ARGS__)
+    #define CM_DBG_ERROR(...) \
+        cm_debug_log_ndu (CM_DEBUG_LOG_TYPE_ERROR, __func__, __LINE__, __VA_ARGS__)
+    #define CM_DBG_FUNC_ENTRY(...) \
+        cm_debug_log_ndu (CM_DEBUG_LOG_TYPE_FUNC, __func__, __LINE__, "" __VA_ARGS__)
+    #define CM_DBG_WARN(...) \
+        cm_debug_log_ndu (CM_DEBUG_LOG_TYPE_WARN, __func__, __LINE__, __VA_ARGS__)
 #else
-    #define INFO(...)       (void)0
-    #define ERROR(...)      (void)0
-    #define FUNC_ENTRY(...) (void)0
-    #define WARN(...)       (void)0
+    #define CM_DBG_INFO(...)       (void)0
+    #define CM_DBG_ERROR(...)      (void)0
+    #define CM_DBG_FUNC_ENTRY(...) (void)0
+    #define CM_DBG_WARN(...)       (void)0
 #endif // PORT_E9_ENABLED
 
 #if defined(DEBUG)
@@ -33,10 +37,10 @@
      *
      * @return      Nothing
      **************************************************************************************************/
-    #define bochs_breakpoint() __asm__ volatile("xchg bx, bx")
+    #define cm_debug_bochs_breakpoint() __asm__ volatile("xchg bx, bx")
 
     #if ARCH == x86
-        #define x86_outb(p, v) __asm__ volatile("out dx, al;" : : "a"(v), "d"(p))
-        #define x86_inb(p, v)  __asm__ volatile("in al, dx" : "=a"(v) : "d"(p))
+        #define cm_debug_x86_outb(p, v) __asm__ volatile("out dx, al;" : : "a"(v), "d"(p))
+        #define cm_debug_x86_inb(p, v)  __asm__ volatile("in al, dx" : "=a"(v) : "d"(p))
     #endif
 #endif // DEBUG
diff --git a/include/cm/err.h b/include/cm/err.h
@@ -36,9 +36,9 @@ static inline uint32_t cm_get_os_error()
 }
 
 /* Can be used to store an error code and return from a function */
-#define CM_RETURN_ERROR__(errno, rval) \
-    do {                               \
-        ERROR ("Error %x.", errno);    \
-        cm_error_num__ = errno;        \
-        return rval;                   \
+#define CM_RETURN_ERROR__(errno, rval)     \
+    do {                                   \
+        CM_DBG_ERROR ("Error %x.", errno); \
+        cm_error_num__ = errno;            \
+        return rval;                       \
     } while (0)
diff --git a/src/apps/gui0.c b/src/apps/gui0.c
@@ -12,13 +12,13 @@ static OSIF_WindowFrameBufferInfo createWindow (const char* const title)
 {
     Handle h = cm_window_create (title);
     if (h == INVALID_HANDLE) {
-        ERROR ("Window creation failed");
+        CM_DBG_ERROR ("Window creation failed");
         HALT();
     }
 
     OSIF_WindowFrameBufferInfo fbi;
     if (!cm_window_getFB (h, &fbi)) {
-        ERROR ("Window creation failed");
+        CM_DBG_ERROR ("Window creation failed");
         HALT();
     }
 

diff --git a/src/cm/cm.c b/src/cm/cm.c
@@ -23,7 +23,7 @@ void event_handler_NDU_()
         cm_process_yield();
         break;
     case OSIF_PROCESS_EVENT_PROCCESS_CHILD_KILLED:
-        INFO ("Child exitted with code: %x", e.data);
+        CM_DBG_INFO ("Child exitted with code: %x", e.data);
         break;
     case OSIF_PROCESS_EVENT_NONE:
         break;

diff --git a/src/cm/debug.c b/src/cm/debug.c
@@ -29,7 +29,7 @@ static void qemu_putString (const CHAR* string)
     CHAR c;
     while ((c = *string++)) {
     #if ARCH == x86
-        x86_outb (0xE9, c);
+        cm_debug_x86_outb (0xE9, c);
     #else
         #error "Not implemented"
     #endif
@@ -42,27 +42,27 @@ static void qemu_putString (const CHAR* string)
  *
  * @return      Nothing
  **************************************************************************************************/
-void debug_log_ndu (DebugLogType type, const char* func, UINT line, char* fmt, ...)
+void cm_debug_log_ndu (CM_DebugLogType type, const char* func, UINT line, char* fmt, ...)
 {
     int len = 0;
     char buffer[MAX_PRINTABLE_STRING_LENGTH];
     char* message  = NULL;
     char* logColor = ANSI_COL_RESET;
 
     switch (type) {
-    case DEBUG_LOG_TYPE_INFO: {
+    case CM_DEBUG_LOG_TYPE_INFO: {
         message  = "\n  %s[%u][MLC][ INFO ]%s %s:%u %s|";
         logColor = ANSI_COL_GREEN;
     } break;
-    case DEBUG_LOG_TYPE_FUNC: {
+    case CM_DEBUG_LOG_TYPE_FUNC: {
         message  = "\n%s[%u][MLC]%s[ %s:%u ]%s|";
         logColor = ANSI_COL_YELLOW;
     } break;
-    case DEBUG_LOG_TYPE_ERROR: {
+    case CM_DEBUG_LOG_TYPE_ERROR: {
         message  = "\n  %s[%u][MLC][ ERROR ]%s %s:%u %s|";
         logColor = ANSI_COL_RED;
     } break;
-    case DEBUG_LOG_TYPE_WARN: {
+    case CM_DEBUG_LOG_TYPE_WARN: {
         message  = "\n  %s[%u][MLC][ WARN ]%s %s:%u %s|";
         logColor = ANSI_COL_YELLOW;
     } break;

diff --git a/src/cm/graphics.c b/src/cm/graphics.c
@@ -41,7 +41,7 @@ typedef RGBColor32Bits GxColor;
 
 void graphics_blit (const GraphicsContext* destg, UINT x, UINT y, const GraphicsContext* srcg)
 {
-    FUNC_ENTRY ("area: %px, x: %u, y: %u, src area: %px", destg, x, y, srcg);
+    CM_DBG_FUNC_ENTRY ("area: %px, x: %u, y: %u, src area: %px", destg, x, y, srcg);
 
     // k_assert (destg->bytesPerPixel == srcg->bytesPerPixel, "Graphics area mismatch");
 
@@ -64,7 +64,7 @@ void graphics_blit (const GraphicsContext* destg, UINT x, UINT y, const Graphics
 void graphics_image_ppm (const GraphicsContext* g, UINT x, UINT y, UINT w, UINT h,
                          UINT bytesPerPixel, U8* bytes)
 {
-    FUNC_ENTRY ("area: %px, x: %u, y: %u, w: %u, h: %u, bytes: %px", g, x, y, w, h, bytes);
+    CM_DBG_FUNC_ENTRY ("area: %px, x: %u, y: %u, w: %u, h: %u, bytes: %px", g, x, y, w, h, bytes);
 
     SIZE bytesPerRow = g->bytesPerRow;
     U8* start        = (U8*)g->buffer + (y * bytesPerRow) + (x * g->bytesPerPixel);
@@ -89,7 +89,7 @@ void graphics_image_ppm (const GraphicsContext* g, UINT x, UINT y, UINT w, UINT
 
 void graphics_putpixel (const GraphicsContext* g, UINT x, UINT y, Color color)
 {
-    FUNC_ENTRY ("area: %px, x: %u, y: %u, color: %x", g, x, y, color);
+    CM_DBG_FUNC_ENTRY ("area: %px, x: %u, y: %u, color: %x", g, x, y, color);
 
     GxColor* start = (GxColor*)(g->buffer + (y * g->bytesPerRow) + (x * g->bytesPerPixel));
     GxColor* col   = (GxColor*)&color;
@@ -98,7 +98,7 @@ void graphics_putpixel (const GraphicsContext* g, UINT x, UINT y, Color color)
 
 void graphics_rect (const GraphicsContext* g, UINT x, UINT y, UINT w, UINT h, Color color)
 {
-    FUNC_ENTRY ("area: %px, x: %u, y: %u, w: %u, h: %u, color: %x", g, x, y, w, h, color);
+    CM_DBG_FUNC_ENTRY ("area: %px, x: %u, y: %u, w: %u, h: %u, color: %x", g, x, y, w, h, color);
 
     SIZE bytesPerRow = g->bytesPerRow;
     U8* start        = (U8*)g->buffer + (y * bytesPerRow) + (x * g->bytesPerPixel);