include/analogy/subdevice.h

Go to the documentation of this file.

#ifndef __ANALOGY_SUBDEVICE__
#define __ANALOGY_SUBDEVICE__

#ifdef __KERNEL__
#include <linux/list.h>
#endif /* __KERNEL__ */

#include <analogy/types.h>
#include <analogy/context.h>
#include <analogy/instruction.h>
#include <analogy/command.h>
#include <analogy/channel_range.h>

/* --- Subdevice flags desc stuff --- */

/* TODO: replace ANALOGY_SUBD_AI with ANALOGY_SUBD_ANALOG
   and ANALOGY_SUBD_INPUT */

/* Subdevice types masks */
#define A4L_SUBD_MASK_READ 0x80000000
#define A4L_SUBD_MASK_WRITE 0x40000000
#define A4L_SUBD_MASK_SPECIAL 0x20000000

#define A4L_SUBD_UNUSED (A4L_SUBD_MASK_SPECIAL|0x1)

#define A4L_SUBD_AI (A4L_SUBD_MASK_READ|0x2)

#define A4L_SUBD_AO (A4L_SUBD_MASK_WRITE|0x4)

#define A4L_SUBD_DI (A4L_SUBD_MASK_READ|0x8)

#define A4L_SUBD_DO (A4L_SUBD_MASK_WRITE|0x10)

#define A4L_SUBD_DIO (A4L_SUBD_MASK_SPECIAL|0x20)

#define A4L_SUBD_COUNTER (A4L_SUBD_MASK_SPECIAL|0x40)

#define A4L_SUBD_TIMER (A4L_SUBD_MASK_SPECIAL|0x80)

#define A4L_SUBD_MEMORY (A4L_SUBD_MASK_SPECIAL|0x100)

#define A4L_SUBD_CALIB (A4L_SUBD_MASK_SPECIAL|0x200)

#define A4L_SUBD_PROC (A4L_SUBD_MASK_SPECIAL|0x400)

#define A4L_SUBD_SERIAL (A4L_SUBD_MASK_SPECIAL|0x800)

#define A4L_SUBD_TYPES (A4L_SUBD_UNUSED |        \
                           A4L_SUBD_AI |         \
                           A4L_SUBD_AO |         \
                           A4L_SUBD_DI |         \
                           A4L_SUBD_DO |         \
                           A4L_SUBD_DIO |        \
                           A4L_SUBD_COUNTER | \
                           A4L_SUBD_TIMER |      \
                           A4L_SUBD_MEMORY |     \
                           A4L_SUBD_CALIB |      \
                           A4L_SUBD_PROC |       \
                           A4L_SUBD_SERIAL)

/* Subdevice capabilities */
#define A4L_SUBD_CMD 0x1000

#define A4L_SUBD_MMAP 0x8000

/* Subdevice status flag(s) */
#define A4L_SUBD_BUSY_NR 0
#define A4L_SUBD_BUSY (1 << A4L_SUBD_BUSY_NR)

#define A4L_SUBD_CLEAN_NR 1
#define A4L_SUBD_CLEAN (1 << A4L_SUBD_CLEAN_NR)


#ifdef __KERNEL__

/* --- Subdevice descriptor structure --- */

struct a4l_device;
struct a4l_buffer;

struct a4l_subdevice {

        struct list_head list;
        struct a4l_device *dev;
        unsigned int idx;
        struct a4l_buffer *buf;
        /* Subdevice's status (busy, linked?) */
        unsigned long status;
        /* Descriptors stuff */
        unsigned long flags;
        a4l_chdesc_t *chan_desc;
        a4l_rngdesc_t *rng_desc;
        a4l_cmd_t *cmd_mask;
        /* Functions stuff */
        int (*insn_read) (struct a4l_subdevice *, a4l_kinsn_t *);
        int (*insn_write) (struct a4l_subdevice *, a4l_kinsn_t *);
        int (*insn_bits) (struct a4l_subdevice *, a4l_kinsn_t *);
        int (*insn_config) (struct a4l_subdevice *, a4l_kinsn_t *);
        int (*do_cmd) (struct a4l_subdevice *, a4l_cmd_t *);
        int (*do_cmdtest) (struct a4l_subdevice *, a4l_cmd_t *);
        int (*cancel) (struct a4l_subdevice *);
        void (*munge) (struct a4l_subdevice *, void *, unsigned long);
        int (*trigger) (struct a4l_subdevice *, lsampl_t);
        char priv[0];
};
typedef struct a4l_subdevice a4l_subd_t;

#endif /* __KERNEL__ */

#ifndef DOXYGEN_CPP

/* --- Subdevice related IOCTL arguments structures --- */

/* SUDBINFO IOCTL argument */
struct a4l_subd_info {
        unsigned long flags;
        unsigned long status;
        unsigned char nb_chan;
};
typedef struct a4l_subd_info a4l_sbinfo_t;

/* CHANINFO / NBCHANINFO IOCTL arguments */
struct a4l_chan_info {
        unsigned long chan_flags;
        unsigned char nb_rng;
        unsigned char nb_bits;
};
typedef struct a4l_chan_info a4l_chinfo_t;

struct a4l_chinfo_arg {
        unsigned int idx_subd;
        void *info;
};
typedef struct a4l_chinfo_arg a4l_chinfo_arg_t;

/* RNGINFO / NBRNGINFO IOCTL arguments */
struct a4l_rng_info {
        long min;
        long max;
        unsigned long flags;
};
typedef struct a4l_rng_info a4l_rnginfo_t;

struct a4l_rng_info_arg {
        unsigned int idx_subd;
        unsigned int idx_chan;
        void *info;
};
typedef struct a4l_rng_info_arg a4l_rnginfo_arg_t;

#ifdef __KERNEL__

/* --- Subdevice related functions and macros --- */

a4l_chan_t *a4l_get_chfeat(a4l_subd_t * sb, int idx);
a4l_rng_t *a4l_get_rngfeat(a4l_subd_t * sb, int chidx, int rngidx);
int a4l_check_chanlist(a4l_subd_t * subd,
                       unsigned char nb_chan, unsigned int *chans);

#define a4l_subd_is_input(x) ((A4L_SUBD_MASK_READ & (x)->flags) != 0)
/* The following macro considers that a DIO subdevice is firstly an
   output subdevice */
#define a4l_subd_is_output(x) \
        ((A4L_SUBD_MASK_WRITE & (x)->flags) != 0 || \
         (A4L_SUBD_DIO & (x)->flags) != 0)

/* --- Upper layer functions --- */

a4l_subd_t * a4l_get_subd(struct a4l_device *dev, int idx);
a4l_subd_t * a4l_alloc_subd(int sizeof_priv,
                            void (*setup)(a4l_subd_t *));
int a4l_add_subd(struct a4l_device *dev, a4l_subd_t * subd);
int a4l_ioctl_subdinfo(a4l_cxt_t * cxt, void *arg);
int a4l_ioctl_chaninfo(a4l_cxt_t * cxt, void *arg);
int a4l_ioctl_rnginfo(a4l_cxt_t * cxt, void *arg);
int a4l_ioctl_nbchaninfo(a4l_cxt_t * cxt, void *arg);
int a4l_ioctl_nbrnginfo(a4l_cxt_t * cxt, void *arg);

#endif /* __KERNEL__ */

#endif /* !DOXYGEN_CPP */

#endif /* __ANALOGY_SUBDEVICE__ */