Ram Gandikota / Mbed OS metronome

FRDM K64F Metronome

pal/Source/PAL-Impl/Services-API/pal.h@0:a2cb7295a1f7, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:35:07 2017 +0000
Revision:
0:a2cb7295a1f7
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ram54288 0:a2cb7295a1f7 1 /*
ram54288 0:a2cb7295a1f7 2 * Copyright (c) 2016 ARM Limited. All rights reserved.
ram54288 0:a2cb7295a1f7 3 * SPDX-License-Identifier: Apache-2.0
ram54288 0:a2cb7295a1f7 4 * Licensed under the Apache License, Version 2.0 (the License); you may
ram54288 0:a2cb7295a1f7 5 * not use this file except in compliance with the License.
ram54288 0:a2cb7295a1f7 6 * You may obtain a copy of the License at
ram54288 0:a2cb7295a1f7 7 *
ram54288 0:a2cb7295a1f7 8 * http://www.apache.org/licenses/LICENSE-2.0
ram54288 0:a2cb7295a1f7 9 *
ram54288 0:a2cb7295a1f7 10 * Unless required by applicable law or agreed to in writing, software
ram54288 0:a2cb7295a1f7 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
ram54288 0:a2cb7295a1f7 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ram54288 0:a2cb7295a1f7 13 * See the License for the specific language governing permissions and
ram54288 0:a2cb7295a1f7 14 * limitations under the License.
ram54288 0:a2cb7295a1f7 15 */
ram54288 0:a2cb7295a1f7 16
ram54288 0:a2cb7295a1f7 17
ram54288 0:a2cb7295a1f7 18 #ifndef _PAL_H
ram54288 0:a2cb7295a1f7 19 #define _PAL_H
ram54288 0:a2cb7295a1f7 20
ram54288 0:a2cb7295a1f7 21 #ifdef __cplusplus
ram54288 0:a2cb7295a1f7 22 extern "C" {
ram54288 0:a2cb7295a1f7 23 #endif
ram54288 0:a2cb7295a1f7 24
ram54288 0:a2cb7295a1f7 25
ram54288 0:a2cb7295a1f7 26 //includes for common headers in PAL
ram54288 0:a2cb7295a1f7 27 #include "pal_macros.h"
ram54288 0:a2cb7295a1f7 28 #include "pal_configuration.h"
ram54288 0:a2cb7295a1f7 29 #include "pal_errors.h"
ram54288 0:a2cb7295a1f7 30 #include "pal_types.h"
ram54288 0:a2cb7295a1f7 31
ram54288 0:a2cb7295a1f7 32 //includes for modules headers.
ram54288 0:a2cb7295a1f7 33 #include "pal_rtos.h"
ram54288 0:a2cb7295a1f7 34 //#include "pal_socket.h"
ram54288 0:a2cb7295a1f7 35
ram54288 0:a2cb7295a1f7 36
ram54288 0:a2cb7295a1f7 37
ram54288 0:a2cb7295a1f7 38 //declarations for global init and destroy of PAL
ram54288 0:a2cb7295a1f7 39
ram54288 0:a2cb7295a1f7 40 /*! PAL initialization
ram54288 0:a2cb7295a1f7 41 * This function will call each module's initialization function (if exist)
ram54288 0:a2cb7295a1f7 42 * to allocate required resources and initiate them.
ram54288 0:a2cb7295a1f7 43 * \return the function returns the status in the form of palStatus_t which will be PAL_SUCCESS(0) in case of success
ram54288 0:a2cb7295a1f7 44 * and another negative value indicating a specific error code in case of failure
ram54288 0:a2cb7295a1f7 45 */
ram54288 0:a2cb7295a1f7 46 palStatus_t pal_init();
ram54288 0:a2cb7295a1f7 47
ram54288 0:a2cb7295a1f7 48 /*! PAL destruction
ram54288 0:a2cb7295a1f7 49 * This function will call each module's destroy function (if exist)
ram54288 0:a2cb7295a1f7 50 * to free resources.
ram54288 0:a2cb7295a1f7 51 */
ram54288 0:a2cb7295a1f7 52 void pal_destroy();
ram54288 0:a2cb7295a1f7 53
ram54288 0:a2cb7295a1f7 54
ram54288 0:a2cb7295a1f7 55 #ifdef __cplusplus
ram54288 0:a2cb7295a1f7 56 }
ram54288 0:a2cb7295a1f7 57 #endif
ram54288 0:a2cb7295a1f7 58 #endif //_PAL_H