xref: /openbmc/phosphor-ipmi-flash/tools/pci.hpp (revision 2950c258)
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
53         configure(const ipmi_flash::PciConfigResponse& configResp) override{};
54 
55     std::size_t getDataLength() override
56     {
57         return dataLength;
58     }
59 
60   protected:
61     /**
62      * Finds the PCI device matching @a match and saves a reference to it in @a
63      * dev. Also maps the memory region described in BAR number @a bar to
64      * address @a addr,
65      */
66     PciAccessBridge(const struct pci_id_match* match, int bar,
67                     std::size_t dataOffset, std::size_t dataLength,
68                     const PciAccess* pci);
69 
70     struct pci_device* dev = nullptr;
71     std::uint8_t* addr = nullptr;
72     std::size_t size = 0;
73 
74   private:
75     std::size_t dataOffset;
76     std::size_t dataLength;
77 
78   protected:
79     const PciAccess* pci;
80 };
81 
82 class NuvotonPciBridge : public PciAccessBridge
83 {
84   public:
85     explicit NuvotonPciBridge(const PciAccess* pci) :
86         PciAccessBridge(&match, bar, dataOffset, dataLength, pci)
87     {
88         enableBridge();
89     }
90 
91     ~NuvotonPciBridge()
92     {
93         disableBridge();
94     }
95 
96   private:
97     static constexpr std::uint32_t vid = 0x1050;
98     static constexpr std::uint32_t did = 0x0750;
99     static constexpr int bar = 0;
100     static constexpr struct pci_id_match match
101     {
102         vid, did, PCI_MATCH_ANY, PCI_MATCH_ANY
103     };
104 
105     static constexpr pciaddr_t bridge = 0x04;
106     static constexpr std::uint8_t bridgeEnabled = 0x02;
107 
108     static constexpr std::size_t dataOffset = 0x0;
109     static constexpr std::size_t dataLength = 0x4000;
110 
111     void enableBridge();
112     void disableBridge();
113 };
114 
115 class AspeedPciBridge : public PciAccessBridge
116 {
117   public:
118     explicit AspeedPciBridge(const PciAccess* pci) :
119         PciAccessBridge(&match, bar, dataOffset, dataLength, pci)
120     {
121         enableBridge();
122     }
123 
124     ~AspeedPciBridge()
125     {
126         disableBridge();
127     }
128 
129     void configure(const ipmi_flash::PciConfigResponse& configResp) override;
130 
131   private:
132     static constexpr std::uint32_t vid = 0x1a03;
133     static constexpr std::uint32_t did = 0x2000;
134     static constexpr int bar = 1;
135     static constexpr struct pci_id_match match
136     {
137         vid, did, PCI_MATCH_ANY, PCI_MATCH_ANY
138     };
139 
140     static constexpr std::size_t config = 0x0f000;
141     static constexpr std::size_t bridge = 0x0f004;
142     static constexpr std::uint32_t bridgeEnabled = 0x1;
143 
144     static constexpr std::size_t dataOffset = 0x10000;
145     static constexpr std::size_t dataLength = 0x10000;
146 
147     void enableBridge();
148     void disableBridge();
149 };
150 
151 } // namespace host_tool
152