blob: e6f7e23bf4160ddb393000bd9e870edc7432c8c7 [file] [log] [blame]
Simon Butcher86311432016-07-12 13:11:00 +01001/**
2 * \file platform_time.h
3 *
4 * \brief mbed TLS Platform time abstraction
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Simon Butcher86311432016-07-12 13:11:00 +01008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Simon Butcher86311432016-07-12 13:11:00 +010021 */
22#ifndef MBEDTLS_PLATFORM_TIME_H
23#define MBEDTLS_PLATFORM_TIME_H
24
Bence Szépkútic662b362021-05-27 11:25:03 +020025#include "mbedtls/build_info.h"
Simon Butcher86311432016-07-12 13:11:00 +010026
27#ifdef __cplusplus
28extern "C" {
29#endif
30
Simon Butcher86311432016-07-12 13:11:00 +010031/*
32 * The time_t datatype
33 */
34#if defined(MBEDTLS_PLATFORM_TIME_TYPE_MACRO)
35typedef MBEDTLS_PLATFORM_TIME_TYPE_MACRO mbedtls_time_t;
36#else
37/* For time_t */
38#include <time.h>
39typedef time_t mbedtls_time_t;
40#endif /* MBEDTLS_PLATFORM_TIME_TYPE_MACRO */
41
Jerry Yueba0ab52022-12-15 17:41:41 +080042#if defined(MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO)
43typedef MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO mbedtls_ms_time_t;
44#else
45typedef signed long long mbedtls_ms_time_t;
46#endif /* MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO */
47
Simon Butcher86311432016-07-12 13:11:00 +010048/*
49 * The function pointers for time
50 */
51#if defined(MBEDTLS_PLATFORM_TIME_ALT)
Gilles Peskine449bd832023-01-11 14:50:10 +010052extern mbedtls_time_t (*mbedtls_time)(mbedtls_time_t *time);
Simon Butcher86311432016-07-12 13:11:00 +010053
54/**
55 * \brief Set your own time function pointer
56 *
57 * \param time_func the time function implementation
58 *
59 * \return 0
60 */
Gilles Peskine449bd832023-01-11 14:50:10 +010061int mbedtls_platform_set_time(mbedtls_time_t (*time_func)(mbedtls_time_t *time));
Simon Butcher86311432016-07-12 13:11:00 +010062#else
63#if defined(MBEDTLS_PLATFORM_TIME_MACRO)
64#define mbedtls_time MBEDTLS_PLATFORM_TIME_MACRO
65#else
66#define mbedtls_time time
67#endif /* MBEDTLS_PLATFORM_TIME_MACRO */
68#endif /* MBEDTLS_PLATFORM_TIME_ALT */
69
70#ifdef __cplusplus
71}
72#endif
73
Simon Butcher86311432016-07-12 13:11:00 +010074#endif /* platform_time.h */