/home/hillier_g/checkout/most4linux/most-kernel/most-base.h

Go to the documentation of this file.

/*
 *  Copyright(c) Siemens AG, Muenchen, Germany, 2005, 2006, 2007
 *                           Bernhard Walle <bernhard.walle@gmx.de>
 *                           Gernot Hillier <gernot.hillier@siemens.com>
 *
 * ----------------------------------------------------------------------------
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as 
 * published by the Free Software Foundation;
 *
 * 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.
 * ----------------------------------------------------------------------------
 */
#ifdef HAVE_CONFIG_H
#include "config/config.h"
#endif
#ifndef MOST_BASE
#define MOST_BASE

#ifdef __KERNEL__

#include <linux/interrupt.h>
#include <linux/spinlock.h>
#include <linux/seq_file.h>

#ifdef RT_RTDM
#   include <rtdm/rtdm_driver.h>
#endif

#include "most-common.h"
#include "most-constants.h" 


/*
 * Forward declarations -------------------------------------------------------
 */
struct most_dev;

/*
 * Typedefs -------------------------------------------------------------------
 */

typedef u32 (*readreg_func) (struct most_dev* dev, u32 addr);

typedef void (*writereg_func) (struct most_dev* dev, u32 val, u32 addr);

typedef void (*changereg_func) (struct most_dev     *dev, 
                                u32                 address, 
                                u32                 value, 
                                u32                 mask);

typedef int (*read_os8104_func) (struct most_dev*   dev,
                                 unsigned char      *dest, 
                                 size_t             len, 
                                 u32                addr);

typedef int (*write_os8104_func) (struct most_dev*  dev,
                                  unsigned char     *src,
                                  size_t            len,
                                  u32               addr);

typedef void (*intset_func) (struct most_dev      *dev,
                             unsigned int         interrupts, 
                             unsigned int         mask,
                             unsigned int         *oldmask);

typedef void (*intclear_func) (struct most_dev    *dev,
                               unsigned int        interrupts);

typedef void (*reset_func) (struct most_dev *dev);

struct dma_buffer 
{
    dma_addr_t      addr_bus;           
    void            *addr_virt;         
    unsigned int    size;               
};

typedef int (*dma_alloc_fun) (struct most_dev *dev, struct dma_buffer *buf);

typedef void (*dma_dealloc_fun) (struct most_dev *dev, struct dma_buffer *buf);

typedef int (*probe_func)(struct most_dev *dev);

typedef int (*remove_func)(struct most_dev *dev);

typedef void (*irq_func)(struct most_dev *dev, unsigned int intstatus);

typedef void (*proc_show_func)(struct seq_file *file);

typedef int (*feature_fun)(struct most_dev *dev);

typedef void (*usage_fun)(struct most_dev *dev, int change);

/*
 * Types ----------------------------------------------------------------------
 */

struct most_ops {
    readreg_func       readreg;        
    writereg_func      writereg;       
    changereg_func     changereg;      
    read_os8104_func   readreg8104;    
    write_os8104_func  writereg8104;   
    intset_func        intset;         
    intclear_func      intclear;       
    reset_func         reset;          
    dma_alloc_fun      dma_allocate;   
    dma_dealloc_fun    dma_deallocate; 
    feature_fun        features;       
};

struct most_ops_rt {
    readreg_func       readreg;        
    writereg_func      writereg;       
};


struct most_dev {
    spinlock_t         lock;           
    struct list_head   list;           
    int                major_device_no;
    int                card_number;    
    char               name[20];       
    u64                serial_number;  
    unsigned char      product_id;     
    void               *impl;          
    usage_fun          manage_usage;   
    struct most_ops    ops;            
#ifdef RT_RTDM
    struct most_ops_rt rt_ops;         
#endif
};

#define most_readreg(dev, addr)                             \
    (dev)->ops.readreg((dev), addr)

#define most_writereg(dev, value, addr)                     \
    (dev)->ops.writereg((dev), (value), (addr))

#define most_changereg(dev, addr, value, mask)              \
    (dev)->ops.changereg((dev), (addr), (value), (mask))

#define most_readreg8104(dev, dest, len, addr)              \
    (dev)->ops.readreg8104((dev), (dest), (len), (addr))

#define most_writereg8104(dev, src, len, addr)              \
    (dev)->ops.writereg8104((dev), (src), (len), (addr))

#define most_intset(dev, interrupts, mask, oldmask)         \
    (dev)->ops.intset((dev), (interrupts), (mask), (oldmask))

#define most_intclear(dev, interrupts)                      \
    (dev)->ops.intclear((dev), (interrupts))

#define most_dma_allocate(dev, dma_buffer)                  \
    (dev)->ops.dma_allocate(dev, dma_buffer)

#define most_dma_deallocate(dev, dma_buffer)                \
    (dev)->ops.dma_deallocate(dev, dma_buffer)

#define most_reset(dev)                                     \
    (dev)->ops.reset((dev))

#define most_features(dev)                                  \
    (dev)->ops.features(dev)

#define most_readreg_rt(dev, addr)                          \
    (dev)->rt_ops.readreg((dev), addr)

#define most_writereg_rt(dev, value, addr)                  \
    (dev)->rt_ops.writereg((dev), (value), (addr))

#define most_manage_usage(dev, change)                      \
    (dev)->manage_usage((dev), (change))

#define MOST_DEV_MAJOR(most_device)                 \
        ((most_device)->major_device_no)

#define MOST_DEV_CARDNUMBER(most_device)            \
        ((most_device)->card_number)


struct most_high_driver {
    const char         *name;          
    struct list_head   sema_list;      
    struct list_head   spin_list;      
    probe_func         probe;          
    remove_func        remove;         
    u8                 interrupt_mask; 
    irq_func           int_handler;    
};

struct most_low_driver {
    const char*      name;             
    struct list_head list;             
    void (*high_driver_registered)(struct most_high_driver *high_drv);
    void (*high_driver_deregistered)(struct most_high_driver *high_drv);
    proc_show_func   proc_show;        
};

/*
 * Function prototypes * ------------------------------------------------------
 */

int most_register_high_driver(struct most_high_driver *driver);

void most_deregister_high_driver(struct most_high_driver *driver);

void most_register_low_driver(struct most_low_driver *low_driver);

void most_deregister_low_driver(struct most_low_driver *low_driver);

struct most_dev *most_dev_new(void);

void most_dev_free(struct most_dev* dev);

extern struct rwsema_locked_list most_base_low_drivers;

extern struct rwsema_locked_list most_base_high_drivers_sema;

extern struct spin_locked_list most_base_high_drivers_spin;


#endif /* __KERNEL__ */
#endif /* MOST_BASE */

/* vim: set ts=4 et sw=4: */

---