[PATCH v3 10/24] firmware: arm_scmi: Add Telemetry configuration operations
From: Cristian Marussi <cristian.marussi@arm.com>
Date: 2026-03-29 16:34:47
Also in:
arm-scmi, linux-doc, linux-fsdevel, 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> --- v2 --> v3 - split from monolithic Telemetry patch - simplify clenaup with scmi_telemetry_de_unlink --- drivers/firmware/arm_scmi/telemetry.c | 348 ++++++++++++++++++++++++++ include/linux/scmi_protocol.h | 16 ++ 2 files changed, 364 insertions(+)
diff --git a/drivers/firmware/arm_scmi/telemetry.c b/drivers/firmware/arm_scmi/telemetry.c
index 6c5a988b2aac..9536262bbdf7 100644
--- a/drivers/firmware/arm_scmi/telemetry.c
+++ b/drivers/firmware/arm_scmi/telemetry.c@@ -457,6 +457,9 @@ struct telemetry_info { static struct scmi_telemetry_res_info * __scmi_telemetry_resources_get(struct telemetry_info *ti); +static int scmi_telemetry_shmti_scan(struct telemetry_info *ti, + unsigned int shmti_id, enum scan_mode mode); + static struct telemetry_de * scmi_telemetry_free_tde_get(struct telemetry_info *ti) {
@@ -1687,10 +1690,355 @@ 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, + bool *enable, 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) + de->enabled = *enable; + if (tstamp) + de->tstamp_enabled = *tstamp; + } + + return 0; +} + +static int +scmi_telemetry_state_set_resp_process(struct telemetry_info *ti, + struct scmi_telemetry_de *de, + 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 *payld; + u32 de_offs; + + de_offs = le32_to_cpu(resp->shmti_de_offset); + if (de_offs >= ti->shmti[sid].len - de->info->data_sz) + return -EPROTO; + + tde = to_tde(de); + tde->base = ti->shmti[sid].base; + tde->offset = de_offs; + /* A handy reference to the Epilogue updated */ + tde->eplg = SHMTI_EPLG(&ti->shmti[sid]); + + payld = tde->base + tde->offset; + if (USE_BLK_TS(payld) && !tde->bts) { + struct payload *bts_payld; + u32 bts_offs; + + bts_offs = le32_to_cpu(resp->blk_ts_offset); + bts_payld = (bts_offs) ? tde->base + bts_offs : NULL; + tde->bts = scmi_telemetry_blkts_bind(ti->ph->dev, + &ti->shmti[sid], + payld, + &ti->xa_lines, + 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_warn(ti->ph->dev, + "Failed group-scan of SHMTI ID:%d - ret:%d\n", + sid, ret); + } + } else if (!is_group) { + /* Unlink the related BLK_TS/UUID lines on disable */ + scmi_telemetry_de_unlink(de); + } + + return 0; +} + +static int __scmi_telemetry_state_set(const struct scmi_protocol_handle *ph, + bool is_group, bool *enable, + bool *enabled_state, 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_group *grp; + struct scmi_telemetry_de *de; + unsigned int obj_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) { + *tstamp_enabled_state = *tstamp; + return 0; + } + + if (!is_group) { + de = obj; + obj_id = de->info->id; + } else { + grp = obj; + obj_id = grp->info->id; + } + + 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 |= 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 |= *tstamp ? DE_ENABLE_WTH_TSTAMP : + DE_ENABLE_NO_TSTAMP; + } else { + msg->flags |= *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, de, resp, is_group); + if (!ret) { + /* Update cached state on success */ + if (enable) + *enabled_state = *enable; + if (tstamp) + *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, + u32 id, bool *enabled, bool *tstamp_enabled) +{ + struct telemetry_info *ti = ph->get_priv(ph); + struct scmi_telemetry_de *de; + + if (!enabled || !tstamp_enabled) + return -EINVAL; + + de = xa_load(&ti->xa_des, id); + if (!de) + return -ENODEV; + + *enabled = de->enabled; + *tstamp_enabled = de->tstamp_enabled; + + return 0; +} + +static int scmi_telemetry_state_set(const struct scmi_protocol_handle *ph, + bool is_group, u32 id, bool *enable, + bool *tstamp) +{ + struct telemetry_info *ti = ph->get_priv(ph); + bool *enabled_state, *tstamp_enabled_state; + struct scmi_telemetry_res_info *rinfo; + void *obj; + + 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; + } + + return __scmi_telemetry_state_set(ph, is_group, enable, enabled_state, + tstamp, tstamp_enabled_state, obj); +} + +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 = DE_DISABLE_ALL; + if (is_group) + msg->flags |= GROUP_SELECTOR; + ret = ph->xops->do_xfer(ph, t); + if (!ret) { + for (int i = 0; i < ti->info.base.num_des; i++) + rinfo->des[i]->enabled = false; + + if (is_group) { + for (int i = 0; i < ti->info.base.num_groups; i++) + rinfo->grps[i].enabled = false; + } + } + + ph->xops->xfer_put(ph, t); + + return ret; +} + +static int +scmi_telemetry_collection_configure(const struct scmi_protocol_handle *ph, + unsigned int res_id, bool grp_ignore, + bool *enable, + unsigned int *update_interval_ms, + enum scmi_telemetry_collection *mode) +{ + 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; + bool tlm_enable; + u32 interval; + int ret; + + if (mode && *mode == SCMI_TLM_NOTIFICATION && + !ti->info.continuos_update_support) + return -EINVAL; + + if (res_id != SCMI_TLM_GRP_INVALID && res_id >= ti->info.base.num_groups) + return -EINVAL; + + if (res_id == SCMI_TLM_GRP_INVALID || grp_ignore) { + 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 = *update_interval_ms; + + tlm_enable = enable ? *enable : ti->info.enabled; + next_mode = mode ? *mode : *current_mode; + + msg = t->tx.buf; + msg->grp_id = res_id; + msg->control = tlm_enable ? TELEMETRY_ENABLE : 0; + msg->control |= grp_ignore ? TELEMETRY_SET_SELECTOR_ALL : + TELEMETRY_SET_SELECTOR_GROUP; + msg->control |= TELEMETRY_MODE_SET(next_mode); + 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 = 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 fcb45bd4b44c..03aa6b3dbd6b 100644
--- a/include/linux/scmi_protocol.h
+++ b/include/linux/scmi_protocol.h@@ -942,6 +942,12 @@ 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. + * @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)
@@ -950,6 +956,16 @@ 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, + u32 id, bool *enabled, bool *tstamp_enabled); + int (*state_set)(const struct scmi_protocol_handle *ph, + bool is_group, u32 id, bool *enable, bool *tstamp); + int (*all_disable)(const struct scmi_protocol_handle *ph, bool group); + int (*collection_configure)(const struct scmi_protocol_handle *ph, + unsigned int res_id, bool grp_ignore, + bool *enable, + unsigned int *update_interval_ms, + enum scmi_telemetry_collection *mode); }; /**
--
2.53.0