viper_dio.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
 **
 ** 2007, 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 Viper digital IO ports. There are 8 independent inputs, IN0-7,
   and 8 independent outputs OUT0-7.  The value of the inputs can be read,
   and the value of the outputs written or read.

   Original Author: Gordon Maclean

*/

#ifndef NIDAS_ARCOM_VIPER_DIO_H
#define NIDAS_ARCOM_VIPER_DIO_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 VIPER_DIO_IOC_MAGIC 'v'

#define VIPER_DIO_GET_NOUT  _IO(VIPER_DIO_IOC_MAGIC,0)

#define VIPER_DIO_GET_NIN   _IO(VIPER_DIO_IOC_MAGIC,1)

#define VIPER_DIO_CLEAR \
    _IOW(VIPER_DIO_IOC_MAGIC,2,unsigned char)

#define VIPER_DIO_SET \
    _IOW(VIPER_DIO_IOC_MAGIC,3,unsigned char)

#define VIPER_DIO_SET_TO_VAL \
    _IOW(VIPER_DIO_IOC_MAGIC,4,unsigned char[2])

#define VIPER_DIO_GET_DOUT \
    _IOR(VIPER_DIO_IOC_MAGIC,5,unsigned char)

#define VIPER_DIO_GET_DIN \
    _IOR(VIPER_DIO_IOC_MAGIC,6,unsigned char)

#define VIPER_DIO_IOC_MAXNR 6

#define VIPER_DIO_NOUT 8

#define VIPER_DIO_NIN 8

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

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

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)
#include <mach/viper.h>
#else
#include <asm/arch/viper.h>
#endif

/*
  Definitions missing from viper.h for GPIO read register.
  Physical address of 16 bit GPIO read register */
#define _VIPER_GPIO_PHYS (VIPER_CPLD_PHYS + 0x500000)
/* Virtual address of 16 bit GPIO read register */
#define VIPER_GPIO __VIPER_CPLD_REG(_VIPER_GPIO_PHYS)

struct VIPER_DIO {

        char deviceName[64];

        struct cdev cdev;

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
        struct mutex reg_mutex;         // enforce atomic access to dio regs
#else
        struct semaphore reg_mutex;     // enforce atomic access to dio regs
#endif

        struct class* vclass;

        struct device* device;
};

#endif

#endif