iotrace: move record definitons to header file
[platform/kernel/u-boot.git] / common / iotrace.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (c) 2014 Google, Inc.
4  */
5
6 #define IOTRACE_IMPL
7
8 #include <common.h>
9 #include <mapmem.h>
10 #include <asm/io.h>
11
12 DECLARE_GLOBAL_DATA_PTR;
13
14 /**
15  * struct iotrace - current trace status and checksum
16  *
17  * @start:      Start address of iotrace buffer
18  * @size:       Size of iotrace buffer in bytes
19  * @offset:     Current write offset into iotrace buffer
20  * @region_start: Address of IO region to trace
21  * @region_size: Size of region to trace. if 0 will trace all address space
22  * @crc32:      Current value of CRC chceksum of trace records
23  * @enabled:    true if enabled, false if disabled
24  */
25 static struct iotrace {
26         ulong start;
27         ulong size;
28         ulong offset;
29         ulong region_start;
30         ulong region_size;
31         u32 crc32;
32         bool enabled;
33 } iotrace;
34
35 static void add_record(int flags, const void *ptr, ulong value)
36 {
37         struct iotrace_record srec, *rec = &srec;
38
39         /*
40          * We don't support iotrace before relocation. Since the trace buffer
41          * is set up by a command, it can't be enabled at present. To change
42          * this we would need to set the iotrace buffer at build-time. See
43          * lib/trace.c for how this might be done if you are interested.
44          */
45         if (!(gd->flags & GD_FLG_RELOC) || !iotrace.enabled)
46                 return;
47
48         if (iotrace.region_size)
49                 if ((ulong)ptr < iotrace.region_start ||
50                     (ulong)ptr > iotrace.region_start + iotrace.region_size)
51                         return;
52
53         /* Store it if there is room */
54         if (iotrace.offset + sizeof(*rec) < iotrace.size) {
55                 rec = (struct iotrace_record *)map_sysmem(
56                                         iotrace.start + iotrace.offset,
57                                         sizeof(value));
58         }
59         rec->timestamp = timer_get_us();
60         rec->flags = flags;
61         rec->addr = map_to_sysmem(ptr);
62         rec->value = value;
63
64         /* Update our checksum */
65         iotrace.crc32 = crc32(iotrace.crc32, (unsigned char *)rec,
66                               sizeof(*rec));
67
68         iotrace.offset += sizeof(struct iotrace_record);
69 }
70
71 u32 iotrace_readl(const void *ptr)
72 {
73         u32 v;
74
75         v = readl(ptr);
76         add_record(IOT_32 | IOT_READ, ptr, v);
77
78         return v;
79 }
80
81 void iotrace_writel(ulong value, const void *ptr)
82 {
83         add_record(IOT_32 | IOT_WRITE, ptr, value);
84         writel(value, ptr);
85 }
86
87 u16 iotrace_readw(const void *ptr)
88 {
89         u32 v;
90
91         v = readw(ptr);
92         add_record(IOT_16 | IOT_READ, ptr, v);
93
94         return v;
95 }
96
97 void iotrace_writew(ulong value, const void *ptr)
98 {
99         add_record(IOT_16 | IOT_WRITE, ptr, value);
100         writew(value, ptr);
101 }
102
103 u8 iotrace_readb(const void *ptr)
104 {
105         u32 v;
106
107         v = readb(ptr);
108         add_record(IOT_8 | IOT_READ, ptr, v);
109
110         return v;
111 }
112
113 void iotrace_writeb(ulong value, const void *ptr)
114 {
115         add_record(IOT_8 | IOT_WRITE, ptr, value);
116         writeb(value, ptr);
117 }
118
119 void iotrace_reset_checksum(void)
120 {
121         iotrace.crc32 = 0;
122 }
123
124 u32 iotrace_get_checksum(void)
125 {
126         return iotrace.crc32;
127 }
128
129 void iotrace_set_region(ulong start, ulong size)
130 {
131         iotrace.region_start = start;
132         iotrace.region_size = size;
133 }
134
135 void iotrace_reset_region(void)
136 {
137         iotrace.region_start = 0;
138         iotrace.region_size = 0;
139 }
140
141 void iotrace_get_region(ulong *start, ulong *size)
142 {
143         *start = iotrace.region_start;
144         *size = iotrace.region_size;
145 }
146
147 void iotrace_set_enabled(int enable)
148 {
149         iotrace.enabled = enable;
150 }
151
152 int iotrace_get_enabled(void)
153 {
154         return iotrace.enabled;
155 }
156
157 void iotrace_set_buffer(ulong start, ulong size)
158 {
159         iotrace.start = start;
160         iotrace.size = size;
161         iotrace.offset = 0;
162         iotrace.crc32 = 0;
163 }
164
165 void iotrace_get_buffer(ulong *start, ulong *size, ulong *offset, ulong *count)
166 {
167         *start = iotrace.start;
168         *size = iotrace.size;
169         *offset = iotrace.offset;
170         *count = iotrace.offset / sizeof(struct iotrace_record);
171 }