SysTiming.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

// include guard
#ifndef __SYSTIMING_H__
#define __SYSTIMING_H__

#include <stdint.h>

#ifndef CPU_CLK
#define CPU_CLK 120000000
#endif // CPU_CLK

#ifndef _CLEARCORE_SAMPLE_RATE_HZ
#define _CLEARCORE_SAMPLE_RATE_HZ (5000)
#endif

#define MS_TO_SAMPLES (_CLEARCORE_SAMPLE_RATE_HZ / 1000)

#define CYCLES_PER_INTERRUPT   (CPU_CLK / _CLEARCORE_SAMPLE_RATE_HZ)

#define SAMPLE_PERIOD_MICROSECONDS (1000000UL / _CLEARCORE_SAMPLE_RATE_HZ)

#define CYCLES_PER_MICROSECOND (CPU_CLK / 1000000)

#define CYCLES_PER_MILLISECOND (CPU_CLK / 1000)

#define CYCLES_PER_SECOND      (CPU_CLK)



namespace ClearCore {

const uint16_t SampleRateHz = _CLEARCORE_SAMPLE_RATE_HZ;

class SysTiming {
    friend class SysManager;

public:
#ifndef HIDE_FROM_DOXYGEN

    void GetIsrLoading(uint32_t &minSlot, uint32_t &maxSlot);

    static SysTiming &Instance();
#endif

    uint32_t Microseconds();

    void ResetMicroseconds();

    volatile const uint32_t &Milliseconds() {
        return m_msTickCnt;
    }

    void ResetMilliseconds();

#ifndef HIDE_FROM_DOXYGEN

    bool SysTickPeriodMicroSec(uint32_t microseconds = 1000);
#endif

private:
    uint32_t m_isrStartCycle;
    uint32_t m_isrMinCycles;
    uint32_t m_isrMaxCycles;
    uint32_t m_isrLastCycles;
    uint32_t m_msTickCnt;
    uint8_t m_fractMsTick;
    uint32_t m_lastIsrStartCnt;
    uint32_t m_microAdj;
    uint32_t m_microAdjHigh;
    uint32_t m_microAdjLow;
    uint32_t m_microAdjHighRemainder;
    uint32_t m_microAdjLowRemainder;


    SysTiming();

    void IsrStart();
    void IsrEnd();
    void Update();

};

}

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

uint32_t Milliseconds(void);

uint32_t Microseconds(void);

void Delay_cycles(uint64_t cycles);

inline void Delay_ms(uint32_t ms)  {
    return Delay_cycles(static_cast<uint64_t>(ms) * CYCLES_PER_MILLISECOND);
}

inline void Delay_us(uint32_t usec) {
    return Delay_cycles(static_cast<uint64_t>(usec) * CYCLES_PER_MICROSECOND);
}

#ifdef __cplusplus
}
#endif // __cplusplus

// end of include guard
#endif // __SYSTIMING_H__