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

This file contains the definitions and functions of the 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
 The 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
 
#define MBEDTLS_PLATFORM_STD_PRINTF   printf
 
#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf
 
#define MBEDTLS_PLATFORM_STD_CALLOC   calloc
 
#define MBEDTLS_PLATFORM_STD_FREE   free
 
#define MBEDTLS_PLATFORM_STD_EXIT   exit
 
#define MBEDTLS_PLATFORM_STD_TIME   time
 
#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS
 
#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE
 
#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)
 This function performs any platform-specific initialization operations. More...
 
void mbedtls_platform_teardown (mbedtls_platform_context *ctx)
 This function performs any platform teardown operations. More...
 

Detailed Description

This file contains the definitions and functions of the Mbed TLS platform abstraction layer.

The platform abstraction layer removes the need for the library to directly link to standard C library functions or operating system services, making the library easier to port and embed. Application developers and users of the library can provide their own implementations of these functions, or implementations specific to their platform, which can be statically linked to the library or dynamically configured at runtime.

Definition in file platform.h.

Macro Definition Documentation

#define mbedtls_calloc   calloc

Definition at line 141 of file platform.h.

#define mbedtls_exit   exit

Definition at line 250 of file platform.h.

#define MBEDTLS_EXIT_FAILURE   MBEDTLS_PLATFORM_STD_EXIT_FAILURE

Definition at line 263 of file platform.h.

#define MBEDTLS_EXIT_SUCCESS   MBEDTLS_PLATFORM_STD_EXIT_SUCCESS

Definition at line 258 of file platform.h.

#define mbedtls_fprintf   fprintf

Definition at line 167 of file platform.h.

#define mbedtls_free   free

Definition at line 140 of file platform.h.

#define MBEDTLS_PLATFORM_STD_CALLOC   calloc

The default calloc function to use.

Definition at line 76 of file platform.h.

#define MBEDTLS_PLATFORM_STD_EXIT   exit

The default exit function to use.

Definition at line 82 of file platform.h.

#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE

The default exit value to use.

Definition at line 91 of file platform.h.

#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS

The default exit value to use.

Definition at line 88 of file platform.h.

#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf

The default fprintf function to use.

Definition at line 73 of file platform.h.

#define MBEDTLS_PLATFORM_STD_FREE   free

The default free function to use.

Definition at line 79 of file platform.h.

#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE   "seedfile"

Definition at line 101 of file platform.h.

#define MBEDTLS_PLATFORM_STD_NV_SEED_READ   mbedtls_platform_std_nv_seed_read

Definition at line 95 of file platform.h.

#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE   mbedtls_platform_std_nv_seed_write

Definition at line 98 of file platform.h.

#define MBEDTLS_PLATFORM_STD_PRINTF   printf

The default printf function to use.

Definition at line 70 of file platform.h.

#define MBEDTLS_PLATFORM_STD_SNPRINTF   snprintf

The default snprintf function to use.

Definition at line 66 of file platform.h.

#define MBEDTLS_PLATFORM_STD_TIME   time

The default time function to use.

Definition at line 85 of file platform.h.

#define mbedtls_printf   printf

Definition at line 191 of file platform.h.

#define mbedtls_snprintf   snprintf

Definition at line 226 of file platform.h.

Function Documentation

int mbedtls_platform_setup ( mbedtls_platform_context ctx)

This function performs any platform-specific initialization operations.

Note
This function should be called before any other library functions.
     Its implementation is platform-specific, and unless
     platform-specific code is provided, it does nothing. 
The usage and necessity of this function is dependent on the platform.
Parameters
ctxThe platform context.
Returns
0 on success.
void mbedtls_platform_teardown ( mbedtls_platform_context ctx)

This function performs any platform teardown operations.

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 unless platform-specific code is provided, it does nothing.

Note
The usage and necessity of this function is dependent on the platform.
Parameters
ctxThe platform context.