1 /* 1 /*
2 * Remote Processor Framework 2 * Remote Processor Framework
3 * 3 *
4 * Copyright(c) 2011 Texas Instruments, Inc. 4 * Copyright(c) 2011 Texas Instruments, Inc.
5 * Copyright(c) 2011 Google, Inc. 5 * Copyright(c) 2011 Google, Inc.
6 * All rights reserved. 6 * All rights reserved.
7 * 7 *
8 * Redistribution and use in source and binary 8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that t 9 * modification, are permitted provided that the following conditions
10 * are met: 10 * are met:
11 * 11 *
12 * * Redistributions of source code must retai 12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the f 13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must repro 14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the f 15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials 16 * the documentation and/or other materials provided with the
17 * distribution. 17 * distribution.
18 * * Neither the name Texas Instruments nor th 18 * * Neither the name Texas Instruments nor the names of its
19 * contributors may be used to endorse or pr 19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior 20 * from this software without specific prior written permission.
21 * 21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTI 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCH 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIR 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGE 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, S 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE PO 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */ 33 */
34 34
35 #ifndef REMOTEPROC_H 35 #ifndef REMOTEPROC_H
36 #define REMOTEPROC_H 36 #define REMOTEPROC_H
37 37
38 #include <linux/types.h> 38 #include <linux/types.h>
39 #include <linux/mutex.h> 39 #include <linux/mutex.h>
40 #include <linux/virtio.h> 40 #include <linux/virtio.h>
41 #include <linux/cdev.h> <<
42 #include <linux/completion.h> 41 #include <linux/completion.h>
43 #include <linux/idr.h> 42 #include <linux/idr.h>
44 #include <linux/of.h> 43 #include <linux/of.h>
45 44
46 /** 45 /**
47 * struct resource_table - firmware resource t 46 * struct resource_table - firmware resource table header
48 * @ver: version number 47 * @ver: version number
49 * @num: number of resource entries 48 * @num: number of resource entries
50 * @reserved: reserved (must be zero) 49 * @reserved: reserved (must be zero)
51 * @offset: array of offsets pointing at the v 50 * @offset: array of offsets pointing at the various resource entries
52 * 51 *
53 * A resource table is essentially a list of s 52 * A resource table is essentially a list of system resources required
54 * by the remote processor. It may also includ 53 * by the remote processor. It may also include configuration entries.
55 * If needed, the remote processor firmware sh 54 * If needed, the remote processor firmware should contain this table
56 * as a dedicated ".resource_table" ELF sectio 55 * as a dedicated ".resource_table" ELF section.
57 * 56 *
58 * Some resources entries are mere announcemen 57 * Some resources entries are mere announcements, where the host is informed
59 * of specific remoteproc configuration. Other 58 * of specific remoteproc configuration. Other entries require the host to
60 * do something (e.g. allocate a system resour 59 * do something (e.g. allocate a system resource). Sometimes a negotiation
61 * is expected, where the firmware requests a 60 * is expected, where the firmware requests a resource, and once allocated,
62 * the host should provide back its details (e 61 * the host should provide back its details (e.g. address of an allocated
63 * memory region). 62 * memory region).
64 * 63 *
65 * The header of the resource table, as expres 64 * The header of the resource table, as expressed by this structure,
66 * contains a version number (should we need t 65 * contains a version number (should we need to change this format in the
67 * future), the number of available resource e 66 * future), the number of available resource entries, and their offsets
68 * in the table. 67 * in the table.
69 * 68 *
70 * Immediately following this header are the r 69 * Immediately following this header are the resource entries themselves,
71 * each of which begins with a resource entry 70 * each of which begins with a resource entry header (as described below).
72 */ 71 */
73 struct resource_table { 72 struct resource_table {
74 u32 ver; 73 u32 ver;
75 u32 num; 74 u32 num;
76 u32 reserved[2]; 75 u32 reserved[2];
77 u32 offset[]; !! 76 u32 offset[0];
78 } __packed; 77 } __packed;
79 78
80 /** 79 /**
81 * struct fw_rsc_hdr - firmware resource entry 80 * struct fw_rsc_hdr - firmware resource entry header
82 * @type: resource type 81 * @type: resource type
83 * @data: resource data 82 * @data: resource data
84 * 83 *
85 * Every resource entry begins with a 'struct 84 * Every resource entry begins with a 'struct fw_rsc_hdr' header providing
86 * its @type. The content of the entry itself 85 * its @type. The content of the entry itself will immediately follow
87 * this header, and it should be parsed accord 86 * this header, and it should be parsed according to the resource type.
88 */ 87 */
89 struct fw_rsc_hdr { 88 struct fw_rsc_hdr {
90 u32 type; 89 u32 type;
91 u8 data[]; !! 90 u8 data[0];
92 } __packed; 91 } __packed;
93 92
94 /** 93 /**
95 * enum fw_resource_type - types of resource e 94 * enum fw_resource_type - types of resource entries
96 * 95 *
97 * @RSC_CARVEOUT: request for allocation of 96 * @RSC_CARVEOUT: request for allocation of a physically contiguous
98 * memory region. 97 * memory region.
99 * @RSC_DEVMEM: request to iommu_map a mem 98 * @RSC_DEVMEM: request to iommu_map a memory-based peripheral.
100 * @RSC_TRACE: announces the availability 99 * @RSC_TRACE: announces the availability of a trace buffer into which
101 * the remote processor will 100 * the remote processor will be writing logs.
102 * @RSC_VDEV: declare support for a virt 101 * @RSC_VDEV: declare support for a virtio device, and serve as its
103 * virtio header. 102 * virtio header.
104 * @RSC_LAST: just keep this one at the !! 103 * @RSC_LAST: just keep this one at the end
105 * @RSC_VENDOR_START: start of the vendor sp <<
106 * @RSC_VENDOR_END: end of the vendor spec <<
107 * 104 *
108 * For more details regarding a specific resou 105 * For more details regarding a specific resource type, please see its
109 * dedicated structure below. 106 * dedicated structure below.
110 * 107 *
111 * Please note that these values are used as i 108 * Please note that these values are used as indices to the rproc_handle_rsc
112 * lookup table, so please keep them sane. Mor 109 * lookup table, so please keep them sane. Moreover, @RSC_LAST is used to
113 * check the validity of an index before the l 110 * check the validity of an index before the lookup table is accessed, so
114 * please update it as needed. 111 * please update it as needed.
115 */ 112 */
116 enum fw_resource_type { 113 enum fw_resource_type {
117 RSC_CARVEOUT = 0, !! 114 RSC_CARVEOUT = 0,
118 RSC_DEVMEM = 1, !! 115 RSC_DEVMEM = 1,
119 RSC_TRACE = 2, !! 116 RSC_TRACE = 2,
120 RSC_VDEV = 3, !! 117 RSC_VDEV = 3,
121 RSC_LAST = 4, !! 118 RSC_LAST = 4,
122 RSC_VENDOR_START = 128, <<
123 RSC_VENDOR_END = 512, <<
124 }; 119 };
125 120
126 #define FW_RSC_ADDR_ANY (-1) 121 #define FW_RSC_ADDR_ANY (-1)
127 122
128 /** 123 /**
129 * struct fw_rsc_carveout - physically contigu 124 * struct fw_rsc_carveout - physically contiguous memory request
130 * @da: device address 125 * @da: device address
131 * @pa: physical address 126 * @pa: physical address
132 * @len: length (in bytes) 127 * @len: length (in bytes)
133 * @flags: iommu protection flags 128 * @flags: iommu protection flags
134 * @reserved: reserved (must be zero) 129 * @reserved: reserved (must be zero)
135 * @name: human-readable name of the requested 130 * @name: human-readable name of the requested memory region
136 * 131 *
137 * This resource entry requests the host to al 132 * This resource entry requests the host to allocate a physically contiguous
138 * memory region. 133 * memory region.
139 * 134 *
140 * These request entries should precede other 135 * These request entries should precede other firmware resource entries,
141 * as other entries might request placing othe 136 * as other entries might request placing other data objects inside
142 * these memory regions (e.g. data/code segmen 137 * these memory regions (e.g. data/code segments, trace resource entries, ...).
143 * 138 *
144 * Allocating memory this way helps utilizing 139 * Allocating memory this way helps utilizing the reserved physical memory
145 * (e.g. CMA) more efficiently, and also minim 140 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
146 * needed to map it (in case @rproc is using a 141 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
147 * pressure is important; it may have a substa 142 * pressure is important; it may have a substantial impact on performance.
148 * 143 *
149 * If the firmware is compiled with static add 144 * If the firmware is compiled with static addresses, then @da should specify
150 * the expected device address of this memory 145 * the expected device address of this memory region. If @da is set to
151 * FW_RSC_ADDR_ANY, then the host will dynamic 146 * FW_RSC_ADDR_ANY, then the host will dynamically allocate it, and then
152 * overwrite @da with the dynamically allocate 147 * overwrite @da with the dynamically allocated address.
153 * 148 *
154 * We will always use @da to negotiate the dev 149 * We will always use @da to negotiate the device addresses, even if it
155 * isn't using an iommu. In that case, though, 150 * isn't using an iommu. In that case, though, it will obviously contain
156 * physical addresses. 151 * physical addresses.
157 * 152 *
158 * Some remote processors needs to know the al 153 * Some remote processors needs to know the allocated physical address
159 * even if they do use an iommu. This is neede 154 * even if they do use an iommu. This is needed, e.g., if they control
160 * hardware accelerators which access the phys 155 * hardware accelerators which access the physical memory directly (this
161 * is the case with OMAP4 for instance). In th 156 * is the case with OMAP4 for instance). In that case, the host will
162 * overwrite @pa with the dynamically allocate 157 * overwrite @pa with the dynamically allocated physical address.
163 * Generally we don't want to expose physical 158 * Generally we don't want to expose physical addresses if we don't have to
164 * (remote processors are generally _not_ trus 159 * (remote processors are generally _not_ trusted), so we might want to
165 * change this to happen _only_ when explicitl 160 * change this to happen _only_ when explicitly required by the hardware.
166 * 161 *
167 * @flags is used to provide IOMMU protection 162 * @flags is used to provide IOMMU protection flags, and @name should
168 * (optionally) contain a human readable name 163 * (optionally) contain a human readable name of this carveout region
169 * (mainly for debugging purposes). 164 * (mainly for debugging purposes).
170 */ 165 */
171 struct fw_rsc_carveout { 166 struct fw_rsc_carveout {
172 u32 da; 167 u32 da;
173 u32 pa; 168 u32 pa;
174 u32 len; 169 u32 len;
175 u32 flags; 170 u32 flags;
176 u32 reserved; 171 u32 reserved;
177 u8 name[32]; 172 u8 name[32];
178 } __packed; 173 } __packed;
179 174
180 /** 175 /**
181 * struct fw_rsc_devmem - iommu mapping reques 176 * struct fw_rsc_devmem - iommu mapping request
182 * @da: device address 177 * @da: device address
183 * @pa: physical address 178 * @pa: physical address
184 * @len: length (in bytes) 179 * @len: length (in bytes)
185 * @flags: iommu protection flags 180 * @flags: iommu protection flags
186 * @reserved: reserved (must be zero) 181 * @reserved: reserved (must be zero)
187 * @name: human-readable name of the requested 182 * @name: human-readable name of the requested region to be mapped
188 * 183 *
189 * This resource entry requests the host to io 184 * This resource entry requests the host to iommu map a physically contiguous
190 * memory region. This is needed in case the r 185 * memory region. This is needed in case the remote processor requires
191 * access to certain memory-based peripherals; 186 * access to certain memory-based peripherals; _never_ use it to access
192 * regular memory. 187 * regular memory.
193 * 188 *
194 * This is obviously only needed if the remote 189 * This is obviously only needed if the remote processor is accessing memory
195 * via an iommu. 190 * via an iommu.
196 * 191 *
197 * @da should specify the required device addr 192 * @da should specify the required device address, @pa should specify
198 * the physical address we want to map, @len s 193 * the physical address we want to map, @len should specify the size of
199 * the mapping and @flags is the IOMMU protect 194 * the mapping and @flags is the IOMMU protection flags. As always, @name may
200 * (optionally) contain a human readable name 195 * (optionally) contain a human readable name of this mapping (mainly for
201 * debugging purposes). 196 * debugging purposes).
202 * 197 *
203 * Note: at this point we just "trust" those d 198 * Note: at this point we just "trust" those devmem entries to contain valid
204 * physical addresses, but this isn't safe and 199 * physical addresses, but this isn't safe and will be changed: eventually we
205 * want remoteproc implementations to provide 200 * want remoteproc implementations to provide us ranges of physical addresses
206 * the firmware is allowed to request, and not 201 * the firmware is allowed to request, and not allow firmwares to request
207 * access to physical addresses that are outsi 202 * access to physical addresses that are outside those ranges.
208 */ 203 */
209 struct fw_rsc_devmem { 204 struct fw_rsc_devmem {
210 u32 da; 205 u32 da;
211 u32 pa; 206 u32 pa;
212 u32 len; 207 u32 len;
213 u32 flags; 208 u32 flags;
214 u32 reserved; 209 u32 reserved;
215 u8 name[32]; 210 u8 name[32];
216 } __packed; 211 } __packed;
217 212
218 /** 213 /**
219 * struct fw_rsc_trace - trace buffer declarat 214 * struct fw_rsc_trace - trace buffer declaration
220 * @da: device address 215 * @da: device address
221 * @len: length (in bytes) 216 * @len: length (in bytes)
222 * @reserved: reserved (must be zero) 217 * @reserved: reserved (must be zero)
223 * @name: human-readable name of the trace buf 218 * @name: human-readable name of the trace buffer
224 * 219 *
225 * This resource entry provides the host infor 220 * This resource entry provides the host information about a trace buffer
226 * into which the remote processor will write 221 * into which the remote processor will write log messages.
227 * 222 *
228 * @da specifies the device address of the buf 223 * @da specifies the device address of the buffer, @len specifies
229 * its size, and @name may contain a human rea 224 * its size, and @name may contain a human readable name of the trace buffer.
230 * 225 *
231 * After booting the remote processor, the tra 226 * After booting the remote processor, the trace buffers are exposed to the
232 * user via debugfs entries (called trace0, tr 227 * user via debugfs entries (called trace0, trace1, etc..).
233 */ 228 */
234 struct fw_rsc_trace { 229 struct fw_rsc_trace {
235 u32 da; 230 u32 da;
236 u32 len; 231 u32 len;
237 u32 reserved; 232 u32 reserved;
238 u8 name[32]; 233 u8 name[32];
239 } __packed; 234 } __packed;
240 235
241 /** 236 /**
242 * struct fw_rsc_vdev_vring - vring descriptor 237 * struct fw_rsc_vdev_vring - vring descriptor entry
243 * @da: device address 238 * @da: device address
244 * @align: the alignment between the consumer 239 * @align: the alignment between the consumer and producer parts of the vring
245 * @num: num of buffers supported by this vrin 240 * @num: num of buffers supported by this vring (must be power of two)
246 * @notifyid: a unique rproc-wide notify index !! 241 * @notifyid is a unique rproc-wide notify index for this vring. This notify
247 * index is used when kicking a remote process 242 * index is used when kicking a remote processor, to let it know that this
248 * vring is triggered. 243 * vring is triggered.
249 * @pa: physical address 244 * @pa: physical address
250 * 245 *
251 * This descriptor is not a resource entry by 246 * This descriptor is not a resource entry by itself; it is part of the
252 * vdev resource type (see below). 247 * vdev resource type (see below).
253 * 248 *
254 * Note that @da should either contain the dev 249 * Note that @da should either contain the device address where
255 * the remote processor is expecting the vring 250 * the remote processor is expecting the vring, or indicate that
256 * dynamically allocation of the vring's devic 251 * dynamically allocation of the vring's device address is supported.
257 */ 252 */
258 struct fw_rsc_vdev_vring { 253 struct fw_rsc_vdev_vring {
259 u32 da; 254 u32 da;
260 u32 align; 255 u32 align;
261 u32 num; 256 u32 num;
262 u32 notifyid; 257 u32 notifyid;
263 u32 pa; 258 u32 pa;
264 } __packed; 259 } __packed;
265 260
266 /** 261 /**
267 * struct fw_rsc_vdev - virtio device header 262 * struct fw_rsc_vdev - virtio device header
268 * @id: virtio device id (as in virtio_ids.h) 263 * @id: virtio device id (as in virtio_ids.h)
269 * @notifyid: a unique rproc-wide notify index !! 264 * @notifyid is a unique rproc-wide notify index for this vdev. This notify
270 * index is used when kicking a remote process 265 * index is used when kicking a remote processor, to let it know that the
271 * status/features of this vdev have changes. 266 * status/features of this vdev have changes.
272 * @dfeatures: specifies the virtio device fea !! 267 * @dfeatures specifies the virtio device features supported by the firmware
273 * @gfeatures: a place holder used by the host !! 268 * @gfeatures is a place holder used by the host to write back the
274 * negotiated features that are supported by b 269 * negotiated features that are supported by both sides.
275 * @config_len: the size of the virtio config !! 270 * @config_len is the size of the virtio config space of this vdev. The config
276 * space lies in the resource table immediate 271 * space lies in the resource table immediate after this vdev header.
277 * @status: a place holder where the host will !! 272 * @status is a place holder where the host will indicate its virtio progress.
278 * @num_of_vrings: indicates how many vrings a !! 273 * @num_of_vrings indicates how many vrings are described in this vdev header
279 * @reserved: reserved (must be zero) 274 * @reserved: reserved (must be zero)
280 * @vring: an array of @num_of_vrings entries !! 275 * @vring is an array of @num_of_vrings entries of 'struct fw_rsc_vdev_vring'.
281 * 276 *
282 * This resource is a virtio device header: it 277 * This resource is a virtio device header: it provides information about
283 * the vdev, and is then used by the host and 278 * the vdev, and is then used by the host and its peer remote processors
284 * to negotiate and share certain virtio prope 279 * to negotiate and share certain virtio properties.
285 * 280 *
286 * By providing this resource entry, the firmw 281 * By providing this resource entry, the firmware essentially asks remoteproc
287 * to statically allocate a vdev upon registra 282 * to statically allocate a vdev upon registration of the rproc (dynamic vdev
288 * allocation is not yet supported). 283 * allocation is not yet supported).
289 * 284 *
290 * Note: !! 285 * Note: unlike virtualization systems, the term 'host' here means
291 * 1. unlike virtualization systems, the term !! 286 * the Linux side which is running remoteproc to control the remote
292 * the Linux side which is running remotepr !! 287 * processors. We use the name 'gfeatures' to comply with virtio's terms,
293 * processors. We use the name 'gfeatures' !! 288 * though there isn't really any virtualized guest OS here: it's the host
294 * though there isn't really any virtualize !! 289 * which is responsible for negotiating the final features.
295 * which is responsible for negotiating the !! 290 * Yeah, it's a bit confusing.
296 * Yeah, it's a bit confusing. !! 291 *
297 * !! 292 * Note: immediately following this structure is the virtio config space for
298 * 2. immediately following this structure is !! 293 * this vdev (which is specific to the vdev; for more info, read the virtio
299 * this vdev (which is specific to the vdev !! 294 * spec). the size of the config space is specified by @config_len.
300 * spec). The size of the config space is s <<
301 */ 295 */
302 struct fw_rsc_vdev { 296 struct fw_rsc_vdev {
303 u32 id; 297 u32 id;
304 u32 notifyid; 298 u32 notifyid;
305 u32 dfeatures; 299 u32 dfeatures;
306 u32 gfeatures; 300 u32 gfeatures;
307 u32 config_len; 301 u32 config_len;
308 u8 status; 302 u8 status;
309 u8 num_of_vrings; 303 u8 num_of_vrings;
310 u8 reserved[2]; 304 u8 reserved[2];
311 struct fw_rsc_vdev_vring vring[]; !! 305 struct fw_rsc_vdev_vring vring[0];
312 } __packed; 306 } __packed;
313 307
314 struct rproc; <<
315 <<
316 /** 308 /**
317 * struct rproc_mem_entry - memory entry descr 309 * struct rproc_mem_entry - memory entry descriptor
318 * @va: virtual address 310 * @va: virtual address
319 * @is_iomem: io memory <<
320 * @dma: dma address 311 * @dma: dma address
321 * @len: length, in bytes 312 * @len: length, in bytes
322 * @da: device address 313 * @da: device address
323 * @release: release associated memory <<
324 * @priv: associated data 314 * @priv: associated data
325 * @name: associated memory region name (optio <<
326 * @node: list node 315 * @node: list node
327 * @rsc_offset: offset in resource table <<
328 * @flags: iommu protection flags <<
329 * @of_resm_idx: reserved memory phandle index <<
330 * @alloc: specific memory allocator function <<
331 */ 316 */
332 struct rproc_mem_entry { 317 struct rproc_mem_entry {
333 void *va; 318 void *va;
334 bool is_iomem; <<
335 dma_addr_t dma; 319 dma_addr_t dma;
336 size_t len; !! 320 int len;
337 u32 da; 321 u32 da;
338 void *priv; 322 void *priv;
339 char name[32]; <<
340 struct list_head node; 323 struct list_head node;
341 u32 rsc_offset; <<
342 u32 flags; <<
343 u32 of_resm_idx; <<
344 int (*alloc)(struct rproc *rproc, stru <<
345 int (*release)(struct rproc *rproc, st <<
346 }; 324 };
347 325
>> 326 struct rproc;
348 struct firmware; 327 struct firmware;
349 328
350 /** 329 /**
351 * enum rsc_handling_status - return status of <<
352 * @RSC_HANDLED: resource was handled <<
353 * @RSC_IGNORED: resource was ignored <<
354 */ <<
355 enum rsc_handling_status { <<
356 RSC_HANDLED = 0, <<
357 RSC_IGNORED = 1, <<
358 }; <<
359 <<
360 /** <<
361 * struct rproc_ops - platform-specific device 330 * struct rproc_ops - platform-specific device handlers
362 * @prepare: prepare device for code loadin <<
363 * @unprepare: unprepare device after stop <<
364 * @start: power on the device and boot i 331 * @start: power on the device and boot it
365 * @stop: power off the device 332 * @stop: power off the device
366 * @attach: attach to a device that his al <<
367 * @detach: detach from a device, leaving <<
368 * @kick: kick a virtqueue (virtqueue id 333 * @kick: kick a virtqueue (virtqueue id given as a parameter)
369 * @da_to_va: optional platform hook to perf 334 * @da_to_va: optional platform hook to perform address translations
370 * @parse_fw: parse firmware to extract info !! 335 * @load_rsc_table: load resource table from firmware image
371 * @handle_rsc: optional platform hook to hand !! 336 * @find_loaded_rsc_table: find the loaded resouce table
372 * RSC_HANDLED if resource was ha !! 337 * @load: load firmeware to memory, where the remote processor
373 * and a negative value on error <<
374 * @find_loaded_rsc_table: find the loaded res <<
375 * @get_loaded_rsc_table: get resource table i <<
376 * by external entity <<
377 * @load: load firmware to memor <<
378 * expects to find it 338 * expects to find it
379 * @sanity_check: sanity check the fw im 339 * @sanity_check: sanity check the fw image
380 * @get_boot_addr: get boot address to en 340 * @get_boot_addr: get boot address to entry point specified in firmware
381 * @panic: optional callback to react to <<
382 * panic at least the returned nu <<
383 * @coredump: collect firmware dump after <<
384 */ 341 */
385 struct rproc_ops { 342 struct rproc_ops {
386 int (*prepare)(struct rproc *rproc); <<
387 int (*unprepare)(struct rproc *rproc); <<
388 int (*start)(struct rproc *rproc); 343 int (*start)(struct rproc *rproc);
389 int (*stop)(struct rproc *rproc); 344 int (*stop)(struct rproc *rproc);
390 int (*attach)(struct rproc *rproc); <<
391 int (*detach)(struct rproc *rproc); <<
392 void (*kick)(struct rproc *rproc, int 345 void (*kick)(struct rproc *rproc, int vqid);
393 void * (*da_to_va)(struct rproc *rproc !! 346 void * (*da_to_va)(struct rproc *rproc, u64 da, int len);
394 int (*parse_fw)(struct rproc *rproc, c 347 int (*parse_fw)(struct rproc *rproc, const struct firmware *fw);
395 int (*handle_rsc)(struct rproc *rproc, <<
396 int offset, int avai <<
397 struct resource_table *(*find_loaded_r 348 struct resource_table *(*find_loaded_rsc_table)(
398 struct rproc * 349 struct rproc *rproc, const struct firmware *fw);
399 struct resource_table *(*get_loaded_rs <<
400 struct rproc * <<
401 int (*load)(struct rproc *rproc, const 350 int (*load)(struct rproc *rproc, const struct firmware *fw);
402 int (*sanity_check)(struct rproc *rpro 351 int (*sanity_check)(struct rproc *rproc, const struct firmware *fw);
403 u64 (*get_boot_addr)(struct rproc *rpr !! 352 u32 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
404 unsigned long (*panic)(struct rproc *r <<
405 void (*coredump)(struct rproc *rproc); <<
406 }; 353 };
407 354
408 /** 355 /**
409 * enum rproc_state - remote processor states 356 * enum rproc_state - remote processor states
410 * @RPROC_OFFLINE: device is powered off 357 * @RPROC_OFFLINE: device is powered off
411 * @RPROC_SUSPENDED: device is suspended; n 358 * @RPROC_SUSPENDED: device is suspended; needs to be woken up to receive
412 * a message. 359 * a message.
413 * @RPROC_RUNNING: device is up and runni 360 * @RPROC_RUNNING: device is up and running
414 * @RPROC_CRASHED: device has crashed; ne 361 * @RPROC_CRASHED: device has crashed; need to start recovery
415 * @RPROC_DELETED: device is deleted 362 * @RPROC_DELETED: device is deleted
416 * @RPROC_ATTACHED: device has been booted <<
417 * has attached to it <<
418 * @RPROC_DETACHED: device has been booted <<
419 * for the core to attach <<
420 * @RPROC_LAST: just keep this one at 363 * @RPROC_LAST: just keep this one at the end
421 * 364 *
422 * Please note that the values of these states 365 * Please note that the values of these states are used as indices
423 * to rproc_state_string, a state-to-name look 366 * to rproc_state_string, a state-to-name lookup table,
424 * so please keep the two synchronized. @RPROC 367 * so please keep the two synchronized. @RPROC_LAST is used to check
425 * the validity of an index before the lookup 368 * the validity of an index before the lookup table is accessed, so
426 * please update it as needed too. 369 * please update it as needed too.
427 */ 370 */
428 enum rproc_state { 371 enum rproc_state {
429 RPROC_OFFLINE = 0, 372 RPROC_OFFLINE = 0,
430 RPROC_SUSPENDED = 1, 373 RPROC_SUSPENDED = 1,
431 RPROC_RUNNING = 2, 374 RPROC_RUNNING = 2,
432 RPROC_CRASHED = 3, 375 RPROC_CRASHED = 3,
433 RPROC_DELETED = 4, 376 RPROC_DELETED = 4,
434 RPROC_ATTACHED = 5, !! 377 RPROC_LAST = 5,
435 RPROC_DETACHED = 6, <<
436 RPROC_LAST = 7, <<
437 }; 378 };
438 379
439 /** 380 /**
440 * enum rproc_crash_type - remote processor cr 381 * enum rproc_crash_type - remote processor crash types
441 * @RPROC_MMUFAULT: iommu fault 382 * @RPROC_MMUFAULT: iommu fault
442 * @RPROC_WATCHDOG: watchdog bite 383 * @RPROC_WATCHDOG: watchdog bite
443 * @RPROC_FATAL_ERROR: fatal error !! 384 * @RPROC_FATAL_ERROR fatal error
444 * 385 *
445 * Each element of the enum is used as an arra 386 * Each element of the enum is used as an array index. So that, the value of
446 * the elements should be always something san 387 * the elements should be always something sane.
447 * 388 *
448 * Feel free to add more types when needed. 389 * Feel free to add more types when needed.
449 */ 390 */
450 enum rproc_crash_type { 391 enum rproc_crash_type {
451 RPROC_MMUFAULT, 392 RPROC_MMUFAULT,
452 RPROC_WATCHDOG, 393 RPROC_WATCHDOG,
453 RPROC_FATAL_ERROR, 394 RPROC_FATAL_ERROR,
454 }; 395 };
455 396
456 /** 397 /**
457 * enum rproc_dump_mechanism - Coredump option <<
458 * @RPROC_COREDUMP_DISABLED: Don't perform <<
459 * @RPROC_COREDUMP_ENABLED: Copy dump to s <<
460 * recovery <<
461 * @RPROC_COREDUMP_INLINE: Read segments <<
462 * recovery until <<
463 */ <<
464 enum rproc_dump_mechanism { <<
465 RPROC_COREDUMP_DISABLED, <<
466 RPROC_COREDUMP_ENABLED, <<
467 RPROC_COREDUMP_INLINE, <<
468 }; <<
469 <<
470 /** <<
471 * struct rproc_dump_segment - segment info fr 398 * struct rproc_dump_segment - segment info from ELF header
472 * @node: list node related to the rproc 399 * @node: list node related to the rproc segment list
473 * @da: device address of the segment 400 * @da: device address of the segment
474 * @size: size of the segment 401 * @size: size of the segment
475 * @priv: private data associated with t <<
476 * @dump: custom dump function to fill d <<
477 * with coredump <<
478 * @offset: offset of the segment <<
479 */ 402 */
480 struct rproc_dump_segment { 403 struct rproc_dump_segment {
481 struct list_head node; 404 struct list_head node;
482 405
483 dma_addr_t da; 406 dma_addr_t da;
484 size_t size; 407 size_t size;
485 408
486 void *priv; <<
487 void (*dump)(struct rproc *rproc, stru <<
488 void *dest, size_t offset <<
489 loff_t offset; 409 loff_t offset;
490 }; 410 };
491 411
492 /** 412 /**
493 * enum rproc_features - features supported <<
494 * <<
495 * @RPROC_FEAT_ATTACH_ON_RECOVERY: The remote <<
496 * from Linux <<
497 * loading. Li <<
498 * recovery. <<
499 */ <<
500 <<
501 enum rproc_features { <<
502 RPROC_FEAT_ATTACH_ON_RECOVERY, <<
503 RPROC_MAX_FEATURES, <<
504 }; <<
505 <<
506 /** <<
507 * struct rproc - represents a physical remote 413 * struct rproc - represents a physical remote processor device
508 * @node: list node of this rproc object 414 * @node: list node of this rproc object
509 * @domain: iommu domain 415 * @domain: iommu domain
510 * @name: human readable name of the rproc 416 * @name: human readable name of the rproc
511 * @firmware: name of firmware file to be load 417 * @firmware: name of firmware file to be loaded
512 * @priv: private data which belongs to the pl 418 * @priv: private data which belongs to the platform-specific rproc module
513 * @ops: platform-specific start/stop rproc ha 419 * @ops: platform-specific start/stop rproc handlers
514 * @dev: virtual device for refcounting and co 420 * @dev: virtual device for refcounting and common remoteproc behavior
515 * @power: refcount of users who need this rpr 421 * @power: refcount of users who need this rproc powered up
516 * @state: state of the device 422 * @state: state of the device
517 * @dump_conf: Currently selected coredump con <<
518 * @lock: lock which protects concurrent manip 423 * @lock: lock which protects concurrent manipulations of the rproc
519 * @dbg_dir: debugfs directory of this rproc d 424 * @dbg_dir: debugfs directory of this rproc device
520 * @traces: list of trace buffers 425 * @traces: list of trace buffers
521 * @num_traces: number of trace buffers 426 * @num_traces: number of trace buffers
522 * @carveouts: list of physically contiguous m 427 * @carveouts: list of physically contiguous memory allocations
523 * @mappings: list of iommu mappings we initia 428 * @mappings: list of iommu mappings we initiated, needed on shutdown
524 * @bootaddr: address of first instruction to 429 * @bootaddr: address of first instruction to boot rproc with (optional)
525 * @rvdevs: list of remote virtio devices 430 * @rvdevs: list of remote virtio devices
526 * @subdevs: list of subdevices, to following 431 * @subdevs: list of subdevices, to following the running state
527 * @notifyids: idr for dynamically assigning r 432 * @notifyids: idr for dynamically assigning rproc-wide unique notify ids
528 * @index: index of this rproc device 433 * @index: index of this rproc device
529 * @crash_handler: workqueue for handling a cr 434 * @crash_handler: workqueue for handling a crash
530 * @crash_cnt: crash counter 435 * @crash_cnt: crash counter
531 * @recovery_disabled: flag that state if reco 436 * @recovery_disabled: flag that state if recovery was disabled
532 * @max_notifyid: largest allocated notify id. 437 * @max_notifyid: largest allocated notify id.
533 * @table_ptr: pointer to the resource table i 438 * @table_ptr: pointer to the resource table in effect
534 * @clean_table: copy of the resource table wi <<
535 * when a remote processor is at <<
536 * @cached_table: copy of the resource table 439 * @cached_table: copy of the resource table
537 * @table_sz: size of @cached_table 440 * @table_sz: size of @cached_table
538 * @has_iommu: flag to indicate if remote proc 441 * @has_iommu: flag to indicate if remote processor is behind an MMU
539 * @auto_boot: flag to indicate if remote proc <<
540 * @sysfs_read_only: flag to make remoteproc s <<
541 * @dump_segments: list of segments in the fir 442 * @dump_segments: list of segments in the firmware
542 * @nb_vdev: number of vdev currently handled <<
543 * @elf_class: firmware ELF class <<
544 * @elf_machine: firmware ELF machine <<
545 * @cdev: character device of the rproc <<
546 * @cdev_put_on_release: flag to indicate if r <<
547 * @features: indicate remoteproc features <<
548 */ 443 */
549 struct rproc { 444 struct rproc {
550 struct list_head node; 445 struct list_head node;
551 struct iommu_domain *domain; 446 struct iommu_domain *domain;
552 const char *name; 447 const char *name;
553 const char *firmware; !! 448 char *firmware;
554 void *priv; 449 void *priv;
555 struct rproc_ops *ops; 450 struct rproc_ops *ops;
556 struct device dev; 451 struct device dev;
557 atomic_t power; 452 atomic_t power;
558 unsigned int state; 453 unsigned int state;
559 enum rproc_dump_mechanism dump_conf; <<
560 struct mutex lock; 454 struct mutex lock;
561 struct dentry *dbg_dir; 455 struct dentry *dbg_dir;
562 struct list_head traces; 456 struct list_head traces;
563 int num_traces; 457 int num_traces;
564 struct list_head carveouts; 458 struct list_head carveouts;
565 struct list_head mappings; 459 struct list_head mappings;
566 u64 bootaddr; !! 460 u32 bootaddr;
567 struct list_head rvdevs; 461 struct list_head rvdevs;
568 struct list_head subdevs; 462 struct list_head subdevs;
569 struct idr notifyids; 463 struct idr notifyids;
570 int index; 464 int index;
571 struct work_struct crash_handler; 465 struct work_struct crash_handler;
572 unsigned int crash_cnt; 466 unsigned int crash_cnt;
573 bool recovery_disabled; 467 bool recovery_disabled;
574 int max_notifyid; 468 int max_notifyid;
575 struct resource_table *table_ptr; 469 struct resource_table *table_ptr;
576 struct resource_table *clean_table; <<
577 struct resource_table *cached_table; 470 struct resource_table *cached_table;
578 size_t table_sz; 471 size_t table_sz;
579 bool has_iommu; 472 bool has_iommu;
580 bool auto_boot; 473 bool auto_boot;
581 bool sysfs_read_only; <<
582 struct list_head dump_segments; 474 struct list_head dump_segments;
583 int nb_vdev; <<
584 u8 elf_class; <<
585 u16 elf_machine; <<
586 struct cdev cdev; <<
587 bool cdev_put_on_release; <<
588 DECLARE_BITMAP(features, RPROC_MAX_FEA <<
589 }; 475 };
590 476
591 /** 477 /**
592 * struct rproc_subdev - subdevice tied to a r 478 * struct rproc_subdev - subdevice tied to a remoteproc
593 * @node: list node related to the rproc subde 479 * @node: list node related to the rproc subdevs list
594 * @prepare: prepare function, called before t !! 480 * @probe: probe function, called as the rproc is started
595 * @start: start function, called after the rp !! 481 * @remove: remove function, called as the rproc is being stopped, the @crashed
596 * @stop: stop function, called before the rpr !! 482 * parameter indicates if this originates from the a recovery
597 * parameter indicates if this origin <<
598 * @unprepare: unprepare function, called afte <<
599 */ 483 */
600 struct rproc_subdev { 484 struct rproc_subdev {
601 struct list_head node; 485 struct list_head node;
602 486
603 int (*prepare)(struct rproc_subdev *su !! 487 int (*probe)(struct rproc_subdev *subdev);
604 int (*start)(struct rproc_subdev *subd !! 488 void (*remove)(struct rproc_subdev *subdev, bool crashed);
605 void (*stop)(struct rproc_subdev *subd <<
606 void (*unprepare)(struct rproc_subdev <<
607 }; 489 };
608 490
609 /* we currently support only two vrings per rv 491 /* we currently support only two vrings per rvdev */
610 492
611 #define RVDEV_NUM_VRINGS 2 493 #define RVDEV_NUM_VRINGS 2
612 494
613 /** 495 /**
614 * struct rproc_vring - remoteproc vring state 496 * struct rproc_vring - remoteproc vring state
615 * @va: virtual address 497 * @va: virtual address
616 * @num: vring size !! 498 * @dma: dma address
>> 499 * @len: length, in bytes
617 * @da: device address 500 * @da: device address
618 * @align: vring alignment 501 * @align: vring alignment
619 * @notifyid: rproc-specific unique vring inde 502 * @notifyid: rproc-specific unique vring index
620 * @rvdev: remote vdev 503 * @rvdev: remote vdev
621 * @vq: the virtqueue of this vring 504 * @vq: the virtqueue of this vring
622 */ 505 */
623 struct rproc_vring { 506 struct rproc_vring {
624 void *va; 507 void *va;
625 int num; !! 508 dma_addr_t dma;
>> 509 int len;
626 u32 da; 510 u32 da;
627 u32 align; 511 u32 align;
628 int notifyid; 512 int notifyid;
629 struct rproc_vdev *rvdev; 513 struct rproc_vdev *rvdev;
630 struct virtqueue *vq; 514 struct virtqueue *vq;
631 }; 515 };
632 516
633 /** 517 /**
634 * struct rproc_vdev - remoteproc state for a 518 * struct rproc_vdev - remoteproc state for a supported virtio device
>> 519 * @refcount: reference counter for the vdev and vring allocations
635 * @subdev: handle for registering the vdev as 520 * @subdev: handle for registering the vdev as a rproc subdevice
636 * @pdev: remoteproc virtio platform device <<
637 * @id: virtio device id (as in virtio_ids.h) 521 * @id: virtio device id (as in virtio_ids.h)
638 * @node: list node 522 * @node: list node
639 * @rproc: the rproc handle 523 * @rproc: the rproc handle
>> 524 * @vdev: the virio device
640 * @vring: the vrings for this vdev 525 * @vring: the vrings for this vdev
641 * @rsc_offset: offset of the vdev's resource 526 * @rsc_offset: offset of the vdev's resource entry
642 * @index: vdev position versus other vdev dec <<
643 */ 527 */
644 struct rproc_vdev { 528 struct rproc_vdev {
>> 529 struct kref refcount;
645 530
646 struct rproc_subdev subdev; 531 struct rproc_subdev subdev;
647 struct platform_device *pdev; <<
648 532
649 unsigned int id; 533 unsigned int id;
650 struct list_head node; 534 struct list_head node;
651 struct rproc *rproc; 535 struct rproc *rproc;
>> 536 struct virtio_device vdev;
652 struct rproc_vring vring[RVDEV_NUM_VRI 537 struct rproc_vring vring[RVDEV_NUM_VRINGS];
653 u32 rsc_offset; 538 u32 rsc_offset;
654 u32 index; <<
655 }; 539 };
656 540
657 struct rproc *rproc_get_by_phandle(phandle pha 541 struct rproc *rproc_get_by_phandle(phandle phandle);
658 struct rproc *rproc_get_by_child(struct device 542 struct rproc *rproc_get_by_child(struct device *dev);
659 543
660 struct rproc *rproc_alloc(struct device *dev, 544 struct rproc *rproc_alloc(struct device *dev, const char *name,
661 const struct rproc_o 545 const struct rproc_ops *ops,
662 const char *firmware 546 const char *firmware, int len);
663 void rproc_put(struct rproc *rproc); 547 void rproc_put(struct rproc *rproc);
664 int rproc_add(struct rproc *rproc); 548 int rproc_add(struct rproc *rproc);
665 int rproc_del(struct rproc *rproc); 549 int rproc_del(struct rproc *rproc);
666 void rproc_free(struct rproc *rproc); 550 void rproc_free(struct rproc *rproc);
667 void rproc_resource_cleanup(struct rproc *rpro <<
668 <<
669 struct rproc *devm_rproc_alloc(struct device * <<
670 const struct rp <<
671 const char *fir <<
672 int devm_rproc_add(struct device *dev, struct <<
673 <<
674 void rproc_add_carveout(struct rproc *rproc, s <<
675 <<
676 struct rproc_mem_entry * <<
677 rproc_mem_entry_init(struct device *dev, <<
678 void *va, dma_addr_t dma, <<
679 int (*alloc)(struct rproc <<
680 int (*release)(struct rpr <<
681 const char *name, ...); <<
682 <<
683 struct rproc_mem_entry * <<
684 rproc_of_resm_mem_entry_init(struct device *de <<
685 u32 da, const cha <<
686 551
687 int rproc_boot(struct rproc *rproc); 552 int rproc_boot(struct rproc *rproc);
688 int rproc_shutdown(struct rproc *rproc); !! 553 void rproc_shutdown(struct rproc *rproc);
689 int rproc_detach(struct rproc *rproc); <<
690 int rproc_set_firmware(struct rproc *rproc, co <<
691 void rproc_report_crash(struct rproc *rproc, e 554 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type);
692 void *rproc_da_to_va(struct rproc *rproc, u64 <<
693 <<
694 /* from remoteproc_coredump.c */ <<
695 void rproc_coredump_cleanup(struct rproc *rpro <<
696 void rproc_coredump(struct rproc *rproc); <<
697 void rproc_coredump_using_sections(struct rpro <<
698 int rproc_coredump_add_segment(struct rproc *r 555 int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size);
699 int rproc_coredump_add_custom_segment(struct r <<
700 dma_addr <<
701 void (*d <<
702 <<
703 <<
704 <<
705 void *pr <<
706 int rproc_coredump_set_elf_info(struct rproc * <<
707 556
708 void rproc_add_subdev(struct rproc *rproc, str !! 557 static inline struct rproc_vdev *vdev_to_rvdev(struct virtio_device *vdev)
>> 558 {
>> 559 return container_of(vdev, struct rproc_vdev, vdev);
>> 560 }
>> 561
>> 562 static inline struct rproc *vdev_to_rproc(struct virtio_device *vdev)
>> 563 {
>> 564 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
>> 565
>> 566 return rvdev->rproc;
>> 567 }
>> 568
>> 569 void rproc_add_subdev(struct rproc *rproc,
>> 570 struct rproc_subdev *subdev,
>> 571 int (*probe)(struct rproc_subdev *subdev),
>> 572 void (*remove)(struct rproc_subdev *subdev, bool crashed));
709 573
710 void rproc_remove_subdev(struct rproc *rproc, 574 void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev);
711 575
712 #endif /* REMOTEPROC_H */ 576 #endif /* REMOTEPROC_H */
713 577
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.