org.lsst.ccs.drivers.iocard

Class AccesDio

java.lang.Object

org.lsst.ccs.drivers.iocard.Iocard

org.lsst.ccs.drivers.iocard.AccesDio

public final class AccesDio
extends Iocard

Provides an interface to a digital I/O card made by Acces I/O. There are three eight-bit port registers which contain the state of the I/O lines: A, B and C. One can configure the direction of the lines, input or output, independently for each of four groups of bits: all bits of A, all bits of B, the low-order four bits of C and the high-order four bits of C. One can enable change-of-line-state interrupts independently for three groups: all of A, all of B and all of C.

Note that values you write to the ports will read back correctly only in the bits that are set as outputs. The interrupt setup register will always read back as zero.

Not all cards in this family allow you to read an interrupt status, so this feature isn't supported. To track changes you have to save the old port values and compare them to the new ones just after the interrupt.

Some cards offer two banks of port registers. For such cards we support only the first bank.

For the PCI/PCIe/mPCIe cards we can search for the first card we find that comes from Acces I/O. For a particular card among several or for an ISA card you'll have to give the I/O base address and the assigned IRQ.

This driver includes a Linux kernel module iocardk.ko which must be loaded in order to operate the DIO card. The script load.sh can be run at boot time to load the module and set the permissions for the device /dev/iocard. There is also a JNI library libIocard.so which allows you to use the card from Java.

In order to handle interrupts, you register a Java method as a callback with the JNI library. The library acknowledges each interrupt so your callback doesn't need to.

Author:

saxton, tether

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONF_REG The offset to the I/O direction configuration register.
static int	INPUT_A Indicates that the A register pins are inputs.
static int	INPUT_B Indicates that the B register pins are inputs.
static int	INPUT_C_HIGH Indicates that the high four C register pins are inputs.
static int	INPUT_C_LOW Indicates that low four C register pins are inputs.
static int	INTERRUPT_A Indicates that register A pins are to generate change-of-state interrupts.
static int	INTERRUPT_B Indicates that register B pins are to generate change-of-state interrupts.
static int	INTERRUPT_C Indicates that register C pins are to generate change-of-state interrupts.
static int	ISA_N_REGS The number of registers in the old ISA cards.
static int	ISA_STATUS_AND_RESET_REG The offset to the interrupt status (read) and reset (write) register.
static int	PCI_MIN_IO_ADDR The minimum I/O port address assigned to PCI cards by the Linux kernel.
static int	PCI_N_REGS The number of registers in the PCI/PCIe/mPCIe cards
static int	PCI_VENDOR_ID The vendor ID for PCI cards from Acces I/O.
static int	PORTA_REG The offset to the A register.
static int	PORTB_REG The offset to the B register.
static int	PORTC_REG The offset to the C register.
static int	RESET_REG The offset to the interrupt reset register.
static int	SETUP_REG The offset to the interrupt setup register.

Fields inherited from class org.lsst.ccs.drivers.iocard.Iocard

OPT_CHECK, OPT_READV, OPT_WRITER

Constructor Summary

Constructors

Constructor and Description
AccesDio() Deprecated.
AccesDio(int base, int irq) Finds and initializes a digital I/O card.

Method Summary

Modifier and Type	Method and Description
void	attachInt(int mask, Object cbObj, String cbMeth, Object cbParm) Register a Java callback for interrupt handling.
void	detachInt() Unregisters the current Java interrupt callback, if any, and disables all interrupts.
void	dioClrBit(int port, int bit) Equivalent to dioOutBit(port, bit, 0).
void	dioConfig(int inputLineMask) Specify which of the DIO card I/O lines are inputs.
int	dioInp(int port) Reads all bits from one of the data ports on the DIO card.
int	dioInpBit(int port, int bit) Reads one of the data ports on the DIO card and returns the value of the selected bit.
void	dioOut(int port, int value) Writes all bits to one of the data ports on the DIO card.
void	dioOutBit(int port, int bit, int value) Uses read-modify-write to update the value of the selected bit in a data port.
void	dioSetBit(int port, int bit) Equivalent to dioOutBit(port, bit, 1).
int	getBase() Gets the I/O space base address of the card.
int	getIrq() Gets the IRQ line no.
int	getNregs() Gets the number of I/O space addresses assigned to the card.
void	init(int base, int irq) Deprecated.

Methods inherited from class org.lsst.ccs.drivers.iocard.Iocard

attachInt, detachInt, init, readB, readL, readW, term, updateB, updateL, updateW, writeB, writeL, writeW

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ISA_N_REGS

public static final int ISA_N_REGS

The number of registers in the old ISA cards.

See Also:

Constant Field Values

PCI_N_REGS

public static final int PCI_N_REGS

The number of registers in the PCI/PCIe/mPCIe cards

See Also:

Constant Field Values

PORTA_REG

public static final int PORTA_REG

The offset to the A register.

See Also:

Constant Field Values

PORTB_REG

public static final int PORTB_REG

The offset to the B register.

See Also:

Constant Field Values

PORTC_REG

public static final int PORTC_REG

The offset to the C register.

See Also:

Constant Field Values

CONF_REG

public static final int CONF_REG

The offset to the I/O direction configuration register.

See Also:

Constant Field Values

SETUP_REG

public static final int SETUP_REG

The offset to the interrupt setup register.

See Also:

Constant Field Values

RESET_REG

public static final int RESET_REG

The offset to the interrupt reset register.

See Also:

Constant Field Values

ISA_STATUS_AND_RESET_REG

public static final int ISA_STATUS_AND_RESET_REG

