blob: 3fa3ba6498e877c9a033cef898a160051fc3643d [file] [log] [blame]
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +02001/*
2 * Remote Processor Framework
3 *
4 * Copyright(c) 2011 Texas Instruments, Inc.
5 * Copyright(c) 2011 Google, Inc.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 * * Neither the name Texas Instruments nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35#ifndef REMOTEPROC_H
36#define REMOTEPROC_H
37
38#include <linux/types.h>
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020039#include <linux/mutex.h>
40#include <linux/virtio.h>
Siddharth Gupta44767702020-07-29 10:40:00 -070041#include <linux/cdev.h>
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020042#include <linux/completion.h>
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010043#include <linux/idr.h>
Dave Gerlachfec47d82015-05-22 15:45:27 -050044#include <linux/of.h>
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020045
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020046/**
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +020047 * struct resource_table - firmware resource table header
48 * @ver: version number
49 * @num: number of resource entries
50 * @reserved: reserved (must be zero)
51 * @offset: array of offsets pointing at the various resource entries
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020052 *
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +020053 * A resource table is essentially a list of system resources required
54 * by the remote processor. It may also include configuration entries.
55 * If needed, the remote processor firmware should contain this table
56 * as a dedicated ".resource_table" ELF section.
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020057 *
58 * Some resources entries are mere announcements, where the host is informed
59 * of specific remoteproc configuration. Other entries require the host to
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +020060 * do something (e.g. allocate a system resource). Sometimes a negotiation
61 * is expected, where the firmware requests a resource, and once allocated,
62 * the host should provide back its details (e.g. address of an allocated
63 * memory region).
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020064 *
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +020065 * The header of the resource table, as expressed by this structure,
66 * contains a version number (should we need to change this format in the
67 * future), the number of available resource entries, and their offsets
68 * in the table.
69 *
70 * Immediately following this header are the resource entries themselves,
71 * each of which begins with a resource entry header (as described below).
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020072 */
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +020073struct resource_table {
74 u32 ver;
75 u32 num;
76 u32 reserved[2];
Gustavo A. R. Silva529798b2020-05-07 14:19:43 -050077 u32 offset[];
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +020078} __packed;
79
80/**
81 * struct fw_rsc_hdr - firmware resource entry header
82 * @type: resource type
83 * @data: resource data
84 *
85 * Every resource entry begins with a 'struct fw_rsc_hdr' header providing
86 * its @type. The content of the entry itself will immediately follow
87 * this header, and it should be parsed according to the resource type.
88 */
89struct fw_rsc_hdr {
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020090 u32 type;
Gustavo A. R. Silva529798b2020-05-07 14:19:43 -050091 u8 data[];
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020092} __packed;
93
94/**
95 * enum fw_resource_type - types of resource entries
96 *
97 * @RSC_CARVEOUT: request for allocation of a physically contiguous
98 * memory region.
99 * @RSC_DEVMEM: request to iommu_map a memory-based peripheral.
100 * @RSC_TRACE: announces the availability of a trace buffer into which
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200101 * the remote processor will be writing logs.
102 * @RSC_VDEV: declare support for a virtio device, and serve as its
103 * virtio header.
Clement Legerb1a17512019-06-17 14:57:30 +0200104 * @RSC_LAST: just keep this one at the end of standard resources
105 * @RSC_VENDOR_START: start of the vendor specific resource types range
106 * @RSC_VENDOR_END: end of the vendor specific resource types range
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200107 *
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200108 * For more details regarding a specific resource type, please see its
109 * dedicated structure below.
Ohad Ben-Cohene12bc142012-01-31 16:07:27 +0200110 *
111 * Please note that these values are used as indices to the rproc_handle_rsc
112 * lookup table, so please keep them sane. Moreover, @RSC_LAST is used to
113 * check the validity of an index before the lookup table is accessed, so
114 * please update it as needed.
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200115 */
116enum fw_resource_type {
Clement Legerb1a17512019-06-17 14:57:30 +0200117 RSC_CARVEOUT = 0,
118 RSC_DEVMEM = 1,
119 RSC_TRACE = 2,
120 RSC_VDEV = 3,
121 RSC_LAST = 4,
122 RSC_VENDOR_START = 128,
123 RSC_VENDOR_END = 512,
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200124};
125
Loic PALLARDYcd583052016-09-06 09:39:42 +0200126#define FW_RSC_ADDR_ANY (-1)
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200127
128/**
129 * struct fw_rsc_carveout - physically contiguous memory request
130 * @da: device address
131 * @pa: physical address
132 * @len: length (in bytes)
133 * @flags: iommu protection flags
134 * @reserved: reserved (must be zero)
135 * @name: human-readable name of the requested memory region
136 *
137 * This resource entry requests the host to allocate a physically contiguous
138 * memory region.
139 *
140 * These request entries should precede other firmware resource entries,
141 * as other entries might request placing other data objects inside
142 * these memory regions (e.g. data/code segments, trace resource entries, ...).
143 *
144 * Allocating memory this way helps utilizing the reserved physical memory
145 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
146 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
147 * pressure is important; it may have a substantial impact on performance.
148 *
149 * If the firmware is compiled with static addresses, then @da should specify
150 * the expected device address of this memory region. If @da is set to
151 * FW_RSC_ADDR_ANY, then the host will dynamically allocate it, and then
152 * overwrite @da with the dynamically allocated address.
153 *
154 * We will always use @da to negotiate the device addresses, even if it
155 * isn't using an iommu. In that case, though, it will obviously contain
156 * physical addresses.
157 *
158 * Some remote processors needs to know the allocated physical address
159 * even if they do use an iommu. This is needed, e.g., if they control
160 * hardware accelerators which access the physical memory directly (this
161 * is the case with OMAP4 for instance). In that case, the host will
162 * overwrite @pa with the dynamically allocated physical address.
163 * Generally we don't want to expose physical addresses if we don't have to
164 * (remote processors are generally _not_ trusted), so we might want to
165 * change this to happen _only_ when explicitly required by the hardware.
166 *
167 * @flags is used to provide IOMMU protection flags, and @name should
168 * (optionally) contain a human readable name of this carveout region
169 * (mainly for debugging purposes).
170 */
171struct fw_rsc_carveout {
172 u32 da;
173 u32 pa;
174 u32 len;
175 u32 flags;
176 u32 reserved;
177 u8 name[32];
178} __packed;
179
180/**
181 * struct fw_rsc_devmem - iommu mapping request
182 * @da: device address
183 * @pa: physical address
184 * @len: length (in bytes)
185 * @flags: iommu protection flags
186 * @reserved: reserved (must be zero)
187 * @name: human-readable name of the requested region to be mapped
188 *
189 * This resource entry requests the host to iommu map a physically contiguous
190 * memory region. This is needed in case the remote processor requires
191 * access to certain memory-based peripherals; _never_ use it to access
192 * regular memory.
193 *
194 * This is obviously only needed if the remote processor is accessing memory
195 * via an iommu.
196 *
197 * @da should specify the required device address, @pa should specify
198 * the physical address we want to map, @len should specify the size of
199 * the mapping and @flags is the IOMMU protection flags. As always, @name may
200 * (optionally) contain a human readable name of this mapping (mainly for
201 * debugging purposes).
202 *
203 * Note: at this point we just "trust" those devmem entries to contain valid
204 * physical addresses, but this isn't safe and will be changed: eventually we
205 * want remoteproc implementations to provide us ranges of physical addresses
206 * the firmware is allowed to request, and not allow firmwares to request
207 * access to physical addresses that are outside those ranges.
208 */
209struct fw_rsc_devmem {
210 u32 da;
211 u32 pa;
212 u32 len;
213 u32 flags;
214 u32 reserved;
215 u8 name[32];
216} __packed;
217
218/**
219 * struct fw_rsc_trace - trace buffer declaration
220 * @da: device address
221 * @len: length (in bytes)
222 * @reserved: reserved (must be zero)
223 * @name: human-readable name of the trace buffer
224 *
225 * This resource entry provides the host information about a trace buffer
226 * into which the remote processor will write log messages.
227 *
228 * @da specifies the device address of the buffer, @len specifies
229 * its size, and @name may contain a human readable name of the trace buffer.
230 *
231 * After booting the remote processor, the trace buffers are exposed to the
232 * user via debugfs entries (called trace0, trace1, etc..).
233 */
234struct fw_rsc_trace {
235 u32 da;
236 u32 len;
237 u32 reserved;
238 u8 name[32];
239} __packed;
240
241/**
242 * struct fw_rsc_vdev_vring - vring descriptor entry
243 * @da: device address
244 * @align: the alignment between the consumer and producer parts of the vring
245 * @num: num of buffers supported by this vring (must be power of two)
246 * @notifyid is a unique rproc-wide notify index for this vring. This notify
247 * index is used when kicking a remote processor, to let it know that this
248 * vring is triggered.
Loic PALLARDY21b66572016-09-06 09:39:43 +0200249 * @pa: physical address
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200250 *
251 * This descriptor is not a resource entry by itself; it is part of the
252 * vdev resource type (see below).
253 *
254 * Note that @da should either contain the device address where
255 * the remote processor is expecting the vring, or indicate that
256 * dynamically allocation of the vring's device address is supported.
257 */
258struct fw_rsc_vdev_vring {
259 u32 da;
260 u32 align;
261 u32 num;
262 u32 notifyid;
Loic PALLARDY21b66572016-09-06 09:39:43 +0200263 u32 pa;
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200264} __packed;
265
266/**
267 * struct fw_rsc_vdev - virtio device header
268 * @id: virtio device id (as in virtio_ids.h)
269 * @notifyid is a unique rproc-wide notify index for this vdev. This notify
270 * index is used when kicking a remote processor, to let it know that the
271 * status/features of this vdev have changes.
272 * @dfeatures specifies the virtio device features supported by the firmware
273 * @gfeatures is a place holder used by the host to write back the
274 * negotiated features that are supported by both sides.
275 * @config_len is the size of the virtio config space of this vdev. The config
276 * space lies in the resource table immediate after this vdev header.
277 * @status is a place holder where the host will indicate its virtio progress.
278 * @num_of_vrings indicates how many vrings are described in this vdev header
279 * @reserved: reserved (must be zero)
280 * @vring is an array of @num_of_vrings entries of 'struct fw_rsc_vdev_vring'.
281 *
282 * This resource is a virtio device header: it provides information about
283 * the vdev, and is then used by the host and its peer remote processors
284 * to negotiate and share certain virtio properties.
285 *
286 * By providing this resource entry, the firmware essentially asks remoteproc
287 * to statically allocate a vdev upon registration of the rproc (dynamic vdev
288 * allocation is not yet supported).
289 *
290 * Note: unlike virtualization systems, the term 'host' here means
291 * the Linux side which is running remoteproc to control the remote
292 * processors. We use the name 'gfeatures' to comply with virtio's terms,
293 * though there isn't really any virtualized guest OS here: it's the host
294 * which is responsible for negotiating the final features.
295 * Yeah, it's a bit confusing.
296 *
297 * Note: immediately following this structure is the virtio config space for
298 * this vdev (which is specific to the vdev; for more info, read the virtio
299 * spec). the size of the config space is specified by @config_len.
300 */
301struct fw_rsc_vdev {
302 u32 id;
303 u32 notifyid;
304 u32 dfeatures;
305 u32 gfeatures;
306 u32 config_len;
307 u8 status;
308 u8 num_of_vrings;
309 u8 reserved[2];
Gustavo A. R. Silva529798b2020-05-07 14:19:43 -0500310 struct fw_rsc_vdev_vring vring[];
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200311} __packed;
312
Loic Pallardyf2e74ab2018-07-27 15:14:38 +0200313struct rproc;
314
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200315/**
316 * struct rproc_mem_entry - memory entry descriptor
317 * @va: virtual address
318 * @dma: dma address
319 * @len: length, in bytes
320 * @da: device address
Loic Pallardyf2e74ab2018-07-27 15:14:38 +0200321 * @release: release associated memory
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200322 * @priv: associated data
Loic Pallardy32652302018-07-27 15:14:39 +0200323 * @name: associated memory region name (optional)
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200324 * @node: list node
Loic Pallardyd7c51702018-07-27 15:14:43 +0200325 * @rsc_offset: offset in resource table
326 * @flags: iommu protection flags
Loic Pallardy1429cca2018-07-27 15:14:44 +0200327 * @of_resm_idx: reserved memory phandle index
Loic Pallardyd7c51702018-07-27 15:14:43 +0200328 * @alloc: specific memory allocator function
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200329 */
330struct rproc_mem_entry {
331 void *va;
332 dma_addr_t dma;
Clement Leger096ee782020-03-02 10:38:56 +0100333 size_t len;
Ohad Ben-Cohenfd2c15e2012-02-01 21:56:16 +0200334 u32 da;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200335 void *priv;
Loic Pallardy32652302018-07-27 15:14:39 +0200336 char name[32];
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200337 struct list_head node;
Loic Pallardyd7c51702018-07-27 15:14:43 +0200338 u32 rsc_offset;
339 u32 flags;
Loic Pallardy1429cca2018-07-27 15:14:44 +0200340 u32 of_resm_idx;
Loic Pallardyd7c51702018-07-27 15:14:43 +0200341 int (*alloc)(struct rproc *rproc, struct rproc_mem_entry *mem);
Loic Pallardyf2e74ab2018-07-27 15:14:38 +0200342 int (*release)(struct rproc *rproc, struct rproc_mem_entry *mem);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200343};
344
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -0800345struct firmware;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200346
347/**
Clement Legerb1a17512019-06-17 14:57:30 +0200348 * enum rsc_handling_status - return status of rproc_ops handle_rsc hook
349 * @RSC_HANDLED: resource was handled
350 * @RSC_IGNORED: resource was ignored
351 */
352enum rsc_handling_status {
353 RSC_HANDLED = 0,
354 RSC_IGNORED = 1,
355};
356
357/**
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200358 * struct rproc_ops - platform-specific device handlers
Loic Pallardy33467ac2020-04-16 19:20:35 -0500359 * @prepare: prepare device for code loading
360 * @unprepare: unprepare device after stop
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200361 * @start: power on the device and boot it
362 * @stop: power off the device
Mathieu Poiriera6a4f282020-07-14 13:50:28 -0600363 * @attach: attach to a device that his already powered up
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200364 * @kick: kick a virtqueue (virtqueue id given as a parameter)
Suman Annaa01f7cd2015-05-22 15:45:28 -0500365 * @da_to_va: optional platform hook to perform address translations
Fabien Dessenneebc40be2018-11-07 11:18:34 +0100366 * @parse_fw: parse firmware to extract information (e.g. resource table)
Clement Legerb1a17512019-06-17 14:57:30 +0200367 * @handle_rsc: optional platform hook to handle vendor resources. Should return
368 * RSC_HANDLED if resource was handled, RSC_IGNORED if not handled and a
369 * negative value on error
370 * @load_rsc_table: load resource table from firmware image
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -0800371 * @find_loaded_rsc_table: find the loaded resouce table
Fabien Dessenneebc40be2018-11-07 11:18:34 +0100372 * @load: load firmware to memory, where the remote processor
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -0800373 * expects to find it
374 * @sanity_check: sanity check the fw image
375 * @get_boot_addr: get boot address to entry point specified in firmware
Bjorn Anderssondc5192c2020-03-23 22:29:02 -0700376 * @panic: optional callback to react to system panic, core will delay
377 * panic at least the returned number of milliseconds
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200378 */
379struct rproc_ops {
Loic Pallardy33467ac2020-04-16 19:20:35 -0500380 int (*prepare)(struct rproc *rproc);
381 int (*unprepare)(struct rproc *rproc);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200382 int (*start)(struct rproc *rproc);
383 int (*stop)(struct rproc *rproc);
Mathieu Poiriera6a4f282020-07-14 13:50:28 -0600384 int (*attach)(struct rproc *rproc);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200385 void (*kick)(struct rproc *rproc, int vqid);
Clement Leger9ce3bf22020-03-02 10:38:55 +0100386 void * (*da_to_va)(struct rproc *rproc, u64 da, size_t len);
Bjorn Anderssonc1d35c12018-01-05 16:04:18 -0800387 int (*parse_fw)(struct rproc *rproc, const struct firmware *fw);
Clement Legerb1a17512019-06-17 14:57:30 +0200388 int (*handle_rsc)(struct rproc *rproc, u32 rsc_type, void *rsc,
389 int offset, int avail);
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -0800390 struct resource_table *(*find_loaded_rsc_table)(
391 struct rproc *rproc, const struct firmware *fw);
392 int (*load)(struct rproc *rproc, const struct firmware *fw);
393 int (*sanity_check)(struct rproc *rproc, const struct firmware *fw);
Clement Legere4ae4b72020-03-02 10:38:57 +0100394 u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
Bjorn Anderssondc5192c2020-03-23 22:29:02 -0700395 unsigned long (*panic)(struct rproc *rproc);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200396};
397
398/**
399 * enum rproc_state - remote processor states
400 * @RPROC_OFFLINE: device is powered off
401 * @RPROC_SUSPENDED: device is suspended; needs to be woken up to receive
402 * a message.
403 * @RPROC_RUNNING: device is up and running
404 * @RPROC_CRASHED: device has crashed; need to start recovery
Sarangdhar Joshi608d7922017-01-23 17:53:18 -0800405 * @RPROC_DELETED: device is deleted
Mathieu Poiriere2e5c552020-07-14 13:50:27 -0600406 * @RPROC_DETACHED: device has been booted by another entity and waiting
407 * for the core to attach to it
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200408 * @RPROC_LAST: just keep this one at the end
409 *
410 * Please note that the values of these states are used as indices
411 * to rproc_state_string, a state-to-name lookup table,
412 * so please keep the two synchronized. @RPROC_LAST is used to check
413 * the validity of an index before the lookup table is accessed, so
414 * please update it as needed too.
415 */
416enum rproc_state {
417 RPROC_OFFLINE = 0,
418 RPROC_SUSPENDED = 1,
419 RPROC_RUNNING = 2,
420 RPROC_CRASHED = 3,
Sarangdhar Joshi608d7922017-01-23 17:53:18 -0800421 RPROC_DELETED = 4,
Mathieu Poiriere2e5c552020-07-14 13:50:27 -0600422 RPROC_DETACHED = 5,
423 RPROC_LAST = 6,
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200424};
425
426/**
Fernando Guzman Lugo8afd5192012-08-30 13:26:12 -0500427 * enum rproc_crash_type - remote processor crash types
428 * @RPROC_MMUFAULT: iommu fault
Bjorn Anderssonb3d39032016-03-28 20:36:59 -0700429 * @RPROC_WATCHDOG: watchdog bite
430 * @RPROC_FATAL_ERROR fatal error
Fernando Guzman Lugo8afd5192012-08-30 13:26:12 -0500431 *
432 * Each element of the enum is used as an array index. So that, the value of
433 * the elements should be always something sane.
434 *
435 * Feel free to add more types when needed.
436 */
437enum rproc_crash_type {
438 RPROC_MMUFAULT,
Bjorn Anderssonb3d39032016-03-28 20:36:59 -0700439 RPROC_WATCHDOG,
440 RPROC_FATAL_ERROR,
Fernando Guzman Lugo8afd5192012-08-30 13:26:12 -0500441};
442
443/**
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700444 * enum rproc_dump_mechanism - Coredump options for core
Rishabh Bhatnagarbf41a092020-10-02 11:09:02 -0700445 * @RPROC_COREDUMP_DISABLED: Don't perform any dump
446 * @RPROC_COREDUMP_ENABLED: Copy dump to separate buffer and carry on with
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700447 recovery
448 * @RPROC_COREDUMP_INLINE: Read segments directly from device memory. Stall
449 recovery until all segments are read
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700450 */
451enum rproc_dump_mechanism {
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700452 RPROC_COREDUMP_DISABLED,
Rishabh Bhatnagarbf41a092020-10-02 11:09:02 -0700453 RPROC_COREDUMP_ENABLED,
454 RPROC_COREDUMP_INLINE,
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700455};
456
457/**
Sarangdhar Joshi2666ca92018-01-05 16:04:17 -0800458 * struct rproc_dump_segment - segment info from ELF header
459 * @node: list node related to the rproc segment list
460 * @da: device address of the segment
461 * @size: size of the segment
Sibi Sankar39521052018-10-17 19:25:23 +0530462 * @priv: private data associated with the dump_segment
463 * @dump: custom dump function to fill device memory segment associated
464 * with coredump
Sarangdhar Joshi2666ca92018-01-05 16:04:17 -0800465 */
466struct rproc_dump_segment {
467 struct list_head node;
468
469 dma_addr_t da;
470 size_t size;
471
Sibi Sankar39521052018-10-17 19:25:23 +0530472 void *priv;
473 void (*dump)(struct rproc *rproc, struct rproc_dump_segment *segment,
Rishabh Bhatnagar76abf9c2020-07-16 15:20:33 -0700474 void *dest, size_t offset, size_t size);
Sarangdhar Joshi2666ca92018-01-05 16:04:17 -0800475 loff_t offset;
476};
477
478/**
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200479 * struct rproc - represents a physical remote processor device
Dave Gerlachfec47d82015-05-22 15:45:27 -0500480 * @node: list node of this rproc object
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200481 * @domain: iommu domain
482 * @name: human readable name of the rproc
483 * @firmware: name of firmware file to be loaded
484 * @priv: private data which belongs to the platform-specific rproc module
485 * @ops: platform-specific start/stop rproc handlers
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300486 * @dev: virtual device for refcounting and common remoteproc behavior
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200487 * @power: refcount of users who need this rproc powered up
488 * @state: state of the device
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700489 * @dump_conf: Currently selected coredump configuration
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200490 * @lock: lock which protects concurrent manipulations of the rproc
491 * @dbg_dir: debugfs directory of this rproc device
492 * @traces: list of trace buffers
493 * @num_traces: number of trace buffers
494 * @carveouts: list of physically contiguous memory allocations
495 * @mappings: list of iommu mappings we initiated, needed on shutdown
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200496 * @bootaddr: address of first instruction to boot rproc with (optional)
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100497 * @rvdevs: list of remote virtio devices
Bjorn Andersson7bdc9652016-10-19 19:40:02 -0700498 * @subdevs: list of subdevices, to following the running state
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100499 * @notifyids: idr for dynamically assigning rproc-wide unique notify ids
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300500 * @index: index of this rproc device
Fernando Guzman Lugo8afd5192012-08-30 13:26:12 -0500501 * @crash_handler: workqueue for handling a crash
502 * @crash_cnt: crash counter
Fernando Guzman Lugo2e37abb2012-09-18 12:26:35 +0300503 * @recovery_disabled: flag that state if recovery was disabled
Sjur Brændeland099a3f32012-09-18 20:32:45 +0200504 * @max_notifyid: largest allocated notify id.
Bjorn Anderssona0c10682016-12-30 03:21:38 -0800505 * @table_ptr: pointer to the resource table in effect
506 * @cached_table: copy of the resource table
Bjorn Anderssona4b24c72018-01-05 15:57:59 -0800507 * @table_sz: size of @cached_table
Suman Anna315491e2015-01-09 15:21:58 -0600508 * @has_iommu: flag to indicate if remote processor is behind an MMU
Suman Anna1bb89892018-09-14 19:37:23 -0500509 * @auto_boot: flag to indicate if remote processor should be auto-started
Mathieu Poirier4a4dca12020-07-14 13:50:35 -0600510 * @autonomous: true if an external entity has booted the remote processor
Sarangdhar Joshi2666ca92018-01-05 16:04:17 -0800511 * @dump_segments: list of segments in the firmware
Loic Pallardyc6aed2382018-07-27 15:14:47 +0200512 * @nb_vdev: number of vdev currently handled by rproc
Siddharth Gupta44767702020-07-29 10:40:00 -0700513 * @char_dev: character device of the rproc
514 * @cdev_put_on_release: flag to indicate if remoteproc should be shutdown on @char_dev release
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200515 */
516struct rproc {
Dave Gerlachfec47d82015-05-22 15:45:27 -0500517 struct list_head node;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200518 struct iommu_domain *domain;
519 const char *name;
Mathieu Poirier1487ded2020-04-20 17:15:58 -0600520 const char *firmware;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200521 void *priv;
Bjorn Anderssonfb98e2b2018-01-05 15:58:00 -0800522 struct rproc_ops *ops;
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300523 struct device dev;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200524 atomic_t power;
525 unsigned int state;
Rishabh Bhatnagarc9731982020-07-16 15:20:34 -0700526 enum rproc_dump_mechanism dump_conf;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200527 struct mutex lock;
528 struct dentry *dbg_dir;
529 struct list_head traces;
530 int num_traces;
531 struct list_head carveouts;
532 struct list_head mappings;
Clement Legere4ae4b72020-03-02 10:38:57 +0100533 u64 bootaddr;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100534 struct list_head rvdevs;
Bjorn Andersson7bdc9652016-10-19 19:40:02 -0700535 struct list_head subdevs;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100536 struct idr notifyids;
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300537 int index;
Fernando Guzman Lugo8afd5192012-08-30 13:26:12 -0500538 struct work_struct crash_handler;
Anna, Sumanf1459282016-08-12 18:42:19 -0500539 unsigned int crash_cnt;
Fernando Guzman Lugo2e37abb2012-09-18 12:26:35 +0300540 bool recovery_disabled;
Sjur Brændeland099a3f32012-09-18 20:32:45 +0200541 int max_notifyid;
Ohad Ben-Cohena2b950a2013-04-07 14:06:07 +0300542 struct resource_table *table_ptr;
Bjorn Anderssona0c10682016-12-30 03:21:38 -0800543 struct resource_table *cached_table;
Bjorn Anderssona4b24c72018-01-05 15:57:59 -0800544 size_t table_sz;
Suman Anna315491e2015-01-09 15:21:58 -0600545 bool has_iommu;
Bjorn Anderssonddf71182016-08-11 14:52:50 -0700546 bool auto_boot;
Mathieu Poirier4a4dca12020-07-14 13:50:35 -0600547 bool autonomous;
Sarangdhar Joshi2666ca92018-01-05 16:04:17 -0800548 struct list_head dump_segments;
Loic Pallardyc6aed2382018-07-27 15:14:47 +0200549 int nb_vdev;
Clement Leger8f403352020-03-02 10:39:02 +0100550 u8 elf_class;
Clement Leger418fd782020-04-10 12:24:32 +0200551 u16 elf_machine;
Siddharth Gupta44767702020-07-29 10:40:00 -0700552 struct cdev cdev;
553 bool cdev_put_on_release;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100554};
555
Bjorn Andersson7bdc9652016-10-19 19:40:02 -0700556/**
557 * struct rproc_subdev - subdevice tied to a remoteproc
558 * @node: list node related to the rproc subdevs list
Bjorn Anderssonc455daa2018-06-26 07:11:59 -0500559 * @prepare: prepare function, called before the rproc is started
Bjorn Andersson618fcff2018-06-26 07:11:55 -0500560 * @start: start function, called after the rproc has been started
561 * @stop: stop function, called before the rproc is stopped; the @crashed
562 * parameter indicates if this originates from a recovery
Bjorn Anderssonc455daa2018-06-26 07:11:59 -0500563 * @unprepare: unprepare function, called after the rproc has been stopped
Bjorn Andersson7bdc9652016-10-19 19:40:02 -0700564 */
565struct rproc_subdev {
566 struct list_head node;
567
Bjorn Anderssonc455daa2018-06-26 07:11:59 -0500568 int (*prepare)(struct rproc_subdev *subdev);
Bjorn Andersson618fcff2018-06-26 07:11:55 -0500569 int (*start)(struct rproc_subdev *subdev);
570 void (*stop)(struct rproc_subdev *subdev, bool crashed);
Bjorn Anderssonc455daa2018-06-26 07:11:59 -0500571 void (*unprepare)(struct rproc_subdev *subdev);
Bjorn Andersson7bdc9652016-10-19 19:40:02 -0700572};
573
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100574/* we currently support only two vrings per rvdev */
Ohad Ben-Cohena2b950a2013-04-07 14:06:07 +0300575
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100576#define RVDEV_NUM_VRINGS 2
577
578/**
579 * struct rproc_vring - remoteproc vring state
580 * @va: virtual address
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100581 * @len: length, in bytes
582 * @da: device address
Ohad Ben-Cohen63140e02012-02-29 14:42:13 +0200583 * @align: vring alignment
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100584 * @notifyid: rproc-specific unique vring index
585 * @rvdev: remote vdev
586 * @vq: the virtqueue of this vring
587 */
588struct rproc_vring {
589 void *va;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100590 int len;
591 u32 da;
Ohad Ben-Cohen63140e02012-02-29 14:42:13 +0200592 u32 align;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100593 int notifyid;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200594 struct rproc_vdev *rvdev;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100595 struct virtqueue *vq;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200596};
597
598/**
599 * struct rproc_vdev - remoteproc state for a supported virtio device
Bjorn Anderssonaab8d802016-10-19 19:40:06 -0700600 * @refcount: reference counter for the vdev and vring allocations
Bjorn Anderssonf5bcb352016-10-19 19:40:09 -0700601 * @subdev: handle for registering the vdev as a rproc subdevice
602 * @id: virtio device id (as in virtio_ids.h)
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100603 * @node: list node
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200604 * @rproc: the rproc handle
605 * @vdev: the virio device
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200606 * @vring: the vrings for this vdev
Ohad Ben-Cohena2b950a2013-04-07 14:06:07 +0300607 * @rsc_offset: offset of the vdev's resource entry
Loic Pallardyc6aed2382018-07-27 15:14:47 +0200608 * @index: vdev position versus other vdev declared in resource table
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200609 */
610struct rproc_vdev {
Bjorn Anderssonaab8d802016-10-19 19:40:06 -0700611 struct kref refcount;
612
Bjorn Anderssonf5bcb352016-10-19 19:40:09 -0700613 struct rproc_subdev subdev;
Loic Pallardy086d0872019-01-10 14:50:49 +0100614 struct device dev;
Bjorn Anderssonf5bcb352016-10-19 19:40:09 -0700615
616 unsigned int id;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100617 struct list_head node;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200618 struct rproc *rproc;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100619 struct rproc_vring vring[RVDEV_NUM_VRINGS];
Ohad Ben-Cohena2b950a2013-04-07 14:06:07 +0300620 u32 rsc_offset;
Loic Pallardyc6aed2382018-07-27 15:14:47 +0200621 u32 index;
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200622};
623
Dave Gerlachfec47d82015-05-22 15:45:27 -0500624struct rproc *rproc_get_by_phandle(phandle phandle);
Bjorn Andersson7c897172017-08-27 22:34:53 -0700625struct rproc *rproc_get_by_child(struct device *dev);
626
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200627struct rproc *rproc_alloc(struct device *dev, const char *name,
Anna, Suman730f84c2016-08-12 18:42:20 -0500628 const struct rproc_ops *ops,
629 const char *firmware, int len);
Ohad Ben-Cohen160e7c82012-07-04 16:25:06 +0300630void rproc_put(struct rproc *rproc);
631int rproc_add(struct rproc *rproc);
632int rproc_del(struct rproc *rproc);
Bjorn Andersson433c0e02016-10-02 17:46:38 -0700633void rproc_free(struct rproc *rproc);
Mathieu Poirierd9473cb2020-07-14 14:04:41 -0600634void rproc_resource_cleanup(struct rproc *rproc);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200635
Paul Cercueil305ac5a2020-04-17 19:00:37 +0200636struct rproc *devm_rproc_alloc(struct device *dev, const char *name,
637 const struct rproc_ops *ops,
638 const char *firmware, int len);
639int devm_rproc_add(struct device *dev, struct rproc *rproc);
640
Loic Pallardy15c0b022018-07-27 15:14:41 +0200641void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem);
642
Loic Pallardy72029c92018-07-27 15:14:40 +0200643struct rproc_mem_entry *
644rproc_mem_entry_init(struct device *dev,
Clement Leger096ee782020-03-02 10:38:56 +0100645 void *va, dma_addr_t dma, size_t len, u32 da,
Loic Pallardyd7c51702018-07-27 15:14:43 +0200646 int (*alloc)(struct rproc *, struct rproc_mem_entry *),
Loic Pallardy72029c92018-07-27 15:14:40 +0200647 int (*release)(struct rproc *, struct rproc_mem_entry *),
648 const char *name, ...);
649
Loic Pallardy1429cca2018-07-27 15:14:44 +0200650struct rproc_mem_entry *
Clement Leger096ee782020-03-02 10:38:56 +0100651rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len,
Loic Pallardy1429cca2018-07-27 15:14:44 +0200652 u32 da, const char *name, ...);
653
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200654int rproc_boot(struct rproc *rproc);
655void rproc_shutdown(struct rproc *rproc);
Fernando Guzman Lugo8afd5192012-08-30 13:26:12 -0500656void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type);
Sarangdhar Joshi2666ca92018-01-05 16:04:17 -0800657int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size);
Sibi Sankarab8f8732018-10-17 19:25:24 +0530658int rproc_coredump_add_custom_segment(struct rproc *rproc,
659 dma_addr_t da, size_t size,
660 void (*dumpfn)(struct rproc *rproc,
661 struct rproc_dump_segment *segment,
Rishabh Bhatnagar76abf9c2020-07-16 15:20:33 -0700662 void *dest, size_t offset,
663 size_t size),
Sibi Sankarab8f8732018-10-17 19:25:24 +0530664 void *priv);
Clement Leger418fd782020-04-10 12:24:32 +0200665int rproc_coredump_set_elf_info(struct rproc *rproc, u8 class, u16 machine);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200666
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100667static inline struct rproc_vdev *vdev_to_rvdev(struct virtio_device *vdev)
668{
Loic Pallardyd4c036f2019-01-21 14:55:15 +0100669 return container_of(vdev->dev.parent, struct rproc_vdev, dev);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100670}
671
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200672static inline struct rproc *vdev_to_rproc(struct virtio_device *vdev)
673{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100674 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200675
676 return rvdev->rproc;
677}
678
Bjorn Andersson49026762018-06-26 07:11:57 -0500679void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev);
Bjorn Andersson7bdc9652016-10-19 19:40:02 -0700680
681void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev);
682
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200683#endif /* REMOTEPROC_H */