remoteproc.h 24.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/*
 * Remote Processor Framework
 *
 * Copyright(c) 2011 Texas Instruments, Inc.
 * Copyright(c) 2011 Google, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name Texas Instruments nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef REMOTEPROC_H
#define REMOTEPROC_H

#include <linux/types.h>
#include <linux/mutex.h>
#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 48 49 50 51
 * struct resource_table - firmware resource table header
 * @ver: version number
 * @num: number of resource entries
 * @reserved: reserved (must be zero)
 * @offset: array of offsets pointing at the various resource entries
52
 *
53 54 55 56
 * A resource table is essentially a list of system resources required
 * by the remote processor. It may also include configuration entries.
 * If needed, the remote processor firmware should contain this table
 * as a dedicated ".resource_table" ELF section.
57 58 59
 *
 * Some resources entries are mere announcements, where the host is informed
 * of specific remoteproc configuration. Other entries require the host to
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
 * do something (e.g. allocate a system resource). Sometimes a negotiation
 * is expected, where the firmware requests a resource, and once allocated,
 * the host should provide back its details (e.g. address of an allocated
 * memory region).
 *
 * The header of the resource table, as expressed by this structure,
 * contains a version number (should we need to change this format in the
 * future), the number of available resource entries, and their offsets
 * in the table.
 *
 * Immediately following this header are the resource entries themselves,
 * each of which begins with a resource entry header (as described below).
 */
struct resource_table {
	u32 ver;
	u32 num;
	u32 reserved[2];
77
	u32 offset[];
78 79 80 81 82 83 84 85 86 87
} __packed;

/**
 * struct fw_rsc_hdr - firmware resource entry header
 * @type: resource type
 * @data: resource data
 *
 * Every resource entry begins with a 'struct fw_rsc_hdr' header providing
 * its @type. The content of the entry itself will immediately follow
 * this header, and it should be parsed according to the resource type.
88
 */
89
struct fw_rsc_hdr {
90
	u32 type;
91
	u8 data[];
92 93 94 95 96 97 98 99 100
} __packed;

/**
 * enum fw_resource_type - types of resource entries
 *
 * @RSC_CARVEOUT:   request for allocation of a physically contiguous
 *		    memory region.
 * @RSC_DEVMEM:     request to iommu_map a memory-based peripheral.
 * @RSC_TRACE:	    announces the availability of a trace buffer into which
101 102 103
 *		    the remote processor will be writing logs.
 * @RSC_VDEV:       declare support for a virtio device, and serve as its
 *		    virtio header.
104 105 106
 * @RSC_LAST:       just keep this one at the end of standard resources
 * @RSC_VENDOR_START:	start of the vendor specific resource types range
 * @RSC_VENDOR_END:	end of the vendor specific resource types range
107
 *
108 109
 * For more details regarding a specific resource type, please see its
 * dedicated structure below.
110 111 112 113 114
 *
 * Please note that these values are used as indices to the rproc_handle_rsc
 * lookup table, so please keep them sane. Moreover, @RSC_LAST is used to
 * check the validity of an index before the lookup table is accessed, so
 * please update it as needed.
115 116
 */
enum fw_resource_type {
117 118 119 120 121 122 123
	RSC_CARVEOUT		= 0,
	RSC_DEVMEM		= 1,
	RSC_TRACE		= 2,
	RSC_VDEV		= 3,
	RSC_LAST		= 4,
	RSC_VENDOR_START	= 128,
	RSC_VENDOR_END		= 512,
124 125
};

126
#define FW_RSC_ADDR_ANY (-1)
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

