xref: /openbmc/phosphor-ipmi-flash/tools/pci.hpp (revision b487eb47)
1 /*
2  * Copyright 2020 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include "data.hpp"
20 #include "internal/sys.hpp"
21 #include "pciaccess.hpp"
22 
23 #include <linux/pci_regs.h>
24 
25 #include <stdplus/types.hpp>
26 
27 // Some versions of the linux/pci_regs.h header don't define this
28 #ifndef PCI_STD_NUM_BARS
29 #define PCI_STD_NUM_BARS 6
30 #endif // !PCI_STD_NUM_BARS
31 
32 namespace host_tool
33 {
34 
35 class PciBridgeIntf
36 {
37   public:
38     virtual ~PciBridgeIntf() = default;
39 
40     virtual void write(const stdplus::span<const std::uint8_t> data) = 0;
41     virtual void configure(const ipmi_flash::PciConfigResponse& config) = 0;
42 
43     virtual std::size_t getDataLength() = 0;
44 };
45 
46 class PciAccessBridge : public PciBridgeIntf
47 {
48   public:
49     virtual ~PciAccessBridge();
50 
51     virtual void write(const stdplus::span<const std::uint8_t> data) override;
52     virtual void configure(const ipmi_flash::PciConfigResponse&) override{};
53 
54     std::size_t getDataLength() override
55     {
56         return dataLength;
57     }
58 
59   protected:
60     /**
61      * Finds the PCI device matching @a match and saves a reference to it in @a
62      * dev. Also maps the memory region described in BAR number @a bar to
63      * address @a addr,
64      */
65     PciAccessBridge(const struct pci_id_match* match, int bar,
66                     std::size_t dataOffset, std::size_t dataLength,
67                     const PciAccess* pci);
68 
69     struct pci_device* dev = nullptr;
70     std::uint8_t* addr = nullptr;
71     std::size_t size = 0;
72 
73   private:
74     std::size_t dataOffset;
75     std::size_t dataLength;
76 
77   protected:
78     const PciAccess* pci;
79 };
80 
81 class NuvotonPciBridge : public PciAccessBridge
82 {
83   public:
84     explicit NuvotonPciBridge(const PciAccess* pciAccess,
85                               bool skipBridgeDisable = false) :
86         PciAccessBridge(&match, bar, dataOffset, dataLength, pciAccess),
87         skipBridgeDisable(skipBridgeDisable)
88     {
89         enableBridge();
90     }
91 
92     ~NuvotonPciBridge()
93     {
94         if (!skipBridgeDisable)
95             disableBridge();
96     }
97 
98   private:
99     static constexpr std::uint32_t vid = 0x1050;
100     static constexpr std::uint32_t did = 0x0750;
101     static constexpr int bar = 0;
102     static constexpr struct pci_id_match match
103     {
104         vid, did, PCI_MATCH_ANY, PCI_MATCH_ANY, 0, 0, 0
105     };
106 
107     static constexpr pciaddr_t bridge = 0x04;
108     static constexpr std::uint8_t bridgeEnabled = 0x02;
109 
110     static constexpr std::size_t dataOffset = 0x0;
111     static constexpr std::size_t dataLength = 0x4000;
112 
113     void enableBridge();
114     void disableBridge();
115 
116     bool skipBridgeDisable;
117 };
118 
119 class AspeedPciBridge : public PciAccessBridge
120 {
121   public:
122     explicit AspeedPciBridge(const PciAccess* pciAccess,
123                              bool skipBridgeDisable = false) :
124         PciAccessBridge(&match, bar, dataOffset, dataLength, pciAccess),
125         skipBridgeDisable(skipBridgeDisable)
126     {
127         enableBridge();
128     }
129 
130     ~AspeedPciBridge()
131     {
132         if (!skipBridgeDisable)
133             disableBridge();
134     }
135 
136     void configure(const ipmi_flash::PciConfigResponse& configResp) override;
137 
138   private:
139     static constexpr std::uint32_t vid = 0x1a03;
140     static constexpr std::uint32_t did = 0x2000;
141     static constexpr int bar = 1;
142     static constexpr struct pci_id_match match
143     {
144         vid, did, PCI_MATCH_ANY, PCI_MATCH_ANY, 0, 0, 0
145     };
146 
147     static constexpr std::size_t config = 0x0f000;
148     static constexpr std::size_t bridge = 0x0f004;
149     static constexpr std::uint32_t bridgeEnabled = 0x1;
150 
151     static constexpr std::size_t dataOffset = 0x10000;
152     static constexpr std::size_t dataLength = 0x10000;
153 
154     void enableBridge();
155     void disableBridge();
156 
157     bool skipBridgeDisable;
158 };
159 
160 } // namespace host_tool
161