drivers/staging/meilhaus/me1000_dio.h

   1 /**
   2  * @file me1000_dio.h
   3  *
   4  * @brief Meilhaus ME-1000 digital i/o implementation.
   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 _ME1000_DIO_H_
  28 #define _ME1000_DIO_H_
  29
  30 #include "mesubdevice.h"
  31 #include "meslock.h"
  32
  33 #ifdef __KERNEL__
  34
  35 /**
  36  * @brief The ME-1000 DIO subdevice class.
  37  */
  38 typedef struct me1000_dio_subdevice {
  39         /* Inheritance */
  40         me_subdevice_t base;                    /**< The subdevice base class. */
  41
  42         /* Attributes */
  43 //      uint32_t magic;                                 /**< The magic number unique for this structure. */
  44
  45         spinlock_t subdevice_lock;              /**< Spin lock to protect the subdevice from concurrent access. */
  46         spinlock_t *ctrl_reg_lock;              /**< Spin lock to protect #ctrl_reg and #ctrl_reg_mirror from concurrent access. */
  47         int dio_idx;                                    /**< The index of the DIO port on the device. */
  48
  49         unsigned long port_reg;                 /**< Register to read or write a value from or to the port respectively. */
  50         unsigned long ctrl_reg;                 /**< Register to configure the DIO modes. */
  51 #ifdef MEDEBUG_DEBUG_REG
  52         unsigned long reg_base;
  53 #endif
  54 } me1000_dio_subdevice_t;
  55
  56 /**
  57  * @brief The constructor to generate a ME-1000 DIO instance.
  58  *
  59  * @param reg_base The register base address of the device as returned by the PCI BIOS.
  60  * @param dio_idx The index of the DIO on the device.
  61  * @param ctrl_reg_lock Pointer to spin lock protecting the control register and from concurrent access.
  62  *
  63  * @return Pointer to new instance on success.\n
  64  * NULL on error.
  65  */
  66 me1000_dio_subdevice_t *me1000_dio_constructor(uint32_t reg_base,
  67                                                unsigned int dio_idx,
  68                                                spinlock_t * ctrl_reg_lock);
  69
  70 #endif
  71 #endif