WM_SetMPFrequency

C Specification

#include <nitro/wm.h>

WMErrCode WM_SetMPFrequency(
WMCallbackFunc  callback ,
u16             mpFreq
);

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
mpFreq Specifies how many times to perform MP communications in one frame. When a value of 0 is specified, this function is set to the continuous packet send mode that is used for large volume data communication.

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Sets the MP communications frequency This function is only executable when the WM is in the MP_PARENT state. This function is used during MP communications to dynamically change the communications frequency that was set by the mpFreq argument in WM_StartMP. If the return value is WM_ERRCODE_OPERATING, a callback is generated after the MP completes the data transmission process.

This wrapper function calls the WM_SetMPParameter function internally.

See Also

WM_SetMPParameter, WM_StartMP, WM_SetMPDataToPort

Revision History

12/06/2005 Noted that WM_SetMPParameter had become a wrapper function.
06/08/2005 Added the fact that the callback is called from the interrupt handler.
10/22/2004 Changed the type of the return value.
09/13/2004 Initial release.