Mtp3SetLinkSetCfg

Configures the MTP 3 task with the linkset configuration values contained in the provided MTP3LinkSetCfg structure.

Prototype

MTP3_STATUS Mtp3SetLinkSetCfg ( U8 board, MTP3LinkSetCfg *pLinkSetCfg)

Argument

Description

board

TX board number on which the desired MTP 3 task resides. Valid range is 1 through maxboard (currently 8).

pLinkSetCfg

Pointer to the MTP3LinkSetCfg structure containing the linkset configuration values.


Return values

Return value

Description

MTP3_SUCCESS

 

MTP3_BOARD

Invalid board number.

MTP3_HANDLE

Mtp3MgmtInit not called for the specified board.

MTP3_TIMEOUT

No response from the board.


Details

An application must set the field values in the MTP3LinkSetCfg structure before calling this function. Set the values by calling Mtp3InitLinkSetCfg, by setting each field from within the application, or with a combination of the two (calling Mtp3InitLinkSetCfg and then overriding specific fields before passing the MTP3LinkSetCfg structure to this function).

This function is typically called once for each configured linkset.

See also

Mtp3InitLinkSetCfg, Mtp3MgmtInit