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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * 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>
 */

#ifndef REMOTEPROC_INTERNAL_H
#define REMOTEPROC_INTERNAL_H

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

struct rproc;

struct rproc_debug_trace {
	struct rproc *rproc;
	struct dentry *tfile;
	struct list_head node;
	struct rproc_mem_entry trace_mem;
};

/* 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);
int rproc_remove_virtio_dev(struct device *dev, void *data);

/* 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_debug_trace *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, size_t len);
phys_addr_t rproc_va_to_pa(void *cpu_addr);
int rproc_trigger_recovery(struct rproc *rproc);

int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
u64 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);
struct rproc_mem_entry *
rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...);

static inline int rproc_prepare_device(struct rproc *rproc)
{
	if (rproc->ops->prepare)
		return rproc->ops->prepare(rproc);

	return 0;
}

static inline int rproc_unprepare_device(struct rproc *rproc)
{
	if (rproc->ops->unprepare)
		return rproc->ops->unprepare(rproc);

	return 0;
}

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
u64 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
int rproc_handle_rsc(struct rproc *rproc, u32 rsc_type, void *rsc, int offset,
		     int avail)
{
	if (rproc->ops->handle_rsc)
		return rproc->ops->handle_rsc(rproc, rsc_type, rsc, offset,
					      avail);

	return RSC_IGNORED;
}

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

static inline
bool rproc_u64_fit_in_size_t(u64 val)
{
	if (sizeof(size_t) == sizeof(u64))
		return true;

	return (val <= (size_t) -1);
}

#endif /* REMOTEPROC_INTERNAL_H */
Commit	Line	Data
9c92ab61	1	/* SPDX-License-Identifier: GPL-2.0-only */
400e64df OBC	2	/*
	3	* Remote processor framework
	4	*
	5	* Copyright (C) 2011 Texas Instruments, Inc.
	6	* Copyright (C) 2011 Google, Inc.
	7	*
	8	* Ohad Ben-Cohen <ohad@wizery.com>
	9	* Brian Swetland <swetland@google.com>
400e64df OBC	10	*/
	11
	12	#ifndef REMOTEPROC_INTERNAL_H
	13	#define REMOTEPROC_INTERNAL_H
	14
	15	#include <linux/irqreturn.h>
72854fb0	16	#include <linux/firmware.h>
400e64df OBC	17
	18	struct rproc;
	19
a987e6b9 LP	20	struct rproc_debug_trace {
	21	struct rproc *rproc;
	22	struct dentry *tfile;
	23	struct list_head node;
	24	struct rproc_mem_entry trace_mem;
	25	};
	26
400e64df OBC	27	/* from remoteproc_core.c */
	28	void rproc_release(struct kref *kref);
	29	irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
aab8d802	30	void rproc_vdev_release(struct kref *ref);
400e64df	31
7a186941 OBC	32	/* from remoteproc_virtio.c */
7a186941 OBC	33	int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
d4c036fe	34	int rproc_remove_virtio_dev(struct device dev, void data);
400e64df OBC	35
	36	/* from remoteproc_debugfs.c */
	37	void rproc_remove_trace_file(struct dentry *tfile);
	38	struct dentry rproc_create_trace_file(const char name, struct rproc *rproc,
a987e6b9	39	struct rproc_debug_trace *trace);
400e64df OBC	40	void rproc_delete_debug_dir(struct rproc *rproc);
	41	void rproc_create_debug_dir(struct rproc *rproc);
	42	void rproc_init_debugfs(void);
	43	void rproc_exit_debugfs(void);
	44
2aefbef0 MR	45	/* from remoteproc_sysfs.c */
	46	extern struct class rproc_class;
	47	int rproc_init_sysfs(void);
	48	void rproc_exit_sysfs(void);
	49
