aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/staging/meilhaus/mesubdevice.h
blob: 19ec2b5d96f03328c6eeeeac7a624d960ee1e89b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/**
 * @file mesubdevice.h
 *
 * @brief Provides the subdevice base class.
 * @note Copyright (C) 2007 Meilhaus Electronic GmbH (support@meilhaus.de)
 * @author Guenter Gebhardt
 */

#ifndef _MESUBDEVICE_H_
#define _MESUBDEVICE_H_

#include <linux/list.h>

#include "metypes.h"
#include "meioctl.h"
#include "meslock.h"

# include <linux/workqueue.h>

#ifdef __KERNEL__

/**
 * @brief Macro used to enter a subdevice.
 */
#define ME_SUBDEVICE_ENTER	\
{ \
	int err; \
	err = me_slock_enter(&instance->base.lock, filep); \
	if(err){ \
		PERROR("Cannot enter subdevice.\n"); \
		return err; \
	} \
}

/**
 * @brief Macro used to exit a subdevice.
 */
#define ME_SUBDEVICE_EXIT	\
{\
	int err; \
	err = me_slock_exit(&instance->base.lock, filep); \
	if(err){ \
		PERROR("Cannot exit subdevice.\n"); \
		return err; \
	} \
}

/**
 * @brief The subdevice base class.
 */
typedef struct me_subdevice {
	/* Attributes */
	struct list_head list;		/**< Enables the subdevice to be added to a dynamic list. */
	me_slock_t lock;		/**< Used by user application in order to lock the subdevice for exclusive usage. */

	/* Methods */
	int (*me_subdevice_io_irq_start) (struct me_subdevice * subdevice,
					  struct file * filep,
					  int channel,
					  int irq_source,
					  int irq_edge, int irq_arg, int flags);

	int (*me_subdevice_io_irq_wait) (struct me_subdevice * subdevice,
					 struct file * filep,
					 int channel,
					 int *irq_count,
					 int *value, int time_out, int flags);

	int (*me_subdevice_io_irq_stop) (struct me_subdevice * subdevice,
					 struct file * filep,
					 int channel, int flags);

	int (*me_subdevice_io_reset_subdevice) (struct me_subdevice * subdevice,
						struct file * filep, int flags);

	int (*me_subdevice_io_single_config) (struct me_subdevice * subdevice,
					      struct file * filep,
					      int channel,
					      int single_config,
					      int ref,
					      int trig_chan,
					      int trig_type,
					      int trig_edge, int flags);

	int (*me_subdevice_io_single_read) (struct me_subdevice * subdevice,
					    struct file * filep,
					    int channel,
					    int *value,
					    int time_out, int flags);

	int (*me_subdevice_io_single_write) (struct me_subdevice * subdevice,
					     struct file * filep,
					     int channel,
					     int value,
					     int time_out, int flags);

	int (*me_subdevice_io_stream_config) (struct me_subdevice * subdevice,
					      struct file * filep,
					      meIOStreamConfig_t * config_list,
					      int count,
					      meIOStreamTrigger_t * trigger,
					      int fifo_irq_threshold,
					      int flags);

	int (*me_subdevice_io_stream_new_values) (struct me_subdevice *
						  subdevice,
						  struct file * filep,
						  int time_out, int *count,
						  int flags);

	int (*me_subdevice_io_stream_read) (struct me_subdevice * subdevice,
					    struct file * filep,
					    int read_mode,
					    int *values, int *count, int flags);

	int (*me_subdevice_io_stream_start) (struct me_subdevice * subdevice,
					     struct file * filep,
					     int start_mode,
					     int time_out, int flags);

	int (*me_subdevice_io_stream_status) (struct me_subdevice * subdevice,
					      struct file * filep,
					      int wait,
					      int *status,
					      int *count, int flags);

	int (*me_subdevice_io_stream_stop) (struct me_subdevice * subdevice,
					    struct file * filep,
					    int stop_mode, int flags);

	int (*me_subdevice_io_stream_write) (struct me_subdevice * subdevice,
					     struct file * filep,
					     int write_mode,
					     int *values,
					     int *count, int flags);

	int (*me_subdevice_lock_subdevice) (struct me_subdevice * subdevice,
					    struct file * filep,
					    int lock, int flags);

	int (*me_subdevice_query_number_channels) (struct me_subdevice *
						   subdevice, int *number);

	int (*me_subdevice_query_number_ranges) (struct me_subdevice *
						 subdevice, int unit,
						 int *count);

	int (*me_subdevice_query_range_by_min_max) (struct me_subdevice *
						    subdevice, int unit,
						    int *min, int *max,
						    int *maxdata, int *range);

	int (*me_subdevice_query_range_info) (struct me_subdevice * subdevice,
					      int range,
					      int *unit,
					      int *min, int *max, int *maxdata);

	int (*me_subdevice_query_subdevice_type) (struct me_subdevice *
						  subdevice, int *type,
						  int *subtype);

	int (*me_subdevice_query_subdevice_caps) (struct me_subdevice *
						  subdevice, int *caps);

	int (*me_subdevice_query_subdevice_caps_args) (struct me_subdevice *
						       subdevice, int cap,
						       int *args, int count);

	int (*me_subdevice_query_timer) (struct me_subdevice * subdevice,
					 int timer,
					 int *base_frequency,
					 long long *min_ticks,
					 long long *max_ticks);

	int (*me_subdevice_config_load) (struct me_subdevice * subdevice,
					 me_cfg_device_entry_t * config);

	void (*me_subdevice_destructor) (struct me_subdevice * subdevice);
} me_subdevice_t;

/**
 * @brief Initializes a subdevice structure.
 *
 * @param subdevice The subdevice structure to initialize.
 * @return 0 on success.
 */
int me_subdevice_init(me_subdevice_t * subdevice);

/**
 * @brief Deinitializes a subdevice structure.
 *
 * @param subdevice The subdevice structure to initialize.
 */
void me_subdevice_deinit(me_subdevice_t * subdevice);

#endif
#endif