CVMUSB

This function returns a vector of usb_device* pointers, one for each VM-USB powered up and attached to the system. usb_device is an opaque type used by libusb to refer to a specific device attached to the host via USB.

Given a usb_device pointer, typically] gotten from CVMUSB::enumerate, returns the serial number string of the device that corresponds to it.

Constructs a CVMUSB object given a usb_device pointer typically gotten from CVMUSB::enumerate

Creates an empty readout list.

Writes value to the VM-USB action register. The action register is a write only register that is used to control the overall behavior of the VM-USB. It allows you to enter or leave data taking mode, reset the VME bus and trigger the various downloaded VME lists.

The action register is described in section 3.1 of the VM-UBS manual.

Reads the firmware Id register. The firmware Id is a bit encoded readonly register that provides the date, status (beta test or production), the major and minor versions of the firmware. The firmware Id register is described by section 3.4.1 of the VM-USB manual.

Writes value to the VM-USB global mode regiseter. The global mode register determiens the bus request level, header options and the size of the output buffer, as well as a few other buffer options. It is described in setion 3.4.2 of the VM-USB manual.

Returns the value of the global mode register.

Writes the data acquisition settings register with value. This register, described in section 3.4.3 of the VM-USB manual, determines how scaler buffers are read and the delay between a readout trigger from IN1 and the actual start of VME list execution. This is provided to allow users to provide a common digitizer and VM-USB trigger. The delay, in that case allows digitizers to complete their conversions prior to being read by the readout list.

Returns the value of the data acquisition settings register.

Write value to the VM-USB LED source register. The VM-USB has a set of four LEDs. This register determines the conditions under which each of those LEDs is lit. The LED source register is described in section 3.4.4 of the VM-USB manual.

Returns the current value of the LED source register.

Writes value to the VM-USB device source register. The VM-USB provides a pair of scalers and gate and delay generators, as well as two front panel NIM outputs. This register defines the signal sources for each of these devices (when scalers increment, what starts a gate and delay generator and when the outputs are asserted).

The Device Sources register is described in section 3.4.5 of the VM-USB manual.

Returns the value of the Device source register.

Writes value to the Delay and Gate Generator A control register. This register contains the length of the output gateas well as the low order bits of the delay. The Delay and Gate register setup is described in section 3.4.6 of the VM-USB manual.

Returns the value of the DGG A control register.

Writes value to the Delay and Gate Generator B control register. This register contains the length of the output gateas well as the low order bits of the delay. The Delay and Gate register setup is described in section 3.4.6 of the VM-USB manual.

Returns the value of the DGG B control register.

Writes the DGG extended delay offset. This register contains the top 16 bits of the delay for both A and B DGG's. It is describedin section 3.4.6 of the VM-USB manual.

Reads the DGG extended delay register.

The VM-USB contains two scalers (counters) that can be incremented as a result of several conditions. These scalers are named A and B and are described in section 3.4.7 of the VM-USB manual.

This method returns the value of scaler A.

See readScalerA this method returns the value of scaler B.

The VM-USB allows stacks to be triggered as a result of VME interrupts. 4 interrupt registers are provided as described in section 3.4.8. Each register describes the IPL and Status ID of two interrupts and associates each of those with a stack. This method allows you to program the value of one of those registers.

The which parameter selects which of the interrupt registers to write, numbered from 1 through 4. The value parameter is written to the selected register.

An error message is thrown as an std::string if which is illegal.

As essentially all VME interrupters in existence use an 8 bit status ID for which the top bits must be set, according to the VME standard, These methods also write both Status/ID expansion registers to 0xffffffff

Returns the value of one of the interrupt registers described above. which indicates which one to read.

Writes the IRQ mask register described in section 3.5 of the VM-USB manual. The register is set to mask. Each bit in the mask represents a VME IPL. 0x01 represents IPL1, 0x40 represents IPL 7. If a bit is set to 1, interrupts at that IPL will be ignored by the VM-USB.

This register only needs to be programmed when the VM-USB is used with other interrupt handling modules (e.g. CPU modules).

Returns the value last written to the IRQ mask register. The actual register is write-only. The CVMUSB class therefore remembers the most recently written value. This shadow register value is what is returned by this method. Note as well that the IRQ mask register is set to 0xff by the constructor so that it has a known intial value. This initial value disables all interrupt handling by the VM-USB.

Writes value to the Bulk Transfer setup register. This register is described in section 3.4.10 of the VM-USB manual. It controls several parameters that can optimize the bandwidth of the USB. Specifically you can set the number of buffers that will be sent from the VM-USB to the host without generating a USB Packet end frame and the timeout after which the packet end frame will be sent regardless of how many bufers were sent.

If the paragraph above is not meaningful to you, and you read 3.4.10 and its still not meaningful, you should probably not touch this register.

Returns the value of the Bulk Transfer Setup register.

Writes a 32 bit longword, data to a vme address using the VME Address modifier aModifier.

