blob: a42690c514e23556498266bd5f3fd4575d3ce3a1 [file] [log] [blame]
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +02001/*
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>
Sjur Brændeland72854fb2012-07-15 11:25:27 +030024#include <linux/firmware.h>
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020025
26struct rproc;
27
28/* from remoteproc_core.c */
29void rproc_release(struct kref *kref);
30irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
Bjorn Anderssonaab8d802016-10-19 19:40:06 -070031void rproc_vdev_release(struct kref *ref);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020032
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010033/* from remoteproc_virtio.c */
34int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
35void rproc_remove_virtio_dev(struct rproc_vdev *rvdev);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020036
37/* from remoteproc_debugfs.c */
38void rproc_remove_trace_file(struct dentry *tfile);
39struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
Anna, Suman730f84c2016-08-12 18:42:20 -050040 struct rproc_mem_entry *trace);
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +020041void rproc_delete_debug_dir(struct rproc *rproc);
42void rproc_create_debug_dir(struct rproc *rproc);
43void rproc_init_debugfs(void);
44void rproc_exit_debugfs(void);
45
Matt Redfearn2aefbef2016-10-19 13:05:47 +010046/* from remoteproc_sysfs.c */
47extern struct class rproc_class;
48int rproc_init_sysfs(void);
49void rproc_exit_sysfs(void);
50
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030051void rproc_free_vring(struct rproc_vring *rvring);
52int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
Sjur Brændeland72854fb2012-07-15 11:25:27 +030053
54void *rproc_da_to_va(struct rproc *rproc, u64 da, int len);
Fernando Guzman Lugo70b85ef2012-08-30 13:26:13 -050055int rproc_trigger_recovery(struct rproc *rproc);
Sjur Brændeland72854fb2012-07-15 11:25:27 +030056
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -080057int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
58u32 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
59int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw);
60struct resource_table *rproc_elf_find_rsc_table(struct rproc *rproc,
61 const struct firmware *fw,
62 int *tablesz);
63struct resource_table *rproc_elf_find_loaded_rsc_table(struct rproc *rproc,
64 const struct firmware *fw);
65
Sjur Brændeland4afc89d2012-06-19 10:08:18 +030066static inline
67int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
68{
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -080069 if (rproc->ops->sanity_check)
70 return rproc->ops->sanity_check(rproc, fw);
Sjur Brændeland4afc89d2012-06-19 10:08:18 +030071
72 return 0;
73}
74
75static inline
76u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
77{
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -080078 if (rproc->ops->get_boot_addr)
79 return rproc->ops->get_boot_addr(rproc, fw);
Sjur Brændeland4afc89d2012-06-19 10:08:18 +030080
81 return 0;
82}
83
84static inline
85int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
86{
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -080087 if (rproc->ops->load)
88 return rproc->ops->load(rproc, fw);
Sjur Brændeland4afc89d2012-06-19 10:08:18 +030089
90 return -EINVAL;
91}
92
93static inline
Sjur Brændeland72854fb2012-07-15 11:25:27 +030094struct resource_table *rproc_find_rsc_table(struct rproc *rproc,
Anna, Suman730f84c2016-08-12 18:42:20 -050095 const struct firmware *fw,
96 int *tablesz)
Sjur Brændeland4afc89d2012-06-19 10:08:18 +030097{
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -080098 if (rproc->ops->find_rsc_table)
99 return rproc->ops->find_rsc_table(rproc, fw, tablesz);
Sjur Brændeland4afc89d2012-06-19 10:08:18 +0300100
101 return NULL;
102}
103
Sjur Brændeland95f95782013-02-21 18:15:34 +0100104static inline
105struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
Anna, Suman730f84c2016-08-12 18:42:20 -0500106 const struct firmware *fw)
Sjur Brændeland95f95782013-02-21 18:15:34 +0100107{
Bjorn Andersson0f21f9c2018-01-05 15:58:01 -0800108 if (rproc->ops->find_loaded_rsc_table)
109 return rproc->ops->find_loaded_rsc_table(rproc, fw);
Sjur Brændeland95f95782013-02-21 18:15:34 +0100110
Suman Anna57971152013-06-30 11:33:05 +0300111 return NULL;
Sjur Brændeland95f95782013-02-21 18:15:34 +0100112}
113
Ohad Ben-Cohen400e64d2011-10-20 16:52:46 +0200114#endif /* REMOTEPROC_INTERNAL_H */