The offset to the interrupt status (read) and reset (write) register. ISA cards only.

See Also:

Constant Field Values

PCI_VENDOR_ID

public static final int PCI_VENDOR_ID

The vendor ID for PCI cards from Acces I/O.

See Also:

Constant Field Values

PCI_MIN_IO_ADDR

public static final int PCI_MIN_IO_ADDR

The minimum I/O port address assigned to PCI cards by the Linux kernel.

See Also:

Constant Field Values

INPUT_A

public static final int INPUT_A

Indicates that the A register pins are inputs.

See Also:

dioConfig(int), Constant Field Values

INPUT_B

public static final int INPUT_B

Indicates that the B register pins are inputs.

See Also:

dioConfig(int), Constant Field Values

INPUT_C_LOW

public static final int INPUT_C_LOW

Indicates that low four C register pins are inputs.

See Also:

dioConfig(int), Constant Field Values

INPUT_C_HIGH

public static final int INPUT_C_HIGH

Indicates that the high four C register pins are inputs.

See Also:

dioConfig(int), Constant Field Values

INTERRUPT_A

public static final int INTERRUPT_A

Indicates that register A pins are to generate change-of-state interrupts.

See Also:

attachInt(int, Object, String, Object), Constant Field Values

INTERRUPT_B

public static final int INTERRUPT_B

Indicates that register B pins are to generate change-of-state interrupts.

See Also:

attachInt(int, Object, String, Object), Constant Field Values

INTERRUPT_C

public static final int INTERRUPT_C

Indicates that register C pins are to generate change-of-state interrupts.

See Also:

attachInt(int, Object, String, Object), Constant Field Values

Constructor Detail

AccesDio

public AccesDio(int base,
                int irq)

Finds and initializes a digital I/O card.

Parameters:

base - The I/O base address of the card. If the value is negative and a PCI/PCIe/mPCIe bus is present then the bus is searched for the first card from Acces I/O.

irq - The IRQ line no. assigned to the card. Ignored if a negative base address was given.

AccesDio

@Deprecated
public AccesDio()

Deprecated.

Constructs and instance but doesn't find or initialize a DIO card.

Method Detail

init

@Deprecated
public void init(int base,
                             int irq)

Deprecated.

Finds and initializes a DIO card.

Parameters:

base -

irq -

See Also:

AccesDio(int, int)

getIrq

public int getIrq()

Gets the IRQ line no. assigned to the card.

Returns:

The IRQ assignment.

getBase

public int getBase()

Gets the I/O space base address of the card.

Returns:

The I/O address.

getNregs

public int getNregs()

Gets the number of I/O space addresses assigned to the card.

Returns:

The number of eight-bit registers.

dioConfig

public void dioConfig(int inputLineMask)

Specify which of the DIO card I/O lines are inputs. Any lines not mentioned are configured as outputs.

Parameters:

inputLineMask - The inclusive OR of any combination of INPUT_A, INPUT_B, INPUT_C_LOW or INPUT_C_HIGH.

dioInp

public int dioInp(int port)

Reads all bits from one of the data ports on the DIO card.

Parameters:

port - One of PORTA_REG, PORTB_REG or PORTC_REG.

Returns:

The current value of the port register.

Throws:

AccesDioException - if the port number is invalid.

dioOut

public void dioOut(int port,
                   int value)

Writes all bits to one of the data ports on the DIO card.

Parameters:

port - One of PORTA_REG, PORTB_REG or PORTC_REG.

value - The value to be written, 0 <= value <= 255.

Throws:

AccesDioException - if the port number is invalid.

dioInpBit

public int dioInpBit(int port,
                     int bit)

Reads one of the data ports on the DIO card and returns the value of the selected bit.

Parameters:

port - One of PORTA_REG, PORTB_REG or PORTC_REG.

bit - The bit index, 0 <= bit <= 7.

Returns:

(regValue >> bit) & 1

Throws:

AccesDioException - if the port number is invalid.

dioOutBit

public void dioOutBit(int port,
                      int bit,
                      int value)

Uses read-modify-write to update the value of the selected bit in a data port. Afterward dioInpBit(int, int) with the same port and bit numbers will return the new bit value.

Parameters:

port - One of PORTA_REG, PORTB_REG or PORTC_REG.

bit - The bit index, 0 <= bit <= 7.

value - The new bit value, 0 or 1.

Throws:

AccesDioException - if the port number is invalid.

dioSetBit

public void dioSetBit(int port,
                      int bit)

Equivalent to dioOutBit(port, bit, 1).

Parameters:

port -

bit -

Throws:

AccesDioException - if the port number is invalid.

See Also:

dioOutBit(int, int, int)

dioClrBit

public void dioClrBit(int port,
                      int bit)

Equivalent to dioOutBit(port, bit, 0).

Parameters:

port -

bit -

Throws:

AccesDioException - if the port number is invalid.

See Also:

dioOutBit(int, int, int)

attachInt

public void attachInt(int mask,
                      Object cbObj,
                      String cbMeth,
                      Object cbParm)

Register a Java callback for interrupt handling. Only a single callback may be registered at any given time.

Parameters:

mask - Specifies which ports are to be sources of interrupts. The logical OR of any combination of INTERRUPT_A, INTERRUPT_B or INTERRUPT_C.

cbObj - The object containing the method to be called.

cbMeth - The name of the method to call on cbObj when an interrupt occurs.

cbParm - The argument to be given to cbObj.cbMeth()

detachInt

public void detachInt()

Unregisters the current Java interrupt callback, if any, and disables all interrupts.