ra8_bit_constants.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
/* =============================================================================
 * Bit positions (uint8_t)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_bit_0  = 0U,  
  k_ra8_bit_1  = 1U,  
  k_ra8_bit_2  = 2U,  
  k_ra8_bit_3  = 3U,  
  k_ra8_bit_4  = 4U,  
  k_ra8_bit_5  = 5U,  
  k_ra8_bit_6  = 6U,  
  k_ra8_bit_7  = 7U,  
  k_ra8_bit_8  = 8U,  
  k_ra8_bit_9  = 9U,  
  k_ra8_bit_10 = 10U, 
  k_ra8_bit_11 = 11U, 
  k_ra8_bit_12 = 12U, 
  k_ra8_bit_13 = 13U, 
  k_ra8_bit_14 = 14U, 
  k_ra8_bit_15 = 15U, 
  k_ra8_bit_16 = 16U, 
  k_ra8_bit_17 = 17U, 
  k_ra8_bit_18 = 18U, 
  k_ra8_bit_19 = 19U, 
  k_ra8_bit_20 = 20U, 
  k_ra8_bit_21 = 21U, 
  k_ra8_bit_22 = 22U, 
  k_ra8_bit_23 = 23U, 
  k_ra8_bit_24 = 24U, 
  k_ra8_bit_25 = 25U, 
  k_ra8_bit_26 = 26U, 
  k_ra8_bit_27 = 27U, 
  k_ra8_bit_28 = 28U, 
  k_ra8_bit_29 = 29U, 
  k_ra8_bit_30 = 30U, 
  k_ra8_bit_31 = 31U, 
} ra8_bit_position_t;
 
/* =============================================================================
 * Byte-level masks
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_mask_nibble = 0x000FU, 
  k_ra8_mask_byte   = 0x00FFU, 
  k_ra8_mask_word   = 0xFFFFU, 
  k_ra8_mask_lsn2   = 0x0003U, 
  k_ra8_mask_lsn3   = 0x0007U, 
  k_ra8_mask_lsn4   = 0x000FU, 
  k_ra8_mask_lsn5   = 0x001FU, 
  k_ra8_mask_lsn6   = 0x003FU, 
  k_ra8_mask_lsn7   = 0x007FU, 
  k_ra8_mask_lsn8   = 0x00FFU, 
} ra8_byte_mask_t;

typedef enum : uint8_t {
  k_ra8_bits_per_byte = 8U,  
  k_ra8_bits_per_u16  = 16U, 
  k_ra8_bits_per_u32  = 32U, 
  k_ra8_bits_per_u64  = 64U, 
} ra8_byte_count_t;
 
/* =============================================================================
 * Byte-index helpers for MSB-first packing
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_be_idx_hi32 = 0U, 
  k_ra8_be_idx_mh32 = 1U, 
  k_ra8_be_idx_ml32 = 2U, 
  k_ra8_be_idx_lo32 = 3U, 
  k_ra8_be_idx_hi16 = 0U, 
  k_ra8_be_idx_lo16 = 1U, 
} ra8_be_byte_idx_t;
 
#ifdef __cplusplus
}
#endif