/**
 * struct fw_rsc_carveout - physically contiguous memory request
 * @da: device address
 * @pa: physical address
 * @len: length (in bytes)
 * @flags: iommu protection flags
 * @reserved: reserved (must be zero)
 * @name: human-readable name of the requested memory region
 *
 * This resource entry requests the host to allocate a physically contiguous
 * memory region.
 *
 * These request entries should precede other firmware resource entries,
 * as other entries might request placing other data objects inside
 * these memory regions (e.g. data/code segments, trace resource entries, ...).
 *
 * Allocating memory this way helps utilizing the reserved physical memory
 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
 * pressure is important; it may have a substantial impact on performance.
 *
 * If the firmware is compiled with static addresses, then @da should specify
 * the expected device address of this memory region. If @da is set to
 * FW_RSC_ADDR_ANY, then the host will dynamically allocate it, and then
 * overwrite @da with the dynamically allocated address.
 *
 * We will always use @da to negotiate the device addresses, even if it
 * isn't using an iommu. In that case, though, it will obviously contain
 * physical addresses.
 *
 * Some remote processors needs to know the allocated physical address
 * even if they do use an iommu. This is needed, e.g., if they control
 * hardware accelerators which access the physical memory directly (this
 * is the case with OMAP4 for instance). In that case, the host will
 * overwrite @pa with the dynamically allocated physical address.
 * Generally we don't want to expose physical addresses if we don't have to
 * (remote processors are generally _not_ trusted), so we might want to
 * change this to happen _only_ when explicitly required by the hardware.
 *
 * @flags is used to provide IOMMU protection flags, and @name should
 * (optionally) contain a human readable name of this carveout region
 * (mainly for debugging purposes).
 */
struct fw_rsc_carveout {
	u32 da;
	u32 pa;
	u32 len;
	u32 flags;
	u32 reserved;
	u8 name[32];
} __packed;

/**
 * struct fw_rsc_devmem - iommu mapping request
 * @da: device address
 * @pa: physical address
 * @len: length (in bytes)
 * @flags: iommu protection flags
 * @reserved: reserved (must be zero)
 * @name: human-readable name of the requested region to be mapped
 *
 * This resource entry requests the host to iommu map a physically contiguous
 * memory region. This is needed in case the remote processor requires
 * access to certain memory-based peripherals; _never_ use it to access
 * regular memory.
 *
 * This is obviously only needed if the remote processor is accessing memory
 * via an iommu.
 *
 * @da should specify the required device address, @pa should specify
 * the physical address we want to map, @len should specify the size of
 * the mapping and @flags is the IOMMU protection flags. As always, @name may
 * (optionally) contain a human readable name of this mapping (mainly for
 * debugging purposes).
 *
 * Note: at this point we just "trust" those devmem entries to contain valid
 * physical addresses, but this isn't safe and will be changed: eventually we
 * want remoteproc implementations to provide us ranges of physical addresses
 * the firmware is allowed to request, and not allow firmwares to request
 * access to physical addresses that are outside those ranges.
 */
struct fw_rsc_devmem {
	u32 da;
	u32 pa;
	u32 len;
	u32 flags;
	u32 reserved;
	u8 name[32];
} __packed;

/**
 * struct fw_rsc_trace - trace buffer declaration
 * @da: device address
 * @len: length (in bytes)
 * @reserved: reserved (must be zero)
 * @name: human-readable name of the trace buffer
 *
 * This resource entry provides the host information about a trace buffer
 * into which the remote processor will write log messages.
 *
 * @da specifies the device address of the buffer, @len specifies
 * its size, and @name may contain a human readable name of the trace buffer.
 *
 * After booting the remote processor, the trace buffers are exposed to the
 * user via debugfs entries (called trace0, trace1, etc..).
 */
struct fw_rsc_trace {
	u32 da;
	u32 len;
	u32 reserved;
	u8 name[32];
} __packed;

/**
 * struct fw_rsc_vdev_vring - vring descriptor entry
 * @da: device address
 * @align: the alignment between the consumer and producer parts of the vring
 * @num: num of buffers supported by this vring (must be power of two)
 * @notifyid is a unique rproc-wide notify index for this vring. This notify
 * index is used when kicking a remote processor, to let it know that this
 * vring is triggered.
249
 * @pa: physical address
250 251 252 253 254 255 256 257 258 259 260 261 262
 *
 * This descriptor is not a resource entry by itself; it is part of the
 * vdev resource type (see below).
 *
 * Note that @da should either contain the device address where
 * the remote processor is expecting the vring, or indicate that
 * dynamically allocation of the vring's device address is supported.
 */
struct fw_rsc_vdev_vring {
	u32 da;
	u32 align;
	u32 num;
	u32 notifyid;
263
	u32 pa;
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
} __packed;

