app_storage.h

Go to the documentation of this file.

/*****************************************************************************
 *   (c) 2024 Ledger SAS.
 *
 *  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.
 *****************************************************************************/
 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
 
#define APP_STORAGE_PROP_SETTINGS (1 << 0)
#define APP_STORAGE_PROP_DATA     (1 << 1)
 
#define APP_STORAGE_TAG_LEN 4
 
#define APP_STORAGE_TAG "NVRA"
 
#define APP_STORAGE_HEADER_STRUCT_VERSION 1
 
#define APP_STORAGE_SUCCESS               0   
#define APP_STORAGE_ERR_INVALID_ARGUMENT  -1  
#define APP_STORAGE_ERR_NO_DATA_AVAILABLE -2  
#define APP_STORAGE_ERR_OVERFLOW          -3  
#define APP_STORAGE_ERR_INVALID_HEADER    -4  
#define APP_STORAGE_ERR_CORRUPTED         -5  
 
#define APP_STORAGE_INITIAL_APP_DATA_VERSION 1
 
typedef struct app_storage_header_s {
    char     tag[APP_STORAGE_TAG_LEN];  
    uint32_t size;                      
    uint16_t struct_version;            
    uint16_t properties;    
    uint32_t data_version;  
} app_storage_header_t;
 
#ifndef HAVE_BOLOS
 
/* Getters for system information */
uint32_t app_storage_get_size(void);
uint16_t app_storage_get_properties(void);
uint32_t app_storage_get_data_version(void);
 
/* Reads app storage data */
int32_t app_storage_read(void *buf, uint32_t nbyte, uint32_t offset);
 
/* Writes app storage data */
int32_t app_storage_write(const void *buf, uint32_t nbyte, uint32_t offset);
 
/* Setters */
void app_storage_set_data_version(uint32_t data_version);
void app_storage_increment_data_version(void);
 
/* Resets and zeroes out application storage */
void app_storage_reset(void);
 
#endif  // #ifndef HAVE_BOLOS