extensions/openpower-pels/src.hpp

35  * This class represents the SRC sections in the PEL, of which there are 2:
37  * difference is that the primary SRC must be the 3rd section in the PEL if
62      * @brief Enums for the error status bits in hex word 5
83      * Fills in this class's data fields from the stream.
85      * @param[in] pel - the PEL data stream
96      * @param[in] regEntry - The message registry entry for this event log
97      * @param[in] additionalData - The AdditionalData properties in this event
99      * @param[in] dataIface - The DataInterface object
113      * @param[in] regEntry - The message registry entry for this event log
114      * @param[in] additionalData - The AdditionalData properties in this event
116      * @param[in] jsonCallouts - The array of JSON callouts, or an empty object.
117      * @param[in] dataIface - The DataInterface object
125      * @param[in] stream - The stream to write to
131      *        than the version byte in the section header.
216      * @brief Says if this SRC has additional subsections in it
230      * This comes from a field in the message registry for BMC
247      * @param[in] wordNum - The SRC word number, as defined by the spec.
258      * @brief Get section in JSON.
259      * @param[in] registry - Registry object reference
260      * @param[in] plugins - Vector of strings of plugins found in filesystem
261      * @param[in] creatorID - Creator Subsystem ID from Private Header
270      * @param[in] registry - Registry object
271      * @param[in] type - detail level enum value : single message or full json
272      * @param[in] toCache - boolean to cache registry in memory, default=false
294      * @brief Set the terminate bit in hex data word 3.
313      * @param[in] rawProgressSRC - The progress SRC bytes
320      * @brief Return the value of the passed in error status flag.
322      * @param[in] flag - The flag
332      * @brief Clears an error status flag in the SRC.
334      * @param[in] flag - The flag to set
343      * @brief Fills in the user defined hex words from the
348      * fields to use to fill in the user defined hex data words 6-9
353      * key X, convert it to a uint32_t, and save it in user data word Y.
355      * @param[in] regEntry - The message registry entry for the error
356      * @param[in] additionalData - The AdditionalData map
361      * @brief Fills in the object from the stream data
363      * @param[in] stream - The stream to read from
368      * @brief Says if the word number is in the range of user defined words.
372      * used to fill them in based on the contents of the OpenBMC event log.
374      * @param[in] wordNum - The SRC word number, as defined by the spec.
376      * @return bool - If this word number can be filled in by the creator.
384      * @brief Sets the SRC format byte in the hex word data.
405      * @param[in] dataIface - The DataInterface object
412      * @param[in] dataIface - The DataInterface object
417      * @brief Sets an error status bit in the SRC.
419      * @param[in] flag - The flag to set
429      * Updates _valid (in Section) with the results.
435      * @param[in] regEntry - The message registry entry for the error
442      * @brief Get Callout info in JSON
454      * @param[in] regEntry - The message registry entry for the error
455      * @param[in] additionalData - The AdditionalData values
456      * @param[in] jsonCallouts - The array of JSON callouts, or an empty object
457      * @param[in] dataIface - The DataInterface object
467      * @param[in] inventoryPath - The inventory item to call out
468      * @param[in] priority - An optional priority (uses high if nullopt)
469      * @param[in] locationCode - The expanded location code (or look it up)
470      * @param[in] dataIface - The DataInterface object
471      * @param[in] mrus - The MRUs to add to the callout
483      * @param[in] regEntry - The message registry entry for the error
484      * @param[in] additionalData - The AdditionalData property
485      * @param[in] dataIface - The DataInterface object
493      *        passed in to the SRC.
495      * The last parameter is used only in a special case when the first
499      * @param[in] callouts - The message registry callouts to add
500      * @param[in] dataIface - The DataInterface object
501      * @param[in] trustedSymbolicFRUInvPath - The optional inventory path used
502      *                                        in the symbolic FRU case.
512      * If the last parameter is filled in, and the registry callout is a
517      * @param[in] callout - The registry callout structure
518      * @param[in] dataIface - The DataInterface object
519      * @param[in] trustedSymbolicFRUInvPath - The optional inventory path used
520      *                                        in the symbolic FRU case.
541      * @brief Adds any FRU callouts based on a device path in the
544      * @param[in] additionalData - The AdditionalData values
545      * @param[in] dataIface - The DataInterface object
551      * @brief Adds any FRU callouts specified in the incoming JSON.
553      * @param[in] jsonCallouts - The JSON array of callouts
554      * @param[in] dataIface - The DataInterface object
562      * @param[in] jsonCallouts - A single callout entry
563      * @param[in] dataIface - The DataInterface object
574      * @param[in] locationCode - The location code
575      * @param[in] priority - The callout priority
584      * @param[in] json - A JSON object that contains the priority key
594      * @param[in] mruJSON - The JSON array
636      * In the spec these are referred to as SRC words 2 - 9 as words 0 and 1