PMICGetEcResetAsync

Syntax

#include <revolution/pmic.h>

// Echo Canceller Reset State
#define PMIC_EC_RESET_ON             0x0001
#define PMIC_EC_RESET_OFF            0x0000

typedef void (*PMICCallback)(PMIC_ERR result, void* arg);

PMIC_ERR PMICGetEcResetAsync(u16* state, PMICCallback cb, void* arg);

Arguments

state Location to store the echo canceler's reset state (ON/OFF), which is received from the Wii Speak.
cb Callback function that will send notification of the execution results of this function.
arg Passed as the second argument of the callback function above.

Return Values

Returns one of the following.

PMIC_ERR_OK The function has been called normally.
PMIC_ERR_INVALID_ARGUMENTS The correct argument was not passed.
PMIC_ERR_INVALID_STATE The Wii Speak is not open.
PMIC_ERR_BUSY Cannot register the command. Call the function again.
PMIC_ERR_FATAL A fatal error has occurred.

Description

Asynchronously gets the reset state (ON/OFF) for the Wii Speak's echo canceler.

This function stores the reset state at the address specified by its first argument, state. A value of PMIC_EC_RESET_ON is stored if resets are enabled, and PMIC_EC_RESET_OFF is stored if resets are disabled. The Wii Speak's echo canceler runs normally when the state is PMIC_EC_RESET_OFF.

One of the following is passed to result, the callback function's first argument.

PMIC_ERR_OK The reset state was obtained successfully.
PMIC_ERR_NO_DEVICE The Wii Speak has been unplugged.
PMIC_ERR_INVALID_STATE The Wii Speak is not open. (Confirm that the Wii Speak cable is inserted in the USB port.)
PMIC_ERR_USB_ERROR An error occurred in USB communications. Call the function again.
PMIC_ERR_FATAL A fatal error has occurred.

See Also

Revision History

2008/12/22 Standardized terminology.
2008/10/24 Revised Description.
2008/10/23 Revised Description.
2008/10/22 Initial version.


CONFIDENTIAL