Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

coresight: Adding ABI documentation

Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Mathieu Poirier and committed by
Greg Kroah-Hartman
7a25ec8e 4b7e4f82

+298
+24
Documentation/ABI/testing/sysfs-bus-coresight-devices-etb10
··· 1 + What: /sys/bus/coresight/devices/<memory_map>.etb/enable_sink 2 + Date: November 2014 3 + KernelVersion: 3.19 4 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 5 + Description: (RW) Add/remove a sink from a trace path. There can be multiple 6 + source for a single sink. 7 + ex: echo 1 > /sys/bus/coresight/devices/20010000.etb/enable_sink 8 + 9 + What: /sys/bus/coresight/devices/<memory_map>.etb/status 10 + Date: November 2014 11 + KernelVersion: 3.19 12 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 13 + Description: (R) List various control and status registers. The specific 14 + layout and content is driver specific. 15 + 16 + What: /sys/bus/coresight/devices/<memory_map>.etb/trigger_cntr 17 + Date: November 2014 18 + KernelVersion: 3.19 19 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 20 + Description: (RW) Disables write access to the Trace RAM by stopping the 21 + formatter after a defined number of words have been stored 22 + following the trigger event. The number of 32-bit words written 23 + into the Trace RAM following the trigger event is equal to the 24 + value stored in this register+1 (from ARM ETB-TRM).
+253
Documentation/ABI/testing/sysfs-bus-coresight-devices-etm3x
··· 1 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/enable_source 2 + Date: November 2014 3 + KernelVersion: 3.19 4 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 5 + Description: (RW) Enable/disable tracing on this specific trace entiry. 6 + Enabling a source implies the source has been configured 7 + properly and a sink has been identidifed for it. The path 8 + of coresight components linking the source to the sink is 9 + configured and managed automatically by the coresight framework. 10 + 11 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/status 12 + Date: November 2014 13 + KernelVersion: 3.19 14 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 15 + Description: (R) List various control and status registers. The specific 16 + layout and content is driver specific. 17 + 18 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_idx 19 + Date: November 2014 20 + KernelVersion: 3.19 21 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 22 + Description: Select which address comparator or pair (of comparators) to 23 + work with. 24 + 25 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_acctype 26 + Date: November 2014 27 + KernelVersion: 3.19 28 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 29 + Description: (RW) Used in conjunction with @addr_idx. Specifies 30 + characteristics about the address comparator being configure, 31 + for example the access type, the kind of instruction to trace, 32 + processor contect ID to trigger on, etc. Individual fields in 33 + the access type register may vary on the version of the trace 34 + entity. 35 + 36 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_range 37 + Date: November 2014 38 + KernelVersion: 3.19 39 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 40 + Description: (RW) Used in conjunction with @addr_idx. Specifies the range of 41 + addresses to trigger on. Inclusion or exclusion is specificed 42 + in the corresponding access type register. 43 + 44 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single 45 + Date: November 2014 46 + KernelVersion: 3.19 47 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 48 + Description: (RW) Used in conjunction with @addr_idx. Specifies the single 49 + address to trigger on, highly influenced by the configuration 50 + options of the corresponding access type register. 51 + 52 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_start 53 + Date: November 2014 54 + KernelVersion: 3.19 55 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 56 + Description: (RW) Used in conjunction with @addr_idx. Specifies the single 57 + address to start tracing on, highly influenced by the 58 + configuration options of the corresponding access type register. 59 + 60 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_stop 61 + Date: November 2014 62 + KernelVersion: 3.19 63 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 64 + Description: (RW) Used in conjunction with @addr_idx. Specifies the single 65 + address to stop tracing on, highly influenced by the 66 + configuration options of the corresponding access type register. 67 + 68 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_idx 69 + Date: November 2014 70 + KernelVersion: 3.19 71 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 72 + Description: (RW) Specifies the counter to work on. 73 + 74 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_event 75 + Date: November 2014 76 + KernelVersion: 3.19 77 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 78 + Description: (RW) Used in conjunction with cntr_idx, give access to the 79 + counter event register. 80 + 81 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_val 82 + Date: November 2014 83 + KernelVersion: 3.19 84 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 85 + Description: (RW) Used in conjunction with cntr_idx, give access to the 86 + counter value register. 87 + 88 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_rld_val 89 + Date: November 2014 90 + KernelVersion: 3.19 91 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 92 + Description: (RW) Used in conjunction with cntr_idx, give access to the 93 + counter reload value register. 94 + 95 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/cntr_rld_event 96 + Date: November 2014 97 + KernelVersion: 3.19 98 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 99 + Description: (RW) Used in conjunction with cntr_idx, give access to the 100 + counter reload event register. 101 + 102 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/ctxid_idx 103 + Date: November 2014 104 + KernelVersion: 3.19 105 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 106 + Description: (RW) Specifies the index of the context ID register to be 107 + selected. 108 + 109 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/ctxid_mask 110 + Date: November 2014 111 + KernelVersion: 3.19 112 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 113 + Description: (RW) Mask to apply to all the context ID comparator. 114 + 115 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/ctxid_val 116 + Date: November 2014 117 + KernelVersion: 3.19 118 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 119 + Description: (RW) Used with the ctxid_idx, specify with context ID to trigger 120 + on. 121 + 122 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/enable_event 123 + Date: November 2014 124 + KernelVersion: 3.19 125 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 126 + Description: (RW) Defines which event triggers a trace. 127 + 128 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/etmsr 129 + Date: November 2014 130 + KernelVersion: 3.19 131 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 132 + Description: (RW) Gives access to the ETM status register, which holds 133 + programming information and status on certains events. 134 + 135 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/fifofull_level 136 + Date: November 2014 137 + KernelVersion: 3.19 138 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 139 + Description: (RW) Number of byte left in the fifo before considering it full. 140 + Depending on the tracer's version, can also hold threshold for 141 + data suppression. 142 + 143 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mode 144 + Date: November 2014 145 + KernelVersion: 3.19 146 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 147 + Description: (RW) Interface with the driver's 'mode' field, controlling 148 + various aspect of the trace entity such as time stamping, 149 + context ID size and cycle accurate tracing. Driver specific 150 + and bound to change depending on the driver. 151 + 152 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_addr_cmp 153 + Date: November 2014 154 + KernelVersion: 3.19 155 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 156 + Description: (R) Provides the number of address comparators pairs accessible 157 + on a trace unit, as specified by bit 3:0 of register ETMCCR. 158 + 159 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_cntr 160 + Date: November 2014 161 + KernelVersion: 3.19 162 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 163 + Description: (R) Provides the number of counters accessible on a trace unit, 164 + as specified by bit 15:13 of register ETMCCR. 165 + 166 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/nr_ctxid_cmp 167 + Date: November 2014 168 + KernelVersion: 3.19 169 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 170 + Description: (R) Provides the number of context ID comparator available on a 171 + trace unit, as specified by bit 25:24 of register ETMCCR. 172 + 173 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/reset 174 + Date: November 2014 175 + KernelVersion: 3.19 176 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 177 + Description: (W) Cancels all configuration on a trace unit and set it back 178 + to its boot configuration. 179 + 180 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_12_event 181 + Date: November 2014 182 + KernelVersion: 3.19 183 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 184 + Description: (RW) Defines the event that causes the sequencer to transition 185 + from state 1 to state 2. 186 + 187 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_13_event 188 + Date: November 2014 189 + KernelVersion: 3.19 190 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 191 + Description: (RW) Defines the event that causes the sequencer to transition 192 + from state 1 to state 3. 193 + 194 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_21_event 195 + Date: November 2014 196 + KernelVersion: 3.19 197 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 198 + Description: (RW) Defines the event that causes the sequencer to transition 199 + from state 2 to state 1. 200 + 201 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_23_event 202 + Date: November 2014 203 + KernelVersion: 3.19 204 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 205 + Description: (RW) Defines the event that causes the sequencer to transition 206 + from state 2 to state 3. 207 + 208 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_31_event 209 + Date: November 2014 210 + KernelVersion: 3.19 211 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 212 + Description: (RW) Defines the event that causes the sequencer to transition 213 + from state 3 to state 1. 214 + 215 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/seq_32_event 216 + Date: November 2014 217 + KernelVersion: 3.19 218 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 219 + Description: (RW) Defines the event that causes the sequencer to transition 220 + from state 3 to state 2. 221 + 222 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/curr_seq_state 223 + Date: November 2014 224 + KernelVersion: 3.19 225 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 226 + Description: (R) Holds the current state of the sequencer. 227 + 228 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/sync_freq 229 + Date: November 2014 230 + KernelVersion: 3.19 231 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 232 + Description: (RW) Holds the trace synchronization frequency value - must be 233 + programmed with the various implementation behavior in mind. 234 + 235 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/timestamp_event 236 + Date: November 2014 237 + KernelVersion: 3.19 238 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 239 + Description: (RW) Defines an event that requests the insertion of a timestamp 240 + into the trace stream. 241 + 242 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/traceid 243 + Date: November 2014 244 + KernelVersion: 3.19 245 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 246 + Description: (RW) Holds the trace ID that will appear in the trace stream 247 + coming from this trace entity. 248 + 249 + What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/trigger_event 250 + Date: November 2014 251 + KernelVersion: 3.19 252 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 253 + Description: (RW) Define the event that controls the trigger.
+12
Documentation/ABI/testing/sysfs-bus-coresight-devices-funnel
··· 1 + What: /sys/bus/coresight/devices/<memory_map>.funnel/funnel_ctrl 2 + Date: November 2014 3 + KernelVersion: 3.19 4 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 5 + Description: (RW) Enables the slave ports and defines the hold time of the 6 + slave ports. 7 + 8 + What: /sys/bus/coresight/devices/<memory_map>.funnel/priority 9 + Date: November 2014 10 + KernelVersion: 3.19 11 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 12 + Description: (RW) Defines input port priority order.
+8
Documentation/ABI/testing/sysfs-bus-coresight-devices-tmc
··· 1 + What: /sys/bus/coresight/devices/<memory_map>.tmc/trigger_cntr 2 + Date: November 2014 3 + KernelVersion: 3.19 4 + Contact: Mathieu Poirier <mathieu.poirier@linaro.org> 5 + Description: (RW) Disables write access to the Trace RAM by stopping the 6 + formatter after a defined number of words have been stored 7 + following the trigger event. Additional interface for this 8 + driver are expected to be added as it matures.
+1
MAINTAINERS
··· 925 925 F: drivers/coresight/* 926 926 F: Documentation/trace/coresight.txt 927 927 F: Documentation/devicetree/bindings/arm/coresight.txt 928 + F: Documentation/ABI/testing/sysfs-bus-coresight-devices-* 928 929 929 930 ARM/CORGI MACHINE SUPPORT 930 931 M: Richard Purdie <rpurdie@rpsys.net>