xref: /aosp_15_r20/external/pigweed/pw_chrono_freertos/public/pw_chrono_freertos/system_timer_native.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2021 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #pragma once
15 
16 #include "FreeRTOS.h"
17 #include "pw_chrono/system_clock.h"
18 #include "pw_function/function.h"
19 #include "timers.h"
20 
21 namespace pw::chrono::backend {
22 
23 struct NativeSystemTimer {
24   StaticTimer_t tcb;
25   enum class State {
26     // Timer is not scheduled to execute the user's callback in the future. If
27     // the native callback gets invoked it will do nothing if it in this state.
28     // The native callback will also transition to this state before invoking
29     // the user's callback.
30     kCancelled = 0,
31 
32     // Timer is scheduled to execute the user's callback. If the native callback
33     // gets invoked it will invoke the user's callback.
34     kScheduled = 1,
35   };
36   State state;
37   SystemClock::time_point expiry_deadline;
38   Function<void(SystemClock::time_point expired_deadline)> user_callback;
39 };
40 using NativeSystemTimerHandle = NativeSystemTimer&;
41 
42 }  // namespace pw::chrono::backend
43