53da0e17560250fd59682c14433917ec967fea20
[coreboot.git] / payloads / libpayload / include / pci / pci.h
1 /*\r
2  * This file is part of the libpayload project.\r
3  *\r
4  * Copyright (C) 2010 coresystems GmbH\r
5  *\r
6  * Redistribution and use in source and binary forms, with or without\r
7  * modification, are permitted provided that the following conditions\r
8  * are met:\r
9  * 1. Redistributions of source code must retain the above copyright\r
10  *    notice, this list of conditions and the following disclaimer.\r
11  * 2. Redistributions in binary form must reproduce the above copyright\r
12  *    notice, this list of conditions and the following disclaimer in the\r
13  *    documentation and/or other materials provided with the distribution.\r
14  * 3. The name of the author may not be used to endorse or promote products\r
15  *    derived from this software without specific prior written permission.\r
16  *\r
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND\r
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE\r
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
27  * SUCH DAMAGE.\r
28  */\r
29 \r
30 #ifndef _PCI_PCI_H\r
31 #define _PCI_PCI_H\r
32 \r
33 /* we implement at least this version */\r
34 #define PCI_LIB_VERSION 0x020200\r
35 \r
36 #include <pci.h>\r
37 \r
38 #define PCI_CLASS_DEVICE        REG_CLASS_DEV\r
39 #define PCI_SUBSYSTEM_VENDOR_ID REG_SUBSYS_VENDOR_ID\r
40 #define PCI_SUBSYSTEM_ID        REG_SUBSYS_ID\r
41 \r
42 #define PCI_COMMAND             REG_COMMAND\r
43 #define PCI_COMMAND_IO          REG_COMMAND_IO\r
44 #define PCI_COMMAND_MEMORY      REG_COMMAND_MEM\r
45 #define PCI_COMMAND_MASTER      REG_COMMAND_BM\r
46 \r
47 #define PCI_HEADER_TYPE         REG_HEADER_TYPE\r
48 #define PCI_HEADER_TYPE_NORMAL  HEADER_TYPE_NORMAL\r
49 #define PCI_HEADER_TYPE_BRIDGE  HEADER_TYPE_BRIDGE\r
50 #define PCI_HEADER_TYPE_CARDBUS HEADER_TYPE_CARDBUS\r
51 \r
52 #define PCI_BASE_ADDRESS_0      0x10\r
53 #define PCI_BASE_ADDRESS_1      0x14\r
54 #define PCI_BASE_ADDRESS_2      0x18\r
55 #define PCI_BASE_ADDRESS_3      0x1c\r
56 #define PCI_BASE_ADDRESS_4      0x20\r
57 #define PCI_BASE_ADDRESS_5      0x24\r
58 #define PCI_BASE_ADDRESS_SPACE  1 // mask\r
59 #define PCI_BASE_ADDRESS_SPACE_IO       1\r
60 #define PCI_BASE_ADDRESS_SPACE_MEM      0\r
61 #define PCI_BASE_ADDRESS_IO_MASK        ~0xf\r
62 #define PCI_BASE_ADDRESS_MEM_MASK       ~0x3\r
63 \r
64 #define PCI_ROM_ADDRESS         0x30\r
65 #define PCI_ROM_ADDRESS1        0x38 // on bridges\r
66 #define PCI_ROM_ADDRESS_MASK    ~0x7ff\r
67 \r
68 struct pci_dev {\r
69         u16 domain;\r
70         u8 bus, dev, func;\r
71         u16 vendor_id, device_id;\r
72         struct pci_dev *next;\r
73 };\r
74 \r
75 /*\r
76  * values to match devices against.\r
77  * "-1" means "don't care", everything else requires an exact match\r
78  */\r
79 struct pci_filter {\r
80         int domain, bus, dev, func;\r
81         int vendor, device;\r
82         struct pci_dev *devices;\r
83 };\r
84 \r
85 struct pci_access {\r
86         struct pci_dev *devices;\r
87 };\r
88 \r
89 u8 pci_read_byte(struct pci_dev *dev, int pos);\r
90 u16 pci_read_word(struct pci_dev *dev, int pos);\r
91 u32 pci_read_long(struct pci_dev *dev, int pos);\r
92 \r
93 int pci_write_byte(struct pci_dev *dev, int pos, u8 data);\r
94 int pci_write_word(struct pci_dev *dev, int pos, u16 data);\r
95 int pci_write_long(struct pci_dev *dev, int pos, u32 data);\r
96 \r
97 struct pci_access *pci_alloc(void);\r
98 void pci_init(struct pci_access*);\r
99 void pci_cleanup(struct pci_access*);\r
100 char *pci_filter_parse_slot(struct pci_filter*, const char*);\r
101 int pci_filter_match(struct pci_filter*, struct pci_dev*);\r
102 void pci_filter_init(struct pci_access*, struct pci_filter*);\r
103 void pci_scan_bus(struct pci_access*);\r
104 struct pci_dev *pci_get_dev(struct pci_access*, u16, u8, u8, u8);\r
105 \r
106 #endif\r