zephyr/include/ipm.h

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

#ifndef CONFIG_COMPAT_INCLUDES
#warning "This header file has moved, include <drivers/ipm.h> instead."
#endif

#include <drivers/ipm.h>

#endif /* ZEPHYR_INCLUDE_IPM_H_ */
ipi.h: introduce low-level inter-processor interrupt API This interface is an abstraction for sending messages between processors with irq-context callbacks and no definition of protocol. We assume that for all IPC implementations, we can send over a message identifier and a sized data payload, and that the receiving side gets an interrupt on an incoming message. APIs exist to indicate the max value of the message id and how much data can be sent over a single message. This will be a foundation to build various high-level drivers which can be bound at runtime to this low-level interface. Some examples: * IPC where IPC messages are used as a doorbell to signal new data in a shared queue * IPC with various kinds of message buffering and deferred message processing via semaphores * IPC for serial console debug output, either a byte or a message at a time * IPC over UARTS in a non-shared memory environment where large-ish messages are exchanged * Shared memory IPC where data pointers are exchanged and a protocol for freeing the data once the receiver is done with it The size parameter passed to ipc_send() isn't propagated to the receiving side. The receiver needs to infer how many bytes of data to read in the callback function based on the protocol implemented in the high-level driver; it can be based on message ID, or bits reserved in the message ID for the message size, or some other mechanism. Change-Id: I9a9529beb61cdebdfb1bafd29d037f926fab3c1b Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-09-03 01:38:38 +02:00			`/*`
cleanup: include/: move ipm.h to drivers/ipm.h move ipm.h to drivers/ipm.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-06-25 21:53:55 +02:00			`* Copyright (c) 2019 Intel Corporation`
ipi.h: introduce low-level inter-processor interrupt API This interface is an abstraction for sending messages between processors with irq-context callbacks and no definition of protocol. We assume that for all IPC implementations, we can send over a message identifier and a sized data payload, and that the receiving side gets an interrupt on an incoming message. APIs exist to indicate the max value of the message id and how much data can be sent over a single message. This will be a foundation to build various high-level drivers which can be bound at runtime to this low-level interface. Some examples: * IPC where IPC messages are used as a doorbell to signal new data in a shared queue * IPC with various kinds of message buffering and deferred message processing via semaphores * IPC for serial console debug output, either a byte or a message at a time * IPC over UARTS in a non-shared memory environment where large-ish messages are exchanged * Shared memory IPC where data pointers are exchanged and a protocol for freeing the data once the receiver is done with it The size parameter passed to ipc_send() isn't propagated to the receiving side. The receiver needs to infer how many bytes of data to read in the callback function based on the protocol implemented in the high-level driver; it can be based on message ID, or bits reserved in the message ID for the message size, or some other mechanism. Change-Id: I9a9529beb61cdebdfb1bafd29d037f926fab3c1b Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-09-03 01:38:38 +02:00			`*`
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 02:01:01 +01:00			`* SPDX-License-Identifier: Apache-2.0`
ipi.h: introduce low-level inter-processor interrupt API This interface is an abstraction for sending messages between processors with irq-context callbacks and no definition of protocol. We assume that for all IPC implementations, we can send over a message identifier and a sized data payload, and that the receiving side gets an interrupt on an incoming message. APIs exist to indicate the max value of the message id and how much data can be sent over a single message. This will be a foundation to build various high-level drivers which can be bound at runtime to this low-level interface. Some examples: * IPC where IPC messages are used as a doorbell to signal new data in a shared queue * IPC with various kinds of message buffering and deferred message processing via semaphores * IPC for serial console debug output, either a byte or a message at a time * IPC over UARTS in a non-shared memory environment where large-ish messages are exchanged * Shared memory IPC where data pointers are exchanged and a protocol for freeing the data once the receiver is done with it The size parameter passed to ipc_send() isn't propagated to the receiving side. The receiver needs to infer how many bytes of data to read in the callback function based on the protocol implemented in the high-level driver; it can be based on message ID, or bits reserved in the message ID for the message size, or some other mechanism. Change-Id: I9a9529beb61cdebdfb1bafd29d037f926fab3c1b Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-09-03 01:38:38 +02: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-14 19:43:44 +02:00			`#ifndef ZEPHYR_INCLUDE_IPM_H_`
			`#define ZEPHYR_INCLUDE_IPM_H_`
ipi.h: introduce low-level inter-processor interrupt API This interface is an abstraction for sending messages between processors with irq-context callbacks and no definition of protocol. We assume that for all IPC implementations, we can send over a message identifier and a sized data payload, and that the receiving side gets an interrupt on an incoming message. APIs exist to indicate the max value of the message id and how much data can be sent over a single message. This will be a foundation to build various high-level drivers which can be bound at runtime to this low-level interface. Some examples: * IPC where IPC messages are used as a doorbell to signal new data in a shared queue * IPC with various kinds of message buffering and deferred message processing via semaphores * IPC for serial console debug output, either a byte or a message at a time * IPC over UARTS in a non-shared memory environment where large-ish messages are exchanged * Shared memory IPC where data pointers are exchanged and a protocol for freeing the data once the receiver is done with it The size parameter passed to ipc_send() isn't propagated to the receiving side. The receiver needs to infer how many bytes of data to read in the callback function based on the protocol implemented in the high-level driver; it can be based on message ID, or bits reserved in the message ID for the message size, or some other mechanism. Change-Id: I9a9529beb61cdebdfb1bafd29d037f926fab3c1b Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2015-09-03 01:38:38 +02:00
cleanup: include/: move ipm.h to drivers/ipm.h move ipm.h to drivers/ipm.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-06-25 21:53:55 +02:00			`#ifndef CONFIG_COMPAT_INCLUDES`
			`#warning "This header file has moved, include <drivers/ipm.h> instead."`
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-22 18:38:49 +01:00			`#endif`

cleanup: include/: move ipm.h to drivers/ipm.h move ipm.h to drivers/ipm.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-06-25 21:53:55 +02:00			`#include <drivers/ipm.h>`
drivers: ipm: add system calls ipm_register_callback() omitted since it registers a callback. Signed-off-by: Andrew Boie <andrew.p.boie@intel.com> 2017-10-25 22:14:49 +02: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-14 19:43:44 +02:00			`#endif /* ZEPHYR_INCLUDE_IPM_H_ */`