blob: 2ce7dcab8b3933c9d3f88d4da23305eacb0e248d [file] [log] [blame]
David Kiliani3fedd142008-11-01 00:39:12 +01001/**
2 * @file me0600_relay.h
3 *
4 * @brief ME-630 relay 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 _ME0600_RELAY_H_
28#define _ME0600_RELAY_H_
29
30#include "mesubdevice.h"
31
32#ifdef __KERNEL__
33
34/**
35 * @brief The template subdevice class.
36 */
37typedef struct me0600_relay_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 long port_0_reg; /**< Register holding the port status. */
45 unsigned long port_1_reg; /**< Register holding the port status. */
46#ifdef MEDEBUG_DEBUG_REG
47 unsigned long reg_base;
48#endif
49} me0600_relay_subdevice_t;
50
51/**
52 * @brief The constructor to generate a ME-630 relay subdevice instance.
53 *
54 * @param reg_base The register base address of the device as returned by the PCI BIOS.
55 * @param ctrl_reg_lock Spin lock protecting the control register.
56 *
57 * @return Pointer to new instance on success.\n
58 * NULL on error.
59 */
60me0600_relay_subdevice_t *me0600_relay_constructor(uint32_t reg_base);
61
62#endif
63#endif