pal_update.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2016-2019 ARM Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef SOURCE_PAL_IMPL_SERVICES_API_PAL_UPDATE_H_
#define SOURCE_PAL_IMPL_SERVICES_API_PAL_UPDATE_H_

#ifndef _PAL_H
    #error "Please do not include this file directly, use pal.h instead"
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef uint32_t palImageId_t;

typedef struct _palImageHeaderDeails_t
{
    size_t imageSize;
    palBuffer_t hash;
    uint64_t version;
} palImageHeaderDeails_t;

typedef enum _palImagePlatformData_t
{
    PAL_IMAGE_DATA_FIRST = 0,
    PAL_IMAGE_DATA_HASH = PAL_IMAGE_DATA_FIRST,
    PAL_IMAGE_DATA_LAST
} palImagePlatformData_t;

typedef enum _palImageEvents_t
{
    PAL_IMAGE_EVENT_FIRST = -1,
    PAL_IMAGE_EVENT_ERROR = PAL_IMAGE_EVENT_FIRST,
    PAL_IMAGE_EVENT_INIT ,
    PAL_IMAGE_EVENT_PREPARE,
    PAL_IMAGE_EVENT_WRITE,
    PAL_IMAGE_EVENT_FINALIZE,
    PAL_IMAGE_EVENT_READTOBUFFER,
    PAL_IMAGE_EVENT_ACTIVATE,
    PAL_IMAGE_EVENT_ACTIVATE_ERROR,
    PAL_IMAGE_EVENT_GETACTIVEHASH,
    PAL_IMAGE_EVENT_GETACTIVEVERSION,
    PAL_IMAGE_EVENT_WRITEDATATOMEMORY,
    PAL_IMAGE_EVENT_LAST
} palImageEvents_t;

typedef void (*palImageSignalEvent_t)( palImageEvents_t event);

#define SIZEOF_SHA256               256/8
#define FIRMWARE_HEADER_MAGIC       0x5a51b3d4UL
#define FIRMWARE_HEADER_VERSION     1
#define ACTIVE_IMAGE_INDEX          0xFFFFFFFF

typedef struct FirmwareHeader {
    uint32_t magic;                         
    uint32_t version;                       
    uint32_t checksum;                      
    uint32_t totalSize;                     
    uint64_t firmwareVersion;               
    uint8_t  firmwareSHA256[SIZEOF_SHA256]; 
} FirmwareHeader_t;


typedef FirmwareHeader_t palFirmwareHeader_t;
palStatus_t pal_imageInitAPI(palImageSignalEvent_t CBfunction);


palStatus_t pal_imageDeInit(void);

palStatus_t pal_imagePrepare(palImageId_t imageId, palImageHeaderDeails_t* headerDetails);

palStatus_t pal_imageWrite (palImageId_t imageId, size_t offset, palConstBuffer_t *chunk);

palStatus_t pal_imageFinalize(palImageId_t imageId);

palStatus_t pal_imageGetDirectMemoryAccess(palImageId_t imageId, void** imagePtr, size_t *imageSizeInBytes);

palStatus_t pal_imageReadToBuffer(palImageId_t imageId, size_t offset, palBuffer_t* chunk);

palStatus_t pal_imageActivate(palImageId_t imageId);

palStatus_t pal_imageGetActiveHash(palBuffer_t* hash);

palStatus_t pal_imageGetFirmwareHeaderData(palImageId_t imageId, palBuffer_t *headerData);

palStatus_t pal_imageGetActiveVersion(palBuffer_t* version);

palStatus_t pal_imageWriteDataToMemory(palImagePlatformData_t dataId, const palConstBuffer_t* const dataBuffer);

char* pal_imageGetFolder(void);

#ifdef __cplusplus
}
#endif
#endif /* SOURCE_PAL_IMPL_SERVICES_API_PAL_UPDATE_H_ */