phosphor-fan-presence/control/zone.hpp

29  *   - init - only do the initialization steps
30  *   - control - run normal control algorithms
57      * @param[in] mode - mode of fan control
58      * @param[in] bus - the dbus object
59      * @param[in] path - object instance path
60      * @param[in] event - Event loop reference
61      * @param[in] def - the fan zone definition data
97      * Sets all fans in the zone to the speed
100      * @param[in] speed - the fan speed
102     void setSpeed(uint64_t speed);
105      * Sets the zone to full speed regardless of zone's active state
112      * @param[in] group - A group that affects the active state
113      * @param[in] isActiveAllow - Active state according to group
120      * @param[in] group - A group that affects floor changes
121      * @param[in] isAllow - Allow state according to group
131      * @param[in] group - A group that affects speed decreases
132      * @param[in] isAllow - Allow state according to group
142      * @param[in] object - Name of the object containing the property
143      * @param[in] interface - Interface name containing the property
144      * @param[in] property - Property name
145      * @param[in] data - Property value
157      * @param[in] object - Name of the object containing the property
158      * @param[in] interface - Interface name containing the property
159      * @param[in] property - Property name
160      * @param[in] value - Property value
172      * @param[in] object - Name of the object containing the property
173      * @param[in] interface - Interface name containing the property
174      * @param[in] property - Property name
175      * @param[in] value - Property value
188      * @param[in] object - Name of the object containing the property
189      * @param[in] interface - Interface name containing the property
190      * @param[in] property - Property name
192      * @return - The property value
205      * @param[in] object - Name of the object containing the property
206      * @param[in] interface - Interface name containing the property
207      * @param[in] property - Property name
209      * @return - The property variant
234         // https://gerrit.openbmc-project.xyz/11739  in getPropertyValueVisitor()
240             // A non-supported type configured will assert.  in getPropertyValueVisitor()
279      * @param[in] object - Name of the object with the interface
280      * @param[in] interface - Interface name to remove
294      * @param[in] group - Group associated with service
295      * @param[in] name - Service name to remove
302      * @param[in] group - Group associated with service
303      * @param[in] name - Service name
304      * @param[in] hasOwner - Whether the service is owned or not
312      * @param[in] group - Group to get service names for
319      * @param[in] group - Group to get service names for
321      * @return - The list of service names
329      * @brief Initialize a set speed event properties and actions
331      * @param[in] event - Set speed event
336      * @brief Removes all the set speed event properties and actions
338      * @param[in] event - Set speed event
343      * @brief Get the default floor speed
345      * @return - The defined default floor speed
355      * @param[in] speed - Speed to set the default floor to
357     inline void setDefFloor(uint64_t speed)  in setDefFloor()  argument
359         _defFloorSpeed = speed;  in setDefFloor()
363      * @brief Get the ceiling speed
365      * @return - The current ceiling speed
373      * @brief Set the ceiling speed to the given speed
375      * @param[in] speed - Speed to set the ceiling to
377     inline void setCeiling(uint64_t speed)  in setCeiling()  argument
379         _ceilingSpeed = speed;  in setCeiling()
386      * @param[in] keyValue - New ceiling key value
388      * @return - Ceiling key value prior to swapping
397      * @brief Get the increase speed delta
399      * @return - The current increase speed delta
407      * @brief Get the decrease speed delta
409      * @return - The current decrease speed delta
417      * @brief Set the floor speed to the given speed and increase target
418      * speed to the floor when target is below floor where floor changes
421      * @param[in] speed - Speed to set the floor to
423     void setFloor(uint64_t speed);
426      * @brief Set the requested speed base to be used as the speed to
427      * base a new requested speed target from
429      * @param[in] speedBase - Base speed value to use
437      * @brief Calculate the requested target speed from the given delta
440      * @param[in] targetDelta - The delta to increase the target speed by
445      * @brief Calculate the requested target speed from the given delta
448      * @param[in] targetDelta - The delta to increase the target speed by
454      * processing of requested speed increases while fans are increasing
460      * requested speed decreases if allowed
467      * @return - The event loop for timers
477      * @param[in] seIter - Iterator pointing to the signal event to remove
491      * @return - List of timer events
501      * @param[in] eventGroup - Group associated with a timer
502      * @param[in] eventActions - List of actions associated with a timer
503      * @param[in] eventTimers - List of timers to find the timer in
505      * @return - Iterator to the timer event
514      * @param[in] name - Event name associated with timer
515      * @param[in] group - Group associated with a timer
516      * @param[in] actions - List of actions associated with a timer
517      * @param[in] tConf - Configuration for the new timer
526      * @param[in] eventGroup - Group to process actions on
527      * @param[in] eventActions - List of event actions to run
536      * @param[in] path - Path to get service for
537      * @param[in] intf - Interface to get service for
539      * @return - The service name
549      * @param[in] path - Path to add services for
550      * @param[in] intf - Interface to add services for
551      * @param[in] depth - Depth of tree traversal from root path
553      * @return - The associated service to the given path and interface
562      * @param[in] msg - Expanded sdbusplus message data
563      * @param[in] eventData - The single event's data
570      * @param[in] name - Event name
571      * @param[in] data - Event data for signal
572      * @param[in] match - Subscribed signal match
584      * @param[in] intf - Interface containing property
585      * @param[in] prop - Property to be persisted
595      * @param[in] intf - Interface containing property
596      * @param[in] prop - Property persisted
598      * @return - True if property is to be persisted, false otherwise
606      * @param[in] path - Path of object
607      * @param[in] intf - Object interface
608      * @param[in] prop - Object property
610      * @return - Property's value
620             auto intfIter = pathIter->second.find(intf);  in getPropertyByName()
621             if (intfIter != pathIter->second.end())  in getPropertyByName()
653      * @brief Overridden thermal object's set 'Current' property function
655      * @param[in] value - Value to set 'Current' to
657      * @return - The updated value of the 'Current' property
659     virtual std::string current(std::string value);
678      * Full speed for the zone
688      * The default floor speed for the zone
693      * The default ceiling speed for the zone
698      * The floor speed to not go below
703      * The ceiling speed to not go above
718      * Target speed for this zone
723      * Speed increase delta
728      * Speed decrease delta
733      * Requested speed base
738      * Speed increase delay in seconds
743      * Speed decrease interval in seconds
758      * Event loop used on set speed event timers
824      * @brief Save the thermal control current mode property
830      * @brief Restore persisted thermal control current mode property
836      * @brief Get the request speed base if defined, otherwise the
837      * the current target speed is returned
839      * @return - The request speed base or current target speed