esp-idf/tools/unit-test-app/components/test_utils/private_include/ccomp_timer_impl.h

// Copyright 2019 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <stdint.h>
#include <stdbool.h>
#include "esp_err.h"

/**
 * @brief Initialize the underlying implementation for cache compensated timer. This might involve
 * setting up architecture-specific event counters and or allocating interrupts that handle events for those counters.
 * @return
 *  - ESP_OK: Success
 *  - ESP_ERR_INVALID_STATE: The timer has already been started previously.
 *  - Others: Fail
 */
esp_err_t ccomp_timer_impl_init(void);

/**
 * @brief Deinitialize the underlying implementation for cache compensated timer. This should restore
 * the state of the program to before ccomp_timer_impl_init.
 * @return
 *  - ESP_OK: Success
 *  - ESP_ERR_INVALID_STATE: The timer has already been started previously.
 *  - Others: Fail
 */
esp_err_t ccomp_timer_impl_deinit(void);

/**
 * @brief Make the underlying implementation start keeping time.
 *
 * @return
 *  - ESP_OK: Success
 *  - Others: Fail
 */
esp_err_t ccomp_timer_impl_start(void);

/**
 * @brief Make the underlying implementation stop keeping time.
 *
 * @return
 *  - ESP_OK: Success
 *  - Others: Fail
 */
esp_err_t ccomp_timer_impl_stop(void);

/**
 * @brief Reset the timer to its initial state.
 *
 * @return
 *  - ESP_OK: Success
 *  - Others: Fail
 */
esp_err_t ccomp_timer_impl_reset(void);

/**
 * @brief Get the elapsed time kept track of by the underlying implementation in microseconds.
 *
 * @return The elapsed time in microseconds. Set to -1 if the operation is unsuccessful.
 */
int64_t ccomp_timer_impl_get_time(void);

/**
 * @brief Obtain an internal critical section used in the implementation. Should be treated
 * as a spinlock.
 */
void ccomp_timer_impl_lock(void);

/**
 * @brief Start the performance timer on the current core.
 */
void ccomp_timer_impl_unlock(void);

/**
 * @brief Check if timer has been initialized.
 *
 * @return
 *  - true: the timer has been initialized using ccomp_timer_impl_init
 *  - false: the timer has not been initialized, or ccomp_timer_impl_deinit has been called recently
 */
bool ccomp_timer_impl_is_init(void);

/**
 * @brief Check if timer is keeping time.
 *
 * @return
 *  - true: the timer is keeping track of elapsed time from ccomp_timer_impl_start
 *  - false: the timer is not keeping track of elapsed time since ccomp_timer_impl_start has not yet been called or ccomp_timer_impl_stop has been called recently
 */
bool ccomp_timer_impl_is_active(void);