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