xref: /aosp_15_r20/external/pigweed/pw_chrono_freertos/public/pw_chrono_freertos/config.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2020 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 // Configuration macros for the tokenizer module.
15 #pragma once
16 
17 #include "FreeRTOS.h"
18 #include "pw_polyfill/static_assert.h"
19 
20 // Because the SystemClock::now() implementation requires the user to invoke it
21 // more than once per overflow period, the max timeout is set to ensure that
22 // blocking indefinitely on a single primitive will meet this constraint with
23 // margin (i.e. more than twice per overflow).
24 #ifndef PW_CHRONO_FREERTOS_CFG_MAX_TIMEOUT
25 #define PW_CHRONO_FREERTOS_CFG_MAX_TIMEOUT (portMAX_DELAY / 3)
26 #endif  // PW_CHRONO_FREERTOS_CFG_MAX_TIMEOUT
27 
28 static_assert((PW_CHRONO_FREERTOS_CFG_MAX_TIMEOUT > 0) &&
29                   (PW_CHRONO_FREERTOS_CFG_MAX_TIMEOUT <= portMAX_DELAY),
30               "Invalid MAX timeout configuration");
31