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>
24#include <linux/firmware.h>
25
26struct rproc;
27
28struct rproc_debug_trace {
29 struct rproc *rproc;
30 struct dentry *tfile;
31 struct list_head node;
32 struct rproc_mem_entry trace_mem;
33};
34
35/* from remoteproc_core.c */
36void rproc_release(struct kref *kref);
37irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
38void rproc_vdev_release(struct kref *ref);
39
40/* from remoteproc_virtio.c */
41int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
42int rproc_remove_virtio_dev(struct device *dev, void *data);
43
44/* from remoteproc_debugfs.c */
45void rproc_remove_trace_file(struct dentry *tfile);
46struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
47 struct rproc_debug_trace *trace);
48void rproc_delete_debug_dir(struct rproc *rproc);
49void rproc_create_debug_dir(struct rproc *rproc);
50void rproc_init_debugfs(void);
51void rproc_exit_debugfs(void);
52
53/* from remoteproc_sysfs.c */
54extern struct class rproc_class;
55int rproc_init_sysfs(void);
56void rproc_exit_sysfs(void);
57
58void rproc_free_vring(struct rproc_vring *rvring);
59int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
60
61void *rproc_da_to_va(struct rproc *rproc, u64 da, int len);
62phys_addr_t rproc_va_to_pa(void *cpu_addr);
63int rproc_trigger_recovery(struct rproc *rproc);
64
65int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
66u32 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
67int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw);
68int rproc_elf_load_rsc_table(struct rproc *rproc, const struct firmware *fw);
69struct resource_table *rproc_elf_find_loaded_rsc_table(struct rproc *rproc,
70 const struct firmware *fw);
71struct rproc_mem_entry *
72rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...);
73
74static inline
75int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
76{
77 if (rproc->ops->sanity_check)
78 return rproc->ops->sanity_check(rproc, fw);
79
80 return 0;
81}
82
83static inline
84u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
85{
86 if (rproc->ops->get_boot_addr)
87 return rproc->ops->get_boot_addr(rproc, fw);
88
89 return 0;
90}
91
92static inline
93int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
94{
95 if (rproc->ops->load)
96 return rproc->ops->load(rproc, fw);
97
98 return -EINVAL;
99}
100
101static inline int rproc_parse_fw(struct rproc *rproc, const struct firmware *fw)
102{
103 if (rproc->ops->parse_fw)
104 return rproc->ops->parse_fw(rproc, fw);
105
106 return 0;
107}
108
109static inline
110struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
111 const struct firmware *fw)
112{
113 if (rproc->ops->find_loaded_rsc_table)
114 return rproc->ops->find_loaded_rsc_table(rproc, fw);
115
116 return NULL;
117}
118
119#endif /* REMOTEPROC_INTERNAL_H */
120