xref: /openbmc/smbios-mdr/include/dimm.hpp (revision 21cb0e87)
1 /*
2 // Copyright (c) 2018 Intel Corporation
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 #include "smbios_mdrv2.hpp"
19 
20 #include <xyz/openbmc_project/Association/Definitions/server.hpp>
21 #include <xyz/openbmc_project/Inventory/Connector/Slot/server.hpp>
22 #include <xyz/openbmc_project/Inventory/Decorator/Asset/server.hpp>
23 #include <xyz/openbmc_project/Inventory/Decorator/LocationCode/server.hpp>
24 #include <xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation/server.hpp>
25 #include <xyz/openbmc_project/Inventory/Item/Dimm/server.hpp>
26 #include <xyz/openbmc_project/Inventory/Item/server.hpp>
27 #include <xyz/openbmc_project/State/Decorator/OperationalStatus/server.hpp>
28 
29 namespace phosphor
30 {
31 
32 namespace smbios
33 {
34 
35 using DeviceType =
36     sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::DeviceType;
37 
38 using EccType =
39     sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::Ecc;
40 
41 using MemoryTechType =
42     sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::MemoryTech;
43 
44 class Dimm :
45     sdbusplus::server::object_t<
46         sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm>,
47     sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
48                                     inventory::item::dimm::MemoryLocation>,
49     sdbusplus::server::object_t<
50         sdbusplus::server::xyz::openbmc_project::inventory::decorator::Asset>,
51     sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
52                                     inventory::decorator::LocationCode>,
53     sdbusplus::server::object_t<
54         sdbusplus::server::xyz::openbmc_project::inventory::connector::Slot>,
55     sdbusplus::server::object_t<
56         sdbusplus::server::xyz::openbmc_project::inventory::Item>,
57     sdbusplus::server::object_t<
58         sdbusplus::server::xyz::openbmc_project::association::Definitions>,
59     sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::state::
60                                     decorator::OperationalStatus>
61 {
62   public:
63     Dimm() = delete;
64     ~Dimm() = default;
65     Dimm(const Dimm&) = delete;
66     Dimm& operator=(const Dimm&) = delete;
67     Dimm(Dimm&&) = default;
68     Dimm& operator=(Dimm&&) = default;
69 
Dimm(sdbusplus::bus_t & bus,const std::string & objPath,const uint8_t & dimmId,uint8_t * smbiosTableStorage,const std::string & motherboard)70     Dimm(sdbusplus::bus_t& bus, const std::string& objPath,
71          const uint8_t& dimmId, uint8_t* smbiosTableStorage,
72          const std::string& motherboard) :
73 
74         sdbusplus::server::object_t<
75             sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm>(
76             bus, objPath.c_str()),
77         sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
78                                         inventory::item::dimm::MemoryLocation>(
79             bus, objPath.c_str()),
80         sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
81                                         inventory::decorator::Asset>(
82             bus, objPath.c_str()),
83         sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
84                                         inventory::decorator::LocationCode>(
85             bus, objPath.c_str()),
86         sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
87                                         inventory::connector::Slot>(
88             bus, objPath.c_str()),
89         sdbusplus::server::object_t<
90             sdbusplus::server::xyz::openbmc_project::inventory::Item>(
91             bus, objPath.c_str()),
92         sdbusplus::server::object_t<
93             sdbusplus::server::xyz::openbmc_project::association::Definitions>(
94             bus, objPath.c_str()),
95         sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::
96                                         state::decorator::OperationalStatus>(
97             bus, objPath.c_str()),
98         dimmNum(dimmId)
99     {
100         memoryInfoUpdate(smbiosTableStorage, motherboard);
101     }
102 
103     void memoryInfoUpdate(uint8_t* smbiosTableStorage,
104                           const std::string& motherboard);
105 
106     uint16_t memoryDataWidth(uint16_t value) override;
107     uint16_t memoryTotalWidth(uint16_t value) override;
108     size_t memorySizeInKB(size_t value) override;
109     std::string memoryDeviceLocator(std::string value) override;
110     DeviceType memoryType(DeviceType value) override;
111     std::string memoryTypeDetail(std::string value) override;
112     uint16_t maxMemorySpeedInMhz(uint16_t value) override;
113     std::string manufacturer(std::string value) override;
114     bool present(bool value) override;
115     std::string serialNumber(std::string value) override;
116     std::string partNumber(std::string value) override;
117     std::string locationCode(std::string value) override;
118     size_t memoryAttributes(size_t value) override;
119     MemoryTechType memoryMedia(MemoryTechType value) override;
120     uint8_t slot(uint8_t value) override;
121     uint8_t socket(uint8_t value) override;
122     uint16_t memoryConfiguredSpeedInMhz(uint16_t value) override;
123     bool functional(bool value) override;
124     EccType ecc(EccType value) override;
125 
126   private:
127     uint8_t dimmNum;
128 
129     uint8_t* storage;
130 
131     std::string motherboardPath;
132 
133     void dimmSize(const uint16_t size);
134     void dimmSizeExt(const uint32_t size);
135     void dimmDeviceLocator(const uint8_t bankLocatorPositionNum,
136                            const uint8_t deviceLocatorPositionNum,
137                            const uint8_t structLen, uint8_t* dataIn);
138     void dimmType(const uint8_t type);
139     void dimmTypeDetail(const uint16_t detail);
140     void dimmManufacturer(const uint8_t positionNum, const uint8_t structLen,
141                           uint8_t* dataIn);
142     void dimmMedia(const uint8_t type);
143     void dimmSerialNum(const uint8_t positionNum, const uint8_t structLen,
144                        uint8_t* dataIn);
145     void dimmPartNum(const uint8_t positionNum, const uint8_t structLen,
146                      uint8_t* dataIn);
147     void updateEccType(uint16_t exPhyArrayHandle);
148 };
149 
150 struct MemoryInfo
151 {
152     uint8_t type;
153     uint8_t length;
154     uint16_t handle;
155     uint16_t phyArrayHandle;
156     uint16_t errInfoHandle;
157     uint16_t totalWidth;
158     uint16_t dataWidth;
159     uint16_t size;
160     uint8_t formFactor;
161     uint8_t deviceSet;
162     uint8_t deviceLocator;
163     uint8_t bankLocator;
164     uint8_t memoryType;
165     uint16_t typeDetail;
166     uint16_t speed;
167     uint8_t manufacturer;
168     uint8_t serialNum;
169     uint8_t assetTag;
170     uint8_t partNum;
171     uint8_t attributes;
172     uint32_t extendedSize;
173     uint16_t confClockSpeed;
174     uint16_t minimumVoltage;
175     uint16_t maximumVoltage;
176     uint16_t configuredVoltage;
177     uint8_t memoryTechnology;
178     uint16_t memoryOperatingModeCap;
179     uint8_t firwareVersion;
180     uint16_t modelManufId;
181     uint16_t modelProdId;
182     uint16_t memSubConManufId;
183     uint16_t memSubConProdId;
184     uint64_t nvSize;
185     uint64_t volatileSize;
186     uint64_t cacheSize;
187     uint64_t logicalSize;
188 } __attribute__((packed));
189 
190 /**
191  * @brief Struct to represent SMBIOS 3.2 type-16 (Physical Memory Array) data.
192  */
193 struct PhysicalMemoryArrayInfo
194 {
195     uint8_t type;
196     uint8_t length;
197     uint16_t handle;
198     uint8_t location;
199     uint8_t use;
200     uint8_t memoryErrorCorrection;
201     uint32_t maximumCapacity;
202     uint16_t memoryErrorInformationHandle;
203     uint16_t numberOfMemoryDevices;
204     uint64_t extendedMaximumCapacity;
205 } __attribute__((packed));
206 static_assert(sizeof(PhysicalMemoryArrayInfo) == 23,
207               "Size of PhysicalMemoryArrayInfo struct is incorrect.");
208 
209 const std::map<uint8_t, DeviceType> dimmTypeTable = {
210     {0x1, DeviceType::Other},         {0x2, DeviceType::Unknown},
211     {0x3, DeviceType::DRAM},          {0x4, DeviceType::EDRAM},
212     {0x5, DeviceType::VRAM},          {0x6, DeviceType::SRAM},
213     {0x7, DeviceType::RAM},           {0x8, DeviceType::ROM},
214     {0x9, DeviceType::FLASH},         {0xa, DeviceType::EEPROM},
215     {0xb, DeviceType::FEPROM},        {0xc, DeviceType::EPROM},
216     {0xd, DeviceType::CDRAM},         {0xe, DeviceType::ThreeDRAM},
217     {0xf, DeviceType::SDRAM},         {0x10, DeviceType::DDR_SGRAM},
218     {0x11, DeviceType::RDRAM},        {0x12, DeviceType::DDR},
219     {0x13, DeviceType::DDR2},         {0x14, DeviceType::DDR2_SDRAM_FB_DIMM},
220     {0x18, DeviceType::DDR3},         {0x19, DeviceType::FBD2},
221     {0x1a, DeviceType::DDR4},         {0x1b, DeviceType::LPDDR_SDRAM},
222     {0x1c, DeviceType::LPDDR2_SDRAM}, {0x1d, DeviceType::LPDDR3_SDRAM},
223     {0x1e, DeviceType::LPDDR4_SDRAM}, {0x1f, DeviceType::Logical},
224     {0x20, DeviceType::HBM},          {0x21, DeviceType::HBM2},
225     {0x22, DeviceType::DDR5},         {0x23, DeviceType::LPDDR5_SDRAM}};
226 
227 const std::array<std::string, 16> detailTable{
228     "Reserved",      "Other",         "Unknown",     "Fast-paged",
229     "Static column", "Pseudo-static", "RAMBUS",      "Synchronous",
230     "CMOS",          "EDO",           "Window DRAM", "Cache DRAM",
231     "Non-volatile",  "Registered",    "Unbuffered",  "LRDIMM"};
232 
233 /**
234  * @brief Map SMBIOS 3.2 Memory Array Error Correction Types to
235  * xyz.openbmc_project.Inventory.Item.Dimm.Ecc types.
236  *
237  * SMBIOS 3.2 Memory Array Error Correction Types 'Unknown', 'None', 'CRC' are
238  * mapped to EccType::NoECC since the DBUs interface does not support those
239  * representations.
240  */
241 const std::map<uint8_t, EccType> dimmEccTypeMap = {
242     {0x1, EccType::NoECC},        {0x2, EccType::NoECC},
243     {0x3, EccType::NoECC},        {0x4, EccType::AddressParity},
244     {0x5, EccType::SingleBitECC}, {0x6, EccType::MultiBitECC},
245     {0x7, EccType::NoECC}};
246 
247 const std::map<uint8_t, MemoryTechType> dimmMemoryTechTypeMap = {
248     {0x1, MemoryTechType::Other},      {0x2, MemoryTechType::Unknown},
249     {0x3, MemoryTechType::DRAM},       {0x4, MemoryTechType::NVDIMM_N},
250     {0x5, MemoryTechType::NVDIMM_F},   {0x6, MemoryTechType::NVDIMM_P},
251     {0x7, MemoryTechType::IntelOptane}};
252 
253 } // namespace smbios
254 
255 } // namespace phosphor
256