drivers/staging/meilhaus/me8200_di.h

   1 /**
   2  * @file me8200_di.h
   3  *
   4  * @brief ME-8200 digital input subdevice class.
   5  * @note Copyright (C) 2007 Meilhaus Electronic GmbH (support@meilhaus.de)
   6  * @author Guenter Gebhardt
   7  */
   8
   9 /*
  10  * Copyright (C) 2007 Meilhaus Electronic GmbH (support@meilhaus.de)
  11  *
  12  * This file is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25  */
  26
  27 #ifndef _ME8200_DI_H_
  28 #define _ME8200_DI_H_
  29
  30 #include "mesubdevice.h"
  31
  32 #ifdef __KERNEL__
  33
  34 /**
  35  * @brief The template subdevice class.
  36  */
  37 typedef struct me8200_di_subdevice {
  38         /* Inheritance */
  39         me_subdevice_t base;                    /**< The subdevice base class. */
  40
  41         /* Attributes */
  42         spinlock_t subdevice_lock;              /**< Spin lock to protect the subdevice from concurrent access. */
  43         spinlock_t *ctrl_reg_lock;
  44         spinlock_t *irq_ctrl_lock;
  45         spinlock_t *irq_mode_lock;
  46
  47         unsigned int di_idx;
  48         unsigned int version;
  49
  50         int irq;                                                /**< The number of the interrupt request. */
  51         volatile int rised;                             /**< Flag to indicate if an interrupt occured. */
  52         uint status_flag;                               /**< Default interupt status flag */
  53         uint status_value;                              /**< Interupt status */
  54         uint status_value_edges;                        /**< Extended interupt status */
  55         uint line_value;
  56         int count;                                              /**< Counts the number of interrupts occured. */
  57         uint8_t compare_value;
  58         uint8_t filtering_flag;
  59
  60         wait_queue_head_t wait_queue;   /**< To wait on interrupts. */
  61
  62         unsigned long port_reg;                 /**< The digital input port. */
  63         unsigned long compare_reg;              /**< The register to hold the value to compare with. */
  64         unsigned long mask_reg;                 /**< The register to hold the mask. */
  65         unsigned long irq_mode_reg;             /**< The interrupt mode register. */
  66         unsigned long irq_ctrl_reg;             /**< The interrupt control register. */
  67         unsigned long irq_status_reg;   /**< The interrupt status register. Also interrupt reseting register (firmware version 7 and later).*/
  68 #ifdef MEDEBUG_DEBUG_REG
  69         unsigned long reg_base;
  70 #endif
  71         unsigned long firmware_version_reg;     /**< The interrupt reseting register. */
  72
  73         unsigned long irq_status_low_reg;       /**< The interrupt extended status register (low part). */
  74         unsigned long irq_status_high_reg;      /**< The interrupt extended status register (high part). */
  75 } me8200_di_subdevice_t;
  76
  77 /**
  78  * @brief The constructor to generate a ME-8200 digital input subdevice instance.
  79  *
  80  * @param reg_base The register base address of the device as returned by the PCI BIOS.
  81  *
  82  * @return Pointer to new instance on success.\n
  83  * NULL on error.
  84  */
  85 me8200_di_subdevice_t *me8200_di_constructor(uint32_t me8200_reg_base,
  86                                              unsigned int di_idx,
  87                                              int irq,
  88                                              spinlock_t * irq_ctrl_lock,
  89                                              spinlock_t * irq_mode_lock);
  90
  91 #endif
  92 #endif