Subversion Repositories shark

/*

 * Linux Plug and Play Support

 * Copyright by Adam Belay <ambx1@neo.rr.com>

 *

 */

#ifndef _LINUX_PNP_H

#define _LINUX_PNP_H

#ifdef __KERNEL__

#include <linux/device.h>

#include <linux/list.h>

#include <linux/errno.h>

#define PNP_MAX_PORT            8

#define PNP_MAX_MEM             4

#define PNP_MAX_IRQ             2

#define PNP_MAX_DMA             2

#define PNP_MAX_DEVICES         8

#define PNP_ID_LEN              8

#define PNP_NAME_LEN            50

struct pnp_protocol;

struct pnp_dev;

/*

 * Resource Management

 */

/* Use these instead of directly reading pnp_dev to get resource information */

#define pnp_port_start(dev,bar)   ((dev)->res.port_resource[(bar)].start)

#define pnp_port_end(dev,bar)     ((dev)->res.port_resource[(bar)].end)

#define pnp_port_flags(dev,bar)   ((dev)->res.port_resource[(bar)].flags)

#define pnp_port_valid(dev,bar)   (pnp_port_flags((dev),(bar)) & IORESOURCE_IO)

#define pnp_port_len(dev,bar) \

        ((pnp_port_start((dev),(bar)) == 0 &&   \

          pnp_port_end((dev),(bar)) ==          \

          pnp_port_start((dev),(bar))) ? 0 :    \

                                                \

         (pnp_port_end((dev),(bar)) -           \

          pnp_port_start((dev),(bar)) + 1))

#define pnp_mem_start(dev,bar)   ((dev)->res.mem_resource[(bar)].start)

#define pnp_mem_end(dev,bar)     ((dev)->res.mem_resource[(bar)].end)

#define pnp_mem_flags(dev,bar)   ((dev)->res.mem_resource[(bar)].flags)

#define pnp_mem_valid(dev,bar)   (pnp_mem_flags((dev),(bar)) & IORESOURCE_MEM)

#define pnp_mem_len(dev,bar) \

        ((pnp_mem_start((dev),(bar)) == 0 &&    \

          pnp_mem_end((dev),(bar)) ==           \

          pnp_mem_start((dev),(bar))) ? 0 :     \

                                                \

         (pnp_mem_end((dev),(bar)) -            \

          pnp_mem_start((dev),(bar)) + 1))

#define pnp_irq(dev,bar)         ((dev)->res.irq_resource[(bar)].start)

#define pnp_irq_flags(dev,bar)   ((dev)->res.irq_resource[(bar)].flags)

#define pnp_irq_valid(dev,bar)   (pnp_irq_flags((dev),(bar)) & IORESOURCE_IRQ)

#define pnp_dma(dev,bar)         ((dev)->res.dma_resource[(bar)].start)

#define pnp_dma_flags(dev,bar)   ((dev)->res.dma_resource[(bar)].flags)

#define pnp_dma_valid(dev,bar)   (pnp_dma_flags((dev),(bar)) & IORESOURCE_DMA)

#define PNP_PORT_FLAG_16BITADDR (1<<0)

#define PNP_PORT_FLAG_FIXED     (1<<1)

struct pnp_port {

        unsigned short min;             /* min base number */

        unsigned short max;             /* max base number */

        unsigned char align;            /* align boundary */

        unsigned char size;             /* size of range */

        unsigned char flags;            /* port flags */

        unsigned char pad;              /* pad */

        struct pnp_port *next;          /* next port */

};

struct pnp_irq {

        unsigned short map;             /* bitmaks for IRQ lines */

        unsigned char flags;            /* IRQ flags */

        unsigned char pad;              /* pad */

        struct pnp_irq *next;           /* next IRQ */

};

struct pnp_dma {

        unsigned char map;              /* bitmask for DMA channels */

        unsigned char flags;            /* DMA flags */

        struct pnp_dma *next;           /* next port */

};

struct pnp_mem {

        unsigned int min;               /* min base number */

        unsigned int max;               /* max base number */

        unsigned int align;             /* align boundary */

        unsigned int size;              /* size of range */

        unsigned char flags;            /* memory flags */

        unsigned char pad;              /* pad */

        struct pnp_mem *next;           /* next memory resource */

};

#define PNP_RES_PRIORITY_PREFERRED      0

#define PNP_RES_PRIORITY_ACCEPTABLE     1

#define PNP_RES_PRIORITY_FUNCTIONAL     2

#define PNP_RES_PRIORITY_INVALID        65535

struct pnp_option {

        unsigned short priority;        /* priority */

        struct pnp_port *port;          /* first port */

        struct pnp_irq *irq;            /* first IRQ */

        struct pnp_dma *dma;            /* first DMA */

        struct pnp_mem *mem;            /* first memory resource */

