alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 10:46:02 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge branch 'doc/ringbuffer_v5.1' into 'release/v5.1'

Browse Source 
docs(esp_ringbuf): Corrected example code block (v5.1)

See merge request espressif/esp-idf!30634
This commit is contained in:
Marius Vikhammer 2024-05-15 09:07:36 +08:00
commit a1b0f253a6
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/api-reference/system/freertos_additions.rst
View File

@ -87,9 +87,9 @@ The following example demonstrates the usage of :cpp:func:`xRingbufferSendAcquir
//Retrieve space for DMA descriptor and corresponding data buffer
//This has to be done with SendAcquire, or the address may be different when we copy
dma_item_t item;
dma_item_t *item;
UBaseType_t res = xRingbufferSendAcquire(buf_handle,
&item, DMA_ITEM_SIZE(buffer_size), pdMS_TO_TICKS(1000));
(void**) &item, DMA_ITEM_SIZE(buffer_size), pdMS_TO_TICKS(1000));
if (res != pdTRUE) {
printf("Failed to acquire memory for item\n");
}
@ -98,7 +98,7 @@ The following example demonstrates the usage of :cpp:func:`xRingbufferSendAcquir
.length = buffer_size,
.eof = 0,
.owner = 1,
.buf = &item->buf,
.buf = item->buf,
};
//Actually send to the ring buffer for consumer to use
res = xRingbufferSendComplete(buf_handle, &item);

2
docs/zh_CN/api-reference/system/freertos_additions.rst
View File

@ -1 +1 @@
.. include:: ../../../en/api-reference/system/freertos_additions.rst
.. include:: ../../../en/api-reference/system/freertos_additions.rst