blob: 8d4b95d1db38651fff1619203f259534b922ef26 [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
31/**
32 * \name SECTION: Module settings
33 *
34 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020035 * Either change them in mbedtls_config.h or define them on the compiler command line.
Simon Butcher86311432016-07-12 13:11:00 +010036 * \{
37 */
38
39/*
40 * The time_t datatype
41 */
42#if defined(MBEDTLS_PLATFORM_TIME_TYPE_MACRO)
43typedef MBEDTLS_PLATFORM_TIME_TYPE_MACRO mbedtls_time_t;
44#else
45/* For time_t */
46#include <time.h>
47typedef time_t mbedtls_time_t;
48#endif /* MBEDTLS_PLATFORM_TIME_TYPE_MACRO */
49
50/*
51 * The function pointers for time
52 */
53#if defined(MBEDTLS_PLATFORM_TIME_ALT)
54extern mbedtls_time_t (*mbedtls_time)( mbedtls_time_t* time );
55
56/**
57 * \brief Set your own time function pointer
58 *
59 * \param time_func the time function implementation
60 *
61 * \return 0
62 */
63int mbedtls_platform_set_time( mbedtls_time_t (*time_func)( mbedtls_time_t* time ) );
64#else
65#if defined(MBEDTLS_PLATFORM_TIME_MACRO)
66#define mbedtls_time MBEDTLS_PLATFORM_TIME_MACRO
67#else
68#define mbedtls_time time
69#endif /* MBEDTLS_PLATFORM_TIME_MACRO */
70#endif /* MBEDTLS_PLATFORM_TIME_ALT */
71
72#ifdef __cplusplus
73}
74#endif
75
76#endif /* platform_time.h */