Set user IQ bits (UIQBITS)

UIQBITS loads user-specified bits that are included with the pulse headers in the RVP10 TimeSeries API data stream.

The permanent Set/Clr bits are updated in the signal processor and retain their value from the last time they were defined. These bits are then repeated in all pulse headers. The ONCE bits are transitory and appear in only one pulse header each time they are set.

A FIFO history of the permanent bits is maintained so that the bits can be associated with the data being acquired right now as the UIQBITS opcode is executed. Each 16-bit command arg specifies bits to Set/Clr in successive bytes of the structure. This allows user code to safely change some bits without affecting others.

The user bits from separate calls are never be collapsed into a single pulse header, even if the header and bit times indicate that they could. This means that each UIQBITS opcode always result in at least one pulse header being tagged with exactly that data. This is generally what you want, since no other exact outcome could be guaranteed based on time-of-arrival alone.

 15  14  13  12  11  10   9   8   7   6   5   4   3   2   1   0
 ---------------------------------------------------------------
|   |   |   |   |   |   |   |   |    |   |   |   |   |   |   |   |
|               | 0   0   0   1    0   0   1   1   1   1   1   1 |  Command 
|---------------|------------------------------------------------|  

 15  14  13  12  11  10   9   8   7   6   5   4   3   2   1   0
 ---------------------------------------------------------------
|   |   |   |   |   |   |   |   |    |   |   |   |   |   |   |   |
|                 64 Permanent User Bits to SET                  |  Inputs 1–4 
|----------------------------------------------------------------|  

 15  14  13  12  11  10   9   8   7   6   5   4   3   2   1   0
 ---------------------------------------------------------------
|   |   |   |   |   |   |   |   |    |   |   |   |   |   |   |   |
|                 64 Permanent User Bits to CLEAR                |  Inputs 5–8 
|----------------------------------------------------------------|  

 15  14  13  12  11  10   9   8   7   6   5   4   3   2   1   0
 ---------------------------------------------------------------
|   |   |   |   |   |   |   |   |    |   |   |   |   |   |   |   |
|                 64 Permanent User Bits to ONCE                 |  Inputs 9–12 
|----------------------------------------------------------------|