Cabac (LSST CCS - REB Driver 2.8.3 API)

java.lang.Object
- org.lsst.ccs.drivers.reb.Asic
- - org.lsst.ccs.drivers.reb.Cabac

```
public class Cabac
extends Asic
```
CABAC access routines.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CABAC_FLD_BIAS_HZ`
`static int`	`CABAC_FLD_EXP_CLK`
`static int`	`CABAC_FLD_GD`
`static int`	`CABAC_FLD_MUX`
`static int`	`CABAC_FLD_MUX_OFF`
`static int`	`CABAC_FLD_MUX0`
`static int`	`CABAC_FLD_MUX1`
`static int`	`CABAC_FLD_MUXE`
`static int`	`CABAC_FLD_OD_EXP0`
`static int`	`CABAC_FLD_OD_EXP1`
`static int`	`CABAC_FLD_OD_RDO0`
`static int`	`CABAC_FLD_OD_RDO1`
`static int`	`CABAC_FLD_OG`
`static int`	`CABAC_FLD_PCLK0`
`static int`	`CABAC_FLD_PCLK1`
`static int`	`CABAC_FLD_PCLK2`
`static int`	`CABAC_FLD_PCLK3`
`static int`	`CABAC_FLD_PULSE`
`static int`	`CABAC_FLD_RD`
`static int`	`CABAC_FLD_RG`
`static int`	`CABAC_FLD_SCLK0`
`static int`	`CABAC_FLD_SCLK1`
`static int`	`CABAC_FLD_SCLK2`
`static int`	`CABAC_FLD_SPARE`
`static int`	`CABAC_FLD_SPH`
`static int`	`CABAC_FLD_SPL`
`static int`	`CABAC_FLD_TEST`
`static int`	`CABAC_OFF_BOTTOM` Public constants.
`static int`	`CABAC_OFF_READ` Public constants.
`static int`	`CABAC_OFF_TOP` Public constants.
`static int`	`CABAC_OFF_WRITE` Public constants.
`static int`	`NUM_CABAC_FLDS`
`static int`	`NUM_CABAC_FLDS_0`
`static int`	`NUM_CABAC_REGS` Public constants.
`static int`	`PWR_ENA_3V` Public constants.
`static int`	`PWR_ENA_5V` Public constants.
`static int`	`PWR_ENA_B3V` Public constants.
`static int`	`PWR_ENA_B5V` Public constants.
`static int`	`PWR_ENA_VEE` Public constants.
`static int`	`REG_CABAC` Public constants.
`static int`	`REG_CABAC_FETCH` Public constants.
`static int`	`REG_CABAC_LOAD` Public constants.
`static int`	`REG_CABAC_POWER` Public constants.
`static int`	`REG_CABAC_READ` Public constants.
`static int`	`REG_CABAC_RESET` Public constants.
`static int`	`REG_CABAC_RESET_0` Public constants.
`static int`	`VALUE_MASK` Public constants.
`static int`	`VERSION_0` Public constants.
`static int`	`VERSION_1` Public constants.
`static int`	`VERSION_UNSUPP` Public constants.

Fields inherited from class org.lsst.ccs.drivers.reb.Asic
ADDR_POSN, MAX_ASICS, MAX_STRIPS, NUM_SIDES, SIDE_BOTTOM, SIDE_MASK, SIDE_POSN, SIDE_TOP, STRIP_POSN, WRITE_POSN

Constructor Summary

Constructors
Constructor and Description

Cabac(BaseSet bss)
Constructor.

Constructors
Constructor and Description
`Cabac(BaseSet bss)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyRaw(int side)` Copies CABAC input registers to the output ones.
`void`	`fetch(int strip)` Fetches the contents of a CABAC strip to the registers.
`int[]`	`get(int side)` Gets all CABAC field values.
`int`	`get(int side, int field)` Gets one CABAC field value.
`int[]`	`get(int side, int first, int count)` Gets several CABAC field values.
`int`	`getNumFields()` Gets the number of CABAC fields.
`int`	`getNumStrips()` Gets the number of strips.
`int`	`getRegulator()` Gets the power regulator enables.
`int`	`getVersion()` Gets the CABAC version.
`void`	`load(int strip)` Loads a CABAC strip from the registers.
`int[][]`	`readField(int strips, int side)` Reads all CABAC fields.
`int[]`	`readField(int strips, int side, int field)` Reads a CABAC field.
`int[][]`	`readField(int strips, int side, int first, int count)` Reads several CABAC fields.
`int[]`	`readRaw(int side)` Reads CABAC input registers in raw format.
`void`	`reset(int strip)` Resets a CABAC strip.
`void`	`set(int side, int[] value)` Sets all CABAC field values.
`void`	`set(int side, int field, int value)` Sets one CABAC field value.
`void`	`set(int side, int first, int count, int[] value)` Sets several CABAC field values.
`void`	`setRegulator(int enables)` Sets the power regulator enables.
`void`	`writeField(int strips, int sides, int[] value)` Writes all CABAC fields.
`void`	`writeField(int strips, int sides, int field, int value)` Writes a CABAC field.
`void`	`writeField(int strips, int sides, int first, int count, int[] value)` Writes several CABAC fields.
`void`	`writeRaw(int side, int[] values)` Writes CABAC output registers in raw format.

Methods inherited from class org.lsst.ccs.drivers.reb.Asic
makeCommand

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION_UNSUPP
```
public static final int VERSION_UNSUPP
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_0
```
public static final int VERSION_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_1
```
public static final int VERSION_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC
```
public static final int REG_CABAC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC_LOAD
```
public static final int REG_CABAC_LOAD
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC_FETCH
```
public static final int REG_CABAC_FETCH
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC_RESET
```
public static final int REG_CABAC_RESET
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC_RESET_0
```
public static final int REG_CABAC_RESET_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC_READ
```
public static final int REG_CABAC_READ
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CABAC_OFF_TOP
```
public static final int CABAC_OFF_TOP
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CABAC_OFF_BOTTOM
```
public static final int CABAC_OFF_BOTTOM
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CABAC_OFF_WRITE
```
public static final int CABAC_OFF_WRITE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CABAC_OFF_READ
```
public static final int CABAC_OFF_READ
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - NUM_CABAC_REGS
```
public static final int NUM_CABAC_REGS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VALUE_MASK
```
public static final int VALUE_MASK
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_CABAC_POWER
```
public static final int REG_CABAC_POWER
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - PWR_ENA_5V
```
public static final int PWR_ENA_5V
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - PWR_ENA_3V
```
public static final int PWR_ENA_3V
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - PWR_ENA_VEE
```
public static final int PWR_ENA_VEE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - PWR_ENA_B5V
```
public static final int PWR_ENA_B5V
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - PWR_ENA_B3V
```
public static final int PWR_ENA_B3V
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CABAC_FLD_OD_EXP0
```
public static final int CABAC_FLD_OD_EXP0
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_OD_EXP1
```
public static final int CABAC_FLD_OD_EXP1
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_OD_RDO0
```
public static final int CABAC_FLD_OD_RDO0
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_OD_RDO1
```
public static final int CABAC_FLD_OD_RDO1
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_PCLK0
```
public static final int CABAC_FLD_PCLK0
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_PCLK1
```
public static final int CABAC_FLD_PCLK1
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_PCLK2
```
public static final int CABAC_FLD_PCLK2
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_PCLK3
```
public static final int CABAC_FLD_PCLK3
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_SCLK0
```
public static final int CABAC_FLD_SCLK0
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_SCLK1
```
public static final int CABAC_FLD_SCLK1
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_SCLK2
```
public static final int CABAC_FLD_SCLK2
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_RG
```
public static final int CABAC_FLD_RG
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_GD
```
public static final int CABAC_FLD_GD
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_OG
```
public static final int CABAC_FLD_OG
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_RD
```
public static final int CABAC_FLD_RD
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_SPH
```
public static final int CABAC_FLD_SPH
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_SPL
```
public static final int CABAC_FLD_SPL
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_MUX0
```
public static final int CABAC_FLD_MUX0
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_MUX1
```
public static final int CABAC_FLD_MUX1
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_PULSE
```
public static final int CABAC_FLD_PULSE
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_MUXE
```
public static final int CABAC_FLD_MUXE
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_SPARE
```
public static final int CABAC_FLD_SPARE
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_MUX
```
public static final int CABAC_FLD_MUX
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_MUX_OFF
```
public static final int CABAC_FLD_MUX_OFF
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_TEST
```
public static final int CABAC_FLD_TEST
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_EXP_CLK
```
public static final int CABAC_FLD_EXP_CLK
```
    See Also:
    
    Constant Field Values
  - CABAC_FLD_BIAS_HZ
```
public static final int CABAC_FLD_BIAS_HZ
```
    See Also:
    
    Constant Field Values
  - NUM_CABAC_FLDS_0
```
public static final int NUM_CABAC_FLDS_0
```
    See Also:
    
    Constant Field Values
  - NUM_CABAC_FLDS
```
public static final int NUM_CABAC_FLDS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cabac
```
public Cabac(BaseSet bss)
```
    Constructor.
    
    Parameters:
    
    bss - The associated base set object