/**
 * struct fw_rsc_vdev - virtio device header
 * @id: virtio device id (as in virtio_ids.h)
 * @notifyid is a unique rproc-wide notify index for this vdev. This notify
 * index is used when kicking a remote processor, to let it know that the
 * status/features of this vdev have changes.
 * @dfeatures specifies the virtio device features supported by the firmware
 * @gfeatures is a place holder used by the host to write back the
 * negotiated features that are supported by both sides.
 * @config_len is the size of the virtio config space of this vdev. The config
 * space lies in the resource table immediate after this vdev header.
 * @status is a place holder where the host will indicate its virtio progress.
 * @num_of_vrings indicates how many vrings are described in this vdev header
 * @reserved: reserved (must be zero)
 * @vring is an array of @num_of_vrings entries of 'struct fw_rsc_vdev_vring'.
 *
 * This resource is a virtio device header: it provides information about
 * the vdev, and is then used by the host and its peer remote processors
 * to negotiate and share certain virtio properties.
 *
 * By providing this resource entry, the firmware essentially asks remoteproc
 * to statically allocate a vdev upon registration of the rproc (dynamic vdev
 * allocation is not yet supported).
 *
 * Note: unlike virtualization systems, the term 'host' here means
 * the Linux side which is running remoteproc to control the remote
 * processors. We use the name 'gfeatures' to comply with virtio's terms,
 * though there isn't really any virtualized guest OS here: it's the host
 * which is responsible for negotiating the final features.
 * Yeah, it's a bit confusing.
 *
 * Note: immediately following this structure is the virtio config space for
 * this vdev (which is specific to the vdev; for more info, read the virtio
 * spec). the size of the config space is specified by @config_len.
 */
struct fw_rsc_vdev {
	u32 id;
	u32 notifyid;
	u32 dfeatures;
	u32 gfeatures;
	u32 config_len;
	u8 status;
	u8 num_of_vrings;
	u8 reserved[2];
310
	struct fw_rsc_vdev_vring vring[];
311 312
} __packed;

313 314
struct rproc;

315 316 317 318 319 320
/**
 * struct rproc_mem_entry - memory entry descriptor
 * @va:	virtual address
 * @dma: dma address
 * @len: length, in bytes
 * @da: device address
321
 * @release: release associated memory
322
 * @priv: associated data
323
 * @name: associated memory region name (optional)
324
 * @node: list node
325 326
 * @rsc_offset: offset in resource table
 * @flags: iommu protection flags
327
 * @of_resm_idx: reserved memory phandle index
328
 * @alloc: specific memory allocator function
329 330 331 332
 */
struct rproc_mem_entry {
	void *va;
	dma_addr_t dma;
333
	size_t len;
334
	u32 da;
335
	void *priv;
336
	char name[32];
337
	struct list_head node;
338 339
	u32 rsc_offset;
	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
};

345
struct firmware;
346

347 348 349 350 351 352 353 354 355 356
/**
 * enum rsc_handling_status - return status of rproc_ops handle_rsc hook
 * @RSC_HANDLED:	resource was handled
 * @RSC_IGNORED:	resource was ignored
 */
enum rsc_handling_status {
	RSC_HANDLED	= 0,
	RSC_IGNORED	= 1,
};

357 358
/**
 * struct rproc_ops - platform-specific device handlers
359 360
 * @prepare:	prepare device for code loading
 * @unprepare:	unprepare device after stop
361 362
 * @start:	power on the device and boot it
 * @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 368 369 370
 * @handle_rsc:	optional platform hook to handle vendor resources. Should return
 * RSC_HANDLED if resource was handled, RSC_IGNORED if not handled and a
 * negative value on error
 * @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 374 375
 *			expects to find it
 * @sanity_check:	sanity check the fw image
 * @get_boot_addr:	get boot address to entry point specified in firmware
376 377
 * @panic:	optional callback to react to system panic, core will delay
 *		panic at least the returned number of milliseconds
378
 * @coredump:	  collect firmware dump after the subsystem is shutdown
379 380
 */
