|
Beamline Instrument Software Support |
|
|
|
SPEC Macro documentation:
[ Macro Index |
BCU Home ]
|
|
| CUB.mac | ||||||
| [ source code | installed at | configured at ] | ||||||
| See other macros in category: Other hardware Generic I/O | ||||||
Description:
| ||||||
Documentation:
Set of primary functions and macros to be used to control and access CUB and PUDS mezzanines SETUP TODO - to be documented | ||||||
Macros:
Usage: cubFuncs MACRO: print the defined device server functions for the device cubInit Usage: cubInit <device> MACRO: set the global variable with <device> value cubR32 Usage: cubR32 <seg> <addr> MACRO: print the 32 bit register value at <seg> space and <addr> position cubR16 Usage: cubR16 <seg> <addr> MACRO: print the 16 bit register value at <seg> space and <addr> position cubR8 Usage: cubR8 <seg> <addr> MACRO: print the 8 bit register value at <seg> space and <addr> position cubW32 Usage: cubW32 <seg> <addr> <val> MACRO: write the value <val> in the 32 bit register at <seg> space and <addr> position cubW16 Usage: cubW16 <seg> <addr> <val> MACRO: write the value <val> in the 16 bit register at <seg> space and <addr> position cubW8 Usage: cubW8 <seg> <addr> <val> MACRO: write the value <val> in the 8 bit register at <seg> space and <addr> position cubReset Usage: cubReset MACRO: erase all FPGA's, set sensitive bit to 0 (segment 2, address 4, bit 23) cubLoadVirtex Usage: cubLoadVirtex <bit file> MACRO: loads the CUB Virtex file <bit file> to FPGA cubLoadSpartanList Usage: cubLoadSpartanList <list file> MACRO: loads the PUDS Spartan files <list file> to FPGA. The <list file> contains the complete path-filename of the files to be loaded, one per line cubLoadSpartan Usage: cubLoadSpartan <bit file> MACRO: loads the PUDS Spartan file <bit file> to FPGA. cubTest Usage: cubTest MACRO: test macro: loads a predefined CUB Virtex bitfile and reads some registers cubTestSpartanList Usage: cubTestSpartanList MACRO: test macro: loads a predefined PUDS SPARTAN bitfile list. cubTestSpartan Usage: cubTestSpartan MACRO: test macro: loads a predefined PUDS SPARTAN bitfile. cubTestVirtex Usage: cubTestVirtex MACRO: test macro: loads a predefined CUB Virtex bitfile. cubHello Usage: cubHello <str> MACRO: special test macro / NOT DOCUMENTED / NOT USE cubTestRW32 Usage: cubTestRW32 MACRO: test RW 32-bit registers cubTestRW16 Usage: cubTestRW16 MACRO: test RW 16-bit registers cubTestRW8 Usage: cubTestRW8 MACRO: test RW 8-bit registers cubversion Usage: cubversion print RCS version | ||||||
| Internal Macros: | ||||||
Usage: cub_get_bit_path_filename (<bit filename>) MACRO: get complete path-filename of the bit file cub_r32 Usage: cub_r32 (seg, addr) FUNCTION: returns the 32 bit register value at <seg> space and <addr> position cub_r16 Usage: cub_r16 (seg, addr) FUNCTION: returns the 16 bit register value at <seg> space and <addr> position cub_r8 Usage: cub_r8 (seg, addr) FUNCTION: returns the 8 bit register value at <seg> space and <addr> position cub_w32 Usage: cub_w32 (seg, addr, val) FUNCTION: writes the value <val> in the 32 bit register at <seg> space and <addr> position. returns the result of esrf_io operation. cub_w16 Usage: cub_w16 (seg, addr, val) FUNCTION: writes the value <val> in the 16 bit register at <seg> space and <addr> position. returns the result of esrf_io operation. cub_w8 Usage: cub_w8 (seg, addr, val) FUNCTION: writes the value <val> in the 8 bit register at <seg> space and <addr> position. returns the result of esrf_io operation. cub_set_timeout Usage: cub_set_timeout (val) FUNCTION: sets the remote procedure call (RPC) of SPEC the value <val> in seconds. return the value set in seconds. cub_restore_timeout Usage: cub_restore_timeout () FUNCTION: restore the remote procedure call (RPC) of SPEC the default value. returns the default value set in seconds. cub_test_rw32_1 Usage: cub_test_rw32_1 (seg, addr, val) FUNCTION: test function: writes and read a value <val> in the 32 bit register at <seg> space and <addr> position. print the results. return if there was a discrepance (1 -> error) cub_test_rw16_1 Usage: cub_test_rw16_1 (seg, addr, val) FUNCTION: test function: writes and read a value <val> in the 16 bit register at <seg> space and <addr> position. print the results. return if there was a discrepance (1 -> error) cub_test_rw8_1 Usage: cub_test_rw8_1 (seg, addr, val) FUNCTION: test function: writes and read a value <val> in the 8 bit register at <seg> space and <addr> position. print the results. return if there was a discrepance (1 -> error) cub_test_rw32 Usage: cub_test_rw32 (seg, addr) FUNCTION: test function: perform a W/R bit-shifting test in the 32 bit register at <seg> space and <addr> position. print the results. return if there was a discrepance (1 -> error) cub_test_rw16 Usage: cub_test_rw16 (seg, addr) FUNCTION: test function: perform a W/R bit-shifting test in the 16 bit register at <seg> space and <addr> position. print the results. return if there was a discrepance (1 -> error) cub_test_rw8 Usage: cub_test_rw8 (seg, addr) FUNCTION: test function: perform a W/R bit-shifting test in the 8 bit register at <seg> space and <addr> position. print the results. return if there was a discrepance (1 -> error) | ||||||
|