GNU Linux-libre 4.19.286-gnu1
[releases.git] / drivers / hwtracing / coresight / coresight-catu.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2018 Arm Limited. All rights reserved.
4  *
5  * Author: Suzuki K Poulose <suzuki.poulose@arm.com>
6  */
7
8 #ifndef _CORESIGHT_CATU_H
9 #define _CORESIGHT_CATU_H
10
11 #include "coresight-priv.h"
12
13 /* Register offset from base */
14 #define CATU_CONTROL            0x000
15 #define CATU_MODE               0x004
16 #define CATU_AXICTRL            0x008
17 #define CATU_IRQEN              0x00c
18 #define CATU_SLADDRLO           0x020
19 #define CATU_SLADDRHI           0x024
20 #define CATU_INADDRLO           0x028
21 #define CATU_INADDRHI           0x02c
22 #define CATU_STATUS             0x100
23 #define CATU_DEVARCH            0xfbc
24
25 #define CATU_CONTROL_ENABLE     0
26
27 #define CATU_MODE_PASS_THROUGH  0U
28 #define CATU_MODE_TRANSLATE     1U
29
30 #define CATU_AXICTRL_ARCACHE_SHIFT      4
31 #define CATU_AXICTRL_ARCACHE_MASK       0xf
32 #define CATU_AXICTRL_ARPROT_MASK        0x3
33 #define CATU_AXICTRL_ARCACHE(arcache)           \
34         (((arcache) & CATU_AXICTRL_ARCACHE_MASK) << CATU_AXICTRL_ARCACHE_SHIFT)
35
36 #define CATU_AXICTRL_VAL(arcache, arprot)       \
37         (CATU_AXICTRL_ARCACHE(arcache) | ((arprot) & CATU_AXICTRL_ARPROT_MASK))
38
39 #define AXI3_AxCACHE_WB_READ_ALLOC      0x7
40 /*
41  * AXI - ARPROT bits:
42  * See AMBA AXI & ACE Protocol specification (ARM IHI 0022E)
43  * sectionA4.7 Access Permissions.
44  *
45  * Bit 0: 0 - Unprivileged access, 1 - Privileged access
46  * Bit 1: 0 - Secure access, 1 - Non-secure access.
47  * Bit 2: 0 - Data access, 1 - instruction access.
48  *
49  * CATU AXICTRL:ARPROT[2] is res0 as we always access data.
50  */
51 #define CATU_OS_ARPROT                  0x2
52
53 #define CATU_OS_AXICTRL         \
54         CATU_AXICTRL_VAL(AXI3_AxCACHE_WB_READ_ALLOC, CATU_OS_ARPROT)
55
56 #define CATU_STATUS_READY       8
57 #define CATU_STATUS_ADRERR      0
58 #define CATU_STATUS_AXIERR      4
59
60 #define CATU_IRQEN_ON           0x1
61 #define CATU_IRQEN_OFF          0x0
62
63 struct catu_drvdata {
64         struct device *dev;
65         void __iomem *base;
66         struct coresight_device *csdev;
67         int irq;
68 };
69
70 #define CATU_REG32(name, offset)                                        \
71 static inline u32                                                       \
72 catu_read_##name(struct catu_drvdata *drvdata)                          \
73 {                                                                       \
74         return coresight_read_reg_pair(drvdata->base, offset, -1);      \
75 }                                                                       \
76 static inline void                                                      \
77 catu_write_##name(struct catu_drvdata *drvdata, u32 val)                \
78 {                                                                       \
79         coresight_write_reg_pair(drvdata->base, val, offset, -1);       \
80 }
81
82 #define CATU_REG_PAIR(name, lo_off, hi_off)                             \
83 static inline u64                                                       \
84 catu_read_##name(struct catu_drvdata *drvdata)                          \
85 {                                                                       \
86         return coresight_read_reg_pair(drvdata->base, lo_off, hi_off);  \
87 }                                                                       \
88 static inline void                                                      \
89 catu_write_##name(struct catu_drvdata *drvdata, u64 val)                \
90 {                                                                       \
91         coresight_write_reg_pair(drvdata->base, val, lo_off, hi_off);   \
92 }
93
94 CATU_REG32(control, CATU_CONTROL);
95 CATU_REG32(mode, CATU_MODE);
96 CATU_REG32(irqen, CATU_IRQEN);
97 CATU_REG32(axictrl, CATU_AXICTRL);
98 CATU_REG_PAIR(sladdr, CATU_SLADDRLO, CATU_SLADDRHI)
99 CATU_REG_PAIR(inaddr, CATU_INADDRLO, CATU_INADDRHI)
100
101 static inline bool coresight_is_catu_device(struct coresight_device *csdev)
102 {
103         if (!IS_ENABLED(CONFIG_CORESIGHT_CATU))
104                 return false;
105         if (csdev->type != CORESIGHT_DEV_TYPE_HELPER)
106                 return false;
107         if (csdev->subtype.helper_subtype != CORESIGHT_DEV_SUBTYPE_HELPER_CATU)
108                 return false;
109         return true;
110 }
111
112 extern const struct etr_buf_operations etr_catu_buf_ops;
113
114 #endif