struct rproc_ops {
381 382
	int (*prepare)(struct rproc *rproc);
	int (*unprepare)(struct rproc *rproc);
383 384
	int (*start)(struct rproc *rproc);
	int (*stop)(struct rproc *rproc);
385
	int (*attach)(struct rproc *rproc);
386
	void (*kick)(struct rproc *rproc, int vqid);
387
	void * (*da_to_va)(struct rproc *rproc, u64 da, size_t len);
388
	int (*parse_fw)(struct rproc *rproc, const struct firmware *fw);
389 390
	int (*handle_rsc)(struct rproc *rproc, u32 rsc_type, void *rsc,
			  int offset, int avail);
391 392 393 394
	struct resource_table *(*find_loaded_rsc_table)(
				struct rproc *rproc, const struct firmware *fw);
	int (*load)(struct rproc *rproc, const struct firmware *fw);
	int (*sanity_check)(struct rproc *rproc, const struct firmware *fw);
395
	u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
396
	unsigned long (*panic)(struct rproc *rproc);
397
	void (*coredump)(struct rproc *rproc);
398 399 400 401 402 403 404 405 406
};

/**
 * enum rproc_state - remote processor states
 * @RPROC_OFFLINE:	device is powered off
 * @RPROC_SUSPENDED:	device is suspended; needs to be woken up to receive
 *			a message.
 * @RPROC_RUNNING:	device is up and running
 * @RPROC_CRASHED:	device has crashed; need to start recovery
407
 * @RPROC_DELETED:	device is deleted
408 409
 * @RPROC_DETACHED:	device has been booted by another entity and waiting
 *			for the core to attach to it
410 411 412 413 414 415 416 417 418 419 420 421 422
 * @RPROC_LAST:		just keep this one at the end
 *
 * Please note that the values of these states are used as indices
 * to rproc_state_string, a state-to-name lookup table,
 * so please keep the two synchronized. @RPROC_LAST is used to check
 * the validity of an index before the lookup table is accessed, so
 * please update it as needed too.
 */
enum rproc_state {
	RPROC_OFFLINE	= 0,
	RPROC_SUSPENDED	= 1,
	RPROC_RUNNING	= 2,
	RPROC_CRASHED	= 3,
423
	RPROC_DELETED	= 4,
424 425
	RPROC_DETACHED	= 5,
	RPROC_LAST	= 6,
426 427
};

428 429 430
/**
 * enum rproc_crash_type - remote processor crash types
 * @RPROC_MMUFAULT:	iommu fault
431 432
 * @RPROC_WATCHDOG:	watchdog bite
 * @RPROC_FATAL_ERROR	fatal error
433 434 435 436 437 438 439 440
 *
 * Each element of the enum is used as an array index. So that, the value of
 * the elements should be always something sane.
 *
 * Feel free to add more types when needed.
 */
enum rproc_crash_type {
	RPROC_MMUFAULT,
441 442
	RPROC_WATCHDOG,
	RPROC_FATAL_ERROR,
443 444
};

445 446
/**
 * enum rproc_dump_mechanism - Coredump options for core
447 448
 * @RPROC_COREDUMP_DISABLED:	Don't perform any dump
 * @RPROC_COREDUMP_ENABLED:	Copy dump to separate buffer and carry on with
449 450 451 452 453 454
				recovery
 * @RPROC_COREDUMP_INLINE:	Read segments directly from device memory. Stall
				recovery until all segments are read
 */
enum rproc_dump_mechanism {
	RPROC_COREDUMP_DISABLED,
455 456
	RPROC_COREDUMP_ENABLED,
	RPROC_COREDUMP_INLINE,
457 458
};

459 460 461 462 463
/**
 * struct rproc_dump_segment - segment info from ELF header
 * @node:	list node related to the rproc segment list
 * @da:		device address of the segment
 * @size:	size of the segment
464 465 466
 * @priv:	private data associated with the dump_segment
 * @dump:	custom dump function to fill device memory segment associated
 *		with coredump
467 468 469 470 471 472 473
 */
struct rproc_dump_segment {
	struct list_head node;

	dma_addr_t da;
	size_t size;

474 475
	void *priv;
	void (*dump)(struct rproc *rproc, struct rproc_dump_segment *segment,
476
		     void *dest, size_t offset, size_t size);
477 478 479
	loff_t offset;
};

