blob: 13e8a8b94cfa2651390663548584d76dd50bc15d [file] [log] [blame]
David Kiliani3fedd142008-11-01 00:39:12 +01001/**
2 * @file me0900_do.h
3 *
4 * @brief ME-9x 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 _ME0900_DO_H_
28#define _ME0900_DO_H_
29
30#include "mesubdevice.h"
31
32#ifdef __KERNEL__
33
34/**
35 * @brief The template subdevice class.
36 */
37typedef struct me0900_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
44 unsigned int do_idx;
45
46 unsigned long ctrl_reg;
47 unsigned long port_reg;
48 unsigned long enable_reg;
49 unsigned long disable_reg;
50#ifdef MEDEBUG_DEBUG_REG
51 unsigned long reg_base;
52#endif
53} me0900_do_subdevice_t;
54
55/**
56 * @brief The constructor to generate a ME-9x digital output subdevice instance.
57 *
58 * @param reg_base The register base address of the device as returned by the PCI BIOS.
59 * @param do_idx The index of the digital output subdevice on this device.
60 *
61 * @return Pointer to new instance on success.\n
62 * NULL on error.
63 */
64me0900_do_subdevice_t *me0900_do_constructor(uint32_t reg_base,
65 unsigned int do_idx);
66
67#endif
68#endif