eeh_clear_user_session
Purpose
Clears a user-state and pending user messages, and ends a user message session.
Syntax
kerrno_t
eeh_clear_user_session(eeh_handle_t handle, ulong flags)Parameter
| Item | Description |
|---|---|
| Handle | Extending Enhanced I/O Error Handling (EEH) handle acquired from the eeh_init_multifunc() service. |
| Flags | Additional flags for the eeh_clear_user_session() service. |
Description
This service is called if a device driver wants to reset the state to 0 and clear any pending user messages. This service also clears the identity of the EEH_INITIATOR driver. The drivers that are calling the eeh_clear_user_session() service and that are not defined as the EEH_INITIATOR driver receive a return value of a kerrno, which is based on the EBUSY state, with the exception of when the device driver specifies the EEH_FORCE_CLEAR driver. This ends the current session. The EEH_FORCE_CLEAR driver is defined in the eeh.h file.
Execution Environment
The eeh_clear_user_session() service either process or interrupt. This function can be called from the live dump, the eeh callback, and other process level entry points.
Return Values
| Item | Description |
|---|---|
| 0 | Success |
| Kerrno with EBUSY | Session is currently active with another initiator |
| Kerrno | Error |