        struct pnp_option *next;        /* used to chain dependent resources */

};

struct pnp_resource_table {

        struct resource port_resource[PNP_MAX_PORT];

        struct resource mem_resource[PNP_MAX_MEM];

        struct resource dma_resource[PNP_MAX_DMA];

        struct resource irq_resource[PNP_MAX_IRQ];

};

/*

 * Device Managemnt

 */

struct pnp_card {

        struct device dev;              /* Driver Model device interface */

        unsigned char number;           /* used as an index, must be unique */

        struct list_head global_list;   /* node in global list of cards */

        struct list_head protocol_list; /* node in protocol's list of cards */

        struct list_head devices;       /* devices attached to the card */

        struct pnp_protocol * protocol;

        struct pnp_id * id;             /* contains supported EISA IDs*/

        char name[PNP_NAME_LEN];        /* contains a human-readable name */

        unsigned char   pnpver;         /* Plug & Play version */

        unsigned char   productver;     /* product version */

        unsigned int    serial;         /* serial number */

        unsigned char   checksum;       /* if zero - checksum passed */

        struct proc_dir_entry *procdir; /* directory entry in /proc/bus/isapnp */

};

#define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)

#define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)

#define to_pnp_card(n) container_of(n, struct pnp_card, dev)

#define pnp_for_each_card(card) \

        for((card) = global_to_pnp_card(pnp_cards.next); \

        (card) != global_to_pnp_card(&pnp_cards); \

        (card) = global_to_pnp_card((card)->global_list.next))

struct pnp_card_link {

        struct pnp_card * card;

        struct pnp_card_driver * driver;

        void * driver_data;

};

static inline void *pnp_get_card_drvdata (struct pnp_card_link *pcard)

{

        return pcard->driver_data;

}

static inline void pnp_set_card_drvdata (struct pnp_card_link *pcard, void *data)

{

        pcard->driver_data = data;

}

struct pnp_dev {

        struct device dev;              /* Driver Model device interface */

        unsigned char number;           /* used as an index, must be unique */

        int status;

        struct list_head global_list;   /* node in global list of devices */

        struct list_head protocol_list; /* node in list of device's protocol */

        struct list_head card_list;     /* node in card's list of devices */

        struct list_head rdev_list;     /* node in cards list of requested devices */

        struct pnp_protocol * protocol;

        struct pnp_card * card;         /* card the device is attached to, none if NULL */

        struct pnp_driver * driver;

        struct pnp_card_link * card_link;

        struct pnp_id   * id;   /* supported EISA IDs*/

        int active;

        int capabilities;

        struct pnp_option * independent;

        struct pnp_option * dependent;

        struct pnp_resource_table res;

        char name[PNP_NAME_LEN];        /* contains a human-readable name */

        unsigned short  regs;           /* ISAPnP: supported registers */

        int             flags;          /* used by protocols */

        struct proc_dir_entry *procent; /* device entry in /proc/bus/isapnp */

};

#define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)

#define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)

#define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)

#define to_pnp_dev(n) container_of(n, struct pnp_dev, dev)

#define pnp_for_each_dev(dev) \

        for((dev) = global_to_pnp_dev(pnp_global.next); \

        (dev) != global_to_pnp_dev(&pnp_global); \

        (dev) = global_to_pnp_dev((dev)->global_list.next))

#define card_for_each_dev(card,dev) \

        for((dev) = card_to_pnp_dev((card)->devices.next); \

        (dev) != card_to_pnp_dev(&(card)->devices); \

        (dev) = card_to_pnp_dev((dev)->card_list.next))

#define pnp_dev_name(dev) (dev)->name

static inline void *pnp_get_drvdata (struct pnp_dev *pdev)

{

        return dev_get_drvdata(&pdev->dev);

}

static inline void pnp_set_drvdata (struct pnp_dev *pdev, void *data)

{

        dev_set_drvdata(&pdev->dev, data);

}

struct pnp_fixup {

        char id[7];

        void (*quirk_function)(struct pnp_dev *dev);    /* fixup function */

};

/* config parameters */

#define PNP_CONFIG_NORMAL       0x0001

#define PNP_CONFIG_FORCE        0x0002  /* disables validity checking */

/* capabilities */

#define PNP_READ                0x0001

#define PNP_WRITE               0x0002

#define PNP_DISABLE             0x0004

#define PNP_CONFIGURABLE        0x0008

#define PNP_REMOVABLE           0x0010

#define pnp_can_read(dev)       (((dev)->protocol) && ((dev)->protocol->get) && \

                                 ((dev)->capabilities & PNP_READ))

#define pnp_can_write(dev)      (((dev)->protocol) && ((dev)->protocol->set) && \

                                 ((dev)->capabilities & PNP_WRITE))

