7ab8065c23b842224915dfcd1c1a24a7924efb31
[coreboot.git] / src / include / device / resource.h
1 #ifndef RESOURCE_H
2 #define RESOURCE_H
3
4 #include <stdint.h>
5
6 #define IORESOURCE_BITS         0x000000ff      /* Bus-specific bits */
7
8 #define IORESOURCE_IO           0x00000100      /* Resource type */
9 #define IORESOURCE_MEM          0x00000200
10 #define IORESOURCE_IRQ          0x00000400
11 #define IORESOURCE_DRQ          0x00000800
12
13 #define IORESOURCE_PREFETCH     0x00001000      /* No side effects */
14 #define IORESOURCE_READONLY     0x00002000
15 #define IORESOURCE_CACHEABLE    0x00004000
16 #define IORESOURCE_RANGELENGTH  0x00008000
17 #define IORESOURCE_SHADOWABLE   0x00010000
18 #define IORESOURCE_BUS_HAS_VGA  0x00020000
19 #define IORESOURCE_SUBTRACTIVE  0x00040000      /* This resource filters all of the unclaimed transactions
20                                                  * to the bus below.
21                                                  */
22 #define IORESOURCE_STORED       0x20000000      /* The IO resource assignment has been stored in the device */
23 #define IORESOURCE_ASSIGNED     0x40000000      /* An IO resource that has been assigned a value */
24 #define IORESOURCE_FIXED        0x80000000      /* An IO resource the allocator must not change */
25
26 /* PCI specific resource bits */
27 #define IORESOURCE_PCI64        (1<<0)  /* 64bit long pci resource */
28 #define IORESOURCE_PCI_BRIDGE   (1<<1)  /* A bridge pci resource */
29
30 /* ISA PnP IRQ specific bits (IORESOURCE_BITS) */
31 #define IORESOURCE_IRQ_HIGHEDGE         (1<<0)
32 #define IORESOURCE_IRQ_LOWEDGE          (1<<1)
33 #define IORESOURCE_IRQ_HIGHLEVEL        (1<<2)
34 #define IORESOURCE_IRQ_LOWLEVEL         (1<<3)
35
36 /* ISA PnP DMA specific bits (IORESOURCE_BITS) */
37 #define IORESOURCE_DMA_TYPE_MASK        (3<<0)
38 #define IORESOURCE_DMA_8BIT             (0<<0)
39 #define IORESOURCE_DMA_8AND16BIT        (1<<0)
40 #define IORESOURCE_DMA_16BIT            (2<<0)
41
42 #define IORESOURCE_DMA_MASTER           (1<<2)
43 #define IORESOURCE_DMA_BYTE             (1<<3)
44 #define IORESOURCE_DMA_WORD             (1<<4)
45
46 #define IORESOURCE_DMA_SPEED_MASK       (3<<6)
47 #define IORESOURCE_DMA_COMPATIBLE       (0<<6)
48 #define IORESOURCE_DMA_TYPEA            (1<<6)
49 #define IORESOURCE_DMA_TYPEB            (2<<6)
50 #define IORESOURCE_DMA_TYPEF            (3<<6)
51
52
53 /* ISA PnP memory I/O specific bits (IORESOURCE_BITS) */
54 #define IORESOURCE_MEM_WRITEABLE        (1<<0)  /* dup: IORESOURCE_READONLY */
55 #define IORESOURCE_MEM_CACHEABLE        (1<<1)  /* dup: IORESOURCE_CACHEABLE */
56 #define IORESOURCE_MEM_RANGELENGTH      (1<<2)  /* dup: IORESOURCE_RANGELENGTH */
57 #define IORESOURCE_MEM_TYPE_MASK        (3<<3)
58 #define IORESOURCE_MEM_8BIT             (0<<3)
59 #define IORESOURCE_MEM_16BIT            (1<<3)
60 #define IORESOURCE_MEM_8AND16BIT        (2<<3)
61 #define IORESOURCE_MEM_SHADOWABLE       (1<<5)  /* dup: IORESOURCE_SHADOWABLE */
62 #define IORESOURCE_MEM_EXPANSIONROM     (1<<6)
63
64
65 typedef uint64_t resource_t;
66 struct resource {
67         resource_t base;        /* Base address of the resource */
68         resource_t size;        /* Size of the resource */
69         resource_t limit;       /* Largest valid value base + size -1 */
70         unsigned long flags;    /* Descriptions of the kind of resource */
71         unsigned long index;    /* Bus specific per device resource id */
72         unsigned char align;    /* Required alignment (log 2) of the resource */
73         unsigned char gran;     /* Granularity (log 2) of the resource */
74         /* Alignment must be >= the granularity of the resource */
75 };
76
77 /* Macros to generate index values for subtractive resources */
78 #define IOINDEX_SUBTRACTIVE(IDX,LINK) (0x10000000 + ((IDX) << 8) + LINK)
79 #define IOINDEX_SUBTRACTIVE_LINK(IDX) (IDX & 0xff)
80
81 /* Generic resource helper functions */
82 struct device;
83 extern void compact_resources(struct device * dev);
84 extern struct resource *probe_resource(struct device *dev, unsigned index);
85 extern struct resource *new_resource(struct device * dev, unsigned index);
86 extern struct resource *find_resource(struct device * dev, unsigned index);
87 extern resource_t resource_end(struct resource *resource);
88 extern resource_t resource_max(struct resource *resource);
89 extern void report_resource_stored(struct device * dev, struct resource *resource, const char *comment);
90
91 #endif /* RESOURCE_H */