Configures the M3UA layer with the values contained in the general configuration structure.
STATUS TXM3UAFUNC M3uaSetGenCfg ( U8 board, M3UAGenCfg *pGencfg)
rgument |
Description |
board |
TX board number on which the desired M3UA layer resides. Valid range is 1 through MAXBOARD (currently 32). |
pGenCfg |
Pointer to the M3UAGenCfg structure that contains the general configuration values. For information, see M3UAGenCfg. |
Return value |
Description |
M3UA_SUCCESS |
|
M3UA_BOARD |
Invalid board number. |
M3UA_DRIVER |
CPI driver error. |
M3UA_HANDLE |
M3UAMgmtInit was not called for the specified board. |
M3UA_PARAM |
Invalid parameter. |
M3UA_RESPONSE |
Incorrect response from the board. |
M3UA_TIMEOUT |
No response from the board. |
Call this function to configure the M3UA layer after you download the TX board and call M3uaMgmtInit.
An application must set the field values in the M3UAGenCfg structure before calling M3uaSetGenCfg. Set the values in any of the following ways:
Call M3uaInitGenCfg to set the fields to default values.
Set each field value from within the application.
Call M3uaInitGenCfg and then override specific field values before passing the M3UAGenCfg structure to M3uaSetGenCfg.
M3uaSetGenCfg is typically called once by an application to set global values.
For more information, see General M3UA configuration.