Commit | Line | Data |
---|---|---|
3fedd148 DK |
1 | /** |
2 | * @file me8100_do.h | |
3 | * | |
4 | * @brief ME-8100 digital output 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_DO_H_ | |
28 | #define _ME8100_DO_H_ | |
29 | ||
30 | #include "mesubdevice.h" | |
31 | ||
32 | #ifdef __KERNEL__ | |
33 | ||
34 | /** | |
35 | * @brief The template subdevice class. | |
36 | */ | |
37 | typedef struct me8100_do_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; /**< Spin lock to protect the #ctrl_reg. */ | |
44 | ||
45 | unsigned int do_idx; | |
46 | ||
47 | uint16_t port_reg_mirror; /**< Mirror used to store current port register setting which is write only. */ | |
48 | ||
49 | unsigned long port_reg; /**< Register holding the port status. */ | |
50 | unsigned long ctrl_reg; /**< Control register. */ | |
51 | #ifdef MEDEBUG_DEBUG_REG | |
52 | unsigned long reg_base; | |
53 | #endif | |
54 | } me8100_do_subdevice_t; | |
55 | ||
56 | /** | |
57 | * @brief The constructor to generate a ME-8100 digital output subdevice instance. | |
58 | * | |
59 | * @param reg_base The register base address of the device as returned by the PCI BIOS. | |
60 | * @param do_idx The index of the digital output subdevice on this device. | |
61 | * | |
62 | * @return Pointer to new instance on success.\n | |
63 | * NULL on error. | |
64 | */ | |
65 | me8100_do_subdevice_t *me8100_do_constructor(uint32_t reg_base, | |
66 | unsigned int do_idx, | |
67 | spinlock_t * ctrl_reg_lock); | |
68 | ||
69 | #endif | |
70 | #endif |