- Method Detail
  - getVersion
```
public int getVersion()
```
    Gets the CABAC version.
    
    Returns:
    
    The version number: VERSION_0 for CABAC0; VERSION_1 for CABAC1
  - getNumStrips
```
public int getNumStrips()
                 throws REBException
```
    Gets the number of strips.
    
    Returns:
    
    The number of strips
    
    Throws:
    
    REBException - if the firmware version is unknown
  - fetch
```
public void fetch(int strip)
           throws REBException
```
    Fetches the contents of a CABAC strip to the registers. This transfers the contents of both (top and bottom) CABACs in the strip to the CABAC input registers in the FPGA.
    
    Parameters:
    
    strip - The number of the strip to be fetched
    
    Throws:
    
    REBException
  - load
```
public void load(int strip)
          throws REBException
```
    Loads a CABAC strip from the registers. This transfers the contents of the CABAC output registers in the FPGA to both (top and bottom) CABACs in the strip.
    
    Parameters:
    
    strip - The number of the strip to be loaded
    
    Throws:
    
    REBException
  - reset
```
public void reset(int strip)
           throws REBException
```
    Resets a CABAC strip. The contents of both (top and bottom) CABACs in the strip are reset to all zeroes.
    
    Parameters:
    
    strip - The number of the strip to be reset
    
    Throws:
    
    REBException
  - readRaw
