mbed TLS v2.6.0
Data Structures | Macros | Functions
platform.h File Reference

mbed TLS Platform abstraction layer More...

#include "config.h"
#include "mbedtls/platform_time.h"
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
Include dependency graph for platform.h:

Go to the source code of this file.

Data Structures

struct  mbedtls_platform_context
 Platform context structure. More...
 

Macros

#define mbedtls_free   free
 
#define mbedtls_calloc   calloc
 
#define mbedtls_fprintf   fprintf
 
#define mbedtls_printf   printf
 
#define mbedtls_snprintf   snprintf
 
#define mbedtls_exit   exit
 
#define MBEDTLS_EXIT_SUCCESS   MBEDTLS_PLATFORM_STD_EXIT_SUCCESS
 
#define MBEDTLS_EXIT_FAILURE   MBEDTLS_PLATFORM_STD_EXIT_FAILURE
 
SECTION: Module settings

The configuration options you can set for this module are in this section.

Either change them in config.h or define them on the compiler command line.

#define MBEDTLS_PLATFORM_STD_SNPRINTF   snprintf
 Default snprintf to use. More...
 
#define MBEDTLS_PLATFORM_STD_PRINTF   printf
 Default printf to use. More...
 
#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf
 Default fprintf to use. More...
 
#define MBEDTLS_PLATFORM_STD_CALLOC   calloc
 Default allocator to use. More...
 
#define MBEDTLS_PLATFORM_STD_FREE   free
 Default free to use. More...
 
#define MBEDTLS_PLATFORM_STD_EXIT   exit
 Default exit to use. More...
 
#define MBEDTLS_PLATFORM_STD_TIME   time
 Default time to use. More...
 
#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS
 Default exit value to use. More...
 
#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE
 Default exit value to use. More...
 
#define MBEDTLS_PLATFORM_STD_NV_SEED_READ   mbedtls_platform_std_nv_seed_read
 
#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE   mbedtls_platform_std_nv_seed_write
 
#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE   "seedfile"
 

Functions

int mbedtls_platform_setup (mbedtls_platform_context *ctx)
 Perform any platform initialisation operations. More...
 
void mbedtls_platform_teardown (mbedtls_platform_context *ctx)
 Perform any platform teardown operations. More...
 

Detailed Description

mbed TLS Platform abstraction layer

Copyright (C) 2006-2016, ARM Limited, All Rights Reserved SPDX-License-Identifier: GPL-2.0

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

This file is part of mbed TLS (https://tls.mbed.org)

Definition in file platform.h.

Macro Definition Documentation

#define mbedtls_calloc   calloc

Definition at line 132 of file platform.h.

#define mbedtls_exit   exit

Definition at line 234 of file platform.h.

#define MBEDTLS_EXIT_FAILURE   MBEDTLS_PLATFORM_STD_EXIT_FAILURE

Definition at line 247 of file platform.h.

#define MBEDTLS_EXIT_SUCCESS   MBEDTLS_PLATFORM_STD_EXIT_SUCCESS

Definition at line 242 of file platform.h.

#define mbedtls_fprintf   fprintf

Definition at line 156 of file platform.h.

#define mbedtls_free   free

Definition at line 131 of file platform.h.

#define MBEDTLS_PLATFORM_STD_CALLOC   calloc

Default allocator to use.

Definition at line 68 of file platform.h.

#define MBEDTLS_PLATFORM_STD_EXIT   exit

Default exit to use.

Definition at line 74 of file platform.h.

#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE

Default exit value to use.

Definition at line 83 of file platform.h.

#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS

Default exit value to use.

Definition at line 80 of file platform.h.

#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf

Default fprintf to use.

Definition at line 65 of file platform.h.

#define MBEDTLS_PLATFORM_STD_FREE   free

Default free to use.

Definition at line 71 of file platform.h.

#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE   "seedfile"

Definition at line 93 of file platform.h.

#define MBEDTLS_PLATFORM_STD_NV_SEED_READ   mbedtls_platform_std_nv_seed_read

Definition at line 87 of file platform.h.

#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE   mbedtls_platform_std_nv_seed_write

Definition at line 90 of file platform.h.

#define MBEDTLS_PLATFORM_STD_PRINTF   printf

Default printf to use.

Definition at line 62 of file platform.h.

#define MBEDTLS_PLATFORM_STD_SNPRINTF   snprintf

Default snprintf to use.

Definition at line 58 of file platform.h.

#define MBEDTLS_PLATFORM_STD_TIME   time

Default time to use.

Definition at line 77 of file platform.h.

#define mbedtls_printf   printf

Definition at line 178 of file platform.h.

#define mbedtls_snprintf   snprintf

Definition at line 212 of file platform.h.

Function Documentation

int mbedtls_platform_setup ( mbedtls_platform_context ctx)

Perform any platform initialisation operations.

Parameters
ctxmbed TLS context
Returns
0 if successful
Note
This function is intended to allow platform specific initialisation, and should be called before any other library functions. Its implementation is platform specific, and by default, unless platform specific code is provided, it does nothing.

Its use and whether its necessary to be called is dependent on the platform.

void mbedtls_platform_teardown ( mbedtls_platform_context ctx)

Perform any platform teardown operations.

Parameters
ctxmbed TLS context
Note
This function should be called after every other mbed TLS module has been correctly freed using the appropriate free function. Its implementation is platform specific, and by default, unless platform specific code is provided, it does nothing.

Its use and whether its necessary to be called is dependent on the platform.