pw_chrono_freertos/public/pw_chrono_freertos/system_timer_native.h

// Copyright 2021 The Pigweed Authors
//
// 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
//
//     https://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 "FreeRTOS.h"
#include "pw_chrono/system_clock.h"
#include "pw_function/function.h"
#include "timers.h"

namespace pw::chrono::backend {

struct NativeSystemTimer {
  StaticTimer_t tcb;
  enum class State {
    // Timer is not scheduled to execute the user's callback in the future. If
    // the native callback gets invoked it will do nothing if it in this state.
    // The native callback will also transition to this state before invoking
    // the user's callback.
    kCancelled = 0,

    // Timer is scheduled to execute the user's callback. If the native callback
    // gets invoked it will invoke the user's callback.
    kScheduled = 1,
  };
  State state;
  SystemClock::time_point expiry_deadline;
  Function<void(SystemClock::time_point expired_deadline)> user_callback;
};
using NativeSystemTimerHandle = NativeSystemTimer&;

}  // namespace pw::chrono::backend