1 /** 2 * @file me6000_ao.h 3 * 4 * @brief Meilhaus ME-6000 analog 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 _ME6000_AO_H_ 28 #define _ME6000_AO_H_ 29 30 #include <linux/version.h> 31 #include "mesubdevice.h" 32 #include "mecirc_buf.h" 33 #include "meioctl.h" 34 35 #ifdef __KERNEL__ 36 37 #define ME6000_AO_MAX_SUBDEVICES 16 38 #define ME6000_AO_FIFO_COUNT 8192 39 40 #define ME6000_AO_BASE_FREQUENCY 33000000L 41 42 #define ME6000_AO_MIN_ACQ_TICKS 0LL 43 #define ME6000_AO_MAX_ACQ_TICKS 0LL 44 45 #define ME6000_AO_MIN_CHAN_TICKS 66LL 46 #define ME6000_AO_MAX_CHAN_TICKS 0xFFFFFFFFLL 47 48 #define ME6000_AO_MIN_RANGE -10000000 49 #define ME6000_AO_MAX_RANGE 9999694 50 51 #define ME6000_AO_MIN_RANGE_HIGH 0 52 #define ME6000_AO_MAX_RANGE_HIGH 49999237 53 54 #define ME6000_AO_MAX_DATA 0xFFFF 55 56 #ifdef ME_SYNAPSE 57 # define ME6000_AO_CIRC_BUF_SIZE_ORDER 8 // 2^n PAGES =>> Maximum value of 1MB for Synapse 58 #else 59 # define ME6000_AO_CIRC_BUF_SIZE_ORDER 5 // 2^n PAGES =>> 128KB 60 #endif 61 #define ME6000_AO_CIRC_BUF_SIZE PAGE_SIZE<<ME6000_AO_CIRC_BUF_SIZE_ORDER // Buffer size in bytes. 62 63 # ifdef _CBUFF_32b_t 64 # define ME6000_AO_CIRC_BUF_COUNT ((ME6000_AO_CIRC_BUF_SIZE) / sizeof(uint32_t)) // Size in values 65 # else 66 # define ME6000_AO_CIRC_BUF_COUNT ((ME6000_AO_CIRC_BUF_SIZE) / sizeof(uint16_t)) // Size in values 67 # endif 68 69 # define ME6000_AO_CONTINOUS 0x0 70 # define ME6000_AO_WRAP_MODE 0x1 71 # define ME6000_AO_HW_MODE 0x2 72 73 # define ME6000_AO_HW_WRAP_MODE (ME6000_AO_WRAP_MODE | ME6000_AO_HW_MODE) 74 # define ME6000_AO_SW_WRAP_MODE ME6000_AO_WRAP_MODE 75 76 # define ME6000_AO_INF_STOP_MODE 0x0 77 # define ME6000_AO_ACQ_STOP_MODE 0x1 78 # define ME6000_AO_SCAN_STOP_MODE 0x2 79 80 # define ME6000_AO_EXTRA_HARDWARE 0x1 81 # define ME6000_AO_HAS_FIFO 0x2 82 83 typedef enum ME6000_AO_STATUS { 84 ao_status_none = 0, 85 ao_status_single_configured, 86 ao_status_single_run_wait, 87 ao_status_single_run, 88 ao_status_single_end_wait, 89 ao_status_single_end, 90 ao_status_stream_configured, 91 ao_status_stream_run_wait, 92 ao_status_stream_run, 93 ao_status_stream_end_wait, 94 ao_status_stream_end, 95 ao_status_stream_fifo_error, 96 ao_status_stream_buffer_error, 97 ao_status_stream_error, 98 ao_status_last 99 } ME6000_AO_STATUS; 100 101 typedef struct me6000_ao_timeout { 102 unsigned long start_time; 103 unsigned long delay; 104 } me6000_ao_timeout_t; 105 106 /** 107 * @brief The ME-6000 analog output subdevice class. 108 */ 109 typedef struct me6000_ao_subdevice { 110 /* Inheritance */ 111 me_subdevice_t base; /**< The subdevice base class. */ 112 unsigned int ao_idx; 113 114 /* Attributes */ 115 spinlock_t subdevice_lock; /**< Spin lock to protect the subdevice from concurrent access. */ 116 spinlock_t *preload_reg_lock; /**< Spin lock to protect preload_reg from concurrent access. */ 117 118 uint32_t *preload_flags; 119 uint32_t *triggering_flags; 120 121 /* Hardware feautres */ 122 unsigned int irq; /**< The interrupt request number assigned by the PCI BIOS. */ 123 int fifo; /**< If set this device has a FIFO. */ 124 125 //Range 126 int min; 127 int max; 128 129 int single_value; /**< Mirror of the output value in single mode. */ 130 int single_value_in_fifo; /**< Mirror of the value written in single mode. */ 131 uint32_t ctrl_trg; /**< Mirror of the trigger settings. */ 132 133 volatile int mode; /**< Flags used for storing SW wraparound setup*/ 134 int stop_mode; /**< The user defined stop condition flag. */ 135 unsigned int start_mode; 136 unsigned int stop_count; /**< The user defined dates presentation end count. */ 137 unsigned int stop_data_count; /**< The stop presentation count. */ 138 unsigned int data_count; /**< The real presentation count. */ 139 unsigned int preloaded_count; /**< The next data addres in buffer. <= for wraparound mode. */ 140 int hardware_stop_delay; /**< The time that stop can take. This is only to not show hardware bug to user. */ 141 142 volatile enum ME6000_AO_STATUS status; /**< The current stream status flag. */ 143 me6000_ao_timeout_t timeout; /**< The timeout for start in blocking and non-blocking mode. */ 144 145 /* Registers *//**< All registers are 32 bits long. */ 146 unsigned long ctrl_reg; 147 unsigned long status_reg; 148 unsigned long fifo_reg; 149 unsigned long single_reg; 150 unsigned long timer_reg; 151 unsigned long irq_status_reg; 152 unsigned long preload_reg; 153 unsigned long irq_reset_reg; 154 #ifdef MEDEBUG_DEBUG_REG 155 unsigned long reg_base; 156 #endif 157 158 /* Software buffer */ 159 me_circ_buf_t circ_buf; /**< Circular buffer holding measurment data. */ 160 wait_queue_head_t wait_queue; /**< Wait queue to put on tasks waiting for data to arrive. */ 161 162 struct workqueue_struct *me6000_workqueue; 163 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,20) 164 struct work_struct ao_control_task; 165 #else 166 struct delayed_work ao_control_task; 167 #endif 168 169 volatile int ao_control_task_flag; /**< Flag controling reexecuting of control task */ 170 171 } me6000_ao_subdevice_t; 172 173 /** 174 * @brief The constructor to generate a ME-6000 analog output subdevice instance. 175 * 176 * @param reg_base The register base address of the device as returned by the PCI BIOS. 177 * @param ctrl_reg_lock Pointer to spin lock protecting the control register from concurrent access. 178 * @param preload_flags Pointer to spin lock protecting the hold&trigger register from concurrent access. 179 * @param ao_idx Subdevice number. 180 * @param fifo Flag set if subdevice has hardware FIFO. 181 * @param irq IRQ number. 182 * @param high_range Flag set if subdevice has high curren output. 183 * @param me6000_wq Queue for asynchronous task (1 queue for all subdevice on 1 board). 184 * 185 * @return Pointer to new instance on success.\n 186 * NULL on error. 187 */ 188 me6000_ao_subdevice_t *me6000_ao_constructor(uint32_t reg_base, 189 spinlock_t * preload_reg_lock, 190 uint32_t * preload_flags, 191 uint32_t * triggering_flags, 192 int ao_idx, 193 int fifo, 194 int irq, 195 int high_range, 196 struct workqueue_struct 197 *me6000_wq); 198 199 #endif //__KERNEL__ 200 #endif //_ME6000_AO_H_ 201