ir104.h

Go to the documentation of this file.

/* -*- mode: C; indent-tabs-mode: nil; c-basic-offset: 8; tab-width: 8; -*- */
/* vim: set shiftwidth=8 softtabstop=8 expandtab: */
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2011, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
/*
 * Driver for Diamond IR104 relay card made by Tri-M Engineering.
 * This pc104 card has 20 output relays and 20 opto-isolated inputs.
 * Newer versions of this card can generate interrupts on inputs,
 * but as of now, this driver does not support interrupts.
 *
 * Original Author: Gordon Maclean
*/

#ifndef NIDAS_DIAMOND_IR104_H
#define NIDAS_DIAMOND_IR104_H

#ifndef __KERNEL__

/* User programs need this for the _IO macros, but kernel
 * modules get their's elsewhere.
 */
#include <sys/ioctl.h>
#include <sys/types.h>

#endif

#define IR104_IOC_MAGIC 'i'

#define IR104_MAX_BOARDS 4

#define IR104_IO_REGION_SIZE 15

#define IR104_GET_NOUT  _IO(IR104_IOC_MAGIC,0)

#define IR104_GET_NIN   _IO(IR104_IOC_MAGIC,1)

#define IR104_CLEAR \
    _IOW(IR104_IOC_MAGIC,2,unsigned char[3])

#define IR104_SET \
    _IOW(IR104_IOC_MAGIC,3,unsigned char[3])

#define IR104_SET_TO_VAL \
    _IOW(IR104_IOC_MAGIC,4,unsigned char[6])

#define IR104_GET_DOUT \
    _IOR(IR104_IOC_MAGIC,5,unsigned char[3])

#define IR104_GET_DIN \
    _IOR(IR104_IOC_MAGIC,6,unsigned char[3])

#define IR104_IOC_MAXNR 6

#define IR104_NOUT 20

#define IR104_NIN 20

#ifdef __KERNEL__
/********  Start of definitions used by the driver module only **********/

#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/types.h>

#include <nidas/linux/util.h>

struct IR104 {

        unsigned int ioport;

        unsigned long addr;

        char deviceName[16];

        struct cdev cdev;

        struct device* device;

        atomic_t num_opened;

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
        struct mutex mutex;
#else
        struct semaphore mutex;
#endif

        unsigned char outputs[3];

        struct dsm_sample_circ_buf relay_samples;

        wait_queue_head_t read_queue;

        struct sample_read_state read_state;

        unsigned int missedSamples;

};

#endif

#endif