zephyr/include/misc/ring_buffer.h

/*
 * Copyright (c) 2015 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_MISC_RING_BUFFER_H_
#define ZEPHYR_INCLUDE_MISC_RING_BUFFER_H_

#warning "This header file has moved, include <ring_buffer.h> instead."

#include <ring_buffer.h>

#endif /* ZEPHYR_INCLUDE_MISC_RING_BUFFER_H_ */
nanokernel: add optional ring buffer data type This patch is based on some code contributed by Dirk Brandewie. This is a generic data structure for queuing data in a FIFO ring buffer. Any given data enqueued is annotated with an app-specific type identifier, and small integral value. Use of a data pointer is optional if the necessary information can be conveyed in the annotations. We want all the metadata to fit in a single DWORD. The ring buffer always contains at least one free dword in the buffer to correctly distinguish between full and empty queues. Concurrency control is almost nonexistent; depending on usage, apps may want to introduce the usage of semaphores and/or mutexes to preserve the integrity of the ring buffer or provide notifications when data is available. Change-Id: I860262d2afc96db4476d4c695a92f7da355ab732 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-08-28 04:07:36 +08:00			`/*`
			`* Copyright (c) 2015 Intel Corporation`
			`*`
license: Replace Apache boilerplate with SPDX tag Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org> 2017-01-19 09:01:01 +08:00			`* SPDX-License-Identifier: Apache-2.0`
nanokernel: add optional ring buffer data type This patch is based on some code contributed by Dirk Brandewie. This is a generic data structure for queuing data in a FIFO ring buffer. Any given data enqueued is annotated with an app-specific type identifier, and small integral value. Use of a data pointer is optional if the necessary information can be conveyed in the annotations. We want all the metadata to fit in a single DWORD. The ring buffer always contains at least one free dword in the buffer to correctly distinguish between full and empty queues. Concurrency control is almost nonexistent; depending on usage, apps may want to introduce the usage of semaphores and/or mutexes to preserve the integrity of the ring buffer or provide notifications when data is available. Change-Id: I860262d2afc96db4476d4c695a92f7da355ab732 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-08-28 04:07:36 +08:00			`*/`
headers: Fix headers across the project Any word started with underscore followed by and uppercase letter or a second underscore is a reserved word according with C99. Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com> 2018-09-15 01:43:44 +08:00			`#ifndef ZEPHYR_INCLUDE_MISC_RING_BUFFER_H_`
			`#define ZEPHYR_INCLUDE_MISC_RING_BUFFER_H_`
nanokernel: add optional ring buffer data type This patch is based on some code contributed by Dirk Brandewie. This is a generic data structure for queuing data in a FIFO ring buffer. Any given data enqueued is annotated with an app-specific type identifier, and small integral value. Use of a data pointer is optional if the necessary information can be conveyed in the annotations. We want all the metadata to fit in a single DWORD. The ring buffer always contains at least one free dword in the buffer to correctly distinguish between full and empty queues. Concurrency control is almost nonexistent; depending on usage, apps may want to introduce the usage of semaphores and/or mutexes to preserve the integrity of the ring buffer or provide notifications when data is available. Change-Id: I860262d2afc96db4476d4c695a92f7da355ab732 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-08-28 04:07:36 +08:00
lib: move ring_buffer from misc/ to lib/ Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-12-15 02:57:03 +08:00			`#warning "This header file has moved, include <ring_buffer.h> instead."`
docs: fixed API linking Change-Id: If9daa0e11c967ee19684dd9d08438f749abf9d5e 2016-02-15 03:24:37 +08:00
lib: move ring_buffer from misc/ to lib/ Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-12-15 02:57:03 +08:00			`#include <ring_buffer.h>`
c++: Add extern "C" { } block to header files Adds extern "C" { } blocks to header files so that they can be safely used by C++ source files. Change-Id: Ia4db0c36a5dac5d3de351184a297d2af0df64532 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com> 2016-01-23 01:38:49 +08:00
headers: Fix headers across the project Any word started with underscore followed by and uppercase letter or a second underscore is a reserved word according with C99. Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com> 2018-09-15 01:43:44 +08:00			`#endif /* ZEPHYR_INCLUDE_MISC_RING_BUFFER_H_ */`