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 #ifndef __ASSEMBLY__
  12 #include <linux/compiler.h>
  13 #include <linux/types.h>
  14 /*
  15  * Resources are tree-like, allowing
  16  * nesting etc..
  17  */
  18 struct resource {
  19         resource_size_t start;
  20         resource_size_t end;
  21         const char *name;
  22         unsigned long flags;
  23         struct resource *parent, *sibling, *child;
  24 };
  25
  26 struct resource_list {
  27         struct resource_list *next;
  28         struct resource *res;
  29         struct pci_dev *dev;
  30 };
  31
  32 /*
  33  * IO resources have these defined flags.
  34  */
  35 #define IORESOURCE_BITS         0x000000ff      /* Bus-specific bits */
  36
  37 #define IORESOURCE_TYPE_BITS    0x00001f00      /* Resource type */
  38 #define IORESOURCE_IO           0x00000100
  39 #define IORESOURCE_MEM          0x00000200
  40 #define IORESOURCE_IRQ          0x00000400
  41 #define IORESOURCE_DMA          0x00000800
  42 #define IORESOURCE_BUS          0x00001000
  43
  44 #define IORESOURCE_PREFETCH     0x00002000      /* No side effects */
  45 #define IORESOURCE_READONLY     0x00004000
  46 #define IORESOURCE_CACHEABLE    0x00008000
  47 #define IORESOURCE_RANGELENGTH  0x00010000
  48 #define IORESOURCE_SHADOWABLE   0x00020000
  49
  50 #define IORESOURCE_SIZEALIGN    0x00040000      /* size indicates alignment */
  51 #define IORESOURCE_STARTALIGN   0x00080000      /* start field is alignment */
  52
  53 #define IORESOURCE_MEM_64       0x00100000
  54 #define IORESOURCE_WINDOW       0x00200000      /* forwarded by bridge */
  55 #define IORESOURCE_MUXED        0x00400000      /* Resource is software muxed */
  56
  57 #define IORESOURCE_EXCLUSIVE    0x08000000      /* Userland may not map this resource */
  58 #define IORESOURCE_DISABLED     0x10000000
  59 #define IORESOURCE_UNSET        0x20000000
  60 #define IORESOURCE_AUTO         0x40000000
  61 #define IORESOURCE_BUSY         0x80000000      /* Driver has marked this resource busy */
  62
  63 /* PnP IRQ specific bits (IORESOURCE_BITS) */
  64 #define IORESOURCE_IRQ_HIGHEDGE         (1<<0)
  65 #define IORESOURCE_IRQ_LOWEDGE          (1<<1)
  66 #define IORESOURCE_IRQ_HIGHLEVEL        (1<<2)
  67 #define IORESOURCE_IRQ_LOWLEVEL         (1<<3)
  68 #define IORESOURCE_IRQ_SHAREABLE        (1<<4)
  69 #define IORESOURCE_IRQ_OPTIONAL         (1<<5)
  70
  71 /* PnP DMA specific bits (IORESOURCE_BITS) */
  72 #define IORESOURCE_DMA_TYPE_MASK        (3<<0)
  73 #define IORESOURCE_DMA_8BIT             (0<<0)
  74 #define IORESOURCE_DMA_8AND16BIT        (1<<0)
  75 #define IORESOURCE_DMA_16BIT            (2<<0)
  76
  77 #define IORESOURCE_DMA_MASTER           (1<<2)
  78 #define IORESOURCE_DMA_BYTE             (1<<3)
  79 #define IORESOURCE_DMA_WORD             (1<<4)
  80
  81 #define IORESOURCE_DMA_SPEED_MASK       (3<<6)
  82 #define IORESOURCE_DMA_COMPATIBLE       (0<<6)
  83 #define IORESOURCE_DMA_TYPEA            (1<<6)
  84 #define IORESOURCE_DMA_TYPEB            (2<<6)
  85 #define IORESOURCE_DMA_TYPEF            (3<<6)
  86
  87 /* PnP memory I/O specific bits (IORESOURCE_BITS) */
  88 #define IORESOURCE_MEM_WRITEABLE        (1<<0)  /* dup: IORESOURCE_READONLY */
  89 #define IORESOURCE_MEM_CACHEABLE        (1<<1)  /* dup: IORESOURCE_CACHEABLE */
  90 #define IORESOURCE_MEM_RANGELENGTH      (1<<2)  /* dup: IORESOURCE_RANGELENGTH */
  91 #define IORESOURCE_MEM_TYPE_MASK        (3<<3)
  92 #define IORESOURCE_MEM_8BIT             (0<<3)
  93 #define IORESOURCE_MEM_16BIT            (1<<3)
  94 #define IORESOURCE_MEM_8AND16BIT        (2<<3)
  95 #define IORESOURCE_MEM_32BIT            (3<<3)
  96 #define IORESOURCE_MEM_SHADOWABLE       (1<<5)  /* dup: IORESOURCE_SHADOWABLE */
  97 #define IORESOURCE_MEM_EXPANSIONROM     (1<<6)
  98
  99 /* PnP I/O specific bits (IORESOURCE_BITS) */
 100 #define IORESOURCE_IO_16BIT_ADDR        (1<<0)
 101 #define IORESOURCE_IO_FIXED             (1<<1)
 102
 103 /* PCI ROM control bits (IORESOURCE_BITS) */
 104 #define IORESOURCE_ROM_ENABLE           (1<<0)  /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
 105 #define IORESOURCE_ROM_SHADOW           (1<<1)  /* ROM is copy at C000:0 */
 106 #define IORESOURCE_ROM_COPY             (1<<2)  /* ROM is alloc'd copy, resource field overlaid */
 107 #define IORESOURCE_ROM_BIOS_COPY        (1<<3)  /* ROM is BIOS copy, resource field overlaid */
 108
 109 /* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */
 110 #define IORESOURCE_PCI_FIXED            (1<<4)  /* Do not move resource */
 111
 112
 113 /* helpers to define resources */
 114 #define DEFINE_RES_NAMED(_start, _size, _name, _flags)                  \
 115         {                                                               \
 116                 .start = (_start),                                      \
 117                 .end = (_start) + (_size) - 1,                          \
 118                 .name = (_name),                                        \
 119                 .flags = (_flags),                                      \
 120         }
 121
 122 #define DEFINE_RES_IO_NAMED(_start, _size, _name)                       \
 123         DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
 124 #define DEFINE_RES_IO(_start, _size)                                    \
 125         DEFINE_RES_IO_NAMED((_start), (_size), NULL)
 126
 127 #define DEFINE_RES_MEM_NAMED(_start, _size, _name)                      \
 128         DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
 129 #define DEFINE_RES_MEM(_start, _size)                                   \
 130         DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
 131
 132 #define DEFINE_RES_IRQ_NAMED(_irq, _name)                               \
 133         DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
 134 #define DEFINE_RES_IRQ(_irq)                                            \
 135         DEFINE_RES_IRQ_NAMED((_irq), NULL)
 136
 137 #define DEFINE_RES_DMA_NAMED(_dma, _name)                               \
 138         DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
 139 #define DEFINE_RES_DMA(_dma)                                            \
 140         DEFINE_RES_DMA_NAMED((_dma), NULL)
 141
 142 /* PC/ISA/whatever - the normal PC address spaces: IO and memory */
 143 extern struct resource ioport_resource;
 144 extern struct resource iomem_resource;
 145
 146 extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
 147 extern int request_resource(struct resource *root, struct resource *new);
 148 extern int release_resource(struct resource *new);
 149 void release_child_resources(struct resource *new);
 150 extern void reserve_region_with_split(struct resource *root,
 151                              resource_size_t start, resource_size_t end,
 152                              const char *name);
 153 extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
 154 extern int insert_resource(struct resource *parent, struct resource *new);
 155 extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
 156 extern void arch_remove_reservations(struct resource *avail);
 157 extern int allocate_resource(struct resource *root, struct resource *new,
 158                              resource_size_t size, resource_size_t min,
 159                              resource_size_t max, resource_size_t align,
 160                              resource_size_t (*alignf)(void *,
 161                                                        const struct resource *,
 162                                                        resource_size_t,
 163                                                        resource_size_t),
 164                              void *alignf_data);
 165 struct resource *lookup_resource(struct resource *root, resource_size_t start);
 166 int adjust_resource(struct resource *res, resource_size_t start,
 167                     resource_size_t size);
 168 resource_size_t resource_alignment(struct resource *res);
 169 static inline resource_size_t resource_size(const struct resource *res)
 170 {
 171         return res->end - res->start + 1;
 172 }
 173 static inline unsigned long resource_type(const struct resource *res)
 174 {
 175         return res->flags & IORESOURCE_TYPE_BITS;
 176 }
 177
 178 /* Convenience shorthand with allocation */
 179 #define request_region(start,n,name)            __request_region(&ioport_resource, (start), (n), (name), 0)
 180 #define request_muxed_region(start,n,name)      __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
 181 #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
 182 #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
 183 #define request_mem_region_exclusive(start,n,name) \
 184         __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
 185 #define rename_region(region, newname) do { (region)->name = (newname); } while (0)
 186
 187 extern struct resource * __request_region(struct resource *,
 188                                         resource_size_t start,
 189                                         resource_size_t n,
 190                                         const char *name, int flags);
 191
 192 /* Compatibility cruft */
 193 #define release_region(start,n) __release_region(&ioport_resource, (start), (n))
 194 #define check_mem_region(start,n)       __check_region(&iomem_resource, (start), (n))
 195 #define release_mem_region(start,n)     __release_region(&iomem_resource, (start), (n))
 196
 197 extern int __check_region(struct resource *, resource_size_t, resource_size_t);
 198 extern void __release_region(struct resource *, resource_size_t,
 199                                 resource_size_t);
 200
 201 static inline int __deprecated check_region(resource_size_t s,
 202                                                 resource_size_t n)
 203 {
 204         return __check_region(&ioport_resource, s, n);
 205 }
 206
 207 /* Wrappers for managed devices */
 208 struct device;
 209 #define devm_request_region(dev,start,n,name) \
 210         __devm_request_region(dev, &ioport_resource, (start), (n), (name))
 211 #define devm_request_mem_region(dev,start,n,name) \
 212         __devm_request_region(dev, &iomem_resource, (start), (n), (name))
 213
 214 extern struct resource * __devm_request_region(struct device *dev,
 215                                 struct resource *parent, resource_size_t start,
 216                                 resource_size_t n, const char *name);
 217
 218 #define devm_release_region(dev, start, n) \
 219         __devm_release_region(dev, &ioport_resource, (start), (n))
 220 #define devm_release_mem_region(dev, start, n) \
 221         __devm_release_region(dev, &iomem_resource, (start), (n))
 222
 223 extern void __devm_release_region(struct device *dev, struct resource *parent,
 224                                   resource_size_t start, resource_size_t n);
 225 extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
 226 extern int iomem_is_exclusive(u64 addr);
 227
 228 extern int
 229 walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
 230                 void *arg, int (*func)(unsigned long, unsigned long, void *));
 231
 232 #endif /* __ASSEMBLY__ */
 233 #endif  /* _LINUX_IOPORT_H */