1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2011-2012, The Linux Foundation. All rights reserved.
4  *
5  * Description: CoreSight Embedded Trace Buffer driver
6  */
7 
8 #include <linux/atomic.h>
9 #include <linux/kernel.h>
10 #include <linux/init.h>
11 #include <linux/types.h>
12 #include <linux/device.h>
13 #include <linux/io.h>
14 #include <linux/err.h>
15 #include <linux/fs.h>
16 #include <linux/miscdevice.h>
17 #include <linux/uaccess.h>
18 #include <linux/slab.h>
19 #include <linux/spinlock.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/seq_file.h>
22 #include <linux/coresight.h>
23 #include <linux/amba/bus.h>
24 #include <linux/clk.h>
25 #include <linux/circ_buf.h>
26 #include <linux/mm.h>
27 #include <linux/perf_event.h>
28 
29 
30 #include "coresight-priv.h"
31 #include "coresight-etm-perf.h"
32 
33 #define ETB_RAM_DEPTH_REG	0x004
34 #define ETB_STATUS_REG		0x00c
35 #define ETB_RAM_READ_DATA_REG	0x010
36 #define ETB_RAM_READ_POINTER	0x014
37 #define ETB_RAM_WRITE_POINTER	0x018
38 #define ETB_TRG			0x01c
39 #define ETB_CTL_REG		0x020
40 #define ETB_RWD_REG		0x024
41 #define ETB_FFSR		0x300
42 #define ETB_FFCR		0x304
43 #define ETB_ITMISCOP0		0xee0
44 #define ETB_ITTRFLINACK		0xee4
45 #define ETB_ITTRFLIN		0xee8
46 #define ETB_ITATBDATA0		0xeeC
47 #define ETB_ITATBCTR2		0xef0
48 #define ETB_ITATBCTR1		0xef4
49 #define ETB_ITATBCTR0		0xef8
50 
51 /* register description */
52 /* STS - 0x00C */
53 #define ETB_STATUS_RAM_FULL	BIT(0)
54 /* CTL - 0x020 */
55 #define ETB_CTL_CAPT_EN		BIT(0)
56 /* FFCR - 0x304 */
57 #define ETB_FFCR_EN_FTC		BIT(0)
58 #define ETB_FFCR_FON_MAN	BIT(6)
59 #define ETB_FFCR_STOP_FI	BIT(12)
60 #define ETB_FFCR_STOP_TRIGGER	BIT(13)
61 
62 #define ETB_FFCR_BIT		6
63 #define ETB_FFSR_BIT		1
64 #define ETB_FRAME_SIZE_WORDS	4
65 
66 DEFINE_CORESIGHT_DEVLIST(etb_devs, "etb");
67 
68 /**
69  * struct etb_drvdata - specifics associated to an ETB component
70  * @base:	memory mapped base address for this component.
71  * @atclk:	optional clock for the core parts of the ETB.
72  * @csdev:	component vitals needed by the framework.
73  * @miscdev:	specifics to handle "/dev/xyz.etb" entry.
74  * @spinlock:	only one at a time pls.
75  * @reading:	synchronise user space access to etb buffer.
76  * @pid:	Process ID of the process being monitored by the session
77  *		that is using this component.
78  * @buf:	area of memory where ETB buffer content gets sent.
79  * @mode:	this ETB is being used.
80  * @buffer_depth: size of @buf.
81  * @trigger_cntr: amount of words to store after a trigger.
82  */
83 struct etb_drvdata {
84 	void __iomem		*base;
85 	struct clk		*atclk;
86 	struct coresight_device	*csdev;
87 	struct miscdevice	miscdev;
88 	spinlock_t		spinlock;
89 	local_t			reading;
90 	pid_t			pid;
91 	u8			*buf;
92 	u32			mode;
93 	u32			buffer_depth;
94 	u32			trigger_cntr;
95 };
96 
97 static int etb_set_buffer(struct coresight_device *csdev,
98 			  struct perf_output_handle *handle);
99 
100 static inline unsigned int etb_get_buffer_depth(struct etb_drvdata *drvdata)
101 {
102 	return readl_relaxed(drvdata->base + ETB_RAM_DEPTH_REG);
103 }
104 
105 static void __etb_enable_hw(struct etb_drvdata *drvdata)
106 {
107 	int i;
108 	u32 depth;
109 
110 	CS_UNLOCK(drvdata->base);
111 
112 	depth = drvdata->buffer_depth;
113 	/* reset write RAM pointer address */
114 	writel_relaxed(0x0, drvdata->base + ETB_RAM_WRITE_POINTER);
115 	/* clear entire RAM buffer */
116 	for (i = 0; i < depth; i++)
117 		writel_relaxed(0x0, drvdata->base + ETB_RWD_REG);
118 
119 	/* reset write RAM pointer address */
120 	writel_relaxed(0x0, drvdata->base + ETB_RAM_WRITE_POINTER);
121 	/* reset read RAM pointer address */
122 	writel_relaxed(0x0, drvdata->base + ETB_RAM_READ_POINTER);
123 
124 	writel_relaxed(drvdata->trigger_cntr, drvdata->base + ETB_TRG);
125 	writel_relaxed(ETB_FFCR_EN_FTC | ETB_FFCR_STOP_TRIGGER,
126 		       drvdata->base + ETB_FFCR);
127 	/* ETB trace capture enable */
128 	writel_relaxed(ETB_CTL_CAPT_EN, drvdata->base + ETB_CTL_REG);
129 
130 	CS_LOCK(drvdata->base);
131 }
132 
133 static int etb_enable_hw(struct etb_drvdata *drvdata)
134 {
135 	int rc = coresight_claim_device(drvdata->base);
136 
137 	if (rc)
138 		return rc;
139 
140 	__etb_enable_hw(drvdata);
141 	return 0;
142 }
143 
144 static int etb_enable_sysfs(struct coresight_device *csdev)
145 {
146 	int ret = 0;
147 	unsigned long flags;
148 	struct etb_drvdata *drvdata = dev_get_drvdata(csdev->dev.parent);
149 
150 	spin_lock_irqsave(&drvdata->spinlock, flags);
151 
152 	/* Don't messup with perf sessions. */
153 	if (drvdata->mode == CS_MODE_PERF) {
154 		ret = -EBUSY;
155 		goto out;
156 	}
157 
158 	if (drvdata->mode == CS_MODE_DISABLED) {
159 		ret = etb_enable_hw(drvdata);
160 		if (ret)
161 			goto out;
162 
163 		drvdata->mode = CS_MODE_SYSFS;
164 	}
165 
166 	atomic_inc(csdev->refcnt);
167 out:
168 	spin_unlock_irqrestore(&drvdata->spinlock, flags);
169 	return ret;
170 }
171 
172 static int etb_enable_perf(struct coresight_device *csdev, void *data)
173 {
174 	int ret = 0;
175 	pid_t pid;
176 	unsigned long flags;
177 	struct etb_drvdata *drvdata = dev_get_drvdata(csdev->dev.parent);
178 	struct perf_output_handle *handle = data;
179 	struct cs_buffers *buf = etm_perf_sink_config(handle);
180 
181 	spin_lock_irqsave(&drvdata->spinlock, flags);
182 
183 	/* No need to continue if the component is already in used by sysFS. */
184 	if (drvdata->mode == CS_MODE_SYSFS) {
185 		ret = -EBUSY;
186 		goto out;
187 	}
188 
189 	/* Get a handle on the pid of the process to monitor */
190 	pid = buf->pid;
191 
192 	if (drvdata->pid != -1 && drvdata->pid != pid) {
193 		ret = -EBUSY;
194 		goto out;
195 	}
196 
197 	/*
198 	 * No HW configuration is needed if the sink is already in
199 	 * use for this session.
200 	 */
201 	if (drvdata->pid == pid) {
202 		atomic_inc(csdev->refcnt);
203 		goto out;
204 	}
205 
206 	/*
207 	 * We don't have an internal state to clean up if we fail to setup
208 	 * the perf buffer. So we can perform the step before we turn the
209 	 * ETB on and leave without cleaning up.
210 	 */
211 	ret = etb_set_buffer(csdev, handle);
212 	if (ret)
213 		goto out;
214 
215 	ret = etb_enable_hw(drvdata);
216 	if (!ret) {
217 		/* Associate with monitored process. */
218 		drvdata->pid = pid;
219 		drvdata->mode = CS_MODE_PERF;
220 		atomic_inc(csdev->refcnt);
221 	}
222 
223 out:
224 	spin_unlock_irqrestore(&drvdata->spinlock, flags);
225 	return ret;
226 }
227 
228 static int etb_enable(struct coresight_device *csdev, u32 mode, void *data)
229 {
230 	int ret;
231 
232 	switch (mode) {
233 	case CS_MODE_SYSFS:
234 		ret = etb_enable_sysfs(csdev);
235 		break;
236 	case CS_MODE_PERF:
237 		ret = etb_enable_perf(csdev, data);
238 		break;
239 	default:
240 		ret = -EINVAL;
241 		break;
242 	}
243 
244 	if (ret)
245 		return ret;
246 
247 	dev_dbg(&csdev->dev, "ETB enabled\n");
248 	return 0;
249 }
250 
251 static void __etb_disable_hw(struct etb_drvdata *drvdata)
252 {
253 	u32 ffcr;
254 	struct device *dev = &drvdata->csdev->dev;
255 
256 	CS_UNLOCK(drvdata->base);
257 
258 	ffcr = readl_relaxed(drvdata->base + ETB_FFCR);
259 	/* stop formatter when a stop has completed */
260 	ffcr |= ETB_FFCR_STOP_FI;
261 	writel_relaxed(ffcr, drvdata->base + ETB_FFCR);
262 	/* manually generate a flush of the system */
263 	ffcr |= ETB_FFCR_FON_MAN;
264 	writel_relaxed(ffcr, drvdata->base + ETB_FFCR);
265 
266 	if (coresight_timeout(drvdata->base, ETB_FFCR, ETB_FFCR_BIT, 0)) {
267 		dev_err(dev,
268 		"timeout while waiting for completion of Manual Flush\n");
269 	}
270 
271 	/* disable trace capture */
272 	writel_relaxed(0x0, drvdata->base + ETB_CTL_REG);
273 
274 	if (coresight_timeout(drvdata->base, ETB_FFSR, ETB_FFSR_BIT, 1)) {
275 		dev_err(dev,
276 			"timeout while waiting for Formatter to Stop\n");
277 	}
278 
279 	CS_LOCK(drvdata->base);
280 }
281 
282 static void etb_dump_hw(struct etb_drvdata *drvdata)
283 {
284 	bool lost = false;
285 	int i;
286 	u8 *buf_ptr;
287 	u32 read_data, depth;
288 	u32 read_ptr, write_ptr;
289 	u32 frame_off, frame_endoff;
290 	struct device *dev = &drvdata->csdev->dev;
291 
292 	CS_UNLOCK(drvdata->base);
293 
294 	read_ptr = readl_relaxed(drvdata->base + ETB_RAM_READ_POINTER);
295 	write_ptr = readl_relaxed(drvdata->base + ETB_RAM_WRITE_POINTER);
296 
297 	frame_off = write_ptr % ETB_FRAME_SIZE_WORDS;
298 	frame_endoff = ETB_FRAME_SIZE_WORDS - frame_off;
299 	if (frame_off) {
300 		dev_err(dev,
301 			"write_ptr: %lu not aligned to formatter frame size\n",
302 			(unsigned long)write_ptr);
303 		dev_err(dev, "frameoff: %lu, frame_endoff: %lu\n",
304 			(unsigned long)frame_off, (unsigned long)frame_endoff);
305 		write_ptr += frame_endoff;
306 	}
307 
308 	if ((readl_relaxed(drvdata->base + ETB_STATUS_REG)
309 		      & ETB_STATUS_RAM_FULL) == 0) {
310 		writel_relaxed(0x0, drvdata->base + ETB_RAM_READ_POINTER);
311 	} else {
312 		writel_relaxed(write_ptr, drvdata->base + ETB_RAM_READ_POINTER);
313 		lost = true;
314 	}
315 
316 	depth = drvdata->buffer_depth;
317 	buf_ptr = drvdata->buf;
318 	for (i = 0; i < depth; i++) {
319 		read_data = readl_relaxed(drvdata->base +
320 					  ETB_RAM_READ_DATA_REG);
321 		*(u32 *)buf_ptr = read_data;
322 		buf_ptr += 4;
323 	}
324 
325 	if (lost)
326 		coresight_insert_barrier_packet(drvdata->buf);
327 
328 	if (frame_off) {
329 		buf_ptr -= (frame_endoff * 4);
330 		for (i = 0; i < frame_endoff; i++) {
331 			*buf_ptr++ = 0x0;
332 			*buf_ptr++ = 0x0;
333 			*buf_ptr++ = 0x0;
334 			*buf_ptr++ = 0x0;
335 		}
336 	}
337 
338 	writel_relaxed(read_ptr, drvdata->base + ETB_RAM_READ_POINTER);
339 
340 	CS_LOCK(drvdata->base);
341 }
342 
343 static void etb_disable_hw(struct etb_drvdata *drvdata)
344 {
345 	__etb_disable_hw(drvdata);
346 	etb_dump_hw(drvdata);
347 	coresight_disclaim_device(drvdata->base);
348 }
349 
350 static int etb_disable(struct coresight_device *csdev)
351 {
352 	struct etb_drvdata *drvdata = dev_get_drvdata(csdev->dev.parent);
353 	unsigned long flags;
354 
355 	spin_lock_irqsave(&drvdata->spinlock, flags);
356 
357 	if (atomic_dec_return(csdev->refcnt)) {
358 		spin_unlock_irqrestore(&drvdata->spinlock, flags);
359 		return -EBUSY;
360 	}
361 
362 	/* Complain if we (somehow) got out of sync */
363 	WARN_ON_ONCE(drvdata->mode == CS_MODE_DISABLED);
364 	etb_disable_hw(drvdata);
365 	/* Dissociate from monitored process. */
366 	drvdata->pid = -1;
367 	drvdata->mode = CS_MODE_DISABLED;
368 	spin_unlock_irqrestore(&drvdata->spinlock, flags);
369 
370 	dev_dbg(&csdev->dev, "ETB disabled\n");
371 	return 0;
372 }
373 
374 static void *etb_alloc_buffer(struct coresight_device *csdev,
375 			      struct perf_event *event, void **pages,
376 			      int nr_pages, bool overwrite)
377 {
378 	int node;
379 	struct cs_buffers *buf;
380 
381 	node = (event->cpu == -1) ? NUMA_NO_NODE : cpu_to_node(event->cpu);
382 
383 	buf = kzalloc_node(sizeof(struct cs_buffers), GFP_KERNEL, node);
384 	if (!buf)
385 		return NULL;
386 
387 	buf->pid = task_pid_nr(event->owner);
388 	buf->snapshot = overwrite;
389 	buf->nr_pages = nr_pages;
390 	buf->data_pages = pages;
391 
392 	return buf;
393 }
394 
395 static void etb_free_buffer(void *config)
396 {
397 	struct cs_buffers *buf = config;
398 
399 	kfree(buf);
400 }
401 
402 static int etb_set_buffer(struct coresight_device *csdev,
403 			  struct perf_output_handle *handle)
404 {
405 	int ret = 0;
406 	unsigned long head;
407 	struct cs_buffers *buf = etm_perf_sink_config(handle);
408 
409 	if (!buf)
410 		return -EINVAL;
411 
412 	/* wrap head around to the amount of space we have */
413 	head = handle->head & ((buf->nr_pages << PAGE_SHIFT) - 1);
414 
415 	/* find the page to write to */
416 	buf->cur = head / PAGE_SIZE;
417 
418 	/* and offset within that page */
419 	buf->offset = head % PAGE_SIZE;
420 
421 	local_set(&buf->data_size, 0);
422 
423 	return ret;
424 }
425 
426 static unsigned long etb_update_buffer(struct coresight_device *csdev,
427 			      struct perf_output_handle *handle,
428 			      void *sink_config)
429 {
430 	bool lost = false;
431 	int i, cur;
432 	u8 *buf_ptr;
433 	const u32 *barrier;
434 	u32 read_ptr, write_ptr, capacity;
435 	u32 status, read_data;
436 	unsigned long offset, to_read = 0, flags;
437 	struct cs_buffers *buf = sink_config;
438 	struct etb_drvdata *drvdata = dev_get_drvdata(csdev->dev.parent);
439 
440 	if (!buf)
441 		return 0;
442 
443 	capacity = drvdata->buffer_depth * ETB_FRAME_SIZE_WORDS;
444 
445 	spin_lock_irqsave(&drvdata->spinlock, flags);
446 
447 	/* Don't do anything if another tracer is using this sink */
448 	if (atomic_read(csdev->refcnt) != 1)
449 		goto out;
450 
451 	__etb_disable_hw(drvdata);
452 	CS_UNLOCK(drvdata->base);
453 
454 	/* unit is in words, not bytes */
455 	read_ptr = readl_relaxed(drvdata->base + ETB_RAM_READ_POINTER);
456 	write_ptr = readl_relaxed(drvdata->base + ETB_RAM_WRITE_POINTER);
457 
458 	/*
459 	 * Entries should be aligned to the frame size.  If they are not
460 	 * go back to the last alignment point to give decoding tools a
461 	 * chance to fix things.
462 	 */
463 	if (write_ptr % ETB_FRAME_SIZE_WORDS) {
464 		dev_err(&csdev->dev,
465 			"write_ptr: %lu not aligned to formatter frame size\n",
466 			(unsigned long)write_ptr);
467 
468 		write_ptr &= ~(ETB_FRAME_SIZE_WORDS - 1);
469 		lost = true;
470 	}
471 
472 	/*
473 	 * Get a hold of the status register and see if a wrap around
474 	 * has occurred.  If so adjust things accordingly.  Otherwise
475 	 * start at the beginning and go until the write pointer has
476 	 * been reached.
477 	 */
478 	status = readl_relaxed(drvdata->base + ETB_STATUS_REG);
479 	if (status & ETB_STATUS_RAM_FULL) {
480 		lost = true;
481 		to_read = capacity;
482 		read_ptr = write_ptr;
483 	} else {
484 		to_read = CIRC_CNT(write_ptr, read_ptr, drvdata->buffer_depth);
485 		to_read *= ETB_FRAME_SIZE_WORDS;
486 	}
487 
488 	/*
489 	 * Make sure we don't overwrite data that hasn't been consumed yet.
490 	 * It is entirely possible that the HW buffer has more data than the
491 	 * ring buffer can currently handle.  If so adjust the start address
492 	 * to take only the last traces.
493 	 *
494 	 * In snapshot mode we are looking to get the latest traces only and as
495 	 * such, we don't care about not overwriting data that hasn't been
496 	 * processed by user space.
497 	 */
498 	if (!buf->snapshot && to_read > handle->size) {
499 		u32 mask = ~(ETB_FRAME_SIZE_WORDS - 1);
500 
501 		/* The new read pointer must be frame size aligned */
502 		to_read = handle->size & mask;
503 		/*
504 		 * Move the RAM read pointer up, keeping in mind that
505 		 * everything is in frame size units.
506 		 */
507 		read_ptr = (write_ptr + drvdata->buffer_depth) -
508 					to_read / ETB_FRAME_SIZE_WORDS;
509 		/* Wrap around if need be*/
510 		if (read_ptr > (drvdata->buffer_depth - 1))
511 			read_ptr -= drvdata->buffer_depth;
512 		/* let the decoder know we've skipped ahead */
513 		lost = true;
514 	}
515 
516 	/*
517 	 * Don't set the TRUNCATED flag in snapshot mode because 1) the
518 	 * captured buffer is expected to be truncated and 2) a full buffer
519 	 * prevents the event from being re-enabled by the perf core,
520 	 * resulting in stale data being send to user space.
521 	 */
522 	if (!buf->snapshot && lost)
523 		perf_aux_output_flag(handle, PERF_AUX_FLAG_TRUNCATED);
524 
525 	/* finally tell HW where we want to start reading from */
526 	writel_relaxed(read_ptr, drvdata->base + ETB_RAM_READ_POINTER);
527 
528 	cur = buf->cur;
529 	offset = buf->offset;
530 	barrier = coresight_barrier_pkt;
531 
532 	for (i = 0; i < to_read; i += 4) {
533 		buf_ptr = buf->data_pages[cur] + offset;
534 		read_data = readl_relaxed(drvdata->base +
535 					  ETB_RAM_READ_DATA_REG);
536 		if (lost && i < CORESIGHT_BARRIER_PKT_SIZE) {
537 			read_data = *barrier;
538 			barrier++;
539 		}
540 
541 		*(u32 *)buf_ptr = read_data;
542 		buf_ptr += 4;
543 
544 		offset += 4;
545 		if (offset >= PAGE_SIZE) {
546 			offset = 0;
547 			cur++;
548 			/* wrap around at the end of the buffer */
549 			cur &= buf->nr_pages - 1;
550 		}
551 	}
552 
553 	/* reset ETB buffer for next run */
554 	writel_relaxed(0x0, drvdata->base + ETB_RAM_READ_POINTER);
555 	writel_relaxed(0x0, drvdata->base + ETB_RAM_WRITE_POINTER);
556 
557 	/*
558 	 * In snapshot mode we simply increment the head by the number of byte
559 	 * that were written.  User space function  cs_etm_find_snapshot() will
560 	 * figure out how many bytes to get from the AUX buffer based on the
561 	 * position of the head.
562 	 */
563 	if (buf->snapshot)
564 		handle->head += to_read;
565 
566 	__etb_enable_hw(drvdata);
567 	CS_LOCK(drvdata->base);
568 out:
569 	spin_unlock_irqrestore(&drvdata->spinlock, flags);
570 
571 	return to_read;
572 }
573 
574 static const struct coresight_ops_sink etb_sink_ops = {
575 	.enable		= etb_enable,
576 	.disable	= etb_disable,
577 	.alloc_buffer	= etb_alloc_buffer,
578 	.free_buffer	= etb_free_buffer,
579 	.update_buffer	= etb_update_buffer,
580 };
581 
582 static const struct coresight_ops etb_cs_ops = {
583 	.sink_ops	= &etb_sink_ops,
584 };
585 
586 static void etb_dump(struct etb_drvdata *drvdata)
587 {
588 	unsigned long flags;
589 
590 	spin_lock_irqsave(&drvdata->spinlock, flags);
591 	if (drvdata->mode == CS_MODE_SYSFS) {
592 		__etb_disable_hw(drvdata);
593 		etb_dump_hw(drvdata);
594 		__etb_enable_hw(drvdata);
595 	}
596 	spin_unlock_irqrestore(&drvdata->spinlock, flags);
597 
598 	dev_dbg(&drvdata->csdev->dev, "ETB dumped\n");
599 }
600 
601 static int etb_open(struct inode *inode, struct file *file)
602 {
603 	struct etb_drvdata *drvdata = container_of(file->private_data,
604 						   struct etb_drvdata, miscdev);
605 
606 	if (local_cmpxchg(&drvdata->reading, 0, 1))
607 		return -EBUSY;
608 
609 	dev_dbg(&drvdata->csdev->dev, "%s: successfully opened\n", __func__);
610 	return 0;
611 }
612 
613 static ssize_t etb_read(struct file *file, char __user *data,
614 				size_t len, loff_t *ppos)
615 {
616 	u32 depth;
617 	struct etb_drvdata *drvdata = container_of(file->private_data,
618 						   struct etb_drvdata, miscdev);
619 	struct device *dev = &drvdata->csdev->dev;
620 
621 	etb_dump(drvdata);
622 
623 	depth = drvdata->buffer_depth;
624 	if (*ppos + len > depth * 4)
625 		len = depth * 4 - *ppos;
626 
627 	if (copy_to_user(data, drvdata->buf + *ppos, len)) {
628 		dev_dbg(dev,
629 			"%s: copy_to_user failed\n", __func__);
630 		return -EFAULT;
631 	}
632 
633 	*ppos += len;
634 
635 	dev_dbg(dev, "%s: %zu bytes copied, %d bytes left\n",
636 		__func__, len, (int)(depth * 4 - *ppos));
637 	return len;
638 }
639 
640 static int etb_release(struct inode *inode, struct file *file)
641 {
642 	struct etb_drvdata *drvdata = container_of(file->private_data,
643 						   struct etb_drvdata, miscdev);
644 	local_set(&drvdata->reading, 0);
645 
646 	dev_dbg(&drvdata->csdev->dev, "%s: released\n", __func__);
647 	return 0;
648 }
649 
650 static const struct file_operations etb_fops = {
651 	.owner		= THIS_MODULE,
652 	.open		= etb_open,
653 	.read		= etb_read,
654 	.release	= etb_release,
655 	.llseek		= no_llseek,
656 };
657 
658 #define coresight_etb10_reg(name, offset)		\
659 	coresight_simple_reg32(struct etb_drvdata, name, offset)
660 
661 coresight_etb10_reg(rdp, ETB_RAM_DEPTH_REG);
662 coresight_etb10_reg(sts, ETB_STATUS_REG);
663 coresight_etb10_reg(rrp, ETB_RAM_READ_POINTER);
664 coresight_etb10_reg(rwp, ETB_RAM_WRITE_POINTER);
665 coresight_etb10_reg(trg, ETB_TRG);
666 coresight_etb10_reg(ctl, ETB_CTL_REG);
667 coresight_etb10_reg(ffsr, ETB_FFSR);
668 coresight_etb10_reg(ffcr, ETB_FFCR);
669 
670 static struct attribute *coresight_etb_mgmt_attrs[] = {
671 	&dev_attr_rdp.attr,
672 	&dev_attr_sts.attr,
673 	&dev_attr_rrp.attr,
674 	&dev_attr_rwp.attr,
675 	&dev_attr_trg.attr,
676 	&dev_attr_ctl.attr,
677 	&dev_attr_ffsr.attr,
678 	&dev_attr_ffcr.attr,
679 	NULL,
680 };
681 
682 static ssize_t trigger_cntr_show(struct device *dev,
683 			    struct device_attribute *attr, char *buf)
684 {
685 	struct etb_drvdata *drvdata = dev_get_drvdata(dev->parent);
686 	unsigned long val = drvdata->trigger_cntr;
687 
688 	return sprintf(buf, "%#lx\n", val);
689 }
690 
691 static ssize_t trigger_cntr_store(struct device *dev,
692 			     struct device_attribute *attr,
693 			     const char *buf, size_t size)
694 {
695 	int ret;
696 	unsigned long val;
697 	struct etb_drvdata *drvdata = dev_get_drvdata(dev->parent);
698 
699 	ret = kstrtoul(buf, 16, &val);
700 	if (ret)
701 		return ret;
702 
703 	drvdata->trigger_cntr = val;
704 	return size;
705 }
706 static DEVICE_ATTR_RW(trigger_cntr);
707 
708 static struct attribute *coresight_etb_attrs[] = {
709 	&dev_attr_trigger_cntr.attr,
710 	NULL,
711 };
712 
713 static const struct attribute_group coresight_etb_group = {
714 	.attrs = coresight_etb_attrs,
715 };
716 
717 static const struct attribute_group coresight_etb_mgmt_group = {
718 	.attrs = coresight_etb_mgmt_attrs,
719 	.name = "mgmt",
720 };
721 
722 static const struct attribute_group *coresight_etb_groups[] = {
723 	&coresight_etb_group,
724 	&coresight_etb_mgmt_group,
725 	NULL,
726 };
727 
728 static int etb_probe(struct amba_device *adev, const struct amba_id *id)
729 {
730 	int ret;
731 	void __iomem *base;
732 	struct device *dev = &adev->dev;
733 	struct coresight_platform_data *pdata = NULL;
734 	struct etb_drvdata *drvdata;
735 	struct resource *res = &adev->res;
736 	struct coresight_desc desc = { 0 };
737 
738 	desc.name = coresight_alloc_device_name(&etb_devs, dev);
739 	if (!desc.name)
740 		return -ENOMEM;
741 
742 	drvdata = devm_kzalloc(dev, sizeof(*drvdata), GFP_KERNEL);
743 	if (!drvdata)
744 		return -ENOMEM;
745 
746 	drvdata->atclk = devm_clk_get(&adev->dev, "atclk"); /* optional */
747 	if (!IS_ERR(drvdata->atclk)) {
748 		ret = clk_prepare_enable(drvdata->atclk);
749 		if (ret)
750 			return ret;
751 	}
752 	dev_set_drvdata(dev, drvdata);
753 
754 	/* validity for the resource is already checked by the AMBA core */
755 	base = devm_ioremap_resource(dev, res);
756 	if (IS_ERR(base))
757 		return PTR_ERR(base);
758 
759 	drvdata->base = base;
760 	desc.access = CSDEV_ACCESS_IOMEM(base);
761 
762 	spin_lock_init(&drvdata->spinlock);
763 
764 	drvdata->buffer_depth = etb_get_buffer_depth(drvdata);
765 
766 	if (drvdata->buffer_depth & 0x80000000)
767 		return -EINVAL;
768 
769 	drvdata->buf = devm_kcalloc(dev,
770 				    drvdata->buffer_depth, 4, GFP_KERNEL);
771 	if (!drvdata->buf)
772 		return -ENOMEM;
773 
774 	/* This device is not associated with a session */
775 	drvdata->pid = -1;
776 
777 	pdata = coresight_get_platform_data(dev);
778 	if (IS_ERR(pdata))
779 		return PTR_ERR(pdata);
780 	adev->dev.platform_data = pdata;
781 
782 	desc.type = CORESIGHT_DEV_TYPE_SINK;
783 	desc.subtype.sink_subtype = CORESIGHT_DEV_SUBTYPE_SINK_BUFFER;
784 	desc.ops = &etb_cs_ops;
785 	desc.pdata = pdata;
786 	desc.dev = dev;
787 	desc.groups = coresight_etb_groups;
788 	drvdata->csdev = coresight_register(&desc);
789 	if (IS_ERR(drvdata->csdev))
790 		return PTR_ERR(drvdata->csdev);
791 
792 	drvdata->miscdev.name = desc.name;
793 	drvdata->miscdev.minor = MISC_DYNAMIC_MINOR;
794 	drvdata->miscdev.fops = &etb_fops;
795 	ret = misc_register(&drvdata->miscdev);
796 	if (ret)
797 		goto err_misc_register;
798 
799 	pm_runtime_put(&adev->dev);
800 	return 0;
801 
802 err_misc_register:
803 	coresight_unregister(drvdata->csdev);
804 	return ret;
805 }
806 
807 static int etb_remove(struct amba_device *adev)
808 {
809 	struct etb_drvdata *drvdata = dev_get_drvdata(&adev->dev);
810 
811 	/*
812 	 * Since misc_open() holds a refcount on the f_ops, which is
813 	 * etb fops in this case, device is there until last file
814 	 * handler to this device is closed.
815 	 */
816 	misc_deregister(&drvdata->miscdev);
817 	coresight_unregister(drvdata->csdev);
818 
819 	return 0;
820 }
821 
822 #ifdef CONFIG_PM
823 static int etb_runtime_suspend(struct device *dev)
824 {
825 	struct etb_drvdata *drvdata = dev_get_drvdata(dev);
826 
827 	if (drvdata && !IS_ERR(drvdata->atclk))
828 		clk_disable_unprepare(drvdata->atclk);
829 
830 	return 0;
831 }
832 
833 static int etb_runtime_resume(struct device *dev)
834 {
835 	struct etb_drvdata *drvdata = dev_get_drvdata(dev);
836 
837 	if (drvdata && !IS_ERR(drvdata->atclk))
838 		clk_prepare_enable(drvdata->atclk);
839 
840 	return 0;
841 }
842 #endif
843 
844 static const struct dev_pm_ops etb_dev_pm_ops = {
845 	SET_RUNTIME_PM_OPS(etb_runtime_suspend, etb_runtime_resume, NULL)
846 };
847 
848 static const struct amba_id etb_ids[] = {
849 	{
850 		.id	= 0x000bb907,
851 		.mask	= 0x000fffff,
852 	},
853 	{ 0, 0},
854 };
855 
856 MODULE_DEVICE_TABLE(amba, etb_ids);
857 
858 static struct amba_driver etb_driver = {
859 	.drv = {
860 		.name	= "coresight-etb10",
861 		.owner	= THIS_MODULE,
862 		.pm	= &etb_dev_pm_ops,
863 		.suppress_bind_attrs = true,
864 
865 	},
866 	.probe		= etb_probe,
867 	.remove		= etb_remove,
868 	.id_table	= etb_ids,
869 };
870 
871 module_amba_driver(etb_driver);
872 
873 MODULE_AUTHOR("Pratik Patel <pratikp@codeaurora.org>");
874 MODULE_AUTHOR("Mathieu Poirier <mathieu.poirier@linaro.org>");
875 MODULE_DESCRIPTION("Arm CoreSight Embedded Trace Buffer driver");
876 MODULE_LICENSE("GPL v2");
877