The function returns 0 on success, -1 if the USB write failed, -2 if the USB read of the acknowledgement failed, and -3 if the acknowledgement packet indicated the transfer failed due to a bus error.

For USB write and read failures, the resason for the failure is available in errno

Performs a 32 bit longword read from address using the VME bus address modifier aModifier. If successful, the data are stored in data.

The return value reflects a high level status of the operation. The function returns 0 on success, -1 if the USB write failed, -2 if the USB read of the acknowledgement failed.

For USB write and read failures, the resason for the failure is available in errno

Identical to vmeWrite32 however the data transfered is only a 16 bit word wide.

Identical to vmeRead32 however the data read are only a 16 bit word wide.

Same as vmeWrite32 however the data written are an 8 bit byte in width.

Same as vmeRead32 however the data read are an 8 bit byte in width.

Performs a block read from the VME bus. VME block reads the requestor to only send an initial VME base address followed by a new address every time the address crosses a 256 byte boundary. Subsequent addresses are assumed to represent a contiguous block of storage. Not all devices support block transfers. Block transfers also require specific block transfer address modifiers. When used properly, block transfers allow higher throughput by reducing the number of address cycles.

The base address of the block transfer is baseAddress. The address modifier used is aModifier the caller is responsible for ensuring that aModifier is a valid block transfer address modifier. data is a buffer that will receive the data read. transferCount is the number of longwords (32 bit items) to transfer. All transfers will be 32 bit wide transfers. countTransferred will be the actual number of longwords transferred.

For some devices it is possible to transfer fewer items thatn the number of items requested. An example of this is the use of CAEN V785's in chained block mode. In that case, the read will transfer data until the ADC's have no more data left at which time the modules will return a bus error on the next transfer and the VM-USB will insert a 0xffffffff marker in the data stream when the bus error occured.

This function is the same as vmeBlockRead except that all address cycles use the same address value. This makes the function suitable to read FIFO registers in modules that support block reads.

The VM-USB supports variable sized block reads. These operate by first performing a read of the block count from some register and providing a mask that indicates what part of that data contains the transfer count. The block count read must at some point be folowed by a call to vmeVariableBlockRead to actually perform the block read.

This method does an 8 bit transfer to read the block count for the next vmeVariableBlockRead call. address is the byte address of the location that contains the count field. The addressed module must support byte addressing at this location. mask is the mask that defines the bit field containing the count. amod is the address modifier for the transfer of the transfer count.

Same as vmeReadBlockCount8 but the block count transfer is 16 bits wide.

Same as vmeReadouBlockCount8 except the block count is read with a 32 bit transfer.

Do a variable length block transfer. This transfer must have been set up by doing a call to one of the vmeReadBlockCountxx functions. furthermore, no other block transfer can have taken place since that operation. It is strongly recommended that unless prohibited by the hardware, a vmeReadBlockCountxx be immediately followed by a variable block read or variable fifo read.

address is the starting address of the block read. amod is the VME address modifier. data is a buffer into which data will be stored and maxCount the size of that buffer in 32bit longwords. countTransferred will be filled in with the total number of longwords actually transferred.

The total transfer count is the minimum of the variable block read gotten by the vmeReadBlockCountxx method, the value of the maxCount parameter to this call and the number of transfers actually performed prior to and including the transfer that caused a bus error if any.

As usual, in the event the transfer terminated with a bus error, that operation inserts a 0xffffffff in the buffer.

Same as vmeVariableBlockRead but all addresses cycles provide address rather than

This function executes a list of operations. The list parameter is an instance of a CVMUSBReadoutList class. See the documentation for that class for a description of how to build up lists of VM-USB operations.

pReadBuffer points to a buffer into which the results of all VME read operations will be put. The buffer must be readBufferSize 8 bit bytes long. bytesRead will be written with the number of bytes actually transferred to pReadBuffer

Loads a list for triggered execution in data taking mode. listNumber is the number of the list to load (stack Number). Tis is a value in the range [0..7]. list is a list of operations built up by instantiating a CVMUSBReadoutList

listOffset is the starting offset in VM-USB memory at which the list should be loaded. When computing where to load multiple stacks you need to know that each stack requires:

list.size() * sizeof(uint32_t)/sizeof(uint16_t) + 4
                                

Performs a bulk read on the VM-USB. data provides a buffer into which the data will be read. bufferSize is the number of bytes of space pointed to by data transferCount will be written with the number of transfers that actually were performed.

The return value is 0 on success or -1 on failure. On failure, zero will be stored in the transferCount and errno will have the reason for the failure.

If no data are available by timeout milliseconds, the read will fail with an errno value of ETIMEDOUT

Sets the timeout used for transactions that don't provide a timeout value. ms is the number of milliseconds these methods will wait for a response from the VM-USB.

Almost all actions with the VM-USB require the host to send a USB packet to the VM-USB and receive a packet in return. This function sets the timeout that will be used for the usbRead call to get the return packets.