types.hpp

Go to the documentation of this file.

/**
 * @file types.hpp
 * @brief ARM Cortex-M optimized type aliases for Sound Byte Libs
 * @ingroup common
 * 
 * Defines native 32-bit type aliases optimized for ARM Cortex-M processors.
 * Using native word size eliminates unnecessary type extension instructions
 * and provides optimal performance on 32-bit ARM architecture.
 */
 
#ifndef SBL_COMMON_TYPES_HPP_
#define SBL_COMMON_TYPES_HPP_
 
#include <cstdint>
 
namespace sbl {
namespace common {
namespace types {
 
/**
 * @brief ARM-native GPIO port identifier
 * 
 * Uses 32-bit native word size to eliminate UXTB instructions
 * on ARM Cortex-M processors. Range: 0-15 for up to 16 ports.
 */
using GpioPortId = uint32_t;
 
/**
 * @brief ARM-native GPIO pin number within port
 * 
 * Uses 32-bit native word size for optimal ARM arithmetic.
 * Range: 0-31 for pins within a port.
 */
using GpioPinNum = uint32_t;
 
/**
 * @brief ARM-native frequency representation
 * 
 * Native 32-bit type for frequency values in Hz.
 * Range: 0 to 4,294,967,295 Hz (sufficient for embedded audio).
 */
using FrequencyHz = uint32_t;
 
/**
 * @brief ARM-native timing interval representation
 * 
 * Native 32-bit type for timing intervals in milliseconds.
 * Range: 0 to ~49.7 days in milliseconds.
 */
using IntervalMs = uint32_t;
 
/**
 * @brief ARM-native buffer index type
 * 
 * Native 32-bit type for buffer indexing operations.
 * Eliminates UXTH instructions in ring buffer ISR code.
 */
using BufferIndex = uint32_t;
 
/**
 * @brief ARM-native buffer size type
 * 
 * Native 32-bit type for buffer sizing.
 * Must be power-of-2 for efficient modulo operations.
 */
using BufferSize = uint32_t;
 
} // namespace types
} // namespace common
} // namespace sbl
 
#endif // SBL_COMMON_TYPES_HPP_