1 // SPDX-License-Identifier: GPL-2.0-only
3 * Qualcomm Peripheral Image Loader helpers
5 * Copyright (C) 2016 Linaro Ltd
6 * Copyright (C) 2015 Sony Mobile Communications Inc
7 * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
10 #include <linux/firmware.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/notifier.h>
14 #include <linux/remoteproc.h>
15 #include <linux/remoteproc/qcom_rproc.h>
16 #include <linux/rpmsg/qcom_glink.h>
17 #include <linux/rpmsg/qcom_smd.h>
18 #include <linux/slab.h>
19 #include <linux/soc/qcom/mdt_loader.h>
20 #include <linux/soc/qcom/smem.h>
22 #include "remoteproc_internal.h"
23 #include "qcom_common.h"
25 #define to_glink_subdev(d) container_of(d, struct qcom_rproc_glink, subdev)
26 #define to_smd_subdev(d) container_of(d, struct qcom_rproc_subdev, subdev)
27 #define to_ssr_subdev(d) container_of(d, struct qcom_rproc_ssr, subdev)
29 #define MAX_NUM_OF_SS 10
30 #define MAX_REGION_NAME_LENGTH 16
31 #define SBL_MINIDUMP_SMEM_ID 602
32 #define MINIDUMP_REGION_VALID ('V' << 24 | 'A' << 16 | 'L' << 8 | 'I' << 0)
33 #define MINIDUMP_SS_ENCR_DONE ('D' << 24 | 'O' << 16 | 'N' << 8 | 'E' << 0)
34 #define MINIDUMP_SS_ENABLED ('E' << 24 | 'N' << 16 | 'B' << 8 | 'L' << 0)
37 * struct minidump_region - Minidump region
38 * @name : Name of the region to be dumped
39 * @seq_num: : Use to differentiate regions with same name.
40 * @valid : This entry to be dumped (if set to 1)
41 * @address : Physical address of region to be dumped
42 * @size : Size of the region
44 struct minidump_region {
45 char name[MAX_REGION_NAME_LENGTH];
53 * struct minidump_subsystem - Subsystem's SMEM Table of content
54 * @status : Subsystem toc init status
55 * @enabled : if set to 1, this region would be copied during coredump
56 * @encryption_status: Encryption status for this subsystem
57 * @encryption_required : Decides to encrypt the subsystem regions or not
58 * @region_count : Number of regions added in this subsystem toc
59 * @regions_baseptr : regions base pointer of the subsystem
61 struct minidump_subsystem {
64 __le32 encryption_status;
65 __le32 encryption_required;
67 __le64 regions_baseptr;
71 * struct minidump_global_toc - Global Table of Content
72 * @status : Global Minidump init status
73 * @md_revision : Minidump revision
74 * @enabled : Minidump enable status
75 * @subsystems : Array of subsystems toc
77 struct minidump_global_toc {
81 struct minidump_subsystem subsystems[MAX_NUM_OF_SS];
84 struct qcom_ssr_subsystem {
86 struct srcu_notifier_head notifier_list;
87 struct list_head list;
90 static LIST_HEAD(qcom_ssr_subsystem_list);
91 static DEFINE_MUTEX(qcom_ssr_subsys_lock);
93 static void qcom_minidump_cleanup(struct rproc *rproc)
95 struct rproc_dump_segment *entry, *tmp;
97 list_for_each_entry_safe(entry, tmp, &rproc->dump_segments, node) {
98 list_del(&entry->node);
104 static int qcom_add_minidump_segments(struct rproc *rproc, struct minidump_subsystem *subsystem,
105 void (*rproc_dumpfn_t)(struct rproc *rproc, struct rproc_dump_segment *segment,
106 void *dest, size_t offset, size_t size))
108 struct minidump_region __iomem *ptr;
109 struct minidump_region region;
115 if (WARN_ON(!list_empty(&rproc->dump_segments))) {
116 dev_err(&rproc->dev, "dump segment list already populated\n");
120 seg_cnt = le32_to_cpu(subsystem->region_count);
121 ptr = ioremap((unsigned long)le64_to_cpu(subsystem->regions_baseptr),
122 seg_cnt * sizeof(struct minidump_region));
126 for (i = 0; i < seg_cnt; i++) {
127 memcpy_fromio(®ion, ptr + i, sizeof(region));
128 if (le32_to_cpu(region.valid) == MINIDUMP_REGION_VALID) {
129 name = kstrndup(region.name, MAX_REGION_NAME_LENGTH - 1, GFP_KERNEL);
134 da = le64_to_cpu(region.address);
135 size = le64_to_cpu(region.size);
136 rproc_coredump_add_custom_segment(rproc, da, size, rproc_dumpfn_t, name);
144 void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
145 void (*rproc_dumpfn_t)(struct rproc *rproc,
146 struct rproc_dump_segment *segment, void *dest, size_t offset,
150 struct minidump_subsystem *subsystem;
151 struct minidump_global_toc *toc;
153 /* Get Global minidump ToC*/
154 toc = qcom_smem_get(QCOM_SMEM_HOST_ANY, SBL_MINIDUMP_SMEM_ID, NULL);
156 /* check if global table pointer exists and init is set */
157 if (IS_ERR(toc) || !toc->status) {
158 dev_err(&rproc->dev, "Minidump TOC not found in SMEM\n");
162 /* Get subsystem table of contents using the minidump id */
163 subsystem = &toc->subsystems[minidump_id];
166 * Collect minidump if SS ToC is valid and segment table
167 * is initialized in memory and encryption status is set.
169 if (subsystem->regions_baseptr == 0 ||
170 le32_to_cpu(subsystem->status) != 1 ||
171 le32_to_cpu(subsystem->enabled) != MINIDUMP_SS_ENABLED) {
172 return rproc_coredump(rproc);
175 if (le32_to_cpu(subsystem->encryption_status) != MINIDUMP_SS_ENCR_DONE) {
176 dev_err(&rproc->dev, "Minidump not ready, skipping\n");
181 * Clear out the dump segments populated by parse_fw before
182 * re-populating them with minidump segments.
184 rproc_coredump_cleanup(rproc);
186 ret = qcom_add_minidump_segments(rproc, subsystem, rproc_dumpfn_t);
188 dev_err(&rproc->dev, "Failed with error: %d while adding minidump entries\n", ret);
191 rproc_coredump_using_sections(rproc);
193 qcom_minidump_cleanup(rproc);
195 EXPORT_SYMBOL_GPL(qcom_minidump);
197 static int glink_subdev_start(struct rproc_subdev *subdev)
199 struct qcom_rproc_glink *glink = to_glink_subdev(subdev);
201 glink->edge = qcom_glink_smem_register(glink->dev, glink->node);
203 return PTR_ERR_OR_ZERO(glink->edge);
206 static void glink_subdev_stop(struct rproc_subdev *subdev, bool crashed)
208 struct qcom_rproc_glink *glink = to_glink_subdev(subdev);
210 qcom_glink_smem_unregister(glink->edge);
214 static void glink_subdev_unprepare(struct rproc_subdev *subdev)
216 struct qcom_rproc_glink *glink = to_glink_subdev(subdev);
218 qcom_glink_ssr_notify(glink->ssr_name);
222 * qcom_add_glink_subdev() - try to add a GLINK subdevice to rproc
223 * @rproc: rproc handle to parent the subdevice
224 * @glink: reference to a GLINK subdev context
225 * @ssr_name: identifier of the associated remoteproc for ssr notifications
227 void qcom_add_glink_subdev(struct rproc *rproc, struct qcom_rproc_glink *glink,
228 const char *ssr_name)
230 struct device *dev = &rproc->dev;
232 glink->node = of_get_child_by_name(dev->parent->of_node, "glink-edge");
236 glink->ssr_name = kstrdup_const(ssr_name, GFP_KERNEL);
237 if (!glink->ssr_name)
241 glink->subdev.start = glink_subdev_start;
242 glink->subdev.stop = glink_subdev_stop;
243 glink->subdev.unprepare = glink_subdev_unprepare;
245 rproc_add_subdev(rproc, &glink->subdev);
247 EXPORT_SYMBOL_GPL(qcom_add_glink_subdev);
250 * qcom_remove_glink_subdev() - remove a GLINK subdevice from rproc
251 * @rproc: rproc handle
252 * @glink: reference to a GLINK subdev context
254 void qcom_remove_glink_subdev(struct rproc *rproc, struct qcom_rproc_glink *glink)
259 rproc_remove_subdev(rproc, &glink->subdev);
260 kfree_const(glink->ssr_name);
261 of_node_put(glink->node);
263 EXPORT_SYMBOL_GPL(qcom_remove_glink_subdev);
266 * qcom_register_dump_segments() - register segments for coredump
267 * @rproc: remoteproc handle
268 * @fw: firmware header
270 * Register all segments of the ELF in the remoteproc coredump segment list
272 * Return: 0 on success, negative errno on failure.
274 int qcom_register_dump_segments(struct rproc *rproc,
275 const struct firmware *fw)
277 const struct elf32_phdr *phdrs;
278 const struct elf32_phdr *phdr;
279 const struct elf32_hdr *ehdr;
283 ehdr = (struct elf32_hdr *)fw->data;
284 phdrs = (struct elf32_phdr *)(ehdr + 1);
286 for (i = 0; i < ehdr->e_phnum; i++) {
289 if (phdr->p_type != PT_LOAD)
292 if ((phdr->p_flags & QCOM_MDT_TYPE_MASK) == QCOM_MDT_TYPE_HASH)
298 ret = rproc_coredump_add_segment(rproc, phdr->p_paddr,
306 EXPORT_SYMBOL_GPL(qcom_register_dump_segments);
308 static int smd_subdev_start(struct rproc_subdev *subdev)
310 struct qcom_rproc_subdev *smd = to_smd_subdev(subdev);
312 smd->edge = qcom_smd_register_edge(smd->dev, smd->node);
314 return PTR_ERR_OR_ZERO(smd->edge);
317 static void smd_subdev_stop(struct rproc_subdev *subdev, bool crashed)
319 struct qcom_rproc_subdev *smd = to_smd_subdev(subdev);
321 qcom_smd_unregister_edge(smd->edge);
326 * qcom_add_smd_subdev() - try to add a SMD subdevice to rproc
327 * @rproc: rproc handle to parent the subdevice
328 * @smd: reference to a Qualcomm subdev context
330 void qcom_add_smd_subdev(struct rproc *rproc, struct qcom_rproc_subdev *smd)
332 struct device *dev = &rproc->dev;
334 smd->node = of_get_child_by_name(dev->parent->of_node, "smd-edge");
339 smd->subdev.start = smd_subdev_start;
340 smd->subdev.stop = smd_subdev_stop;
342 rproc_add_subdev(rproc, &smd->subdev);
344 EXPORT_SYMBOL_GPL(qcom_add_smd_subdev);
347 * qcom_remove_smd_subdev() - remove the smd subdevice from rproc
348 * @rproc: rproc handle
349 * @smd: the SMD subdevice to remove
351 void qcom_remove_smd_subdev(struct rproc *rproc, struct qcom_rproc_subdev *smd)
356 rproc_remove_subdev(rproc, &smd->subdev);
357 of_node_put(smd->node);
359 EXPORT_SYMBOL_GPL(qcom_remove_smd_subdev);
361 static struct qcom_ssr_subsystem *qcom_ssr_get_subsys(const char *name)
363 struct qcom_ssr_subsystem *info;
365 mutex_lock(&qcom_ssr_subsys_lock);
366 /* Match in the global qcom_ssr_subsystem_list with name */
367 list_for_each_entry(info, &qcom_ssr_subsystem_list, list)
368 if (!strcmp(info->name, name))
371 info = kzalloc(sizeof(*info), GFP_KERNEL);
373 info = ERR_PTR(-ENOMEM);
376 info->name = kstrdup_const(name, GFP_KERNEL);
377 srcu_init_notifier_head(&info->notifier_list);
379 /* Add to global notification list */
380 list_add_tail(&info->list, &qcom_ssr_subsystem_list);
383 mutex_unlock(&qcom_ssr_subsys_lock);
388 * qcom_register_ssr_notifier() - register SSR notification handler
389 * @name: Subsystem's SSR name
390 * @nb: notifier_block to be invoked upon subsystem's state change
392 * This registers the @nb notifier block as part the notifier chain for a
393 * remoteproc associated with @name. The notifier block's callback
394 * will be invoked when the remote processor's SSR events occur
395 * (pre/post startup and pre/post shutdown).
397 * Return: a subsystem cookie on success, ERR_PTR on failure.
399 void *qcom_register_ssr_notifier(const char *name, struct notifier_block *nb)
401 struct qcom_ssr_subsystem *info;
403 info = qcom_ssr_get_subsys(name);
407 srcu_notifier_chain_register(&info->notifier_list, nb);
409 return &info->notifier_list;
411 EXPORT_SYMBOL_GPL(qcom_register_ssr_notifier);
414 * qcom_unregister_ssr_notifier() - unregister SSR notification handler
415 * @notify: subsystem cookie returned from qcom_register_ssr_notifier
416 * @nb: notifier_block to unregister
418 * This function will unregister the notifier from the particular notifier
421 * Return: 0 on success, %ENOENT otherwise.
423 int qcom_unregister_ssr_notifier(void *notify, struct notifier_block *nb)
425 return srcu_notifier_chain_unregister(notify, nb);
427 EXPORT_SYMBOL_GPL(qcom_unregister_ssr_notifier);
429 static int ssr_notify_prepare(struct rproc_subdev *subdev)
431 struct qcom_rproc_ssr *ssr = to_ssr_subdev(subdev);
432 struct qcom_ssr_notify_data data = {
433 .name = ssr->info->name,
437 srcu_notifier_call_chain(&ssr->info->notifier_list,
438 QCOM_SSR_BEFORE_POWERUP, &data);
442 static int ssr_notify_start(struct rproc_subdev *subdev)
444 struct qcom_rproc_ssr *ssr = to_ssr_subdev(subdev);
445 struct qcom_ssr_notify_data data = {
446 .name = ssr->info->name,
450 srcu_notifier_call_chain(&ssr->info->notifier_list,
451 QCOM_SSR_AFTER_POWERUP, &data);
455 static void ssr_notify_stop(struct rproc_subdev *subdev, bool crashed)
457 struct qcom_rproc_ssr *ssr = to_ssr_subdev(subdev);
458 struct qcom_ssr_notify_data data = {
459 .name = ssr->info->name,
463 srcu_notifier_call_chain(&ssr->info->notifier_list,
464 QCOM_SSR_BEFORE_SHUTDOWN, &data);
467 static void ssr_notify_unprepare(struct rproc_subdev *subdev)
469 struct qcom_rproc_ssr *ssr = to_ssr_subdev(subdev);
470 struct qcom_ssr_notify_data data = {
471 .name = ssr->info->name,
475 srcu_notifier_call_chain(&ssr->info->notifier_list,
476 QCOM_SSR_AFTER_SHUTDOWN, &data);
480 * qcom_add_ssr_subdev() - register subdevice as restart notification source
481 * @rproc: rproc handle
482 * @ssr: SSR subdevice handle
483 * @ssr_name: identifier to use for notifications originating from @rproc
485 * As the @ssr is registered with the @rproc SSR events will be sent to all
486 * registered listeners for the remoteproc when it's SSR events occur
487 * (pre/post startup and pre/post shutdown).
489 void qcom_add_ssr_subdev(struct rproc *rproc, struct qcom_rproc_ssr *ssr,
490 const char *ssr_name)
492 struct qcom_ssr_subsystem *info;
494 info = qcom_ssr_get_subsys(ssr_name);
496 dev_err(&rproc->dev, "Failed to add ssr subdevice\n");
501 ssr->subdev.prepare = ssr_notify_prepare;
502 ssr->subdev.start = ssr_notify_start;
503 ssr->subdev.stop = ssr_notify_stop;
504 ssr->subdev.unprepare = ssr_notify_unprepare;
506 rproc_add_subdev(rproc, &ssr->subdev);
508 EXPORT_SYMBOL_GPL(qcom_add_ssr_subdev);
511 * qcom_remove_ssr_subdev() - remove subdevice as restart notification source
512 * @rproc: rproc handle
513 * @ssr: SSR subdevice handle
515 void qcom_remove_ssr_subdev(struct rproc *rproc, struct qcom_rproc_ssr *ssr)
517 rproc_remove_subdev(rproc, &ssr->subdev);
520 EXPORT_SYMBOL_GPL(qcom_remove_ssr_subdev);
522 MODULE_DESCRIPTION("Qualcomm Remoteproc helper driver");
523 MODULE_LICENSE("GPL v2");