1 /* SPDX-License-Identifier: GPL-2.0-only */
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>
10 */
11
12 #ifndef REMOTEPROC_INTERNAL_H
13 #define REMOTEPROC_INTERNAL_H
14
15 #include <linux/irqreturn.h>
16 #include <linux/firmware.h>
17
18 struct rproc;
19
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
27 /* from remoteproc_core.c */
28 void rproc_release(struct kref *kref);
29 irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
30 void rproc_vdev_release(struct kref *ref);
31 int rproc_of_parse_firmware(struct device *dev, int index,
32 const char **fw_name);
33
34 /* from remoteproc_virtio.c */
35 int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
36 int rproc_remove_virtio_dev(struct device *dev, void *data);
37
38 /* from remoteproc_debugfs.c */
39 void rproc_remove_trace_file(struct dentry *tfile);
40 struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
41 struct rproc_debug_trace *trace);
42 void rproc_delete_debug_dir(struct rproc *rproc);
43 void rproc_create_debug_dir(struct rproc *rproc);
44 void rproc_init_debugfs(void);
45 void rproc_exit_debugfs(void);
46
47 /* from remoteproc_sysfs.c */
48 extern struct class rproc_class;
49 int rproc_init_sysfs(void);
50 void rproc_exit_sysfs(void);
51
52 #ifdef CONFIG_REMOTEPROC_CDEV
53 void rproc_init_cdev(void);
54 void rproc_exit_cdev(void);
55 int rproc_char_device_add(struct rproc *rproc);
56 void rproc_char_device_remove(struct rproc *rproc);
57 #else
rproc_init_cdev(void)58 static inline void rproc_init_cdev(void)
59 {
60 }
61
rproc_exit_cdev(void)62 static inline void rproc_exit_cdev(void)
63 {
64 }
65
66 /*
67 * The character device interface is an optional feature, if it is not enabled
68 * the function should not return an error.
69 */
rproc_char_device_add(struct rproc * rproc)70 static inline int rproc_char_device_add(struct rproc *rproc)
71 {
72 return 0;
73 }
74
rproc_char_device_remove(struct rproc * rproc)75 static inline void rproc_char_device_remove(struct rproc *rproc)
76 {
77 }
78 #endif
79
80 void rproc_free_vring(struct rproc_vring *rvring);
81 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
82
83 void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem);
84 phys_addr_t rproc_va_to_pa(void *cpu_addr);
85 int rproc_trigger_recovery(struct rproc *rproc);
86
87 int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
88 u64 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
89 int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw);
90 int rproc_elf_load_rsc_table(struct rproc *rproc, const struct firmware *fw);
91 struct resource_table *rproc_elf_find_loaded_rsc_table(struct rproc *rproc,
92 const struct firmware *fw);
93 struct rproc_mem_entry *
94 rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...);
95
rproc_prepare_device(struct rproc * rproc)96 static inline int rproc_prepare_device(struct rproc *rproc)
97 {
98 if (rproc->ops->prepare)
99 return rproc->ops->prepare(rproc);
100
101 return 0;
102 }
103
rproc_unprepare_device(struct rproc * rproc)104 static inline int rproc_unprepare_device(struct rproc *rproc)
105 {
106 if (rproc->ops->unprepare)
107 return rproc->ops->unprepare(rproc);
108
109 return 0;
110 }
111
rproc_attach_device(struct rproc * rproc)112 static inline int rproc_attach_device(struct rproc *rproc)
113 {
114 if (rproc->ops->attach)
115 return rproc->ops->attach(rproc);
116
117 return 0;
118 }
119
120 static inline
rproc_fw_sanity_check(struct rproc * rproc,const struct firmware * fw)121 int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
122 {
123 if (rproc->ops->sanity_check)
124 return rproc->ops->sanity_check(rproc, fw);
125
126 return 0;
127 }
128
129 static inline
rproc_get_boot_addr(struct rproc * rproc,const struct firmware * fw)130 u64 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
131 {
132 if (rproc->ops->get_boot_addr)
133 return rproc->ops->get_boot_addr(rproc, fw);
134
135 return 0;
136 }
137
138 static inline
rproc_load_segments(struct rproc * rproc,const struct firmware * fw)139 int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
140 {
141 if (rproc->ops->load)
142 return rproc->ops->load(rproc, fw);
143
144 return -EINVAL;
145 }
146
rproc_parse_fw(struct rproc * rproc,const struct firmware * fw)147 static inline int rproc_parse_fw(struct rproc *rproc, const struct firmware *fw)
148 {
149 if (rproc->ops->parse_fw)
150 return rproc->ops->parse_fw(rproc, fw);
151
152 return 0;
153 }
154
155 static inline
rproc_handle_rsc(struct rproc * rproc,u32 rsc_type,void * rsc,int offset,int avail)156 int rproc_handle_rsc(struct rproc *rproc, u32 rsc_type, void *rsc, int offset,
157 int avail)
158 {
159 if (rproc->ops->handle_rsc)
160 return rproc->ops->handle_rsc(rproc, rsc_type, rsc, offset,
161 avail);
162
163 return RSC_IGNORED;
164 }
165
166 static inline
rproc_find_loaded_rsc_table(struct rproc * rproc,const struct firmware * fw)167 struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
168 const struct firmware *fw)
169 {
170 if (rproc->ops->find_loaded_rsc_table)
171 return rproc->ops->find_loaded_rsc_table(rproc, fw);
172
173 return NULL;
174 }
175
176 static inline
rproc_u64_fit_in_size_t(u64 val)177 bool rproc_u64_fit_in_size_t(u64 val)
178 {
179 if (sizeof(size_t) == sizeof(u64))
180 return true;
181
182 return (val <= (size_t) -1);
183 }
184
185 #endif /* REMOTEPROC_INTERNAL_H */
186