blob: a45870c3a65274092acd748b962d9d5d58573f0a [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/*
Simon Butcher86311432016-07-12 13:11:00 +01007 * Copyright (C) 2006-2016, ARM Limited, All Rights Reserved
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 * **********
48 *
Simon Butcher86311432016-07-12 13:11:00 +010049 * This file is part of mbed TLS (https://tls.mbed.org)
50 */
51#ifndef MBEDTLS_PLATFORM_TIME_H
52#define MBEDTLS_PLATFORM_TIME_H
53
54#if !defined(MBEDTLS_CONFIG_FILE)
55#include "config.h"
56#else
57#include MBEDTLS_CONFIG_FILE
58#endif
59
60#ifdef __cplusplus
61extern "C" {
62#endif
63
64/**
65 * \name SECTION: Module settings
66 *
67 * The configuration options you can set for this module are in this section.
68 * Either change them in config.h or define them on the compiler command line.
69 * \{
70 */
71
72/*
73 * The time_t datatype
74 */
75#if defined(MBEDTLS_PLATFORM_TIME_TYPE_MACRO)
76typedef MBEDTLS_PLATFORM_TIME_TYPE_MACRO mbedtls_time_t;
77#else
78/* For time_t */
79#include <time.h>
80typedef time_t mbedtls_time_t;
81#endif /* MBEDTLS_PLATFORM_TIME_TYPE_MACRO */
82
83/*
84 * The function pointers for time
85 */
86#if defined(MBEDTLS_PLATFORM_TIME_ALT)
87extern mbedtls_time_t (*mbedtls_time)( mbedtls_time_t* time );
88
89/**
90 * \brief Set your own time function pointer
91 *
92 * \param time_func the time function implementation
93 *
94 * \return 0
95 */
96int mbedtls_platform_set_time( mbedtls_time_t (*time_func)( mbedtls_time_t* time ) );
97#else
98#if defined(MBEDTLS_PLATFORM_TIME_MACRO)
99#define mbedtls_time MBEDTLS_PLATFORM_TIME_MACRO
100#else
101#define mbedtls_time time
102#endif /* MBEDTLS_PLATFORM_TIME_MACRO */
103#endif /* MBEDTLS_PLATFORM_TIME_ALT */
104
105#ifdef __cplusplus
106}
107#endif
108
109#endif /* platform_time.h */