Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ring buffer support #2425

Closed
zephyrbot opened this issue Sep 16, 2016 · 4 comments
Closed

Add ring buffer support #2425

zephyrbot opened this issue Sep 16, 2016 · 4 comments
Labels
area: Kernel Enhancement Changes/Updates/Additions to existing features priority: high High impact/importance bug

Comments

@zephyrbot
Copy link
Collaborator

zephyrbot commented Sep 16, 2016

Reported by Benjamin Walsh:

A potpourri of ring buffer-related work items.

Need to decide if ring buffer is a "first class" kernel object (i.e. like a fifo) or not (i.e. like a linked list, which is a "misc" object).
If not:
    Update the Kernel Primer to remove any mention of it. (Although where it would be documented is unclear ...)
    Move ring_buffer.c into "misc" directory.
If so:
    Include file should be relocated, since it doesn't belong under "include/misc".
    Currently lacks concurrent use protection mechanism, unlike other "first class" kernel objects. (This seems to be a deliberate choice, but is it desirable?)
    Currently unclear if ISRs can use ring buffers.
    Kernel Primer documentation should be brought into line with description for other kernel objects.

(Imported from Jira ZEP-918)

@zephyrbot
Copy link
Collaborator Author

by Sharron LIU:

As the issues was resolved with "Won't Do", according to the description of this story, "ring buffer" supposed to be excluded from https://www.zephyrproject.org/doc/kernel_v2/kernel.html
Dmitriy Korovkin , is that change on the way? Thanks.

@zephyrbot
Copy link
Collaborator Author

by Sharron LIU:

The status till git revision 19f2884:

  • header file is under "include/misc/ring_buffer.h", unlike other "first-class" kernel objs.
  • implementation is under "kernel/unified/ring_buffer.c", like other "first-class" kernel objs.
  • ring buffer still kept TBD in the kernel primer v2 doc

This does not seem inline with the description of this story. Dmitriy Korovkin , Benjamin Walsh , could you update if any new conclusion reached to resolve the story as "Won't Do"? Thanks.

The current status is a little bit confusing if ring buffer is treated as "first-class" or not...

@zephyrbot
Copy link
Collaborator Author

by Dmitriy Korovkin:

Per discussion, ring buffer will be kept in the kernel as a simple tool for kernel developers. "Won't do" means that ring buffers are not going to be exported as a public kernel object available for application developers, as the community do not see any need for this.

@zephyrbot
Copy link
Collaborator Author

by Sharron LIU:

That's clear now. Does it mean to remove ring buffer from "kernel primer v2"?

Closing per Dmitriy Korovkin clarification.

@zephyrbot zephyrbot added priority: high High impact/importance bug area: Kernel Enhancement Changes/Updates/Additions to existing features labels Sep 23, 2017
@zephyrbot zephyrbot mentioned this issue Sep 23, 2017
49 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Kernel Enhancement Changes/Updates/Additions to existing features priority: high High impact/importance bug
Projects
None yet
Development

No branches or pull requests

1 participant