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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/**
* @file me4600_ao.h
*
* @brief Meilhaus ME-4000 analog output subdevice class.
* @note Copyright (C) 2007 Meilhaus Electronic GmbH (support@meilhaus.de)
* @author Guenter Gebhardt
*/
/*
* Copyright (C) 2007 Meilhaus Electronic GmbH (support@meilhaus.de)
*
* This file is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef _ME4600_AO_H_
# define _ME4600_AO_H_
# include <linux/version.h>
# include "mesubdevice.h"
# include "mecirc_buf.h"
# include "meioctl.h"
# ifdef __KERNEL__
# ifdef BOSCH
# undef ME_SYNAPSE
# ifndef _CBUFF_32b_t
# define _CBUFF_32b_t
# endif //_CBUFF_32b_t
# endif //BOSCH
# define ME4600_AO_MAX_SUBDEVICES 4
# define ME4600_AO_FIFO_COUNT 4096
# define ME4600_AO_BASE_FREQUENCY 33000000LL
# define ME4600_AO_MIN_ACQ_TICKS 0LL
# define ME4600_AO_MAX_ACQ_TICKS 0LL
# define ME4600_AO_MIN_CHAN_TICKS 66LL
# define ME4600_AO_MAX_CHAN_TICKS 0xFFFFFFFFLL
# define ME4600_AO_MIN_RANGE -10000000
# define ME4600_AO_MAX_RANGE 9999694
# define ME4600_AO_MAX_DATA 0xFFFF
# ifdef ME_SYNAPSE
# define ME4600_AO_CIRC_BUF_SIZE_ORDER 8 // 2^n PAGES =>> Maximum value of 1MB for Synapse
# else
# define ME4600_AO_CIRC_BUF_SIZE_ORDER 5 // 2^n PAGES =>> 128KB
# endif
# define ME4600_AO_CIRC_BUF_SIZE PAGE_SIZE<<ME4600_AO_CIRC_BUF_SIZE_ORDER // Buffer size in bytes.
# ifdef _CBUFF_32b_t
# define ME4600_AO_CIRC_BUF_COUNT ((ME4600_AO_CIRC_BUF_SIZE) / sizeof(uint32_t)) // Size in values
# else
# define ME4600_AO_CIRC_BUF_COUNT ((ME4600_AO_CIRC_BUF_SIZE) / sizeof(uint16_t)) // Size in values
# endif
# define ME4600_AO_CONTINOUS 0x0
# define ME4600_AO_WRAP_MODE 0x1
# define ME4600_AO_HW_MODE 0x2
# define ME4600_AO_HW_WRAP_MODE (ME4600_AO_WRAP_MODE | ME4600_AO_HW_MODE)
# define ME4600_AO_SW_WRAP_MODE ME4600_AO_WRAP_MODE
# define ME4600_AO_INF_STOP_MODE 0x0
# define ME4600_AO_ACQ_STOP_MODE 0x1
# define ME4600_AO_SCAN_STOP_MODE 0x2
# ifdef BOSCH //SPECIAL BUILD FOR BOSCH
/* Bits for flags attribute. */
# define ME4600_AO_FLAGS_BROKEN_PIPE 0x1
# define ME4600_AO_FLAGS_SW_WRAP_MODE_0 0x2
# define ME4600_AO_FLAGS_SW_WRAP_MODE_1 0x4
# define ME4600_AO_FLAGS_SW_WRAP_MODE_MASK (ME4600_AO_FLAGS_SW_WRAP_MODE_0 | ME4600_AO_FLAGS_SW_WRAP_MODE_1)
# define ME4600_AO_FLAGS_SW_WRAP_MODE_NONE 0x0
# define ME4600_AO_FLAGS_SW_WRAP_MODE_INF 0x2
# define ME4600_AO_FLAGS_SW_WRAP_MODE_FIN 0x4
/**
* @brief The ME-4000 analog output subdevice class.
*/
typedef struct me4600_ao_subdevice {
/* Inheritance */
me_subdevice_t base; /**< The subdevice base class. */
/* Attributes */
spinlock_t subdevice_lock; /**< Spin lock to protect the subdevice from concurrent access. */
spinlock_t *preload_reg_lock; /**< Spin lock to protect #preload_reg from concurrent access. */
uint32_t *preload_flags;
unsigned int irq; /**< The interrupt request number assigned by the PCI BIOS. */
me_circ_buf_t circ_buf; /**< Circular buffer holding measurment data. */
wait_queue_head_t wait_queue; /**< Wait queue to put on tasks waiting for data to arrive. */
int single_value; /**< Mirror of the value written in single mode. */
int volatile flags; /**< Flags used for storing SW wraparound setup and error signalling from ISR. */
unsigned int wrap_count; /**< The user defined wraparound cycle count. */
unsigned int wrap_remaining; /**< The wraparound cycle down counter used by a running conversion. */
unsigned int ao_idx; /**< The index of this analog output on this device. */
int fifo; /**< If set this device has a FIFO. */
int bosch_fw; /**< If set the bosch firmware is in PROM. */
/* Registers */
uint32_t ctrl_reg;
uint32_t status_reg;
uint32_t fifo_reg;
uint32_t single_reg;
uint32_t timer_reg;
uint32_t irq_status_reg;
uint32_t preload_reg;
uint32_t reg_base;
} me4600_ao_subdevice_t;
/**
* @brief The constructor to generate a ME-4000 analog output subdevice instance for BOSCH project.
*
* @param reg_base The register base address of the device as returned by the PCI BIOS.
* @param ctrl_reg_lock Pointer to spin lock protecting the control register from concurrent access.
* @param preload_flags Pointer to spin lock protecting the hold&trigger register from concurrent access.
* @param ao_idx Subdevice number.
* @param fifo Flag set if subdevice has hardware FIFO.
* @param irq IRQ number.
*
* @return Pointer to new instance on success.\n
* NULL on error.
*/
me4600_ao_subdevice_t *me4600_ao_constructor(uint32_t reg_base,
spinlock_t * preload_reg_lock,
uint32_t * preload_flags,
int ao_idx, int fifo, int irq);
# else //~BOSCH
//ME4600_AO_FLAGS_BROKEN_PIPE is OBSOLETE => Now problems are reported in status.
typedef enum ME4600_AO_STATUS {
ao_status_none = 0,
ao_status_single_configured,
ao_status_single_run_wait,
ao_status_single_run,
ao_status_single_end_wait,
ao_status_single_end,
ao_status_stream_configured,
ao_status_stream_run_wait,
ao_status_stream_run,
ao_status_stream_end_wait,
ao_status_stream_end,
ao_status_stream_fifo_error,
ao_status_stream_buffer_error,
ao_status_stream_error,
ao_status_last
} ME4600_AO_STATUS;
typedef struct me4600_ao_timeout {
unsigned long start_time;
unsigned long delay;
} me4600_ao_timeout_t;
/**
* @brief The ME-4600 analog output subdevice class.
*/
typedef struct me4600_ao_subdevice {
/* Inheritance */
me_subdevice_t base; /**< The subdevice base class. */
unsigned int ao_idx; /**< The index of this analog output on this device. */
/* Attributes */
spinlock_t subdevice_lock; /**< Spin lock to protect the subdevice from concurrent access. */
spinlock_t *preload_reg_lock; /**< Spin lock to protect preload_reg from concurrent access. */
uint32_t *preload_flags;
/* Hardware feautres */
unsigned int irq; /**< The interrupt request number assigned by the PCI BIOS. */
int fifo; /**< If set this device has a FIFO. */
int bitpattern; /**< If set this device use bitpattern. */
int single_value; /**< Mirror of the output value in single mode. */
int single_value_in_fifo; /**< Mirror of the value written in single mode. */
uint32_t ctrl_trg; /**< Mirror of the trigger settings. */
volatile int mode; /**< Flags used for storing SW wraparound setup*/
int stop_mode; /**< The user defined stop condition flag. */
unsigned int start_mode;
unsigned int stop_count; /**< The user defined dates presentation end count. */
unsigned int stop_data_count; /**< The stop presentation count. */
unsigned int data_count; /**< The real presentation count. */
unsigned int preloaded_count; /**< The next data addres in buffer. <= for wraparound mode. */
int hardware_stop_delay; /**< The time that stop can take. This is only to not show hardware bug to user. */
volatile enum ME4600_AO_STATUS status; /**< The current stream status flag. */
me4600_ao_timeout_t timeout; /**< The timeout for start in blocking and non-blocking mode. */
/* Registers *//**< All registers are 32 bits long. */
unsigned long ctrl_reg;
unsigned long status_reg;
unsigned long fifo_reg;
unsigned long single_reg;
unsigned long timer_reg;
unsigned long irq_status_reg;
unsigned long preload_reg;
unsigned long reg_base;
/* Software buffer */
me_circ_buf_t circ_buf; /**< Circular buffer holding measurment data. 32 bit long */
wait_queue_head_t wait_queue; /**< Wait queue to put on tasks waiting for data to arrive. */
struct workqueue_struct *me4600_workqueue;
#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,20)
struct work_struct ao_control_task;
#else
struct delayed_work ao_control_task;
#endif
volatile int ao_control_task_flag; /**< Flag controling reexecuting of control task */
} me4600_ao_subdevice_t;
/**
* @brief The constructor to generate a ME-4600 analog output subdevice instance.
*
* @param reg_base The register base address of the device as returned by the PCI BIOS.
* @param ctrl_reg_lock Pointer to spin lock protecting the control register from concurrent access.
* @param preload_flags Pointer to spin lock protecting the hold&trigger register from concurrent access.
* @param ao_idx Subdevice number.
* @param fifo Flag set if subdevice has hardware FIFO.
* @param irq IRQ number.
* @param me4600_wq Queue for asynchronous task (1 queue for all subdevice on 1 board).
*
* @return Pointer to new instance on success.\n
* NULL on error.
*/
me4600_ao_subdevice_t *me4600_ao_constructor(uint32_t reg_base,
spinlock_t * preload_reg_lock,
uint32_t * preload_flags,
int ao_idx,
int fifo,
int irq,
struct workqueue_struct
*me4600_wq);
# endif //BOSCH
# endif //__KERNEL__
#endif // ~_ME4600_AO_H_
|
