HardwareTypes.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
#include <limits>
 
//==============================================================================
// PLATFORM-AGNOSTIC TYPE WRAPPING
//==============================================================================
 
using hf_u8_t = uint8_t;
 
using hf_u16_t = uint16_t;
 
using hf_u32_t = uint32_t;
 
using hf_u64_t = uint64_t;
 
using hf_i8_t = int8_t;
 
using hf_i16_t = int16_t;
 
using hf_i32_t = int32_t;
 
using hf_i64_t = int64_t;
 
using hf_bool_t = bool;
 
//==============================================================================
// PLATFORM-AGNOSTIC GPIO TYPES
//==============================================================================
 
using hf_pin_num_t = hf_i32_t;
 
constexpr hf_pin_num_t HF_INVALID_PIN = -1;
 
constexpr hf_pin_num_t HF_MAX_PIN_NUMBER = 255;
 
//==============================================================================
// PLATFORM-AGNOSTIC PORT/CONTROLLER TYPES
//==============================================================================
 
using hf_port_num_t = hf_u32_t;
 
constexpr hf_port_num_t HF_INVALID_PORT = std::numeric_limits<hf_port_num_t>::max();
 
using hf_host_id_t = hf_u32_t;
 
constexpr hf_host_id_t HF_INVALID_HOST = std::numeric_limits<hf_host_id_t>::max();
 
//==============================================================================
// COMMUNICATION FREQUENCY TYPES
//==============================================================================
 
using hf_frequency_hz_t = hf_u32_t;
 
using hf_frequency_t = hf_frequency_hz_t;
 
using hf_baud_rate_t = hf_u32_t;
 
//==============================================================================
// CHANNEL AND TIMING TYPES
//==============================================================================
 
using hf_channel_id_t = hf_u32_t;
 
constexpr hf_channel_id_t HF_INVALID_CHANNEL = std::numeric_limits<hf_channel_id_t>::max();
 
using hf_time_t = hf_u32_t;
 
using hf_timeout_ms_t = hf_time_t;
 
using hf_timeout_us_t = hf_time_t;
 
using hf_timestamp_us_t = hf_u64_t;
 
//==============================================================================
// TIMEOUT CONSTANTS
//==============================================================================
 
constexpr hf_time_t HF_TIMEOUT_DEFAULT_MS = 1000;
 
constexpr hf_time_t HF_TIMEOUT_NONE = 0;
 
constexpr hf_time_t HF_TIMEOUT_MAX = std::numeric_limits<hf_time_t>::max();
 
//==============================================================================
// VALIDATION FUNCTIONS
//==============================================================================
 
constexpr bool IsValidPin(hf_pin_num_t pin) noexcept {
  return pin >= 0 && pin <= HF_MAX_PIN_NUMBER;
}
 
constexpr bool IsValidPort(hf_port_num_t port) noexcept {
  return port != HF_INVALID_PORT;
}
 
constexpr bool IsValidHost(hf_host_id_t host) noexcept {
  return host != HF_INVALID_HOST;
}
 
constexpr bool IsValidChannel(hf_channel_id_t channel) noexcept {
  return channel != HF_INVALID_CHANNEL;
}