sfToolkit.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "sfTkError.h"
 
// byte order types/enum
enum class sfTkByteOrder : uint8_t
{
    BigEndian = 0x01,
    LittleEndian = 0x02
};
 
// Note - toolkit *functions* start with sftk_ to avoid name collisions
 
// Function to determine the byte order of the system
sfTkByteOrder sftk_system_byteorder(void);
 
uint8_t sftk_byte_swap(uint8_t i);
uint16_t sftk_byte_swap(uint16_t i);
uint32_t sftk_byte_swap(uint32_t i);
int16_t sftk_byte_swap(int16_t i);
int32_t sftk_byte_swap(int32_t i);
 
// Area for platform specific implementations. The interface/functions are
// defined here, with the expectation that the platform provides the implementation.
 
// delay in milliseconds
void sftk_delay_ms(uint32_t ms);
 
// ticks in milliseconds
uint32_t sftk_ticks_ms(void);
 
#define SFTK_CHECK_BITS_SET(__value__, __bitmask__) (((__value__) & (__bitmask__)) == __bitmask__)
 
#define SFTK_CHECK_BITS_CLEARED(__value__, __bitmask__) (((__value__) & (__bitmask__)) == 0)