los_dynshm.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2022-2022. All rights reserved.
 * Description: Basic definitions
 * Author: Huawei LiteOS Team
 * Create: 2022-07-01
 * 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 COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 COPYRIGHT HOLDER OR
 * CONTRIBUTORS 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.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_DYN_SHM_H
#define _LOS_DYN_SHM_H
 
#include "los_typedef.h"
#include "los_errno.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define LOS_ERRNO_DYN_SHM_NO_MEMORY             LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x00)
 
#define LOS_ERRNO_DYN_SHM_INPUT_INVALID         LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x01)
 
#define LOS_ERRNO_DYN_SHM_INIT_FAILED           LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x02)
 
#define LOS_ERRNO_DYN_SHM_ALREADY_MAPPED        LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x03)
 
#define LOS_ERRNO_DYN_SHM_INIT_REPEATEDLY       LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x04)
 
#define LOS_ERRNO_DYN_SHM_IN_ISR                LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x05)
 
#define LOS_ERRNO_DYN_SHM_NOT_READY             LOS_ERRNO_OS_ERROR(LOS_MOD_DYN_SHM, 0x06)
 
typedef UINT64 UADDR;
 
#define SHM_CACHE_MASK 0b001
#define SHM_SEC_MASK   0b010
#define SHM_MMZ_MASK   0b100
 
#define LOS_SHM_IS_CACHE(x) ((UINT32)(x) & SHM_CACHE_MASK)
#define LOS_SHM_IS_SEC(x)   ((UINT32)(x) & SHM_SEC_MASK)
#define LOS_SHM_IS_MMZ(x)   ((UINT32)(x) & SHM_MMZ_MASK)
 
#define SHM_ALIGN_UP(val, align)      (((val) + (align) - 1) & (~((UADDR)(align) - 1)))
#define SHM_ALIGN_DN(val, align)      ((val) & (~((UADDR)(align) - 1)))
#define SHM_ALIGN_OFFSET(val, align)  ((val) & ((UADDR)(align) - 1))
 
typedef enum {
    LOS_VA_SPACE_NOSEC_NOCACHE  = 0b000,
    LOS_VA_SPACE_NOSEC_CACHE    = 0b001,
    LOS_VA_SPACE_SEC_NOCACHE    = 0b010,
    LOS_VA_SPACE_SEC_CACHE      = 0b011,
    LOS_VA_SPACE_TYPE_MAX       = 4,
    LOS_MMZ_SPACE_NOSEC_NOCACHE = 0b100,
    LOS_MMZ_SPACE_NOSEC_CACHE   = 0b101,
    LOS_MMZ_SPACE_SEC_NOCACHE   = 0b110,
    LOS_MMZ_SPACE_SEC_CACHE     = 0b111,
    LOS_SHM_TYPE_MAX,
} DynShmMemType;
 
typedef struct {
    UINT32 baseAddr;
    UINT32 tableSize;
} PageTableConfig;
 
typedef struct {
    PageTableConfig nonsec;
    PageTableConfig sec;
} SysPageTable;
 
typedef struct {
    UINT32 startAddr;
    UINT32 size;
    union {
        UINT32 type;
        UINT32 nextRgnIdx;
    };
} DynShmRegion;
 
typedef struct {
    UADDR dmaBuf;    /* It's output param when allocation, while input param when free */
    UINTPTR virAddr; /* It's output param when allocation, while input param when free */
    UADDR phyAddr;   /* It's input param whenever allocation or free */
    UINT32 size;     /* It's input param whenever allocation or free */
    UINT32 type;     /* It's input param whenever allocation or free */
    CHAR *name;
    BOOL noNeedMap;
} DynShmBulkMem;
 
typedef UINT32 (*DynShmFlushIoMmuTlbHandler)(BOOL flushCache);
typedef UINT32 (*DynShmBulkAllocHandler)(DynShmBulkMem *mem);
typedef UINT32 (*DynShmBulkFreeHandler)(DynShmBulkMem *mem);
 
typedef struct {
    SysPageTable outerPageTable;
    SysPageTable innerPageTable;
    UINT32 pageSize;
 
    DynShmFlushIoMmuTlbHandler flushTlbHandler;
    DynShmBulkAllocHandler bulkAllocHandler;
    DynShmBulkFreeHandler bulkFreeHandler;
 
    UINT8 regionCnt;
#define DYN_SHM_RGN_MAX 8
    DynShmRegion regions[DYN_SHM_RGN_MAX];
} DynShmConfig;
 
extern UINT32 LOS_DynShmInit(DynShmConfig *config);
 
extern UINT32 LOS_DynShmMap(UADDR inAddr, UINT32 size, DynShmMemType memType, UINTPTR *outAddr);
 
extern UINT32 LOS_DynShmUnmap(UINTPTR virAddr, UINT32 size);
 
/*
 * INNER_VA means LiteOS running core's virtual address.
 * OUTER_VA means another device's virtual address, instead of LiteOS running core.
 * MEM_PA means real memory's physical address.
 */
typedef enum {
    INNER_VA_TO_OUTER_VA = 0,
    OUTER_VA_TO_INNER_VA,
    INNER_VA_TO_MEM_PA,
    OUTER_VA_TO_MEM_PA,
    SHM_ADDR_TRANS_TYPE_MAX,
} DynShmTransType;
 
extern UINT32 LOS_DynShmAddrTranslate(UADDR inAddr, UADDR *outAddr, DynShmTransType optType);
 
extern VOID *LOS_DynShmBulkMalloc(DynShmBulkMem *mem);
 
extern UINT32 LOS_DynShmBulkFree(DynShmBulkMem *mem);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_DYN_SHM_H */