#define pnp_can_disable(dev)    (((dev)->protocol) && ((dev)->protocol->disable) && \

                                 ((dev)->capabilities & PNP_DISABLE))

#define pnp_can_configure(dev)  ((!(dev)->active) && \

                                 ((dev)->capabilities & PNP_CONFIGURABLE))

#ifdef CONFIG_ISAPNP

extern struct pnp_protocol isapnp_protocol;

#define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))

#else

#define pnp_device_is_isapnp(dev) 0

#endif

#ifdef CONFIG_PNPBIOS

extern struct pnp_protocol pnpbios_protocol;

#define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))

#else

#define pnp_device_is_pnpbios(dev) 0

#endif

/* status */

#define PNP_READY               0x0000

#define PNP_ATTACHED            0x0001

#define PNP_BUSY                0x0002

#define PNP_FAULTY              0x0004

/* isapnp specific macros */

#define isapnp_card_number(dev) ((dev)->card ? (dev)->card->number : -1)

#define isapnp_csn_number(dev)  ((dev)->number)

/*

 * Driver Management

 */

struct pnp_id {

        char id[PNP_ID_LEN];

        struct pnp_id * next;

};

struct pnp_device_id {

        char id[PNP_ID_LEN];

        unsigned long driver_data;      /* data private to the driver */

};

struct pnp_card_device_id {

        char id[PNP_ID_LEN];

        unsigned long driver_data;      /* data private to the driver */

        struct {

                char id[PNP_ID_LEN];

        } devs[PNP_MAX_DEVICES];        /* logical devices */

};

struct pnp_driver {

        char * name;

        const struct pnp_device_id *id_table;

        unsigned int flags;

        int  (*probe)  (struct pnp_dev *dev, const struct pnp_device_id *dev_id);

        void (*remove) (struct pnp_dev *dev);

        struct device_driver driver;

};

#define to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)

struct pnp_card_driver {

        struct list_head global_list;

        char * name;

        const struct pnp_card_device_id *id_table;

        unsigned int flags;

        int  (*probe)  (struct pnp_card_link *card, const struct pnp_card_device_id *card_id);

        void (*remove) (struct pnp_card_link *card);

        struct pnp_driver link;

};

#define to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)

/* pnp driver flags */

#define PNP_DRIVER_RES_DO_NOT_CHANGE    0x0001  /* do not change the state of the device */

#define PNP_DRIVER_RES_DISABLE          0x0003  /* ensure the device is disabled */

/*

 * Protocol Management

 */

struct pnp_protocol {

        struct list_head        protocol_list;

        char                  * name;

        /* resource control functions */

        int (*get)(struct pnp_dev *dev, struct pnp_resource_table *res);

        int (*set)(struct pnp_dev *dev, struct pnp_resource_table *res);

        int (*disable)(struct pnp_dev *dev);

        /* used by pnp layer only (look but don't touch) */

        unsigned char           number;         /* protocol number*/

        struct device           dev;            /* link to driver model */

        struct list_head        cards;

        struct list_head        devices;

};

#define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)

#define protocol_for_each_card(protocol,card) \

        for((card) = protocol_to_pnp_card((protocol)->cards.next); \

        (card) != protocol_to_pnp_card(&(protocol)->cards); \

        (card) = protocol_to_pnp_card((card)->protocol_list.next))

#define protocol_for_each_dev(protocol,dev) \

        for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \

        (dev) != protocol_to_pnp_dev(&(protocol)->devices); \

        (dev) = protocol_to_pnp_dev((dev)->protocol_list.next))

#if defined(CONFIG_PNP)

/* device management */

int pnp_register_protocol(struct pnp_protocol *protocol);

void pnp_unregister_protocol(struct pnp_protocol *protocol);

int pnp_add_device(struct pnp_dev *dev);

void pnp_remove_device(struct pnp_dev *dev);

int pnp_device_attach(struct pnp_dev *pnp_dev);

void pnp_device_detach(struct pnp_dev *pnp_dev);

extern struct list_head pnp_global;

/* multidevice card support */

int pnp_add_card(struct pnp_card *card);

void pnp_remove_card(struct pnp_card *card);

int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev);

void pnp_remove_card_device(struct pnp_dev *dev);

int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card);

struct pnp_dev * pnp_request_card_device(struct pnp_card_link *clink, const char * id, struct pnp_dev * from);

void pnp_release_card_device(struct pnp_dev * dev);

int pnp_register_card_driver(struct pnp_card_driver * drv);

void pnp_unregister_card_driver(struct pnp_card_driver * drv);

extern struct list_head pnp_cards;

/* resource management */

struct pnp_option * pnp_register_independent_option(struct pnp_dev *dev);

struct pnp_option * pnp_register_dependent_option(struct pnp_dev *dev, int priority);

int pnp_register_irq_resource(struct pnp_option *option, struct pnp_irq *data);

