2 * Remote processor framework
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Copyright (C) 2011 Google, Inc.
7 * Ohad Ben-Cohen <ohad@wizery.com>
8 * Brian Swetland <swetland@google.com>
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.
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.
20 #ifndef REMOTEPROC_INTERNAL_H
21 #define REMOTEPROC_INTERNAL_H
23 #include <linux/irqreturn.h>
24 #include <linux/firmware.h>
29 * struct rproc_fw_ops - firmware format specific operations.
30 * @find_rsc_table: find the resource table inside the firmware image
31 * @find_loaded_rsc_table: find the loaded resouce table
32 * @load: load firmeware to memory, where the remote processor
34 * @sanity_check: sanity check the fw image
35 * @get_boot_addr: get boot address to entry point specified in firmware
38 struct resource_table *(*find_rsc_table)(struct rproc *rproc,
39 const struct firmware *fw,
41 struct resource_table *(*find_loaded_rsc_table)(
42 struct rproc *rproc, const struct firmware *fw);
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);
48 /* from remoteproc_core.c */
49 void rproc_release(struct kref *kref);
50 irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
51 void rproc_vdev_release(struct kref *ref);
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);
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,
60 struct rproc_mem_entry *trace);
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);
66 /* from remoteproc_sysfs.c */
67 extern struct class rproc_class;
68 int rproc_init_sysfs(void);
69 void rproc_exit_sysfs(void);
71 void rproc_free_vring(struct rproc_vring *rvring);
72 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
74 void *rproc_da_to_va(struct rproc *rproc, u64 da, int len);
75 int rproc_trigger_recovery(struct rproc *rproc);
78 int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
80 if (rproc->fw_ops->sanity_check)
81 return rproc->fw_ops->sanity_check(rproc, fw);
87 u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
89 if (rproc->fw_ops->get_boot_addr)
90 return rproc->fw_ops->get_boot_addr(rproc, fw);
96 int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
98 if (rproc->fw_ops->load)
99 return rproc->fw_ops->load(rproc, fw);
105 struct resource_table *rproc_find_rsc_table(struct rproc *rproc,
106 const struct firmware *fw,
109 if (rproc->fw_ops->find_rsc_table)
110 return rproc->fw_ops->find_rsc_table(rproc, fw, tablesz);
116 struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
117 const struct firmware *fw)
119 if (rproc->fw_ops->find_loaded_rsc_table)
120 return rproc->fw_ops->find_loaded_rsc_table(rproc, fw);
125 extern const struct rproc_fw_ops rproc_elf_fw_ops;
127 #endif /* REMOTEPROC_INTERNAL_H */