Files
mbedtls/library/mbedtls_common.h
Gilles Peskine a3d55d9ec7 Document the purpose of mbedtls_common.h
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2026-03-02 12:25:01 +00:00

40 lines
1.4 KiB
C

/**
* \file mbedtls_common.h
*
* \brief Utility macros for internal use in the library.
*
* This file should be included as the first thing in all library C files
* (directly, or indirectly via x509_internal.h or ssl_misc.h).
* It must not be included by sample programs, since sample programs
* illustrate what you can do without the library sources.
* It may be included (often indirectly) by test code that isn't purely
* black-box testing.
*
* This file takes care of setting up requirements for platform headers.
* It includes the library configuration and derived macros.
* It additionally defines various utility macros and other definitions
* (but no function declarations).
*/
/*
* Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
*/
#ifndef MBEDTLS_MBEDTLS_COMMON_H
#define MBEDTLS_MBEDTLS_COMMON_H
/* Before including any system header, declare some macros to tell system
* headers what we expect of them.
*
* Do this before including any header from TF-PSA-Crypto, since the
* convention is first-come-first-served (so that users can
* override some macros on the command line, and individual users can
* override some macros before including the common header).
*/
#include "mbedtls_platform_requirements.h"
/* Mbed TLS requires TF-PSA-Crypto internals. */
#include "tf_psa_crypto_common.h"
#endif /* MBEDTLS_MBEDTLS_COMMON_H */