mod: mark sink/src api as private in audio_stream

as agreed some time ago, parts of structures
that should not be modified or accessed directly
("private") should be marked with _ prefix
https://github.com/thesofproject/sof/issues/8100

Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>
This commit is contained in:
Marcin Szkudlinski 2024-04-30 11:33:43 +02:00 committed by Kai Vehmanen
parent 374d2d668d
commit e117e9a004
3 changed files with 20 additions and 20 deletions

View File

@ -8,7 +8,7 @@
static size_t audio_stream_get_free_size(struct sof_sink *sink)
{
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, sink_api);
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, _sink_api);
return audio_stream_get_free_bytes(audio_stream);
}
@ -16,7 +16,7 @@ static size_t audio_stream_get_free_size(struct sof_sink *sink)
static int audio_stream_get_buffer(struct sof_sink *sink, size_t req_size,
void **data_ptr, void **buffer_start, size_t *buffer_size)
{
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, sink_api);
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, _sink_api);
if (req_size > audio_stream_get_free_size(sink))
return -ENODATA;
@ -30,7 +30,7 @@ static int audio_stream_get_buffer(struct sof_sink *sink, size_t req_size,
static int audio_stream_commit_buffer(struct sof_sink *sink, size_t commit_size)
{
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, sink_api);
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, _sink_api);
struct comp_buffer *buffer = container_of(audio_stream, struct comp_buffer, stream);
if (commit_size) {
@ -43,7 +43,7 @@ static int audio_stream_commit_buffer(struct sof_sink *sink, size_t commit_size)
static size_t audio_stream_get_data_available(struct sof_source *source)
{
struct audio_stream *audio_stream = container_of(source, struct audio_stream, source_api);
struct audio_stream *audio_stream = container_of(source, struct audio_stream, _source_api);
return audio_stream_get_avail_bytes(audio_stream);
}
@ -52,7 +52,7 @@ static int audio_stream_get_data(struct sof_source *source, size_t req_size,
void const **data_ptr, void const **buffer_start,
size_t *buffer_size)
{
struct audio_stream *audio_stream = container_of(source, struct audio_stream, source_api);
struct audio_stream *audio_stream = container_of(source, struct audio_stream, _source_api);
struct comp_buffer *buffer = container_of(audio_stream, struct comp_buffer, stream);
if (req_size > audio_stream_get_data_available(source))
@ -105,7 +105,7 @@ void audio_stream_set_align(const uint32_t byte_align,
static int audio_stream_release_data(struct sof_source *source, size_t free_size)
{
struct audio_stream *audio_stream = container_of(source, struct audio_stream, source_api);
struct audio_stream *audio_stream = container_of(source, struct audio_stream, _source_api);
if (free_size)
audio_stream_consume(audio_stream, free_size);
@ -117,7 +117,7 @@ static int audio_stream_set_ipc_params_source(struct sof_source *source,
struct sof_ipc_stream_params *params,
bool force_update)
{
struct audio_stream *audio_stream = container_of(source, struct audio_stream, source_api);
struct audio_stream *audio_stream = container_of(source, struct audio_stream, _source_api);
struct comp_buffer *buffer = container_of(audio_stream, struct comp_buffer, stream);
return buffer_set_params(buffer, params, force_update);
@ -127,7 +127,7 @@ static int audio_stream_set_ipc_params_sink(struct sof_sink *sink,
struct sof_ipc_stream_params *params,
bool force_update)
{
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, sink_api);
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, _sink_api);
struct comp_buffer *buffer = container_of(audio_stream, struct comp_buffer, stream);
return buffer_set_params(buffer, params, force_update);
@ -137,7 +137,7 @@ static int audio_stream_source_set_alignment_constants(struct sof_source *source
const uint32_t byte_align,
const uint32_t frame_align_req)
{
struct audio_stream *audio_stream = container_of(source, struct audio_stream, source_api);
struct audio_stream *audio_stream = container_of(source, struct audio_stream, _source_api);
audio_stream_set_align(byte_align, frame_align_req, audio_stream);
@ -148,7 +148,7 @@ static int audio_stream_sink_set_alignment_constants(struct sof_sink *sink,
const uint32_t byte_align,
const uint32_t frame_align_req)
{
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, sink_api);
struct audio_stream *audio_stream = container_of(sink, struct audio_stream, _sink_api);
audio_stream_set_align(byte_align, frame_align_req, audio_stream);
@ -157,7 +157,7 @@ static int audio_stream_sink_set_alignment_constants(struct sof_sink *sink,
static int source_format_set(struct sof_source *source)
{
struct audio_stream *s = container_of(source, struct audio_stream, source_api);
struct audio_stream *s = container_of(source, struct audio_stream, _source_api);
audio_stream_recalc_align(s);
return 0;
@ -165,7 +165,7 @@ static int source_format_set(struct sof_source *source)
static int sink_format_set(struct sof_sink *sink)
{
struct audio_stream *s = container_of(sink, struct audio_stream, sink_api);
struct audio_stream *s = container_of(sink, struct audio_stream, _sink_api);
audio_stream_recalc_align(s);
return 0;

View File

@ -304,7 +304,7 @@ static int mixin_process(struct processing_module *mod,
* TODO: find out a solution to reach mixout without knowledge of mixin
* sof_sink implementation.
*/
stream = container_of(sinks[i], struct audio_stream, sink_api);
stream = container_of(sinks[i], struct audio_stream, _sink_api);
/* unused buffer between mixin and mixout */
unused_in_between_buf = container_of(stream, struct comp_buffer, stream);
mixout = unused_in_between_buf->sink;
@ -492,7 +492,7 @@ static int mixout_process(struct processing_module *mod,
* TODO: find out a solution to reach mixin without knowledge of mixout
* sof_source implementation.
*/
source_stream = container_of(sources[i], struct audio_stream, source_api);
source_stream = container_of(sources[i], struct audio_stream, _source_api);
unused_in_between_buf = container_of(source_stream, struct comp_buffer,
stream);
mixin = unused_in_between_buf->source;
@ -511,7 +511,7 @@ static int mixout_process(struct processing_module *mod,
struct comp_buffer *unused_in_between_buf;
struct comp_dev *mixin;
source_stream = container_of(sources[i], struct audio_stream, source_api);
source_stream = container_of(sources[i], struct audio_stream, _source_api);
unused_in_between_buf = container_of(source_stream,
struct comp_buffer, stream);
mixin = unused_in_between_buf->source;
@ -588,7 +588,7 @@ static int mixout_reset(struct processing_module *mod)
* sof_source implementation.
*/
source_stream = container_of(mod->sources[i],
struct audio_stream, source_api);
struct audio_stream, _source_api);
source_buf = container_of(source_stream, struct comp_buffer,
stream);

View File

@ -50,8 +50,8 @@
* Audio stream implements pipeline2.0 sink and source API
*/
struct audio_stream {
struct sof_source source_api; /**< source API, don't modify, use helper functions only */
struct sof_sink sink_api; /**< sink API, don't modify, use helper functions only */
struct sof_source _source_api; /**< source API, don't modify, use helper functions only */
struct sof_sink _sink_api; /**< sink API, don't modify, use helper functions only */
/* runtime data */
uint32_t size; /**< Runtime buffer size in bytes (period multiple) */
@ -1021,13 +1021,13 @@ static inline void audio_stream_fmt_conversion(enum ipc4_bit_depth depth,
static inline struct sof_source *
audio_stream_get_source(struct audio_stream *audio_stream)
{
return &audio_stream->source_api;
return &audio_stream->_source_api;
}
static inline struct sof_sink *
audio_stream_get_sink(struct audio_stream *audio_stream)
{
return &audio_stream->sink_api;
return &audio_stream->_sink_api;
}
/** @}*/