Lines Matching +full:remote +full:- +full:endpoint

4  * SPDX-License-Identifier: Apache-2.0
20  * @brief Multi-endpoint extension of icmsg IPC library
21  * @defgroup ipc_icmsg_me_api Icmsg multi-endpoint IPC library API
27 /* If more bytes than 1 was used for endpoint id, endianness should be
53  *  @param[inout] data Structure containing run-time data used by the icmsg_me
68  *  remote instance.
69  *  This function is blocking until the handshake with the remote instance is
73  *  remote instance is being pefromed.
77  *  @param[inout] data Structure containing run-time data used by the icmsg_me
105  *  @param[inout] data Structure containing run-time data used by the icmsg_me
118  *  @param[inout] data Structure containing run-time data used by the icmsg_me
125 /** @brief Notify the icmsg_me instance that data for an endpoint was received
132  *  @param[inout] data Structure containing run-time data used by the icmsg_me
136  *  @param[in] id The value identifyig the endpoint.
138  *                 multi-endpoint header.
144 /** @brief Set endpoint configuration in an empty endpoint slot
146  *  During endpoint handshake the handshake initiator must select an id number
147  *  and store endpoint metadata required to finalize handshake and maintain
158  *  @param[inout] data Structure containing run-time data used by the icmsg_me
162  *  @param[in] ept_cfg Configuration data of the endpoint for which the
164  *  @param[out] id The value uniquely identifyig this endpoint.
167  *  @retval -ENOMEM when there are no more empty endpoint configuration slots.
173 /** @brief Set endpoint configuration in a selected endpoint slot
175  *  During endpoint handshake the handshake follower must store endpoint id and
178  *  associated with the id of the endpoint.
180  *  @param[inout] data Structure containing run-time data used by the icmsg_me
184  *  @param[in] id The value uniquely identifyig this endpoint.
185  *  @param[in] ept_cfg Configuration data of the endpoint for which the
189  *  @retval -ENOENT when @p id is out of range of available slots.
194 /** @brief Get endpoint configuration from a selected endpoint slot
196  *  When the icmsg_me instance receives data from a remote endpoint, it must
197  *  get the endpoint configuration based on the id of the endpoint. This
200  *  If retrieved endpoint configuration is not set, @p ept_cfg points to NULL.
202  *  @param[inout] data Structure containing run-time data used by the icmsg_me
206  *  @param[in] id The value uniquely identifyig endpoint.
207  *  @param[in] ept_cfg Configuration data of the endpoint with given id.
210  *  @retval -ENOENT when @p id is out of range of available slots.
215 /** @brief Reset endpoint configuration in a selected endpoint slot.
217  *  If handshake fails or an endpoint is disconnected, then configuration
218  *  slot for given endpoint should be vacated. This function is intended to
221  *  @param[inout] data Structure containing run-time data used by the icmsg_me
225  *  @param[in] id The value uniquely identifyig endpoint.
229 /** @brief Send a message to the remote icmsg_me endpoint.
233  *  @param[inout] data Structure containing run-time data used by the icmsg_me
237  *  @param[in] id Id of the endpoint to use.
243  *  @retval -EBADMSG when the requested data to send is too big.