After running the above sequence, once the monitoring has been enabled the user can look out for alarm on assigned GPIO. Additionally, one can call the alarm readback function in the following manner.

Format: CAFE. getSnrAlarm(afeInst)

Example 8.1: CAFE.getSnrAlarm(0)

Format:CAFE. getRxBiasAlarm(afeInst))

Example 8.2: CAFE.getRxBiasAlarm(0)

Format: CAFE. getBitAlarm(afeInst))

Example 8.3: CAFE.getBitAlarm(0)

CAPI getSnrAlarm reports three values where the first value corresponds to RX Alarms, second corresponds to FB Alarms while the third value corresponds to TX Alarms. RX Alarms can be interpreted bitwise where bit 0 corresponds to alarm for RX1 and bit 1 corresponds to alarm for RX2 and so on. Similarly, FB Alarms can be interpreted bitwise where bit 0 corresponds to alarm for FB1 and bit 1 corresponds to alarm for FB2. TX Alarms can be interpreted similar to RX Alarms.

Refer to the example below:

Output: [11,1,2]
Binary representation: [1011,01,0010]

This implies that SNR has crossed the set threshold for the channels: RX1, RX2, RX4, FB1 and TX2.

CAPI getRxBiasAlarm reports two values where the first value corresponds to RX Alarms and the second value corresponds to FB Alarms. RX Alarms can be interpreted bitwise where bit 0 corresponds to alarm for RX1 and bit 1 corresponds to alarm for RX2 and so on. Similarly, FB Alarms can be interpreted bitwise where bit 0 corresponds to alarm for FB1 and bit 1 corresponds to alarm for FB2.

See the following example:

Output: [3,1] 
Binary Representation: [0011,01]

This implies that bias has gone out of spec for: RX1, RX2 and FB1.

CAPI getBitAlarm reports whether the configuration registers sets have been corrupted due to any radiation event. If the output is 1, this indicates a bit flip/flips in configuration register sets while 0 indicates the register sets are not impacted.

These alarms are sticky in nature. This means, if the alarm ever gets high, it holds that condition. You can use the clear alarm function to clear these alarms and call read alarms functions again to get the current state. Refer to the example below to clear alarms.

Format: CAFE.clearSnrAlarm(afeInst)

Example 10.1: CAFE.clearSnrAlarm(0)

Format: CAFE.clearRxBiasAlarm(afeInst)

Example 10.2: CAFE.clearRxBiasAlarm(0)

Format: CAFE.clearBitAlarm(afeInst)

Example 10.3: CAFE.clearBitAlarm(0)