Lines Matching full:instance

43  * - INSTANCE: an instance is the external representation of a physical
47  *             instance is peculiar to each backend. For example for
48  *             OpenAMP-based backends, an instance is usually represented by a
52  *             It's important to note that an instance per se is not used to
54  *             user have to create (register) an endpoint in the instance
58  *             instance, each one used to exchange data, possibly with different
66  *             data between two domains (connected by the instance). An
67  *             endpoint is always associated to an instance.
72  *            2) creating / registering the endpoints onto an instance at run
77  *            the configuration parameters for the instance.
83  *   # Open the (same) instance on host and remote
176 /** @brief Endpoint instance.
183 	/** Instance this endpoint belongs to. */
184 	const struct device *instance;  member
186 	/** Backend-specific token used to identify an endpoint in an instance. */
206 /** @brief Open an instance
208  *  Function to be used to open an instance before being able to register a new
211  *  @param[in] instance Instance to open.
213  *  @retval -EINVAL when instance configuration is invalid.
215  *  @retval -EALREADY when the instance is already opened (or being opened).
220 int ipc_service_open_instance(const struct device *instance);
222 /** @brief Close an instance
224  *  Function to be used to close an instance. All bounded endpoints must be
228  *  @param[in] instance Instance to close.
230  *  @retval -EINVAL when instance configuration is invalid.
232  *  @retval -EALREADY when the instance is not already opened.
239 int ipc_service_close_instance(const struct device *instance);
241 /** @brief Register IPC endpoint onto an instance.
243  *  Registers IPC endpoint onto an instance to enable communication with a
248  *  @param[in] instance Instance to register the endpoint onto.
255  *  @retval -EINVAL when instance, endpoint or configuration is invalid.
256  *  @retval -EBUSY when the instance is busy.
261 int ipc_service_register_endpoint(const struct device *instance,
265 /** @brief Deregister an IPC endpoint from its instance.
267  *  Deregisters an IPC endpoint from its instance.
274  *  @retval -EINVAL when instance, endpoint or configuration is invalid.
275  *  @retval -ENOENT when the endpoint is not registered with the instance.
276  *  @retval -EBUSY when the instance is busy.
291  *  @retval -EINVAL when instance or endpoint is invalid.
292  *  @retval -ENOENT when the endpoint is not registered with the instance.
295  *  @retval -EBUSY when the instance is busy.
312  *  @retval -EINVAL when instance or endpoint is invalid.
313  *  @retval -ENOENT when the endpoint is not registered with the instance.
357  *  @retval -EINVAL when instance or endpoint is invalid.
358  *  @retval -ENOENT when the endpoint is not registered with the instance.
380  *  @retval -EINVAL when instance or endpoint is invalid.
381  *  @retval -ENOENT when the endpoint is not registered with the instance.
415  *  @retval -EINVAL when instance or endpoint is invalid.
416  *  @retval -ENOENT when the endpoint is not registered with the instance.
419  *  @retval -EBUSY when the instance is busy.
441  *  @retval -EINVAL when instance or endpoint is invalid.
442  *  @retval -ENOENT when the endpoint is not registered with the instance.
465  *  @retval -EINVAL when instance or endpoint is invalid.
466  *  @retval -ENOENT when the endpoint is not registered with the instance.