LXR linux/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 */
  18struct 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/*
  27 * IO resources have these defined flags.
  28 *
  29 * PCI devices expose these flags to userspace in the "resource" sysfs file,
  30 * so don't move them.
  31 */
  32#define IORESOURCE_BITS         0x000000ff      /* Bus-specific bits */
  33
  34#define IORESOURCE_TYPE_BITS    0x00001f00      /* Resource type */
  35#define IORESOURCE_IO           0x00000100      /* PCI/ISA I/O ports */
  36#define IORESOURCE_MEM          0x00000200
  37#define IORESOURCE_REG          0x00000300      /* Register offsets */
  38#define IORESOURCE_IRQ          0x00000400
  39#define IORESOURCE_DMA          0x00000800
  40#define IORESOURCE_BUS          0x00001000
  41
  42#define IORESOURCE_PREFETCH     0x00002000      /* No side effects */
  43#define IORESOURCE_READONLY     0x00004000
  44#define IORESOURCE_CACHEABLE    0x00008000
  45#define IORESOURCE_RANGELENGTH  0x00010000
  46#define IORESOURCE_SHADOWABLE   0x00020000
  47
  48#define IORESOURCE_SIZEALIGN    0x00040000      /* size indicates alignment */
  49#define IORESOURCE_STARTALIGN   0x00080000      /* start field is alignment */
  50
  51#define IORESOURCE_MEM_64       0x00100000
  52#define IORESOURCE_WINDOW       0x00200000      /* forwarded by bridge */
  53#define IORESOURCE_MUXED        0x00400000      /* Resource is software muxed */
  54
  55#define IORESOURCE_EXT_TYPE_BITS 0x01000000     /* Resource extended types */
  56#define IORESOURCE_SYSRAM       0x01000000      /* System RAM (modifier) */
  57
  58#define IORESOURCE_EXCLUSIVE    0x08000000      /* Userland may not map this resource */
  59
  60#define IORESOURCE_DISABLED     0x10000000
  61#define IORESOURCE_UNSET        0x20000000      /* No address assigned yet */
  62#define IORESOURCE_AUTO         0x40000000
  63#define IORESOURCE_BUSY         0x80000000      /* Driver has marked this resource busy */
  64
  65/* I/O resource extended types */
  66#define IORESOURCE_SYSTEM_RAM           (IORESOURCE_MEM|IORESOURCE_SYSRAM)
  67
  68/* PnP IRQ specific bits (IORESOURCE_BITS) */
  69#define IORESOURCE_IRQ_HIGHEDGE         (1<<0)
  70#define IORESOURCE_IRQ_LOWEDGE          (1<<1)
  71#define IORESOURCE_IRQ_HIGHLEVEL        (1<<2)
  72#define IORESOURCE_IRQ_LOWLEVEL         (1<<3)
  73#define IORESOURCE_IRQ_SHAREABLE        (1<<4)
  74#define IORESOURCE_IRQ_OPTIONAL         (1<<5)
  75
  76/* PnP DMA specific bits (IORESOURCE_BITS) */
  77#define IORESOURCE_DMA_TYPE_MASK        (3<<0)
  78#define IORESOURCE_DMA_8BIT             (0<<0)
  79#define IORESOURCE_DMA_8AND16BIT        (1<<0)
  80#define IORESOURCE_DMA_16BIT            (2<<0)
  81
  82#define IORESOURCE_DMA_MASTER           (1<<2)
  83#define IORESOURCE_DMA_BYTE             (1<<3)
  84#define IORESOURCE_DMA_WORD             (1<<4)
  85
  86#define IORESOURCE_DMA_SPEED_MASK       (3<<6)
  87#define IORESOURCE_DMA_COMPATIBLE       (0<<6)
  88#define IORESOURCE_DMA_TYPEA            (1<<6)
  89#define IORESOURCE_DMA_TYPEB            (2<<6)
  90#define IORESOURCE_DMA_TYPEF            (3<<6)
  91
  92/* PnP memory I/O specific bits (IORESOURCE_BITS) */
  93#define IORESOURCE_MEM_WRITEABLE        (1<<0)  /* dup: IORESOURCE_READONLY */
  94#define IORESOURCE_MEM_CACHEABLE        (1<<1)  /* dup: IORESOURCE_CACHEABLE */
  95#define IORESOURCE_MEM_RANGELENGTH      (1<<2)  /* dup: IORESOURCE_RANGELENGTH */
  96#define IORESOURCE_MEM_TYPE_MASK        (3<<3)
  97#define IORESOURCE_MEM_8BIT             (0<<3)
  98#define IORESOURCE_MEM_16BIT            (1<<3)
  99#define IORESOURCE_MEM_8AND16BIT        (2<<3)
 100#define IORESOURCE_MEM_32BIT            (3<<3)
 101#define IORESOURCE_MEM_SHADOWABLE       (1<<5)  /* dup: IORESOURCE_SHADOWABLE */
 102#define IORESOURCE_MEM_EXPANSIONROM     (1<<6)
 103
 104/* PnP I/O specific bits (IORESOURCE_BITS) */
 105#define IORESOURCE_IO_16BIT_ADDR        (1<<0)
 106#define IORESOURCE_IO_FIXED             (1<<1)
 107#define IORESOURCE_IO_SPARSE            (1<<2)
 108
 109/* PCI ROM control bits (IORESOURCE_BITS) */
 110#define IORESOURCE_ROM_ENABLE           (1<<0)  /* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */
 111#define IORESOURCE_ROM_SHADOW           (1<<1)  /* ROM is copy at C000:0 */
 112#define IORESOURCE_ROM_COPY             (1<<2)  /* ROM is alloc'd copy, resource field overlaid */
 113#define IORESOURCE_ROM_BIOS_COPY        (1<<3)  /* ROM is BIOS copy, resource field overlaid */
 114
 115/* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */
 116#define IORESOURCE_PCI_FIXED            (1<<4)  /* Do not move resource */
 117#define IORESOURCE_PCI_EA_BEI           (1<<5)  /* BAR Equivalent Indicator */
 118
 119
 120/* helpers to define resources */
 121#define DEFINE_RES_NAMED(_start, _size, _name, _flags)                  \
 122        {                                                               \
 123                .start = (_start),                                      \
 124                .end = (_start) + (_size) - 1,                          \
 125                .name = (_name),                                        \
 126                .flags = (_flags),                                      \
 127        }
 128
 129#define DEFINE_RES_IO_NAMED(_start, _size, _name)                       \
 130        DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)
 131#define DEFINE_RES_IO(_start, _size)                                    \
 132        DEFINE_RES_IO_NAMED((_start), (_size), NULL)
 133
 134#define DEFINE_RES_MEM_NAMED(_start, _size, _name)                      \
 135        DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)
 136#define DEFINE_RES_MEM(_start, _size)                                   \
 137        DEFINE_RES_MEM_NAMED((_start), (_size), NULL)
 138
 139#define DEFINE_RES_IRQ_NAMED(_irq, _name)                               \
 140        DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)
 141#define DEFINE_RES_IRQ(_irq)                                            \
 142        DEFINE_RES_IRQ_NAMED((_irq), NULL)
 143
 144#define DEFINE_RES_DMA_NAMED(_dma, _name)                               \
 145        DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)
 146#define DEFINE_RES_DMA(_dma)                                            \
 147        DEFINE_RES_DMA_NAMED((_dma), NULL)
 148
 149/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
 150extern struct resource ioport_resource;
 151extern struct resource iomem_resource;
 152
 153extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
 154extern int request_resource(struct resource *root, struct resource *new);
 155extern int release_resource(struct resource *new);
 156void release_child_resources(struct resource *new);
 157extern void reserve_region_with_split(struct resource *root,
 158                             resource_size_t start, resource_size_t end,
 159                             const char *name);
 160extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
 161extern int insert_resource(struct resource *parent, struct resource *new);
 162extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
 163extern int remove_resource(struct resource *old);
 164extern void arch_remove_reservations(struct resource *avail);
 165extern int allocate_resource(struct resource *root, struct resource *new,
 166                             resource_size_t size, resource_size_t min,
 167                             resource_size_t max, resource_size_t align,
 168                             resource_size_t (*alignf)(void *,
 169                                                       const struct resource *,
 170                                                       resource_size_t,
 171                                                       resource_size_t),
 172                             void *alignf_data);
 173struct resource *lookup_resource(struct resource *root, resource_size_t start);
 174int adjust_resource(struct resource *res, resource_size_t start,
 175                    resource_size_t size);
 176resource_size_t resource_alignment(struct resource *res);
 177static inline resource_size_t resource_size(const struct resource *res)
 178{
 179        return res->end - res->start + 1;
 180}
 181static inline unsigned long resource_type(const struct resource *res)
 182{
 183        return res->flags & IORESOURCE_TYPE_BITS;
 184}
 185static inline unsigned long resource_ext_type(const struct resource *res)
 186{
 187        return res->flags & IORESOURCE_EXT_TYPE_BITS;
 188}
 189/* True iff r1 completely contains r2 */
 190static inline bool resource_contains(struct resource *r1, struct resource *r2)
 191{
 192        if (resource_type(r1) != resource_type(r2))
 193                return false;
 194        if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET)
 195                return false;
 196        return r1->start <= r2->start && r1->end >= r2->end;
 197}
 198
 199
 200/* Convenience shorthand with allocation */
 201#define request_region(start,n,name)            __request_region(&ioport_resource, (start), (n), (name), 0)
 202#define request_muxed_region(start,n,name)      __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED)
 203#define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl)
 204#define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0)
 205#define request_mem_region_exclusive(start,n,name) \
 206        __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE)
 207#define rename_region(region, newname) do { (region)->name = (newname); } while (0)
 208
 209extern struct resource * __request_region(struct resource *,
 210                                        resource_size_t start,
 211                                        resource_size_t n,
 212                                        const char *name, int flags);
 213
 214/* Compatibility cruft */
 215#define release_region(start,n) __release_region(&ioport_resource, (start), (n))
 216#define check_mem_region(start,n)       __check_region(&iomem_resource, (start), (n))
 217#define release_mem_region(start,n)     __release_region(&iomem_resource, (start), (n))
 218
 219extern int __check_region(struct resource *, resource_size_t, resource_size_t);
 220extern void __release_region(struct resource *, resource_size_t,
 221                                resource_size_t);
 222#ifdef CONFIG_MEMORY_HOTREMOVE
 223extern int release_mem_region_adjustable(struct resource *, resource_size_t,
 224                                resource_size_t);
 225#endif
 226
 227static inline int __deprecated check_region(resource_size_t s,
 228                                                resource_size_t n)
 229{
 230        return __check_region(&ioport_resource, s, n);
 231}
 232
 233/* Wrappers for managed devices */
 234struct device;
 235
 236extern int devm_request_resource(struct device *dev, struct resource *root,
 237                                 struct resource *new);
 238extern void devm_release_resource(struct device *dev, struct resource *new);
 239
 240#define devm_request_region(dev,start,n,name) \
 241        __devm_request_region(dev, &ioport_resource, (start), (n), (name))
 242#define devm_request_mem_region(dev,start,n,name) \
 243        __devm_request_region(dev, &iomem_resource, (start), (n), (name))
 244
 245extern struct resource * __devm_request_region(struct device *dev,
 246                                struct resource *parent, resource_size_t start,
 247                                resource_size_t n, const char *name);
 248
 249#define devm_release_region(dev, start, n) \
 250        __devm_release_region(dev, &ioport_resource, (start), (n))
 251#define devm_release_mem_region(dev, start, n) \
 252        __devm_release_region(dev, &iomem_resource, (start), (n))
 253
 254extern void __devm_release_region(struct device *dev, struct resource *parent,
 255                                  resource_size_t start, resource_size_t n);
 256extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size);
 257extern int iomem_is_exclusive(u64 addr);
 258
 259extern int
 260walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
 261                void *arg, int (*func)(unsigned long, unsigned long, void *));
 262extern int
 263walk_mem_res(u64 start, u64 end, void *arg,
 264             int (*func)(struct resource *, void *));
 265extern int
 266walk_system_ram_res(u64 start, u64 end, void *arg,
 267                    int (*func)(struct resource *, void *));
 268extern int
 269walk_iomem_res(char *name, unsigned long flags, u64 start, u64 end, void *arg,
 270               int (*func)(struct resource *, void *));
 271
 272/* True if any part of r1 overlaps r2 */
 273static inline bool resource_overlaps(struct resource *r1, struct resource *r2)
 274{
 275       return (r1->start <= r2->end && r1->end >= r2->start);
 276}
 277
 278
 279#endif /* __ASSEMBLY__ */
 280#endif  /* _LINUX_IOPORT_H */
 281