mbed TLS  Version 2.6.0
SSL/TLS Library for the Embedded Space
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
platform.h File Reference

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.
 
#define MBEDTLS_PLATFORM_STD_PRINTF   printf
 Default printf to use.
 
#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf
 Default fprintf to use.
 
#define MBEDTLS_PLATFORM_STD_CALLOC   calloc
 Default allocator to use.
 
#define MBEDTLS_PLATFORM_STD_FREE   free
 Default free to use.
 
#define MBEDTLS_PLATFORM_STD_EXIT   exit
 Default exit to use.
 
#define MBEDTLS_PLATFORM_STD_TIME   time
 Default time to use.
 
#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS
 Default exit value to use.
 
#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE
 Default exit value to use.
 
#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...
 

Description

mbed TLS Platform abstraction layer

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

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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


Data Structure Documentation

struct mbedtls_platform_context

Platform context structure.

Note
This structure may be used to assist platform-specific setup/teardown operations.
Data Fields
char dummy Placeholder member as empty structs are not portable.

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.