vsf_mal.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  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 __VSF_MAL_H__
#define __VSF_MAL_H__
 
/*============================ INCLUDES ======================================*/
 
#include "./vsf_mal_cfg.h"
 
#if VSF_USE_MAL == ENABLED
 
#include "kernel/vsf_kernel.h"
 
#if     defined(__VSF_MAL_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_MAL_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL != ENABLED
#   error VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL is needed to use mal
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
vsf_dcl_class(vk_mal_t)
#if VSF_USE_SIMPLE_STREAM == ENABLED
vsf_dcl_class(vk_mal_stream_t)
#endif
 
vsf_dcl_class(vk_mal_drv_t)
 
typedef enum vsf_mal_op_t {
    VSF_MAL_OP_ERASE,
    VSF_MAL_OP_READ,
    VSF_MAL_OP_WRITE,
} vsf_mal_op_t;
 
typedef enum vsf_mal_feature_t {
    VSF_MAL_READABLE            = 1 << 0,
    VSF_MAL_WRITABLE            = 1 << 1,
    VSF_MAL_ERASABLE            = 1 << 2,
    VSF_MAL_NON_UNIFIED_BLOCK   = 1 << 3,
    VSF_MAL_LOCAL_BUFFER        = 1 << 4,
} vsf_mal_feature_t;
 
typedef struct vsf_mal_capability_t {
    // alignment in bytes, 1 byte alignment if 0
    uint16_t data_ptr_alignment;    // default for read and write
    uint16_t data_size_alignment;   // alignment of data size
    // direction-specific pointer alignment, 0 inherits data_ptr_alignment
    uint16_t read_data_ptr_alignment;
    uint16_t write_data_ptr_alignment;
} vsf_mal_capability_t;
 
vsf_class(vk_mal_drv_t) {
    protected_member(
        uint_fast32_t (*blksz)(vk_mal_t *mal, uint_fast64_t addr, uint_fast32_t size, vsf_mal_op_t op);
        bool (*buffer)(vk_mal_t *mal, uint_fast64_t addr, uint_fast32_t size, vsf_mal_op_t op, vsf_mem_t *mem);
        vsf_mal_capability_t (*capability)(vk_mal_t *mal);
 
        uint8_t init_local_size;
        uint8_t fini_local_size;
        uint8_t erase_local_size;
        uint8_t read_local_size;
        uint8_t write_local_size;
        vsf_peda_evthandler_t init;
        vsf_peda_evthandler_t fini;
        vsf_peda_evthandler_t erase;
        vsf_peda_evthandler_t read;
        vsf_peda_evthandler_t write;
    )
};
 
vsf_class(vk_mal_t) {
    public_member(
        const vk_mal_drv_t *drv;
        void *param;
        uint64_t size;
        uint8_t feature;
    )
};
 
#if VSF_USE_SIMPLE_STREAM == ENABLED
vsf_class(vk_mal_stream_t) {
    public_member(
        vk_mal_t *mal;
    )
    protected_member(
        uint64_t addr;
        uint32_t size;
        uint32_t rw_size;
        vsf_stream_t *stream;
        uint32_t cur_size;
        uint8_t *cur_buff;
        vsf_eda_t *cur_eda;
    )
};
#endif
 
#if defined(__VSF_MAL_CLASS_IMPLEMENT) || defined(__VSF_MAL_CLASS_INHERIT__)
__vsf_component_peda_ifs(vk_mal_init)
__vsf_component_peda_ifs(vk_mal_fini)
__vsf_component_peda_ifs(vk_mal_erase,
    uint64_t addr;
    uint32_t size;
)
__vsf_component_peda_ifs(vk_mal_read,
    uint64_t addr;
    uint32_t size;
    uint8_t *buff;
    uint32_t rsize;
)
__vsf_component_peda_ifs(vk_mal_write,
    uint64_t addr;
    uint32_t size;
    uint8_t *buff;
    uint32_t wsize;
)
#endif
 
#if VSF_KERNEL_CFG_SUPPORT_SYNC == ENABLED
vsf_class(vk_reentrant_mal_t) {
    public_member(
        implement(vk_mal_t)
 
        vk_mal_t *mal;
        vsf_mutex_t *mutex;
        uint64_t offset;
    )
};
#endif
 
/*============================ GLOBAL VARIABLES ==============================*/
 
#if VSF_KERNEL_CFG_SUPPORT_SYNC == ENABLED
extern const vk_mal_drv_t vk_reentrant_mal_drv;
#endif
 
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vk_mal_init(vk_mal_t *pthis);
 
extern vsf_err_t vk_mal_fini(vk_mal_t *pthis);
 
extern uint_fast32_t vk_mal_blksz(vk_mal_t *pthis, uint_fast64_t addr, uint_fast32_t size, vsf_mal_op_t op);
 
extern bool vk_mal_prepare_buffer(vk_mal_t *pthis, uint_fast64_t addr, uint_fast32_t size, vsf_mal_op_t op, vsf_mem_t *mem);
 
extern vsf_mal_capability_t vk_mal_capability(vk_mal_t *pthis);
 
extern vsf_err_t vk_mal_erase(vk_mal_t *pthis, uint_fast64_t addr, uint_fast32_t size);
 
extern vsf_err_t vk_mal_read(vk_mal_t *pthis, uint_fast64_t addr, uint_fast32_t size, uint8_t *buff);
 
extern vsf_err_t vk_mal_write(vk_mal_t *pthis, uint_fast64_t addr, uint_fast32_t size, uint8_t *buff);
 
#if VSF_USE_SIMPLE_STREAM == ENABLED
extern vsf_err_t vk_mal_read_stream(vk_mal_stream_t *pthis, uint_fast64_t addr, uint_fast32_t size, vsf_stream_t *stream);
 
extern vsf_err_t vk_mal_write_stream(vk_mal_stream_t *pthis, uint_fast64_t addr, uint_fast32_t size, vsf_stream_t *stream);
#endif
 
#ifdef __cplusplus
}
#endif
 
/*============================ INCLUDES ======================================*/
 
#include "./driver/mim_mal/vsf_mim_mal.h"
#include "./driver/mem_mal/vsf_mem_mal.h"
#include "./driver/fakefat32_mal/vsf_fakefat32_mal.h"
#include "./driver/scsi_mal/vsf_scsi_mal.h"
#include "./driver/file_mal/vsf_file_mal.h"
#include "./driver/flash_mal/vsf_flash_mal.h"
#include "./driver/sdmmc_mal/vsf_sdmmc_mal.h"
#include "./driver/cached_mal/vsf_cached_mal.h"
 
#undef __VSF_MAL_CLASS_IMPLEMENT
#undef __VSF_MAL_CLASS_INHERIT__
 
#endif      // VSF_USE_MAL
#endif      // __VSF_MAL_H__