Skip to content

Commit c2ce371

Browse files
kv2019ikv2019i
committed
audio: buffer: use add BUFFER_USAGE_ flags to improve readability
Passing boolean parameters to key functions results in hard to read code. Add BUFFER_USAGE_SHARED and BUFFER_USAGE_NOT_SHARED definitions to make code allocating buffers easier to read and maintain. No functional change. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
1 parent 42c0875 commit c2ce371

File tree

15 files changed

+52
-46
lines changed

15 files changed

+52
-46
lines changed

‎src/audio/chain_dma.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ __cold static int chain_task_init(struct comp_dev *dev, uint8_t host_dma_id, uin
592592
fifo_size = ALIGN_UP_INTERNAL(fifo_size, addr_align);
593593
/* allocate not shared buffer */
594594
cd->dma_buffer = buffer_alloc(fifo_size, SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA,
595-
addr_align, false);
595+
addr_align, BUFFER_USAGE_NOT_SHARED);
596596

597597
if (!cd->dma_buffer) {
598598
comp_err(dev, "failed to alloc dma buffer");

‎src/audio/copier/copier_generic.c‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,8 +427,7 @@ __cold int create_multi_endpoint_buffer(struct comp_dev *dev,
427427
ipc_buf.size = buf_size;
428428
ipc_buf.comp.pipeline_id = config->pipeline_id;
429429
ipc_buf.comp.core = config->core;
430-
/* allocate not shared buffer */
431-
buffer = buffer_new(&ipc_buf, false);
430+
buffer = buffer_new(&ipc_buf, BUFFER_USAGE_NOT_SHARED);
432431
if (!buffer)
433432
return -ENOMEM;
434433

‎src/audio/dai-legacy.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ int dai_common_params(struct dai_data *dd, struct comp_dev *dev,
562562
}
563563
} else {
564564
dd->dma_buffer = buffer_alloc(buffer_size, SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA,
565-
addr_align, false);
565+
addr_align, BUFFER_USAGE_NOT_SHARED);
566566
if (!dd->dma_buffer) {
567567
comp_err(dev, "failed to alloc dma buffer");
568568
return -ENOMEM;

‎src/audio/dai-zephyr.c‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1020,7 +1020,8 @@ static int dai_set_dma_buffer(struct dai_data *dd, struct comp_dev *dev,
10201020
}
10211021
} else {
10221022
dd->dma_buffer = buffer_alloc_range(buffer_size_preferred, buffer_size,
1023-
SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA, addr_align, false);
1023+
SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA,
1024+
addr_align, BUFFER_USAGE_NOT_SHARED);
10241025
if (!dd->dma_buffer) {
10251026
comp_err(dev, "failed to alloc dma buffer");
10261027
return -ENOMEM;

‎src/audio/host-legacy.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ int host_common_params(struct host_data *hd, struct comp_dev *dev,
760760
}
761761
} else {
762762
hd->dma_buffer = buffer_alloc(buffer_size, SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA,
763-
addr_align, false);
763+
addr_align, BUFFER_USAGE_NOT_SHARED);
764764
if (!hd->dma_buffer) {
765765
comp_err(dev, "failed to alloc dma buffer");
766766
err = -ENOMEM;

‎src/audio/host-zephyr.c‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -921,7 +921,8 @@ int host_common_params(struct host_data *hd, struct comp_dev *dev,
921921
} else {
922922
/* allocate not shared buffer */
923923
hd->dma_buffer = buffer_alloc_range(buffer_size_preferred, buffer_size,
924-
SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA, addr_align, false);
924+
SOF_MEM_FLAG_USER | SOF_MEM_FLAG_DMA,
925+
addr_align, BUFFER_USAGE_NOT_SHARED);
925926
if (!hd->dma_buffer) {
926927
comp_err(dev, "failed to alloc dma buffer");
927928
return -ENOMEM;

‎src/audio/module_adapter/module_adapter.c‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,8 @@ int module_adapter_prepare(struct comp_dev *dev)
451451
for (i = 0; i < mod->num_of_sinks; i++) {
452452
/* allocate not shared buffer */
453453
struct comp_buffer *buffer = buffer_alloc(buff_size, memory_flags,
454-
PLATFORM_DCACHE_ALIGN, false);
454+
PLATFORM_DCACHE_ALIGN,
455+
BUFFER_USAGE_NOT_SHARED);
455456
uint32_t flags;
456457

457458
if (!buffer) {

‎src/include/sof/audio/buffer.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@ extern struct tr_ctx buffer_tr;
117117
#define BUFF_PARAMS_RATE BIT(2)
118118
#define BUFF_PARAMS_CHANNELS BIT(3)
119119

120+
/* buffer usage */
121+
#define BUFFER_USAGE_SHARED true /* buffer used by multiple DSP core and/or HW blocks */
122+
#define BUFFER_USAGE_NOT_SHARED false /* buffer only used by one HW block */
123+
120124
/*
121125
* audio component buffer - connects 2 audio components together in pipeline.
122126
*

‎src/ipc/ipc3/helper.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ int ipc_buffer_new(struct ipc *ipc, const struct sof_ipc_buffer *desc)
485485
}
486486

487487
/* register buffer with pipeline */
488-
buffer = buffer_new(desc, false);
488+
buffer = buffer_new(desc, BUFFER_USAGE_NOT_SHARED);
489489
if (!buffer) {
490490
tr_err(&ipc_tr, "buffer_new() failed");
491491
return -ENOMEM;

‎test/cmocka/src/audio/buffer/buffer_copy.c‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ static void test_audio_buffer_copy_underrun(void **state)
2929
.size = 256
3030
};
3131

32-
struct comp_buffer *src = buffer_new(&test_buf_desc, false);
33-
struct comp_buffer *snk = buffer_new(&test_buf_desc, false);
32+
struct comp_buffer *src = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
33+
struct comp_buffer *snk = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
3434

3535
assert_non_null(src);
3636
assert_non_null(snk);
@@ -56,8 +56,8 @@ static void test_audio_buffer_copy_overrun(void **state)
5656
.size = 256
5757
};
5858

59-
struct comp_buffer *src = buffer_new(&test_buf_desc, false);
60-
struct comp_buffer *snk = buffer_new(&test_buf_desc, false);
59+
struct comp_buffer *src = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
60+
struct comp_buffer *snk = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
6161

6262
assert_non_null(src);
6363
assert_non_null(snk);
@@ -85,8 +85,8 @@ static void test_audio_buffer_copy_success(void **state)
8585
.size = 256
8686
};
8787

88-
struct comp_buffer *src = buffer_new(&test_buf_desc, false);
89-
struct comp_buffer *snk = buffer_new(&test_buf_desc, false);
88+
struct comp_buffer *src = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
89+
struct comp_buffer *snk = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
9090

9191
assert_non_null(src);
9292
assert_non_null(snk);
@@ -111,8 +111,8 @@ static void test_audio_buffer_copy_fit_space_constraint(void **state)
111111
.size = 256
112112
};
113113

114-
struct comp_buffer *src = buffer_new(&test_buf_desc, false);
115-
struct comp_buffer *snk = buffer_new(&test_buf_desc, false);
114+
struct comp_buffer *src = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
115+
struct comp_buffer *snk = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
116116

117117
assert_non_null(src);
118118
assert_non_null(snk);
@@ -139,8 +139,8 @@ static void test_audio_buffer_copy_fit_no_space_constraint(void **state)
139139
.size = 256
140140
};
141141

142-
struct comp_buffer *src = buffer_new(&test_buf_desc, false);
143-
struct comp_buffer *snk = buffer_new(&test_buf_desc, false);
142+
struct comp_buffer *src = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
143+
struct comp_buffer *snk = buffer_new(&test_buf_desc, BUFFER_USAGE_NOT_SHARED);
144144

145145
assert_non_null(src);
146146
assert_non_null(snk);

0 commit comments

Comments
 (0)