phosphor-power/phosphor-power-supply/power_supply.hpp

38 static constexpr auto FL_KW_SIZE = 20;
163      * @brief Function to specifically clear VIN_UV/OFF fault(s).
189      * @brief Adds properties to the inventory.
206      * @brief Accessor function to indicate present status
214      * @brief Returns the last read value from STATUS_WORD.
222      * @brief Returns the last read value from STATUS_INPUT.
230      * @brief Returns the last read value from STATUS_MFR.
238      * @brief Returns the last read value from STATUS_CML.
246      * @brief Returns the last read value from STATUS_VOUT.
254      * @brief Returns the last value read from STATUS_IOUT.
262      * @brief Returns the last value read from STATUS_FANS_1_2.
270      * @brief Returns the last value read from STATUS_TEMPERATURE.
278      * @brief Returns true if a fault was found.
293      * @brief Return whether a fault has been logged for this power supply
301      * @brief Called when a fault for this power supply has been logged.
309      * @brief Returns true if INPUT fault occurred.
317      * @brief Returns true if MFRSPECIFIC occurred.
325      * @brief Returns true if VIN_UV_FAULT occurred.
333      * @brief Returns true if VOUT_OV_FAULT occurred.
341      * @brief Returns true if IOUT_OC fault occurred (bit 4 STATUS_BYTE).
349      * @brief Returns true if VOUT_UV_FAULT occurred.
357      *@brief Returns true if fan fault occurred.
365      * @brief Returns true if TEMPERATURE fault occurred.
373      * @brief Returns true if there is a PGood fault (PGOOD# inactive, or OFF
382      * @brief Return true if there is a PS_Kill fault.
390      * @brief Returns true if there is a 12Vcs (standy power) fault.
398      * @brief Returns true if there is a 12V current-share fault.
406      * @brief Returns true if an AC fault has occurred in the window of
415      * @brief Returns the device path
426      * @brief Returns this power supply's inventory path.
438      * @brief Returns the short name (last part of inventoryPath).
446      * @brief Returns the firmware revision version read from the power supply
454      * @brief Returns the model name of the power supply
462      * @brief Returns true if the number of failed reads exceeds limit
470      * @brief Reads the pmbus input voltage and returns that actual voltage
479      * @brief Check if the PS is considered to be available or not
496      * @brief Returns true when INPUT_HISTORY sync is required.
504      * @brief Clears the indicator that sync required for INPUT_HISTORY.
516      * @brief Puts the input voltage rating on D-Bus.
523      * @brief Returns the peak input power value if there is one,
537      * @brief Converts a Linear Format power number to an integer
550      * @brief Retrieve device driver name
558      * @brief Set device driver name
568      * @brief Examine STATUS_WORD for CML (communication, memory, logic fault).
573      * @brief Examine STATUS_WORD for INPUT bit on.
581      * @brief Examine STATUS_WORD for VOUT being set.
589      * @brief Examine STATUS_WORD value read for IOUT_OC_FAULT.
597      * @brief Examines STATUS_WORD value read to see if there is a UV fault.
606      * @brief Examine STATUS_WORD for the fan fault/warning bit.
615      * @brief Examine STATUS_WORD for temperature fault.
620      * @brief Examine STATUS_WORD for pgood or unit off faults.
625      * @brief Determine possible manufacturer-specific faults from bits in
635      * @brief Examine STATUS_WORD value read for MFRSPECIFIC bit on.
645      * @brief Analyzes the STATUS_WORD for a VIN_UV_FAULT indicator.
650      * @brief Given a full inventory path, returns the last node of the path as
669      * @brief Binds or unbinds the power supply device driver
687      *  @brief Updates the presence status by querying D-Bus
696      * @brief Updates the power supply presence by reading the GPIO line.
701      * @brief Callback for inventory property changes
713      * @brief Callback for inventory property added.
725      * @brief Reads the pmbus MFR_POUT_MAX value.
735      * @brief Reads a VPD value from PMBus, correct size, and contents.
752      * @brief Retrieve PSU VPD keyword from D-Bus
762      * @brief Creates the appropriate sensor D-Bus objects.
767      * @brief Monitors sensor values and updates D-Bus.
773      * @brief Creates the peak input power sensor D-Bus object
779      * @brief Monitors the peak input power sensor
784      * @brief Sets any sensor objects to Available = false on D-Bus.
789      * @brief Returns the associations to create for a sensor on this
795      * @brief systemd bus member
800      * @brief D-Bus path to use for this power supply's inventory status.
805      * @brief The file system path used for binding the device driver.
810      * @brief Get the power on status of the psu manager class.
818      * @brief Set to true when INPUT_HISTORY sync is required.
827      * @brief Store the short name to avoid string processing.
835      * @brief The libgpiod object for monitoring PSU presence
840      * @brief True if the power supply is present.
845      * @brief Power supply model name.
850      * @brief D-Bus match variable used to subscribe to Present property
856      * @brief D-Bus match variable used to subscribe for Present property
862      * @brief Pointer to the PMBus interface
869      * @brief Stored copy of the firmware version/revision string
874      * @brief The string to pass in for binding the device driver.
879      * @brief The result of the most recent availability check
886      * @brief Will be updated to the latest/lastvalue read from STATUS_WORD.
891      * @brief Will be set to the last read value of STATUS_WORD.
896      * @brief Will be updated to the latest/lastvalue read from STATUS_INPUT.
901      * @brief Will be updated to the latest/lastvalue read from STATUS_MFR.
906      * @brief Will be updated to the latest/last value read from STATUS_CML.
911      * @brief Will be updated to the latest/last value read from STATUS_VOUT.
916      * @brief Will be updated to the latest/last value read from STATUS_IOUT.
921      * @brief Will be updated to the latest/last value read from
927      * @brief Will be updated to the latest/last value read from
933      * @brief Will be updated with latest converted value read from READ_VIN
938      * @brief Will be updated with the actual voltage last read from READ_VIN
943      * @brief True if an error for a fault has already been logged.
948      * @brief Incremented if bit 1 of STATUS_WORD low byte is on.
955      * @brief Incremented if bit 5 of STATUS_WORD high byte is on.
962      * @brief Incremented if bit 4 of STATUS_WORD high byte is on.
969      * @brief Incremented if bit 3 of STATUS_WORD low byte is on.
976      * @brief Incremented if bit 5 of STATUS_WORD low byte is on.
983      * @brief Incremented if bit 4 of STATUS_WORD low byte is on.
990      * @brief Incremented if bit 7 of STATUS_WORD high byte is on and bit 5
998      * @brief Incremented if FANS fault/warn bit on in STATUS_WORD.
1005      * @brief Incremented if bit 2 of STATUS_WORD low byte is on.
1012      * @brief Incremented if bit 11 or 6 of STATUS_WORD is on. PGOOD# is
1020      * @brief Power Supply Kill fault.
1029      * @brief Power Supply 12Vcs fault (standby power).
1038      * @brief Power Supply Current-Share fault in 12V domain.
1047      * @brief Set to AC_FAULT_LIMIT when AC fault is detected, decremented when
1054      * @brief Count of the number of read failures.
1059      * @brief The D-Bus object for the input voltage rating
1068      * @brief The D-Bus object for the peak input power sensor.
1073      * @brief The device driver name