6db20ea8 OBC	50	void rproc_free_vring(struct rproc_vring *rvring);
6db20ea8 OBC	51	int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
72854fb0	52
9ce3bf22	53	void rproc_da_to_va(struct rproc rproc, u64 da, size_t len);
086d0872	54	phys_addr_t rproc_va_to_pa(void *cpu_addr);
70b85ef8	55	int rproc_trigger_recovery(struct rproc *rproc);
72854fb0	56
f31e339f	57	int rproc_elf_sanity_check(struct rproc rproc, const struct firmware fw);
e4ae4b7d	58	u64 rproc_elf_get_boot_addr(struct rproc rproc, const struct firmware fw);
0f21f9cc	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,
0f21f9cc BA	62	const struct firmware *fw);
c6aed238 LP	63	struct rproc_mem_entry *
c6aed238 LP	64	rproc_find_carveout_by_name(struct rproc rproc, const char name, ...);
0f21f9cc	65
33467ac3 LP	66	static inline int rproc_prepare_device(struct rproc *rproc)
	67	{
	68	if (rproc->ops->prepare)
	69	return rproc->ops->prepare(rproc);
	70
	71	return 0;
	72	}
	73
	74	static inline int rproc_unprepare_device(struct rproc *rproc)
	75	{
	76	if (rproc->ops->unprepare)
	77	return rproc->ops->unprepare(rproc);
	78
	79	return 0;
	80	}
	81
4afc89d6 SB	82	static inline
	83	int rproc_fw_sanity_check(struct rproc rproc, const struct firmware fw)
	84	{
0f21f9cc BA	85	if (rproc->ops->sanity_check)
0f21f9cc BA	86	return rproc->ops->sanity_check(rproc, fw);
4afc89d6 SB	87
	88	return 0;
	89	}
	90
	91	static inline
e4ae4b7d	92	u64 rproc_get_boot_addr(struct rproc rproc, const struct firmware fw)
4afc89d6	93	{
0f21f9cc BA	94	if (rproc->ops->get_boot_addr)
0f21f9cc BA	95	return rproc->ops->get_boot_addr(rproc, fw);
4afc89d6 SB	96
	97	return 0;
	98	}
	99
	100	static inline
	101	int rproc_load_segments(struct rproc rproc, const struct firmware fw)
	102	{
0f21f9cc BA	103	if (rproc->ops->load)
0f21f9cc BA	104	return rproc->ops->load(rproc, fw);
4afc89d6 SB	105
	106	return -EINVAL;
	107	}
	108
c1d35c1a	109	static inline int rproc_parse_fw(struct rproc rproc, const struct firmware fw)
4afc89d6	110	{
c1d35c1a BA	111	if (rproc->ops->parse_fw)
c1d35c1a BA	112	return rproc->ops->parse_fw(rproc, fw);
4afc89d6	113
58b64090	114	return 0;
4afc89d6 SB	115	}
4afc89d6 SB	116
b1a17513 CL	117	static inline
	118	int rproc_handle_rsc(struct rproc rproc, u32 rsc_type, void rsc, int offset,
	119	int avail)
	120	{
	121	if (rproc->ops->handle_rsc)
	122	return rproc->ops->handle_rsc(rproc, rsc_type, rsc, offset,
	123	avail);
	124
	125	return RSC_IGNORED;
	126	}
	127
95f95781 SB	128	static inline
95f95781 SB	129	struct resource_table rproc_find_loaded_rsc_table(struct rproc rproc,
730f84ce	130	const struct firmware *fw)
95f95781	131	{
0f21f9cc BA	132	if (rproc->ops->find_loaded_rsc_table)
0f21f9cc BA	133	return rproc->ops->find_loaded_rsc_table(rproc, fw);
95f95781	134
57971159	135	return NULL;
95f95781 SB	136	}
95f95781 SB	137
f31e339f CL	138	static inline
	139	bool rproc_u64_fit_in_size_t(u64 val)
	140	{
	141	if (sizeof(size_t) == sizeof(u64))
	142	return true;
	143
	144	return (val <= (size_t) -1);
	145	}
	146
400e64df	147	#endif /* REMOTEPROC_INTERNAL_H */