Lines Matching full:event
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
33 * @defgroup los_event Event
50 * Event reading mode: The task waits for all its expected events to occur.
56 * Event reading mode: The task waits for any of its expected events to occur.
62 * Event reading mode: The event flag is immediately cleared after the event is read.
68 * Bit 25 of the event mask cannot be set to an event because it is set to an error code.
72 * Solution: Set bits excluding bit 25 of the event mask to events.
77 * Event reading error code: Event reading times out.
81 …* Solution: Increase the waiting time for event reading, or make another task write a mask for the…
87 …* Event reading error code: The EVENTMASK input parameter value is valid. The input parameter valu…
97 * Event reading error code: The event is being read during an interrupt.
101 * Solution: Read the event in a task.
107 …* Event reading error code: The uwFlags input parameter value used in the event reading API is inv…
110 * a nonzero value when an event is read in the mode of OS_EVENT_WAIT.
120 * Event reading error code: The task is locked and is unable to read the event.
124 * Solution: Unlock the task and read the event.
130 * Event reading error code: Null pointer.
140 * Event reading error code: no initialized.
144 * Solution: Check whether the event is initialized.
150 * Event reading error code: should not be destroyed.
154 * Solution: Check whether the event list is not empty.
160 * Event reading error code: The event is being read in a system-level task.
163 * Solution: Read the event in a valid task.
169 * Event control structure
172 UINT32 uwEventID; /**< Event mask in the event control block,
173 indicating the event that has been logically processed. */
174 LOS_DL_LIST stEventList; /**< Event control block linked list */
178 * @brief Initialize an event control block.
181 * This API is used to initialize the event control block pointed to by eventCB.
187 * @param eventCB [IN/OUT] Pointer to the event control block to be initialized.
190 * @retval #LOS_OK The event control block is successfully initialized.
199 * @brief Obtain an event specified by the event ID.
202 …* This API is used to check whether an event expected by the user occurs according to the event ID…
203 …* and event reading mode, and process the event based on the event reading mode. The event ID must…
211 * @param eventID [IN/OUT] Pointer to the ID of the event to be checked.
212 …* @param eventMask [IN] Mask of the event expected to occur by the user, indicating the event o…
214 …* @param mode [IN] Event reading mode. The modes include LOS_WAITMODE_AND, LOS_WAITMODE_OR…
216 * @retval 0 The event expected by the user does not occur.
217 * @retval #UINT32 The event expected by the user occurs.
226 * @brief Read an event.
229 …API is used to block or schedule a task that reads an event of which the event control block, even…
235 …* <li>An error code and an event return value can be same. To differentiate the error code and ret…
236 * the event mask is forbidden to be used.</li>
239 …* @param eventCB [IN/OUT] Pointer to the event control block to be checked. This parameter mu…
241 …* @param eventMask [IN] Mask of the event expected to occur by the user, indicating the eve…
243 * @param mode [IN] Event reading mode.
244 * @param timeOut [IN] Timeout interval of event reading (unit: Tick).
246 * @retval #LOS_ERRNO_EVENT_SETBIT_INVALID Bit 25 of the event mask cannot be set because
248 * @retval #LOS_ERRNO_EVENT_EVENTMASK_INVALID The passed-in event reading mode is incorrect.
249 * @retval #LOS_ERRNO_EVENT_READ_IN_INTERRUPT The event is being read during an interrupt.
250 * @retval #LOS_ERRNO_EVENT_FLAGS_INVALID The event mode is invalid.
251 * @retval #LOS_ERRNO_EVENT_READ_IN_LOCK The event reading task is locked.
253 * @retval 0 The event expected by the user does not occur.
254 * @retval #UINT32 The event expected by the user occurs.
263 * @brief Write an event.
266 …* This API is used to write an event specified by the passed-in event mask into an event control b…
270 …>To determine whether the LOS_EventRead API returns an event or an error code, bit 25 of the event…
274 * @param eventCB [IN/OUT] Pointer to the event control block into which an event is to be written.
276 * @param events [IN] Event mask to be written.
278 * @retval #LOS_ERRNO_EVENT_SETBIT_INVALID Bit 25 of the event mask cannot be set to an event
281 * @retval #LOS_OK The event is successfully written.
290 * @brief Clear the event of the eventCB by a specified eventMask.
294 …* <li>This API is used to set the ID of an event that has a specified mask and of which the inform…
295 * an event control block pointed to by eventCB to 0. eventCB must point to valid memory.</li>
302 * @param eventCB [IN/OUT] Pointer to the event control block to be cleared.
303 * @param eventMask [IN] Mask of the event to be cleared.
306 * @retval #LOS_OK The event is successfully cleared.
315 * @brief Destroy an event.
319 * <li>This API is used to Destroy an event.</li>
323 * <li>The specific event should be a valid one.</li>
326 * @param eventCB [IN/OUT] Pointer to the event control block to be Destroyed.
329 * @retval #LOS_OK The event is successfully cleared.