eeh_get_user_state
Purpose
Reads a user-state.
Syntax
kerrno_t
eeh_get_user_state(eeh_handle_t handle, ulong flags, uint *state,
ulong* status)Parameter
| Item | Description |
|---|---|
| Handle | Extending Enhanced I/O Error Handling (EEH) handle acquired from the eeh_init_multifunc() service. |
| Flags | Additional flags. Currently, the value must be 0. |
| State | Pointer to where the user-state is returned. |
| Message | Bitmask information about the current session. |
Description
This service provides a method for a device driver to read the user state. This service does not send any messages.
Execution Environment
The eeh_get_user_state() service either process or interrupt. This service can be called from the live dump, the eeh callback, and other process level entry points.
Return Values
| Item | Description |
|---|---|
| 0 | Success |
| Kerrno | Error |
Status Flags
The status parameter currently
defines the following flags:
The flags are returned on success and also by the kerrno messages
that are based on the EBUSY flag
| Flags | Description | Value |
|---|---|---|
| SESSION_ACTIVE | User Message Session is currently active. | 0x1 |
| IS_INITIATOR | User is EEH_INITIATOR | 0x2 |
| BRDCAST_ACTIVE | User Message is currently being broadcast. | 0x3 |