Toyomasa Watarai
/
Mbed-example-WS-W27
simple-mbed-cloud-client/mbed-cloud-client/mbed-client-pal/Source/PAL-Impl/Services-API/pal.h@0:119624335925, 2018-06-30 (annotated)
- Committer:
- MACRUM
- Date:
- Sat Jun 30 01:40:30 2018 +0000
- Revision:
- 0:119624335925
Initial commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
MACRUM | 0:119624335925 | 1 | /* |
MACRUM | 0:119624335925 | 2 | * Copyright (c) 2016 ARM Limited. All rights reserved. |
MACRUM | 0:119624335925 | 3 | * SPDX-License-Identifier: Apache-2.0 |
MACRUM | 0:119624335925 | 4 | * Licensed under the Apache License, Version 2.0 (the License); you may |
MACRUM | 0:119624335925 | 5 | * not use this file except in compliance with the License. |
MACRUM | 0:119624335925 | 6 | * You may obtain a copy of the License at |
MACRUM | 0:119624335925 | 7 | * |
MACRUM | 0:119624335925 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
MACRUM | 0:119624335925 | 9 | * |
MACRUM | 0:119624335925 | 10 | * Unless required by applicable law or agreed to in writing, software |
MACRUM | 0:119624335925 | 11 | * distributed under the License is distributed on an AS IS BASIS, WITHOUT |
MACRUM | 0:119624335925 | 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
MACRUM | 0:119624335925 | 13 | * See the License for the specific language governing permissions and |
MACRUM | 0:119624335925 | 14 | * limitations under the License. |
MACRUM | 0:119624335925 | 15 | */ |
MACRUM | 0:119624335925 | 16 | |
MACRUM | 0:119624335925 | 17 | |
MACRUM | 0:119624335925 | 18 | #ifndef _PAL_H |
MACRUM | 0:119624335925 | 19 | #define _PAL_H |
MACRUM | 0:119624335925 | 20 | |
MACRUM | 0:119624335925 | 21 | #ifdef __cplusplus |
MACRUM | 0:119624335925 | 22 | extern "C" { |
MACRUM | 0:119624335925 | 23 | #endif |
MACRUM | 0:119624335925 | 24 | |
MACRUM | 0:119624335925 | 25 | //includes for common headers in PAL |
MACRUM | 0:119624335925 | 26 | #include "pal_macros.h" |
MACRUM | 0:119624335925 | 27 | #include "pal_configuration.h" |
MACRUM | 0:119624335925 | 28 | #include "pal_errors.h" |
MACRUM | 0:119624335925 | 29 | #include "pal_types.h" |
MACRUM | 0:119624335925 | 30 | |
MACRUM | 0:119624335925 | 31 | //includes for modules headers. |
MACRUM | 0:119624335925 | 32 | #include "pal_fileSystem.h" |
MACRUM | 0:119624335925 | 33 | #include "pal_rtos.h" |
MACRUM | 0:119624335925 | 34 | #include "pal_network.h" |
MACRUM | 0:119624335925 | 35 | #include "pal_TLS.h" |
MACRUM | 0:119624335925 | 36 | #include "pal_Crypto.h" |
MACRUM | 0:119624335925 | 37 | #include "pal_update.h" |
MACRUM | 0:119624335925 | 38 | #include "pal_internalFlash.h" |
MACRUM | 0:119624335925 | 39 | |
MACRUM | 0:119624335925 | 40 | /*! \file pal.h |
MACRUM | 0:119624335925 | 41 | * \brief PAL. |
MACRUM | 0:119624335925 | 42 | * This file contains the general API to initiate and destroy the PAL component. |
MACRUM | 0:119624335925 | 43 | * This is part of the PAL service API. |
MACRUM | 0:119624335925 | 44 | */ |
MACRUM | 0:119624335925 | 45 | |
MACRUM | 0:119624335925 | 46 | |
MACRUM | 0:119624335925 | 47 | //declarations for global init and destroy of PAL |
MACRUM | 0:119624335925 | 48 | |
MACRUM | 0:119624335925 | 49 | /*! PAL initialization |
MACRUM | 0:119624335925 | 50 | * This function calls each module's initialization function (if exist) |
MACRUM | 0:119624335925 | 51 | * to allocate required resources and initiate them. |
MACRUM | 0:119624335925 | 52 | * \return PAL_SUCCESS(0) in case of success, a negative value indicating a specific error code in case of failure. |
MACRUM | 0:119624335925 | 53 | */ |
MACRUM | 0:119624335925 | 54 | palStatus_t pal_init(void); |
MACRUM | 0:119624335925 | 55 | |
MACRUM | 0:119624335925 | 56 | /*! PAL destruction. |
MACRUM | 0:119624335925 | 57 | * This function calls each module's destroy function (if exist) |
MACRUM | 0:119624335925 | 58 | * to free resources. |
MACRUM | 0:119624335925 | 59 | */ |
MACRUM | 0:119624335925 | 60 | int32_t pal_destroy(void); |
MACRUM | 0:119624335925 | 61 | |
MACRUM | 0:119624335925 | 62 | |
MACRUM | 0:119624335925 | 63 | #ifdef __cplusplus |
MACRUM | 0:119624335925 | 64 | } |
MACRUM | 0:119624335925 | 65 | #endif |
MACRUM | 0:119624335925 | 66 | #endif //_PAL_H |