Sensoray 2600 - Manual (Page 28)

Sensoray 2600 Programming Guide
24
Gateway Action Scheduling
Returns: Error code as described in section 5.5. Zero is returned if the operation was successful.
Benchmark: 0.9 ms for IOMs, or 0.1 ms for the gateway.
Notes: The returned value indicates the model number of the target module. For example, the decimal value 2652 is
returned by the Model 2652 Solid State Relay IOM. The value 2601 is returned when the gateway is the target
module.
Example: // Fetch the IOM model number from MM number 0, IOM port 6.
u16 modelnum;
void *x = S26_SchedOpen( 0, 1 );
S26_Sched2600_IomGetProductID( x, 6, &modelnum );
S26_SchedExecute( x, 1000, 0 );
printf( "Model number = %d\n", modelnum );
7.2.6 S26_Sched2600_Nop()
Function: Schedules a “no-operation” action for an IOM or the gateway.
Prototype: u32 S26_Sched2600_Nop( XACT x, IOMPORT IomPort );
Returns: Error code as described in section 5.5. Zero is returned if the operation was successful.
Benchmark: 0.7 ms for IOMs, or 0.1 ms for the gateway.
Notes: S26_Sched2600_Nop() may be used to acquire IOM status when no other actions are required.
Example: // Fetch IOM status from MM number 0, IOM port 6.
u8 status[16];
void *x = S26_SchedOpen( 0, 1 );
S26_Sched2600_Nop( x, 6 );
S26_SchedExecute( x, 1000, status );
printf( "IOM_6 status = %d\n", status[6] );
7.3 Model 2601 Gateway
The functions in this section are used to schedule gateway actions on a MM. These functions are applicable only to Model 2601
MMs. Any attempt to call these functions for IOMs will result in a
GWERR_IOMTYPE transaction error. Note that these functions
only schedule actions into a transaction; they do not cause the actions to be immediately executed
7.3.1 Type-Specific Errors
The gateway employs only the STATUS_RST flag. It does not have a STATUS_CERR flag, nor does it have any type-specific flags. If
the gateway’s STATUS_RST flag is asserted, a transaction error of type GWERR_IOMRESET will be generated and the error code’s
least significant byte (which indicates the module in which the error was detected) will contain MODID_GATEWAY .
7.3.2 S26_Sched2601_GetInterlocks()
Function: Schedules the fetching of the MM’s power interlock status.
Parameter Type Description
x void * Transaction handle obtained from S26_SchedOpen().
IomPort u8 The IOM port number (on the MM) to which the target IOM is connected, or 0xFF if
the gateway is the target.