Merge branch 'bugzilla-13041' into release
[linux-2.6] / drivers / staging / meilhaus / me8100_di.h
1 /**
2  * @file me8100_di.h
3  *
4  * @brief ME-8100 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 _ME8100_DI_H_
28 #define _ME8100_DI_H_
29
30 #include "mesubdevice.h"
31
32 #ifdef __KERNEL__
33
34 /**
35  * @brief The template subdevice class.
36  */
37 typedef struct me8100_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
45         unsigned di_idx;
46
47         int irq;
48         volatile int rised;
49         unsigned int irq_count;
50
51         uint status_flag;                               /**< Default interupt status flag */
52         uint status_value;                              /**< Interupt status */
53         uint status_value_edges;                /**< Extended interupt status */
54         uint line_value;
55
56         uint16_t compare_value;
57         uint8_t filtering_flag;
58
59         wait_queue_head_t wait_queue;
60
61         unsigned long ctrl_reg;
62         unsigned long port_reg;
63         unsigned long mask_reg;
64         unsigned long pattern_reg;
65         unsigned long long din_int_reg;
66         unsigned long irq_reset_reg;
67         unsigned long irq_status_reg;
68 #ifdef MEDEBUG_DEBUG_REG
69         unsigned long reg_base;
70 #endif
71
72 } me8100_di_subdevice_t;
73
74 /**
75  * @brief The constructor to generate a ME-8100 digital input subdevice instance.
76  *
77  * @param reg_base The register base address of the device as returned by the PCI BIOS.
78  *
79  * @return Pointer to new instance on success.\n
80  * NULL on error.
81  */
82 me8100_di_subdevice_t *me8100_di_constructor(uint32_t me8100_reg_base,
83                                              uint32_t plx_reg_base,
84                                              unsigned int di_idx,
85                                              int irq,
86                                              spinlock_t * ctrl_leg_lock);
87
88 #endif
89 #endif