Program Interface Library AR_GETFILTER
CEI-100/CEI-200/CEI-x20 User’s Manual 95
AR_GETFILTER
CEI_INT32 ar_getfilter (CEI_UINT32 board, CEI_UINT32 channel,
CEI_CHAR * Filter)
Only the CEI-520/520A/620/820/820TX enhanced API supports this
function.
This function reads the label interrupt and filter buffer from the board for a
specified channel. Each receiver channel has an 8K-byte filter buffer,
which is used by the firmware to control storage of received labels and to
determine if a particular label is to cause an interrupt. Each element of the
filter buffer consists of a bit field defined as follows:
FILTER_SEQUENTIAL 0x10 If CLEAR add label to Sequential receive buffer
FILTER_SNAPSHOT 0x20 If CLEAR add label to Snapshot receiver buffer
FILTER_INTERRUPT 0x40 If SET add entry to interrupt queue & set IRQ
FILTER_SIGNAL 0x80 If SET signal channel to transmit label
FILTER_CHANNEL 0x0F Transmit channel number (0-15) (mask) to signal
The filter buffer for a single channel is defined as follows:
FilterCtrl[MAX_ESSM][MAX_SDI][MAX_LABEL]
and accessed as
FilterCtrl[eSSM][SDI][ label]
where the bits of the ARINC word are split up as follows:
An entry is made into the interrupt queue if specified by the filter buffer,
even if hardware interrupts are not enabled.
To write the label interrupt and filter buffer, see AR_PUTFILTER.
The CEI-520/520A/620/820/820TX enhanced API supports SIGNALED
MESSAGES. The values FILTER_SIGNAL and FILTER_CHANNEL
are used to signal a specific label previously setup by a call to
AR_DEFINE_MSG(), and enabled by a call to AR_MODIFY_MSG(), to
be transmitted by the signaled channel as soon as possible after the
specified label has been received. See AR_PUTFILTER () and
AR_MODIFY_MSG () for more information.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com