pal.h

00001 /*
00002 * Copyright (c) 2016 ARM Limited. All rights reserved.
00003 * SPDX-License-Identifier: Apache-2.0
00004 * Licensed under the Apache License, Version 2.0 (the License); you may
00005 * 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, WITHOUT
00012 * 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 
00025 
00026 //includes for common headers in PAL
00027 #include "pal_macros.h"
00028 #include "pal_configuration.h"
00029 #include "pal_errors.h"
00030 #include "pal_types.h"
00031 
00032 //includes for modules headers.
00033 #include "pal_rtos.h"
00034 //#include "pal_socket.h"
00035 
00036 
00037 
00038 //declarations for global init and destroy of PAL
00039 
00040 /*! PAL initialization
00041 *   This function will call each module's initialization function (if exist)
00042 *   to allocate required resources and initiate them.
00043 * \return the function returns the status in the form of palStatus_t which will be PAL_SUCCESS(0) in case of success 
00044 *   and another negative value indicating a specific error code in case of failure
00045 */
00046 palStatus_t pal_init();
00047 
00048 /*! PAL destruction
00049 *   This function will call each module's destroy function (if exist)
00050 *   to free resources.
00051 */
00052 void pal_destroy();
00053 
00054 
00055 #ifdef __cplusplus
00056 }
00057 #endif
00058 #endif //_PAL_H