Lines Matching +full:instance +full:- +full:specific

4  * SPDX-License-Identifier: Apache-2.0
30 	/** @brief Pointer to the function that will be used to open an instance
32 	 *  @param[in] instance Instance pointer.
34 	 *  @retval -EALREADY when the instance is already opened.
40 	int (*open_instance)(const struct device *instance);
42 	/** @brief Pointer to the function that will be used to close an instance
44 	 *  @param[in] instance Instance pointer.
46 	 *  @retval -EALREADY when the instance is not already inited.
52 	int (*close_instance)(const struct device *instance);
56 	 *  @param[in] instance Instance pointer.
57 	 *  @param[in] token Backend-specific token.
61 	 *  @retval -EINVAL when instance is invalid.
62 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
63 	 *  @retval -EBADMSG when the message is invalid.
64 	 *  @retval -EBUSY when the instance is busy or not ready.
65 	 *  @retval -ENOMEM when no memory / buffers are available.
71 	int (*send)(const struct device *instance, void *token,
76 	 *  @param[in] instance Instance to register the endpoint onto.
77 	 *  @param[out] token Backend-specific token.
80 	 *  @retval -EINVAL when the endpoint configuration or instance is invalid.
81 	 *  @retval -EBUSY when the instance is busy or not ready.
87 	int (*register_endpoint)(const struct device *instance,
93 	 *  @param[in] instance Instance from which to deregister the endpoint.
94 	 *  @param[in] token Backend-specific token.
96 	 *  @retval -EINVAL when the endpoint configuration or instance is invalid.
97 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
98 	 *  @retval -EBUSY when the instance is busy or not ready.
104 	int (*deregister_endpoint)(const struct device *instance, void *token);
108 	 *  @param[in] instance Instance pointer.
109 	 *  @param[in] token Backend-specific token.
111 	 *  @retval -EINVAL when instance is invalid.
112 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
113 	 *  @retval -ENOTSUP when the operation is not supported.
119 	int (*get_tx_buffer_size)(const struct device *instance, void *token);
123 	 *  @param[in] instance Instance pointer.
124 	 *  @param[in] token Backend-specific token.
129 	 *  @retval -EINVAL when instance is invalid.
130 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
131 	 *  @retval -ENOTSUP when the operation or the timeout is not supported.
132 	 *  @retval -ENOBUFS when there are no TX buffers available.
133 	 *  @retval -EALREADY when a buffer was already claimed and not yet released.
134 	 *  @retval -ENOMEM when the requested size is too big (and the size parameter
141 	int (*get_tx_buffer)(const struct device *instance, void *token,
146 	 *  @param[in] instance Instance pointer.
147 	 *  @param[in] token Backend-specific token.
150 	 *  @retval -EINVAL when instance is invalid.
151 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
152 	 *  @retval -ENOTSUP when this function is not supported.
153 	 *  @retval -EALREADY when the buffer was already dropped.
159 	int (*drop_tx_buffer)(const struct device *instance, void *token,
166 	 *  @param[in] instance Instance pointer.
167 	 *  @param[in] token Backend-specific token.
171 	 *  @retval -EINVAL when instance is invalid.
172 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
173 	 *  @retval -EBADMSG when the data is invalid (i.e. invalid data format,
175 	 *  @retval -EBUSY when the instance is busy or not ready.
181 	int (*send_nocopy)(const struct device *instance, void *token,
186 	 *  @param[in] instance Instance pointer.
187 	 *  @param[in] token Backend-specific token.
190 	 *  @retval -EINVAL when instance is invalid.
191 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
192 	 *  @retval -EALREADY when the buffer data has been already hold.
193 	 *  @retval -ENOTSUP when this function is not supported.
199 	int (*hold_rx_buffer)(const struct device *instance, void *token,
204 	 *  @param[in] instance Instance pointer.
205 	 *  @param[in] token Backend-specific token.
208 	 *  @retval -EINVAL when instance is invalid.
209 	 *  @retval -ENOENT when the endpoint is not registered with the instance.
210 	 *  @retval -EALREADY when the buffer data has been already released.
211 	 *  @retval -ENOTSUP when this function is not supported.
217 	int (*release_rx_buffer)(const struct device *instance, void *token,