samples: update to new ring_buffer api

samples to use new ring_buffer api.

Signed-off-by: Måns Ansgariusson <[email protected]>

Author: Mattemagikern

samples/bluetooth/bap_broadcast_sink/Kconfig

@@ -58,7 +58,6 @@ config USE_USB_AUDIO_OUTPUT
 	depends on ENABLE_LC3
 	select USB_DEVICE_STACK_NEXT
 	select USBD_AUDIO2_CLASS
-	select RING_BUFFER
 	help
 	  Enables USB audio as output as a USB peripheral. This does not support providing USB
 	  audio to e.g. speakers that are also USB peripherals, but can be connected to e.g. a

samples/bluetooth/bap_broadcast_sink/src/usb.c

@@ -59,7 +59,7 @@ struct decoded_sdu {
 	uint32_t ts;
 } decoded_sdu;
 
-RING_BUF_DECLARE(usb_in_ring_buf, USB_IN_RING_BUF_SIZE);
+RING_BUFFER_DECLARE(usb_in_ring_buf, USB_IN_RING_BUF_SIZE);
 K_MEM_SLAB_DEFINE_STATIC(usb_in_buf_pool, ROUND_UP(USB_STEREO_FRAME_SIZE, UDC_BUF_GRANULARITY),
 			 USB_ENQUEUE_COUNT, UDC_BUF_ALIGN);
 static volatile bool terminal_enabled;
@@ -73,7 +73,7 @@ static void uac2_sof_cb(const struct device *dev, void *user_data)
 
 	if (!terminal_enabled) {
 		/* Simply discard the data then */
-		(void)ring_buf_get(&usb_in_ring_buf, NULL, USB_STEREO_FRAME_SIZE);
+		(void)ring_buffer_read(&usb_in_ring_buf, NULL, USB_STEREO_FRAME_SIZE);
 		return;
 	}
 
@@ -83,7 +83,7 @@ static void uac2_sof_cb(const struct device *dev, void *user_data)
 		return;
 	}
 
