1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2012, The Linux Foundation. All rights reserved.
4 * Description: CoreSight Trace Memory Controller driver
7 #include <linux/acpi.h>
8 #include <linux/kernel.h>
9 #include <linux/init.h>
10 #include <linux/types.h>
11 #include <linux/device.h>
12 #include <linux/idr.h>
14 #include <linux/iommu.h>
15 #include <linux/err.h>
17 #include <linux/miscdevice.h>
18 #include <linux/mutex.h>
19 #include <linux/property.h>
20 #include <linux/uaccess.h>
21 #include <linux/slab.h>
22 #include <linux/dma-mapping.h>
23 #include <linux/spinlock.h>
24 #include <linux/pm_runtime.h>
26 #include <linux/coresight.h>
27 #include <linux/amba/bus.h>
28 #include <linux/platform_device.h>
30 #include "coresight-priv.h"
31 #include "coresight-tmc.h"
33 DEFINE_CORESIGHT_DEVLIST(etb_devs
, "tmc_etb");
34 DEFINE_CORESIGHT_DEVLIST(etf_devs
, "tmc_etf");
35 DEFINE_CORESIGHT_DEVLIST(etr_devs
, "tmc_etr");
37 int tmc_wait_for_tmcready(struct tmc_drvdata
*drvdata
)
39 struct coresight_device
*csdev
= drvdata
->csdev
;
40 struct csdev_access
*csa
= &csdev
->access
;
42 /* Ensure formatter, unformatter and hardware fifo are empty */
43 if (coresight_timeout(csa
, TMC_STS
, TMC_STS_TMCREADY_BIT
, 1)) {
45 "timeout while waiting for TMC to be Ready\n");
51 void tmc_flush_and_stop(struct tmc_drvdata
*drvdata
)
53 struct coresight_device
*csdev
= drvdata
->csdev
;
54 struct csdev_access
*csa
= &csdev
->access
;
57 ffcr
= readl_relaxed(drvdata
->base
+ TMC_FFCR
);
58 ffcr
|= TMC_FFCR_STOP_ON_FLUSH
;
59 writel_relaxed(ffcr
, drvdata
->base
+ TMC_FFCR
);
60 ffcr
|= BIT(TMC_FFCR_FLUSHMAN_BIT
);
61 writel_relaxed(ffcr
, drvdata
->base
+ TMC_FFCR
);
62 /* Ensure flush completes */
63 if (coresight_timeout(csa
, TMC_FFCR
, TMC_FFCR_FLUSHMAN_BIT
, 0)) {
65 "timeout while waiting for completion of Manual Flush\n");
68 tmc_wait_for_tmcready(drvdata
);
71 void tmc_enable_hw(struct tmc_drvdata
*drvdata
)
73 writel_relaxed(TMC_CTL_CAPT_EN
, drvdata
->base
+ TMC_CTL
);
76 void tmc_disable_hw(struct tmc_drvdata
*drvdata
)
78 writel_relaxed(0x0, drvdata
->base
+ TMC_CTL
);
81 u32
tmc_get_memwidth_mask(struct tmc_drvdata
*drvdata
)
86 * When moving RRP or an offset address forward, the new values must
87 * be byte-address aligned to the width of the trace memory databus
88 * _and_ to a frame boundary (16 byte), whichever is the biggest. For
89 * example, for 32-bit, 64-bit and 128-bit wide trace memory, the four
90 * LSBs must be 0s. For 256-bit wide trace memory, the five LSBs must
93 switch (drvdata
->memwidth
) {
94 case TMC_MEM_INTF_WIDTH_32BITS
:
95 case TMC_MEM_INTF_WIDTH_64BITS
:
96 case TMC_MEM_INTF_WIDTH_128BITS
:
97 mask
= GENMASK(31, 4);
99 case TMC_MEM_INTF_WIDTH_256BITS
:
100 mask
= GENMASK(31, 5);
107 static int tmc_read_prepare(struct tmc_drvdata
*drvdata
)
111 switch (drvdata
->config_type
) {
112 case TMC_CONFIG_TYPE_ETB
:
113 case TMC_CONFIG_TYPE_ETF
:
114 ret
= tmc_read_prepare_etb(drvdata
);
116 case TMC_CONFIG_TYPE_ETR
:
117 ret
= tmc_read_prepare_etr(drvdata
);
124 dev_dbg(&drvdata
->csdev
->dev
, "TMC read start\n");
129 static int tmc_read_unprepare(struct tmc_drvdata
*drvdata
)
133 switch (drvdata
->config_type
) {
134 case TMC_CONFIG_TYPE_ETB
:
135 case TMC_CONFIG_TYPE_ETF
:
136 ret
= tmc_read_unprepare_etb(drvdata
);
138 case TMC_CONFIG_TYPE_ETR
:
139 ret
= tmc_read_unprepare_etr(drvdata
);
146 dev_dbg(&drvdata
->csdev
->dev
, "TMC read end\n");
151 static int tmc_open(struct inode
*inode
, struct file
*file
)
154 struct tmc_drvdata
*drvdata
= container_of(file
->private_data
,
155 struct tmc_drvdata
, miscdev
);
157 ret
= tmc_read_prepare(drvdata
);
161 nonseekable_open(inode
, file
);
163 dev_dbg(&drvdata
->csdev
->dev
, "%s: successfully opened\n", __func__
);
167 static inline ssize_t
tmc_get_sysfs_trace(struct tmc_drvdata
*drvdata
,
168 loff_t pos
, size_t len
, char **bufpp
)
170 switch (drvdata
->config_type
) {
171 case TMC_CONFIG_TYPE_ETB
:
172 case TMC_CONFIG_TYPE_ETF
:
173 return tmc_etb_get_sysfs_trace(drvdata
, pos
, len
, bufpp
);
174 case TMC_CONFIG_TYPE_ETR
:
175 return tmc_etr_get_sysfs_trace(drvdata
, pos
, len
, bufpp
);
181 static ssize_t
tmc_read(struct file
*file
, char __user
*data
, size_t len
,
186 struct tmc_drvdata
*drvdata
= container_of(file
->private_data
,
187 struct tmc_drvdata
, miscdev
);
188 actual
= tmc_get_sysfs_trace(drvdata
, *ppos
, len
, &bufp
);
192 if (copy_to_user(data
, bufp
, actual
)) {
193 dev_dbg(&drvdata
->csdev
->dev
,
194 "%s: copy_to_user failed\n", __func__
);
199 dev_dbg(&drvdata
->csdev
->dev
, "%zu bytes copied\n", actual
);
204 static int tmc_release(struct inode
*inode
, struct file
*file
)
207 struct tmc_drvdata
*drvdata
= container_of(file
->private_data
,
208 struct tmc_drvdata
, miscdev
);
210 ret
= tmc_read_unprepare(drvdata
);
214 dev_dbg(&drvdata
->csdev
->dev
, "%s: released\n", __func__
);
218 static const struct file_operations tmc_fops
= {
219 .owner
= THIS_MODULE
,
222 .release
= tmc_release
,
225 static enum tmc_mem_intf_width
tmc_get_memwidth(u32 devid
)
227 enum tmc_mem_intf_width memwidth
;
230 * Excerpt from the TRM:
232 * DEVID::MEMWIDTH[10:8]
233 * 0x2 Memory interface databus is 32 bits wide.
234 * 0x3 Memory interface databus is 64 bits wide.
235 * 0x4 Memory interface databus is 128 bits wide.
236 * 0x5 Memory interface databus is 256 bits wide.
238 switch (BMVAL(devid
, 8, 10)) {
240 memwidth
= TMC_MEM_INTF_WIDTH_32BITS
;
243 memwidth
= TMC_MEM_INTF_WIDTH_64BITS
;
246 memwidth
= TMC_MEM_INTF_WIDTH_128BITS
;
249 memwidth
= TMC_MEM_INTF_WIDTH_256BITS
;
258 static struct attribute
*coresight_tmc_mgmt_attrs
[] = {
259 coresight_simple_reg32(rsz
, TMC_RSZ
),
260 coresight_simple_reg32(sts
, TMC_STS
),
261 coresight_simple_reg64(rrp
, TMC_RRP
, TMC_RRPHI
),
262 coresight_simple_reg64(rwp
, TMC_RWP
, TMC_RWPHI
),
263 coresight_simple_reg32(trg
, TMC_TRG
),
264 coresight_simple_reg32(ctl
, TMC_CTL
),
265 coresight_simple_reg32(ffsr
, TMC_FFSR
),
266 coresight_simple_reg32(ffcr
, TMC_FFCR
),
267 coresight_simple_reg32(mode
, TMC_MODE
),
268 coresight_simple_reg32(pscr
, TMC_PSCR
),
269 coresight_simple_reg32(devid
, CORESIGHT_DEVID
),
270 coresight_simple_reg64(dba
, TMC_DBALO
, TMC_DBAHI
),
271 coresight_simple_reg32(axictl
, TMC_AXICTL
),
272 coresight_simple_reg32(authstatus
, TMC_AUTHSTATUS
),
276 static ssize_t
trigger_cntr_show(struct device
*dev
,
277 struct device_attribute
*attr
, char *buf
)
279 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
280 unsigned long val
= drvdata
->trigger_cntr
;
282 return sprintf(buf
, "%#lx\n", val
);
285 static ssize_t
trigger_cntr_store(struct device
*dev
,
286 struct device_attribute
*attr
,
287 const char *buf
, size_t size
)
291 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
293 ret
= kstrtoul(buf
, 16, &val
);
297 drvdata
->trigger_cntr
= val
;
300 static DEVICE_ATTR_RW(trigger_cntr
);
302 static ssize_t
buffer_size_show(struct device
*dev
,
303 struct device_attribute
*attr
, char *buf
)
305 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
307 return sprintf(buf
, "%#x\n", drvdata
->size
);
310 static ssize_t
buffer_size_store(struct device
*dev
,
311 struct device_attribute
*attr
,
312 const char *buf
, size_t size
)
316 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
318 /* Only permitted for TMC-ETRs */
319 if (drvdata
->config_type
!= TMC_CONFIG_TYPE_ETR
)
322 ret
= kstrtoul(buf
, 0, &val
);
325 /* The buffer size should be page aligned */
326 if (val
& (PAGE_SIZE
- 1))
332 static DEVICE_ATTR_RW(buffer_size
);
334 static struct attribute
*coresight_tmc_attrs
[] = {
335 &dev_attr_trigger_cntr
.attr
,
336 &dev_attr_buffer_size
.attr
,
340 static const struct attribute_group coresight_tmc_group
= {
341 .attrs
= coresight_tmc_attrs
,
344 static const struct attribute_group coresight_tmc_mgmt_group
= {
345 .attrs
= coresight_tmc_mgmt_attrs
,
349 static const struct attribute_group
*coresight_etf_groups
[] = {
350 &coresight_tmc_group
,
351 &coresight_tmc_mgmt_group
,
355 static const struct attribute_group
*coresight_etr_groups
[] = {
356 &coresight_etr_group
,
357 &coresight_tmc_group
,
358 &coresight_tmc_mgmt_group
,
362 static inline bool tmc_etr_can_use_sg(struct device
*dev
)
368 * Presence of the property 'arm,scatter-gather' is checked
369 * on the platform for the feature support, rather than its
372 if (is_of_node(dev
->fwnode
)) {
373 return fwnode_property_present(dev
->fwnode
, "arm,scatter-gather");
374 } else if (is_acpi_device_node(dev
->fwnode
)) {
376 * TMC_DEVID_NOSCAT test in tmc_etr_setup_caps(), has already ensured
377 * this property is only checked for Coresight SoC 400 TMC configured
380 ret
= fwnode_property_read_u8(dev
->fwnode
, "arm-armhc97c-sg-enable", &val_u8
);
384 if (fwnode_property_present(dev
->fwnode
, "arm,scatter-gather")) {
385 pr_warn_once("Deprecated ACPI property - arm,scatter-gather\n");
392 static inline bool tmc_etr_has_non_secure_access(struct tmc_drvdata
*drvdata
)
394 u32 auth
= readl_relaxed(drvdata
->base
+ TMC_AUTHSTATUS
);
396 return (auth
& TMC_AUTH_NSID_MASK
) == 0x3;
399 static const struct amba_id tmc_ids
[];
401 /* Detect and initialise the capabilities of a TMC ETR */
402 static int tmc_etr_setup_caps(struct device
*parent
, u32 devid
,
403 struct csdev_access
*access
)
406 u32 tmc_pid
, dma_mask
= 0;
407 struct tmc_drvdata
*drvdata
= dev_get_drvdata(parent
);
410 if (!tmc_etr_has_non_secure_access(drvdata
))
413 tmc_pid
= coresight_get_pid(access
);
414 dev_caps
= coresight_get_uci_data_from_amba(tmc_ids
, tmc_pid
);
416 /* Set the unadvertised capabilities */
417 tmc_etr_init_caps(drvdata
, (u32
)(unsigned long)dev_caps
);
419 if (!(devid
& TMC_DEVID_NOSCAT
) && tmc_etr_can_use_sg(parent
))
420 tmc_etr_set_cap(drvdata
, TMC_ETR_SG
);
422 /* Check if the AXI address width is available */
423 if (devid
& TMC_DEVID_AXIAW_VALID
)
424 dma_mask
= ((devid
>> TMC_DEVID_AXIAW_SHIFT
) &
425 TMC_DEVID_AXIAW_MASK
);
428 * Unless specified in the device configuration, ETR uses a 40-bit
429 * AXI master in place of the embedded SRAM of ETB/ETF.
437 dev_info(parent
, "Detected dma mask %dbits\n", dma_mask
);
443 rc
= dma_set_mask_and_coherent(parent
, DMA_BIT_MASK(dma_mask
));
445 dev_err(parent
, "Failed to setup DMA mask: %d\n", rc
);
449 static u32
tmc_etr_get_default_buffer_size(struct device
*dev
)
453 if (fwnode_property_read_u32(dev
->fwnode
, "arm,buffer-size", &size
))
458 static u32
tmc_etr_get_max_burst_size(struct device
*dev
)
462 if (fwnode_property_read_u32(dev
->fwnode
, "arm,max-burst-size",
464 return TMC_AXICTL_WR_BURST_16
;
466 /* Only permissible values are 0 to 15 */
467 if (burst_size
> 0xF)
468 burst_size
= TMC_AXICTL_WR_BURST_16
;
473 static int __tmc_probe(struct device
*dev
, struct resource
*res
)
478 struct coresight_platform_data
*pdata
= NULL
;
479 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
);
480 struct coresight_desc desc
= { 0 };
481 struct coresight_dev_list
*dev_list
= NULL
;
485 /* Validity for the resource is already checked by the AMBA core */
486 base
= devm_ioremap_resource(dev
, res
);
492 drvdata
->base
= base
;
493 desc
.access
= CSDEV_ACCESS_IOMEM(base
);
495 spin_lock_init(&drvdata
->spinlock
);
497 devid
= readl_relaxed(drvdata
->base
+ CORESIGHT_DEVID
);
498 drvdata
->config_type
= BMVAL(devid
, 6, 7);
499 drvdata
->memwidth
= tmc_get_memwidth(devid
);
500 /* This device is not associated with a session */
502 drvdata
->etr_mode
= ETR_MODE_AUTO
;
504 if (drvdata
->config_type
== TMC_CONFIG_TYPE_ETR
) {
505 drvdata
->size
= tmc_etr_get_default_buffer_size(dev
);
506 drvdata
->max_burst_size
= tmc_etr_get_max_burst_size(dev
);
508 drvdata
->size
= readl_relaxed(drvdata
->base
+ TMC_RSZ
) * 4;
513 switch (drvdata
->config_type
) {
514 case TMC_CONFIG_TYPE_ETB
:
515 desc
.groups
= coresight_etf_groups
;
516 desc
.type
= CORESIGHT_DEV_TYPE_SINK
;
517 desc
.subtype
.sink_subtype
= CORESIGHT_DEV_SUBTYPE_SINK_BUFFER
;
518 desc
.ops
= &tmc_etb_cs_ops
;
519 dev_list
= &etb_devs
;
521 case TMC_CONFIG_TYPE_ETR
:
522 desc
.groups
= coresight_etr_groups
;
523 desc
.type
= CORESIGHT_DEV_TYPE_SINK
;
524 desc
.subtype
.sink_subtype
= CORESIGHT_DEV_SUBTYPE_SINK_SYSMEM
;
525 desc
.ops
= &tmc_etr_cs_ops
;
526 ret
= tmc_etr_setup_caps(dev
, devid
, &desc
.access
);
529 idr_init(&drvdata
->idr
);
530 mutex_init(&drvdata
->idr_mutex
);
531 dev_list
= &etr_devs
;
533 case TMC_CONFIG_TYPE_ETF
:
534 desc
.groups
= coresight_etf_groups
;
535 desc
.type
= CORESIGHT_DEV_TYPE_LINKSINK
;
536 desc
.subtype
.sink_subtype
= CORESIGHT_DEV_SUBTYPE_SINK_BUFFER
;
537 desc
.subtype
.link_subtype
= CORESIGHT_DEV_SUBTYPE_LINK_FIFO
;
538 desc
.ops
= &tmc_etf_cs_ops
;
539 dev_list
= &etf_devs
;
542 pr_err("%s: Unsupported TMC config\n", desc
.name
);
547 desc
.name
= coresight_alloc_device_name(dev_list
, dev
);
553 pdata
= coresight_get_platform_data(dev
);
555 ret
= PTR_ERR(pdata
);
558 dev
->platform_data
= pdata
;
561 drvdata
->csdev
= coresight_register(&desc
);
562 if (IS_ERR(drvdata
->csdev
)) {
563 ret
= PTR_ERR(drvdata
->csdev
);
567 drvdata
->miscdev
.name
= desc
.name
;
568 drvdata
->miscdev
.minor
= MISC_DYNAMIC_MINOR
;
569 drvdata
->miscdev
.fops
= &tmc_fops
;
570 ret
= misc_register(&drvdata
->miscdev
);
572 coresight_unregister(drvdata
->csdev
);
577 static int tmc_probe(struct amba_device
*adev
, const struct amba_id
*id
)
579 struct tmc_drvdata
*drvdata
;
582 drvdata
= devm_kzalloc(&adev
->dev
, sizeof(*drvdata
), GFP_KERNEL
);
586 amba_set_drvdata(adev
, drvdata
);
587 ret
= __tmc_probe(&adev
->dev
, &adev
->res
);
589 pm_runtime_put(&adev
->dev
);
594 static void tmc_shutdown(struct amba_device
*adev
)
597 struct tmc_drvdata
*drvdata
= amba_get_drvdata(adev
);
599 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
601 if (coresight_get_mode(drvdata
->csdev
) == CS_MODE_DISABLED
)
604 if (drvdata
->config_type
== TMC_CONFIG_TYPE_ETR
)
605 tmc_etr_disable_hw(drvdata
);
608 * We do not care about coresight unregister here unlike remove
609 * callback which is required for making coresight modular since
610 * the system is going down after this.
613 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
616 static void __tmc_remove(struct device
*dev
)
618 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
);
621 * Since misc_open() holds a refcount on the f_ops, which is
622 * etb fops in this case, device is there until last file
623 * handler to this device is closed.
625 misc_deregister(&drvdata
->miscdev
);
626 coresight_unregister(drvdata
->csdev
);
629 static void tmc_remove(struct amba_device
*adev
)
631 __tmc_remove(&adev
->dev
);
634 static const struct amba_id tmc_ids
[] = {
635 CS_AMBA_ID(0x000bb961),
636 /* Coresight SoC 600 TMC-ETR/ETS */
637 CS_AMBA_ID_DATA(0x000bb9e8, (unsigned long)CORESIGHT_SOC_600_ETR_CAPS
),
638 /* Coresight SoC 600 TMC-ETB */
639 CS_AMBA_ID(0x000bb9e9),
640 /* Coresight SoC 600 TMC-ETF */
641 CS_AMBA_ID(0x000bb9ea),
645 MODULE_DEVICE_TABLE(amba
, tmc_ids
);
647 static struct amba_driver tmc_driver
= {
649 .name
= "coresight-tmc",
650 .suppress_bind_attrs
= true,
653 .shutdown
= tmc_shutdown
,
654 .remove
= tmc_remove
,
658 static int tmc_platform_probe(struct platform_device
*pdev
)
660 struct resource
*res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
661 struct tmc_drvdata
*drvdata
;
664 drvdata
= devm_kzalloc(&pdev
->dev
, sizeof(*drvdata
), GFP_KERNEL
);
668 drvdata
->pclk
= coresight_get_enable_apb_pclk(&pdev
->dev
);
669 if (IS_ERR(drvdata
->pclk
))
672 dev_set_drvdata(&pdev
->dev
, drvdata
);
673 pm_runtime_get_noresume(&pdev
->dev
);
674 pm_runtime_set_active(&pdev
->dev
);
675 pm_runtime_enable(&pdev
->dev
);
677 ret
= __tmc_probe(&pdev
->dev
, res
);
678 pm_runtime_put(&pdev
->dev
);
680 pm_runtime_disable(&pdev
->dev
);
685 static void tmc_platform_remove(struct platform_device
*pdev
)
687 struct tmc_drvdata
*drvdata
= dev_get_drvdata(&pdev
->dev
);
689 if (WARN_ON(!drvdata
))
692 __tmc_remove(&pdev
->dev
);
693 pm_runtime_disable(&pdev
->dev
);
694 if (!IS_ERR_OR_NULL(drvdata
->pclk
))
695 clk_put(drvdata
->pclk
);
699 static int tmc_runtime_suspend(struct device
*dev
)
701 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
);
703 if (drvdata
&& !IS_ERR_OR_NULL(drvdata
->pclk
))
704 clk_disable_unprepare(drvdata
->pclk
);
708 static int tmc_runtime_resume(struct device
*dev
)
710 struct tmc_drvdata
*drvdata
= dev_get_drvdata(dev
);
712 if (drvdata
&& !IS_ERR_OR_NULL(drvdata
->pclk
))
713 clk_prepare_enable(drvdata
->pclk
);
718 static const struct dev_pm_ops tmc_dev_pm_ops
= {
719 SET_RUNTIME_PM_OPS(tmc_runtime_suspend
, tmc_runtime_resume
, NULL
)
723 static const struct acpi_device_id tmc_acpi_ids
[] = {
724 {"ARMHC501", 0, 0, 0}, /* ARM CoreSight ETR */
725 {"ARMHC97C", 0, 0, 0}, /* ARM CoreSight SoC-400 TMC, SoC-600 ETF/ETB */
728 MODULE_DEVICE_TABLE(acpi
, tmc_acpi_ids
);
731 static struct platform_driver tmc_platform_driver
= {
732 .probe
= tmc_platform_probe
,
733 .remove
= tmc_platform_remove
,
735 .name
= "coresight-tmc-platform",
736 .acpi_match_table
= ACPI_PTR(tmc_acpi_ids
),
737 .suppress_bind_attrs
= true,
738 .pm
= &tmc_dev_pm_ops
,
742 static int __init
tmc_init(void)
744 return coresight_init_driver("tmc", &tmc_driver
, &tmc_platform_driver
);
747 static void __exit
tmc_exit(void)
749 coresight_remove_driver(&tmc_driver
, &tmc_platform_driver
);
751 module_init(tmc_init
);
752 module_exit(tmc_exit
);
754 MODULE_AUTHOR("Pratik Patel <pratikp@codeaurora.org>");
755 MODULE_DESCRIPTION("Arm CoreSight Trace Memory Controller driver");
756 MODULE_LICENSE("GPL v2");