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 /* Nothing to do, the tracer is already enabled. */
159 if (val
== CS_MODE_SYSFS
)
162 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
163 etb_enable_hw(drvdata
);
164 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
167 dev_info(drvdata
->dev
, "ETB enabled\n");
171 static void etb_disable_hw(struct etb_drvdata
*drvdata
)
175 CS_UNLOCK(drvdata
->base
);
177 ffcr
= readl_relaxed(drvdata
->base
+ ETB_FFCR
);
178 /* stop formatter when a stop has completed */
179 ffcr
|= ETB_FFCR_STOP_FI
;
180 writel_relaxed(ffcr
, drvdata
->base
+ ETB_FFCR
);
181 /* manually generate a flush of the system */
182 ffcr
|= ETB_FFCR_FON_MAN
;
183 writel_relaxed(ffcr
, drvdata
->base
+ ETB_FFCR
);
185 if (coresight_timeout(drvdata
->base
, ETB_FFCR
, ETB_FFCR_BIT
, 0)) {
186 dev_err(drvdata
->dev
,
187 "timeout while waiting for completion of Manual Flush\n");
190 /* disable trace capture */
191 writel_relaxed(0x0, drvdata
->base
+ ETB_CTL_REG
);
193 if (coresight_timeout(drvdata
->base
, ETB_FFSR
, ETB_FFSR_BIT
, 1)) {
194 dev_err(drvdata
->dev
,
195 "timeout while waiting for Formatter to Stop\n");
198 CS_LOCK(drvdata
->base
);
201 static void etb_dump_hw(struct etb_drvdata
*drvdata
)
205 u32 read_data
, depth
;
206 u32 read_ptr
, write_ptr
;
207 u32 frame_off
, frame_endoff
;
209 CS_UNLOCK(drvdata
->base
);
211 read_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_READ_POINTER
);
212 write_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
214 frame_off
= write_ptr
% ETB_FRAME_SIZE_WORDS
;
215 frame_endoff
= ETB_FRAME_SIZE_WORDS
- frame_off
;
217 dev_err(drvdata
->dev
,
218 "write_ptr: %lu not aligned to formatter frame size\n",
219 (unsigned long)write_ptr
);
220 dev_err(drvdata
->dev
, "frameoff: %lu, frame_endoff: %lu\n",
221 (unsigned long)frame_off
, (unsigned long)frame_endoff
);
222 write_ptr
+= frame_endoff
;
225 if ((readl_relaxed(drvdata
->base
+ ETB_STATUS_REG
)
226 & ETB_STATUS_RAM_FULL
) == 0)
227 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_READ_POINTER
);
229 writel_relaxed(write_ptr
, drvdata
->base
+ ETB_RAM_READ_POINTER
);
231 depth
= drvdata
->buffer_depth
;
232 buf_ptr
= drvdata
->buf
;
233 for (i
= 0; i
< depth
; i
++) {
234 read_data
= readl_relaxed(drvdata
->base
+
235 ETB_RAM_READ_DATA_REG
);
236 *buf_ptr
++ = read_data
>> 0;
237 *buf_ptr
++ = read_data
>> 8;
238 *buf_ptr
++ = read_data
>> 16;
239 *buf_ptr
++ = read_data
>> 24;
243 buf_ptr
-= (frame_endoff
* 4);
244 for (i
= 0; i
< frame_endoff
; i
++) {
252 writel_relaxed(read_ptr
, drvdata
->base
+ ETB_RAM_READ_POINTER
);
254 CS_LOCK(drvdata
->base
);
257 static void etb_disable(struct coresight_device
*csdev
)
259 struct etb_drvdata
*drvdata
= dev_get_drvdata(csdev
->dev
.parent
);
262 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
263 etb_disable_hw(drvdata
);
264 etb_dump_hw(drvdata
);
265 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
267 local_set(&drvdata
->mode
, CS_MODE_DISABLED
);
269 dev_info(drvdata
->dev
, "ETB disabled\n");
272 static void *etb_alloc_buffer(struct coresight_device
*csdev
, int cpu
,
273 void **pages
, int nr_pages
, bool overwrite
)
276 struct cs_buffers
*buf
;
279 cpu
= smp_processor_id();
280 node
= cpu_to_node(cpu
);
282 buf
= kzalloc_node(sizeof(struct cs_buffers
), GFP_KERNEL
, node
);
286 buf
->snapshot
= overwrite
;
287 buf
->nr_pages
= nr_pages
;
288 buf
->data_pages
= pages
;
293 static void etb_free_buffer(void *config
)
295 struct cs_buffers
*buf
= config
;
300 static int etb_set_buffer(struct coresight_device
*csdev
,
301 struct perf_output_handle
*handle
,
306 struct cs_buffers
*buf
= sink_config
;
308 /* wrap head around to the amount of space we have */
309 head
= handle
->head
& ((buf
->nr_pages
<< PAGE_SHIFT
) - 1);
311 /* find the page to write to */
312 buf
->cur
= head
/ PAGE_SIZE
;
314 /* and offset within that page */
315 buf
->offset
= head
% PAGE_SIZE
;
317 local_set(&buf
->data_size
, 0);
322 static unsigned long etb_reset_buffer(struct coresight_device
*csdev
,
323 struct perf_output_handle
*handle
,
324 void *sink_config
, bool *lost
)
326 unsigned long size
= 0;
327 struct cs_buffers
*buf
= sink_config
;
331 * In snapshot mode ->data_size holds the new address of the
332 * ring buffer's head. The size itself is the whole address
333 * range since we want the latest information.
336 handle
->head
= local_xchg(&buf
->data_size
,
337 buf
->nr_pages
<< PAGE_SHIFT
);
340 * Tell the tracer PMU how much we got in this run and if
341 * something went wrong along the way. Nobody else can use
342 * this cs_buffers instance until we are done. As such
343 * resetting parameters here and squaring off with the ring
344 * buffer API in the tracer PMU is fine.
346 *lost
= !!local_xchg(&buf
->lost
, 0);
347 size
= local_xchg(&buf
->data_size
, 0);
353 static void etb_update_buffer(struct coresight_device
*csdev
,
354 struct perf_output_handle
*handle
,
359 u32 read_ptr
, write_ptr
, capacity
;
360 u32 status
, read_data
, to_read
;
361 unsigned long offset
;
362 struct cs_buffers
*buf
= sink_config
;
363 struct etb_drvdata
*drvdata
= dev_get_drvdata(csdev
->dev
.parent
);
368 capacity
= drvdata
->buffer_depth
* ETB_FRAME_SIZE_WORDS
;
370 CS_UNLOCK(drvdata
->base
);
371 etb_disable_hw(drvdata
);
373 /* unit is in words, not bytes */
374 read_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_READ_POINTER
);
375 write_ptr
= readl_relaxed(drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
378 * Entries should be aligned to the frame size. If they are not
379 * go back to the last alignement point to give decoding tools a
380 * chance to fix things.
382 if (write_ptr
% ETB_FRAME_SIZE_WORDS
) {
383 dev_err(drvdata
->dev
,
384 "write_ptr: %lu not aligned to formatter frame size\n",
385 (unsigned long)write_ptr
);
387 write_ptr
&= ~(ETB_FRAME_SIZE_WORDS
- 1);
388 local_inc(&buf
->lost
);
392 * Get a hold of the status register and see if a wrap around
393 * has occurred. If so adjust things accordingly. Otherwise
394 * start at the beginning and go until the write pointer has
397 status
= readl_relaxed(drvdata
->base
+ ETB_STATUS_REG
);
398 if (status
& ETB_STATUS_RAM_FULL
) {
399 local_inc(&buf
->lost
);
401 read_ptr
= write_ptr
;
403 to_read
= CIRC_CNT(write_ptr
, read_ptr
, drvdata
->buffer_depth
);
404 to_read
*= ETB_FRAME_SIZE_WORDS
;
408 * Make sure we don't overwrite data that hasn't been consumed yet.
409 * It is entirely possible that the HW buffer has more data than the
410 * ring buffer can currently handle. If so adjust the start address
411 * to take only the last traces.
413 * In snapshot mode we are looking to get the latest traces only and as
414 * such, we don't care about not overwriting data that hasn't been
415 * processed by user space.
417 if (!buf
->snapshot
&& to_read
> handle
->size
) {
418 u32 mask
= ~(ETB_FRAME_SIZE_WORDS
- 1);
420 /* The new read pointer must be frame size aligned */
421 to_read
= handle
->size
& mask
;
423 * Move the RAM read pointer up, keeping in mind that
424 * everything is in frame size units.
426 read_ptr
= (write_ptr
+ drvdata
->buffer_depth
) -
427 to_read
/ ETB_FRAME_SIZE_WORDS
;
428 /* Wrap around if need be*/
429 if (read_ptr
> (drvdata
->buffer_depth
- 1))
430 read_ptr
-= drvdata
->buffer_depth
;
431 /* let the decoder know we've skipped ahead */
432 local_inc(&buf
->lost
);
435 /* finally tell HW where we want to start reading from */
436 writel_relaxed(read_ptr
, drvdata
->base
+ ETB_RAM_READ_POINTER
);
439 offset
= buf
->offset
;
440 for (i
= 0; i
< to_read
; i
+= 4) {
441 buf_ptr
= buf
->data_pages
[cur
] + offset
;
442 read_data
= readl_relaxed(drvdata
->base
+
443 ETB_RAM_READ_DATA_REG
);
444 *buf_ptr
++ = read_data
>> 0;
445 *buf_ptr
++ = read_data
>> 8;
446 *buf_ptr
++ = read_data
>> 16;
447 *buf_ptr
++ = read_data
>> 24;
450 if (offset
>= PAGE_SIZE
) {
453 /* wrap around at the end of the buffer */
454 cur
&= buf
->nr_pages
- 1;
458 /* reset ETB buffer for next run */
459 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_READ_POINTER
);
460 writel_relaxed(0x0, drvdata
->base
+ ETB_RAM_WRITE_POINTER
);
463 * In snapshot mode all we have to do is communicate to
464 * perf_aux_output_end() the address of the current head. In full
465 * trace mode the same function expects a size to move rb->aux_head
469 local_set(&buf
->data_size
, (cur
* PAGE_SIZE
) + offset
);
471 local_add(to_read
, &buf
->data_size
);
473 etb_enable_hw(drvdata
);
474 CS_LOCK(drvdata
->base
);
477 static const struct coresight_ops_sink etb_sink_ops
= {
478 .enable
= etb_enable
,
479 .disable
= etb_disable
,
480 .alloc_buffer
= etb_alloc_buffer
,
481 .free_buffer
= etb_free_buffer
,
482 .set_buffer
= etb_set_buffer
,
483 .reset_buffer
= etb_reset_buffer
,
484 .update_buffer
= etb_update_buffer
,
487 static const struct coresight_ops etb_cs_ops
= {
488 .sink_ops
= &etb_sink_ops
,
491 static void etb_dump(struct etb_drvdata
*drvdata
)
495 spin_lock_irqsave(&drvdata
->spinlock
, flags
);
496 if (local_read(&drvdata
->mode
) == CS_MODE_SYSFS
) {
497 etb_disable_hw(drvdata
);
498 etb_dump_hw(drvdata
);
499 etb_enable_hw(drvdata
);
501 spin_unlock_irqrestore(&drvdata
->spinlock
, flags
);
503 dev_info(drvdata
->dev
, "ETB dumped\n");
506 static int etb_open(struct inode
*inode
, struct file
*file
)
508 struct etb_drvdata
*drvdata
= container_of(file
->private_data
,
509 struct etb_drvdata
, miscdev
);
511 if (local_cmpxchg(&drvdata
->reading
, 0, 1))
514 dev_dbg(drvdata
->dev
, "%s: successfully opened\n", __func__
);
518 static ssize_t
etb_read(struct file
*file
, char __user
*data
,
519 size_t len
, loff_t
*ppos
)
522 struct etb_drvdata
*drvdata
= container_of(file
->private_data
,
523 struct etb_drvdata
, miscdev
);
527 depth
= drvdata
->buffer_depth
;
528 if (*ppos
+ len
> depth
* 4)
529 len
= depth
* 4 - *ppos
;
531 if (copy_to_user(data
, drvdata
->buf
+ *ppos
, len
)) {
532 dev_dbg(drvdata
->dev
, "%s: copy_to_user failed\n", __func__
);
538 dev_dbg(drvdata
->dev
, "%s: %zu bytes copied, %d bytes left\n",
539 __func__
, len
, (int)(depth
* 4 - *ppos
));
543 static int etb_release(struct inode
*inode
, struct file
*file
)
545 struct etb_drvdata
*drvdata
= container_of(file
->private_data
,
546 struct etb_drvdata
, miscdev
);
547 local_set(&drvdata
->reading
, 0);
549 dev_dbg(drvdata
->dev
, "%s: released\n", __func__
);
553 static const struct file_operations etb_fops
= {
554 .owner
= THIS_MODULE
,
557 .release
= etb_release
,
561 #define coresight_etb10_simple_func(name, offset) \
562 coresight_simple_func(struct etb_drvdata, NULL, name, offset)
564 coresight_etb10_simple_func(rdp
, ETB_RAM_DEPTH_REG
);
565 coresight_etb10_simple_func(sts
, ETB_STATUS_REG
);
566 coresight_etb10_simple_func(rrp
, ETB_RAM_READ_POINTER
);
567 coresight_etb10_simple_func(rwp
, ETB_RAM_WRITE_POINTER
);
568 coresight_etb10_simple_func(trg
, ETB_TRG
);
569 coresight_etb10_simple_func(ctl
, ETB_CTL_REG
);
570 coresight_etb10_simple_func(ffsr
, ETB_FFSR
);
571 coresight_etb10_simple_func(ffcr
, ETB_FFCR
);
573 static struct attribute
*coresight_etb_mgmt_attrs
[] = {
585 static ssize_t
trigger_cntr_show(struct device
*dev
,
586 struct device_attribute
*attr
, char *buf
)
588 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
589 unsigned long val
= drvdata
->trigger_cntr
;
591 return sprintf(buf
, "%#lx\n", val
);
594 static ssize_t
trigger_cntr_store(struct device
*dev
,
595 struct device_attribute
*attr
,
596 const char *buf
, size_t size
)
600 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
->parent
);
602 ret
= kstrtoul(buf
, 16, &val
);
606 drvdata
->trigger_cntr
= val
;
609 static DEVICE_ATTR_RW(trigger_cntr
);
611 static struct attribute
*coresight_etb_attrs
[] = {
612 &dev_attr_trigger_cntr
.attr
,
616 static const struct attribute_group coresight_etb_group
= {
617 .attrs
= coresight_etb_attrs
,
620 static const struct attribute_group coresight_etb_mgmt_group
= {
621 .attrs
= coresight_etb_mgmt_attrs
,
625 const struct attribute_group
*coresight_etb_groups
[] = {
626 &coresight_etb_group
,
627 &coresight_etb_mgmt_group
,
631 static int etb_probe(struct amba_device
*adev
, const struct amba_id
*id
)
635 struct device
*dev
= &adev
->dev
;
636 struct coresight_platform_data
*pdata
= NULL
;
637 struct etb_drvdata
*drvdata
;
638 struct resource
*res
= &adev
->res
;
639 struct coresight_desc desc
= { 0 };
640 struct device_node
*np
= adev
->dev
.of_node
;
643 pdata
= of_get_coresight_platform_data(dev
, np
);
645 return PTR_ERR(pdata
);
646 adev
->dev
.platform_data
= pdata
;
649 drvdata
= devm_kzalloc(dev
, sizeof(*drvdata
), GFP_KERNEL
);
653 drvdata
->dev
= &adev
->dev
;
654 drvdata
->atclk
= devm_clk_get(&adev
->dev
, "atclk"); /* optional */
655 if (!IS_ERR(drvdata
->atclk
)) {
656 ret
= clk_prepare_enable(drvdata
->atclk
);
660 dev_set_drvdata(dev
, drvdata
);
662 /* validity for the resource is already checked by the AMBA core */
663 base
= devm_ioremap_resource(dev
, res
);
665 return PTR_ERR(base
);
667 drvdata
->base
= base
;
669 spin_lock_init(&drvdata
->spinlock
);
671 drvdata
->buffer_depth
= etb_get_buffer_depth(drvdata
);
672 pm_runtime_put(&adev
->dev
);
674 if (drvdata
->buffer_depth
& 0x80000000)
677 drvdata
->buf
= devm_kzalloc(dev
,
678 drvdata
->buffer_depth
* 4, GFP_KERNEL
);
680 dev_err(dev
, "Failed to allocate %u bytes for buffer data\n",
681 drvdata
->buffer_depth
* 4);
685 desc
.type
= CORESIGHT_DEV_TYPE_SINK
;
686 desc
.subtype
.sink_subtype
= CORESIGHT_DEV_SUBTYPE_SINK_BUFFER
;
687 desc
.ops
= &etb_cs_ops
;
690 desc
.groups
= coresight_etb_groups
;
691 drvdata
->csdev
= coresight_register(&desc
);
692 if (IS_ERR(drvdata
->csdev
))
693 return PTR_ERR(drvdata
->csdev
);
695 drvdata
->miscdev
.name
= pdata
->name
;
696 drvdata
->miscdev
.minor
= MISC_DYNAMIC_MINOR
;
697 drvdata
->miscdev
.fops
= &etb_fops
;
698 ret
= misc_register(&drvdata
->miscdev
);
700 goto err_misc_register
;
705 coresight_unregister(drvdata
->csdev
);
710 static int etb_runtime_suspend(struct device
*dev
)
712 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
);
714 if (drvdata
&& !IS_ERR(drvdata
->atclk
))
715 clk_disable_unprepare(drvdata
->atclk
);
720 static int etb_runtime_resume(struct device
*dev
)
722 struct etb_drvdata
*drvdata
= dev_get_drvdata(dev
);
724 if (drvdata
&& !IS_ERR(drvdata
->atclk
))
725 clk_prepare_enable(drvdata
->atclk
);
731 static const struct dev_pm_ops etb_dev_pm_ops
= {
732 SET_RUNTIME_PM_OPS(etb_runtime_suspend
, etb_runtime_resume
, NULL
)
735 static struct amba_id etb_ids
[] = {
743 static struct amba_driver etb_driver
= {
745 .name
= "coresight-etb10",
746 .owner
= THIS_MODULE
,
747 .pm
= &etb_dev_pm_ops
,
748 .suppress_bind_attrs
= true,
754 builtin_amba_driver(etb_driver
);