pal.h

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