Staging: Add the Meilhaus ME-IDS driver package
[safe/jmp/linux-2.6] / drivers / staging / meilhaus / mesubdevice.h
diff --git a/drivers/staging/meilhaus/mesubdevice.h b/drivers/staging/meilhaus/mesubdevice.h
new file mode 100644 (file)
index 0000000..19ec2b5
--- /dev/null
@@ -0,0 +1,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