Linux Audio

Check our new training course

Buildroot integration, development and maintenance

Need a Buildroot system for your embedded project?
Loading...
Note: File does not exist in v3.1.
  1/*
  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>
 39#include <linux/mutex.h>
 40#include <linux/virtio.h>
 41#include <linux/cdev.h>
 42#include <linux/completion.h>
 43#include <linux/idr.h>
 44#include <linux/of.h>
 45
 46/**
 47 * 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
 52 *
 53 * 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.
 57 *
 58 * Some resources entries are mere announcements, where the host is informed
 59 * of specific remoteproc configuration. Other entries require the host to
 60 * 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).
 64 *
 65 * 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).
 72 */
 73struct resource_table {
 74	u32 ver;
 75	u32 num;
 76	u32 reserved[2];
 77	u32 offset[];
 78} __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 {
 90	u32 type;
 91	u8 data[];
 92} __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
101 *		    the remote processor will be writing logs.
102 * @RSC_VDEV:       declare support for a virtio device, and serve as its
103 *		    virtio header.
104 * @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
107 *
108 * For more details regarding a specific resource type, please see its
109 * dedicated structure below.
110 *
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.
115 */
116enum fw_resource_type {
117	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,
124};
125
126#define FW_RSC_ADDR_ANY (-1)
127
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.
249 * @pa: physical address
250 *
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;
263	u32 pa;
264} __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];
310	struct fw_rsc_vdev_vring vring[];
311} __packed;
312
313struct rproc;
314
315/**
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
321 * @release: release associated memory
322 * @priv: associated data
323 * @name: associated memory region name (optional)
324 * @node: list node
325 * @rsc_offset: offset in resource table
326 * @flags: iommu protection flags
327 * @of_resm_idx: reserved memory phandle index
328 * @alloc: specific memory allocator function
329 */
330struct rproc_mem_entry {
331	void *va;
332	dma_addr_t dma;
333	size_t len;
334	u32 da;
335	void *priv;
336	char name[32];
337	struct list_head node;
338	u32 rsc_offset;
339	u32 flags;
340	u32 of_resm_idx;
341	int (*alloc)(struct rproc *rproc, struct rproc_mem_entry *mem);
342	int (*release)(struct rproc *rproc, struct rproc_mem_entry *mem);
343};
344
345struct firmware;
346
347/**
348 * 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/**
358 * struct rproc_ops - platform-specific device handlers
359 * @prepare:	prepare device for code loading
360 * @unprepare:	unprepare device after stop
361 * @start:	power on the device and boot it
362 * @stop:	power off the device
363 * @attach:	attach to a device that his already powered up
364 * @kick:	kick a virtqueue (virtqueue id given as a parameter)
365 * @da_to_va:	optional platform hook to perform address translations
366 * @parse_fw:	parse firmware to extract information (e.g. resource table)
367 * @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
371 * @find_loaded_rsc_table: find the loaded resouce table
372 * @load:		load firmware to memory, where the remote processor
373 *			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
376 * @panic:	optional callback to react to system panic, core will delay
377 *		panic at least the returned number of milliseconds
378 */
379struct rproc_ops {
380	int (*prepare)(struct rproc *rproc);
381	int (*unprepare)(struct rproc *rproc);
382	int (*start)(struct rproc *rproc);
383	int (*stop)(struct rproc *rproc);
384	int (*attach)(struct rproc *rproc);
385	void (*kick)(struct rproc *rproc, int vqid);
386	void * (*da_to_va)(struct rproc *rproc, u64 da, size_t len);
387	int (*parse_fw)(struct rproc *rproc, const struct firmware *fw);
388	int (*handle_rsc)(struct rproc *rproc, u32 rsc_type, void *rsc,
389			  int offset, int avail);
390	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);
394	u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
395	unsigned long (*panic)(struct rproc *rproc);
396};
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
405 * @RPROC_DELETED:	device is deleted
406 * @RPROC_DETACHED:	device has been booted by another entity and waiting
407 *			for the core to attach to it
408 * @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,
421	RPROC_DELETED	= 4,
422	RPROC_DETACHED	= 5,
423	RPROC_LAST	= 6,
424};
425
426/**
427 * enum rproc_crash_type - remote processor crash types
428 * @RPROC_MMUFAULT:	iommu fault
429 * @RPROC_WATCHDOG:	watchdog bite
430 * @RPROC_FATAL_ERROR	fatal error
431 *
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,
439	RPROC_WATCHDOG,
440	RPROC_FATAL_ERROR,
441};
442
443/**
444 * enum rproc_dump_mechanism - Coredump options for core
445 * @RPROC_COREDUMP_DEFAULT:	Copy dump to separate buffer and carry on with
446				recovery
447 * @RPROC_COREDUMP_INLINE:	Read segments directly from device memory. Stall
448				recovery until all segments are read
449 * @RPROC_COREDUMP_DISABLED:	Don't perform any dump
450 */
451enum rproc_dump_mechanism {
452	RPROC_COREDUMP_DEFAULT,
453	RPROC_COREDUMP_INLINE,
454	RPROC_COREDUMP_DISABLED,
455};
456
457/**
458 * 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
462 * @priv:	private data associated with the dump_segment
463 * @dump:	custom dump function to fill device memory segment associated
464 *		with coredump
465 */
466struct rproc_dump_segment {
467	struct list_head node;
468
469	dma_addr_t da;
470	size_t size;
471
472	void *priv;
473	void (*dump)(struct rproc *rproc, struct rproc_dump_segment *segment,
474		     void *dest, size_t offset, size_t size);
475	loff_t offset;
476};
477
478/**
479 * struct rproc - represents a physical remote processor device
480 * @node: list node of this rproc object
481 * @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
486 * @dev: virtual device for refcounting and common remoteproc behavior
487 * @power: refcount of users who need this rproc powered up
488 * @state: state of the device
489 * @dump_conf: Currently selected coredump configuration
490 * @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
496 * @bootaddr: address of first instruction to boot rproc with (optional)
497 * @rvdevs: list of remote virtio devices
498 * @subdevs: list of subdevices, to following the running state
499 * @notifyids: idr for dynamically assigning rproc-wide unique notify ids
500 * @index: index of this rproc device
501 * @crash_handler: workqueue for handling a crash
502 * @crash_cnt: crash counter
503 * @recovery_disabled: flag that state if recovery was disabled
504 * @max_notifyid: largest allocated notify id.
505 * @table_ptr: pointer to the resource table in effect
506 * @cached_table: copy of the resource table
507 * @table_sz: size of @cached_table
508 * @has_iommu: flag to indicate if remote processor is behind an MMU
509 * @auto_boot: flag to indicate if remote processor should be auto-started
510 * @autonomous: true if an external entity has booted the remote processor
511 * @dump_segments: list of segments in the firmware
512 * @nb_vdev: number of vdev currently handled by rproc
513 * @char_dev: character device of the rproc
514 * @cdev_put_on_release: flag to indicate if remoteproc should be shutdown on @char_dev release
515 */
516struct rproc {
517	struct list_head node;
518	struct iommu_domain *domain;
519	const char *name;
520	const char *firmware;
521	void *priv;
522	struct rproc_ops *ops;
523	struct device dev;
524	atomic_t power;
525	unsigned int state;
526	enum rproc_dump_mechanism dump_conf;
527	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;
533	u64 bootaddr;
534	struct list_head rvdevs;
535	struct list_head subdevs;
536	struct idr notifyids;
537	int index;
538	struct work_struct crash_handler;
539	unsigned int crash_cnt;
540	bool recovery_disabled;
541	int max_notifyid;
542	struct resource_table *table_ptr;
543	struct resource_table *cached_table;
544	size_t table_sz;
545	bool has_iommu;
546	bool auto_boot;
547	bool autonomous;
548	struct list_head dump_segments;
549	int nb_vdev;
550	u8 elf_class;
551	u16 elf_machine;
552	struct cdev cdev;
553	bool cdev_put_on_release;
554};
555
556/**
557 * struct rproc_subdev - subdevice tied to a remoteproc
558 * @node: list node related to the rproc subdevs list
559 * @prepare: prepare function, called before the rproc is started
560 * @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
563 * @unprepare: unprepare function, called after the rproc has been stopped
564 */
565struct rproc_subdev {
566	struct list_head node;
567
568	int (*prepare)(struct rproc_subdev *subdev);
569	int (*start)(struct rproc_subdev *subdev);
570	void (*stop)(struct rproc_subdev *subdev, bool crashed);
571	void (*unprepare)(struct rproc_subdev *subdev);
572};
573
574/* we currently support only two vrings per rvdev */
575
576#define RVDEV_NUM_VRINGS 2
577
578/**
579 * struct rproc_vring - remoteproc vring state
580 * @va:	virtual address
581 * @len: length, in bytes
582 * @da: device address
583 * @align: vring alignment
584 * @notifyid: rproc-specific unique vring index
585 * @rvdev: remote vdev
586 * @vq: the virtqueue of this vring
587 */
588struct rproc_vring {
589	void *va;
590	int len;
591	u32 da;
592	u32 align;
593	int notifyid;
594	struct rproc_vdev *rvdev;
595	struct virtqueue *vq;
596};
597
598/**
599 * struct rproc_vdev - remoteproc state for a supported virtio device
600 * @refcount: reference counter for the vdev and vring allocations
601 * @subdev: handle for registering the vdev as a rproc subdevice
602 * @id: virtio device id (as in virtio_ids.h)
603 * @node: list node
604 * @rproc: the rproc handle
605 * @vdev: the virio device
606 * @vring: the vrings for this vdev
607 * @rsc_offset: offset of the vdev's resource entry
608 * @index: vdev position versus other vdev declared in resource table
609 */
610struct rproc_vdev {
611	struct kref refcount;
612
613	struct rproc_subdev subdev;
614	struct device dev;
615
616	unsigned int id;
617	struct list_head node;
618	struct rproc *rproc;
619	struct rproc_vring vring[RVDEV_NUM_VRINGS];
620	u32 rsc_offset;
621	u32 index;
622};
623
624struct rproc *rproc_get_by_phandle(phandle phandle);
625struct rproc *rproc_get_by_child(struct device *dev);
626
627struct rproc *rproc_alloc(struct device *dev, const char *name,
628			  const struct rproc_ops *ops,
629			  const char *firmware, int len);
630void rproc_put(struct rproc *rproc);
631int rproc_add(struct rproc *rproc);
632int rproc_del(struct rproc *rproc);
633void rproc_free(struct rproc *rproc);
634void rproc_resource_cleanup(struct rproc *rproc);
635
636struct 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
641void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem);
642
643struct rproc_mem_entry *
644rproc_mem_entry_init(struct device *dev,
645		     void *va, dma_addr_t dma, size_t len, u32 da,
646		     int (*alloc)(struct rproc *, struct rproc_mem_entry *),
647		     int (*release)(struct rproc *, struct rproc_mem_entry *),
648		     const char *name, ...);
649
650struct rproc_mem_entry *
651rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len,
652			     u32 da, const char *name, ...);
653
654int rproc_boot(struct rproc *rproc);
655void rproc_shutdown(struct rproc *rproc);
656void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type);
657int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size);
658int 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,
662						     void *dest, size_t offset,
663						     size_t size),
664				      void *priv);
665int rproc_coredump_set_elf_info(struct rproc *rproc, u8 class, u16 machine);
666
667static inline struct rproc_vdev *vdev_to_rvdev(struct virtio_device *vdev)
668{
669	return container_of(vdev->dev.parent, struct rproc_vdev, dev);
670}
671
672static inline struct rproc *vdev_to_rproc(struct virtio_device *vdev)
673{
674	struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
675
676	return rvdev->rproc;
677}
678
679void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev);
680
681void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev);
682
683#endif /* REMOTEPROC_H */