Lines Matching full:service
20 * @defgroup resource_mgmt_onoff_apis On-Off Service APIs
38 * @brief Mask used to isolate bits defining the service state.
50 * @brief Value exposed by ONOFF_STATE_MASK when service is off.
55 * @brief Value exposed by ONOFF_STATE_MASK when service is on.
60 * @brief Value exposed by ONOFF_STATE_MASK when the service is in an
66 * @brief Value exposed by ONOFF_STATE_MASK when service is
72 * @brief Value exposed by ONOFF_STATE_MASK when service is
78 * @brief Value exposed by ONOFF_STATE_MASK when service is in the
91 * Functions of this type are passed to service-specific transition
99 * indicated the service shall enter an error state.
105 * @brief Signature used by service implementations to effect a
108 * Service definitions use two required function pointers of this type
110 * one to reset the service when it is in an error state.
132 /** @brief On-off service transition functions. */
134 /** Function to invoke to transition the service to on. */
137 /** Function to invoke to transition the service to off. */
140 /** Function to force the service state to reset, where
149 * No fields in this structure are intended for use by service
151 * onoff_manager_init(), when the service provider is initialized. In
174 /** Flags identifying the service state. */
177 /** Number of active clients for the service. */
187 * @param _reset a function used to clear errors and force the service
203 * @brief Initialize an on-off service to off state.
205 * This function must be invoked exactly once per service instance, by
206 * the infrastructure that provides the service, and before any other
207 * on-off service API is invoked on the service.
210 * service.
228 * @brief Signature used to notify an on-off service client of the
236 * null if the on-off service uses synchronous transitions.
247 * service-specific, but the value shall be non-negative if the
258 * @brief State associated with a client of an on-off service.
264 * Control of the object content transfers to the service provider
266 * function. While the service provider controls the object the
277 * Links the client into the set of waiting service users.
296 * These bits are intended for use by containing service
303 * @brief Test whether an on-off service has recorded an error.
305 * This function can be used to determine whether the service has
311 * transitions the service between an error and non-error state.
313 * @return true if and only if the service has an uncleared error.
321 * @brief Request a reservation to use an on-off service.
338 * passes a pointer object associated with an incomplete service
343 * @retval -EIO if service has recorded an an error.
351 * @brief Release a reserved use of an on-off service.
364 * @retval -EIO if service has recorded an an error.
447 * @brief Clear errors on an on-off service and reset it to its off
450 * A service can only be reset when it is in an error state as
472 * if cli references an object associated with an incomplete service
477 * @retval -ENOTSUP if reset is not supported by the service.
479 * @retval -EALREADY if the service does not have a recorded error.
485 * @brief Signature used to notify a monitor of an onoff service of
509 * service- and state-specific, but the value shall be non-negative if
518 * @brief Registration state for notifications of onoff service
525 /** Links the client into the set of waiting service users.
567 * @brief State used when a driver uses the on-off service API for synchronous
585 * @brief Lock a synchronous onoff service and provide its state.
591 * @param srv pointer to the synchronous service state.
595 * @return negative if the service is in an error state, otherwise the
605 * service and release lock.
607 * This function updates the service state on the @p res and @p on parameters
611 * If the service was in an error state when locked, and @p res is non-negative
614 * @param srv pointer to the synchronous service state
620 * state of the service is updated. For compatibility with the
625 * @param res the result of the transition. A negative value places the service
629 * @param on Only when @p res is non-negative, the service reference count will
632 * @return negative if the service is left or put into an error state, otherwise