Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
mbed-os/features/mbedtls/inc/mbedtls/platform.h@0:8fdf9a60065b, 2018-10-10 (annotated)
- Committer:
- kadonotakashi
- Date:
- Wed Oct 10 00:33:53 2018 +0000
- Revision:
- 0:8fdf9a60065b
how to make mbed librry
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| kadonotakashi | 0:8fdf9a60065b | 1 | /** |
| kadonotakashi | 0:8fdf9a60065b | 2 | * \file platform.h |
| kadonotakashi | 0:8fdf9a60065b | 3 | * |
| kadonotakashi | 0:8fdf9a60065b | 4 | * \brief This file contains the definitions and functions of the |
| kadonotakashi | 0:8fdf9a60065b | 5 | * Mbed TLS platform abstraction layer. |
| kadonotakashi | 0:8fdf9a60065b | 6 | * |
| kadonotakashi | 0:8fdf9a60065b | 7 | * The platform abstraction layer removes the need for the library |
| kadonotakashi | 0:8fdf9a60065b | 8 | * to directly link to standard C library functions or operating |
| kadonotakashi | 0:8fdf9a60065b | 9 | * system services, making the library easier to port and embed. |
| kadonotakashi | 0:8fdf9a60065b | 10 | * Application developers and users of the library can provide their own |
| kadonotakashi | 0:8fdf9a60065b | 11 | * implementations of these functions, or implementations specific to |
| kadonotakashi | 0:8fdf9a60065b | 12 | * their platform, which can be statically linked to the library or |
| kadonotakashi | 0:8fdf9a60065b | 13 | * dynamically configured at runtime. |
| kadonotakashi | 0:8fdf9a60065b | 14 | */ |
| kadonotakashi | 0:8fdf9a60065b | 15 | /* |
| kadonotakashi | 0:8fdf9a60065b | 16 | * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved |
| kadonotakashi | 0:8fdf9a60065b | 17 | * SPDX-License-Identifier: Apache-2.0 |
| kadonotakashi | 0:8fdf9a60065b | 18 | * |
| kadonotakashi | 0:8fdf9a60065b | 19 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| kadonotakashi | 0:8fdf9a60065b | 20 | * not use this file except in compliance with the License. |
| kadonotakashi | 0:8fdf9a60065b | 21 | * You may obtain a copy of the License at |
| kadonotakashi | 0:8fdf9a60065b | 22 | * |
| kadonotakashi | 0:8fdf9a60065b | 23 | * http://www.apache.org/licenses/LICENSE-2.0 |
| kadonotakashi | 0:8fdf9a60065b | 24 | * |
| kadonotakashi | 0:8fdf9a60065b | 25 | * Unless required by applicable law or agreed to in writing, software |
| kadonotakashi | 0:8fdf9a60065b | 26 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| kadonotakashi | 0:8fdf9a60065b | 27 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| kadonotakashi | 0:8fdf9a60065b | 28 | * See the License for the specific language governing permissions and |
| kadonotakashi | 0:8fdf9a60065b | 29 | * limitations under the License. |
| kadonotakashi | 0:8fdf9a60065b | 30 | * |
| kadonotakashi | 0:8fdf9a60065b | 31 | * This file is part of Mbed TLS (https://tls.mbed.org) |
| kadonotakashi | 0:8fdf9a60065b | 32 | */ |
| kadonotakashi | 0:8fdf9a60065b | 33 | #ifndef MBEDTLS_PLATFORM_H |
| kadonotakashi | 0:8fdf9a60065b | 34 | #define MBEDTLS_PLATFORM_H |
| kadonotakashi | 0:8fdf9a60065b | 35 | |
| kadonotakashi | 0:8fdf9a60065b | 36 | #if !defined(MBEDTLS_CONFIG_FILE) |
| kadonotakashi | 0:8fdf9a60065b | 37 | #include "config.h" |
| kadonotakashi | 0:8fdf9a60065b | 38 | #else |
| kadonotakashi | 0:8fdf9a60065b | 39 | #include MBEDTLS_CONFIG_FILE |
| kadonotakashi | 0:8fdf9a60065b | 40 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 41 | |
| kadonotakashi | 0:8fdf9a60065b | 42 | #if defined(MBEDTLS_HAVE_TIME) |
| kadonotakashi | 0:8fdf9a60065b | 43 | #include "platform_time.h" |
| kadonotakashi | 0:8fdf9a60065b | 44 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 45 | |
| kadonotakashi | 0:8fdf9a60065b | 46 | #ifdef __cplusplus |
| kadonotakashi | 0:8fdf9a60065b | 47 | extern "C" { |
| kadonotakashi | 0:8fdf9a60065b | 48 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 49 | |
| kadonotakashi | 0:8fdf9a60065b | 50 | /** |
| kadonotakashi | 0:8fdf9a60065b | 51 | * \name SECTION: Module settings |
| kadonotakashi | 0:8fdf9a60065b | 52 | * |
| kadonotakashi | 0:8fdf9a60065b | 53 | * The configuration options you can set for this module are in this section. |
| kadonotakashi | 0:8fdf9a60065b | 54 | * Either change them in config.h or define them on the compiler command line. |
| kadonotakashi | 0:8fdf9a60065b | 55 | * \{ |
| kadonotakashi | 0:8fdf9a60065b | 56 | */ |
| kadonotakashi | 0:8fdf9a60065b | 57 | |
| kadonotakashi | 0:8fdf9a60065b | 58 | #if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS) |
| kadonotakashi | 0:8fdf9a60065b | 59 | #include <stdio.h> |
| kadonotakashi | 0:8fdf9a60065b | 60 | #include <stdlib.h> |
| kadonotakashi | 0:8fdf9a60065b | 61 | #include <time.h> |
| kadonotakashi | 0:8fdf9a60065b | 62 | #if !defined(MBEDTLS_PLATFORM_STD_SNPRINTF) |
| kadonotakashi | 0:8fdf9a60065b | 63 | #if defined(_WIN32) |
| kadonotakashi | 0:8fdf9a60065b | 64 | #define MBEDTLS_PLATFORM_STD_SNPRINTF mbedtls_platform_win32_snprintf /**< The default \c snprintf function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 65 | #else |
| kadonotakashi | 0:8fdf9a60065b | 66 | #define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< The default \c snprintf function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 67 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 68 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 69 | #if !defined(MBEDTLS_PLATFORM_STD_PRINTF) |
| kadonotakashi | 0:8fdf9a60065b | 70 | #define MBEDTLS_PLATFORM_STD_PRINTF printf /**< The default \c printf function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 71 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 72 | #if !defined(MBEDTLS_PLATFORM_STD_FPRINTF) |
| kadonotakashi | 0:8fdf9a60065b | 73 | #define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< The default \c fprintf function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 74 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 75 | #if !defined(MBEDTLS_PLATFORM_STD_CALLOC) |
| kadonotakashi | 0:8fdf9a60065b | 76 | #define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< The default \c calloc function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 77 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 78 | #if !defined(MBEDTLS_PLATFORM_STD_FREE) |
| kadonotakashi | 0:8fdf9a60065b | 79 | #define MBEDTLS_PLATFORM_STD_FREE free /**< The default \c free function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 80 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 81 | #if !defined(MBEDTLS_PLATFORM_STD_EXIT) |
| kadonotakashi | 0:8fdf9a60065b | 82 | #define MBEDTLS_PLATFORM_STD_EXIT exit /**< The default \c exit function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 83 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 84 | #if !defined(MBEDTLS_PLATFORM_STD_TIME) |
| kadonotakashi | 0:8fdf9a60065b | 85 | #define MBEDTLS_PLATFORM_STD_TIME time /**< The default \c time function to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 86 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 87 | #if !defined(MBEDTLS_PLATFORM_STD_EXIT_SUCCESS) |
| kadonotakashi | 0:8fdf9a60065b | 88 | #define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS EXIT_SUCCESS /**< The default exit value to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 89 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 90 | #if !defined(MBEDTLS_PLATFORM_STD_EXIT_FAILURE) |
| kadonotakashi | 0:8fdf9a60065b | 91 | #define MBEDTLS_PLATFORM_STD_EXIT_FAILURE EXIT_FAILURE /**< The default exit value to use. */ |
| kadonotakashi | 0:8fdf9a60065b | 92 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 93 | #if defined(MBEDTLS_FS_IO) |
| kadonotakashi | 0:8fdf9a60065b | 94 | #if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_READ) |
| kadonotakashi | 0:8fdf9a60065b | 95 | #define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read |
| kadonotakashi | 0:8fdf9a60065b | 96 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 97 | #if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_WRITE) |
| kadonotakashi | 0:8fdf9a60065b | 98 | #define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write |
| kadonotakashi | 0:8fdf9a60065b | 99 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 100 | #if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_FILE) |
| kadonotakashi | 0:8fdf9a60065b | 101 | #define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" |
| kadonotakashi | 0:8fdf9a60065b | 102 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 103 | #endif /* MBEDTLS_FS_IO */ |
| kadonotakashi | 0:8fdf9a60065b | 104 | #else /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */ |
| kadonotakashi | 0:8fdf9a60065b | 105 | #if defined(MBEDTLS_PLATFORM_STD_MEM_HDR) |
| kadonotakashi | 0:8fdf9a60065b | 106 | #include MBEDTLS_PLATFORM_STD_MEM_HDR |
| kadonotakashi | 0:8fdf9a60065b | 107 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 108 | #endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */ |
| kadonotakashi | 0:8fdf9a60065b | 109 | |
| kadonotakashi | 0:8fdf9a60065b | 110 | |
| kadonotakashi | 0:8fdf9a60065b | 111 | /* \} name SECTION: Module settings */ |
| kadonotakashi | 0:8fdf9a60065b | 112 | |
| kadonotakashi | 0:8fdf9a60065b | 113 | /* |
| kadonotakashi | 0:8fdf9a60065b | 114 | * The function pointers for calloc and free. |
| kadonotakashi | 0:8fdf9a60065b | 115 | */ |
| kadonotakashi | 0:8fdf9a60065b | 116 | #if defined(MBEDTLS_PLATFORM_MEMORY) |
| kadonotakashi | 0:8fdf9a60065b | 117 | #if defined(MBEDTLS_PLATFORM_FREE_MACRO) && \ |
| kadonotakashi | 0:8fdf9a60065b | 118 | defined(MBEDTLS_PLATFORM_CALLOC_MACRO) |
| kadonotakashi | 0:8fdf9a60065b | 119 | #define mbedtls_free MBEDTLS_PLATFORM_FREE_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 120 | #define mbedtls_calloc MBEDTLS_PLATFORM_CALLOC_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 121 | #else |
| kadonotakashi | 0:8fdf9a60065b | 122 | /* For size_t */ |
| kadonotakashi | 0:8fdf9a60065b | 123 | #include <stddef.h> |
| kadonotakashi | 0:8fdf9a60065b | 124 | extern void *mbedtls_calloc( size_t n, size_t size ); |
| kadonotakashi | 0:8fdf9a60065b | 125 | extern void mbedtls_free( void *ptr ); |
| kadonotakashi | 0:8fdf9a60065b | 126 | |
| kadonotakashi | 0:8fdf9a60065b | 127 | /** |
| kadonotakashi | 0:8fdf9a60065b | 128 | * \brief This function dynamically sets the memory-management |
| kadonotakashi | 0:8fdf9a60065b | 129 | * functions used by the library, during runtime. |
| kadonotakashi | 0:8fdf9a60065b | 130 | * |
| kadonotakashi | 0:8fdf9a60065b | 131 | * \param calloc_func The \c calloc function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 132 | * \param free_func The \c free function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 133 | * |
| kadonotakashi | 0:8fdf9a60065b | 134 | * \return \c 0. |
| kadonotakashi | 0:8fdf9a60065b | 135 | */ |
| kadonotakashi | 0:8fdf9a60065b | 136 | int mbedtls_platform_set_calloc_free( void * (*calloc_func)( size_t, size_t ), |
| kadonotakashi | 0:8fdf9a60065b | 137 | void (*free_func)( void * ) ); |
| kadonotakashi | 0:8fdf9a60065b | 138 | #endif /* MBEDTLS_PLATFORM_FREE_MACRO && MBEDTLS_PLATFORM_CALLOC_MACRO */ |
| kadonotakashi | 0:8fdf9a60065b | 139 | #else /* !MBEDTLS_PLATFORM_MEMORY */ |
| kadonotakashi | 0:8fdf9a60065b | 140 | #define mbedtls_free free |
| kadonotakashi | 0:8fdf9a60065b | 141 | #define mbedtls_calloc calloc |
| kadonotakashi | 0:8fdf9a60065b | 142 | #endif /* MBEDTLS_PLATFORM_MEMORY && !MBEDTLS_PLATFORM_{FREE,CALLOC}_MACRO */ |
| kadonotakashi | 0:8fdf9a60065b | 143 | |
| kadonotakashi | 0:8fdf9a60065b | 144 | /* |
| kadonotakashi | 0:8fdf9a60065b | 145 | * The function pointers for fprintf |
| kadonotakashi | 0:8fdf9a60065b | 146 | */ |
| kadonotakashi | 0:8fdf9a60065b | 147 | #if defined(MBEDTLS_PLATFORM_FPRINTF_ALT) |
| kadonotakashi | 0:8fdf9a60065b | 148 | /* We need FILE * */ |
| kadonotakashi | 0:8fdf9a60065b | 149 | #include <stdio.h> |
| kadonotakashi | 0:8fdf9a60065b | 150 | extern int (*mbedtls_fprintf)( FILE *stream, const char *format, ... ); |
| kadonotakashi | 0:8fdf9a60065b | 151 | |
| kadonotakashi | 0:8fdf9a60065b | 152 | /** |
| kadonotakashi | 0:8fdf9a60065b | 153 | * \brief This function dynamically configures the fprintf |
| kadonotakashi | 0:8fdf9a60065b | 154 | * function that is called when the |
| kadonotakashi | 0:8fdf9a60065b | 155 | * mbedtls_fprintf() function is invoked by the library. |
| kadonotakashi | 0:8fdf9a60065b | 156 | * |
| kadonotakashi | 0:8fdf9a60065b | 157 | * \param fprintf_func The \c fprintf function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 158 | * |
| kadonotakashi | 0:8fdf9a60065b | 159 | * \return \c 0. |
| kadonotakashi | 0:8fdf9a60065b | 160 | */ |
| kadonotakashi | 0:8fdf9a60065b | 161 | int mbedtls_platform_set_fprintf( int (*fprintf_func)( FILE *stream, const char *, |
| kadonotakashi | 0:8fdf9a60065b | 162 | ... ) ); |
| kadonotakashi | 0:8fdf9a60065b | 163 | #else |
| kadonotakashi | 0:8fdf9a60065b | 164 | #if defined(MBEDTLS_PLATFORM_FPRINTF_MACRO) |
| kadonotakashi | 0:8fdf9a60065b | 165 | #define mbedtls_fprintf MBEDTLS_PLATFORM_FPRINTF_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 166 | #else |
| kadonotakashi | 0:8fdf9a60065b | 167 | #define mbedtls_fprintf fprintf |
| kadonotakashi | 0:8fdf9a60065b | 168 | #endif /* MBEDTLS_PLATFORM_FPRINTF_MACRO */ |
| kadonotakashi | 0:8fdf9a60065b | 169 | #endif /* MBEDTLS_PLATFORM_FPRINTF_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 170 | |
| kadonotakashi | 0:8fdf9a60065b | 171 | /* |
| kadonotakashi | 0:8fdf9a60065b | 172 | * The function pointers for printf |
| kadonotakashi | 0:8fdf9a60065b | 173 | */ |
| kadonotakashi | 0:8fdf9a60065b | 174 | #if defined(MBEDTLS_PLATFORM_PRINTF_ALT) |
| kadonotakashi | 0:8fdf9a60065b | 175 | extern int (*mbedtls_printf)( const char *format, ... ); |
| kadonotakashi | 0:8fdf9a60065b | 176 | |
| kadonotakashi | 0:8fdf9a60065b | 177 | /** |
| kadonotakashi | 0:8fdf9a60065b | 178 | * \brief This function dynamically configures the snprintf |
| kadonotakashi | 0:8fdf9a60065b | 179 | * function that is called when the mbedtls_snprintf() |
| kadonotakashi | 0:8fdf9a60065b | 180 | * function is invoked by the library. |
| kadonotakashi | 0:8fdf9a60065b | 181 | * |
| kadonotakashi | 0:8fdf9a60065b | 182 | * \param printf_func The \c printf function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 183 | * |
| kadonotakashi | 0:8fdf9a60065b | 184 | * \return \c 0 on success. |
| kadonotakashi | 0:8fdf9a60065b | 185 | */ |
| kadonotakashi | 0:8fdf9a60065b | 186 | int mbedtls_platform_set_printf( int (*printf_func)( const char *, ... ) ); |
| kadonotakashi | 0:8fdf9a60065b | 187 | #else /* !MBEDTLS_PLATFORM_PRINTF_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 188 | #if defined(MBEDTLS_PLATFORM_PRINTF_MACRO) |
| kadonotakashi | 0:8fdf9a60065b | 189 | #define mbedtls_printf MBEDTLS_PLATFORM_PRINTF_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 190 | #else |
| kadonotakashi | 0:8fdf9a60065b | 191 | #define mbedtls_printf printf |
| kadonotakashi | 0:8fdf9a60065b | 192 | #endif /* MBEDTLS_PLATFORM_PRINTF_MACRO */ |
| kadonotakashi | 0:8fdf9a60065b | 193 | #endif /* MBEDTLS_PLATFORM_PRINTF_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 194 | |
| kadonotakashi | 0:8fdf9a60065b | 195 | /* |
| kadonotakashi | 0:8fdf9a60065b | 196 | * The function pointers for snprintf |
| kadonotakashi | 0:8fdf9a60065b | 197 | * |
| kadonotakashi | 0:8fdf9a60065b | 198 | * The snprintf implementation should conform to C99: |
| kadonotakashi | 0:8fdf9a60065b | 199 | * - it *must* always correctly zero-terminate the buffer |
| kadonotakashi | 0:8fdf9a60065b | 200 | * (except when n == 0, then it must leave the buffer untouched) |
| kadonotakashi | 0:8fdf9a60065b | 201 | * - however it is acceptable to return -1 instead of the required length when |
| kadonotakashi | 0:8fdf9a60065b | 202 | * the destination buffer is too short. |
| kadonotakashi | 0:8fdf9a60065b | 203 | */ |
| kadonotakashi | 0:8fdf9a60065b | 204 | #if defined(_WIN32) |
| kadonotakashi | 0:8fdf9a60065b | 205 | /* For Windows (inc. MSYS2), we provide our own fixed implementation */ |
| kadonotakashi | 0:8fdf9a60065b | 206 | int mbedtls_platform_win32_snprintf( char *s, size_t n, const char *fmt, ... ); |
| kadonotakashi | 0:8fdf9a60065b | 207 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 208 | |
| kadonotakashi | 0:8fdf9a60065b | 209 | #if defined(MBEDTLS_PLATFORM_SNPRINTF_ALT) |
| kadonotakashi | 0:8fdf9a60065b | 210 | extern int (*mbedtls_snprintf)( char * s, size_t n, const char * format, ... ); |
| kadonotakashi | 0:8fdf9a60065b | 211 | |
| kadonotakashi | 0:8fdf9a60065b | 212 | /** |
| kadonotakashi | 0:8fdf9a60065b | 213 | * \brief This function allows configuring a custom |
| kadonotakashi | 0:8fdf9a60065b | 214 | * \c snprintf function pointer. |
| kadonotakashi | 0:8fdf9a60065b | 215 | * |
| kadonotakashi | 0:8fdf9a60065b | 216 | * \param snprintf_func The \c snprintf function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 217 | * |
| kadonotakashi | 0:8fdf9a60065b | 218 | * \return \c 0 on success. |
| kadonotakashi | 0:8fdf9a60065b | 219 | */ |
| kadonotakashi | 0:8fdf9a60065b | 220 | int mbedtls_platform_set_snprintf( int (*snprintf_func)( char * s, size_t n, |
| kadonotakashi | 0:8fdf9a60065b | 221 | const char * format, ... ) ); |
| kadonotakashi | 0:8fdf9a60065b | 222 | #else /* MBEDTLS_PLATFORM_SNPRINTF_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 223 | #if defined(MBEDTLS_PLATFORM_SNPRINTF_MACRO) |
| kadonotakashi | 0:8fdf9a60065b | 224 | #define mbedtls_snprintf MBEDTLS_PLATFORM_SNPRINTF_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 225 | #else |
| kadonotakashi | 0:8fdf9a60065b | 226 | #define mbedtls_snprintf MBEDTLS_PLATFORM_STD_SNPRINTF |
| kadonotakashi | 0:8fdf9a60065b | 227 | #endif /* MBEDTLS_PLATFORM_SNPRINTF_MACRO */ |
| kadonotakashi | 0:8fdf9a60065b | 228 | #endif /* MBEDTLS_PLATFORM_SNPRINTF_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 229 | |
| kadonotakashi | 0:8fdf9a60065b | 230 | /* |
| kadonotakashi | 0:8fdf9a60065b | 231 | * The function pointers for exit |
| kadonotakashi | 0:8fdf9a60065b | 232 | */ |
| kadonotakashi | 0:8fdf9a60065b | 233 | #if defined(MBEDTLS_PLATFORM_EXIT_ALT) |
| kadonotakashi | 0:8fdf9a60065b | 234 | extern void (*mbedtls_exit)( int status ); |
| kadonotakashi | 0:8fdf9a60065b | 235 | |
| kadonotakashi | 0:8fdf9a60065b | 236 | /** |
| kadonotakashi | 0:8fdf9a60065b | 237 | * \brief This function dynamically configures the exit |
| kadonotakashi | 0:8fdf9a60065b | 238 | * function that is called when the mbedtls_exit() |
| kadonotakashi | 0:8fdf9a60065b | 239 | * function is invoked by the library. |
| kadonotakashi | 0:8fdf9a60065b | 240 | * |
| kadonotakashi | 0:8fdf9a60065b | 241 | * \param exit_func The \c exit function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 242 | * |
| kadonotakashi | 0:8fdf9a60065b | 243 | * \return \c 0 on success. |
| kadonotakashi | 0:8fdf9a60065b | 244 | */ |
| kadonotakashi | 0:8fdf9a60065b | 245 | int mbedtls_platform_set_exit( void (*exit_func)( int status ) ); |
| kadonotakashi | 0:8fdf9a60065b | 246 | #else |
| kadonotakashi | 0:8fdf9a60065b | 247 | #if defined(MBEDTLS_PLATFORM_EXIT_MACRO) |
| kadonotakashi | 0:8fdf9a60065b | 248 | #define mbedtls_exit MBEDTLS_PLATFORM_EXIT_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 249 | #else |
| kadonotakashi | 0:8fdf9a60065b | 250 | #define mbedtls_exit exit |
| kadonotakashi | 0:8fdf9a60065b | 251 | #endif /* MBEDTLS_PLATFORM_EXIT_MACRO */ |
| kadonotakashi | 0:8fdf9a60065b | 252 | #endif /* MBEDTLS_PLATFORM_EXIT_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 253 | |
| kadonotakashi | 0:8fdf9a60065b | 254 | /* |
| kadonotakashi | 0:8fdf9a60065b | 255 | * The default exit values |
| kadonotakashi | 0:8fdf9a60065b | 256 | */ |
| kadonotakashi | 0:8fdf9a60065b | 257 | #if defined(MBEDTLS_PLATFORM_STD_EXIT_SUCCESS) |
| kadonotakashi | 0:8fdf9a60065b | 258 | #define MBEDTLS_EXIT_SUCCESS MBEDTLS_PLATFORM_STD_EXIT_SUCCESS |
| kadonotakashi | 0:8fdf9a60065b | 259 | #else |
| kadonotakashi | 0:8fdf9a60065b | 260 | #define MBEDTLS_EXIT_SUCCESS 0 |
| kadonotakashi | 0:8fdf9a60065b | 261 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 262 | #if defined(MBEDTLS_PLATFORM_STD_EXIT_FAILURE) |
| kadonotakashi | 0:8fdf9a60065b | 263 | #define MBEDTLS_EXIT_FAILURE MBEDTLS_PLATFORM_STD_EXIT_FAILURE |
| kadonotakashi | 0:8fdf9a60065b | 264 | #else |
| kadonotakashi | 0:8fdf9a60065b | 265 | #define MBEDTLS_EXIT_FAILURE 1 |
| kadonotakashi | 0:8fdf9a60065b | 266 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 267 | |
| kadonotakashi | 0:8fdf9a60065b | 268 | /* |
| kadonotakashi | 0:8fdf9a60065b | 269 | * The function pointers for reading from and writing a seed file to |
| kadonotakashi | 0:8fdf9a60065b | 270 | * Non-Volatile storage (NV) in a platform-independent way |
| kadonotakashi | 0:8fdf9a60065b | 271 | * |
| kadonotakashi | 0:8fdf9a60065b | 272 | * Only enabled when the NV seed entropy source is enabled |
| kadonotakashi | 0:8fdf9a60065b | 273 | */ |
| kadonotakashi | 0:8fdf9a60065b | 274 | #if defined(MBEDTLS_ENTROPY_NV_SEED) |
| kadonotakashi | 0:8fdf9a60065b | 275 | #if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS) && defined(MBEDTLS_FS_IO) |
| kadonotakashi | 0:8fdf9a60065b | 276 | /* Internal standard platform definitions */ |
| kadonotakashi | 0:8fdf9a60065b | 277 | int mbedtls_platform_std_nv_seed_read( unsigned char *buf, size_t buf_len ); |
| kadonotakashi | 0:8fdf9a60065b | 278 | int mbedtls_platform_std_nv_seed_write( unsigned char *buf, size_t buf_len ); |
| kadonotakashi | 0:8fdf9a60065b | 279 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 280 | |
| kadonotakashi | 0:8fdf9a60065b | 281 | #if defined(MBEDTLS_PLATFORM_NV_SEED_ALT) |
| kadonotakashi | 0:8fdf9a60065b | 282 | extern int (*mbedtls_nv_seed_read)( unsigned char *buf, size_t buf_len ); |
| kadonotakashi | 0:8fdf9a60065b | 283 | extern int (*mbedtls_nv_seed_write)( unsigned char *buf, size_t buf_len ); |
| kadonotakashi | 0:8fdf9a60065b | 284 | |
| kadonotakashi | 0:8fdf9a60065b | 285 | /** |
| kadonotakashi | 0:8fdf9a60065b | 286 | * \brief This function allows configuring custom seed file writing and |
| kadonotakashi | 0:8fdf9a60065b | 287 | * reading functions. |
| kadonotakashi | 0:8fdf9a60065b | 288 | * |
| kadonotakashi | 0:8fdf9a60065b | 289 | * \param nv_seed_read_func The seed reading function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 290 | * \param nv_seed_write_func The seed writing function implementation. |
| kadonotakashi | 0:8fdf9a60065b | 291 | * |
| kadonotakashi | 0:8fdf9a60065b | 292 | * \return \c 0 on success. |
| kadonotakashi | 0:8fdf9a60065b | 293 | */ |
| kadonotakashi | 0:8fdf9a60065b | 294 | int mbedtls_platform_set_nv_seed( |
| kadonotakashi | 0:8fdf9a60065b | 295 | int (*nv_seed_read_func)( unsigned char *buf, size_t buf_len ), |
| kadonotakashi | 0:8fdf9a60065b | 296 | int (*nv_seed_write_func)( unsigned char *buf, size_t buf_len ) |
| kadonotakashi | 0:8fdf9a60065b | 297 | ); |
| kadonotakashi | 0:8fdf9a60065b | 298 | #else |
| kadonotakashi | 0:8fdf9a60065b | 299 | #if defined(MBEDTLS_PLATFORM_NV_SEED_READ_MACRO) && \ |
| kadonotakashi | 0:8fdf9a60065b | 300 | defined(MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO) |
| kadonotakashi | 0:8fdf9a60065b | 301 | #define mbedtls_nv_seed_read MBEDTLS_PLATFORM_NV_SEED_READ_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 302 | #define mbedtls_nv_seed_write MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO |
| kadonotakashi | 0:8fdf9a60065b | 303 | #else |
| kadonotakashi | 0:8fdf9a60065b | 304 | #define mbedtls_nv_seed_read mbedtls_platform_std_nv_seed_read |
| kadonotakashi | 0:8fdf9a60065b | 305 | #define mbedtls_nv_seed_write mbedtls_platform_std_nv_seed_write |
| kadonotakashi | 0:8fdf9a60065b | 306 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 307 | #endif /* MBEDTLS_PLATFORM_NV_SEED_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 308 | #endif /* MBEDTLS_ENTROPY_NV_SEED */ |
| kadonotakashi | 0:8fdf9a60065b | 309 | |
| kadonotakashi | 0:8fdf9a60065b | 310 | #if !defined(MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT) |
| kadonotakashi | 0:8fdf9a60065b | 311 | |
| kadonotakashi | 0:8fdf9a60065b | 312 | /** |
| kadonotakashi | 0:8fdf9a60065b | 313 | * \brief The platform context structure. |
| kadonotakashi | 0:8fdf9a60065b | 314 | * |
| kadonotakashi | 0:8fdf9a60065b | 315 | * \note This structure may be used to assist platform-specific |
| kadonotakashi | 0:8fdf9a60065b | 316 | * setup or teardown operations. |
| kadonotakashi | 0:8fdf9a60065b | 317 | */ |
| kadonotakashi | 0:8fdf9a60065b | 318 | typedef struct mbedtls_platform_context |
| kadonotakashi | 0:8fdf9a60065b | 319 | { |
| kadonotakashi | 0:8fdf9a60065b | 320 | char dummy; /**< A placeholder member, as empty structs are not portable. */ |
| kadonotakashi | 0:8fdf9a60065b | 321 | } |
| kadonotakashi | 0:8fdf9a60065b | 322 | mbedtls_platform_context; |
| kadonotakashi | 0:8fdf9a60065b | 323 | |
| kadonotakashi | 0:8fdf9a60065b | 324 | #else |
| kadonotakashi | 0:8fdf9a60065b | 325 | #include "platform_alt.h" |
| kadonotakashi | 0:8fdf9a60065b | 326 | #endif /* !MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT */ |
| kadonotakashi | 0:8fdf9a60065b | 327 | |
| kadonotakashi | 0:8fdf9a60065b | 328 | /** |
| kadonotakashi | 0:8fdf9a60065b | 329 | * \brief This function performs any platform-specific initialization |
| kadonotakashi | 0:8fdf9a60065b | 330 | * operations. |
| kadonotakashi | 0:8fdf9a60065b | 331 | * |
| kadonotakashi | 0:8fdf9a60065b | 332 | * \note This function should be called before any other library functions. |
| kadonotakashi | 0:8fdf9a60065b | 333 | * |
| kadonotakashi | 0:8fdf9a60065b | 334 | * Its implementation is platform-specific, and unless |
| kadonotakashi | 0:8fdf9a60065b | 335 | * platform-specific code is provided, it does nothing. |
| kadonotakashi | 0:8fdf9a60065b | 336 | * |
| kadonotakashi | 0:8fdf9a60065b | 337 | * \note The usage and necessity of this function is dependent on the platform. |
| kadonotakashi | 0:8fdf9a60065b | 338 | * |
| kadonotakashi | 0:8fdf9a60065b | 339 | * \param ctx The platform context. |
| kadonotakashi | 0:8fdf9a60065b | 340 | * |
| kadonotakashi | 0:8fdf9a60065b | 341 | * \return \c 0 on success. |
| kadonotakashi | 0:8fdf9a60065b | 342 | */ |
| kadonotakashi | 0:8fdf9a60065b | 343 | int mbedtls_platform_setup( mbedtls_platform_context *ctx ); |
| kadonotakashi | 0:8fdf9a60065b | 344 | /** |
| kadonotakashi | 0:8fdf9a60065b | 345 | * \brief This function performs any platform teardown operations. |
| kadonotakashi | 0:8fdf9a60065b | 346 | * |
| kadonotakashi | 0:8fdf9a60065b | 347 | * \note This function should be called after every other Mbed TLS module |
| kadonotakashi | 0:8fdf9a60065b | 348 | * has been correctly freed using the appropriate free function. |
| kadonotakashi | 0:8fdf9a60065b | 349 | * |
| kadonotakashi | 0:8fdf9a60065b | 350 | * Its implementation is platform-specific, and unless |
| kadonotakashi | 0:8fdf9a60065b | 351 | * platform-specific code is provided, it does nothing. |
| kadonotakashi | 0:8fdf9a60065b | 352 | * |
| kadonotakashi | 0:8fdf9a60065b | 353 | * \note The usage and necessity of this function is dependent on the platform. |
| kadonotakashi | 0:8fdf9a60065b | 354 | * |
| kadonotakashi | 0:8fdf9a60065b | 355 | * \param ctx The platform context. |
| kadonotakashi | 0:8fdf9a60065b | 356 | * |
| kadonotakashi | 0:8fdf9a60065b | 357 | */ |
| kadonotakashi | 0:8fdf9a60065b | 358 | void mbedtls_platform_teardown( mbedtls_platform_context *ctx ); |
| kadonotakashi | 0:8fdf9a60065b | 359 | |
| kadonotakashi | 0:8fdf9a60065b | 360 | #ifdef __cplusplus |
| kadonotakashi | 0:8fdf9a60065b | 361 | } |
| kadonotakashi | 0:8fdf9a60065b | 362 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 363 | |
| kadonotakashi | 0:8fdf9a60065b | 364 | #endif /* platform.h */ |