blob: 127b7fe3e6529d8940f6abc4aabf49ee4819df29 [file] [log] [blame]
Paul Bakker747a83a2014-02-01 22:50:07 +01001/**
2 * \file platform.h
3 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00004 * \brief mbed TLS Platform abstraction layer
Paul Bakker747a83a2014-02-01 22:50:07 +01005 *
Manuel Pégourié-Gonnarda658a402015-01-23 09:45:19 +00006 * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
Paul Bakker747a83a2014-02-01 22:50:07 +01007 *
Manuel Pégourié-Gonnard860b5162015-01-28 17:12:07 +00008 * This file is part of mbed TLS (https://polarssl.org)
Paul Bakker747a83a2014-02-01 22:50:07 +01009 *
Paul Bakker747a83a2014-02-01 22:50:07 +010010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 */
24#ifndef POLARSSL_PLATFORM_H
25#define POLARSSL_PLATFORM_H
26
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020027#if !defined(POLARSSL_CONFIG_FILE)
Paul Bakker747a83a2014-02-01 22:50:07 +010028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
30#include POLARSSL_CONFIG_FILE
31#endif
Paul Bakker747a83a2014-02-01 22:50:07 +010032
Manuel Pégourié-Gonnard0a155b82015-01-23 17:28:27 +000033/* Temporary compability hack for to keep the deprecated MEMORY_C working */
34#if defined(POLARSSL_MEMORY_C) && !defined(POLARSSL_PLATFORM_MEMORY)
35#define POLARSSL_PLATFORM_MEMORY
36#endif
37
Paul Bakker747a83a2014-02-01 22:50:07 +010038#ifdef __cplusplus
39extern "C" {
40#endif
41
Paul Bakker088c5c52014-04-25 11:11:10 +020042/**
43 * \name SECTION: Module settings
44 *
45 * The configuration options you can set for this module are in this section.
46 * Either change them in config.h or define them on the compiler command line.
47 * \{
48 */
49
50#if !defined(POLARSSL_PLATFORM_NO_STD_FUNCTIONS)
Rich Evans00ab4702015-02-06 13:43:58 +000051#include <stdio.h>
Paul Bakkera9066cf2014-02-05 15:13:04 +010052#include <stdlib.h>
Paul Bakker088c5c52014-04-25 11:11:10 +020053#if !defined(POLARSSL_PLATFORM_STD_PRINTF)
Paul Bakker747a83a2014-02-01 22:50:07 +010054#define POLARSSL_PLATFORM_STD_PRINTF printf /**< Default printf to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020055#endif
56#if !defined(POLARSSL_PLATFORM_STD_FPRINTF)
Paul Bakker747a83a2014-02-01 22:50:07 +010057#define POLARSSL_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020058#endif
59#if !defined(POLARSSL_PLATFORM_STD_MALLOC)
Paul Bakkerdefc0ca2014-02-04 17:30:24 +010060#define POLARSSL_PLATFORM_STD_MALLOC malloc /**< Default allocator to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020061#endif
62#if !defined(POLARSSL_PLATFORM_STD_FREE)
Paul Bakkerdefc0ca2014-02-04 17:30:24 +010063#define POLARSSL_PLATFORM_STD_FREE free /**< Default free to use */
Paul Bakker088c5c52014-04-25 11:11:10 +020064#endif
65#else /* POLARSSL_PLATFORM_NO_STD_FUNCTIONS */
Manuel Pégourié-Gonnardeb82a742014-04-02 13:43:48 +020066#if defined(POLARSSL_PLATFORM_STD_MEM_HDR)
67#include POLARSSL_PLATFORM_STD_MEM_HDR
68#endif
Paul Bakker088c5c52014-04-25 11:11:10 +020069#endif /* POLARSSL_PLATFORM_NO_STD_FUNCTIONS */
70
71/* \} name SECTION: Module settings */
Paul Bakker747a83a2014-02-01 22:50:07 +010072
73/*
74 * The function pointers for malloc and free
75 */
Paul Bakkera9066cf2014-02-05 15:13:04 +010076#if defined(POLARSSL_PLATFORM_MEMORY)
Paul Bakkerdefc0ca2014-02-04 17:30:24 +010077extern void * (*polarssl_malloc)( size_t len );
78extern void (*polarssl_free)( void *ptr );
79
80/**
81 * \brief Set your own memory implementation function pointers
82 *
83 * \param malloc_func the malloc function implementation
84 * \param free_func the free function implementation
85 *
86 * \return 0 if successful
87 */
88int platform_set_malloc_free( void * (*malloc_func)( size_t ),
89 void (*free_func)( void * ) );
Rich Evans00ab4702015-02-06 13:43:58 +000090#else /* !POLARSSL_PLATFORM_MEMORY */
Paul Bakker747a83a2014-02-01 22:50:07 +010091#define polarssl_malloc malloc
92#define polarssl_free free
Rich Evans00ab4702015-02-06 13:43:58 +000093#endif /* POLARSSL_PLATFORM_MEMORY */
Paul Bakker747a83a2014-02-01 22:50:07 +010094
95/*
96 * The function pointers for printf
97 */
98#if defined(POLARSSL_PLATFORM_PRINTF_ALT)
99extern int (*polarssl_printf)( const char *format, ... );
100
101/**
102 * \brief Set your own printf function pointer
103 *
104 * \param printf_func the printf function implementation
105 *
106 * \return 0
107 */
108int platform_set_printf( int (*printf_func)( const char *, ... ) );
Paul Bakker9af723c2014-05-01 13:03:14 +0200109#else /* POLARSSL_PLATFORM_PRINTF_ALT */
Paul Bakker747a83a2014-02-01 22:50:07 +0100110#define polarssl_printf printf
Paul Bakker9af723c2014-05-01 13:03:14 +0200111#endif /* POLARSSL_PLATFORM_PRINTF_ALT */
Paul Bakker747a83a2014-02-01 22:50:07 +0100112
113/*
114 * The function pointers for fprintf
115 */
116#if defined(POLARSSL_PLATFORM_FPRINTF_ALT)
117extern int (*polarssl_fprintf)( FILE *stream, const char *format, ... );
118
119int platform_set_fprintf( int (*fprintf_func)( FILE *stream, const char *,
120 ... ) );
121#else
122#define polarssl_fprintf fprintf
123#endif
124
125#ifdef __cplusplus
126}
127#endif
128
129#endif /* platform.h */