include/linux/ioport.h

   1 /*
   2  * ioport.h     Definitions of routines for detecting, reserving and
   3  *              allocating system resources.
   4  *
   5  * Authors:     Linus Torvalds
   6  */
   7
   8 #ifndef _LINUX_IOPORT_H
   9 #define _LINUX_IOPORT_H
  10
  11 #include <linux/compiler.h>
  12 #include <linux/types.h>
  13 /*
  14  * Resources are tree-like, allowing
  15  * nesting etc..
  16  */
  17 struct resource {
  18         resource_size_t start;
  19         resource_size_t end;
  20         const char *name;
  21         unsigned long flags;
  22         struct resource *parent, *sibling, *child;
  23 };
  24
  25 struct resource_list {
  26         struct resource_list *next;
  27         struct resource *res;
  28         struct pci_dev *dev;
  29 };
  30
  31 /*
  32  * IO resources have these defined flags.
  33  */
  34 #define IORESOURCE_BITS         0x000000ff      /* Bus-specific bits */
  35
  36 #define IORESOURCE_IO           0x00000100      /* Resource type */
  37 #define IORESOURCE_MEM          0x00000200
  38 #define IORESOURCE_IRQ          0x00000400
  39 #define IORESOURCE_DMA          0x00000800
  40
  41 #define IORESOURCE_PREFETCH     0x00001000      /* No side effects */
  42 #define IORESOURCE_READONLY     0x00002000
  43 #define IORESOURCE_CACHEABLE    0x00004000
  44 #define IORESOURCE_RANGELENGTH  0x00008000
  45 #define IORESOURCE_SHADOWABLE   0x00010000
  46 #define IORESOURCE_BUS_HAS_VGA  0x00080000
  47
  48 #define IORESOURCE_DISABLED     0x10000000
  49 #define IORESOURCE_UNSET        0x20000000
  50 #define IORESOURCE_AUTO         0x40000000
  51 #define IORESOURCE_BUSY         0x80000000      /* Driver has marked this resource busy */
  52
  53 /* ISA PnP IRQ specific bits (IORESOURCE_BITS) */
  54 #define IORESOURCE_IRQ_HIGHEDGE         (1<<0)
  55 #define IORESOURCE_IRQ_LOWEDGE          (1<<1)
  56 #define IORESOURCE_IRQ_HIGHLEVEL        (1<<2)
  57 #define IORESOURCE_IRQ_LOWLEVEL         (1<<3)
  58 #define IORESOURCE_IRQ_SHAREABLE        (1<<4)
  59
  60 /* ISA PnP DMA specific bits (IORESOURCE_BITS) */
  61 #define IORESOURCE_DMA_TYPE_MASK        (3<<0)
  62 #define IORESOURCE_DMA_8BIT             (0<<0)
  63 #define IORESOURCE_DMA_8AND16BIT        (1<<0)
  64 #define IORESOURCE_DMA_16BIT            (2<<0)
  65
  66 #define IORESOURCE_DMA_MASTER           (1<<2)
  67 #define IORESOURCE_DMA_BYTE             (1<<3)
  68 #define IORESOURCE_DMA_WORD             (1<<4)
  69
  70 #define IORESOURCE_DMA_SPEED_MASK       (3<<6)
  71 #define IORESOURCE_DMA_COMPATIBLE       (0<<6)
  72 #define IORESOURCE_DMA_TYPEA            (1<<6)
  73 #define IORESOURCE_DMA_TYPEB            (2<<6)
  74 #define IORESOURCE_DMA_TYPEF            (3<<6)
  75
  76 /* ISA PnP memory I/O specific bits (IORESOURCE_BITS) */
  77 #define IORESOURCE_MEM_WRITEABLE        (1<<0)  /* dup: IORESOURCE_READONLY */
  78 #define IORESOURCE_MEM_CACHEABLE        (1<<1)  /* dup: IORESOURCE_CACHEABLE */
  79 #define IORESOURCE_MEM_RANGELENGTH      (1<<2)  /* dup: IORESOURCE_RANGELENGTH */
  80 #define IORESOURCE_MEM_TYPE_MASK        (3<<3)
  81 #define IORESOURCE_MEM_8BIT             (0<<3)
  82 #define IORESOURCE_MEM_16BIT            (1<<3)
  83 #define IORESOURCE_MEM_8AND16BIT        (2<<3)
  84 #define IORESOURCE_MEM_32BIT            (3<<3)
  85 #define IORESOURCE_MEM_SHADOWABLE       (1<<5)  /* dup: IORESOURCE_SHADOWABLE */
  86 #define IORESOURCE_MEM_EXPANSIONROM     (1<<6)
  87
  88 /* PCI ROM control bits (IORESOURCE_BITS) */
  89 #define IORESOURCE_ROM_ENABLE           (1<<0)  /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
  90 #define IORESOURCE_ROM_SHADOW           (1<<1)  /* ROM is copy at C000:0 */
  91 #define IORESOURCE_ROM_COPY             (1<<2)  /* ROM is alloc'd copy, resource field overlaid */
  92 #define IORESOURCE_ROM_BIOS_COPY        (1<<3)  /* ROM is BIOS copy, resource field overlaid */
  93
  94 /* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */
  95 #define IORESOURCE_PCI_FIXED            (1<<4)  /* Do not move resource */
  96
  97 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
  98 extern struct resource ioport_resource;
  99 extern struct resource iomem_resource;
 100
 101 extern int request_resource(struct resource *root, struct resource *new);
 102 extern int release_resource(struct resource *new);
 103 extern int insert_resource(struct resource *parent, struct resource *new);
 104 extern int allocate_resource(struct resource *root, struct resource *new,
 105                              resource_size_t size, resource_size_t min,
 106                              resource_size_t max, resource_size_t align,
 107                              void (*alignf)(void *, struct resource *,
 108                                             resource_size_t, resource_size_t),
 109                              void *alignf_data);
 110 int adjust_resource(struct resource *res, resource_size_t start,
 111                     resource_size_t size);
 112
 113 /* get registered SYSTEM_RAM resources in specified area */
 114 extern int find_next_system_ram(struct resource *res);
 115
 116 /* Convenience shorthand with allocation */
 117 #define request_region(start,n,name)    __request_region(&ioport_resource, (start), (n), (name))
 118 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name))
 119 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
 120
 121 extern struct resource * __request_region(struct resource *,
 122                                         resource_size_t start,
 123                                         resource_size_t n, const char *name);
 124
 125 /* Compatibility cruft */
 126 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
 127 #define check_mem_region(start,n)       __check_region(&iomem_resource, (start), (n))
 128 #define release_mem_region(start,n)     __release_region(&iomem_resource, (start), (n))
 129
 130 extern int __check_region(struct resource *, resource_size_t, resource_size_t);
 131 extern void __release_region(struct resource *, resource_size_t,
 132                                 resource_size_t);
 133
 134 static inline int __deprecated check_region(resource_size_t s,
 135                                                 resource_size_t n)
 136 {
 137         return __check_region(&ioport_resource, s, n);
 138 }
 139
 140 /* Wrappers for managed devices */
 141 struct device;
 142 #define devm_request_region(dev,start,n,name) \
 143         __devm_request_region(dev, &ioport_resource, (start), (n), (name))
 144 #define devm_request_mem_region(dev,start,n,name) \
 145         __devm_request_region(dev, &iomem_resource, (start), (n), (name))
 146
 147 extern struct resource * __devm_request_region(struct device *dev,
 148                                 struct resource *parent, resource_size_t start,
 149                                 resource_size_t n, const char *name);
 150
 151 #define devm_release_region(start,n) \
 152         __devm_release_region(dev, &ioport_resource, (start), (n))
 153 #define devm_release_mem_region(start,n) \
 154         __devm_release_region(dev, &iomem_resource, (start), (n))
 155
 156 extern void __devm_release_region(struct device *dev, struct resource *parent,
 157                                   resource_size_t start, resource_size_t n);
 158
 159 #endif  /* _LINUX_IOPORT_H */