480 481
/**
 * struct rproc - represents a physical remote processor device
482
 * @node: list node of this rproc object
483 484 485 486 487
 * @domain: iommu domain
 * @name: human readable name of the rproc
 * @firmware: name of firmware file to be loaded
 * @priv: private data which belongs to the platform-specific rproc module
 * @ops: platform-specific start/stop rproc handlers
488
 * @dev: virtual device for refcounting and common remoteproc behavior
489 490
 * @power: refcount of users who need this rproc powered up
 * @state: state of the device
491
 * @dump_conf: Currently selected coredump configuration
492 493 494 495 496 497 498
 * @lock: lock which protects concurrent manipulations of the rproc
 * @dbg_dir: debugfs directory of this rproc device
 * @traces: list of trace buffers
 * @num_traces: number of trace buffers
 * @carveouts: list of physically contiguous memory allocations
 * @mappings: list of iommu mappings we initiated, needed on shutdown
 * @bootaddr: address of first instruction to boot rproc with (optional)
499
 * @rvdevs: list of remote virtio devices
B
Bjorn Andersson 已提交
500
 * @subdevs: list of subdevices, to following the running state
501
 * @notifyids: idr for dynamically assigning rproc-wide unique notify ids
502
 * @index: index of this rproc device
503 504
 * @crash_handler: workqueue for handling a crash
 * @crash_cnt: crash counter
505
 * @recovery_disabled: flag that state if recovery was disabled
506
 * @max_notifyid: largest allocated notify id.
507 508
 * @table_ptr: pointer to the resource table in effect
 * @cached_table: copy of the resource table
509
 * @table_sz: size of @cached_table
510
 * @has_iommu: flag to indicate if remote processor is behind an MMU
511
 * @auto_boot: flag to indicate if remote processor should be auto-started
512
 * @autonomous: true if an external entity has booted the remote processor
513
 * @dump_segments: list of segments in the firmware
514
 * @nb_vdev: number of vdev currently handled by rproc
515 516
 * @char_dev: character device of the rproc
 * @cdev_put_on_release: flag to indicate if remoteproc should be shutdown on @char_dev release
517 518
 */
struct rproc {
519
	struct list_head node;
520 521
	struct iommu_domain *domain;
	const char *name;
522
	const char *firmware;
523
	void *priv;
524
	struct rproc_ops *ops;
525
	struct device dev;
526 527
	atomic_t power;
	unsigned int state;
528
	enum rproc_dump_mechanism dump_conf;
529 530 531 532 533 534
	struct mutex lock;
	struct dentry *dbg_dir;
	struct list_head traces;
	int num_traces;
	struct list_head carveouts;
	struct list_head mappings;
535
	u64 bootaddr;
536
	struct list_head rvdevs;
B
Bjorn Andersson 已提交
537
	struct list_head subdevs;
538
	struct idr notifyids;
539
	int index;
540
	struct work_struct crash_handler;
541
	unsigned int crash_cnt;
542
	bool recovery_disabled;
543
	int max_notifyid;
544
	struct resource_table *table_ptr;
545
	struct resource_table *cached_table;
546
	size_t table_sz;
547
	bool has_iommu;
548
	bool auto_boot;
549
	bool autonomous;
550
	struct list_head dump_segments;
551
	int nb_vdev;
552
	u8 elf_class;
553
	u16 elf_machine;
554 555
	struct cdev cdev;
	bool cdev_put_on_release;
556 557
};

B
Bjorn Andersson 已提交
558 559 560
/**
 * struct rproc_subdev - subdevice tied to a remoteproc
 * @node: list node related to the rproc subdevs list
561
 * @prepare: prepare function, called before the rproc is started
562 563 564
 * @start: start function, called after the rproc has been started
 * @stop: stop function, called before the rproc is stopped; the @crashed
 *	    parameter indicates if this originates from a recovery
565
 * @unprepare: unprepare function, called after the rproc has been stopped
B
Bjorn Andersson 已提交
566 567 568 569
 */
struct rproc_subdev {
	struct list_head node;

570
	int (*prepare)(struct rproc_subdev *subdev);
571 572
	int (*start)(struct rproc_subdev *subdev);
	void (*stop)(struct rproc_subdev *subdev, bool crashed);
573
	void (*unprepare)(struct rproc_subdev *subdev);
B
Bjorn Andersson 已提交
574 575
};

