arm_uc_pal_linux_generic.c

00001 // ----------------------------------------------------------------------------
00002 // Copyright 2016-2017 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 #include "arm_uc_config.h"
00020 #if defined(ARM_UC_FEATURE_PAL_LINUX) && (ARM_UC_FEATURE_PAL_LINUX == 1)
00021 #if defined(TARGET_IS_PC_LINUX)
00022 
00023 #include "update-client-paal/arm_uc_paal_update_api.h"
00024 #include "update-client-pal-linux/arm_uc_pal_linux_implementation.h"
00025 #include "update-client-pal-linux/arm_uc_pal_linux_implementation_internal.h"
00026 
00027 /**
00028  * @brief Get a bitmap indicating supported features.
00029  * @details The bitmap is used in conjunction with the firmware and
00030  *          installer details struct to indicate what fields are supported
00031  *          and which values are valid.
00032  *
00033  * @return Capability bitmap.
00034  */
00035 ARM_UC_PAAL_UPDATE_CAPABILITIES ARM_UC_PAL_Linux_GetCapabilities_Generic(void)
00036 {
00037     const ARM_UC_PAAL_UPDATE_CAPABILITIES result = {
00038         .installer_arm_hash = 0,
00039         .installer_oem_hash = 0,
00040         .installer_layout   = 0,
00041         .firmware_hash      = 1,
00042         .firmware_hmac      = 0,
00043         .firmware_campaign  = 0,
00044         .firmware_version   = 1,
00045         .firmware_size      = 1
00046     };
00047 
00048     return result;
00049 }
00050 
00051 arm_ucp_worker_t arm_uc_worker_parameters_initialize = {
00052     .command  = "../../../arm_update_initialize.sh",
00053     .header   = 0,
00054     .firmware = 0,
00055     .location = 0,
00056     .offset   = 0,
00057     .size     = 0,
00058     .success_event = ARM_UC_PAAL_EVENT_INITIALIZE_DONE,
00059     .failure_event = ARM_UC_PAAL_EVENT_INITIALIZE_ERROR,
00060     .post_runner = NULL
00061 };
00062 
00063 arm_ucp_worker_t arm_uc_worker_parameters_prepare = {
00064     .command  = "../../../arm_update_prepare.sh",
00065     .header   = 1,
00066     .firmware = 1,
00067     .location = 1,
00068     .offset   = 0,
00069     .size     = 0,
00070     .success_event = ARM_UC_PAAL_EVENT_PREPARE_DONE,
00071     .failure_event = ARM_UC_PAAL_EVENT_PREPARE_ERROR,
00072     .post_runner = NULL
00073 };
00074 
00075 arm_ucp_worker_t arm_uc_worker_parameters_read = {
00076     .command = "../../../arm_update_read.sh",
00077     .header   = 0,
00078     .firmware = 0,
00079     .location = 1,
00080     .offset   = 1,
00081     .size     = 1,
00082     .success_event = ARM_UC_PAAL_EVENT_READ_DONE,
00083     .failure_event = ARM_UC_PAAL_EVENT_READ_ERROR,
00084     .post_runner = NULL
00085 };
00086 
00087 arm_ucp_worker_t arm_uc_worker_parameters_write = {
00088     .command = "../../../arm_update_write.sh",
00089     .header   = 0,
00090     .firmware = 1,
00091     .location = 1,
00092     .offset   = 1,
00093     .size     = 0,
00094     .success_event = ARM_UC_PAAL_EVENT_WRITE_DONE,
00095     .failure_event = ARM_UC_PAAL_EVENT_WRITE_ERROR,
00096     .post_runner = NULL
00097 };
00098 
00099 arm_ucp_worker_t arm_uc_worker_parameters_finalize = {
00100     .command = "../../../arm_update_finalize.sh",
00101     .header   = 1,
00102     .firmware = 1,
00103     .location = 1,
00104     .offset   = 0,
00105     .size     = 0,
00106     .success_event = ARM_UC_PAAL_EVENT_FINALIZE_DONE,
00107     .failure_event = ARM_UC_PAAL_EVENT_FINALIZE_ERROR,
00108     .post_runner = NULL
00109 };
00110 
00111 arm_ucp_worker_t arm_uc_worker_parameters_details = {
00112     .command = "../../../arm_update_details.sh",
00113     .header   = 1,
00114     .firmware = 0,
00115     .location = 1,
00116     .offset   = 0,
00117     .size     = 0,
00118     .success_event = ARM_UC_PAAL_EVENT_GET_FIRMWARE_DETAILS_DONE,
00119     .failure_event = ARM_UC_PAAL_EVENT_GET_FIRMWARE_DETAILS_ERROR,
00120     .post_runner = NULL
00121 };
00122 
00123 arm_ucp_worker_t arm_uc_worker_parameters_active_details = {
00124     .command = "../../../arm_update_active_details.sh",
00125     .header   = 1,
00126     .firmware = 0,
00127     .location = 0,
00128     .offset   = 0,
00129     .size     = 0,
00130     .success_event = ARM_UC_PAAL_EVENT_GET_ACTIVE_FIRMWARE_DETAILS_DONE,
00131     .failure_event = ARM_UC_PAAL_EVENT_GET_ACTIVE_FIRMWARE_DETAILS_ERROR,
00132     .post_runner = NULL
00133 };
00134 
00135 arm_ucp_worker_t arm_uc_worker_parameters_activate = {
00136     .command = "../../../arm_update_activate.sh",
00137     .header   = 1,
00138     .firmware = 1,
00139     .location = 0,
00140     .offset   = 0,
00141     .size     = 0,
00142     .success_event = ARM_UC_PAAL_EVENT_ACTIVATE_DONE,
00143     .failure_event = ARM_UC_PAAL_EVENT_ACTIVATE_ERROR,
00144     .post_runner = NULL
00145 };
00146 
00147 arm_ucp_worker_t arm_uc_worker_parameters_installer = {
00148     .command = "../../../arm_update_installer.sh",
00149     .header   = 1,
00150     .firmware = 0,
00151     .location = 0,
00152     .offset   = 0,
00153     .size     = 0,
00154     .success_event = ARM_UC_PAAL_EVENT_GET_INSTALLER_DETAILS_DONE,
00155     .failure_event = ARM_UC_PAAL_EVENT_GET_INSTALLER_DETAILS_ERROR,
00156     .post_runner = NULL
00157 };
00158 
00159 arm_uc_error_t ARM_UC_PAL_Linux_Initialize_Generic(ARM_UC_PAAL_UPDATE_SignalEvent_t callback)
00160 {
00161 #if 1
00162     extern arm_ucp_worker_config_t arm_uc_worker_parameters;
00163 
00164     arm_uc_worker_parameters.activate       = &arm_uc_worker_parameters_activate;
00165     arm_uc_worker_parameters.active_details = &arm_uc_worker_parameters_active_details;
00166     arm_uc_worker_parameters.details        = &arm_uc_worker_parameters_details;
00167     arm_uc_worker_parameters.finalize       = &arm_uc_worker_parameters_finalize;
00168     arm_uc_worker_parameters.initialize     = &arm_uc_worker_parameters_initialize;
00169     arm_uc_worker_parameters.installer      = &arm_uc_worker_parameters_installer;
00170     arm_uc_worker_parameters.prepare        = &arm_uc_worker_parameters_prepare;
00171 //    arm_uc_worker_parameters.read           = &arm_uc_worker_parameters_read;
00172 //    arm_uc_worker_parameters.write          = &arm_uc_worker_parameters_write;
00173 #endif
00174 
00175     return ARM_UC_PAL_Linux_Initialize(callback);
00176 }
00177 
00178 const ARM_UC_PAAL_UPDATE ARM_UCP_LINUX_GENERIC = {
00179     .Initialize                 = ARM_UC_PAL_Linux_Initialize_Generic,
00180     .GetCapabilities            = ARM_UC_PAL_Linux_GetCapabilities_Generic,
00181     .GetMaxID                   = ARM_UC_PAL_Linux_GetMaxID,
00182     .Prepare                    = ARM_UC_PAL_Linux_Prepare,
00183     .Write                      = ARM_UC_PAL_Linux_Write,
00184     .Finalize                   = ARM_UC_PAL_Linux_Finalize,
00185     .Read                       = ARM_UC_PAL_Linux_Read,
00186     .Activate                   = ARM_UC_PAL_Linux_Activate,
00187     .GetActiveFirmwareDetails   = ARM_UC_PAL_Linux_GetActiveFirmwareDetails,
00188     .GetFirmwareDetails         = ARM_UC_PAL_Linux_GetFirmwareDetails,
00189     .GetInstallerDetails        = ARM_UC_PAL_Linux_GetInstallerDetails
00190 };
00191 
00192 #endif /* TARGET_IS_PC_LINUX */
00193 #endif /* ARM_UC_FEATURE_PAL_LINUX */