```
public int[] readRaw(int side)
              throws REBException
```
    Reads CABAC input registers in raw format. The contents of the five input registers for the top or bottom CABAC are returned.
    
    Parameters:
    
    side - The side to read: 0 = top; 1 = bottom
    
    Returns:
    
    The 5-element array of values read from the registers
    
    Throws:
    
    REBException
  - writeRaw
```
public void writeRaw(int side,
                     int[] values)
              throws REBException
```
    Writes CABAC output registers in raw format. The five output registers for the top or bottom CABAC are set to the supplied values.
    
    Parameters:
    
    side - The side to write: 0 = top; 1 = bottom
    
    values - The 5-element array of values to be written
    
    Throws:
    
    REBException
  - copyRaw
```
public void copyRaw(int side)
             throws REBException
```
    Copies CABAC input registers to the output ones. The input registers for the top or bottom CABAC are copied to its output registers.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    Throws:
    
    REBException
  - set
```
public void set(int side,
                int field,
                int value)
         throws REBException
```
    Sets one CABAC field value. A single field is inserted into the correct location in the top or bottom CABAC's output registers. Since the output registers are write-only, this can be done in a reasonable way only if the output registers were initially primed with the contents of the input registers, which were in turn obtained by fetching the CABAC's contents.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    field - The field ID
    
    value - The value to be set
    
    Throws:
    
    REBException
  - set
```
public void set(int side,
                int[] value)
         throws REBException
```
    Sets all CABAC field values. The values for all fields of the top or bottom CABAC are set into its output registers, completely overwriting their contents.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    value - The 21-element array of values to be set
    
    Throws:
    
    REBException
  - set
```
public void set(int side,
                int first,
                int count,
                int[] value)
         throws REBException
```
    Sets several CABAC field values. The specified fields are inserted into the correct locations in the top or bottom CABAC's output registers. Since the output registers are write-only, this can be done in a reasonable way only if the output registers were initially primed with the contents of the input registers, which were in turn obtained by fetching the CABAC's contents.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    first - The ID of the first field
    
    count - The number of fields to set
    
    value - The array of values to be set
    
    Throws:
    
    REBException
  - get
```
public int get(int side,
               int field)
        throws REBException
```
    Gets one CABAC field value. The value of the specified field is extracted from the top or bottom CABAC input registers.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    field - The field ID
    
    Returns:
    
    The value of the field
    
    Throws:
    
    REBException
  - get
```
public int[] get(int side)
          throws REBException
```
    Gets all CABAC field values. The values of all fields are extracted from the top or bottom CABAC input registers.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    Returns:
    
    The 21-element array of field values
    
    Throws:
    
    REBException
  - get
```
public int[] get(int side,
                 int first,
                 int count)
          throws REBException
```
    Gets several CABAC field values. The values of the specified fields are extracted from the top or bottom CABAC input registers.
    
    Parameters:
    
    side - The side number: 0 = top; 1 = bottom
    
    first - The ID of the first field
    
    count - The number of fields to get
    
    Returns:
    
    The array of field values
    
    Throws:
    
    REBException
  - writeField
```
public void writeField(int strips,
                       int sides,
                       int field,
                       int value)
                throws REBException
```
    Writes a CABAC field.
    
    Parameters:
    
    strips - The mask of strips to write
    
    sides - The mask of sides (top and/or bottom) to write
    
    field - The CABAC field ID
    
    value - The value to write
    
    Throws:
    
    REBException
  - writeField
