subsystem.h

Go to the documentation of this file.

#ifndef _SUBSYSTEM_H_
#define _SUBSYSTEM_H_

#include <stdarg.h>

#include "library.h"

// Define these before including project_settings.h so project_settings.h can see them
#define SUBSYSTEM_IO_NONE 0
#define SUBSYSTEM_IO_UART 1
#define SUBSYSTEM_IO_PRINTF 2
#define SUBSYSTEM_IO_CUSTOM 255 // if the user sets this, they are responsible for creating the macro hooks to the IO layer in their project_settings.h file

#include "project_settings.h"

enum log_level {
    LOG_OFF = 0,
    LOG_ERROR,
    LOG_WARNING,
    LOG_MESSAGE,
    LOG_DEBUG
};


/* If the subsys io isn't explicitly defined, but SUBSYS_UART is defined, set the io system to UART
 * else, disable the system */
#ifndef SUBSYSTEM_IO
#ifdef SUBSYSTEM_UART
#define SUBSYSTEM_IO SUBSYSTEM_IO_UART
#else
#define SUBSYSTEM_IO SUBSYSTEM_IO_NONE
#endif
#endif

#if SUBSYSTEM_IO != SUBSYSTEM_IO_NONE
#ifndef USE_MODULE_SUBSYSTEM
#warning "USE_MODULE_SUBSYSTEM not defined in project_settings.h. Other modules won't be able to utilize this module."
#endif
#endif

#if SUBSYSTEM_IO == SUBSYSTEM_IO_NONE
    #define LogError(sys_id, str, ...)
    #define LogWarning(sys_id, str, ...)
    #define LogMsg(sys_id, str, ...)
    #define LogDebug(sys_id, str, ...)
#else
    #define LogError(sys_id, str, ...) Subsystem_Write(sys_id, LOG_ERROR, str, ##__VA_ARGS__)
    #define LogWarning(sys_id, str, ...) Subsystem_Write(sys_id, LOG_WARNING, str, ##__VA_ARGS__)
    #define LogMsg(sys_id, str, ...) Subsystem_Write(sys_id, LOG_MESSAGE, str, ##__VA_ARGS__)
    #define LogDebug(sys_id, str, ...) Subsystem_Write(sys_id, LOG_DEBUG, str, ##__VA_ARGS__)
#endif

#if SUBSYSTEM_IO == SUBSYSTEM_IO_NONE
    #define Subsystem_printf(str, ...)
    #define Subsystem_vprintf(str, arg)
    #define Subsystem_PrintChar(c)
    #define Subsystem_RegisterReceiver(r)
#elif SUBSYSTEM_IO == SUBSYSTEM_IO_UART
    #include "uart.h"
    #ifndef USE_MODULE_BUFFER_PRINTF
        #error "This module requires optional UART functionality provided by buffer_printf. Please declare USE_MODULE_BUFFER_PRINTF in project_settings.h"
    #endif
    #ifndef SUBSYSTEM_UART
        #error "You must define what UART number the terminal is using in project_settings.h: #define SUBSYS_UART num"
    #endif
    #define Subsystem_printf(str, ...) UART_printf(SUBSYSTEM_UART, str, ##__VA_ARGS__)
    #define Subsystem_vprintf(str, arg) UART_vprintf(SUBSYSTEM_UART, str, arg)
    #define Subsystem_PrintChar(c) UART_WriteByte(SUBSYSTEM_UART, c)
    #define Subsystem_RegisterReceiver(r) UART_RegisterReceiver(SUBSYSTEM_UART, r);
#elif SUBSYSTEM_IO == SUBSYSTEM_IO_PRINTF
    #include <stdio.h>
    #define Subsystem_printf(str, ...) printf(str, ##__VA_ARGS__)
    #define Subsystem_vprintf(str, args) vprintf(str, args)
    #define Subsystem_PrintChar(c) printf("%c", c)
    #define Subsystem_RegisterReceiver(r)
#endif

#define SYSTEM_VERSION 0x04000000u 

#ifndef RECEIVE_MAX_LENGTH
#define RECEIVE_MAX_LENGTH 64 
#endif
#define RECEIVE_START_CHAR '$' 
#ifndef RECEIVE_STOP_CHAR
#define RECEIVE_STOP_CHAR '\r' 
#endif
#ifndef RECEIVE_MAX_ARGC
#define RECEIVE_MAX_ARGC 8 
#endif

#define GetLogTimestamp() TimeNow()

// use Push_printf to log messages to the log buffer LOG_BUF
void LogStr(char * str, ...);

// TODO: Update documentation
void Subsystem_Write(uint8_t subsystem_id, enum log_level level,  char * str, ...);

uint8_t Subsystem_Init(char * name, version_t version, void (*callback)(int argc, char *argv[]));

void Subsystem_RegisterCallback(uint8_t subsystem_id, void (*callback)(int argc, char *argv[]));

char *Subsystem_GetName(uint8_t subsystem_id);

void Log_EchoOn(void);

void Log_EchoOff(void);

uint8_t Log_GetEcho(void);

void Log_Version(uint8_t subys_id);

void Log_Header(uint8_t subsystem_id, enum log_level level);

void Log_MuteAll(void);

void Log_UnmuteAll(void);

void Log_MuteSys(uint8_t sys_id);

void Log_UnmuteSys(uint8_t sys_id);

void Log_SetLevel(uint8_t sys_id, enum log_level level);

uint16_t ArgToU16(char* arg);
uint8_t ArgToU8(char* arg);
uint32_t ArgToU32(char* arg);

void Subsystem_SystemDisable(void);

void Subsystem_SystemEnable(void);

#endif /* _SUBSYS_H_ */