ra8_err.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
/* =============================================================================
 * Error Code Enum
 * =============================================================================
 */

typedef enum : uint16_t {
  /* =========================================================================
   * Success
   * =========================================================================
   */

  k_ra8_ok = 0,
 
  /* =========================================================================
   * Generic errors (0x100 -- 0x1FF)
   * General-purpose failures not tied to a specific peripheral or bus
   * =========================================================================
   */

  k_ra8_fail = 0x101,

  k_ra8_err_no_mem = 0x102,

  k_ra8_err_invalid_arg = 0x103,

  k_ra8_err_invalid_state = 0x104,

  k_ra8_err_invalid_size = 0x105,

  k_ra8_err_not_found = 0x106,

  k_ra8_err_not_supported = 0x107,

  k_ra8_err_timeout = 0x108,

  k_ra8_err_busy = 0x109,

  k_ra8_err_no_data = 0x10A,

  k_ra8_err_would_block = 0x10B,

  k_ra8_err_exists = 0x10C,

  k_ra8_err_empty = 0x10D,

  k_ra8_err_cancelled = 0x10E,

  k_ra8_err_not_initialized = 0x10F,

  k_ra8_err_estop = 0x110,

  k_ra8_err_not_empty = 0x111,

  k_ra8_err_access_denied = 0x112,
 
  /* =========================================================================
   * Hardware errors (0x200 -- 0x2FF)
   * Peripheral, GPIO, and hardware-interface errors
   * =========================================================================
   */

  k_ra8_err_hw_init_failed = 0x201,

  k_ra8_err_hw_not_ready = 0x202,

  k_ra8_err_hw_timeout = 0x203,

  k_ra8_err_hw_error = 0x204,

  k_ra8_err_gpio_conflict = 0x205,

  k_ra8_err_gpio_invalid_port = 0x206,

  k_ra8_err_gpio_invalid_pin = 0x207,

  k_ra8_err_out_of_range = 0x208,

  k_ra8_err_hw_unmapped = 0x209,
 
  /* =========================================================================
   * RTOS errors (0x300 -- 0x3FF)
   * Reserved for the future RTOS. Unused in the bare-metal v0.x build.
   * =========================================================================
   */

  k_ra8_err_rtos_error = 0x301,

  k_ra8_err_rtos_thread_create = 0x302,

  k_ra8_err_rtos_semaphore = 0x303,

  k_ra8_err_rtos_mutex = 0x304,

  k_ra8_err_rtos_queue = 0x305,

  k_ra8_err_rtos_timer = 0x306,
 
  /* =========================================================================
   * Communication errors (0x400 -- 0x4FF)
   * Bus-level and protocol-level failures
   * =========================================================================
   */

  k_ra8_err_comm_error = 0x401,

  k_ra8_err_spi_error = 0x402,

  k_ra8_err_uart_error = 0x403,

  k_ra8_err_i2c_error = 0x404,

  k_ra8_err_crc_mismatch = 0x405,

  k_ra8_err_protocol_error = 0x406,

  k_ra8_err_nack = 0x407,

  k_ra8_err_conflict = 0x408,

  k_ra8_err_retry_limit = 0x409,
 
  /* =========================================================================
   * Validation errors (0x500 -- 0x5FF)
   * Raised by ra8_check.h helpers and explicit pre/post-condition checks
   * =========================================================================
   */

  k_ra8_err_validation_failed = 0x501,

  k_ra8_err_checksum_mismatch = 0x502,

  k_ra8_err_range_check_failed = 0x503,

  k_ra8_err_null_ptr = 0x504,

  k_ra8_err_decomp_output_cap = 0x505,

  k_ra8_err_decomp_ratio = 0x506,

  k_ra8_err_decomp_entries = 0x507,

  k_ra8_err_decomp_depth = 0x508,

  k_ra8_err_decomp_iterations = 0x509,
} ra8_err_codes_t;

typedef ra8_err_codes_t ra8_err_t;
 
/* =============================================================================
 * Helpers
 * =============================================================================
 */

static inline bool ra8_err_is_error(ra8_err_t err)
{
  return err != k_ra8_ok;
}

const char* ra8_err_to_str(ra8_err_t err);
 
#ifdef __cplusplus
}
#endif