Types.h

#pragma once
#ifndef OSCR_TYPES_H_
#define OSCR_TYPES_H_
 
#include <stdint.h>
#include "config.h"
#include "core-types.h"
#include "common/crc32_t.h"
 
namespace OSCR
{
  typedef void (*ConfigCallback)();
 
  enum class HW : uint8_t
  {
    Custom,
    V1,
    V2,
    V3,
    V4,
    V5,
  };

  struct CoreDefinition
  {
    CoreID const id = CoreID::NONE;
    char const * title;
    void (*menu)();
  };

  enum class ModuleResult : uint8_t
  {
    Success,      
    Error,        
    NotEnabled,   
    Unknown       
  };

  enum class ClockSpeed : bool
  {
    k16MHz  = 0,      
    k8MHz   = 1,      
    Full    = k16MHz, 
    Half    = k8MHz,  
  };

  enum class Voltage : uint8_t
  {
    k5V,          
    k3V3,         
    Unknown,

    k5V0 = k5V,   
    k3V = k3V3,   

#if defined(ENABLE_ONBOARD_ATMEGA)
    Default = k5V, 
#else /* !ENABLE_ONBOARD_ATMEGA */
    Default = k3V3, 
#endif /* ENABLE_ONBOARD_ATMEGA */
  };

  enum class SleepState : uint8_t
  {
    Awake,
    Drowsy,
    Sleep,
    DeepSleep,
  };

  enum class DataDirection : uint8_t
  {
    Unknown,
    In,
    Out,
  };

  struct BrowserFile
  {
    uint32_t index;
    char name[UI_FILE_BROWSER_FILENAME_MAX + 1];
    bool isDir = false;
  };
 
  namespace UI
  {
    enum UserInput: uint8_t
    {
      kUserInputIgnore,
      kUserInputConfirm,
      kUserInputNext,
      kUserInputBack,
      kUserInputConfirmShort,
      kUserInputConfirmLong,
      kUserInputUnknown,
    };

    enum InterfaceInput: uint8_t
    {
      kInterfaceInputIgnore,
      kInterfaceInputPress,
      kInterfaceInputPressDouble,
      kInterfaceInputPressShort,
      kInterfaceInputPressLong,
    };

    enum NavDir: bool
    {
      kNavDirBackward,
      kNavDirForward,
    };

    struct rgb_t
    {
      uint8_t red;
      uint8_t green;
      uint8_t blue;
    };

    enum MenuMode: uint8_t
    {
      kMenuFlashString,
      kMenuRamFlashString,
      kMenuOptionStruct,
      kMenuNullChar,
      kMenuFlashStringTemplate,
      kMenuIntegerTemplate,
    };
 
  }
 
  namespace Serial
  {
    enum class Style : uint8_t
    {
      Reset = 0,
      Bold, // also called "Bright"
      Faint, // ECMA-48
      Italic,
      Underline,
      Blink,
      // 6 = Unused
      Inverse = 7,
      Invisible, // ECMA-48
      Strikethrough, // ECMA-48
    };
 
    enum class Foreground : uint8_t
    {
      Black = 30,
      Red,
      Green,
      Yellow,
      Blue,
      Magenta,
      Cyan,
      White,
      Default, // ECMA-48
    };
 
    enum class Background : uint8_t
    {
      Black = 40,
      Red,
      Green,
      Yellow,
      Blue,
      Magenta,
      Cyan,
      White,
      Default, // ECMA-48
    };
 
    union Format
    {
      uint8_t value;
      Style style;
      Foreground foreground;
      Background background;
    };
 
    enum class Cursor: bool
    {
      Show,
      Hide,
    };
  }
}
 
#endif /* OSCR_TYPES_H_ */