```
public void writeField(int strips,
                       int sides,
                       int[] value)
                throws REBException
```
    Writes all CABAC fields.
    
    Parameters:
    
    strips - The mask of strips to write
    
    sides - The mask of sides (top and/or bottom) to write
    
    value - The array of values to write
    
    Throws:
    
    REBException
  - writeField
```
public void writeField(int strips,
                       int sides,
                       int first,
                       int count,
                       int[] value)
                throws REBException
```
    Writes several CABAC fields.
    
    Parameters:
    
    strips - The mask of strips to write
    
    sides - The mask of sides (top and/or bottom) to write
    
    first - The ID of the first field
    
    count - The number of fields to write
    
    value - The array of values to write
    
    Throws:
    
    REBException
  - readField
```
public int[] readField(int strips,
                       int side,
                       int field)
                throws REBException
```
    Reads a CABAC field.
    
    Parameters:
    
    strips - The mask of strips to read
    
    side - The side number: 0 = top; 1 = bottom
    
    field - The CABAC field ID
    
    Returns:
    
    The array of read values, one per read strip
    
    Throws:
    
    REBException
  - readField
```
public int[][] readField(int strips,
                         int side)
                  throws REBException
```
    Reads all CABAC fields.
    
    Parameters:
    
    strips - The mask of strips to read
    
    side - The side number: 0 = top; 1 = bottom
    
    Returns:
    
    The array of read value arrays, one per read strip
    
    Throws:
    
    REBException
  - readField
```
public int[][] readField(int strips,
                         int side,
                         int first,
                         int count)
                  throws REBException
```
    Reads several CABAC fields.
    
    Parameters:
    
    strips - The mask of strips to read
    
    side - The side number: 0 = top; 1 = bottom
    
    first - The ID of the first field
    
    count - The number of fields to read
    
    Returns:
    
    The array of read value arrays, one per read strip
    
    Throws:
    
    REBException
  - getNumFields
```
public int getNumFields()
                 throws REBException
```
    Gets the number of CABAC fields.
    
    Returns:
    
    The number of fields
    
    Throws:
    
    REBException
  - setRegulator
```
public void setRegulator(int enables)
                  throws REBException
```
    Sets the power regulator enables.
    
    Parameters:
    
    enables - The mask of enable bits
    
    Throws:
    
    REBException
  - getRegulator
```
public int getRegulator()
                 throws REBException
```
    Gets the power regulator enables.
    
    Returns:
    
    The mask of enable bits
    
    Throws:
    
    REBException

Class Cabac

Field Summary

Fields inherited from class org.lsst.ccs.drivers.reb.Asic

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.drivers.reb.Asic

Methods inherited from class java.lang.Object

Field Detail

VERSION_UNSUPP

VERSION_0

VERSION_1

REG_CABAC

REG_CABAC_LOAD

REG_CABAC_FETCH

REG_CABAC_RESET

REG_CABAC_RESET_0

REG_CABAC_READ

CABAC_OFF_TOP

CABAC_OFF_BOTTOM

CABAC_OFF_WRITE

CABAC_OFF_READ

NUM_CABAC_REGS

VALUE_MASK

REG_CABAC_POWER

PWR_ENA_5V

PWR_ENA_3V

PWR_ENA_VEE

PWR_ENA_B5V

PWR_ENA_B3V

CABAC_FLD_OD_EXP0

CABAC_FLD_OD_EXP1

CABAC_FLD_OD_RDO0

CABAC_FLD_OD_RDO1

CABAC_FLD_PCLK0

CABAC_FLD_PCLK1

CABAC_FLD_PCLK2

CABAC_FLD_PCLK3

CABAC_FLD_SCLK0

CABAC_FLD_SCLK1

CABAC_FLD_SCLK2

CABAC_FLD_RG

CABAC_FLD_GD

CABAC_FLD_OG

CABAC_FLD_RD

CABAC_FLD_SPH

CABAC_FLD_SPL

CABAC_FLD_MUX0

CABAC_FLD_MUX1

CABAC_FLD_PULSE

CABAC_FLD_MUXE

CABAC_FLD_SPARE

CABAC_FLD_MUX

CABAC_FLD_MUX_OFF

CABAC_FLD_TEST

CABAC_FLD_EXP_CLK

CABAC_FLD_BIAS_HZ

NUM_CABAC_FLDS_0

NUM_CABAC_FLDS

Constructor Detail

Cabac

Method Detail

getVersion

getNumStrips

fetch

load

reset

readRaw

writeRaw

copyRaw

set

set

set

get

get

get

writeField

writeField

writeField

readField

readField