[PATCH v7 08/23] firmware: arm_scmi: Add Telemetry configuration operations
From: Cristian Marussi <cristian.marussi@arm.com>
Date: 2026-08-02 14:57:59
Also in:
arm-scmi, linux-doc, lkml
Subsystem:
system control & power/management interface (scpi/scmi) message protocol drivers, the rest · Maintainers:
Sudeep Holla, Linus Torvalds
Add support for basic Telemetry configuration operations to selectively enable or disable DataEvents monitoring. Signed-off-by: Cristian Marussi <cristian.marussi@arm.com> --- v6 --> v7 - expose per-DE tracked sid/offset/UUIDs - trigger a full SHMTI scan when a SHMTI-based is enabled and it still has NO associated UUID v5 --> v6 - constify a few booleans used as inpurt in telemetry_operations - fixes (some) Sashiko reviews https://sashiko.dev/#/patchset/20260703123601.381275-1-cristian.marussi%40arm.com?part=9 - underflow on de_offs - SHMTI overflow checks - bail out on failed group scan - unlink comprising DEs on group disable - add boudnary check on message response parsing v4 --> v5 - use renamed grp_id instead of old id in group descriptors - remove useless grp_ignore param from collection_configure - fixes sparse warnings v3 --> v4 - track configured Telemetry DE states - add aggregate Telemetry state query v2 --> v3 - split from monolithic Telemetry patch - simplify clenaup with scmi_telemetry_de_unlink --- drivers/firmware/arm_scmi/telemetry.c | 446 ++++++++++++++++++++++++++ include/linux/scmi_protocol.h | 19 ++ 2 files changed, 465 insertions(+)
diff --git a/drivers/firmware/arm_scmi/telemetry.c b/drivers/firmware/arm_scmi/telemetry.c
index fadb64ac6346..e194715066e7 100644
--- a/drivers/firmware/arm_scmi/telemetry.c
+++ b/drivers/firmware/arm_scmi/telemetry.c@@ -1929,10 +1929,456 @@ static int scmi_telemetry_shmti_scan(struct telemetry_info *ti, return 0; } +static int scmi_telemetry_group_state_update(struct telemetry_info *ti, + struct scmi_telemetry_group *grp, + const bool *enable, const bool *tstamp) +{ + struct scmi_telemetry_res_info *rinfo; + + rinfo = ti->res_get(ti); + for (int i = 0; i < grp->info->num_des; i++) { + struct scmi_telemetry_de *de = rinfo->des[grp->des[i]]; + + if (enable) + scmi_telemetry_de_state_update(ti, ENA_STATE, + &de->enabled, *enable); + + if (tstamp && de->tstamp_support) + scmi_telemetry_de_state_update(ti, ENA_TSTAMP, + &de->tstamp_enabled, *tstamp); + } + + return 0; +} + +static void scmi_telemetry_group_unlink(struct telemetry_info *ti, + struct scmi_telemetry_group *grp) +{ + struct scmi_telemetry_res_info *rinfo; + + rinfo = ti->res_get(ti); + /* Unlink the related BLK_TS/UUID lines of DEs composing the group */ + for (int i = 0; i < grp->info->num_des; i++) { + struct telemetry_de *tde = to_tde(rinfo->des[grp->des[i]]); + + scmi_telemetry_blkts_unlink(tde); + } +} + +static int +scmi_telemetry_state_set_resp_process(struct telemetry_info *ti, void *obj, + void *r, bool is_group) +{ + struct scmi_msg_resp_telemetry_de_configure *resp = r; + u32 sid = le32_to_cpu(resp->shmti_id); + + /* Update DE SHMTI and offset, if applicable */ + if (IS_SHMTI_ID_VALID(sid)) { + if (sid >= ti->num_shmti) + return -EPROTO; + + /* + * Update SHMTI/offset while skipping non-SHMTI-DEs like + * FCs and notif-only. + */ + if (!is_group) { + struct telemetry_de *tde; + struct payload __iomem *payld; + struct scmi_telemetry_de *de = obj; + struct telemetry_shmti *shmti; + u32 de_offs; + + de_offs = le32_to_cpu(resp->shmti_de_offset); + + shmti = &ti->shmti[sid]; + payld = shmti->base; + /* Check boundary first... */ + if (de_offs + LINE_LENGTH_BYTES(payld) >= shmti->info.len) + return -EPROTO; + + tde = to_tde(de); + /*...then assign */ + tde->sid = sid; + tde->base = payld; + tde->offset = de_offs; + /* A handy reference to the Epilogue updated */ + tde->eplg = SHMTI_EPLG(shmti); + + payld = tde->base + tde->offset; + + /* + * On enable if a UUID was NOT already assigned scan + * looking for possible Secondary UUID to bind: if NO + * secondary could be found embedded in the preceding + * SHMTI lines, install the primary UUID for this DE. + */ + if (!tde->uuid) { + tde->uuid = scmi_telemetry_uuid_bind(ti, shmti, payld); + if (!tde->uuid) + scmi_telemetry_uuid_link(tde, ti->primary_uuid); + } + + if (USE_BLK_TS(payld) && !tde->bts) { + struct payload __iomem *bts_payld; + u32 bts_offs; + + bts_offs = le32_to_cpu(resp->blk_ts_offset); + bts_payld = (bts_offs) ? tde->base + bts_offs : NULL; + + /* Check SHMTI overflow on returned offset */ + if (bts_payld && SHMTI_OVERFLOWS(bts_payld, shmti)) + return -ENOSPC; + + tde->bts = scmi_telemetry_blkts_bind(ti, shmti, + payld, bts_payld); + if (WARN_ON(!tde->bts)) + return -EPROTO; + } + } else { + int ret; + + /* + * A full SHMTI scan is needed when enabling a + * group or its timestamps in order to retrieve + * offsets: note that when group-timestamp is + * enabled for composing DEs a re-scan is needed + * since some DEs could have been relocated due + * to lack of space in the TDCF. + */ + ret = scmi_telemetry_shmti_scan(ti, sid, SCAN_UPDATE); + if (ret) { + dev_err(ti->ph->dev, + "Failed group-scan of SHMTI ID:%d - ret:%d\n", + sid, ret); + return ret; + } + } + } else { + /* Unlink the related BLK_TS/UUID lines on disable */ + if (!is_group) { + struct scmi_telemetry_de *de = obj; + struct telemetry_de *tde = to_tde(de); + + tde->sid = SHMTI_ID_INVALID; + /* UUID is never unlinked once discovered */ + scmi_telemetry_blkts_unlink(tde); + } else { + scmi_telemetry_group_unlink(ti, obj); + } + } + + return 0; +} + +static int __scmi_telemetry_state_set(const struct scmi_protocol_handle *ph, + bool is_group, const bool *enable, + bool *enabled_state, const bool *tstamp, + bool *tstamp_enabled_state, void *obj) +{ + struct scmi_msg_resp_telemetry_de_configure *resp; + struct scmi_msg_telemetry_de_configure *msg; + struct telemetry_info *ti = ph->get_priv(ph); + struct scmi_telemetry_de *de = !is_group ? obj : NULL; + struct scmi_telemetry_group *grp = is_group ? obj : NULL; + unsigned int obj_id = !is_group ? de->info->id : grp->info->grp_id; + struct scmi_xfer *t; + int ret; + + if (!enabled_state || !tstamp_enabled_state) + return -EINVAL; + + /* Is anything to do at all on this DE ? */ + if (!is_group && (!enable || *enable == *enabled_state) && + (!tstamp || *tstamp == *tstamp_enabled_state)) + return 0; + + /* + * DE is currently disabled AND no enable state change was requested, + * while timestamp is being changed: update only local state...no need + * to send a message. + */ + if (!is_group && !enable && !*enabled_state) { + if (de->tstamp_support) + scmi_telemetry_de_state_update(ti, ENA_TSTAMP, + tstamp_enabled_state, + *tstamp); + + return 0; + } + + ret = ph->xops->xfer_get_init(ph, TELEMETRY_DE_CONFIGURE, + sizeof(*msg), sizeof(*resp), &t); + if (ret) + return ret; + + msg = t->tx.buf; + /* Note that BOTH DE and GROUPS have a first ID field.. */ + msg->id = cpu_to_le32(obj_id); + /* Default to disable mode for one DE */ + msg->flags = DE_DISABLE_ONE; + msg->flags |= cpu_to_le32(FIELD_PREP(GENMASK(3, 3), + is_group ? EVENT_GROUP : EVENT_DE)); + + if ((!enable && *enabled_state) || (enable && *enable)) { + /* Already enabled but tstamp_enabled state changed */ + if (tstamp) { + /* Here, tstamp cannot be NULL too */ + msg->flags |= cpu_to_le32(*tstamp ? + DE_ENABLE_WTH_TSTAMP : DE_ENABLE_NO_TSTAMP); + } else { + msg->flags |= cpu_to_le32(*tstamp_enabled_state ? + DE_ENABLE_WTH_TSTAMP : DE_ENABLE_NO_TSTAMP); + } + } + + resp = t->rx.buf; + ret = ph->xops->do_xfer(ph, t); + if (!ret) { + ret = scmi_telemetry_state_set_resp_process(ti, obj, resp, is_group); + if (!ret) { + /* Update cached state on success */ + if (enable) { + if (!is_group) + scmi_telemetry_de_state_update(ti, ENA_STATE, + enabled_state, + *enable); + else + *enabled_state = *enable; + } + if (tstamp) { + if (!is_group) { + if (de->tstamp_support) + scmi_telemetry_de_state_update(ti, ENA_TSTAMP, + tstamp_enabled_state, + *tstamp); + } else { + *tstamp_enabled_state = *tstamp; + } + } + + if (is_group) + scmi_telemetry_group_state_update(ti, grp, enable, + tstamp); + } + } + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int scmi_telemetry_state_get(const struct scmi_protocol_handle *ph, + const u32 *id, bool *enabled, bool *tstamp_enabled, + u32 *sid, u32 *offset, uuid_t *uuid) +{ + struct telemetry_info *ti = ph->get_priv(ph); + struct scmi_telemetry_de *de; + struct telemetry_de *tde; + + if (!enabled || !tstamp_enabled) + return -EINVAL; + + if (!id) { + /* Returning the all_des_* state */ + *enabled = + (atomic_read(&ti->des_enabled[ENA_STATE]) == ti->info.base.num_des); + *tstamp_enabled = + (atomic_read(&ti->des_enabled[ENA_TSTAMP]) == ti->num_des_tstamp); + + return 0; + } + + de = xa_load(&ti->xa_des, *id); + if (!de) + return -ENODEV; + + *enabled = de->enabled; + *tstamp_enabled = de->tstamp_enabled; + + tde = to_tde(de); + if (sid) + *sid = tde->sid; + if (offset) + *offset = tde->offset; + if (uuid && tde->uuid) + uuid_copy(uuid, &tde->uuid->uuid); + + return 0; +} + +static int scmi_telemetry_state_set(const struct scmi_protocol_handle *ph, + bool is_group, u32 id, const bool *enable, + const bool *tstamp, u32 *sid, u32 *offset, + uuid_t *uuid) +{ + struct telemetry_info *ti = ph->get_priv(ph); + bool *enabled_state, *tstamp_enabled_state; + struct scmi_telemetry_res_info *rinfo; + void *obj; + int ret; + + rinfo = ti->res_get(ti); + if (!is_group) { + struct scmi_telemetry_de *de; + + de = xa_load(&ti->xa_des, id); + if (!de) + return -ENODEV; + + enabled_state = &de->enabled; + tstamp_enabled_state = &de->tstamp_enabled; + obj = de; + } else { + struct scmi_telemetry_group *grp; + + if (id >= ti->info.base.num_groups) + return -EINVAL; + + grp = &rinfo->grps[id]; + + enabled_state = &grp->enabled; + tstamp_enabled_state = &grp->tstamp_enabled; + obj = grp; + } + + ret = __scmi_telemetry_state_set(ph, is_group, enable, enabled_state, + tstamp, tstamp_enabled_state, obj); + if (ret) + return ret; + + if (!is_group) { + struct telemetry_de *tde; + + tde = to_tde(obj); + if (sid) + *sid = tde->sid; + if (offset) + *offset = tde->offset; + if (uuid && tde->uuid) + uuid_copy(uuid, &tde->uuid->uuid); + } + + return 0; +} + +static int scmi_telemetry_all_disable(const struct scmi_protocol_handle *ph, + bool is_group) +{ + struct telemetry_info *ti = ph->get_priv(ph); + struct scmi_msg_telemetry_de_configure *msg; + struct scmi_telemetry_res_info *rinfo; + struct scmi_xfer *t; + int ret; + + rinfo = ti->res_get(ti); + ret = ph->xops->xfer_get_init(ph, TELEMETRY_DE_CONFIGURE, + sizeof(*msg), 0, &t); + if (ret) + return ret; + + msg = t->tx.buf; + msg->flags = cpu_to_le32(DE_DISABLE_ALL); + if (is_group) + msg->flags |= cpu_to_le32(GROUP_SELECTOR); + ret = ph->xops->do_xfer(ph, t); + if (!ret) { + for (int i = 0; i < rinfo->num_des; i++) + scmi_telemetry_de_state_update(ti, ENA_STATE, + &rinfo->des[i]->enabled, + false); + if (is_group) { + for (int i = 0; i < ti->info.base.num_groups; i++) { + rinfo->grps[i].enabled = false; + scmi_telemetry_group_unlink(ti, &rinfo->grps[i]); + } + } + } + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int +scmi_telemetry_collection_configure(const struct scmi_protocol_handle *ph, + unsigned int res_id, const bool *enable, + const unsigned int *update_interval_ms, + const enum scmi_telemetry_collection *mode) +{ + bool tlm_enable, is_group = res_id != SCMI_TLM_GRP_INVALID; + enum scmi_telemetry_collection *current_mode, next_mode; + struct telemetry_info *ti = ph->get_priv(ph); + struct scmi_msg_telemetry_config_set *msg; + unsigned int *active_update_interval; + struct scmi_xfer *t; + __le32 interval; + u32 control; + int ret; + + if (mode && *mode == SCMI_TLM_NOTIFICATION && + !ti->info.continuos_update_support) + return -EINVAL; + + if (is_group && res_id >= ti->info.base.num_groups) + return -EINVAL; + + if (!is_group) { + active_update_interval = &ti->info.active_update_interval; + current_mode = &ti->info.current_mode; + } else { + struct scmi_telemetry_res_info *rinfo; + + rinfo = ti->res_get(ti); + active_update_interval = + &rinfo->grps[res_id].active_update_interval; + current_mode = &rinfo->grps[res_id].current_mode; + } + + if (!enable && !update_interval_ms && (!mode || *mode == *current_mode)) + return 0; + + ret = ph->xops->xfer_get_init(ph, TELEMETRY_CONFIG_SET, + sizeof(*msg), 0, &t); + if (ret) + return ret; + + if (!update_interval_ms) + interval = cpu_to_le32(*active_update_interval); + else + interval = cpu_to_le32(*update_interval_ms); + + tlm_enable = enable ? *enable : ti->info.enabled; + next_mode = mode ? *mode : *current_mode; + + msg = t->tx.buf; + msg->grp_id = cpu_to_le32(res_id); + control = tlm_enable ? TELEMETRY_ENABLE : 0; + control |= !is_group ? TELEMETRY_SET_SELECTOR_ALL : TELEMETRY_SET_SELECTOR_GROUP; + control |= TELEMETRY_MODE_SET(next_mode); + msg->control = cpu_to_le32(control); + msg->sampling_rate = interval; + ret = ph->xops->do_xfer(ph, t); + if (!ret) { + ti->info.enabled = tlm_enable; + *current_mode = next_mode; + ti->info.notif_enabled = *current_mode == SCMI_TLM_NOTIFICATION; + if (update_interval_ms) + *active_update_interval = le32_to_cpu(interval); + } + + ph->xops->xfer_put(ph, t); + + return ret; +} + static const struct scmi_telemetry_proto_ops tlm_proto_ops = { .info_get = scmi_telemetry_info_get, .de_lookup = scmi_telemetry_de_lookup, .res_get = scmi_telemetry_resources_get, + .state_get = scmi_telemetry_state_get, + .state_set = scmi_telemetry_state_set, + .all_disable = scmi_telemetry_all_disable, + .collection_configure = scmi_telemetry_collection_configure, }; /**
diff --git a/include/linux/scmi_protocol.h b/include/linux/scmi_protocol.h
index 2850b018da0d..f2eac131ebcf 100644
--- a/include/linux/scmi_protocol.h
+++ b/include/linux/scmi_protocol.h@@ -994,6 +994,13 @@ struct scmi_telemetry_info { * @info_get: get the general Telemetry information. * @de_lookup: get a specific DE descriptor from the DE id. * @res_get: get a reference to the Telemetry resources descriptor. + * @state_get: retrieve the specific DE or GROUP state, if NULL returns the + * cumulative state of all DEs. + * @state_set: enable/disable the specific DE or GROUP with or without timestamps. + * @all_disable: disable ALL DEs or GROUPs. + * @collection_configure: choose a sampling rate and enable SHMTI/FC sampling + * for on demand collection via @de_data_read or async + * notificatioins for all the enabled DEs. */ struct scmi_telemetry_proto_ops { const struct scmi_telemetry_info __must_check *(*info_get)
@@ -1002,6 +1009,18 @@ struct scmi_telemetry_proto_ops { (const struct scmi_protocol_handle *ph, u32 id); const struct scmi_telemetry_res_info __must_check *(*res_get) (const struct scmi_protocol_handle *ph); + int (*state_get)(const struct scmi_protocol_handle *ph, + const u32 *id, bool *enabled, bool *tstamp_enabled, + u32 *sid, u32 *offset, uuid_t *uuid); + int (*state_set)(const struct scmi_protocol_handle *ph, + bool is_group, u32 id, const bool *enable, + const bool *tstamp, u32 *sid, u32 *offset, + uuid_t *uuid); + int (*all_disable)(const struct scmi_protocol_handle *ph, bool group); + int (*collection_configure)(const struct scmi_protocol_handle *ph, + unsigned int res_id, const bool *enable, + const unsigned int *update_interval_ms, + const enum scmi_telemetry_collection *mode); }; /**
--
2.54.0