Lines Matching full:is
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
61 * The creation of the instances is left to the backend (usually at
62 * init time), while the registration of the endpoints is left to
65 * - ENDPOINT: an endpoint is the entity the user must use to send / receive
67 * endpoint is always associated to an instance.
91 * # is ready to be used
142 * It is registered during endpoint registration.
143 * This structure is part of the endpoint configuration.
148 * This callback is called when the endpoint binding is successful.
156 * This callback is called when new data is received.
158 * @note When @ref ipc_service_hold_rx_buffer is not used, the data
159 * buffer is to be considered released and available again only
178 * Token is not important for user of the API. It is implemented in a
213 * @retval -EINVAL when instance configuration is invalid.
214 * @retval -EIO when no backend is registered.
215 * @retval -EALREADY when the instance is already opened (or being opened).
226 * is called.
230 * @retval -EINVAL when instance configuration is invalid.
231 * @retval -EIO when no backend is registered.
232 * @retval -EALREADY when the instance is not already opened.
252 * @note Keep the variable pointed by @p cfg alive when endpoint is in use.
254 * @retval -EIO when no backend is registered.
255 * @retval -EINVAL when instance, endpoint or configuration is invalid.
256 * @retval -EBUSY when the instance is busy.
273 * @retval -EIO when no backend is registered.
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.
289 * @retval -EIO when no backend is registered or send hook is missing from
291 * @retval -EINVAL when instance or endpoint is invalid.
292 * @retval -ENOENT when the endpoint is not registered with the instance.
293 * @retval -EBADMSG when the data is invalid (i.e. invalid data format,
295 * @retval -EBUSY when the instance is busy.
310 * @retval -EIO when no backend is registered or send hook is missing from
312 * @retval -EINVAL when instance or endpoint is invalid.
313 * @retval -ENOENT when the endpoint is not registered with the instance.
314 * @retval -ENOTSUP when the operation is not supported by backend.
327 * It is the application responsibility to correctly fill the allocated TX
333 * buffer is allocated
334 * - if the requested size is too big, the function returns -ENOMEM and the
335 * the buffer is not allocated.
336 * - if the requested size is '0' the buffer is allocated with the maximum
342 * When the function returns no errors, the buffer is intended as allocated
343 * and it is released under two conditions: (1) when sending the buffer using
344 * @ref ipc_service_send_nocopy (and in this case the buffer is automatically
355 * @retval -EIO when no backend is registered or send hook is missing from
357 * @retval -EINVAL when instance or endpoint is invalid.
358 * @retval -ENOENT when the endpoint is not registered with the instance.
359 * @retval -ENOTSUP when the operation or the timeout is not supported by backend.
362 * @retval -ENOMEM when the requested size is too big (and the size parameter
372 * Drop and release a TX buffer. It is possible to drop only TX buffers
378 * @retval -EIO when no backend is registered or send hook is missing from
380 * @retval -EINVAL when instance or endpoint is invalid.
381 * @retval -ENOENT when the endpoint is not registered with the instance.
382 * @retval -ENOTSUP when this is not supported by backend.
395 * This is equivalent to @ref ipc_service_send but in this case the TX buffer
401 * After the @ref ipc_service_send_nocopy function is issued the TX buffer is
413 * @retval -EIO when no backend is registered or send hook is missing from
415 * @retval -EINVAL when instance or endpoint is invalid.
416 * @retval -ENOENT when the endpoint is not registered with the instance.
417 * @retval -EBADMSG when the data is invalid (i.e. invalid data format,
419 * @retval -EBUSY when the instance is busy.
433 * After the message is processed, the application must release the buffer
439 * @retval -EIO when no backend is registered or release hook is missing from
441 * @retval -EINVAL when instance or endpoint is invalid.
442 * @retval -ENOENT when the endpoint is not registered with the instance.
444 * @retval -ENOTSUP when this is not supported by backend.
457 * It is possible to release only RX buffers on which @ref
463 * @retval -EIO when no backend is registered or release hook is missing from
465 * @retval -EINVAL when instance or endpoint is invalid.
466 * @retval -ENOENT when the endpoint is not registered with the instance.
468 * @retval -ENOTSUP when this is not supported by backend.