ring_buffer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2023 Intel Corporation. All rights reserved.
 *
 */
 
#ifndef __SOF_RING_BUFFER_H__
#define __SOF_RING_BUFFER_H__
 
#include <sof/audio/sink_api.h>
#include <sof/audio/source_api.h>
#include <sof/audio/audio_stream.h>
#include <sof/audio/audio_buffer.h>
#include <rtos/bit.h>
#include <sof/common.h>
#include <ipc/topology.h>
#include <sof/coherent.h>

 
struct comp_dev;
struct ring_buffer;
struct sof_audio_stream_params;
 
/* the ring_buffer structure */
struct ring_buffer {
    /* public: read only */
    struct sof_audio_buffer audio_buffer;
 
    size_t data_buffer_size;
 
    uint8_t __sparse_cache *_data_buffer;
    size_t _write_offset;       /* private: to be modified by data producer using API */
    size_t _read_offset;        /* private: to be modified by data consumer using API */
};

struct ring_buffer *ring_buffer_create(struct comp_dev *dev, size_t min_available,
                       size_t min_free_space, bool is_shared,
                       uint32_t id);
 
#endif /* __SOF_RING_BUFFER_H__ */