LXR linux/include/linux/pnp.h

   1/*
   2 * Linux Plug and Play Support
   3 * Copyright by Adam Belay <ambx1@neo.rr.com>
   4 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
   5 *      Bjorn Helgaas <bjorn.helgaas@hp.com>
   6 */
   7
   8#ifndef _LINUX_PNP_H
   9#define _LINUX_PNP_H
  10
  11#include <linux/device.h>
  12#include <linux/list.h>
  13#include <linux/errno.h>
  14#include <linux/mod_devicetable.h>
  15
  16#define PNP_NAME_LEN            50
  17
  18struct pnp_protocol;
  19struct pnp_dev;
  20
  21/*
  22 * Resource Management
  23 */
  24#ifdef CONFIG_PNP
  25struct resource *pnp_get_resource(struct pnp_dev *dev, unsigned long type,
  26                                unsigned int num);
  27#else
  28static inline struct resource *pnp_get_resource(struct pnp_dev *dev,
  29                        unsigned long type, unsigned int num)
  30{
  31        return NULL;
  32}
  33#endif
  34
  35static inline int pnp_resource_valid(struct resource *res)
  36{
  37        if (res)
  38                return 1;
  39        return 0;
  40}
  41
  42static inline int pnp_resource_enabled(struct resource *res)
  43{
  44        if (res && !(res->flags & IORESOURCE_DISABLED))
  45                return 1;
  46        return 0;
  47}
  48
  49static inline resource_size_t pnp_resource_len(struct resource *res)
  50{
  51        if (res->start == 0 && res->end == 0)
  52                return 0;
  53        return resource_size(res);
  54}
  55
  56
  57static inline resource_size_t pnp_port_start(struct pnp_dev *dev,
  58                                             unsigned int bar)
  59{
  60        struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  61
  62        if (pnp_resource_valid(res))
  63                return res->start;
  64        return 0;
  65}
  66
  67static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
  68                                           unsigned int bar)
  69{
  70        struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  71
  72        if (pnp_resource_valid(res))
  73                return res->end;
  74        return 0;
  75}
  76
  77static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
  78                                           unsigned int bar)
  79{
  80        struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  81
  82        if (pnp_resource_valid(res))
  83                return res->flags;
  84        return IORESOURCE_IO | IORESOURCE_AUTO;
  85}
  86
  87static inline int pnp_port_valid(struct pnp_dev *dev, unsigned int bar)
  88{
  89        return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IO, bar));
  90}
  91
  92static inline resource_size_t pnp_port_len(struct pnp_dev *dev,
  93                                           unsigned int bar)
  94{
  95        struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  96
  97        if (pnp_resource_valid(res))
  98                return pnp_resource_len(res);
  99        return 0;
 100}
 101
 102
 103static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
 104                                            unsigned int bar)
 105{
 106        struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
 107
 108        if (pnp_resource_valid(res))
 109                return res->start;
 110        return 0;
 111}
 112
 113static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
 114                                          unsigned int bar)
 115{
 116        struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
 117
 118        if (pnp_resource_valid(res))
 119                return res->end;
 120        return 0;
 121}
 122
 123static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
 124{
 125        struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
 126
 127        if (pnp_resource_valid(res))
 128                return res->flags;
 129        return IORESOURCE_MEM | IORESOURCE_AUTO;
 130}
 131
 132static inline int pnp_mem_valid(struct pnp_dev *dev, unsigned int bar)
 133{
 134        return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_MEM, bar));
 135}
 136
 137static inline resource_size_t pnp_mem_len(struct pnp_dev *dev,
 138                                          unsigned int bar)
 139{
 140        struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
 141
 142        if (pnp_resource_valid(res))
 143                return pnp_resource_len(res);
 144        return 0;
 145}
 146
 147
 148static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
 149{
 150        struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
 151
 152        if (pnp_resource_valid(res))
 153                return res->start;
 154        return -1;
 155}
 156
 157static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
 158{
 159        struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
 160
 161        if (pnp_resource_valid(res))
 162                return res->flags;
 163        return IORESOURCE_IRQ | IORESOURCE_AUTO;
 164}
 165
 166static inline int pnp_irq_valid(struct pnp_dev *dev, unsigned int bar)
 167{
 168        return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IRQ, bar));
 169}
 170
 171
 172static inline resource_size_t pnp_dma(struct pnp_dev *dev, unsigned int bar)
 173{
 174        struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
 175
 176        if (pnp_resource_valid(res))
 177                return res->start;
 178        return -1;
 179}
 180
 181static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
 182{
 183        struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
 184
 185        if (pnp_resource_valid(res))
 186                return res->flags;
 187        return IORESOURCE_DMA | IORESOURCE_AUTO;
 188}
 189
 190static inline int pnp_dma_valid(struct pnp_dev *dev, unsigned int bar)
 191{
 192        return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_DMA, bar));
 193}
 194
 195
 196/*
 197 * Device Management
 198 */
 199
 200struct pnp_card {
 201        struct device dev;              /* Driver Model device interface */
 202        unsigned char number;           /* used as an index, must be unique */
 203        struct list_head global_list;   /* node in global list of cards */
 204        struct list_head protocol_list; /* node in protocol's list of cards */
 205        struct list_head devices;       /* devices attached to the card */
 206
 207        struct pnp_protocol *protocol;
 208        struct pnp_id *id;              /* contains supported EISA IDs */
 209
 210        char name[PNP_NAME_LEN];        /* contains a human-readable name */
 211        unsigned char pnpver;           /* Plug & Play version */
 212        unsigned char productver;       /* product version */
 213        unsigned int serial;            /* serial number */
 214        unsigned char checksum;         /* if zero - checksum passed */
 215        struct proc_dir_entry *procdir; /* directory entry in /proc/bus/isapnp */
 216};
 217
 218#define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
 219#define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
 220#define to_pnp_card(n) container_of(n, struct pnp_card, dev)
 221#define pnp_for_each_card(card) \
 222        for((card) = global_to_pnp_card(pnp_cards.next); \
 223        (card) != global_to_pnp_card(&pnp_cards); \
 224        (card) = global_to_pnp_card((card)->global_list.next))
 225
 226struct pnp_card_link {
 227        struct pnp_card *card;
 228        struct pnp_card_driver *driver;
 229        void *driver_data;
 230        pm_message_t pm_state;
 231};
 232
 233static inline void *pnp_get_card_drvdata(struct pnp_card_link *pcard)
 234{
 235        return pcard->driver_data;
 236}
 237
 238static inline void pnp_set_card_drvdata(struct pnp_card_link *pcard, void *data)
 239{
 240        pcard->driver_data = data;
 241}
 242
 243struct pnp_dev {
 244        struct device dev;              /* Driver Model device interface */
 245        u64 dma_mask;
 246        unsigned int number;            /* used as an index, must be unique */
 247        int status;
 248
 249        struct list_head global_list;   /* node in global list of devices */
 250        struct list_head protocol_list; /* node in list of device's protocol */
 251        struct list_head card_list;     /* node in card's list of devices */
 252        struct list_head rdev_list;     /* node in cards list of requested devices */
 253
 254        struct pnp_protocol *protocol;
 255        struct pnp_card *card;  /* card the device is attached to, none if NULL */
 256        struct pnp_driver *driver;
 257        struct pnp_card_link *card_link;
 258
 259        struct pnp_id *id;              /* supported EISA IDs */
 260
 261        int active;
 262        int capabilities;
 263        unsigned int num_dependent_sets;
 264        struct list_head resources;
 265        struct list_head options;
 266
 267        char name[PNP_NAME_LEN];        /* contains a human-readable name */
 268        int flags;                      /* used by protocols */
 269        struct proc_dir_entry *procent; /* device entry in /proc/bus/isapnp */
 270        void *data;
 271};
 272
 273#define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
 274#define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
 275#define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
 276#define to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
 277#define pnp_for_each_dev(dev) \
 278        for((dev) = global_to_pnp_dev(pnp_global.next); \
 279        (dev) != global_to_pnp_dev(&pnp_global); \
 280        (dev) = global_to_pnp_dev((dev)->global_list.next))
 281#define card_for_each_dev(card,dev) \
 282        for((dev) = card_to_pnp_dev((card)->devices.next); \
 283        (dev) != card_to_pnp_dev(&(card)->devices); \
 284        (dev) = card_to_pnp_dev((dev)->card_list.next))
 285#define pnp_dev_name(dev) (dev)->name
 286
 287static inline void *pnp_get_drvdata(struct pnp_dev *pdev)
 288{
 289        return dev_get_drvdata(&pdev->dev);
 290}
 291
 292static inline void pnp_set_drvdata(struct pnp_dev *pdev, void *data)
 293{
 294        dev_set_drvdata(&pdev->dev, data);
 295}
 296
 297struct pnp_fixup {
 298        char id[7];
 299        void (*quirk_function) (struct pnp_dev * dev);  /* fixup function */
 300};
 301
 302/* config parameters */
 303#define PNP_CONFIG_NORMAL       0x0001
 304#define PNP_CONFIG_FORCE        0x0002  /* disables validity checking */
 305
 306/* capabilities */
 307#define PNP_READ                0x0001
 308#define PNP_WRITE               0x0002
 309#define PNP_DISABLE             0x0004
 310#define PNP_CONFIGURABLE        0x0008
 311#define PNP_REMOVABLE           0x0010
 312
 313#define pnp_can_read(dev)       (((dev)->protocol->get) && \
 314                                 ((dev)->capabilities & PNP_READ))
 315#define pnp_can_write(dev)      (((dev)->protocol->set) && \
 316                                 ((dev)->capabilities & PNP_WRITE))
 317#define pnp_can_disable(dev)    (((dev)->protocol->disable) && \
 318                                 ((dev)->capabilities & PNP_DISABLE))
 319#define pnp_can_configure(dev)  ((!(dev)->active) && \
 320                                 ((dev)->capabilities & PNP_CONFIGURABLE))
 321
 322#ifdef CONFIG_ISAPNP
 323extern struct pnp_protocol isapnp_protocol;
 324#define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
 325#else
 326#define pnp_device_is_isapnp(dev) 0
 327#endif
 328extern struct mutex pnp_res_mutex;
 329
 330#ifdef CONFIG_PNPBIOS
 331extern struct pnp_protocol pnpbios_protocol;
 332#define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
 333#else
 334#define pnp_device_is_pnpbios(dev) 0
 335#endif
 336
 337#ifdef CONFIG_PNPACPI
 338extern struct pnp_protocol pnpacpi_protocol;
 339
 340static inline struct acpi_device *pnp_acpi_device(struct pnp_dev *dev)
 341{
 342        if (dev->protocol == &pnpacpi_protocol)
 343                return dev->data;
 344        return NULL;
 345}
 346#else
 347#define pnp_acpi_device(dev) 0
 348#endif
 349
 350/* status */
 351#define PNP_READY               0x0000
 352#define PNP_ATTACHED            0x0001
 353#define PNP_BUSY                0x0002
 354#define PNP_FAULTY              0x0004
 355
 356/* isapnp specific macros */
 357
 358#define isapnp_card_number(dev) ((dev)->card ? (dev)->card->number : -1)
 359#define isapnp_csn_number(dev)  ((dev)->number)
 360
 361/*
 362 * Driver Management
 363 */
 364
 365struct pnp_id {
 366        char id[PNP_ID_LEN];
 367        struct pnp_id *next;
 368};
 369
 370struct pnp_driver {
 371        char *name;
 372        const struct pnp_device_id *id_table;
 373        unsigned int flags;
 374        int (*probe) (struct pnp_dev *dev, const struct pnp_device_id *dev_id);
 375        void (*remove) (struct pnp_dev *dev);
 376        void (*shutdown) (struct pnp_dev *dev);
 377        int (*suspend) (struct pnp_dev *dev, pm_message_t state);
 378        int (*resume) (struct pnp_dev *dev);
 379        struct device_driver driver;
 380};
 381
 382#define to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)
 383
 384struct pnp_card_driver {
 385        struct list_head global_list;
 386        char *name;
 387        const struct pnp_card_device_id *id_table;
 388        unsigned int flags;
 389        int (*probe) (struct pnp_card_link *card,
 390                      const struct pnp_card_device_id *card_id);
 391        void (*remove) (struct pnp_card_link *card);
 392        int (*suspend) (struct pnp_card_link *card, pm_message_t state);
 393        int (*resume) (struct pnp_card_link *card);
 394        struct pnp_driver link;
 395};
 396
 397#define to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)
 398
 399/* pnp driver flags */
 400#define PNP_DRIVER_RES_DO_NOT_CHANGE    0x0001  /* do not change the state of the device */
 401#define PNP_DRIVER_RES_DISABLE          0x0003  /* ensure the device is disabled */
 402
 403/*
 404 * Protocol Management
 405 */
 406
 407struct pnp_protocol {
 408        struct list_head protocol_list;
 409        char *name;
 410
 411        /* resource control functions */
 412        int (*get) (struct pnp_dev *dev);
 413        int (*set) (struct pnp_dev *dev);
 414        int (*disable) (struct pnp_dev *dev);
 415
 416        /* protocol specific suspend/resume */
 417        bool (*can_wakeup) (struct pnp_dev *dev);
 418        int (*suspend) (struct pnp_dev * dev, pm_message_t state);
 419        int (*resume) (struct pnp_dev * dev);
 420
 421        /* used by pnp layer only (look but don't touch) */
 422        unsigned char number;   /* protocol number */
 423        struct device dev;      /* link to driver model */
 424        struct list_head cards;
 425        struct list_head devices;
 426};
 427
 428#define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
 429#define protocol_for_each_card(protocol,card) \
 430        for((card) = protocol_to_pnp_card((protocol)->cards.next); \
 431        (card) != protocol_to_pnp_card(&(protocol)->cards); \
 432        (card) = protocol_to_pnp_card((card)->protocol_list.next))
 433#define protocol_for_each_dev(protocol,dev) \
 434        for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \
 435        (dev) != protocol_to_pnp_dev(&(protocol)->devices); \
 436        (dev) = protocol_to_pnp_dev((dev)->protocol_list.next))
 437
 438extern struct bus_type pnp_bus_type;
 439
 440#if defined(CONFIG_PNP)
 441
 442/* device management */
 443int pnp_device_attach(struct pnp_dev *pnp_dev);
 444void pnp_device_detach(struct pnp_dev *pnp_dev);
 445extern struct list_head pnp_global;
 446extern int pnp_platform_devices;
 447
 448/* multidevice card support */
 449struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
 450                                        const char *id, struct pnp_dev *from);
 451void pnp_release_card_device(struct pnp_dev *dev);
 452int pnp_register_card_driver(struct pnp_card_driver *drv);
 453void pnp_unregister_card_driver(struct pnp_card_driver *drv);
 454extern struct list_head pnp_cards;
 455
 456/* resource management */
 457int pnp_possible_config(struct pnp_dev *dev, int type, resource_size_t base,
 458                        resource_size_t size);
 459int pnp_auto_config_dev(struct pnp_dev *dev);
 460int pnp_start_dev(struct pnp_dev *dev);
 461int pnp_stop_dev(struct pnp_dev *dev);
 462int pnp_activate_dev(struct pnp_dev *dev);
 463int pnp_disable_dev(struct pnp_dev *dev);
 464int pnp_range_reserved(resource_size_t start, resource_size_t end);
 465
 466/* protocol helpers */
 467int pnp_is_active(struct pnp_dev *dev);
 468int compare_pnp_id(struct pnp_id *pos, const char *id);
 469int pnp_register_driver(struct pnp_driver *drv);
 470void pnp_unregister_driver(struct pnp_driver *drv);
 471
 472#else
 473
 474/* device management */
 475static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
 476static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { }
 477
 478#define pnp_platform_devices 0
 479
 480/* multidevice card support */
 481static inline struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink, const char *id, struct pnp_dev *from) { return NULL; }
 482static inline void pnp_release_card_device(struct pnp_dev *dev) { }
 483static inline int pnp_register_card_driver(struct pnp_card_driver *drv) { return -ENODEV; }
 484static inline void pnp_unregister_card_driver(struct pnp_card_driver *drv) { }
 485
 486/* resource management */
 487static inline int pnp_possible_config(struct pnp_dev *dev, int type,
 488                                      resource_size_t base,
 489                                      resource_size_t size) { return 0; }
 490static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
 491static inline int pnp_start_dev(struct pnp_dev *dev) { return -ENODEV; }
 492static inline int pnp_stop_dev(struct pnp_dev *dev) { return -ENODEV; }
 493static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
 494static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }
 495static inline int pnp_range_reserved(resource_size_t start, resource_size_t end) { return 0;}
 496
 497/* protocol helpers */
 498static inline int pnp_is_active(struct pnp_dev *dev) { return 0; }
 499static inline int compare_pnp_id(struct pnp_id *pos, const char *id) { return -ENODEV; }
 500static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
 501static inline void pnp_unregister_driver(struct pnp_driver *drv) { }
 502
 503#endif /* CONFIG_PNP */
 504
 505#endif /* _LINUX_PNP_H */
 506