Sends a control request to the MTP 3 task.
MTP3_STATUS Mtp3MgmtCtrl ( U8 board, S16 entity, U8 action )
Argument |
Description |
board |
TX board number on which the desired MTP 3 task resides. Valid range is 1 through maxboard (currently 8). |
entity |
Link number for link control operations or the linkset number for linkset control operations. The link or linkset number must have been previously defined with the appropriate configuration function call, either Mtp3SetLinkCfg or Mtp3SetLinkSetCfg. Not used for general control operations. |
action |
Action to take on the specified entity. See the Details section for valid actions. |
Return value |
Description |
MTP3_SUCCESS |
|
MTP3_BOARD |
Invalid board number. |
MTP3_HANDLE |
Mtp3MgmtInit not called for the specified board. |
MTP3_PARAM |
Invalid action. Must be an action defined in the following General control actions table. |
Three classifications of control requests exist: general, link, and linkset. Use this function to activate and deactivate network layer resources. The combination of entity and action tells MTP 3 what action to take and what to act upon.
The action field must be one of the following:
General control actions (entity is not used)
Action |
Description |
MTP3_CTRL_ALARM_ENA |
Enables alarms. |
MTP3_CTRL_ALARM_DIS |
Disables alarms. |
MTP3_CTRL_FLOWCTL_ON |
Starts flow control and disables transmission of all except critical MTP 3 management messages. |
MTP3_CTRL_FLOWCTL_OFF |
Ends flow control and enables transmission of all MTP 3 management messages. |
MTP3_CTRL_TRACE_ON |
Enables all data tracing in MTP 3. |
MTP3_CTRL_TRACE_OFF |
Disables all data tracing in MTP 3. |
Link control actions (entity specifies link number)
Action |
Description |
MTP3_CTRL_LINK_ENA |
Enables the specified link. |
MTP3_CTRL_LINK_DIS |
Disables the specified link. |
MTP3_CTRL_LINK_INH |
Inhibits transmission of data messages to and from specified link. |
MTP3_CTRL_LINK_UNINH |
Uninhibits transmission of data messages to and from specified link. |
MTP3_CTRL_LINK_DEL |
Deletes the specified link. |
MTP3_CTRL_LINK_LPO |
Sends specified link into local processor outage condition. Layer 2 sends SIPOs rather than FISUs. |
MTP3_CTRL_LINK_LPR |
Clears local processor outage condition. Layer 2 resumes sending FISUs. |
MTP3_CTRL_LINK_EMG |
Sends specified link into emergency alignment condition. Layer 2 sends SIE rather than SIN. |
MTP3_CTRL_LINK_NRM |
Sends specified link into normal alignment condition. Layer 2 sends SIN rather than SIE. |
MTP3_CTRL_LINK_TRCON |
Enables data tracing on specified link. |
MTP3_CTRL_LINK_TRCOFF |
Disables data tracing on specified link. |
Linkset control actions (entity specifies linkset number)
Action |
Description |
MTP3_CTRL_LINKSET_ENA |
Enables all links in specified linkset. |
MTP3_CTRL_LINKSET_DIS |
Disables all links in specified linkset. |