[deliverable/linux.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;

/**
 * struct rproc_fw_ops - firmware format specific operations.
 * @find_rsc_table:	find the resource table inside the firmware image
 * @find_loaded_rsc_table: find the loaded resouce table
 * @load:		load firmeware to memory, where the remote processor
 *			expects to find it
 * @sanity_check:	sanity check the fw image
 * @get_boot_addr:	get boot address to entry point specified in firmware
 */
struct rproc_fw_ops {
	struct resource_table *(*find_rsc_table)(struct rproc *rproc,
						 const struct firmware *fw,
						 int *tablesz);
	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);
	u32 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
};

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

/* 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);

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);

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

	return 0;
}

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

	return 0;
}

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

	return -EINVAL;
}

static inline
struct resource_table *rproc_find_rsc_table(struct rproc *rproc,
					    const struct firmware *fw,
					    int *tablesz)
{
	if (rproc->fw_ops->find_rsc_table)
		return rproc->fw_ops->find_rsc_table(rproc, fw, tablesz);

	return NULL;
}

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

	return NULL;
}

extern const struct rproc_fw_ops rproc_elf_fw_ops;

#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
4afc89d6 SB	28	/**
4afc89d6 SB	29	* struct rproc_fw_ops - firmware format specific operations.
95f95781 SB	30	* @find_rsc_table: find the resource table inside the firmware image
95f95781 SB	31	* @find_loaded_rsc_table: find the loaded resouce table
4afc89d6 SB	32	* @load: load firmeware to memory, where the remote processor
	33	* expects to find it
	34	* @sanity_check: sanity check the fw image
	35	* @get_boot_addr: get boot address to entry point specified in firmware
	36	*/
	37	struct rproc_fw_ops {
172e6ab1	38	struct resource_table (find_rsc_table)(struct rproc *rproc,
730f84ce AS	39	const struct firmware *fw,
	40	int *tablesz);
	41	struct resource_table (find_loaded_rsc_table)(
	42	struct rproc rproc, const struct firmware fw);
4afc89d6 SB	43	int (load)(struct rproc rproc, const struct firmware *fw);
	44	int (sanity_check)(struct rproc rproc, const struct firmware *fw);
	45	u32 (get_boot_addr)(struct rproc rproc, const struct firmware *fw);
	46	};
	47
400e64df OBC	48	/* from remoteproc_core.c */
	49	void rproc_release(struct kref *kref);
	50	irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
3d87fa1d	51	int rproc_boot_nowait(struct rproc *rproc);
400e64df	52
7a186941 OBC	53	/* from remoteproc_virtio.c */
	54	int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
	55	void rproc_remove_virtio_dev(struct rproc_vdev *rvdev);
400e64df OBC	56
	57	/* from remoteproc_debugfs.c */
	58	void rproc_remove_trace_file(struct dentry *tfile);
	59	struct dentry rproc_create_trace_file(const char name, struct rproc *rproc,
730f84ce	60	struct rproc_mem_entry *trace);
400e64df OBC	61	void rproc_delete_debug_dir(struct rproc *rproc);
	62	void rproc_create_debug_dir(struct rproc *rproc);
	63	void rproc_init_debugfs(void);
	64	void rproc_exit_debugfs(void);
	65
6db20ea8 OBC	66	void rproc_free_vring(struct rproc_vring *rvring);
6db20ea8 OBC	67	int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
72854fb0 SB	68
72854fb0 SB	69	void rproc_da_to_va(struct rproc rproc, u64 da, int len);
70b85ef8	70	int rproc_trigger_recovery(struct rproc *rproc);
72854fb0	71
4afc89d6 SB	72	static inline
	73	int rproc_fw_sanity_check(struct rproc rproc, const struct firmware fw)
	74	{
	75	if (rproc->fw_ops->sanity_check)
	76	return rproc->fw_ops->sanity_check(rproc, fw);
	77
	78	return 0;
	79	}
	80
	81	static inline
	82	u32 rproc_get_boot_addr(struct rproc rproc, const struct firmware fw)
	83	{
	84	if (rproc->fw_ops->get_boot_addr)
	85	return rproc->fw_ops->get_boot_addr(rproc, fw);
	86
	87	return 0;
	88	}
	89
	90	static inline
	91	int rproc_load_segments(struct rproc rproc, const struct firmware fw)
	92	{
	93	if (rproc->fw_ops->load)
	94	return rproc->fw_ops->load(rproc, fw);
	95
	96	return -EINVAL;
	97	}
	98
	99	static inline
72854fb0	100	struct resource_table rproc_find_rsc_table(struct rproc rproc,
730f84ce AS	101	const struct firmware *fw,
730f84ce AS	102	int *tablesz)
4afc89d6 SB	103	{
	104	if (rproc->fw_ops->find_rsc_table)
	105	return rproc->fw_ops->find_rsc_table(rproc, fw, tablesz);
	106
	107	return NULL;
	108	}
	109
95f95781 SB	110	static inline
95f95781 SB	111	struct resource_table rproc_find_loaded_rsc_table(struct rproc rproc,
730f84ce	112	const struct firmware *fw)
95f95781 SB	113	{
	114	if (rproc->fw_ops->find_loaded_rsc_table)
	115	return rproc->fw_ops->find_loaded_rsc_table(rproc, fw);
	116
57971159	117	return NULL;
95f95781 SB	118	}
95f95781 SB	119
4afc89d6	120	extern const struct rproc_fw_ops rproc_elf_fw_ops;
72854fb0	121
400e64df	122	#endif /* REMOTEPROC_INTERNAL_H */