37  * status of a voltage rail.
56  * @class Rail
58  * A voltage rail that is enabled or monitored by the power sequencer device.
60 class Rail  class
64     Rail() = delete;
65     Rail(const Rail&) = delete;
66     Rail(Rail&&) = delete;
67     Rail& operator=(const Rail&) = delete;
68     Rail& operator=(Rail&&) = delete;
69     ~Rail() = default;
76      * @param name Unique name for the rail
78      *                 must be present in order for the rail to be present
79      * @param page Optional PMBus PAGE number of the rail.  Required if
81      * @param isPowerSupplyRail Specifies whether the rail is produced by a
85      *                        status of the rail
88      *                              determining the pgood status of the rail
90      *             rail
92     explicit Rail(const std::string& name,  in Rail()  function in phosphor::power::sequencer::Rail
109      * Returns the unique name for the rail.
111      * @return rail name
120      * present in order for the rail to be present.
130      * Returns the PMBus PAGE number of the rail.
132      * @return PAGE number for rail
140      * Returns whether the rail is produced by a power supply.
142      * @return true if rail is produced by a power supply, false otherwise
151      * when determining the pgood status of the rail.
162      * fault limit when determining the pgood status of the rail.
172      * Returns the GPIO to read to determine the pgood status of the rail.
182      * Returns whether the rail is present.
187      * @return true if rail is present, false otherwise
192      * Returns the value of the PMBus STATUS_WORD command for the rail.
199      * @param device Power sequencer device that enables and monitors the rail
205      * Returns the value of the PMBus STATUS_VOUT command for the rail.
211      * @param device Power sequencer device that enables and monitors the rail
217      * Returns the value of the PMBus READ_VOUT command for the rail.
224      * @param device Power sequencer device that enables and monitors the rail
230      * Returns the value of the PMBus VOUT_UV_FAULT_LIMIT command for the rail.
237      * @param device Power sequencer device that enables and monitors the rail
243      * Returns whether a pgood (power good) fault has occurred on the rail.
245      * Throws an exception if an error occurs while trying to obtain the rail
248      * @param device Power sequencer device that enables and monitors the rail
253      * @return true if a pgood fault was found on the rail, false otherwise
261      * has occurred on the rail.
263      * Throws an exception if an error occurs while trying to obtain the rail
266      * @param device Power sequencer device that enables and monitors the rail
270      * @return true if a pgood fault was found on the rail, false otherwise
278      * rail.
280      * Throws an exception if an error occurs while trying to obtain the rail
283      * @param device Power sequencer device that enables and monitors the rail
288      * @return true if a pgood fault was found on the rail, false otherwise
296      * indicating a pgood fault has occurred on the rail.
298      * Throws an exception if an error occurs while trying to obtain the rail
301      * @param device Power sequencer device that enables and monitors the rail
305      * @return true if a pgood fault was found on the rail, false otherwise
313      * Verifies that a PMBus PAGE number is defined for the rail.
325      * @param device Power sequencer device that enables and monitors the rail
334      * Unique name for the rail.
340      * for the rail to be present.
342      * If not specified, the rail is assumed to always be present.
347      * PMBus PAGE number of the rail.
352      * Specifies whether the rail is produced by a power supply.
358      * when determining the pgood status of the rail.
360      * If one of the error bits is set in STATUS_VOUT, the rail pgood will be
367      * limit when determining the pgood status of the rail.
369      * If the output voltage is below this limit, the rail pgood will be
377      * GPIO to read to determine the pgood status of the rail.