PROTOCOLS
Actor
Defined in fuchsia.thermal/thermal.fidl
The protocol to receive thermal state updates from the fuchsia.thermal/Controller.
SetThermalState
Sets the Actor's thermal state.
The Actor is expected to ACK each call before subsequent calls will be made. state is
defined as an index into the Actor's reported thermal ranges. The Actor's thermal ranges
are defined by dividing the normalized thermal limiting range [0 - MAX_THERMAL_LOAD] at
the locations specified by the trip_points argument to Subscribe. state is therefore in
the range [0 - len(trip_points)]. For each value of state, the subsystem should remain
operational. The value of state should be interpreted as:
0: "normal operation"
1..[len(trip_points) - 1]: The subsystem is operating in such a way that each state
produces less heat than the previous state
len(trip_points): max thermal limiting while still operational
As a simple example, consider that Subscribe was called with a vector of two trip points:
[50, 90]. We can think of these trip points as boundaries within the normalized range
[0 - MAX_THERMAL_LOAD] such that three thermal ranges are created: [0 - 49], [50 - 89],
and [90 - MAX_THERMAL_LOAD]. Now, as the Controller observes the system thermal load
increase through the normalized range, it calls SetThermalState at the specified trip
points and indicates the index of which thermal range is now active. In this example, the
Controller would initially call SetThermalState(0) when there is no thermal limiting
required. As the device heats up, the Controller would call SetThermalState(1) and finally
SetThermalState(2) as the Controller observes the system thermal load cross 50 and 90,
respectively.
- request
statethe new thermal state as an index into the Actor's reported thermal ranges, which are defined based on the Actor's specifiedtrip_points.
Request
| Name | Type |
|---|---|
state |
uint32
|
Response
<EMPTY>
Controller
Defined in fuchsia.thermal/thermal.fidl
A protocol providing the API for a client service to subscribe to receive thermal state updates.
Subscribe
Subscribes with the Controller to receive thermal state changes on the specified [fuchsia.thermal/Actor] proxy handle.
The current thermal state will be sent immediately, with all subsequent state changes
occuring based on the changing system thermal load and specified trip_points.
A TripPoint is activated when the thermal load is greater than or equal to its activate_at
value and deactivated when the thermal load drops below its deactivate_below value. The
Actor's thermal state is set to 1 greater than the index of the highest active trip point,
or 0 if none are active.
- request
actora [fuchsia.thermal/Actor] proxy to handle the SetThermalState callbacks - request
actor_typea [fuchsia.thermal/ActorType] value to indicate the type of subsystem this actor is representing. The Controller may leverage this extra information to thermally limit only specific subsystems as needed. - request
trip_pointsa vector ofTripPoints specifying when the Actor should be transitioned between thermal states. The vector must:- have length in the range [1 - MAX_TRIP_POINT_COUNT]
- elementwise satisfy
low<=high - be monotonically increasing:
high[i]<low[i+1] - elementwise have
lowandhighvalues in the range [1 - MAX_THERMAL_LOAD] Failure to meet these conditions will cause [fuchsia.thermal/Error].INVALID_ARGUMENTS to be returned.
- error a [fuchsia.thermal/Error] value indicating the reason (if any) that Subscribe failed
Request
| Name | Type |
|---|---|
actor |
Actor
|
actor_type |
ActorType
|
trip_points |
vector<TripPoint>[100]
|
Response
| Name | Type |
|---|---|
result |
Controller_Subscribe_Result
|
STRUCTS
Controller_Subscribe_Response
Defined in fuchsia.thermal/thermal.fidl
<EMPTY>
TripPoint
Defined in fuchsia.thermal/thermal.fidl
Configuration for a single trip point. The trip point will be activated when the thermal load
is greater than or equal to activate_at, and deactivated when it is less than
deactivate_below.
See [fuchsia.thermal/Controller.Subscribe] for the relationship between trip points and thermal states.
| Field | Type | Description | Default |
|---|---|---|---|
deactivate_below |
uint32
|
The trip point will be deactivated when thermal load drops below this value. |
No default |
activate_at |
uint32
|
The trip point will be activated when thermal load is greater than or equal to this value. |
No default |
ENUMS
ActorType strict
Type: uint32
Defined in fuchsia.thermal/thermal.fidl
A value to indicate which type of subsystem an Actor connection represents. The Controller may leverage this extra information to thermally limit only specific subsystems as needed.
| Name | Value | Description |
|---|---|---|
UNSPECIFIED |
1 |
|
AUDIO |
2 |
Error strict
Type: uint32
Defined in fuchsia.thermal/thermal.fidl
Error codes for the thermal protocol.
| Name | Value | Description |
|---|---|---|
INTERNAL |
1 |
The component encountered an unspecified error while performing the operation. |
INVALID_ARGUMENTS |
2 |
At least one argument was invalid. |
UNIONS
Controller_Subscribe_Result strict
Defined in fuchsia.thermal/thermal.fidl
| Ordinal | |||
|---|---|---|---|
| Variant | Type | Description | |
| 1 | response |
Controller_Subscribe_Response
|
|
| 2 | err |
Error
|
CONSTANTS
| Name | Value | Type | Description |
|---|---|---|---|
| MAX_THERMAL_LOAD |
100
|
uint32 |
The maximum value of the normalized thermal load. This value bounds the width (and therefore also the precision) of the normalized thermal limiting range starting from 0. Trip points must be specified within this range. |
| MAX_TRIP_POINT_COUNT |
100
|
uint32 |
The maximum number of trip points that may be specified in the |