1 /* Copyright (c) 2011-2012, The Linux Foundation. All rights reserved.
3 * Description: CoreSight Embedded Trace Buffer driver
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 and
7 * only version 2 as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #include <asm/local.h>
16 #include <linux/kernel.h>
17 #include <linux/init.h>
18 #include <linux/types.h>
19 #include <linux/device.h>
21 #include <linux/err.h>
23 #include <linux/miscdevice.h>
24 #include <linux/uaccess.h>
25 #include <linux/slab.h>
26 #include <linux/spinlock.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/seq_file.h>
29 #include <linux/coresight.h>
30 #include <linux/amba/bus.h>
31 #include <linux/clk.h>
32 #include <linux/circ_buf.h>
34 #include <linux/perf_event.h>
36 #include <asm/local.h>
38 #include "coresight-priv.h"
40 #define ETB_RAM_DEPTH_REG 0x004
41 #define ETB_STATUS_REG 0x00c
42 #define ETB_RAM_READ_DATA_REG 0x010
43 #define ETB_RAM_READ_POINTER 0x014
44 #define ETB_RAM_WRITE_POINTER 0x018
46 #define ETB_CTL_REG 0x020
47 #define ETB_RWD_REG 0x024
48 #define ETB_FFSR 0x300
49 #define ETB_FFCR 0x304
50 #define ETB_ITMISCOP0 0xee0
51 #define ETB_ITTRFLINACK 0xee4
52 #define ETB_ITTRFLIN 0xee8
53 #define ETB_ITATBDATA0 0xeeC
54 #define ETB_ITATBCTR2 0xef0
55 #define ETB_ITATBCTR1 0xef4
56 #define ETB_ITATBCTR0 0xef8
58 /* register description */
60 #define ETB_STATUS_RAM_FULL BIT(0)
62 #define ETB_CTL_CAPT_EN BIT(0)
64 #define ETB_FFCR_EN_FTC BIT(0)
65 #define ETB_FFCR_FON_MAN BIT(6)
66 #define ETB_FFCR_STOP_FI BIT(12)
67 #define ETB_FFCR_STOP_TRIGGER BIT(13)
69 #define ETB_FFCR_BIT 6
70 #define ETB_FFSR_BIT 1
71 #define ETB_FRAME_SIZE_WORDS 4
74 * struct etb_drvdata - specifics associated to an ETB component
75 * @base: memory mapped base address for this component.
76 * @dev: the device entity associated to this component.
77 * @atclk: optional clock for the core parts of the ETB.
78 * @csdev: component vitals needed by the framework.
79 * @miscdev: specifics to handle "/dev/xyz.etb" entry.
80 * @spinlock: only one at a time pls.
81 * @reading: synchronise user space access to etb buffer.
82 * @mode: this ETB is being used.
83 * @buf: area of memory where ETB buffer content gets sent.
84 * @buffer_depth: size of @buf.
85 * @trigger_cntr: amount of words to store after a trigger.
91 struct coresight_device
*csdev
;
92 struct miscdevice miscdev
;
101 static unsigned int etb_get_buffer_depth(struct etb_drvdata
*drvdata
)
105 pm_runtime_get_sync(drvdata
->dev
);
107 /* RO registers don't need locking */
108 depth
= readl_relaxed(drvdata
->base
+ ETB_RAM_DEPTH_REG
);
110 pm_runtime_put(drvdata
->dev
);
114 static void etb_enable_hw(struct etb_drvdata
*drvdata
)
119 CS_UNLOCK(drvdata
->base
);
121 depth
= drvdata
->buffer_depth
;
122 /* reset write RAM pointer address */
123 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
124 /* clear entire RAM buffer */
125 for (i
= 0; i
< depth
; i
++)
126 writel_relaxed(0x0, drvdata
->base
+ ETB_RWD_REG
);
128 /* reset write RAM pointer address */
129 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
130 /* reset read RAM pointer address */
131 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_READ_POINTER
);
133 writel_relaxed(drvdata
->trigger_cntr
, drvdata
->base
+ ETB_TRG
);
134 writel_relaxed(ETB_FFCR_EN_FTC
| ETB_FFCR_STOP_TRIGGER
,
135 drvdata
->base
+ ETB_FFCR
);
136 /* ETB trace capture enable */
137 writel_relaxed(ETB_CTL_CAPT_EN
, drvdata
->base
+ ETB_CTL_REG
);
139 CS_LOCK(drvdata
->base
);
142 static int etb_enable(struct coresight_device
*csdev
, u32 mode
)
146 struct etb_drvdata
*drvdata
= dev_get_drvdata(csdev
->dev
.parent
);
148 val
= local_cmpxchg(&drvdata
->mode
,
149 CS_MODE_DISABLED
, mode
);
151 * When accessing from Perf, a HW buffer can be handled
152 * by a single trace entity. In sysFS mode many tracers
153 * can be logging to the same HW buffer.
155 if (val
== CS_MODE_PERF
)
158 /* Don't let perf disturb sysFS sessions */
159 if (val
== CS_MODE_SYSFS
&& mode
== CS_MODE_PERF
)
162 /* Nothing to do, the tracer is already enabled. */
163 if (val
== CS_MODE_SYSFS
)
166 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
167 etb_enable_hw(drvdata
);
168 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
171 dev_info(drvdata
->dev
, "ETB enabled\n");
175 static void etb_disable_hw(struct etb_drvdata
*drvdata
)
179 CS_UNLOCK(drvdata
->base
);
181 ffcr
= readl_relaxed(drvdata
->base
+ ETB_FFCR
);
182 /* stop formatter when a stop has completed */
183 ffcr
|= ETB_FFCR_STOP_FI
;
184 writel_relaxed(ffcr
, drvdata
->base
+ ETB_FFCR
);
185 /* manually generate a flush of the system */
186 ffcr
|= ETB_FFCR_FON_MAN
;
187 writel_relaxed(ffcr
, drvdata
->base
+ ETB_FFCR
);
189 if (coresight_timeout(drvdata
->base
, ETB_FFCR
, ETB_FFCR_BIT
, 0)) {
190 dev_err(drvdata
->dev
,
191 "timeout while waiting for completion of Manual Flush\n");
194 /* disable trace capture */
195 writel_relaxed(0x0, drvdata
->base
+ ETB_CTL_REG
);
197 if (coresight_timeout(drvdata
->base
, ETB_FFSR
, ETB_FFSR_BIT
, 1)) {
198 dev_err(drvdata
->dev
,
199 "timeout while waiting for Formatter to Stop\n");
202 CS_LOCK(drvdata
->base
);
205 static void etb_dump_hw(struct etb_drvdata
*drvdata
)
211 u32 read_data
, depth
;
212 u32 read_ptr
, write_ptr
;
213 u32 frame_off
, frame_endoff
;
215 CS_UNLOCK(drvdata
->base
);
217 read_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_READ_POINTER
);
218 write_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
220 frame_off
= write_ptr
% ETB_FRAME_SIZE_WORDS
;
221 frame_endoff
= ETB_FRAME_SIZE_WORDS
- frame_off
;
223 dev_err(drvdata
->dev
,
224 "write_ptr: %lu not aligned to formatter frame size\n",
225 (unsigned long)write_ptr
);
226 dev_err(drvdata
->dev
, "frameoff: %lu, frame_endoff: %lu\n",
227 (unsigned long)frame_off
, (unsigned long)frame_endoff
);
228 write_ptr
+= frame_endoff
;
231 if ((readl_relaxed(drvdata
->base
+ ETB_STATUS_REG
)
232 & ETB_STATUS_RAM_FULL
) == 0) {
233 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_READ_POINTER
);
235 writel_relaxed(write_ptr
, drvdata
->base
+ ETB_RAM_READ_POINTER
);
239 depth
= drvdata
->buffer_depth
;
240 buf_ptr
= drvdata
->buf
;
241 barrier
= barrier_pkt
;
242 for (i
= 0; i
< depth
; i
++) {
243 read_data
= readl_relaxed(drvdata
->base
+
244 ETB_RAM_READ_DATA_REG
);
245 if (lost
&& *barrier
) {
246 read_data
= *barrier
;
250 *(u32
*)buf_ptr
= read_data
;
255 buf_ptr
-= (frame_endoff
* 4);
256 for (i
= 0; i
< frame_endoff
; i
++) {
264 writel_relaxed(read_ptr
, drvdata
->base
+ ETB_RAM_READ_POINTER
);
266 CS_LOCK(drvdata
->base
);
269 static void etb_disable(struct coresight_device
*csdev
)
271 struct etb_drvdata
*drvdata
= dev_get_drvdata(csdev
->dev
.parent
);
274 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
275 etb_disable_hw(drvdata
);
276 etb_dump_hw(drvdata
);
277 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
279 local_set(&drvdata
->mode
, CS_MODE_DISABLED
);
281 dev_info(drvdata
->dev
, "ETB disabled\n");
284 static void *etb_alloc_buffer(struct coresight_device
*csdev
, int cpu
,
285 void **pages
, int nr_pages
, bool overwrite
)
288 struct cs_buffers
*buf
;
291 cpu
= smp_processor_id();
292 node
= cpu_to_node(cpu
);
294 buf
= kzalloc_node(sizeof(struct cs_buffers
), GFP_KERNEL
, node
);
298 buf
->snapshot
= overwrite
;
299 buf
->nr_pages
= nr_pages
;
300 buf
->data_pages
= pages
;
305 static void etb_free_buffer(void *config
)
307 struct cs_buffers
*buf
= config
;
312 static int etb_set_buffer(struct coresight_device
*csdev
,
313 struct perf_output_handle
*handle
,
318 struct cs_buffers
*buf
= sink_config
;
320 /* wrap head around to the amount of space we have */
321 head
= handle
->head
& ((buf
->nr_pages
<< PAGE_SHIFT
) - 1);
323 /* find the page to write to */
324 buf
->cur
= head
/ PAGE_SIZE
;
326 /* and offset within that page */
327 buf
->offset
= head
% PAGE_SIZE
;
329 local_set(&buf
->data_size
, 0);
334 static unsigned long etb_reset_buffer(struct coresight_device
*csdev
,
335 struct perf_output_handle
*handle
,
338 unsigned long size
= 0;
339 struct cs_buffers
*buf
= sink_config
;
343 * In snapshot mode ->data_size holds the new address of the
344 * ring buffer's head. The size itself is the whole address
345 * range since we want the latest information.
348 handle
->head
= local_xchg(&buf
->data_size
,
349 buf
->nr_pages
<< PAGE_SHIFT
);
352 * Tell the tracer PMU how much we got in this run and if
353 * something went wrong along the way. Nobody else can use
354 * this cs_buffers instance until we are done. As such
355 * resetting parameters here and squaring off with the ring
356 * buffer API in the tracer PMU is fine.
358 size
= local_xchg(&buf
->data_size
, 0);
364 static void etb_update_buffer(struct coresight_device
*csdev
,
365 struct perf_output_handle
*handle
,
372 u32 read_ptr
, write_ptr
, capacity
;
373 u32 status
, read_data
, to_read
;
374 unsigned long offset
;
375 struct cs_buffers
*buf
= sink_config
;
376 struct etb_drvdata
*drvdata
= dev_get_drvdata(csdev
->dev
.parent
);
381 capacity
= drvdata
->buffer_depth
* ETB_FRAME_SIZE_WORDS
;
383 etb_disable_hw(drvdata
);
384 CS_UNLOCK(drvdata
->base
);
386 /* unit is in words, not bytes */
387 read_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_READ_POINTER
);
388 write_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
391 * Entries should be aligned to the frame size. If they are not
392 * go back to the last alignment point to give decoding tools a
393 * chance to fix things.
395 if (write_ptr
% ETB_FRAME_SIZE_WORDS
) {
396 dev_err(drvdata
->dev
,
397 "write_ptr: %lu not aligned to formatter frame size\n",
398 (unsigned long)write_ptr
);
400 write_ptr
&= ~(ETB_FRAME_SIZE_WORDS
- 1);
405 * Get a hold of the status register and see if a wrap around
406 * has occurred. If so adjust things accordingly. Otherwise
407 * start at the beginning and go until the write pointer has
410 status
= readl_relaxed(drvdata
->base
+ ETB_STATUS_REG
);
411 if (status
& ETB_STATUS_RAM_FULL
) {
414 read_ptr
= write_ptr
;
416 to_read
= CIRC_CNT(write_ptr
, read_ptr
, drvdata
->buffer_depth
);
417 to_read
*= ETB_FRAME_SIZE_WORDS
;
421 * Make sure we don't overwrite data that hasn't been consumed yet.
422 * It is entirely possible that the HW buffer has more data than the
423 * ring buffer can currently handle. If so adjust the start address
424 * to take only the last traces.
426 * In snapshot mode we are looking to get the latest traces only and as
427 * such, we don't care about not overwriting data that hasn't been
428 * processed by user space.
430 if (!buf
->snapshot
&& to_read
> handle
->size
) {
431 u32 mask
= ~(ETB_FRAME_SIZE_WORDS
- 1);
433 /* The new read pointer must be frame size aligned */
434 to_read
= handle
->size
& mask
;
436 * Move the RAM read pointer up, keeping in mind that
437 * everything is in frame size units.
439 read_ptr
= (write_ptr
+ drvdata
->buffer_depth
) -
440 to_read
/ ETB_FRAME_SIZE_WORDS
;
441 /* Wrap around if need be*/
442 if (read_ptr
> (drvdata
->buffer_depth
- 1))
443 read_ptr
-= drvdata
->buffer_depth
;
444 /* let the decoder know we've skipped ahead */
449 perf_aux_output_flag(handle
, PERF_AUX_FLAG_TRUNCATED
);
451 /* finally tell HW where we want to start reading from */
452 writel_relaxed(read_ptr
, drvdata
->base
+ ETB_RAM_READ_POINTER
);
455 offset
= buf
->offset
;
456 barrier
= barrier_pkt
;
458 for (i
= 0; i
< to_read
; i
+= 4) {
459 buf_ptr
= buf
->data_pages
[cur
] + offset
;
460 read_data
= readl_relaxed(drvdata
->base
+
461 ETB_RAM_READ_DATA_REG
);
462 if (lost
&& *barrier
) {
463 read_data
= *barrier
;
467 *(u32
*)buf_ptr
= read_data
;
471 if (offset
>= PAGE_SIZE
) {
474 /* wrap around at the end of the buffer */
475 cur
&= buf
->nr_pages
- 1;
479 /* reset ETB buffer for next run */
480 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_READ_POINTER
);
481 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
484 * In snapshot mode all we have to do is communicate to
485 * perf_aux_output_end() the address of the current head. In full
486 * trace mode the same function expects a size to move rb->aux_head
490 local_set(&buf
->data_size
, (cur
* PAGE_SIZE
) + offset
);
492 local_add(to_read
, &buf
->data_size
);
494 etb_enable_hw(drvdata
);
495 CS_LOCK(drvdata
->base
);
498 static const struct coresight_ops_sink etb_sink_ops
= {
499 .enable
= etb_enable
,
500 .disable
= etb_disable
,
501 .alloc_buffer
= etb_alloc_buffer
,
502 .free_buffer
= etb_free_buffer
,
503 .set_buffer
= etb_set_buffer
,
504 .reset_buffer
= etb_reset_buffer
,
505 .update_buffer
= etb_update_buffer
,
508 static const struct coresight_ops etb_cs_ops
= {
509 .sink_ops
= &etb_sink_ops
,
512 static void etb_dump(struct etb_drvdata
*drvdata
)
516 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
517 if (local_read(&drvdata
->mode
) == CS_MODE_SYSFS
) {
518 etb_disable_hw(drvdata
);
519 etb_dump_hw(drvdata
);
520 etb_enable_hw(drvdata
);
522 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
524 dev_info(drvdata
->dev
, "ETB dumped\n");
527 static int etb_open(struct inode
*inode
, struct file
*file
)
529 struct etb_drvdata
*drvdata
= container_of(file
->private_data
,
530 struct etb_drvdata
, miscdev
);
532 if (local_cmpxchg(&drvdata
->reading
, 0, 1))
535 dev_dbg(drvdata
->dev
, "%s: successfully opened\n", __func__
);
539 static ssize_t
etb_read(struct file
*file
, char __user
*data
,
540 size_t len
, loff_t
*ppos
)
543 struct etb_drvdata
*drvdata
= container_of(file
->private_data
,
544 struct etb_drvdata
, miscdev
);
548 depth
= drvdata
->buffer_depth
;
549 if (*ppos
+ len
> depth
* 4)
550 len
= depth
* 4 - *ppos
;
552 if (copy_to_user(data
, drvdata
->buf
+ *ppos
, len
)) {
553 dev_dbg(drvdata
->dev
, "%s: copy_to_user failed\n", __func__
);
559 dev_dbg(drvdata
->dev
, "%s: %zu bytes copied, %d bytes left\n",
560 __func__
, len
, (int)(depth
* 4 - *ppos
));
564 static int etb_release(struct inode
*inode
, struct file
*file
)
566 struct etb_drvdata
*drvdata
= container_of(file
->private_data
,
567 struct etb_drvdata
, miscdev
);
568 local_set(&drvdata
->reading
, 0);
570 dev_dbg(drvdata
->dev
, "%s: released\n", __func__
);
574 static const struct file_operations etb_fops
= {
575 .owner
= THIS_MODULE
,
578 .release
= etb_release
,
582 #define coresight_etb10_reg(name, offset) \
583 coresight_simple_reg32(struct etb_drvdata, name, offset)
585 coresight_etb10_reg(rdp
, ETB_RAM_DEPTH_REG
);
586 coresight_etb10_reg(sts
, ETB_STATUS_REG
);
587 coresight_etb10_reg(rrp
, ETB_RAM_READ_POINTER
);
588 coresight_etb10_reg(rwp
, ETB_RAM_WRITE_POINTER
);
589 coresight_etb10_reg(trg
, ETB_TRG
);
590 coresight_etb10_reg(ctl
, ETB_CTL_REG
);
591 coresight_etb10_reg(ffsr
, ETB_FFSR
);
592 coresight_etb10_reg(ffcr
, ETB_FFCR
);
594 static struct attribute
*coresight_etb_mgmt_attrs
[] = {
606 static ssize_t
trigger_cntr_show(struct device
*dev
,
607 struct device_attribute
*attr
, char *buf
)
609 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
610 unsigned long val
= drvdata
->trigger_cntr
;
612 return sprintf(buf
, "%#lx\n", val
);
615 static ssize_t
trigger_cntr_store(struct device
*dev
,
616 struct device_attribute
*attr
,
617 const char *buf
, size_t size
)
621 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
623 ret
= kstrtoul(buf
, 16, &val
);
627 drvdata
->trigger_cntr
= val
;
630 static DEVICE_ATTR_RW(trigger_cntr
);
632 static struct attribute
*coresight_etb_attrs
[] = {
633 &dev_attr_trigger_cntr
.attr
,
637 static const struct attribute_group coresight_etb_group
= {
638 .attrs
= coresight_etb_attrs
,
641 static const struct attribute_group coresight_etb_mgmt_group
= {
642 .attrs
= coresight_etb_mgmt_attrs
,
646 const struct attribute_group
*coresight_etb_groups
[] = {
647 &coresight_etb_group
,
648 &coresight_etb_mgmt_group
,
652 static int etb_probe(struct amba_device
*adev
, const struct amba_id
*id
)
656 struct device
*dev
= &adev
->dev
;
657 struct coresight_platform_data
*pdata
= NULL
;
658 struct etb_drvdata
*drvdata
;
659 struct resource
*res
= &adev
->res
;
660 struct coresight_desc desc
= { 0 };
661 struct device_node
*np
= adev
->dev
.of_node
;
664 pdata
= of_get_coresight_platform_data(dev
, np
);
666 return PTR_ERR(pdata
);
667 adev
->dev
.platform_data
= pdata
;
670 drvdata
= devm_kzalloc(dev
, sizeof(*drvdata
), GFP_KERNEL
);
674 drvdata
->dev
= &adev
->dev
;
675 drvdata
->atclk
= devm_clk_get(&adev
->dev
, "atclk"); /* optional */
676 if (!IS_ERR(drvdata
->atclk
)) {
677 ret
= clk_prepare_enable(drvdata
->atclk
);
681 dev_set_drvdata(dev
, drvdata
);
683 /* validity for the resource is already checked by the AMBA core */
684 base
= devm_ioremap_resource(dev
, res
);
686 return PTR_ERR(base
);
688 drvdata
->base
= base
;
690 spin_lock_init(&drvdata
->spinlock
);
692 drvdata
->buffer_depth
= etb_get_buffer_depth(drvdata
);
693 pm_runtime_put(&adev
->dev
);
695 if (drvdata
->buffer_depth
& 0x80000000)
698 drvdata
->buf
= devm_kzalloc(dev
,
699 drvdata
->buffer_depth
* 4, GFP_KERNEL
);
703 desc
.type
= CORESIGHT_DEV_TYPE_SINK
;
704 desc
.subtype
.sink_subtype
= CORESIGHT_DEV_SUBTYPE_SINK_BUFFER
;
705 desc
.ops
= &etb_cs_ops
;
708 desc
.groups
= coresight_etb_groups
;
709 drvdata
->csdev
= coresight_register(&desc
);
710 if (IS_ERR(drvdata
->csdev
))
711 return PTR_ERR(drvdata
->csdev
);
713 drvdata
->miscdev
.name
= pdata
->name
;
714 drvdata
->miscdev
.minor
= MISC_DYNAMIC_MINOR
;
715 drvdata
->miscdev
.fops
= &etb_fops
;
716 ret
= misc_register(&drvdata
->miscdev
);
718 goto err_misc_register
;
723 coresight_unregister(drvdata
->csdev
);
728 static int etb_runtime_suspend(struct device
*dev
)
730 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
);
732 if (drvdata
&& !IS_ERR(drvdata
->atclk
))
733 clk_disable_unprepare(drvdata
->atclk
);
738 static int etb_runtime_resume(struct device
*dev
)
740 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
);
742 if (drvdata
&& !IS_ERR(drvdata
->atclk
))
743 clk_prepare_enable(drvdata
->atclk
);
749 static const struct dev_pm_ops etb_dev_pm_ops
= {
750 SET_RUNTIME_PM_OPS(etb_runtime_suspend
, etb_runtime_resume
, NULL
)
753 static const struct amba_id etb_ids
[] = {
761 static struct amba_driver etb_driver
= {
763 .name
= "coresight-etb10",
764 .owner
= THIS_MODULE
,
765 .pm
= &etb_dev_pm_ops
,
766 .suppress_bind_attrs
= true,
772 builtin_amba_driver(etb_driver
);