OPAL Console calls¶
There are four OPAL calls relating to the OPAL console:
Name |
API Token ID |
Introduced |
Required as of |
Notes |
1 |
v1.0 (Initial Release) |
POWER8 |
||
2 |
v1.0 (Initial Release) |
POWER8 |
||
25 |
v1.0 (Initial Release) |
POWER8 |
||
117 |
POWER9 |
The OPAL console calls can support multiple consoles. Each console MUST be represented in the device tree.
A conforming implementation SHOULD have at least one console. It is valid for it to simply be an in-memory buffer and only support writing.
[TODO: details on device tree specs for console]
OPAL_CONSOLE_WRITE¶
Parameters:
int64_t term_number
int64_t *length,
const uint8_t *buffer
Returns:
OPAL_PARAMETER on invalid term_number
OPAL_CLOSED if console device closed
OPAL_BUSY_EVENT if unable to write any of buffer
term_number is the terminal number as represented in the device tree.
length is a pointer to the length of buffer.
A conforming implementation SHOULD try to NOT do partial writes, although partial writes and not writing anything are valid.
OPAL_CONSOLE_WRITE_BUFFER_SPACE¶
Parameters:
int64_t term_number
int64_t *length
Returns:
OPAL_PARAMETER on invalid term_number
Returns the available buffer length for OPAL_CONSOLE_WRITE in length.
This call can be used to help work out if there is sufficient buffer
space to write your full message to the console with OPAL_CONSOLE_WRITE.
OPAL_CONSOLE_READ¶
Parameters:
int64_t term_number
int64_t *length
uint8_t *buffer
Returns:
OPAL_PARAMETER on invalid term_number
Use OPAL_POLL_EVENTS for how to determine
OPAL_CONSOLE_FLUSH¶
Parameters:
int64_t term_number
Returns:
OPAL_UNSUPPORTED if the console does not implement a flush call
OPAL_PARAMETER on invalid term_number
OPAL_PARTIAL if more to flush, call again
OPAL_BUSY if nothing was flushed this call