blob: e132f6a688c00402ae211e24215ef3bbd97884d2 [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útia2947ac2020-08-19 16:37:36 +02007 * Copyright The Mbed TLS Contributors
Bence Szépkútif744bd72020-06-05 13:02:18 +02008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 *
10 * This file is provided under the Apache License 2.0, or the
11 * GNU General Public License v2.0 or later.
12 *
13 * **********
14 * Apache License 2.0:
Simon Butcher86311432016-07-12 13:11:00 +010015 *
16 * Licensed under the Apache License, Version 2.0 (the "License"); you may
17 * not use this file except in compliance with the License.
18 * You may obtain a copy of the License at
19 *
20 * http://www.apache.org/licenses/LICENSE-2.0
21 *
22 * Unless required by applicable law or agreed to in writing, software
23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25 * See the License for the specific language governing permissions and
26 * limitations under the License.
27 *
Bence Szépkútif744bd72020-06-05 13:02:18 +020028 * **********
29 *
30 * **********
31 * GNU General Public License v2.0 or later:
32 *
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
37 *
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
42 *
43 * You should have received a copy of the GNU General Public License along
44 * with this program; if not, write to the Free Software Foundation, Inc.,
45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46 *
47 * **********
Simon Butcher86311432016-07-12 13:11:00 +010048 */
49#ifndef MBEDTLS_PLATFORM_TIME_H
50#define MBEDTLS_PLATFORM_TIME_H
51
52#if !defined(MBEDTLS_CONFIG_FILE)
53#include "config.h"
54#else
55#include MBEDTLS_CONFIG_FILE
56#endif
57
58#ifdef __cplusplus
59extern "C" {
60#endif
61
62/**
63 * \name SECTION: Module settings
64 *
65 * The configuration options you can set for this module are in this section.
66 * Either change them in config.h or define them on the compiler command line.
67 * \{
68 */
69
70/*
71 * The time_t datatype
72 */
73#if defined(MBEDTLS_PLATFORM_TIME_TYPE_MACRO)
74typedef MBEDTLS_PLATFORM_TIME_TYPE_MACRO mbedtls_time_t;
75#else
76/* For time_t */
77#include <time.h>
78typedef time_t mbedtls_time_t;
79#endif /* MBEDTLS_PLATFORM_TIME_TYPE_MACRO */
80
81/*
82 * The function pointers for time
83 */
84#if defined(MBEDTLS_PLATFORM_TIME_ALT)
85extern mbedtls_time_t (*mbedtls_time)( mbedtls_time_t* time );
86
87/**
88 * \brief Set your own time function pointer
89 *
90 * \param time_func the time function implementation
91 *
92 * \return 0
93 */
94int mbedtls_platform_set_time( mbedtls_time_t (*time_func)( mbedtls_time_t* time ) );
95#else
96#if defined(MBEDTLS_PLATFORM_TIME_MACRO)
97#define mbedtls_time MBEDTLS_PLATFORM_TIME_MACRO
98#else
99#define mbedtls_time time
100#endif /* MBEDTLS_PLATFORM_TIME_MACRO */
101#endif /* MBEDTLS_PLATFORM_TIME_ALT */
102
103#ifdef __cplusplus
104}
105#endif
106
107#endif /* platform_time.h */