zephyrproject-rtos/zephyr

Port drivers to use sys/ring_buffer

Open

#21,155 opened on Dec 3, 2019

View on GitHub
 (8 comments) (0 reactions) (0 assignees)C (15,249 stars) (9,144 forks)batch import
EnhancementGood first issuearea: Drivers

Description

There are some drivers that are implementing their own ring_buffer, there are cases where even functions names are colliding with sys/ring_buffer.

Drivers doing it: drivers/ethernet/eth_sam_gmac.c drivers/i2s/i2s_sam_ssc.c drivers/i2s/i2s_ll_stm32.h

Contributor guide

Tech stack
c
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of CFamiliarity with Zephyr driver modelUnderstanding of ring buffer API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the three listed driver files (eth sam gmac.c, i2s sam ssc.c, i2s ll stm32.h) to identify their custom ring buffer implementations. Replace each with the generic sys/ring buffer from the Zephyr kernel, ensuring function name collisions are resolved and the existing behavior is preserved. Check for any usage of the old ring buffer functions in header files or other modules, and update accordingly. Verify compilation and run relevant tests to ensure no regressions.