pal_sst.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.
// ----------------------------------------------------------------------------

#ifdef MBED_CONF_MBED_CLOUD_CLIENT_EXTERNAL_SST_SUPPORT

#ifndef _PAL_SST_H
#define _PAL_SST_H

#ifndef _PAL_H
    #error "Do not include this file directly. Use pal.h instead."
#endif

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
* Pal SST item iterator
*/
typedef uintptr_t palSSTIterator_t;

/*
* Pal SST flags
*/

/*
* Write once flag. 
* When the flag is used, the item can only be written once and cannot be removed.
*/
#define PAL_SST_WRITE_ONCE_FLAG         (1 << 0)

/* 
* Confidentiality (encryption) flag.
*/
#define PAL_SST_CONFIDENTIALITY_FLAG    (1 << 1)

/*
* Replay protection flag.
* When this flag is used, the item cannot be physically removed (outside pal_SST APIs). 
*/
#define PAL_SST_REPLAY_PROTECTION_FLAG  (1 << 3)

/*
* PAL SST item info structure
*/
typedef struct palSSTItemInfo {
    size_t itemSize;          
    uint32_t SSTFlagsBitmap;  
} palSSTItemInfo_t;

palStatus_t pal_SSTSet(const char *itemName, const void *itemBuffer, size_t itemBufferSize, uint32_t SSTFlagsBitmap);

palStatus_t pal_SSTGet(const char *itemName, void *itemBuffer, size_t itemBufferSize, size_t *actualItemSize);

palStatus_t pal_SSTGetInfo(const char *itemName, palSSTItemInfo_t *palItemInfo);

palStatus_t pal_SSTRemove(const char *itemName);

palStatus_t pal_SSTIteratorOpen(palSSTIterator_t *palSSTIterator, const char *itemPrefix);

palStatus_t pal_SSTIteratorNext(palSSTIterator_t palSSTIterator, char *itemNameBuffer, size_t itemNameBufferSize);

palStatus_t pal_SSTIteratorClose(palSSTIterator_t palSSTIterator);

palStatus_t pal_SSTReset(void);

#ifdef __cplusplus
}
#endif

// endif


#endif //_PAL_SST_H

#endif //MBED_CONF_MBED_CLOUD_CLIENT_EXTERNAL_SST_SUPPORT