storage_hal.h

Go to the documentation of this file.

//  Copyright (C) 2015-2020 Virgil Security, Inc.
//
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//
//      (1) Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//      (2) Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in
//      the documentation and/or other materials provided with the
//      distribution.
//
//      (3) Neither the name of the copyright holder nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
//  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
//  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
//  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
//  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
//  Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 
#ifndef VS_STORAGE_HAL_H
#define VS_STORAGE_HAL_H
 
#include <virgil/iot/status_code/status_code.h>
#include <sys/types.h>
 
#ifdef __cplusplus
namespace VirgilIoTKit {
extern "C" {
#endif
 
#define VS_STORAGE_ELEMENT_ID_MAX  (32)
 
typedef uint8_t vs_storage_element_id_t[VS_STORAGE_ELEMENT_ID_MAX];
 
typedef void *vs_storage_impl_data_ctx_t;
 
typedef void *vs_storage_file_t;
 
typedef vs_status_e (*vs_storage_deinit_hal_t)(
        vs_storage_impl_data_ctx_t storage_ctx);
 
typedef vs_storage_file_t (*vs_storage_open_hal_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        const vs_storage_element_id_t id);
 
typedef vs_status_e (*vs_rpi_storage_sync_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        const vs_storage_file_t file);
 
typedef vs_status_e (*vs_storage_close_hal_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        vs_storage_file_t file);
 
typedef vs_status_e (*vs_storage_save_hal_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        const vs_storage_file_t file,
        size_t offset,
        const uint8_t *in_data,
        size_t data_sz);
 
typedef vs_status_e (*vs_storage_load_hal_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        const vs_storage_file_t file,
        size_t offset,
        uint8_t *out_data,
        size_t data_sz);
 
typedef ssize_t (*vs_storage_file_size_hal_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        const vs_storage_element_id_t id);
 
typedef vs_status_e (*vs_storage_del_hal_t)(
        const vs_storage_impl_data_ctx_t storage_ctx,
        const vs_storage_element_id_t id);
 
vs_status_e
vs_impl_own_firmware_descriptor(void *descriptor);
 
typedef struct {
    vs_storage_deinit_hal_t deinit; 
    vs_storage_open_hal_t open; 
    vs_rpi_storage_sync_t sync; 
    vs_storage_close_hal_t close; 
    vs_storage_save_hal_t save; 
    vs_storage_load_hal_t load; 
    vs_storage_file_size_hal_t size; 
    vs_storage_del_hal_t del; 
} vs_storage_impl_func_t;
 
typedef struct {
    vs_storage_impl_func_t impl_func; 
    vs_storage_impl_data_ctx_t impl_data; 
    size_t file_sz_limit; 
} vs_storage_op_ctx_t;
 
#ifdef __cplusplus
} // extern "C"
} // namespace VirgilIoTKit
#endif
 
#endif //VS_STORAGE_HAL_H