sp500/dsp.h Source File

sp500/dsp.h Source File#

Mobilint REGULUS: sp500/dsp.h Source File
Mobilint REGULUS v4.1
SP500 DSP API
sp500
#ifndef SP500_DSP_H
#define SP500_DSP_H
 
#include <stdint.h>
#include <stddef.h>
 
/* ---------------------------------------------------------------- version -- */
 
#define SP500_VERSION_MAJOR 1
#define SP500_VERSION_MINOR 0
#define SP500_VERSION_PATCH 0
#define SP500_VERSION_INT (((SP500_VERSION_MAJOR) * 10000) + \
                           ((SP500_VERSION_MINOR) * 100) + (SP500_VERSION_PATCH))
 
/* -------------------------------------------------------- linkage macros -- */
 
#if defined(__GNUC__) || defined(__clang__)
#  define SP500_API __attribute__((visibility("default")))
#else
#  define SP500_API
#endif
 
#ifdef __cplusplus
#  define SP500_INLINE inline
extern "C" {
#else
#  define SP500_INLINE static inline
#endif
 
/* ----------------------------------------------------------------- status -- */
typedef int32_t sp500_status;
 
enum
{
    SP500_OK                    =  0,  
    SP500_ERR_INVALID_ARG       = -1,  
    SP500_ERR_UNSUPPORTED       = -2,  
    SP500_ERR_BUFFER_TOO_SMALL  = -3,  
    SP500_ERR_NOT_READY         = -4,  
    SP500_ERR_NO_MEMORY         = -5,  
    SP500_ERR_TIMEOUT           = -6,  
    SP500_ERR_DSP               = -7,  
    SP500_ERR_INTERNAL          = -8   
};
SP500_API const char* sp500_status_string(sp500_status status);
SP500_API uint32_t sp500_version(void);
SP500_API const char* sp500_version_string(void);
 
/* -------------------------------------------------------------- lifecycle -- */
#define SP500_DEFAULT_OPEN_TIMEOUT_MS 10000u
#define SP500_DEFAULT_DSP_TIMEOUT_MS 3000u
SP500_API sp500_status sp500_dsp_open(uint32_t timeout_ms);
SP500_API int sp500_dsp_is_open(void);
SP500_API void sp500_set_dsp_timeout_ms(uint32_t timeout_ms);
SP500_API uint32_t sp500_get_dsp_timeout_ms(void);
 
/* ------------------------------------------------------------------- lock -- */
SP500_API void sp500_dsp_lock(void);
SP500_API void sp500_dsp_unlock(void);
 
/* ---------------------------------------------------------- shared memory -- */
#define SP500_ALIGN_DSP 32u
#define SP500_ALIGN_NPU 4096u
SP500_API void* sp500_shmem_alloc(uint32_t size, uint32_t alignment);
SP500_API void sp500_shmem_free(void* ptr);
SP500_API int sp500_shmem_contains(const void* ptr);
SP500_API uint64_t sp500_shmem_phys_addr(const void* ptr);
 
/* ---------------------------------------------------------------- buffers -- */
enum
{
    SP500_BUFFER_SHARED = 1u << 0
};
typedef struct sp500_buffer
{
    void*    data;   
    uint32_t size;   
    uint32_t flags;  
} sp500_buffer;
SP500_INLINE sp500_buffer sp500_buffer_none(void)
{
    sp500_buffer b;
    b.data = NULL;
    b.size = 0u;
    b.flags = 0u;
    return b;
}
SP500_INLINE sp500_buffer sp500_buffer_alloc(uint32_t size, uint32_t alignment)
{
    sp500_buffer b = sp500_buffer_none();
    b.data = sp500_shmem_alloc(size, alignment);
    if(b.data != NULL)
    {
        b.size = size;
        b.flags = SP500_BUFFER_SHARED;
    }
    return b;
}
SP500_INLINE sp500_buffer sp500_buffer_wrap(void* data, uint32_t size)
{
    sp500_buffer b = sp500_buffer_none();
    b.data = data;
    b.size = size;
    return b;
}
SP500_INLINE void sp500_buffer_release(sp500_buffer* buffer)
{
    if(buffer != NULL)
    {
        if((buffer->flags & SP500_BUFFER_SHARED) != 0u)
        {
            sp500_shmem_free(buffer->data);
        }
        *buffer = sp500_buffer_none();
    }
}
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SP500_DSP_H */