powercap: make documentation reflect code

Fix up the documentation of the struct powercap_control_type members
to match the code.

Also fixup stray whitespace.

Signed-off-by: Amit Kucheria <amitk@kernel.org>
[ rjw: Changelog edits ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
This commit is contained in:
Amit Kucheria 2020-09-10 15:57:46 +05:30 committed by Rafael J. Wysocki
parent ba92a42011
commit cc88b78c08

View file

@ -44,19 +44,18 @@ struct powercap_control_type_ops {
};
/**
* struct powercap_control_type- Defines a powercap control_type
* @name: name of control_type
* struct powercap_control_type - Defines a powercap control_type
* @dev: device for this control_type
* @idr: idr to have unique id for its child
* @root_node: Root holding power zones for this control_type
* @nr_zones: counter for number of zones of this type
* @ops: Pointer to callback struct
* @node_lock: mutex for control type
* @lock: mutex for control type
* @allocated: This is possible that client owns the memory
* used by this structure. In this case
* this flag is set to false by framework to
* prevent deallocation during release process.
* Otherwise this flag is set to true.
* @ctrl_inst: link to the control_type list
* @node: linked-list node
*
* Defines powercap control_type. This acts as a container for power
* zones, which use same method to control power. E.g. RAPL, RAPL-PCI etc.
@ -129,7 +128,7 @@ struct powercap_zone_ops {
* this flag is set to false by framework to
* prevent deallocation during release process.
* Otherwise this flag is set to true.
* @constraint_ptr: List of constraints for this zone.
* @constraints: List of constraints for this zone.
*
* This defines a power zone instance. The fields of this structure are
* private, and should not be used by client drivers.