xt_mem.h

浏览该文件的文档.

 
#ifndef __XT_MEM_H__
#define __XT_MEM_H__
 
/* ==================== [Includes] ========================================== */
 
#include <stddef.h>
#include <stdint.h>
 
#include "xt_error.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_MEM_CAP_REGION_S       (0)
#define XT_MEM_CAP_REGION_W       (4)
#define XT_MEM_CAP_ALIGN_S        (4)
#define XT_MEM_CAP_ALIGN_W        (4)
#define XT_MEM_CAP_FLAG_S         (8)
#define XT_MEM_CAP_FLAG_W         (8)
 
/* 内存区域 */
#define XT_MEM_CAP_DEFAULT        (0 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_EXTERNAL       (1 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_REGION_0       (2 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_REGION_1       (3 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_REGION_2       (4 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_REGION_3       (5 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_REGION_4       (6 << XT_MEM_CAP_REGION_S)    
#define XT_MEM_CAP_REGION_5       (7 << XT_MEM_CAP_REGION_S)    
 
/* 内存对齐 */
#define XT_MEM_CAP_ALIGN_8        (0 << XT_MEM_CAP_ALIGN_S)    
#define XT_MEM_CAP_ALIGN_16       (1 << XT_MEM_CAP_ALIGN_S)    
#define XT_MEM_CAP_ALIGN_32       (2 << XT_MEM_CAP_ALIGN_S)    
#define XT_MEM_CAP_ALIGN_64       (3 << XT_MEM_CAP_ALIGN_S)    
// #define XT_MEM_CAP_ALIGN_128      (4 << XT_MEM_CAP_ALIGN_S)    /*!< 128 位对齐 */
// #define XT_MEM_CAP_ALIGN_256      (5 << XT_MEM_CAP_ALIGN_S)    /*!< 256 位对齐 */
// #define XT_MEM_CAP_ALIGN_512      (6 << XT_MEM_CAP_ALIGN_S)    /*!< 512 位对齐 */
// #define XT_MEM_CAP_ALIGN_1024     (7 << XT_MEM_CAP_ALIGN_S)    /*!< 1024 位对齐 */
 
/* 内存标志 */
#define XT_MEM_CAP_RESET          (1 << 8)    
#define XT_MEM_CAP_DMA            (1 << 9)    
#define XT_MEM_CAP_EXEC           (1 << 10)   
 
/* ==================== [Typedefs] ========================================== */
 
/* ==================== [Global Prototypes] ================================= */

void *xt_mem_malloc(size_t size);

void *xt_mem_calloc(size_t count, size_t size);

void *xt_mem_realloc(void *ptr, size_t size);

xt_err_t xt_mem_free(void *ptr);

void *xt_mem_caps_malloc(size_t size, uint32_t caps);

void *xt_mem_caps_realloc(void *ptr, size_t size, uint32_t caps);

xt_err_t xt_mem_caps_free(void *ptr);
 
/* ==================== [Macros] ============================================ */
 
#define xt_malloc(size)         xt_mem_malloc(size)
#define xt_calloc(count, size)  xt_mem_calloc((count), (size))
#define xt_realloc(ptr, size)   xt_mem_realloc((ptr), (size))
#define xt_free(ptr)            xt_mem_free(ptr)
 
#define xt_caps_malloc(size, caps)          xt_mem_caps_malloc((size), (caps))
#define xt_caps_realloc(ptr, size, caps)    xt_mem_caps_realloc((ptr), (size), (caps))
#define xt_caps_free(ptr)                   xt_mem_caps_free(ptr)
  /* xt_mem */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_MEM_H__ */