vregion.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
// Copyright(c) 2025 Intel Corporation.
 
/* Pre Allocated Contiguous Virtual Region */
#ifndef __SOF_LIB_VREGION_H__
#define __SOF_LIB_VREGION_H__
 
#include <stddef.h>
#include <stdint.h>
#include <sof/compiler_attributes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct vregion;

enum vregion_mem_type {
    VREGION_MEM_TYPE_INTERIM,       /* interim allocation that can be freed */
    VREGION_MEM_TYPE_LIFETIME,      /* lifetime allocation */
    VREGION_MEM_TYPE_INVALID,       /* Interim heap initialization failed */
};
 
#if CONFIG_SOF_VREGIONS

struct vregion *vregion_create(size_t memsize);

__syscall struct vregion *vregion_create_map(uintptr_t *vreg_start, size_t *vreg_size);

__syscall void vregion_set_interim(struct vregion *vr);

__syscall struct vregion *vregion_get(struct vregion *vr);

__syscall struct vregion *vregion_put(struct vregion *vr);

__syscall void *vregion_alloc_align(struct vregion *vr, size_t size, size_t alignment);

__syscall void *vregion_alloc_coherent_align(struct vregion *vr, size_t size, size_t alignment);

static inline void *vregion_alloc(struct vregion *vr, size_t size)
{
    return vregion_alloc_align(vr, size, 0);
}

static inline void *vregion_alloc_coherent(struct vregion *vr, size_t size)
{
    return vregion_alloc_coherent_align(vr, size, 0);
}

__syscall void vregion_free(struct vregion *vr, void *ptr);

void vregion_info(struct vregion *vr);

void vregion_mem_info(struct vregion *vr, size_t *size, uintptr_t *start);
 
bool vregion_verify(struct vregion *vr);
 
#include <zephyr/syscalls/vregion.h>
 
#else /* CONFIG_SOF_VREGIONS */
 
struct vregion {
    unsigned int use_count;
};
 
static inline struct vregion *vregion_create(size_t memsize)
{
    return NULL;
}
static inline struct vregion *vregion_create_map(uintptr_t *vreg_start, size_t *vreg_size)
{
    return NULL;
}
static inline void vregion_set_interim(struct vregion *vr) {}
static inline struct vregion *vregion_get(struct vregion *vr)
{
    return vr;
}
static inline struct vregion *vregion_put(struct vregion *vr)
{
    return vr;
}
static inline void *vregion_alloc(struct vregion *vr, size_t size)
{
    return NULL;
}
static inline void *vregion_alloc_coherent(struct vregion *vr, size_t size)
{
    return NULL;
}
static inline void *vregion_alloc_align(struct vregion *vr, size_t size, size_t alignment)
{
    return NULL;
}
static inline void *vregion_alloc_coherent_align(struct vregion *vr, size_t size,
                         size_t alignment)
{
    return NULL;
}
static inline void vregion_free(struct vregion *vr, void *ptr) {}
static inline void vregion_info(struct vregion *vr) {}
static inline void vregion_mem_info(struct vregion *vr, size_t *size, uintptr_t *start)
{
    if (size)
        *size = 0;
}
static inline bool vregion_verify(struct vregion *vr) {return false;}
 
#endif /* CONFIG_SOF_VREGIONS */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __SOF_LIB_VREGION_H__ */