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