drivers/remoteproc/remoteproc_internal.h

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