update-lwm2m-mbed-apis.h

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2016-2018 ARM Ltd.
00003 //
00004 // SPDX-License-Identifier: Apache-2.0
00005 //
00006 // Licensed under the Apache License, Version 2.0 (the "License");
00007 // you may not use this file except in compliance with the License.
00008 // You may obtain a copy of the License at
00009 //
00010 //     http://www.apache.org/licenses/LICENSE-2.0
00011 //
00012 // Unless required by applicable law or agreed to in writing, software
00013 // distributed under the License is distributed on an "AS IS" BASIS,
00014 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00015 // See the License for the specific language governing permissions and
00016 // limitations under the License.
00017 // ----------------------------------------------------------------------------
00018 
00019 /** @file update-lwm2m-mbed-apis.h
00020  * @brief This file contains forward declarations for all functions used as
00021  * APIS for the update client
00022  * 
00023  * @detail Because C++ does not support designated initialisers, this file is
00024  * used to provide linkage from C++ to C structure initialisers. This pattern is
00025  * necessary to ensure that the APIs are not brittle and prone to breakage if
00026  * APIs are added or the API structure is changed.
00027  */
00028 
00029 #include "update-client-common/arm_uc_error.h"
00030 #include "update-client-monitor/arm_uc_monitor.h"
00031 #include "update-client-source/arm_uc_source.h"
00032 #include <stdint.h>
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 uint32_t ARM_UCS_LWM2M_MONITOR_GetVersion(void);
00039 ARM_MONITOR_CAPABILITIES ARM_UCS_LWM2M_MONITOR_GetCapabilities(void);
00040 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_Initialize(void (*notification_handler)(void));
00041 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_Uninitialize(void);
00042 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_SendState(arm_uc_monitor_state_t state);
00043 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_SendUpdateResult(arm_uc_monitor_result_t updateResult);
00044 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_SendName(arm_uc_buffer_t* name);
00045 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_SendVersion(uint64_t version);
00046 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_SetBootloaderHash(arm_uc_buffer_t* hash);
00047 arm_uc_error_t ARM_UCS_LWM2M_MONITOR_SetOEMBootloaderHash(arm_uc_buffer_t* hash);
00048 
00049 uint32_t ARM_UCS_LWM2M_SOURCE_GetVersion(void);
00050 ARM_SOURCE_CAPABILITIES ARM_UCS_LWM2M_SOURCE_GetCapabilities(void);
00051 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_Initialize(ARM_SOURCE_SignalEvent_t cb_event);
00052 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_Uninitialize(void);
00053 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetManifestDefaultCost(uint32_t* cost);
00054 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetManifestDefault(arm_uc_buffer_t* buffer,
00055                                                        uint32_t offset);
00056 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetManifestURLCost(arm_uc_uri_t* uri,
00057                                                        uint32_t* cost);
00058 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetFirmwareURLCost(arm_uc_uri_t* uri,
00059                                                        uint32_t* cost);
00060 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetKeytableURLCost(arm_uc_uri_t* uri,
00061                                                        uint32_t* cost);
00062 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetManifestURL(arm_uc_uri_t* uri,
00063                                                    arm_uc_buffer_t* buffer,
00064                                                    uint32_t offset);
00065 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetFirmwareFragment(arm_uc_uri_t* uri,
00066                                                         arm_uc_buffer_t* buffer,
00067                                                         uint32_t offset);
00068 arm_uc_error_t ARM_UCS_LWM2M_SOURCE_GetKeytableURL(arm_uc_uri_t* uri,
00069                                                    arm_uc_buffer_t* buffer);                                                                                                                                                                                                                         
00070 
00071 
00072 #ifdef __cplusplus
00073 }
00074 #endif