int pnp_register_dma_resource(struct pnp_option *option, struct pnp_dma *data);

int pnp_register_port_resource(struct pnp_option *option, struct pnp_port *data);

int pnp_register_mem_resource(struct pnp_option *option, struct pnp_mem *data);

void pnp_init_resource_table(struct pnp_resource_table *table);

int pnp_assign_resources(struct pnp_dev *dev, int depnum);

int pnp_manual_config_dev(struct pnp_dev *dev, struct pnp_resource_table *res, int mode);

int pnp_auto_config_dev(struct pnp_dev *dev);

int pnp_validate_config(struct pnp_dev *dev);

int pnp_activate_dev(struct pnp_dev *dev);

int pnp_disable_dev(struct pnp_dev *dev);

void pnp_resource_change(struct resource *resource, unsigned long start, unsigned long size);

/* protocol helpers */

int pnp_is_active(struct pnp_dev * dev);

int compare_pnp_id(struct pnp_id * pos, const char * id);

int pnp_add_id(struct pnp_id *id, struct pnp_dev *dev);

int pnp_register_driver(struct pnp_driver *drv);

void pnp_unregister_driver(struct pnp_driver *drv);

#else

/* device management */

static inline int pnp_register_protocol(struct pnp_protocol *protocol) { return -ENODEV; }

static inline void pnp_unregister_protocol(struct pnp_protocol *protocol) { }

static inline int pnp_init_device(struct pnp_dev *dev) { return -ENODEV; }

static inline int pnp_add_device(struct pnp_dev *dev) { return -ENODEV; }

static inline void pnp_remove_device(struct pnp_dev *dev) { }

static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }

static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { ; }

/* multidevice card support */

static inline int pnp_add_card(struct pnp_card *card) { return -ENODEV; }

static inline void pnp_remove_card(struct pnp_card *card) { ; }

static inline int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev) { return -ENODEV; }

static inline void pnp_remove_card_device(struct pnp_dev *dev) { ; }

static inline int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card) { return -ENODEV; }

static inline struct pnp_dev * pnp_request_card_device(struct pnp_card_link *clink, const char * id, struct pnp_dev * from) { return NULL; }

static inline void pnp_release_card_device(struct pnp_dev * dev) { ; }

static inline int pnp_register_card_driver(struct pnp_card_driver * drv) { return -ENODEV; }

static inline void pnp_unregister_card_driver(struct pnp_card_driver * drv) { ; }

/* resource management */

static inline struct pnp_option * pnp_register_independent_option(struct pnp_dev *dev) { return NULL; }

static inline struct pnp_option * pnp_register_dependent_option(struct pnp_dev *dev, int priority) { return NULL; }

static inline int pnp_register_irq_resource(struct pnp_option *option, struct pnp_irq *data) { return -ENODEV; }

static inline int pnp_register_dma_resource(struct pnp_option *option, struct pnp_dma *data) { return -ENODEV; }

static inline int pnp_register_port_resource(struct pnp_option *option, struct pnp_port *data) { return -ENODEV; }

static inline int pnp_register_mem_resource(struct pnp_option *option, struct pnp_mem *data) { return -ENODEV; }

static inline void pnp_init_resource_table(struct pnp_resource_table *table) { }

static inline int pnp_assign_resources(struct pnp_dev *dev, int depnum) { return -ENODEV; }

static inline int pnp_manual_config_dev(struct pnp_dev *dev, struct pnp_resource_table *res, int mode) { return -ENODEV; }

static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }

static inline int pnp_validate_config(struct pnp_dev *dev) { return -ENODEV; }

static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }

static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }

static inline void pnp_resource_change(struct resource *resource, unsigned long start, unsigned long size) { }

/* protocol helpers */

static inline int pnp_is_active(struct pnp_dev * dev) { return 0; }

static inline int compare_pnp_id(struct pnp_id * pos, const char * id) { return -ENODEV; }

static inline int pnp_add_id(struct pnp_id *id, struct pnp_dev *dev) { return -ENODEV; }

static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }

static inline void pnp_unregister_driver(struct pnp_driver *drv) { ; }

#endif /* CONFIG_PNP */

#define pnp_err(format, arg...) printk(KERN_ERR "pnp: " format "\n" , ## arg)

#define pnp_info(format, arg...) printk(KERN_INFO "pnp: " format "\n" , ## arg)

#define pnp_warn(format, arg...) printk(KERN_WARNING "pnp: " format "\n" , ## arg)

#ifdef DEBUG

#define pnp_dbg(format, arg...) printk(KERN_DEBUG "pnp: " format "\n" , ## arg)

#else

#define pnp_dbg(format, arg...) do {} while (0)

#endif

#endif /* __KERNEL__ */

#endif /* _LINUX_PNP_H */