├── .clang-format ├── .gitignore ├── LICENSE ├── OWNERS ├── README.md ├── fru_area.cpp ├── fru_area.hpp ├── frup.cpp ├── frup.hpp ├── meson.build ├── meson.options ├── readeeprom.cpp ├── scripts ├── example.yaml ├── extra-properties-example.yaml ├── extra-properties.cpp.mako ├── extra-properties.py ├── fru_gen.py └── writefru.cpp.mako ├── strgfnhandler.cpp ├── subprojects ├── CLI11.wrap ├── phosphor-host-ipmid.wrap ├── phosphor-logging.wrap └── sdbusplus.wrap ├── types.hpp ├── writefrudata.cpp └── writefrudata.hpp /.clang-format: -------------------------------------------------------------------------------- 1 | --- 2 | Language: Cpp 3 | # BasedOnStyle: LLVM 4 | AccessModifierOffset: -2 5 | AlignAfterOpenBracket: Align 6 | AlignConsecutiveAssignments: false 7 | AlignConsecutiveDeclarations: false 8 | AlignEscapedNewlines: Right 9 | AlignOperands: Align 10 | AlignTrailingComments: 11 | Kind: Always 12 | OverEmptyLines: 1 13 | AllowAllParametersOfDeclarationOnNextLine: true 14 | AllowShortBlocksOnASingleLine: Empty 15 | AllowShortCaseLabelsOnASingleLine: false 16 | AllowShortFunctionsOnASingleLine: Empty 17 | AllowShortIfStatementsOnASingleLine: Never 18 | AllowShortLambdasOnASingleLine: true 19 | AllowShortLoopsOnASingleLine: false 20 | AlwaysBreakBeforeMultilineStrings: false 21 | BinPackArguments: true 22 | BinPackParameters: true 23 | BitFieldColonSpacing: None 24 | BraceWrapping: 25 | AfterCaseLabel: true 26 | AfterClass: true 27 | AfterControlStatement: true 28 | AfterEnum: true 29 | AfterExternBlock: true 30 | AfterFunction: true 31 | AfterNamespace: true 32 | AfterObjCDeclaration: true 33 | AfterStruct: true 34 | AfterUnion: true 35 | BeforeCatch: true 36 | BeforeElse: true 37 | BeforeLambdaBody: false 38 | BeforeWhile: false 39 | IndentBraces: false 40 | SplitEmptyFunction: false 41 | SplitEmptyRecord: false 42 | SplitEmptyNamespace: false 43 | BreakAfterAttributes: Never 44 | BreakAfterReturnType: Automatic 45 | BreakBeforeBinaryOperators: None 46 | BreakBeforeBraces: Custom 47 | BreakBeforeTernaryOperators: true 48 | BreakConstructorInitializers: AfterColon 49 | BreakInheritanceList: AfterColon 50 | BreakStringLiterals: false 51 | BreakTemplateDeclarations: Yes 52 | ColumnLimit: 80 53 | CommentPragmas: '^ IWYU pragma:' 54 | CompactNamespaces: false 55 | ConstructorInitializerIndentWidth: 4 56 | ContinuationIndentWidth: 4 57 | Cpp11BracedListStyle: true 58 | DerivePointerAlignment: false 59 | DisableFormat: false 60 | FixNamespaceComments: true 61 | ForEachMacros: 62 | - foreach 63 | - Q_FOREACH 64 | - BOOST_FOREACH 65 | IncludeBlocks: Regroup 66 | IncludeCategories: 67 | - Regex: '^[<"](gtest|gmock)' 68 | Priority: 7 69 | - Regex: '^"config.h"' 70 | Priority: -1 71 | - Regex: '^".*\.h"' 72 | Priority: 1 73 | - Regex: '^".*\.hpp"' 74 | Priority: 2 75 | - Regex: '^<.*\.h>' 76 | Priority: 3 77 | - Regex: '^<.*\.hpp>' 78 | Priority: 4 79 | - Regex: '^<.*' 80 | Priority: 5 81 | - Regex: '.*' 82 | Priority: 6 83 | IndentCaseLabels: true 84 | IndentExternBlock: NoIndent 85 | IndentRequiresClause: true 86 | IndentWidth: 4 87 | IndentWrappedFunctionNames: true 88 | InsertNewlineAtEOF: true 89 | KeepEmptyLinesAtTheStartOfBlocks: false 90 | LambdaBodyIndentation: Signature 91 | LineEnding: LF 92 | MacroBlockBegin: '' 93 | MacroBlockEnd: '' 94 | MaxEmptyLinesToKeep: 1 95 | NamespaceIndentation: None 96 | ObjCBlockIndentWidth: 2 97 | ObjCSpaceAfterProperty: false 98 | ObjCSpaceBeforeProtocolList: true 99 | PackConstructorInitializers: BinPack 100 | PenaltyBreakAssignment: 25 101 | PenaltyBreakBeforeFirstCallParameter: 50 102 | PenaltyBreakComment: 300 103 | PenaltyBreakFirstLessLess: 120 104 | PenaltyBreakString: 1000 105 | PenaltyBreakTemplateDeclaration: 10 106 | PenaltyExcessCharacter: 1000000 107 | PenaltyReturnTypeOnItsOwnLine: 150 108 | PenaltyIndentedWhitespace: 1 109 | PointerAlignment: Left 110 | QualifierAlignment: Left 111 | ReferenceAlignment: Left 112 | ReflowComments: true 113 | RequiresClausePosition: OwnLine 114 | RequiresExpressionIndentation: Keyword 115 | SortIncludes: CaseSensitive 116 | SortUsingDeclarations: true 117 | SpaceAfterCStyleCast: false 118 | SpaceAfterTemplateKeyword: true 119 | SpaceBeforeAssignmentOperators: true 120 | SpaceBeforeCpp11BracedList: false 121 | SpaceBeforeCtorInitializerColon: true 122 | SpaceBeforeInheritanceColon: true 123 | SpaceBeforeParens: ControlStatements 124 | SpaceBeforeRangeBasedForLoopColon: true 125 | SpaceInEmptyParentheses: false 126 | SpacesBeforeTrailingComments: 1 127 | SpacesInAngles: Never 128 | SpacesInContainerLiterals: true 129 | SpacesInCStyleCastParentheses: false 130 | SpacesInParentheses: false 131 | SpacesInSquareBrackets: false 132 | Standard: Latest 133 | TabWidth: 4 134 | UseTab: Never 135 | ... 136 | 137 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build*/ 2 | subprojects/* 3 | !subprojects/*.wrap 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /OWNERS: -------------------------------------------------------------------------------- 1 | # OWNERS 2 | # ------ 3 | # 4 | # The OWNERS file maintains the list of individuals responsible for various 5 | # parts of this repository, including code review and approval. We use the 6 | # Gerrit 'owners' plugin, which consumes this file, along with some extra 7 | # keywords for our own purposes and tooling. 8 | # 9 | # For details on the configuration used by 'owners' see: 10 | # https://gerrit.googlesource.com/plugins/owners/+/refs/heads/master/owners/src/main/resources/Documentation/config.md 11 | # 12 | # An OWNERS file must be in the root of a repository but may also be present 13 | # in any subdirectory. The contents of the subdirectory OWNERS file are 14 | # combined with parent directories unless 'inherit: false' is set. 15 | # 16 | # The owners file is YAML and has [up to] 4 top-level keywords. 17 | # * owners: A list of individuals who have approval authority on the 18 | # repository. 19 | # 20 | # * reviewers: A list of individuals who have requested review notification 21 | # on the repository. 22 | # 23 | # * matchers: A list of specific file/path matchers for granular 'owners' and 24 | # 'reviewers'. See 'owners' plugin documentation. 25 | # 26 | # * openbmc: A list of openbmc-specific meta-data about owners and reviewers. 27 | # - name: preferred name of the individual. 28 | # - email: preferred email address of the individual. 29 | # - discord: Discord nickname of the individual. 30 | # 31 | # It is expected that these 4 sections will be listed in the order above and 32 | # data within them will be kept sorted. 33 | 34 | owners: 35 | - patrick@stwcx.xyz 36 | 37 | reviewers: 38 | - ratankgupta31@gmail.com 39 | 40 | matchers: 41 | 42 | openbmc: 43 | - name: Patrick Williams 44 | email: patrick@stwcx.xyz 45 | discord: stwcx 46 | - name: Ratan Gupta 47 | email: ratankgupta31@gmail.com 48 | discord: rgupta 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ipmi-fru-parser 2 | 3 | ## Building 4 | 5 | To build this package, do the following steps: 6 | 7 | ```sh 8 | meson setup builddir 9 | ninja -C builddir 10 | ``` 11 | -------------------------------------------------------------------------------- /fru_area.cpp: -------------------------------------------------------------------------------- 1 | #include "fru_area.hpp" 2 | 3 | #include "frup.hpp" 4 | 5 | #include 6 | 7 | #include 8 | #include 9 | 10 | using namespace phosphor::logging; 11 | 12 | IPMIFruArea::IPMIFruArea(const uint8_t fruID, const ipmi_fru_area_type type, 13 | bool bmcOnlyFru) : 14 | fruID(fruID), type(type), bmcOnlyFru(bmcOnlyFru) 15 | { 16 | if (type == IPMI_FRU_AREA_INTERNAL_USE) 17 | { 18 | name = "INTERNAL_"; 19 | } 20 | else if (type == IPMI_FRU_AREA_CHASSIS_INFO) 21 | { 22 | name = "CHASSIS_"; 23 | } 24 | else if (type == IPMI_FRU_AREA_BOARD_INFO) 25 | { 26 | name = "BOARD_"; 27 | } 28 | else if (type == IPMI_FRU_AREA_PRODUCT_INFO) 29 | { 30 | name = "PRODUCT_"; 31 | } 32 | else if (type == IPMI_FRU_AREA_MULTI_RECORD) 33 | { 34 | name = "MULTI_"; 35 | } 36 | else 37 | { 38 | name = IPMI_FRU_AREA_TYPE_MAX; 39 | log("Invalid Area", entry("TYPE=%d", type)); 40 | } 41 | } 42 | 43 | void IPMIFruArea::setData(const uint8_t* value, const size_t length) 44 | { 45 | data.reserve(length); // pre-allocate the space. 46 | data.insert(data.begin(), value, value + length); 47 | } 48 | -------------------------------------------------------------------------------- /fru_area.hpp: -------------------------------------------------------------------------------- 1 | #ifndef __IPMI_FRU_AREA_H__ 2 | #define __IPMI_FRU_AREA_H__ 3 | 4 | #include "frup.hpp" 5 | #include "writefrudata.hpp" 6 | 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | using std::uint8_t; 13 | 14 | /** 15 | * IPMIFruArea represents a piece of a FRU that is accessible over IPMI. 16 | */ 17 | class IPMIFruArea 18 | { 19 | public: 20 | IPMIFruArea() = delete; 21 | ~IPMIFruArea() = default; 22 | 23 | /** 24 | * Construct an IPMIFruArea. 25 | * 26 | * @param[in] fruID - FRU identifier value 27 | * @param[in] type - the type of FRU area. 28 | * @param[in] bmcOnlyFru - Is this FRU only accessible via the BMC 29 | */ 30 | IPMIFruArea(const uint8_t fruID, const ipmi_fru_area_type type, 31 | bool bmcOnlyFru = false); 32 | 33 | /** 34 | * Set whether the FRU is present. 35 | * 36 | * @param[in] present - True if present. 37 | */ 38 | inline void setPresent(const bool present) 39 | { 40 | isPresent = present; 41 | } 42 | 43 | /** 44 | * Retrieves the FRU's ID. 45 | * 46 | * @return the FRU ID. 47 | */ 48 | uint8_t getFruID() const 49 | { 50 | return fruID; 51 | } 52 | 53 | /** 54 | * Returns the length of the FRU data. 55 | * 56 | * @return the number of bytes. 57 | */ 58 | size_t getLength() const 59 | { 60 | return data.size(); 61 | } 62 | 63 | /** 64 | * Returns the type of the current FRU area. 65 | * 66 | * @return the type of FRU area 67 | */ 68 | ipmi_fru_area_type getType() const 69 | { 70 | return type; 71 | } 72 | 73 | /** 74 | * Returns the FRU area name. 75 | * 76 | * @return the FRU area name 77 | */ 78 | const char* getName() const 79 | { 80 | return name.c_str(); 81 | } 82 | 83 | /** 84 | * Returns the data portion. 85 | * 86 | * @return pointer to data 87 | */ 88 | inline const uint8_t* getData() const 89 | { 90 | return data.data(); 91 | } 92 | 93 | /** 94 | * Accepts a pointer to data and sets it in the object. 95 | * 96 | * @param[in] value - The data to copy into the FRU area 97 | * @param[in] length - the number of bytes value points to 98 | */ 99 | void setData(const uint8_t* value, const size_t length); 100 | 101 | private: 102 | // Unique way of identifying a FRU 103 | uint8_t fruID = 0; 104 | 105 | // Type of the FRU matching offsets in common header 106 | ipmi_fru_area_type type = IPMI_FRU_AREA_INTERNAL_USE; 107 | 108 | // Name of the FRU area. ( BOARD/CHASSIS/PRODUCT ) 109 | std::string name; 110 | 111 | // Special bit for BMC readable eeprom only. 112 | bool bmcOnlyFru = false; 113 | 114 | // If a FRU is physically present. 115 | bool isPresent = false; 116 | 117 | // Whether a particular area is valid ? 118 | bool isValid = false; 119 | 120 | // Actual area data. 121 | std::vector data; 122 | }; 123 | 124 | #endif 125 | -------------------------------------------------------------------------------- /frup.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2003-2014 FreeIPMI Core Team 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | * 17 | */ 18 | /*****************************************************************************\ 19 | * Copyright (C) 2007-2014 Lawrence Livermore National Security, LLC. 20 | * Copyright (C) 2007 The Regents of the University of California. 21 | * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). 22 | * Written by Albert Chu 23 | * UCRL-CODE-232183 24 | * 25 | * This file is part of Ipmi-fru, a tool used for retrieving 26 | * motherboard field replaceable unit (FRU) information. For details, 27 | * see http://www.llnl.gov/linux/. 28 | * 29 | * Ipmi-fru is free software; you can redistribute it and/or modify 30 | * it under the terms of the GNU General Public License as published by the 31 | * Free Software Foundation; either version 3 of the License, or (at your 32 | * option) any later version. 33 | * 34 | * Ipmi-fru is distributed in the hope that it will be useful, but 35 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 36 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 37 | * for more details. 38 | * 39 | * You should have received a copy of the GNU General Public License along 40 | * with Ipmi-fru. If not, see . 41 | \*****************************************************************************/ 42 | #include "frup.hpp" 43 | 44 | #include 45 | #include 46 | #include 47 | #include 48 | #include 49 | #include 50 | #include 51 | 52 | #define TEXTSTR(a) #a 53 | #define ASSERT(x) \ 54 | do \ 55 | { \ 56 | if (0 == (x)) \ 57 | { \ 58 | fprintf(stderr, \ 59 | "Assertion failed: %s, " \ 60 | "%d at \'%s\'\n", \ 61 | __FILE__, __LINE__, TEXTSTR(a)); \ 62 | return -1; \ 63 | } \ 64 | } while (0) 65 | 66 | #define IPMI_FRU_AREA_TYPE_LENGTH_FIELD_MAX 512 67 | #define IPMI_FRU_SENTINEL_VALUE 0xC1 68 | #define IPMI_FRU_TYPE_LENGTH_TYPE_CODE_MASK 0xC0 69 | #define IPMI_FRU_TYPE_LENGTH_TYPE_CODE_SHIFT 0x06 70 | #define IPMI_FRU_TYPE_LENGTH_NUMBER_OF_DATA_BYTES_MASK 0x3F 71 | #define IPMI_FRU_TYPE_LENGTH_TYPE_CODE_LANGUAGE_CODE 0x03 72 | 73 | /* OpenBMC defines for Parser */ 74 | #define IPMI_FRU_AREA_INTERNAL_USE 0x00 75 | #define IPMI_FRU_AREA_CHASSIS_INFO 0x01 76 | #define IPMI_FRU_AREA_BOARD_INFO 0x02 77 | #define IPMI_FRU_AREA_PRODUCT_INFO 0x03 78 | #define IPMI_FRU_AREA_MULTI_RECORD 0x04 79 | #define IPMI_FRU_AREA_TYPE_MAX 0x05 80 | 81 | #define OPENBMC_VPD_KEY_LEN 64 82 | #define OPENBMC_VPD_VAL_LEN 512 83 | 84 | constexpr long fruEpochMinutes = 820454400; 85 | 86 | struct ipmi_fru_field 87 | { 88 | uint8_t type_length_field[IPMI_FRU_AREA_TYPE_LENGTH_FIELD_MAX]; 89 | /* store length of data stored in buffer */ 90 | unsigned int type_length_field_length; 91 | }; 92 | 93 | typedef struct ipmi_fru_field ipmi_fru_field_t; 94 | /* 95 | * FRU Parser 96 | */ 97 | 98 | typedef struct ipmi_fru_area_info 99 | { 100 | uint8_t off; 101 | uint8_t len; 102 | } ipmi_fru_area_info_t; 103 | 104 | typedef struct ipmi_fru_common_hdr 105 | { 106 | uint8_t fmtver; 107 | uint8_t internal; 108 | uint8_t chassis; 109 | uint8_t board; 110 | uint8_t product; 111 | uint8_t multirec; 112 | } __attribute__((packed)) ipmi_fru_common_hdr_t; 113 | 114 | const char* vpd_key_names[] = { 115 | "Key Names Table Start", 116 | "Type", /*OPENBMC_VPD_KEY_CHASSIS_TYPE*/ 117 | "Part Number", /*OPENBMC_VPD_KEY_CHASSIS_PART_NUM,*/ 118 | "Serial Number", /*OPENBMC_VPD_KEY_CHASSIS_SERIAL_NUM,*/ 119 | "Custom Field 1", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM1,*/ 120 | "Custom Field 2", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM2,*/ 121 | "Custom Field 3", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM3,*/ 122 | "Custom Field 4", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM4,*/ 123 | "Custom Field 5", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM5,*/ 124 | "Custom Field 6", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM6,*/ 125 | "Custom Field 7", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM7,*/ 126 | "Custom Field 8", /*OPENBMC_VPD_KEY_CHASSIS_CUSTOM8,*/ 127 | 128 | "Mfg Date", 129 | /* OPENBMC_VPD_KEY_BOARD_MFG_DATE, */ /* not a type/len */ 130 | "Manufacturer", /* OPENBMC_VPD_KEY_BOARD_MFR, */ 131 | "Name", /* OPENBMC_VPD_KEY_BOARD_NAME, */ 132 | "Serial Number", /* OPENBMC_VPD_KEY_BOARD_SERIAL_NUM, */ 133 | "Part Number", /* OPENBMC_VPD_KEY_BOARD_PART_NUM, */ 134 | "FRU File ID", /* OPENBMC_VPD_KEY_BOARD_FRU_FILE_ID, */ 135 | "Custom Field 1", /*OPENBMC_VPD_KEY_BOARD_CUSTOM1,*/ 136 | "Custom Field 2", /*OPENBMC_VPD_KEY_BOARD_CUSTOM2,*/ 137 | "Custom Field 3", /*OPENBMC_VPD_KEY_BOARD_CUSTOM3,*/ 138 | "Custom Field 4", /*OPENBMC_VPD_KEY_BOARD_CUSTOM4,*/ 139 | "Custom Field 5", /*OPENBMC_VPD_KEY_BOARD_CUSTOM5,*/ 140 | "Custom Field 6", /*OPENBMC_VPD_KEY_BOARD_CUSTOM6,*/ 141 | "Custom Field 7", /*OPENBMC_VPD_KEY_BOARD_CUSTOM7,*/ 142 | "Custom Field 8", /*OPENBMC_VPD_KEY_BOARD_CUSTOM8,*/ 143 | 144 | "Manufacturer", /* OPENBMC_VPD_KEY_PRODUCT_MFR, */ 145 | "Name", /* OPENBMC_VPD_KEY_PRODUCT_NAME, */ 146 | "Model Number", /* OPENBMC_VPD_KEY_PRODUCT_PART_MODEL_NUM, */ 147 | "Version", /* OPENBMC_VPD_KEY_PRODUCT_VER, */ 148 | "Serial Number", /* OPENBMC_VPD_KEY_PRODUCT_SERIAL_NUM, */ 149 | "Asset Tag", /* OPENBMC_VPD_KEY_PRODUCT_ASSET_TAG, */ 150 | "FRU File ID", /* OPENBMC_VPD_KEY_PRODUCT_FRU_FILE_ID, */ 151 | "Custom Field 1", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM1,*/ 152 | "Custom Field 2", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM2,*/ 153 | "Custom Field 3", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM3,*/ 154 | "Custom Field 4", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM4,*/ 155 | "Custom Field 5", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM5,*/ 156 | "Custom Field 6", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM6,*/ 157 | "Custom Field 7", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM7,*/ 158 | "Custom Field 8", /*OPENBMC_VPD_KEY_PRODUCT_CUSTOM8,*/ 159 | 160 | "Key Names Table End" /*OPENBMC_VPD_KEY_MAX,*/ 161 | }; 162 | 163 | /* 164 | * -------------------------------------------------------------------- 165 | * 166 | * -------------------------------------------------------------------- 167 | */ 168 | 169 | static size_t _to_time_str(uint32_t mfg_date_time, char* timestr, uint32_t len) 170 | { 171 | struct tm tm; 172 | time_t t; 173 | size_t s; 174 | 175 | ASSERT(timestr); 176 | ASSERT(len); 177 | 178 | memset(&tm, '\0', sizeof(struct tm)); 179 | 180 | t = mfg_date_time; 181 | gmtime_r(&t, &tm); 182 | s = strftime(timestr, len, "%F - %H:%M:%S UTC", &tm); 183 | 184 | return s; 185 | } 186 | 187 | /* private method to parse type/length */ 188 | static int _parse_type_length(const void* areabuf, unsigned int areabuflen, 189 | unsigned int current_area_offset, 190 | uint8_t* number_of_data_bytes, 191 | ipmi_fru_field_t* field) 192 | { 193 | const uint8_t* areabufptr = (const uint8_t*)areabuf; 194 | uint8_t type_length; 195 | uint8_t type_code; 196 | 197 | ASSERT(areabuf); 198 | ASSERT(areabuflen); 199 | ASSERT(number_of_data_bytes); 200 | 201 | type_length = areabufptr[current_area_offset]; 202 | 203 | /* ipmi workaround 204 | * 205 | * dell p weredge r610 206 | * 207 | * my reading of the fru spec is that all non-custom fields are 208 | * required to be listed by the vendor. however, on this 209 | * motherboard, some areas list this, indicating that there is 210 | * no more data to be parsed. so now, for "required" fields, i 211 | * check to see if the type-length field is a sentinel before 212 | * calling this function. 213 | */ 214 | 215 | ASSERT(type_length != IPMI_FRU_SENTINEL_VALUE); 216 | 217 | type_code = (type_length & IPMI_FRU_TYPE_LENGTH_TYPE_CODE_MASK) >> 218 | IPMI_FRU_TYPE_LENGTH_TYPE_CODE_SHIFT; 219 | (*number_of_data_bytes) = 220 | type_length & IPMI_FRU_TYPE_LENGTH_NUMBER_OF_DATA_BYTES_MASK; 221 | 222 | /* special case: this shouldn't be a length of 0x01 (see type/length 223 | * byte format in fru information storage definition). 224 | */ 225 | if (type_code == IPMI_FRU_TYPE_LENGTH_TYPE_CODE_LANGUAGE_CODE && 226 | (*number_of_data_bytes) == 0x01) 227 | { 228 | return (-1); 229 | } 230 | 231 | if ((current_area_offset + 1 + (*number_of_data_bytes)) > areabuflen) 232 | { 233 | return (-1); 234 | } 235 | 236 | if (field) 237 | { 238 | memset(field->type_length_field, '\0', 239 | IPMI_FRU_AREA_TYPE_LENGTH_FIELD_MAX); 240 | memcpy(field->type_length_field, &areabufptr[current_area_offset], 241 | 1 + (*number_of_data_bytes)); 242 | field->type_length_field_length = 1 + (*number_of_data_bytes); 243 | } 244 | 245 | return (0); 246 | } 247 | 248 | int ipmi_fru_chassis_info_area( 249 | const void* areabuf, unsigned int areabuflen, uint8_t* chassis_type, 250 | ipmi_fru_field_t* chassis_part_number, 251 | ipmi_fru_field_t* chassis_serial_number, 252 | ipmi_fru_field_t* chassis_custom_fields, 253 | unsigned int chassis_custom_fields_len) 254 | { 255 | const uint8_t* areabufptr = (const uint8_t*)areabuf; 256 | unsigned int area_offset = 0; 257 | unsigned int custom_fields_index = 0; 258 | uint8_t number_of_data_bytes; 259 | int rv = -1; 260 | 261 | if (!areabuf || !areabuflen) 262 | { 263 | return (-1); 264 | } 265 | 266 | if (chassis_part_number) 267 | memset(chassis_part_number, '\0', sizeof(ipmi_fru_field_t)); 268 | if (chassis_serial_number) 269 | memset(chassis_serial_number, '\0', sizeof(ipmi_fru_field_t)); 270 | if (chassis_custom_fields && chassis_custom_fields_len) 271 | memset(chassis_custom_fields, '\0', 272 | sizeof(ipmi_fru_field_t) * chassis_custom_fields_len); 273 | 274 | if (chassis_type) 275 | (*chassis_type) = areabufptr[area_offset]; 276 | area_offset++; 277 | 278 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 279 | goto out; 280 | 281 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 282 | &number_of_data_bytes, chassis_part_number) < 0) 283 | goto cleanup; 284 | area_offset += 1; /* type/length byte */ 285 | area_offset += number_of_data_bytes; 286 | 287 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 288 | goto out; 289 | 290 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 291 | &number_of_data_bytes, chassis_serial_number) < 0) 292 | goto cleanup; 293 | area_offset += 1; /* type/length byte */ 294 | area_offset += number_of_data_bytes; 295 | 296 | while (area_offset < areabuflen && 297 | areabufptr[area_offset] != IPMI_FRU_SENTINEL_VALUE) 298 | { 299 | ipmi_fru_field_t* field_ptr = nullptr; 300 | 301 | if (chassis_custom_fields && chassis_custom_fields_len) 302 | { 303 | if (custom_fields_index < chassis_custom_fields_len) 304 | field_ptr = &chassis_custom_fields[custom_fields_index]; 305 | else 306 | { 307 | goto cleanup; 308 | } 309 | } 310 | 311 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 312 | &number_of_data_bytes, field_ptr) < 0) 313 | goto cleanup; 314 | 315 | area_offset += 1; /* type/length byte */ 316 | area_offset += number_of_data_bytes; 317 | custom_fields_index++; 318 | } 319 | 320 | out: 321 | rv = 0; 322 | cleanup: 323 | return (rv); 324 | } 325 | 326 | int ipmi_fru_board_info_area( 327 | const void* areabuf, unsigned int areabuflen, uint8_t* language_code, 328 | uint32_t* mfg_date_time, ipmi_fru_field_t* board_manufacturer, 329 | ipmi_fru_field_t* board_product_name, ipmi_fru_field_t* board_serial_number, 330 | ipmi_fru_field_t* board_part_number, ipmi_fru_field_t* board_fru_file_id, 331 | ipmi_fru_field_t* board_custom_fields, unsigned int board_custom_fields_len) 332 | { 333 | const uint8_t* areabufptr = (const uint8_t*)areabuf; 334 | unsigned int area_offset = 0; 335 | unsigned int custom_fields_index = 0; 336 | uint8_t number_of_data_bytes; 337 | int rv = -1; 338 | 339 | if (!areabuf || !areabuflen) 340 | { 341 | return (-1); 342 | } 343 | 344 | if (board_manufacturer) 345 | memset(board_manufacturer, '\0', sizeof(ipmi_fru_field_t)); 346 | if (board_product_name) 347 | memset(board_product_name, '\0', sizeof(ipmi_fru_field_t)); 348 | if (board_serial_number) 349 | memset(board_serial_number, '\0', sizeof(ipmi_fru_field_t)); 350 | if (board_part_number) 351 | memset(board_part_number, '\0', sizeof(ipmi_fru_field_t)); 352 | if (board_fru_file_id) 353 | memset(board_fru_file_id, '\0', sizeof(ipmi_fru_field_t)); 354 | if (board_custom_fields && board_custom_fields_len) 355 | memset(board_custom_fields, '\0', 356 | sizeof(ipmi_fru_field_t) * board_custom_fields_len); 357 | 358 | if (language_code) 359 | (*language_code) = areabufptr[area_offset]; 360 | area_offset++; 361 | 362 | if (mfg_date_time) 363 | { 364 | unsigned int minutes = areabufptr[area_offset]; 365 | area_offset++; 366 | minutes |= (areabufptr[area_offset] << 8); 367 | area_offset++; 368 | minutes |= (areabufptr[area_offset] << 16); 369 | area_offset++; 370 | 371 | /* In fru, epoch is 0:00 hrs 1/1/96 == 820454400 372 | * Remove it directly and remove the time conversion. 373 | */ 374 | (*mfg_date_time) = fruEpochMinutes + static_cast(minutes) * 60; 375 | } 376 | else 377 | area_offset += 3; 378 | 379 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 380 | goto out; 381 | 382 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 383 | &number_of_data_bytes, board_manufacturer) < 0) 384 | goto cleanup; 385 | area_offset += 1; /* type/length byte */ 386 | area_offset += number_of_data_bytes; 387 | 388 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 389 | goto out; 390 | 391 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 392 | &number_of_data_bytes, board_product_name) < 0) 393 | goto cleanup; 394 | area_offset += 1; /* type/length byte */ 395 | area_offset += number_of_data_bytes; 396 | 397 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 398 | goto out; 399 | 400 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 401 | &number_of_data_bytes, board_serial_number) < 0) 402 | goto cleanup; 403 | area_offset += 1; /* type/length byte */ 404 | area_offset += number_of_data_bytes; 405 | 406 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 407 | goto out; 408 | 409 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 410 | &number_of_data_bytes, board_part_number) < 0) 411 | goto cleanup; 412 | area_offset += 1; /* type/length byte */ 413 | area_offset += number_of_data_bytes; 414 | 415 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 416 | goto out; 417 | 418 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 419 | &number_of_data_bytes, board_fru_file_id) < 0) 420 | goto cleanup; 421 | area_offset += 1; /* type/length byte */ 422 | area_offset += number_of_data_bytes; 423 | 424 | while (area_offset < areabuflen && 425 | areabufptr[area_offset] != IPMI_FRU_SENTINEL_VALUE) 426 | { 427 | ipmi_fru_field_t* field_ptr = nullptr; 428 | 429 | if (board_custom_fields && board_custom_fields_len) 430 | { 431 | if (custom_fields_index < board_custom_fields_len) 432 | field_ptr = &board_custom_fields[custom_fields_index]; 433 | else 434 | { 435 | goto cleanup; 436 | } 437 | } 438 | 439 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 440 | &number_of_data_bytes, field_ptr) < 0) 441 | goto cleanup; 442 | 443 | area_offset += 1; /* type/length byte */ 444 | area_offset += number_of_data_bytes; 445 | custom_fields_index++; 446 | } 447 | 448 | out: 449 | rv = 0; 450 | cleanup: 451 | return (rv); 452 | } 453 | 454 | int ipmi_fru_product_info_area( 455 | const void* areabuf, unsigned int areabuflen, uint8_t* language_code, 456 | ipmi_fru_field_t* product_manufacturer_name, ipmi_fru_field_t* product_name, 457 | ipmi_fru_field_t* product_part_model_number, 458 | ipmi_fru_field_t* product_version, ipmi_fru_field_t* product_serial_number, 459 | ipmi_fru_field_t* product_asset_tag, ipmi_fru_field_t* product_fru_file_id, 460 | ipmi_fru_field_t* product_custom_fields, 461 | unsigned int product_custom_fields_len) 462 | { 463 | const uint8_t* areabufptr = (const uint8_t*)areabuf; 464 | unsigned int area_offset = 0; 465 | unsigned int custom_fields_index = 0; 466 | uint8_t number_of_data_bytes; 467 | int rv = -1; 468 | 469 | if (!areabuf || !areabuflen) 470 | { 471 | return (-1); 472 | } 473 | 474 | if (product_manufacturer_name) 475 | memset(product_manufacturer_name, '\0', sizeof(ipmi_fru_field_t)); 476 | if (product_name) 477 | memset(product_name, '\0', sizeof(ipmi_fru_field_t)); 478 | if (product_part_model_number) 479 | memset(product_part_model_number, '\0', sizeof(ipmi_fru_field_t)); 480 | if (product_version) 481 | memset(product_version, '\0', sizeof(ipmi_fru_field_t)); 482 | if (product_serial_number) 483 | memset(product_serial_number, '\0', sizeof(ipmi_fru_field_t)); 484 | if (product_asset_tag) 485 | memset(product_asset_tag, '\0', sizeof(ipmi_fru_field_t)); 486 | if (product_fru_file_id) 487 | memset(product_fru_file_id, '\0', sizeof(ipmi_fru_field_t)); 488 | if (product_custom_fields && product_custom_fields_len) 489 | memset(product_custom_fields, '\0', 490 | sizeof(ipmi_fru_field_t) * product_custom_fields_len); 491 | 492 | if (language_code) 493 | (*language_code) = areabufptr[area_offset]; 494 | area_offset++; 495 | 496 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 497 | goto out; 498 | 499 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 500 | &number_of_data_bytes, product_manufacturer_name) < 501 | 0) 502 | goto cleanup; 503 | area_offset += 1; /* type/length byte */ 504 | area_offset += number_of_data_bytes; 505 | 506 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 507 | goto out; 508 | 509 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 510 | &number_of_data_bytes, product_name) < 0) 511 | goto cleanup; 512 | area_offset += 1; /* type/length byte */ 513 | area_offset += number_of_data_bytes; 514 | 515 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 516 | goto out; 517 | 518 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 519 | &number_of_data_bytes, product_part_model_number) < 520 | 0) 521 | goto cleanup; 522 | area_offset += 1; /* type/length byte */ 523 | area_offset += number_of_data_bytes; 524 | 525 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 526 | goto out; 527 | 528 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 529 | &number_of_data_bytes, product_version) < 0) 530 | goto cleanup; 531 | area_offset += 1; /* type/length byte */ 532 | area_offset += number_of_data_bytes; 533 | 534 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 535 | goto out; 536 | 537 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 538 | &number_of_data_bytes, product_serial_number) < 0) 539 | goto cleanup; 540 | area_offset += 1; /* type/length byte */ 541 | area_offset += number_of_data_bytes; 542 | 543 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 544 | goto out; 545 | 546 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 547 | &number_of_data_bytes, product_asset_tag) < 0) 548 | goto cleanup; 549 | area_offset += 1; /* type/length byte */ 550 | area_offset += number_of_data_bytes; 551 | 552 | if (areabufptr[area_offset] == IPMI_FRU_SENTINEL_VALUE) 553 | goto out; 554 | 555 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 556 | &number_of_data_bytes, product_fru_file_id) < 0) 557 | goto cleanup; 558 | 559 | area_offset += 1; /* type/length byte */ 560 | area_offset += number_of_data_bytes; 561 | 562 | while (area_offset < areabuflen && 563 | areabufptr[area_offset] != IPMI_FRU_SENTINEL_VALUE) 564 | { 565 | ipmi_fru_field_t* field_ptr = nullptr; 566 | 567 | if (product_custom_fields && product_custom_fields_len) 568 | { 569 | if (custom_fields_index < product_custom_fields_len) 570 | field_ptr = &product_custom_fields[custom_fields_index]; 571 | else 572 | { 573 | goto cleanup; 574 | } 575 | } 576 | 577 | if (_parse_type_length(areabufptr, areabuflen, area_offset, 578 | &number_of_data_bytes, field_ptr) < 0) 579 | goto cleanup; 580 | 581 | area_offset += 1; /* type/length byte */ 582 | area_offset += number_of_data_bytes; 583 | custom_fields_index++; 584 | } 585 | 586 | out: 587 | rv = 0; 588 | cleanup: 589 | return (rv); 590 | } 591 | 592 | void _append_to_dict(uint8_t vpd_key_id, uint8_t* vpd_key_val, 593 | IPMIFruInfo& info) 594 | { 595 | int type_length = vpd_key_val[0]; 596 | int type_code = (type_length & IPMI_FRU_TYPE_LENGTH_TYPE_CODE_MASK) >> 597 | IPMI_FRU_TYPE_LENGTH_TYPE_CODE_SHIFT; 598 | int vpd_val_len = type_length & 599 | IPMI_FRU_TYPE_LENGTH_NUMBER_OF_DATA_BYTES_MASK; 600 | 601 | /* Needed to convert each uint8_t byte to a ascii */ 602 | char bin_byte[3] = {0}; 603 | 604 | /* 605 | * Max number of characters needed to represent 1 unsigned byte in string 606 | * is number of bytes multiplied by 2. Extra 3 for 0x and a ending '\0'; 607 | */ 608 | char bin_in_ascii_len = vpd_val_len * 2 + 3; 609 | 610 | /* Binary converted to ascii in array */ 611 | char* bin_in_ascii = (char*)malloc(bin_in_ascii_len); 612 | 613 | /* For reading byte from the area */ 614 | int val = 0; 615 | 616 | char* bin_copy = &((char*)bin_in_ascii)[2]; 617 | 618 | switch (type_code) 619 | { 620 | case 0: 621 | memset(bin_in_ascii, 0x0, bin_in_ascii_len); 622 | 623 | /* Offset 1 is where actual data starts */ 624 | for (val = 1; val <= vpd_val_len; val++) 625 | { 626 | /* 2 bytes for data and 1 for terminating '\0' */ 627 | snprintf(bin_byte, 3, "%02x", vpd_key_val[val]); 628 | 629 | #pragma GCC diagnostic push 630 | #ifdef __clang__ 631 | #pragma clang diagnostic ignored "-Wdeprecated-declarations" 632 | #else 633 | #pragma GCC diagnostic ignored "-Wstringop-truncation" 634 | #endif 635 | /* Its a running string so strip off the '\0' */ 636 | strncat(bin_copy, bin_byte, 2); 637 | #pragma GCC diagnostic pop 638 | } 639 | 640 | /* We need the data represented as 0x...... */ 641 | if (vpd_val_len > 0) 642 | { 643 | memcpy(bin_in_ascii, "0x", 2); 644 | } 645 | #if IPMI_FRU_PARSER_DEBUG 646 | printf("_append_to_dict: VPD Key = [%s] : Type Code = [BINARY] :" 647 | " Len = [%d] : Val = [%s]\n", 648 | vpd_key_names[vpd_key_id], vpd_val_len, bin_in_ascii); 649 | #endif 650 | info[vpd_key_id] = 651 | std::make_pair(vpd_key_names[vpd_key_id], bin_in_ascii); 652 | break; 653 | 654 | case 3: 655 | #if IPMI_FRU_PARSER_DEBUG 656 | printf("_append_to_dict: VPD Key = [%s] : Type Code=[ASCII+Latin]" 657 | " : Len = [%d] : Val = [%s]\n", 658 | vpd_key_names[vpd_key_id], vpd_val_len, &vpd_key_val[1]); 659 | #endif 660 | info[vpd_key_id] = std::make_pair( 661 | vpd_key_names[vpd_key_id], 662 | std::string(vpd_key_val + 1, vpd_key_val + 1 + type_length)); 663 | break; 664 | } 665 | 666 | if (bin_in_ascii) 667 | { 668 | free(bin_in_ascii); 669 | bin_in_ascii = nullptr; 670 | } 671 | } 672 | 673 | int parse_fru_area(const uint8_t area, const void* msgbuf, const size_t len, 674 | IPMIFruInfo& info) 675 | { 676 | int rv = -1; 677 | int i = 0; 678 | 679 | /* Chassis */ 680 | uint8_t chassis_type; 681 | /* Board */ 682 | uint32_t mfg_date_time; 683 | /* Product */ 684 | // unsigned int product_custom_fields_len; 685 | 686 | // ipmi_fru_area_info_t fru_area_info [ IPMI_FRU_AREA_TYPE_MAX ]; 687 | ipmi_fru_field_t vpd_info[OPENBMC_VPD_KEY_MAX]; 688 | char timestr[OPENBMC_VPD_VAL_LEN]; 689 | 690 | // uint8_t* ipmi_fru_field_str=NULL; 691 | // ipmi_fru_common_hdr_t* chdr = NULL; 692 | // uint8_t* hdr = NULL; 693 | 694 | ASSERT(msgbuf); 695 | 696 | for (i = 0; i < OPENBMC_VPD_KEY_MAX; i++) 697 | { 698 | memset(vpd_info[i].type_length_field, '\0', 699 | IPMI_FRU_AREA_TYPE_LENGTH_FIELD_MAX); 700 | vpd_info[i].type_length_field_length = 0; 701 | } 702 | 703 | switch (area) 704 | { 705 | case IPMI_FRU_AREA_CHASSIS_INFO: 706 | #if IPMI_FRU_PARSER_DEBUG 707 | printf("Chassis : Buf len = [%d]\n", len); 708 | #endif 709 | ipmi_fru_chassis_info_area( 710 | (uint8_t*)msgbuf + 2, len, &chassis_type, 711 | &vpd_info[OPENBMC_VPD_KEY_CHASSIS_PART_NUM], 712 | &vpd_info[OPENBMC_VPD_KEY_CHASSIS_SERIAL_NUM], 713 | &vpd_info[OPENBMC_VPD_KEY_CHASSIS_CUSTOM1], 714 | OPENBMC_VPD_KEY_CUSTOM_FIELDS_MAX); 715 | 716 | /* Populate VPD Table */ 717 | for (i = 1; i <= OPENBMC_VPD_KEY_CHASSIS_MAX; i++) 718 | { 719 | if (i == OPENBMC_VPD_KEY_CHASSIS_TYPE) 720 | { 721 | #if IPMI_FRU_PARSER_DEBUG 722 | printf("Chassis : Appending [%s] = [%d]\n", 723 | vpd_key_names[i], chassis_type); 724 | #endif 725 | info[i] = std::make_pair(vpd_key_names[i], 726 | std::to_string(chassis_type)); 727 | continue; 728 | } 729 | _append_to_dict(i, vpd_info[i].type_length_field, info); 730 | } 731 | break; 732 | case IPMI_FRU_AREA_BOARD_INFO: 733 | #if IPMI_FRU_PARSER_DEBUG 734 | printf("Board : Buf len = [%d]\n", len); 735 | #endif 736 | ipmi_fru_board_info_area( 737 | (uint8_t*)msgbuf + 2, len, nullptr, &mfg_date_time, 738 | &vpd_info[OPENBMC_VPD_KEY_BOARD_MFR], 739 | &vpd_info[OPENBMC_VPD_KEY_BOARD_NAME], 740 | &vpd_info[OPENBMC_VPD_KEY_BOARD_SERIAL_NUM], 741 | &vpd_info[OPENBMC_VPD_KEY_BOARD_PART_NUM], 742 | &vpd_info[OPENBMC_VPD_KEY_BOARD_FRU_FILE_ID], 743 | &vpd_info[OPENBMC_VPD_KEY_BOARD_CUSTOM1], 744 | OPENBMC_VPD_KEY_CUSTOM_FIELDS_MAX); 745 | 746 | /* Populate VPD Table */ 747 | for (i = OPENBMC_VPD_KEY_BOARD_MFG_DATE; 748 | i <= OPENBMC_VPD_KEY_BOARD_MAX; i++) 749 | { 750 | if (i == OPENBMC_VPD_KEY_BOARD_MFG_DATE) 751 | { 752 | _to_time_str(mfg_date_time, timestr, OPENBMC_VPD_VAL_LEN); 753 | #if IPMI_FRU_PARSER_DEBUG 754 | printf("Board : Appending [%s] = [%s]\n", vpd_key_names[i], 755 | timestr); 756 | #endif 757 | info[i] = 758 | std::make_pair(vpd_key_names[i], std::string(timestr)); 759 | continue; 760 | } 761 | _append_to_dict(i, vpd_info[i].type_length_field, info); 762 | } 763 | break; 764 | case IPMI_FRU_AREA_PRODUCT_INFO: 765 | #if IPMI_FRU_PARSER_DEBUG 766 | printf("Product : Buf len = [%d]\n", len); 767 | #endif 768 | ipmi_fru_product_info_area( 769 | (uint8_t*)msgbuf + 2, len, nullptr, 770 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_MFR], 771 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_NAME], 772 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_PART_MODEL_NUM], 773 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_VER], 774 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_SERIAL_NUM], 775 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_ASSET_TAG], 776 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_FRU_FILE_ID], 777 | &vpd_info[OPENBMC_VPD_KEY_PRODUCT_CUSTOM1], 778 | OPENBMC_VPD_KEY_CUSTOM_FIELDS_MAX); 779 | 780 | for (i = OPENBMC_VPD_KEY_PRODUCT_MFR; 781 | i <= OPENBMC_VPD_KEY_PRODUCT_MAX; ++i) 782 | { 783 | _append_to_dict(i, vpd_info[i].type_length_field, info); 784 | } 785 | break; 786 | default: 787 | /* TODO: Parse Multi Rec / Internal use area */ 788 | break; 789 | } 790 | 791 | #if IPMI_FRU_PARSER_DEBUG 792 | printf("parse_fru_area : Dictionary Packing Complete\n"); 793 | #endif 794 | rv = 0; 795 | return (rv); 796 | } 797 | -------------------------------------------------------------------------------- /frup.hpp: -------------------------------------------------------------------------------- 1 | #ifndef OPENBMC_IPMI_FRU_PARSER_H 2 | #define OPENBMC_IPMI_FRU_PARSER_H 3 | 4 | #include 5 | 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | enum ipmi_fru_area_type 13 | { 14 | IPMI_FRU_AREA_INTERNAL_USE = 0x00, 15 | IPMI_FRU_AREA_CHASSIS_INFO, 16 | IPMI_FRU_AREA_BOARD_INFO, 17 | IPMI_FRU_AREA_PRODUCT_INFO, 18 | IPMI_FRU_AREA_MULTI_RECORD, 19 | IPMI_FRU_AREA_TYPE_MAX 20 | }; 21 | 22 | enum openbmc_vpd_key_id 23 | { 24 | OPENBMC_VPD_KEY_CHASSIS_TYPE = 1, /* not a type/len */ 25 | OPENBMC_VPD_KEY_CHASSIS_PART_NUM, 26 | OPENBMC_VPD_KEY_CHASSIS_SERIAL_NUM, 27 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM1, 28 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM2, 29 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM3, 30 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM4, 31 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM5, 32 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM6, 33 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM7, 34 | OPENBMC_VPD_KEY_CHASSIS_CUSTOM8, 35 | OPENBMC_VPD_KEY_CHASSIS_MAX = OPENBMC_VPD_KEY_CHASSIS_CUSTOM8, 36 | /* TODO: chassis_custom_fields */ 37 | 38 | OPENBMC_VPD_KEY_BOARD_MFG_DATE, /* not a type/len */ 39 | OPENBMC_VPD_KEY_BOARD_MFR, 40 | OPENBMC_VPD_KEY_BOARD_NAME, 41 | OPENBMC_VPD_KEY_BOARD_SERIAL_NUM, 42 | OPENBMC_VPD_KEY_BOARD_PART_NUM, 43 | OPENBMC_VPD_KEY_BOARD_FRU_FILE_ID, 44 | OPENBMC_VPD_KEY_BOARD_CUSTOM1, 45 | OPENBMC_VPD_KEY_BOARD_CUSTOM2, 46 | OPENBMC_VPD_KEY_BOARD_CUSTOM3, 47 | OPENBMC_VPD_KEY_BOARD_CUSTOM4, 48 | OPENBMC_VPD_KEY_BOARD_CUSTOM5, 49 | OPENBMC_VPD_KEY_BOARD_CUSTOM6, 50 | OPENBMC_VPD_KEY_BOARD_CUSTOM7, 51 | OPENBMC_VPD_KEY_BOARD_CUSTOM8, 52 | OPENBMC_VPD_KEY_BOARD_MAX = OPENBMC_VPD_KEY_BOARD_CUSTOM8, 53 | /* TODO: board_custom_fields */ 54 | 55 | OPENBMC_VPD_KEY_PRODUCT_MFR, 56 | OPENBMC_VPD_KEY_PRODUCT_NAME, 57 | OPENBMC_VPD_KEY_PRODUCT_PART_MODEL_NUM, 58 | OPENBMC_VPD_KEY_PRODUCT_VER, 59 | OPENBMC_VPD_KEY_PRODUCT_SERIAL_NUM, 60 | OPENBMC_VPD_KEY_PRODUCT_ASSET_TAG, 61 | OPENBMC_VPD_KEY_PRODUCT_FRU_FILE_ID, 62 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM1, 63 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM2, 64 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM3, 65 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM4, 66 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM5, 67 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM6, 68 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM7, 69 | OPENBMC_VPD_KEY_PRODUCT_CUSTOM8, 70 | OPENBMC_VPD_KEY_PRODUCT_MAX = OPENBMC_VPD_KEY_PRODUCT_CUSTOM8, 71 | 72 | OPENBMC_VPD_KEY_MAX, 73 | OPENBMC_VPD_KEY_CUSTOM_FIELDS_MAX = 8, 74 | 75 | }; 76 | 77 | using IPMIFruInfo = 78 | std::array, OPENBMC_VPD_KEY_MAX>; 79 | 80 | struct IPMIFruData 81 | { 82 | std::string section; 83 | std::string property; 84 | std::string delimiter; 85 | }; 86 | 87 | using DbusProperty = std::string; 88 | using DbusPropertyVec = std::vector>; 89 | 90 | using DbusInterface = std::string; 91 | using DbusInterfaceVec = std::vector>; 92 | 93 | using FruInstancePath = std::string; 94 | 95 | struct FruInstance 96 | { 97 | uint8_t entityID; 98 | uint8_t entityInstance; 99 | FruInstancePath path; 100 | DbusInterfaceVec interfaces; 101 | }; 102 | 103 | using FruInstanceVec = std::vector; 104 | 105 | using FruId = uint32_t; 106 | using FruMap = std::map; 107 | 108 | /* Parse an IPMI write fru data message into a dictionary containing name value 109 | * pair of VPD entries.*/ 110 | int parse_fru(const void* msgbuf, sd_bus_message* vpdtbl); 111 | 112 | int parse_fru_area(const uint8_t area, const void* msgbuf, const size_t len, 113 | IPMIFruInfo& info); 114 | 115 | #endif 116 | -------------------------------------------------------------------------------- /meson.build: -------------------------------------------------------------------------------- 1 | project( 2 | 'ipmi-fru-parser', 3 | 'cpp', 4 | version: '1.0', 5 | default_options: [ 6 | 'buildtype=debugoptimized', 7 | 'cpp_std=c++23', 8 | 'warning_level=3', 9 | 'werror=true', 10 | ], 11 | meson_version: '>=1.1.1', 12 | ) 13 | 14 | cxx = meson.get_compiler('cpp') 15 | 16 | phosphor_logging_dep = dependency('phosphor-logging') 17 | sdbusplus_dep = dependency('sdbusplus') 18 | ipmid_dep = dependency('libipmid') 19 | 20 | if cxx.has_header('CLI/CLI.hpp') 21 | CLI11_dep = declare_dependency() 22 | else 23 | CLI11_dep = dependency('CLI11') 24 | endif 25 | 26 | python_prog = find_program('python3', native: true) 27 | 28 | fru_gen = custom_target( 29 | 'fru-gen.cpp'.underscorify(), 30 | input: ['scripts/fru_gen.py', get_option('fru_yaml')], 31 | output: 'fru-gen.cpp', 32 | command: [ 33 | python_prog, 34 | '@INPUT0@', 35 | '-i', 36 | '@INPUT1@', 37 | '-o', 38 | meson.current_build_dir(), 39 | 'generate-cpp', 40 | ], 41 | ) 42 | 43 | properties_gen = custom_target( 44 | 'extra-properties-gen.cpp'.underscorify(), 45 | input: ['scripts/extra-properties.py', get_option('properties_yaml')], 46 | output: 'extra-properties-gen.cpp', 47 | command: [python_prog, '@INPUT0@', '-e', '@INPUT1@'], 48 | ) 49 | 50 | writefrudata_lib = library( 51 | 'writefrudata', 52 | fru_gen, 53 | properties_gen, 54 | 'fru_area.cpp', 55 | 'frup.cpp', 56 | 'writefrudata.cpp', 57 | dependencies: [sdbusplus_dep, phosphor_logging_dep, ipmid_dep], 58 | version: meson.project_version(), 59 | install: true, 60 | ) 61 | 62 | writefrudata_dep = declare_dependency(link_with: writefrudata_lib) 63 | 64 | strgfnhandler_lib = library( 65 | 'strgfnhandler', 66 | 'strgfnhandler.cpp', 67 | dependencies: [writefrudata_dep, phosphor_logging_dep, ipmid_dep], 68 | override_options: ['b_lundef=false'], 69 | version: meson.project_version(), 70 | install: true, 71 | install_dir: get_option('libdir') / 'ipmid-providers', 72 | ) 73 | 74 | executable( 75 | 'phosphor-read-eeprom', 76 | 'readeeprom.cpp', 77 | dependencies: [ 78 | CLI11_dep, 79 | phosphor_logging_dep, 80 | sdbusplus_dep, 81 | writefrudata_dep, 82 | ], 83 | install: true, 84 | ) 85 | -------------------------------------------------------------------------------- /meson.options: -------------------------------------------------------------------------------- 1 | option( 2 | 'fru_yaml', 3 | type: 'string', 4 | value: 'scripts/example.yaml', 5 | description: 'Path to FRU YAML', 6 | ) 7 | 8 | option( 9 | 'properties_yaml', 10 | type: 'string', 11 | value: 'scripts/extra-properties-example.yaml', 12 | description: 'Path to Properties YAML', 13 | ) 14 | -------------------------------------------------------------------------------- /readeeprom.cpp: -------------------------------------------------------------------------------- 1 | #include "writefrudata.hpp" 2 | 3 | #include 4 | #include 5 | 6 | #include 7 | #include 8 | #include 9 | #include 10 | 11 | using namespace phosphor::logging; 12 | 13 | //-------------------------------------------------------------------------- 14 | // This gets called by udev monitor soon after seeing hog plugs for EEPROMS. 15 | //-------------------------------------------------------------------------- 16 | int main(int argc, char** argv) 17 | { 18 | int rc = 0; 19 | uint8_t fruid; 20 | std::string eeprom_file; 21 | const int MAX_FRU_ID = 0xfe; 22 | 23 | CLI::App app{"OpenBMC IPMI-FRU-Parser"}; 24 | app.add_option("-e,--eeprom", eeprom_file, "Absolute file name of eeprom") 25 | ->check(CLI::ExistingFile); 26 | app.add_option("-f,--fruid", fruid, "valid fru id in integer") 27 | ->check(CLI::Range(0, MAX_FRU_ID)); 28 | 29 | // Read the arguments. 30 | CLI11_PARSE(app, argc, argv); 31 | 32 | // Now that we have the file that contains the eeprom data, go read it 33 | // and update the Inventory DB. 34 | auto bus = sdbusplus::bus::new_default(); 35 | bool bmc_fru = true; 36 | rc = validateFRUArea(fruid, eeprom_file.c_str(), bus, bmc_fru); 37 | 38 | return (rc < 0 ? EXIT_FAILURE : EXIT_SUCCESS); 39 | } 40 | -------------------------------------------------------------------------------- /scripts/example.yaml: -------------------------------------------------------------------------------- 1 | # A YAML similar to this example would have to be generated, for eg with MRW 2 | # inputs and system configuration, to depict IPMI Fru information. 3 | # 4 | # This file maps IPMI properties to phosphor dbus inventory properties 5 | # 6 | # This YAML could help generate C++ code. 7 | # Format of the YAML: 8 | # Fruid: 9 | # Associated Fru paths 10 | # d-bus Interfaces 11 | # d-bus Properties 12 | # IPMI Fru mapping 13 | 0: 14 | /system: 15 | entityID: 200 16 | entityInstance: 1 17 | interfaces: 18 | xyz.openbmc_project.Inventory.Item: 19 | PrettyName: 20 | IPMIFruProperty: Product Name 21 | IPMIFruSection: Product 22 | xyz.openbmc_project.Inventory.Decorator.Asset: 23 | Manufacturer: 24 | IPMIFruProperty: Manufacturer 25 | IPMIFruSection: Product 26 | PartNumber: 27 | IPMIFruProperty: Part Number 28 | IPMIFruSection: Product 29 | SerialNumber: 30 | IPMIFruProperty: Serial Number 31 | IPMIFruSection: Product 32 | BuildDate: 33 | IPMIFruProperty: Mfg Date 34 | IPMIFruSection: Product 35 | xyz.openbmc_project.Inventory.Decorator.Revision: 36 | Version: 37 | IPMIFruProperty: Version 38 | IPMIFruSection: Product 39 | xyz.openbmc_project.Inventory.Item.System: 40 | 1: 41 | /system/chassis/motherboard/dimm0: 42 | entityID: 8 43 | entityInstance: 1 44 | interfaces: 45 | xyz.openbmc_project.Inventory.Item: 46 | PrettyName: 47 | IPMIFruProperty: Product Name 48 | IPMIFruSection: Product 49 | xyz.openbmc_project.Inventory.Decorator.Asset: 50 | Manufacturer: 51 | IPMIFruProperty: Manufacturer 52 | IPMIFruSection: Product 53 | BuildDate: 54 | IPMIFruProperty: Mfg Date 55 | IPMIFruSection: Product 56 | SerialNumber: 57 | IPMIFruProperty: Serial Number 58 | IPMIFruSection: Product 59 | PartNumber: 60 | IPMIFruProperty: Part Number 61 | IPMIFruSection: Product 62 | xyz.openbmc_project.Inventory.Decorator.Revision: 63 | Version: 64 | IPMIFruProperty: Version 65 | IPMIFruSection: Product 66 | xyz.openbmc_project.Inventory.Item.Dimm: 67 | 2: 68 | /system/chassis/motherboard/dimm1: 69 | entityID: 8 70 | entityInstance: 2 71 | interfaces: 72 | xyz.openbmc_project.Inventory.Item: 73 | PrettyName: 74 | IPMIFruProperty: Product Name 75 | IPMIFruSection: Product 76 | xyz.openbmc_project.Inventory.Decorator.Asset: 77 | Manufacturer: 78 | IPMIFruProperty: Manufacturer 79 | IPMIFruSection: Product 80 | BuildDate: 81 | IPMIFruProperty: Mfg Date 82 | IPMIFruSection: Product 83 | SerialNumber: 84 | IPMIFruProperty: Serial Number 85 | IPMIFruSection: Product 86 | PartNumber: 87 | IPMIFruProperty: Part Number 88 | IPMIFruSection: Product 89 | xyz.openbmc_project.Inventory.Decorator.Revision: 90 | Version: 91 | IPMIFruProperty: Version 92 | IPMIFruSection: Product 93 | xyz.openbmc_project.Inventory.Item.Dimm: 94 | 3: 95 | /system/chassis/motherboard/cpu0: 96 | entityID: 3 97 | entityInstance: 1 98 | interfaces: 99 | xyz.openbmc_project.Inventory.Item: 100 | PrettyName: 101 | IPMIFruProperty: Product Name 102 | IPMIFruSection: Board 103 | xyz.openbmc_project.Inventory.Decorator.Asset: 104 | BuildDate: 105 | IPMIFruProperty: Mfg Date 106 | IPMIFruSection: Board 107 | SerialNumber: 108 | IPMIFruProperty: Serial Number 109 | IPMIFruSection: Board 110 | PartNumber: 111 | IPMIFruProperty: Part Number 112 | IPMIFruSection: Board 113 | Manufacturer: 114 | IPMIFruProperty: Manufacturer 115 | IPMIFruSection: Board 116 | xyz.openbmc_project.Inventory.Item.Cpu: 117 | 4: 118 | /system/chassis/motherboard/cpu1: 119 | entityID: 3 120 | entityInstance: 2 121 | interfaces: 122 | xyz.openbmc_project.Inventory.Item: 123 | PrettyName: 124 | IPMIFruProperty: Product Name 125 | IPMIFruSection: Board 126 | xyz.openbmc_project.Inventory.Decorator.Asset: 127 | BuildDate: 128 | IPMIFruProperty: Mfg Date 129 | IPMIFruSection: Board 130 | SerialNumber: 131 | IPMIFruProperty: Serial Number 132 | IPMIFruSection: Board 133 | PartNumber: 134 | IPMIFruProperty: Part Number 135 | IPMIFruSection: Board 136 | Manufacturer: 137 | IPMIFruProperty: Manufacturer 138 | IPMIFruSection: Board 139 | xyz.openbmc_project.Inventory.Item.Cpu: 140 | -------------------------------------------------------------------------------- /scripts/extra-properties-example.yaml: -------------------------------------------------------------------------------- 1 | /system/chassis/motherboard/cpu0: 2 | xyz.openbmc_project.Inventory.Decorator.Replaceable: 3 | FieldReplaceable: "true" 4 | xyz.openbmc_project.Inventory.Decorator.Cacheable: 5 | Cached: "true" 6 | 7 | /system/chassis/motherboard/dimm0: 8 | xyz.openbmc_project.Inventory.Decorator.Replaceable: 9 | FieldReplaceable: "true" 10 | xyz.openbmc_project.Inventory.Decorator.Cacheable: 11 | Cached: "true" 12 | -------------------------------------------------------------------------------- /scripts/extra-properties.cpp.mako: -------------------------------------------------------------------------------- 1 | ## This file is a template. The comment below is emitted 2 | ## into the rendered file; feel free to edit this file. 3 | // WARNING: Generated source. Do not edit! 4 | 5 | #include "types.hpp" 6 | 7 | using namespace ipmi::vpd; 8 | 9 | extern const std::map extras = { 10 | % for path in dict.keys(): 11 | <% 12 | interfaces = dict[path] 13 | %>\ 14 | {"${path}",{ 15 | % for interface,properties in interfaces.items(): 16 | {"${interface}",{ 17 | % for property,value in properties.items(): 18 | {"${property}", ${value}}, 19 | % endfor 20 | }}, 21 | % endfor 22 | }}, 23 | % endfor 24 | }; 25 | -------------------------------------------------------------------------------- /scripts/extra-properties.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import argparse 4 | import os 5 | 6 | import yaml 7 | from mako.template import Template 8 | 9 | 10 | def main(): 11 | parser = argparse.ArgumentParser( 12 | description="IPMI FRU VPD parser and code generator" 13 | ) 14 | 15 | parser.add_argument( 16 | "-e", 17 | "--extra_props_yaml", 18 | dest="extra_props_yaml", 19 | default="extra-properties-example.yaml", 20 | help="input extra properties yaml file to parse", 21 | ) 22 | args = parser.parse_args() 23 | 24 | with open(args.extra_props_yaml, "r") as fd: 25 | yamlDict = yaml.safe_load(fd) 26 | 27 | # Render the mako template 28 | template = os.path.join(script_dir, "extra-properties.cpp.mako") 29 | t = Template(filename=template) 30 | with open("extra-properties-gen.cpp", "w") as fd: 31 | fd.write(t.render(dict=yamlDict)) 32 | 33 | 34 | if __name__ == "__main__": 35 | script_dir = os.path.dirname(os.path.realpath(__file__)) 36 | main() 37 | -------------------------------------------------------------------------------- /scripts/fru_gen.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import argparse 4 | import os 5 | import sys 6 | 7 | import yaml 8 | from mako.template import Template 9 | 10 | 11 | def generate_cpp(inventory_yaml, output_dir): 12 | with open(inventory_yaml, "r") as f: 13 | ifile = yaml.safe_load(f) 14 | if not isinstance(ifile, dict): 15 | ifile = {} 16 | 17 | # Render the mako template 18 | 19 | t = Template(filename=os.path.join(script_dir, "writefru.cpp.mako")) 20 | 21 | output_hpp = os.path.join(output_dir, "fru-gen.cpp") 22 | with open(output_hpp, "w") as fd: 23 | fd.write(t.render(fruDict=ifile)) 24 | 25 | 26 | def main(): 27 | valid_commands = {"generate-cpp": generate_cpp} 28 | parser = argparse.ArgumentParser( 29 | description="IPMI FRU parser and code generator" 30 | ) 31 | 32 | parser.add_argument( 33 | "-i", 34 | "--inventory_yaml", 35 | dest="inventory_yaml", 36 | default="example.yaml", 37 | help="input inventory yaml file to parse", 38 | ) 39 | 40 | parser.add_argument( 41 | "-o", 42 | "--output-dir", 43 | dest="outputdir", 44 | default=".", 45 | help="output directory", 46 | ) 47 | 48 | parser.add_argument( 49 | "command", 50 | metavar="COMMAND", 51 | type=str, 52 | choices=list(valid_commands.keys()), 53 | help="Command to run.", 54 | ) 55 | 56 | args = parser.parse_args() 57 | 58 | if not (os.path.isfile(args.inventory_yaml)): 59 | sys.exit("Can not find input yaml file " + args.inventory_yaml) 60 | 61 | function = valid_commands[args.command] 62 | function(args.inventory_yaml, args.outputdir) 63 | 64 | 65 | if __name__ == "__main__": 66 | script_dir = os.path.dirname(os.path.realpath(__file__)) 67 | main() 68 | -------------------------------------------------------------------------------- /scripts/writefru.cpp.mako: -------------------------------------------------------------------------------- 1 | // !!! WARNING: This is a GENERATED Code..Please do NOT Edit !!! 2 | #include 3 | #include "frup.hpp" 4 | 5 | extern const FruMap frus = { 6 | % for key in fruDict.keys(): 7 | {${key},{ 8 | <% 9 | instanceList = fruDict[key] 10 | %> 11 | % for instancePath,instanceInfo in instanceList.items(): 12 | <% 13 | entityID = instanceInfo["entityID"] 14 | entityInstance = instanceInfo["entityInstance"] 15 | interfaces = instanceInfo["interfaces"] 16 | %> 17 | {${entityID}, ${entityInstance}, "${instancePath}",{ 18 | % for interface,properties in interfaces.items(): 19 | {"${interface}",{ 20 | % if properties: 21 | % for dbus_property,property_value in properties.items(): 22 | {"${dbus_property}",{ 23 | "${property_value.get("IPMIFruSection", "")}", 24 | "${property_value.get("IPMIFruProperty", "")}",\ 25 | <% 26 | delimiter = property_value.get("IPMIFruValueDelimiter") 27 | if not delimiter: 28 | delimiter = "" 29 | else: 30 | delimiter = '\\' + hex(delimiter)[1:] 31 | %> 32 | "${delimiter}" 33 | }}, 34 | % endfor 35 | %endif 36 | }}, 37 | % endfor 38 | }}, 39 | % endfor 40 | }}, 41 | % endfor 42 | }; 43 | -------------------------------------------------------------------------------- /strgfnhandler.cpp: -------------------------------------------------------------------------------- 1 | #include "writefrudata.hpp" 2 | 3 | #include 4 | #include 5 | 6 | #include 7 | #include 8 | #include 9 | 10 | #include 11 | #include 12 | 13 | void register_netfn_storage_write_fru() __attribute__((constructor)); 14 | 15 | sd_bus* ipmid_get_sd_bus_connection(void); 16 | 17 | using namespace phosphor::logging; 18 | 19 | ///------------------------------------------------------- 20 | // Called by IPMI netfn router for write fru data command 21 | //-------------------------------------------------------- 22 | ipmi_ret_t ipmiStorageWriteFruData( 23 | ipmi_netfn_t /*netfn*/, ipmi_cmd_t /*cmd*/, ipmi_request_t request, 24 | ipmi_response_t response, ipmi_data_len_t dataLen, 25 | ipmi_context_t /*context*/) 26 | { 27 | FILE* fp = nullptr; 28 | char fruFilename[16] = {0}; 29 | size_t offset = 0; 30 | size_t len = 0; 31 | ipmi_ret_t rc = IPMI_CC_INVALID; 32 | const char* mode = nullptr; 33 | 34 | // From the payload, extract the header that has fruid and the offsets 35 | auto reqptr = static_cast(request); 36 | 37 | // Maintaining a temporary file to pump the data 38 | std::sprintf(fruFilename, "%s%02x", "/tmp/ipmifru", reqptr->frunum); 39 | 40 | offset = ((size_t)reqptr->offsetms) << 8 | reqptr->offsetls; 41 | 42 | // Length is the number of request bytes minus the header itself. 43 | // The header contains an extra byte to indicate the start of 44 | // the data (so didn't need to worry about word/byte boundaries) 45 | // hence the -1... 46 | len = ((size_t)*dataLen) - (sizeof(write_fru_data_t) - 1); 47 | 48 | // On error there is no response data for this command. 49 | *dataLen = 0; 50 | 51 | #ifdef __IPMI__DEBUG__ 52 | log("IPMI WRITE-FRU-DATA", entry("FILE=%s", fruFilename), 53 | entry("OFFSET=%d", offset), entry("LENGTH=%d", len)); 54 | #endif 55 | 56 | if (access(fruFilename, F_OK) == -1) 57 | { 58 | mode = "wb"; 59 | } 60 | else 61 | { 62 | mode = "rb+"; 63 | } 64 | 65 | if ((fp = std::fopen(fruFilename, mode)) != nullptr) 66 | { 67 | if (std::fseek(fp, offset, SEEK_SET)) 68 | { 69 | log("Seek into fru file failed", 70 | entry("FILE=%s", fruFilename), 71 | entry("ERRNO=%s", std::strerror(errno))); 72 | std::fclose(fp); 73 | return rc; 74 | } 75 | 76 | if (std::fwrite(&reqptr->data, len, 1, fp) != 1) 77 | { 78 | log("Write into fru file failed", 79 | entry("FILE=%s", fruFilename), 80 | entry("ERRNO=%s", std::strerror(errno))); 81 | std::fclose(fp); 82 | return rc; 83 | } 84 | 85 | std::fclose(fp); 86 | } 87 | else 88 | { 89 | log("Error trying to write to fru file", 90 | entry("FILE=%s", fruFilename)); 91 | return rc; 92 | } 93 | 94 | // If we got here then set the response byte 95 | // to the number of bytes written 96 | std::memcpy(response, &len, 1); 97 | *dataLen = 1; 98 | rc = IPMI_CC_OK; 99 | 100 | // Get the reference to global sd_bus object 101 | sd_bus* bus_type = ipmid_get_sd_bus_connection(); 102 | 103 | // We received some bytes. It may be full or partial. Send a valid 104 | // FRU file to the inventory controller on DBus for the correct number 105 | sdbusplus::bus_t bus{bus_type}; 106 | bool bmcOnlyFru = false; 107 | validateFRUArea(reqptr->frunum, fruFilename, bus, bmcOnlyFru); 108 | 109 | return rc; 110 | } 111 | 112 | //------------------------------------------------------- 113 | // Registering WRITE FRU DATA command handler with daemon 114 | //------------------------------------------------------- 115 | void register_netfn_storage_write_fru() 116 | { 117 | std::printf("Registering NetFn:[0x%X], Cmd:[0x%X]\n", ipmi::netFnStorage, 118 | IPMI_CMD_WRITE_FRU_DATA); 119 | 120 | ipmi_register_callback(ipmi::netFnStorage, IPMI_CMD_WRITE_FRU_DATA, nullptr, 121 | ipmiStorageWriteFruData, SYSTEM_INTERFACE); 122 | } 123 | -------------------------------------------------------------------------------- /subprojects/CLI11.wrap: -------------------------------------------------------------------------------- 1 | [wrap-git] 2 | url = https://github.com/CLIUtils/CLI11.git 3 | revision = HEAD 4 | 5 | [provide] 6 | CLI11 = CLI11_dep 7 | -------------------------------------------------------------------------------- /subprojects/phosphor-host-ipmid.wrap: -------------------------------------------------------------------------------- 1 | [wrap-git] 2 | url = https://github.com/openbmc/phosphor-host-ipmid.git 3 | revision = HEAD 4 | 5 | [provide] 6 | libipmid = ipmid_dep 7 | libchannellayer = channellayer_dep 8 | libuserlayer = userlayer_dep 9 | -------------------------------------------------------------------------------- /subprojects/phosphor-logging.wrap: -------------------------------------------------------------------------------- 1 | [wrap-git] 2 | url = https://github.com/openbmc/phosphor-logging.git 3 | revision = HEAD 4 | 5 | [provide] 6 | phosphor-logging = phosphor_logging_dep 7 | -------------------------------------------------------------------------------- /subprojects/sdbusplus.wrap: -------------------------------------------------------------------------------- 1 | [wrap-git] 2 | url = https://github.com/openbmc/sdbusplus.git 3 | revision = HEAD 4 | 5 | [provide] 6 | sdbusplus = sdbusplus_dep 7 | -------------------------------------------------------------------------------- /types.hpp: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | 5 | #include 6 | #include 7 | #include 8 | 9 | namespace ipmi 10 | { 11 | namespace vpd 12 | { 13 | 14 | using Path = std::string; 15 | 16 | using Property = std::string; 17 | /// The Value type represents all types that are possible for a FRU info. 18 | /// Most fields in a FRU info are boolean or string. There is also a 19 | /// 3-byte timestamp that, being converted to unix time, fits well into 20 | /// uint64_t. 21 | /// 22 | /// However for multirecord area records, there may be other data types, 23 | /// not all of which are directly listed in IPMI FRU specification. 24 | /// 25 | /// Hence, this type lists all types possible for sbdusplus except for 26 | /// unixfd, object_path, and signature. 27 | using Value = std::variant; 29 | using PropertyMap = std::map; 30 | 31 | using Interface = std::string; 32 | using InterfaceMap = std::map; 33 | 34 | using Object = sdbusplus::message::object_path; 35 | using ObjectMap = std::map; 36 | 37 | } // namespace vpd 38 | } // namespace ipmi 39 | -------------------------------------------------------------------------------- /writefrudata.cpp: -------------------------------------------------------------------------------- 1 | #include "writefrudata.hpp" 2 | 3 | #include "fru_area.hpp" 4 | #include "frup.hpp" 5 | #include "types.hpp" 6 | 7 | #include 8 | #include 9 | 10 | #include 11 | #include 12 | 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | 26 | using namespace ipmi::vpd; 27 | using namespace phosphor::logging; 28 | 29 | extern const FruMap frus; 30 | extern const std::map extras; 31 | 32 | using FruAreaVector = std::vector>; 33 | 34 | namespace 35 | { 36 | 37 | /** 38 | * Cleanup routine 39 | * Must always be called as last reference to fruFilePointer. 40 | * 41 | * @param[in] fruFilePointer - FRU file pointer to close 42 | * @param[in] fruAreaVec - vector of FRU areas 43 | * @return -1 44 | */ 45 | int cleanupError(FILE* fruFilePointer, FruAreaVector& fruAreaVec) 46 | { 47 | if (fruFilePointer != nullptr) 48 | { 49 | std::fclose(fruFilePointer); 50 | } 51 | 52 | if (!(fruAreaVec.empty())) 53 | { 54 | fruAreaVec.clear(); 55 | } 56 | 57 | return -1; 58 | } 59 | 60 | /** 61 | * Gets the value of the key from the FRU dictionary of the given section. 62 | * FRU dictionary is parsed FRU data for all the sections. 63 | * 64 | * @param[in] section - FRU section name 65 | * @param[in] key - key for section 66 | * @param[in] delimiter - delimiter for parsing custom fields 67 | * @param[in] fruData - the FRU data to search for the section 68 | * @return FRU value 69 | */ 70 | std::string getFRUValue(const std::string& section, const std::string& key, 71 | const std::string& delimiter, IPMIFruInfo& fruData) 72 | { 73 | auto minIndexValue = 0; 74 | auto maxIndexValue = 0; 75 | std::string fruValue = ""; 76 | 77 | if (section == "Board") 78 | { 79 | minIndexValue = OPENBMC_VPD_KEY_BOARD_MFG_DATE; 80 | maxIndexValue = OPENBMC_VPD_KEY_BOARD_MAX; 81 | } 82 | else if (section == "Product") 83 | { 84 | minIndexValue = OPENBMC_VPD_KEY_PRODUCT_MFR; 85 | maxIndexValue = OPENBMC_VPD_KEY_PRODUCT_MAX; 86 | } 87 | else if (section == "Chassis") 88 | { 89 | minIndexValue = OPENBMC_VPD_KEY_CHASSIS_TYPE; 90 | maxIndexValue = OPENBMC_VPD_KEY_CHASSIS_MAX; 91 | } 92 | 93 | auto first = fruData.cbegin() + minIndexValue; 94 | auto last = first + (maxIndexValue - minIndexValue) + 1; 95 | 96 | auto itr = std::find_if(first, last, [&key](const auto& e) { 97 | return key == e.first; 98 | }); 99 | 100 | if (itr != last) 101 | { 102 | fruValue = itr->second; 103 | } 104 | 105 | // if the key is custom property then the value could be in two formats. 106 | // 1) custom field 2 = "value". 107 | // 2) custom field 2 = "key:value". 108 | // if delimiter length = 0 i.e custom field 2 = "value" 109 | 110 | constexpr auto customProp = "Custom Field"; 111 | if (key.find(customProp) != std::string::npos) 112 | { 113 | if (delimiter.length() > 0) 114 | { 115 | size_t delimiterpos = fruValue.find(delimiter); 116 | if (delimiterpos != std::string::npos) 117 | { 118 | fruValue = fruValue.substr(delimiterpos + 1); 119 | } 120 | } 121 | } 122 | return fruValue; 123 | } 124 | 125 | /** 126 | * Get the inventory service from the mapper. 127 | * 128 | * @param[in] bus - sdbusplus handle to use for dbus call 129 | * @param[in] intf - interface 130 | * @param[in] path - the object path 131 | * @return the dbus service that owns the interface for that path 132 | */ 133 | auto getService(sdbusplus::bus_t& bus, const std::string& intf, 134 | const std::string& path) 135 | { 136 | auto mapperCall = 137 | bus.new_method_call("xyz.openbmc_project.ObjectMapper", 138 | "/xyz/openbmc_project/object_mapper", 139 | "xyz.openbmc_project.ObjectMapper", "GetObject"); 140 | 141 | mapperCall.append(path); 142 | mapperCall.append(std::vector({intf})); 143 | std::map> mapperResponse; 144 | 145 | try 146 | { 147 | auto mapperResponseMsg = bus.call(mapperCall); 148 | mapperResponseMsg.read(mapperResponse); 149 | } 150 | catch (const sdbusplus::exception_t& ex) 151 | { 152 | log("Exception from sdbus call", 153 | entry("WHAT=%s", ex.what())); 154 | throw; 155 | } 156 | 157 | if (mapperResponse.begin() == mapperResponse.end()) 158 | { 159 | throw std::runtime_error("ERROR in reading the mapper response"); 160 | } 161 | 162 | return mapperResponse.begin()->first; 163 | } 164 | 165 | /** 166 | * Takes FRU data, invokes Parser for each FRU record area and updates 167 | * inventory. 168 | * 169 | * @param[in] areaVector - vector of FRU areas 170 | * @param[in] bus - handle to sdbus for calling methods, etc 171 | * @return return non-zero of failure 172 | */ 173 | int updateInventory(FruAreaVector& areaVector, sdbusplus::bus_t& bus) 174 | { 175 | // Generic error reporter 176 | int rc = 0; 177 | uint8_t fruid = 0; 178 | IPMIFruInfo fruData; 179 | 180 | // For each FRU area, extract the needed data , get it parsed and update 181 | // the Inventory. 182 | for (const auto& fruArea : areaVector) 183 | { 184 | fruid = fruArea->getFruID(); 185 | // Fill the container with information 186 | rc = parse_fru_area(fruArea->getType(), 187 | static_cast(fruArea->getData()), 188 | fruArea->getLength(), fruData); 189 | if (rc < 0) 190 | { 191 | log("Error parsing FRU records"); 192 | return rc; 193 | } 194 | } // END walking the vector of areas and updating 195 | 196 | // For each FRU we have the list of instances which needs to be updated. 197 | // Each instance object implements certain interfaces. 198 | // Each Interface is having Dbus properties. 199 | // Each Dbus Property would be having metaData(eg section,VpdPropertyName). 200 | 201 | // Here we are just printing the object,interface and the properties. 202 | // which needs to be called with the new inventory manager implementation. 203 | using namespace std::string_literals; 204 | static const auto intf = "xyz.openbmc_project.Inventory.Manager"s; 205 | static const auto path = "/xyz/openbmc_project/inventory"s; 206 | std::string service; 207 | try 208 | { 209 | service = getService(bus, intf, path); 210 | } 211 | catch (const std::exception& e) 212 | { 213 | std::cerr << e.what() << "\n"; 214 | return -1; 215 | } 216 | 217 | auto iter = frus.find(fruid); 218 | if (iter == frus.end()) 219 | { 220 | log("Unable to find FRUID in generated list", 221 | entry("FRU=%d", static_cast(fruid))); 222 | return -1; 223 | } 224 | 225 | auto& instanceList = iter->second; 226 | if (instanceList.size() <= 0) 227 | { 228 | log("Object list empty for this FRU", 229 | entry("FRU=%d", static_cast(fruid))); 230 | } 231 | 232 | ObjectMap objects; 233 | for (const auto& instance : instanceList) 234 | { 235 | InterfaceMap interfaces; 236 | const auto& extrasIter = extras.find(instance.path); 237 | 238 | for (const auto& interfaceList : instance.interfaces) 239 | { 240 | PropertyMap props; // store all the properties 241 | for (const auto& properties : interfaceList.second) 242 | { 243 | std::string value; 244 | decltype(auto) pdata = properties.second; 245 | 246 | if (!pdata.section.empty() && !pdata.property.empty()) 247 | { 248 | value = getFRUValue(pdata.section, pdata.property, 249 | pdata.delimiter, fruData); 250 | } 251 | props.emplace(std::move(properties.first), std::move(value)); 252 | } 253 | // Check and update extra properties 254 | if (extras.end() != extrasIter) 255 | { 256 | const auto& propsIter = 257 | (extrasIter->second).find(interfaceList.first); 258 | if ((extrasIter->second).end() != propsIter) 259 | { 260 | for (const auto& map : propsIter->second) 261 | { 262 | props.emplace(map.first, map.second); 263 | } 264 | } 265 | } 266 | interfaces.emplace(std::move(interfaceList.first), 267 | std::move(props)); 268 | } 269 | 270 | // Call the inventory manager 271 | sdbusplus::message::object_path objectPath = instance.path; 272 | // Check and update extra properties 273 | if (extras.end() != extrasIter) 274 | { 275 | for (const auto& entry : extrasIter->second) 276 | { 277 | if (interfaces.end() == interfaces.find(entry.first)) 278 | { 279 | interfaces.emplace(entry.first, entry.second); 280 | } 281 | } 282 | } 283 | objects.emplace(objectPath, interfaces); 284 | } 285 | 286 | auto pimMsg = bus.new_method_call(service.c_str(), path.c_str(), 287 | intf.c_str(), "Notify"); 288 | pimMsg.append(std::move(objects)); 289 | 290 | try 291 | { 292 | auto inventoryMgrResponseMsg = bus.call(pimMsg); 293 | } 294 | catch (const sdbusplus::exception_t& ex) 295 | { 296 | log("Error in notify call", entry("WHAT=%s", ex.what()), 297 | entry("SERVICE=%s", service.c_str()), 298 | entry("PATH=%s", path.c_str())); 299 | return -1; 300 | } 301 | 302 | return rc; 303 | } 304 | 305 | } // namespace 306 | 307 | /** 308 | * Takes the pointer to stream of bytes and length and returns the 8 bit 309 | * checksum. This algo is per IPMI V2.0 spec 310 | * 311 | * @param[in] data - data for running crc 312 | * @param[in] len - the length over which to run the crc 313 | * @return the CRC value 314 | */ 315 | unsigned char calculateCRC(const unsigned char* data, size_t len) 316 | { 317 | char crc = 0; 318 | size_t byte = 0; 319 | 320 | for (byte = 0; byte < len; byte++) 321 | { 322 | crc += *data++; 323 | } 324 | 325 | return (-crc); 326 | } 327 | 328 | /** 329 | * Accepts a FRU area offset into a common header and tells which area it is. 330 | * 331 | * @param[in] areaOffset - offset to lookup the area type 332 | * @return the ipmi_fru_area_type 333 | */ 334 | ipmi_fru_area_type getFruAreaType(uint8_t areaOffset) 335 | { 336 | ipmi_fru_area_type type = IPMI_FRU_AREA_TYPE_MAX; 337 | 338 | switch (areaOffset) 339 | { 340 | case IPMI_FRU_INTERNAL_OFFSET: 341 | type = IPMI_FRU_AREA_INTERNAL_USE; 342 | break; 343 | 344 | case IPMI_FRU_CHASSIS_OFFSET: 345 | type = IPMI_FRU_AREA_CHASSIS_INFO; 346 | break; 347 | 348 | case IPMI_FRU_BOARD_OFFSET: 349 | type = IPMI_FRU_AREA_BOARD_INFO; 350 | break; 351 | 352 | case IPMI_FRU_PRODUCT_OFFSET: 353 | type = IPMI_FRU_AREA_PRODUCT_INFO; 354 | break; 355 | 356 | case IPMI_FRU_MULTI_OFFSET: 357 | type = IPMI_FRU_AREA_MULTI_RECORD; 358 | break; 359 | 360 | default: 361 | type = IPMI_FRU_AREA_TYPE_MAX; 362 | } 363 | 364 | return type; 365 | } 366 | 367 | /** 368 | * Validates the data for multirecord fields and CRC if selected 369 | * 370 | * @param[in] data - the data to verify 371 | * @param[in] len - the length of the region to verify 372 | * @param[in] validateCrc - whether to validate the CRC 373 | * @return non-zero on failure 374 | */ 375 | int verifyFruMultiRecData(const uint8_t* data, const size_t len, 376 | bool validateCrc) 377 | { 378 | uint8_t checksum = 0; 379 | int rc = -1; 380 | 381 | if (!validateCrc) 382 | { 383 | // There's nothing else to do for this area. 384 | return EXIT_SUCCESS; 385 | } 386 | 387 | // As per the IPMI platform spec, byte[3] is the record checksum. 388 | checksum = calculateCRC(data, len); 389 | if (checksum != data[3]) 390 | { 391 | #ifdef __IPMI_DEBUG__ 392 | log( 393 | "Checksum mismatch", 394 | entry("Calculated=0x%X", static_cast(checksum)), 395 | entry("Embedded=0x%X", static_cast(data[3]))); 396 | #endif 397 | return rc; 398 | } 399 | #ifdef __IPMI_DEBUG__ 400 | else 401 | { 402 | log("Checksum matches"); 403 | } 404 | #endif 405 | 406 | return EXIT_SUCCESS; 407 | } 408 | 409 | /** 410 | * Validates the data for mandatory fields and CRC if selected. 411 | * 412 | * @param[in] data - the data to verify 413 | * @param[in] len - the length of the region to verify 414 | * @param[in] validateCrc - whether to validate the CRC 415 | * @return non-zero on failure 416 | */ 417 | int verifyFruData(const uint8_t* data, const size_t len, bool validateCrc) 418 | { 419 | uint8_t checksum = 0; 420 | int rc = -1; 421 | 422 | // Validate for first byte to always have a value of [1] 423 | if (data[0] != IPMI_FRU_HDR_BYTE_ZERO) 424 | { 425 | log("Invalid entry in byte-0", 426 | entry("ENTRY=0x%X", static_cast(data[0]))); 427 | return rc; 428 | } 429 | #ifdef __IPMI_DEBUG__ 430 | else 431 | { 432 | log("Validated in entry_1 of fruData", 433 | entry("ENTRY=0x%X", static_cast(data[0]))); 434 | } 435 | #endif 436 | 437 | if (!validateCrc) 438 | { 439 | // There's nothing else to do for this area. 440 | return EXIT_SUCCESS; 441 | } 442 | 443 | // See if the calculated CRC matches with the embedded one. 444 | // CRC to be calculated on all except the last one that is CRC itself. 445 | checksum = calculateCRC(data, len - 1); 446 | if (checksum != data[len - 1]) 447 | { 448 | #ifdef __IPMI_DEBUG__ 449 | log( 450 | "Checksum mismatch", 451 | entry("Calculated=0x%X", static_cast(checksum)), 452 | entry("Embedded=0x%X", static_cast(data[len]))); 453 | #endif 454 | return rc; 455 | } 456 | #ifdef __IPMI_DEBUG__ 457 | else 458 | { 459 | log("Checksum matches"); 460 | } 461 | #endif 462 | 463 | return EXIT_SUCCESS; 464 | } 465 | 466 | /** 467 | * Checks if a particular FRU area is populated or not. 468 | * 469 | * @param[in] reference to FRU area pointer 470 | * @return true if the area is empty 471 | */ 472 | bool removeInvalidArea(const std::unique_ptr& fruArea) 473 | { 474 | // Filter the ones that are empty 475 | if (!(fruArea->getLength())) 476 | { 477 | return true; 478 | } 479 | return false; 480 | } 481 | 482 | /** 483 | * Populates various FRU areas. 484 | * 485 | * @prereq : This must be called only after validating common header 486 | * @param[in] fruData - pointer to the FRU bytes 487 | * @param[in] dataLen - the length of the FRU data 488 | * @param[in] fruAreaVec - the FRU area vector to update 489 | */ 490 | int ipmiPopulateFruAreas(uint8_t* fruData, const size_t dataLen, 491 | FruAreaVector& fruAreaVec) 492 | { 493 | // Now walk the common header and see if the file size has at least the last 494 | // offset mentioned by the struct common_header. If the file size is less 495 | // than the offset of any if the FRU areas mentioned in the common header, 496 | // then we do not have a complete file. 497 | for (uint8_t fruEntry = IPMI_FRU_INTERNAL_OFFSET; 498 | fruEntry < (sizeof(struct common_header) - 2); fruEntry++) 499 | { 500 | int rc = -1; 501 | // Actual offset in the payload is the offset mentioned in common header 502 | // multiplied by 8. Common header is always the first 8 bytes. 503 | size_t areaOffset = fruData[fruEntry] * IPMI_EIGHT_BYTES; 504 | if (areaOffset && (dataLen < (areaOffset + 2))) 505 | { 506 | // Our file size is less than what it needs to be. +2 because we are 507 | // using area len that is at 2 byte off areaOffset 508 | log("FRU file is incomplete", 509 | entry("SIZE=%d", dataLen)); 510 | return rc; 511 | } 512 | else if (areaOffset) 513 | { 514 | // Read 3 bytes to know the actual size of area. 515 | uint8_t areaHeader[3] = {0}; 516 | std::memcpy(areaHeader, &((uint8_t*)fruData)[areaOffset], 517 | sizeof(areaHeader)); 518 | 519 | // Size of this area will be the 2nd byte in the FRU area header. 520 | size_t areaLen; 521 | if (fruEntry == IPMI_FRU_MULTI_OFFSET) 522 | { 523 | areaLen = areaHeader[2] + IPMI_FRU_MULTIREC_HDR_BYTES; 524 | } 525 | else 526 | { 527 | areaLen = areaHeader[1] * IPMI_EIGHT_BYTES; 528 | } 529 | 530 | log("FRU Data", entry("SIZE=%d", dataLen), 531 | entry("AREA OFFSET=%d", areaOffset), 532 | entry("AREA_SIZE=%d", areaLen)); 533 | 534 | // See if we really have that much buffer. We have area offset amd 535 | // from there, the actual len. 536 | if (dataLen < (areaLen + areaOffset)) 537 | { 538 | log("Incomplete FRU file", 539 | entry("SIZE=%d", dataLen)); 540 | return rc; 541 | } 542 | 543 | auto fruDataView = 544 | std::span(&fruData[areaOffset], areaLen); 545 | auto areaData = 546 | std::vector(fruDataView.begin(), fruDataView.end()); 547 | 548 | // Validate the CRC, but not for the internal use area, since its 549 | // contents beyond the first byte are not defined in the spec and 550 | // it may not end with a CRC byte. 551 | bool validateCrc = fruEntry != IPMI_FRU_INTERNAL_OFFSET; 552 | 553 | if (fruEntry == IPMI_FRU_MULTI_OFFSET) 554 | { 555 | rc = verifyFruMultiRecData(areaData.data(), areaLen, 556 | validateCrc); 557 | } 558 | else 559 | { 560 | rc = verifyFruData(areaData.data(), areaLen, validateCrc); 561 | } 562 | 563 | if (rc < 0) 564 | { 565 | log("Err validating FRU area", 566 | entry("OFFSET=%d", areaOffset)); 567 | return rc; 568 | } 569 | else 570 | { 571 | log("Successfully verified area.", 572 | entry("OFFSET=%d", areaOffset)); 573 | } 574 | 575 | // We already have a vector that is passed to us containing all 576 | // of the fields populated. Update the data portion now. 577 | for (auto& iter : fruAreaVec) 578 | { 579 | if (iter->getType() == getFruAreaType(fruEntry)) 580 | { 581 | iter->setData(areaData.data(), areaLen); 582 | } 583 | } 584 | } // If we have FRU data present 585 | } // Walk struct common_header 586 | 587 | // Not all the fields will be populated in a FRU data. Mostly all cases will 588 | // not have more than 2 or 3. 589 | fruAreaVec.erase( 590 | std::remove_if(fruAreaVec.begin(), fruAreaVec.end(), removeInvalidArea), 591 | fruAreaVec.end()); 592 | 593 | return EXIT_SUCCESS; 594 | } 595 | 596 | /** 597 | * Validates the FRU data per ipmi common header constructs. 598 | * Returns with updated struct common_header and also file_size 599 | * 600 | * @param[in] fruData - the FRU data 601 | * @param[in] dataLen - the length of the data 602 | * @return non-zero on failure 603 | */ 604 | int ipmiValidateCommonHeader(const uint8_t* fruData, const size_t dataLen) 605 | { 606 | int rc = -1; 607 | 608 | uint8_t commonHdr[sizeof(struct common_header)] = {0}; 609 | if (dataLen >= sizeof(commonHdr)) 610 | { 611 | std::memcpy(commonHdr, fruData, sizeof(commonHdr)); 612 | } 613 | else 614 | { 615 | log("Incomplete FRU data file", entry("SIZE=%d", dataLen)); 616 | return rc; 617 | } 618 | 619 | // Verify the CRC and size 620 | rc = verifyFruData(commonHdr, sizeof(commonHdr), true); 621 | if (rc < 0) 622 | { 623 | log("Failed to validate common header"); 624 | return rc; 625 | } 626 | 627 | return EXIT_SUCCESS; 628 | } 629 | 630 | int validateFRUArea(const uint8_t fruid, const char* fruFilename, 631 | sdbusplus::bus_t& bus, const bool bmcOnlyFru) 632 | { 633 | size_t dataLen = 0; 634 | size_t bytesRead = 0; 635 | int rc = -1; 636 | 637 | // Vector that holds individual IPMI FRU AREAs. Although MULTI and INTERNAL 638 | // are not used, keeping it here for completeness. 639 | FruAreaVector fruAreaVec; 640 | 641 | for (uint8_t fruEntry = IPMI_FRU_INTERNAL_OFFSET; 642 | fruEntry < (sizeof(struct common_header) - 2); fruEntry++) 643 | { 644 | // Create an object and push onto a vector. 645 | std::unique_ptr fruArea = std::make_unique( 646 | fruid, getFruAreaType(fruEntry), bmcOnlyFru); 647 | 648 | // Physically being present 649 | bool present = access(fruFilename, F_OK) == 0; 650 | fruArea->setPresent(present); 651 | 652 | fruAreaVec.emplace_back(std::move(fruArea)); 653 | } 654 | 655 | FILE* fruFilePointer = std::fopen(fruFilename, "rb"); 656 | if (fruFilePointer == nullptr) 657 | { 658 | log("Unable to open FRU file", 659 | entry("FILE=%s", fruFilename), 660 | entry("ERRNO=%s", std::strerror(errno))); 661 | return cleanupError(fruFilePointer, fruAreaVec); 662 | } 663 | 664 | // Get the size of the file to see if it meets minimum requirement 665 | if (std::fseek(fruFilePointer, 0, SEEK_END)) 666 | { 667 | log("Unable to seek FRU file", 668 | entry("FILE=%s", fruFilename), 669 | entry("ERRNO=%s", std::strerror(errno))); 670 | return cleanupError(fruFilePointer, fruAreaVec); 671 | } 672 | 673 | // Allocate a buffer to hold entire file content 674 | dataLen = std::ftell(fruFilePointer); 675 | 676 | auto fruData = std::vector(dataLen, 0); 677 | 678 | std::rewind(fruFilePointer); 679 | bytesRead = std::fread(fruData.data(), dataLen, 1, fruFilePointer); 680 | if (bytesRead != 1) 681 | { 682 | log("Failed reading FRU data.", 683 | entry("BYTESREAD=%d", bytesRead), 684 | entry("ERRNO=%s", std::strerror(errno))); 685 | return cleanupError(fruFilePointer, fruAreaVec); 686 | } 687 | 688 | // We are done reading. 689 | std::fclose(fruFilePointer); 690 | fruFilePointer = nullptr; 691 | 692 | rc = ipmiValidateCommonHeader(fruData.data(), dataLen); 693 | if (rc < 0) 694 | { 695 | return cleanupError(fruFilePointer, fruAreaVec); 696 | } 697 | 698 | // Now that we validated the common header, populate various FRU sections if 699 | // we have them here. 700 | rc = ipmiPopulateFruAreas(fruData.data(), dataLen, fruAreaVec); 701 | if (rc < 0) 702 | { 703 | log("Populating FRU areas failed", entry("FRU=%d", fruid)); 704 | return cleanupError(fruFilePointer, fruAreaVec); 705 | } 706 | else 707 | { 708 | log("Populated FRU areas", entry("FILE=%s", fruFilename)); 709 | } 710 | 711 | #ifdef __IPMI_DEBUG__ 712 | for (const auto& iter : fruAreaVec) 713 | { 714 | std::printf("FRU ID : [%d]\n", iter->getFruID()); 715 | std::printf("AREA NAME : [%s]\n", iter->getName()); 716 | std::printf("TYPE : [%d]\n", iter->getType()); 717 | std::printf("LEN : [%d]\n", iter->getLength()); 718 | } 719 | #endif 720 | 721 | // If the vector is populated with everything, then go ahead and update the 722 | // inventory. 723 | if (!(fruAreaVec.empty())) 724 | { 725 | #ifdef __IPMI_DEBUG__ 726 | std::printf("\n SIZE of vector is : [%d] \n", fruAreaVec.size()); 727 | #endif 728 | rc = updateInventory(fruAreaVec, bus); 729 | if (rc < 0) 730 | { 731 | log("Error updating inventory."); 732 | } 733 | } 734 | 735 | // we are done with all that we wanted to do. This will do the job of 736 | // calling any destructors too. 737 | fruAreaVec.clear(); 738 | 739 | return rc; 740 | } 741 | -------------------------------------------------------------------------------- /writefrudata.hpp: -------------------------------------------------------------------------------- 1 | #ifndef __IPMI_WRITE_FRU_DATA_H__ 2 | #define __IPMI_WRITE_FRU_DATA_H__ 3 | 4 | #include 5 | 6 | // IPMI commands for Storage net functions. 7 | enum ipmi_netfn_storage_cmds 8 | { 9 | IPMI_CMD_WRITE_FRU_DATA = 0x12 10 | }; 11 | 12 | // Format of write fru data command 13 | struct write_fru_data_t 14 | { 15 | uint8_t frunum; 16 | uint8_t offsetls; 17 | uint8_t offsetms; 18 | uint8_t data; 19 | } __attribute__((packed)); 20 | 21 | // Per IPMI v2.0 FRU specification 22 | struct common_header 23 | { 24 | uint8_t fixed; 25 | uint8_t internal_offset; 26 | uint8_t chassis_offset; 27 | uint8_t board_offset; 28 | uint8_t product_offset; 29 | uint8_t multi_offset; 30 | uint8_t pad; 31 | uint8_t crc; 32 | } __attribute__((packed)); 33 | 34 | // first byte in header is 1h per IPMI V2 spec. 35 | #define IPMI_FRU_HDR_BYTE_ZERO 1 36 | #define IPMI_FRU_INTERNAL_OFFSET offsetof(struct common_header, internal_offset) 37 | #define IPMI_FRU_CHASSIS_OFFSET offsetof(struct common_header, chassis_offset) 38 | #define IPMI_FRU_BOARD_OFFSET offsetof(struct common_header, board_offset) 39 | #define IPMI_FRU_PRODUCT_OFFSET offsetof(struct common_header, product_offset) 40 | #define IPMI_FRU_MULTI_OFFSET offsetof(struct common_header, multi_offset) 41 | #define IPMI_FRU_HDR_CRC_OFFSET offsetof(struct common_header, crc) 42 | #define IPMI_EIGHT_BYTES 8 43 | #define IPMI_FRU_MULTIREC_HDR_BYTES 5 44 | 45 | /** 46 | * Validate a FRU. 47 | * 48 | * @param[in] fruid - The ID to use for this FRU. 49 | * @param[in] fruFilename - the filename of the FRU. 50 | * @param[in] bus - an sdbusplus systemd bus for publishing the information. 51 | * @param[in] bmcOnlyFru - If a particular area accessible only by BMC. 52 | */ 53 | int validateFRUArea(const uint8_t fruid, const char* fruFilename, 54 | sdbusplus::bus_t& bus, const bool bmcOnlyFru); 55 | 56 | #endif 57 | --------------------------------------------------------------------------------