576
/* we currently support only two vrings per rvdev */
577

578 579 580 581 582 583 584
#define RVDEV_NUM_VRINGS 2

/**
 * struct rproc_vring - remoteproc vring state
 * @va:	virtual address
 * @len: length, in bytes
 * @da: device address
585
 * @align: vring alignment
586 587 588 589 590 591 592 593
 * @notifyid: rproc-specific unique vring index
 * @rvdev: remote vdev
 * @vq: the virtqueue of this vring
 */
struct rproc_vring {
	void *va;
	int len;
	u32 da;
594
	u32 align;
595
	int notifyid;
596
	struct rproc_vdev *rvdev;
597
	struct virtqueue *vq;
598 599 600 601
};

/**
 * struct rproc_vdev - remoteproc state for a supported virtio device
602
 * @refcount: reference counter for the vdev and vring allocations
603 604
 * @subdev: handle for registering the vdev as a rproc subdevice
 * @id: virtio device id (as in virtio_ids.h)
605
 * @node: list node
606 607 608
 * @rproc: the rproc handle
 * @vdev: the virio device
 * @vring: the vrings for this vdev
609
 * @rsc_offset: offset of the vdev's resource entry
610
 * @index: vdev position versus other vdev declared in resource table
611 612
 */
struct rproc_vdev {
613 614
	struct kref refcount;

615
	struct rproc_subdev subdev;
616
	struct device dev;
617 618

	unsigned int id;
619
	struct list_head node;
620
	struct rproc *rproc;
621
	struct rproc_vring vring[RVDEV_NUM_VRINGS];
622
	u32 rsc_offset;
623
	u32 index;
624 625
};

626
struct rproc *rproc_get_by_phandle(phandle phandle);
627 628
struct rproc *rproc_get_by_child(struct device *dev);

629
struct rproc *rproc_alloc(struct device *dev, const char *name,
630 631
			  const struct rproc_ops *ops,
			  const char *firmware, int len);
632 633 634
void rproc_put(struct rproc *rproc);
int rproc_add(struct rproc *rproc);
int rproc_del(struct rproc *rproc);
635
void rproc_free(struct rproc *rproc);
636
void rproc_resource_cleanup(struct rproc *rproc);
637

638 639 640 641 642
struct rproc *devm_rproc_alloc(struct device *dev, const char *name,
			       const struct rproc_ops *ops,
			       const char *firmware, int len);
int devm_rproc_add(struct device *dev, struct rproc *rproc);

643 644
void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem);

645 646
struct rproc_mem_entry *
rproc_mem_entry_init(struct device *dev,
647
		     void *va, dma_addr_t dma, size_t len, u32 da,
648
		     int (*alloc)(struct rproc *, struct rproc_mem_entry *),
649 650 651
		     int (*release)(struct rproc *, struct rproc_mem_entry *),
		     const char *name, ...);

652
struct rproc_mem_entry *
653
rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len,
654 655
			     u32 da, const char *name, ...);

656 657
int rproc_boot(struct rproc *rproc);
void rproc_shutdown(struct rproc *rproc);
658
int rproc_set_firmware(struct rproc *rproc, const char *fw_name);
659
void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type);
660
void rproc_coredump_using_sections(struct rproc *rproc);
661
int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size);
662 663 664 665
int rproc_coredump_add_custom_segment(struct rproc *rproc,
				      dma_addr_t da, size_t size,
				      void (*dumpfn)(struct rproc *rproc,
						     struct rproc_dump_segment *segment,
666 667
						     void *dest, size_t offset,
						     size_t size),
668
				      void *priv);
669
int rproc_coredump_set_elf_info(struct rproc *rproc, u8 class, u16 machine);
670

671 672
static inline struct rproc_vdev *vdev_to_rvdev(struct virtio_device *vdev)
{
673
	return container_of(vdev->dev.parent, struct rproc_vdev, dev);
674 675
}

676 677
static inline struct rproc *vdev_to_rproc(struct virtio_device *vdev)
{
678
	struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
679 680 681 682

	return rvdev->rproc;
}

683
void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev);
B
Bjorn Andersson 已提交
684 685 686

void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev);

687
#endif /* REMOTEPROC_H */