HIOInit

Syntax

#include <cafe.h>
#include <cafe/hio.h>

HIOStatus HIOInit(void);

Parameters

None.

Return Values

HIO_STATUS_OK Successfully initialized the Host I/O facility.
HIO_STATUS_HEADLESS_MODE Could not initialize because the CAT-DEV is in headless mode.

Description

Initializes the Host IO facility. This function must be called (and completed) at least once before invoking any other HIO function. After the Host IO has been initialized, subsequent calls to HIOInit are safely ignored.

Do Not Call From

Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.
Production code Do not call this function in production code. It is available only for debugging purposes.

Revision History

2013-07-18 Updated return values.
2013-05-08 Automated cleanup pass.
2011-11-04 Updated return values.
2011-02-21 Initial version.


CONFIDENTIAL