Ram Gandikota / Mbed OS ABCD

A metronome using the FRDM K64F board

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

Committer:
ram54288
Date:
Sun May 14 18:40:18 2017 +0000
Revision:
0:a7a43371b306
Initial commit

Who changed what in which revision?

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