[mirror_ubuntu-eoan-kernel.git] / drivers / remoteproc / remoteproc_internal.h

/*
 * Remote processor framework
 *
 * Copyright (C) 2011 Texas Instruments, Inc.
 * Copyright (C) 2011 Google, Inc.
 *
 * Ohad Ben-Cohen <ohad@wizery.com>
 * Brian Swetland <swetland@google.com>
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#ifndef REMOTEPROC_INTERNAL_H
#define REMOTEPROC_INTERNAL_H

#include <linux/irqreturn.h>
#include <linux/firmware.h>

struct rproc;

/* from remoteproc_core.c */
void rproc_release(struct kref *kref);
irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
void rproc_vdev_release(struct kref *ref);

/* from remoteproc_virtio.c */
int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
void rproc_remove_virtio_dev(struct rproc_vdev *rvdev);

/* from remoteproc_debugfs.c */
void rproc_remove_trace_file(struct dentry *tfile);
struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
				       struct rproc_mem_entry *trace);
void rproc_delete_debug_dir(struct rproc *rproc);
void rproc_create_debug_dir(struct rproc *rproc);
void rproc_init_debugfs(void);
void rproc_exit_debugfs(void);

/* from remoteproc_sysfs.c */
extern struct class rproc_class;
int rproc_init_sysfs(void);
void rproc_exit_sysfs(void);

void rproc_free_vring(struct rproc_vring *rvring);
int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);

void *rproc_da_to_va(struct rproc *rproc, u64 da, int len);
int rproc_trigger_recovery(struct rproc *rproc);

int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
u32 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw);
int rproc_elf_load_rsc_table(struct rproc *rproc, const struct firmware *fw);
struct resource_table *rproc_elf_find_loaded_rsc_table(struct rproc *rproc,
						       const struct firmware *fw);

static inline
int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
{
	if (rproc->ops->sanity_check)
		return rproc->ops->sanity_check(rproc, fw);

	return 0;
}

static inline
u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
{
	if (rproc->ops->get_boot_addr)
		return rproc->ops->get_boot_addr(rproc, fw);

	return 0;
}

static inline
int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
{
	if (rproc->ops->load)
		return rproc->ops->load(rproc, fw);

	return -EINVAL;
}

static inline int rproc_parse_fw(struct rproc *rproc, const struct firmware *fw)
{
	if (rproc->ops->parse_fw)
		return rproc->ops->parse_fw(rproc, fw);

	return 0;
}

static inline
struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
						   const struct firmware *fw)
{
	if (rproc->ops->find_loaded_rsc_table)
		return rproc->ops->find_loaded_rsc_table(rproc, fw);

	return NULL;
}

#endif /* REMOTEPROC_INTERNAL_H */
Commit	Line	Data
400e64df OBC	1	/*
	2	* Remote processor framework
	3	*
	4	* Copyright (C) 2011 Texas Instruments, Inc.
	5	* Copyright (C) 2011 Google, Inc.
	6	*
	7	* Ohad Ben-Cohen <ohad@wizery.com>
	8	* Brian Swetland <swetland@google.com>
	9	*
	10	* This software is licensed under the terms of the GNU General Public
	11	* License version 2, as published by the Free Software Foundation, and
	12	* may be copied, distributed, and modified under those terms.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*/
	19
	20	#ifndef REMOTEPROC_INTERNAL_H
	21	#define REMOTEPROC_INTERNAL_H
	22
	23	#include <linux/irqreturn.h>
72854fb0	24	#include <linux/firmware.h>
400e64df OBC	25
	26	struct rproc;
	27
	28	/* from remoteproc_core.c */
	29	void rproc_release(struct kref *kref);
	30	irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
aab8d802	31	void rproc_vdev_release(struct kref *ref);
400e64df	32
7a186941 OBC	33	/* from remoteproc_virtio.c */
	34	int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
	35	void rproc_remove_virtio_dev(struct rproc_vdev *rvdev);
400e64df OBC	36
	37	/* from remoteproc_debugfs.c */
	38	void rproc_remove_trace_file(struct dentry *tfile);
	39	struct dentry rproc_create_trace_file(const char name, struct rproc *rproc,
730f84ce	40	struct rproc_mem_entry *trace);
400e64df OBC	41	void rproc_delete_debug_dir(struct rproc *rproc);
	42	void rproc_create_debug_dir(struct rproc *rproc);
	43	void rproc_init_debugfs(void);
	44	void rproc_exit_debugfs(void);
	45
2aefbef0 MR	46	/* from remoteproc_sysfs.c */
	47	extern struct class rproc_class;
	48	int rproc_init_sysfs(void);
	49	void rproc_exit_sysfs(void);
	50
6db20ea8 OBC	51	void rproc_free_vring(struct rproc_vring *rvring);
6db20ea8 OBC	52	int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
72854fb0 SB	53
72854fb0 SB	54	void rproc_da_to_va(struct rproc rproc, u64 da, int len);
70b85ef8	55	int rproc_trigger_recovery(struct rproc *rproc);
72854fb0	56
0f21f9cc BA	57	int rproc_elf_sanity_check(struct rproc rproc, const struct firmware fw);
	58	u32 rproc_elf_get_boot_addr(struct rproc rproc, const struct firmware fw);
	59	int rproc_elf_load_segments(struct rproc rproc, const struct firmware fw);
58b64090	60	int rproc_elf_load_rsc_table(struct rproc rproc, const struct firmware fw);
0f21f9cc BA	61	struct resource_table rproc_elf_find_loaded_rsc_table(struct rproc rproc,
	62	const struct firmware *fw);
	63
4afc89d6 SB	64	static inline
	65	int rproc_fw_sanity_check(struct rproc rproc, const struct firmware fw)
	66	{
0f21f9cc BA	67	if (rproc->ops->sanity_check)
0f21f9cc BA	68	return rproc->ops->sanity_check(rproc, fw);
4afc89d6 SB	69
	70	return 0;
	71	}
	72
	73	static inline
	74	u32 rproc_get_boot_addr(struct rproc rproc, const struct firmware fw)
	75	{
0f21f9cc BA	76	if (rproc->ops->get_boot_addr)
0f21f9cc BA	77	return rproc->ops->get_boot_addr(rproc, fw);
4afc89d6 SB	78
	79	return 0;
	80	}
	81
	82	static inline
	83	int rproc_load_segments(struct rproc rproc, const struct firmware fw)
	84	{
0f21f9cc BA	85	if (rproc->ops->load)
0f21f9cc BA	86	return rproc->ops->load(rproc, fw);
4afc89d6 SB	87
	88	return -EINVAL;
	89	}
	90
c1d35c1a	91	static inline int rproc_parse_fw(struct rproc rproc, const struct firmware fw)
4afc89d6	92	{
c1d35c1a BA	93	if (rproc->ops->parse_fw)
c1d35c1a BA	94	return rproc->ops->parse_fw(rproc, fw);
4afc89d6	95
58b64090	96	return 0;
4afc89d6 SB	97	}
4afc89d6 SB	98
95f95781 SB	99	static inline
95f95781 SB	100	struct resource_table rproc_find_loaded_rsc_table(struct rproc rproc,
730f84ce	101	const struct firmware *fw)
95f95781	102	{
0f21f9cc BA	103	if (rproc->ops->find_loaded_rsc_table)
0f21f9cc BA	104	return rproc->ops->find_loaded_rsc_table(rproc, fw);
95f95781	105
57971159	106	return NULL;
95f95781 SB	107	}
95f95781 SB	108
400e64df	109	#endif /* REMOTEPROC_INTERNAL_H */