| /** |
| * \file timing.h |
| * |
| * \brief Portable interface to timeouts and to the CPU cycle counter |
| */ |
| /* |
| * Copyright The Mbed TLS Contributors |
| * SPDX-License-Identifier: Apache-2.0 |
| * |
| * 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. |
| */ |
| #ifndef MBEDTLS_TIMING_H |
| #define MBEDTLS_TIMING_H |
| #include "mbedtls/private_access.h" |
| |
| #if !defined(MBEDTLS_CONFIG_FILE) |
| #include "mbedtls/config.h" |
| #else |
| #include MBEDTLS_CONFIG_FILE |
| #endif |
| |
| #include <stdint.h> |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #if !defined(MBEDTLS_TIMING_ALT) |
| // Regular implementation |
| // |
| |
| /** |
| * \brief timer structure |
| */ |
| struct mbedtls_timing_hr_time |
| { |
| unsigned char MBEDTLS_PRIVATE(opaque)[32]; |
| }; |
| |
| /** |
| * \brief Context for mbedtls_timing_set/get_delay() |
| */ |
| typedef struct mbedtls_timing_delay_context |
| { |
| struct mbedtls_timing_hr_time MBEDTLS_PRIVATE(timer); |
| uint32_t MBEDTLS_PRIVATE(int_ms); |
| uint32_t MBEDTLS_PRIVATE(fin_ms); |
| } mbedtls_timing_delay_context; |
| |
| #else /* MBEDTLS_TIMING_ALT */ |
| #include "timing_alt.h" |
| #endif /* MBEDTLS_TIMING_ALT */ |
| |
| /* Internal use */ |
| unsigned long mbedtls_timing_get_timer( struct mbedtls_timing_hr_time *val, int reset ); |
| |
| /** |
| * \brief Set a pair of delays to watch |
| * (See \c mbedtls_timing_get_delay().) |
| * |
| * \param data Pointer to timing data. |
| * Must point to a valid \c mbedtls_timing_delay_context struct. |
| * \param int_ms First (intermediate) delay in milliseconds. |
| * The effect if int_ms > fin_ms is unspecified. |
| * \param fin_ms Second (final) delay in milliseconds. |
| * Pass 0 to cancel the current delay. |
| * |
| * \note To set a single delay, either use \c mbedtls_timing_set_timer |
| * directly or use this function with int_ms == fin_ms. |
| */ |
| void mbedtls_timing_set_delay( void *data, uint32_t int_ms, uint32_t fin_ms ); |
| |
| /** |
| * \brief Get the status of delays |
| * (Memory helper: number of delays passed.) |
| * |
| * \param data Pointer to timing data |
| * Must point to a valid \c mbedtls_timing_delay_context struct. |
| * |
| * \return -1 if cancelled (fin_ms = 0), |
| * 0 if none of the delays are passed, |
| * 1 if only the intermediate delay is passed, |
| * 2 if the final delay is passed. |
| */ |
| int mbedtls_timing_get_delay( void *data ); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* timing.h */ |