pal.h

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2016-2019 ARM Ltd.
00003 //
00004 // SPDX-License-Identifier: Apache-2.0
00005 //
00006 // Licensed under the Apache License, Version 2.0 (the "License");
00007 // you may not use this file except in compliance with the License.
00008 // You may obtain a copy of the License at
00009 //
00010 //     http://www.apache.org/licenses/LICENSE-2.0
00011 //
00012 // Unless required by applicable law or agreed to in writing, software
00013 // distributed under the License is distributed on an "AS IS" BASIS,
00014 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00015 // See the License for the specific language governing permissions and
00016 // limitations under the License.
00017 // ----------------------------------------------------------------------------
00018 
00019 #ifndef _PAL_H
00020 #define _PAL_H
00021 
00022 #ifdef __cplusplus
00023 extern "C" {
00024 #endif
00025 //includes for common headers in PAL
00026 #include "pal_configuration.h"
00027 #include "pal_macros.h"
00028 #include "pal_errors.h"
00029 #include "pal_types.h"
00030 
00031 //includes for modules headers.
00032 #include "pal_drbg.h"
00033 #include "pal_fileSystem.h"
00034 #include "pal_rot.h"
00035 #include "pal_rtos.h"
00036 #include "pal_network.h"
00037 #include "pal_time.h"
00038 #include "pal_TLS.h"
00039 #include "pal_Crypto.h"
00040 #include "pal_entropy.h"
00041 #include "pal_update.h"
00042 #include "pal_internalFlash.h"
00043 #include "pal_sst.h"
00044 
00045 
00046 /*! \file pal.h
00047 *  \brief PAL.
00048 *   This file contains the general API to initiate and destroy the PAL component.
00049 *   This is part of the PAL service API.
00050 */
00051 
00052 
00053 //declarations for global init and destroy of PAL
00054 
00055 /*! \brief PAL initialization.
00056 *   This function calls each module's initialization function (if one exists)
00057 *   to allocate the required resources and initiate them.
00058 * \return PAL_SUCCESS(0) in case of success, a negative value indicating a specific error code in case of failure.
00059 */
00060 palStatus_t pal_init(void);
00061 
00062 /*! \brief PAL destruction.
00063 *   This function calls each module's destroy function (if one exists)
00064 *   to free resources.
00065 */
00066 int32_t pal_destroy(void);
00067 
00068 #ifdef __cplusplus
00069 }
00070 #endif
00071 
00072 
00073 #endif //_PAL_H