-	size = ring_buf_get(&usb_in_ring_buf, pcm_buf, USB_STEREO_FRAME_SIZE);
+	size = ring_buffer_read(&usb_in_ring_buf, pcm_buf, USB_STEREO_FRAME_SIZE);
 	if (size != USB_STEREO_FRAME_SIZE) {
 		/* If we could not fill the buffer, zero-fill the rest (possibly all) */
 		memset(((uint8_t *)pcm_buf) + size, 0, USB_STEREO_FRAME_SIZE - size);
@@ -155,7 +155,7 @@ static void usb_send_frames_to_usb(void)
 		uint32_t rb_size;
 
 		/* Not enough space to store data */
-		if (ring_buf_space_get(&usb_in_ring_buf) < sizeof(stereo_frame)) {
+		if (ring_buffer_space(&usb_in_ring_buf) < sizeof(stereo_frame)) {
 			if (CONFIG_INFO_REPORTING_INTERVAL > 0 &&
 			    (fail_cnt % CONFIG_INFO_REPORTING_INTERVAL) == 0U) {
 				LOG_WRN("[%zu] Could not send more than %zu frames to USB",
@@ -194,7 +194,7 @@ static void usb_send_frames_to_usb(void)
 			}
 		}
 
-		rb_size = ring_buf_put(&usb_in_ring_buf, (uint8_t *)stereo_frame,
+		rb_size = ring_buffer_write(&usb_in_ring_buf, (uint8_t *)stereo_frame,
 				       sizeof(stereo_frame));
 		if (rb_size != sizeof(stereo_frame)) {
 			LOG_WRN("Failed to put frame on USB ring buf");

samples/bluetooth/bap_broadcast_source/Kconfig

@@ -41,7 +41,6 @@ config USE_USB_AUDIO_INPUT
 	depends on ENABLE_LC3
 	select USB_DEVICE_STACK_NEXT
 	select USBD_AUDIO2_CLASS
-	select RING_BUFFER
 
 config BROADCAST_CODE
 	string "The broadcast code (if any) to use for encrypted broadcast"

samples/bluetooth/bap_broadcast_source/src/main.c

@@ -142,7 +142,7 @@ static struct broadcast_source_stream {
 	lc3_encoder_mem_48k_t lc3_encoder_mem;
 #endif
 #if defined(CONFIG_USE_USB_AUDIO_INPUT)
-	struct ring_buf audio_ring_buf;
+	struct ring_buffer audio_ring_buf;
 	uint8_t _ring_buffer_memory[AUDIO_RING_BUF_BYTES];
 #endif /* defined(CONFIG_USE_USB_AUDIO_INPUT) */
 #endif /* defined(CONFIG_LIBLC3) */
@@ -197,7 +197,7 @@ static void send_data(struct broadcast_source_stream *source_stream)
 	}
 
 #if defined(CONFIG_USE_USB_AUDIO_INPUT)
-	uint32_t size = ring_buf_get(&source_stream->audio_ring_buf, (uint8_t *)send_pcm_data,
+	uint32_t size = ring_buffer_read(&source_stream->audio_ring_buf, (uint8_t *)send_pcm_data,
 				     sizeof(send_pcm_data));
 
 	if (size < sizeof(send_pcm_data)) {
@@ -373,13 +373,14 @@ static void data_recv_cb(const struct device *dev, uint8_t terminal, void *buf,
 
 	for (size_t i = 0U; i < MIN(ARRAY_SIZE(streams), 2); i++) {
 		const uint32_t size_put =
-			ring_buf_put(&(streams[i].audio_ring_buf), (uint8_t *)(usb_pcm_data[i]),
-				     nsamples * USB_BYTES_PER_SAMPLE);
+			ring_buffer_write(&(streams[i].audio_ring_buf),
+					(uint8_t *)(usb_pcm_data[i]),
+					nsamples * USB_BYTES_PER_SAMPLE);
 		if (size_put < nsamples * USB_BYTES_PER_SAMPLE) {
 			printk("Not enough room for samples in %s buffer: %u < %u, total capacity: "
 			       "%u\n",
 			       i == 0 ? "left" : "right", size_put, nsamples * USB_BYTES_PER_SAMPLE,
-			       ring_buf_capacity_get(&(streams[i].audio_ring_buf)));
+			       ring_buffer_capacity(&(streams[i].audio_ring_buf)));
 		}
 	}
 
@@ -540,10 +541,11 @@ int main(void)
 	(void)memset(streams, 0, sizeof(streams));
 
 	for (size_t i = 0U; i < ARRAY_SIZE(streams); i++) {
-		ring_buf_init(&(streams[i].audio_ring_buf), sizeof(streams[i]._ring_buffer_memory),
-			      streams[i]._ring_buffer_memory);
+		ring_buffer_init(&(streams[i].audio_ring_buf),
+				streams[i]._ring_buffer_memory,
+				sizeof(streams[i]._ring_buffer_memory));
 		printk("Initialized ring buf %zu: capacity: %u\n", i,
-		       ring_buf_capacity_get(&(streams[i].audio_ring_buf)));
+		       ring_buffer_capacity(&(streams[i].audio_ring_buf)));
 	}
 
 	usbd_uac2_set_ops(broadcaster_dev, &usb_audio_ops, NULL);

samples/boards/st/uart/circular_dma/prj.conf

@@ -1,3 +1,2 @@
 CONFIG_SERIAL=y
 CONFIG_UART_ASYNC_API=y
-CONFIG_RING_BUFFER=y

samples/boards/st/uart/circular_dma/src/main.c

@@ -31,7 +31,7 @@ const struct uart_config uart_cfg = {.baudrate = 115200,
 				     .flow_ctrl = UART_CFG_FLOW_CTRL_NONE};
 
 /* define a ring buffer to get raw bytes*/
-RING_BUF_DECLARE(ring_buf, RING_BUF_SIZE);
+RING_BUFFER_DECLARE(ring_buf, RING_BUF_SIZE);
 
 /* define uart rx buffer */
 static uint8_t rx_buffer[RX_BUF_SIZE];
@@ -63,7 +63,7 @@ static void uart_rx_thread(void *p1, void *p2, void *p3)
 	while (1) {
 
 		/* Check if there's data in the ring buffer */
-		len = ring_buf_get(&ring_buf, rx_data, sizeof(rx_data));
+		len = ring_buffer_read(&ring_buf, rx_data, sizeof(rx_data));
 
 		if (len > 0) {
 
@@ -78,7 +78,8 @@ void uart_cb(const struct device *dev, struct uart_event *evt, void *user_data)
 	switch (evt->type) {
 	case UART_RX_RDY:
 		/* Data received; place into ring buffer */
-		ring_buf_put(&ring_buf, evt->data.rx.buf + evt->data.rx.offset, evt->data.rx.len);
+		ring_buffer_write(&ring_buf, evt->data.rx.buf + evt->data.rx.offset,
+				evt->data.rx.len);
 
 		break;
 

samples/drivers/uart/passthrough/prj.conf

@@ -1,3 +1,2 @@
 CONFIG_SERIAL=y
-CONFIG_RING_BUFFER=y
 CONFIG_UART_INTERRUPT_DRIVEN=y

samples/drivers/uart/passthrough/src/main.c

@@ -16,7 +16,7 @@ struct patch_info {
 	const uint8_t * const name;
 
 	const struct device *rx_dev;
-	struct ring_buf *rx_ring_buf;
+	struct ring_buffer *rx_ring_buf;
 	bool rx_error;
 	bool rx_overflow;
 
@@ -28,7 +28,7 @@ struct patch_info {
 
 #define RING_BUF_SIZE 64
 
-RING_BUF_DECLARE(rb_console, RING_BUF_SIZE);
+RING_BUFFER_DECLARE(rb_console, RING_BUF_SIZE);
 struct patch_info patch_c2o = {
 	.name = "c2o",
 
@@ -40,7 +40,7 @@ struct patch_info patch_c2o = {
 	.tx_dev = DEV_OTHER,
 };
 
-RING_BUF_DECLARE(rb_other, RING_BUF_SIZE);
+RING_BUFFER_DECLARE(rb_other, RING_BUF_SIZE);
 struct patch_info patch_o2c = {
 	.name = "o2c",
 
@@ -68,7 +68,7 @@ static void uart_cb(const struct device *dev, void *ctx)
 			break;
 		}
 
-		len = ring_buf_put_claim(patch->rx_ring_buf, &buf, RING_BUF_SIZE);
+		len = ring_buffer_write_ptr(patch->rx_ring_buf, &buf);
 		if (len == 0) {
 			/* no space for Rx, disable the IRQ */
 			uart_irq_rx_disable(patch->rx_dev);
@@ -84,12 +84,7 @@ static void uart_cb(const struct device *dev, void *ctx)
 			break;
 		}
 		len = ret;
-
-		ret = ring_buf_put_finish(patch->rx_ring_buf, len);
-		if (ret != 0) {
-			patch->rx_error = true;
-			break;
-		}
+		ring_buffer_commit(patch->rx_ring_buf, len);
 	}
 }
 
@@ -109,7 +104,7 @@ static void passthrough(struct patch_info *patch)
 		patch->rx_overflow = false;
 	}
 
-	len = ring_buf_get_claim(patch->rx_ring_buf, &buf, RING_BUF_SIZE);
+	len = ring_buffer_read_ptr(patch->rx_ring_buf, &buf);
 	if (len == 0) {
 		goto done;
 	}
@@ -120,10 +115,7 @@ static void passthrough(struct patch_info *patch)
 	}
 	len = ret;
 
-	ret = ring_buf_get_finish(patch->rx_ring_buf, len);
-	if (ret < 0) {
-		goto error;
-	}
+	ring_buffer_consume(patch->rx_ring_buf, len);
 
 done:
 	uart_irq_rx_enable(patch->rx_dev);

samples/subsys/usb/cdc_acm/src/main.c

@@ -22,7 +22,7 @@ const struct device *const uart_dev = DEVICE_DT_GET_ONE(zephyr_cdc_acm_uart);
 #define RING_BUF_SIZE 1024
 uint8_t ring_buffer[RING_BUF_SIZE];
 
-struct ring_buf ringbuf;
+struct ring_buffer ringbuf;
 
 static bool rx_throttled;
 
@@ -105,7 +105,7 @@ static void interrupt_handler(const struct device *dev, void *user_data)
 		if (!rx_throttled && uart_irq_rx_ready(dev)) {
 			int recv_len, rb_len;
 			uint8_t buffer[64];
-			size_t len = MIN(ring_buf_space_get(&ringbuf),
+			size_t len = MIN(ring_buffer_space(&ringbuf),
 					 sizeof(buffer));
 
 			if (len == 0) {
@@ -121,7 +121,7 @@ static void interrupt_handler(const struct device *dev, void *user_data)
 				recv_len = 0;
 			};
 
-			rb_len = ring_buf_put(&ringbuf, buffer, recv_len);
+			rb_len = ring_buffer_write(&ringbuf, buffer, recv_len);
 			if (rb_len < recv_len) {
 				LOG_ERR("Drop %u bytes", recv_len - rb_len);
 			}
@@ -136,7 +136,7 @@ static void interrupt_handler(const struct device *dev, void *user_data)
 			uint8_t buffer[64];
 			int rb_len, send_len;
 
-			rb_len = ring_buf_get(&ringbuf, buffer, sizeof(buffer));
+			rb_len = ring_buffer_read(&ringbuf, buffer, sizeof(buffer));
 			if (!rb_len) {
 				LOG_DBG("Ring buffer empty, disable TX IRQ");
 				uart_irq_tx_disable(dev);
@@ -173,7 +173,7 @@ int main(void)
 		return 0;
 	}
 
-	ring_buf_init(&ringbuf, sizeof(ring_buffer), ring_buffer);
+	ring_buffer_init(&ringbuf, ring_buffer, sizeof(ring_buffer));
 
 	LOG_INF("Wait for DTR");
 	k_sem_take(&dtr_sem, K_FOREVER);

samples/subsys/usb/legacy/cdc_acm/src/main.c

@@ -20,7 +20,7 @@ const struct device *const uart_dev = DEVICE_DT_GET_ONE(zephyr_cdc_acm_uart);
 #define RING_BUF_SIZE 1024
 uint8_t ring_buffer[RING_BUF_SIZE];
 
-struct ring_buf ringbuf;
+struct ring_buffer ringbuf;
 
 static bool rx_throttled;
 
@@ -45,7 +45,7 @@ static void interrupt_handler(const struct device *dev, void *user_data)
 		if (!rx_throttled && uart_irq_rx_ready(dev)) {
 			int recv_len, rb_len;
 			uint8_t buffer[64];
-			size_t len = MIN(ring_buf_space_get(&ringbuf),
+			size_t len = MIN(ring_buffer_space(&ringbuf),
 					 sizeof(buffer));
 
 			if (len == 0) {
@@ -61,7 +61,7 @@ static void interrupt_handler(const struct device *dev, void *user_data)
 				recv_len = 0;
 			};
 
-			rb_len = ring_buf_put(&ringbuf, buffer, recv_len);
+			rb_len = ring_buffer_write(&ringbuf, buffer, recv_len);
 			if (rb_len < recv_len) {
 				LOG_ERR("Drop %u bytes", recv_len - rb_len);
 			}
@@ -76,7 +76,7 @@ static void interrupt_handler(const struct device *dev, void *user_data)
 			uint8_t buffer[64];
 			int rb_len, send_len;
 
-			rb_len = ring_buf_get(&ringbuf, buffer, sizeof(buffer));
+			rb_len = ring_buffer_read(&ringbuf, buffer, sizeof(buffer));
 			if (!rb_len) {
 				LOG_DBG("Ring buffer empty, disable TX IRQ");
 				uart_irq_tx_disable(dev);
@@ -113,7 +113,7 @@ int main(void)
 		return 0;
 	}
 
-	ring_buf_init(&ringbuf, sizeof(ring_buffer), ring_buffer);
+	ring_buffer_init(&ringbuf, ring_buffer, sizeof(ring_buffer));
 
 	LOG_INF("Wait for DTR");