drivers/remoteproc/remoteproc_internal.h

   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
  32 /* from remoteproc_virtio.c */
  33 int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
  34 int rproc_remove_virtio_dev(struct device *dev, void *data);
  35
  36 /* from remoteproc_debugfs.c */
  37 void rproc_remove_trace_file(struct dentry *tfile);
  38 struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
  39                                        struct rproc_debug_trace *trace);
  40 void rproc_delete_debug_dir(struct rproc *rproc);
  41 void rproc_create_debug_dir(struct rproc *rproc);
  42 void rproc_init_debugfs(void);
  43 void rproc_exit_debugfs(void);
  44
  45 /* from remoteproc_sysfs.c */
  46 extern struct class rproc_class;
  47 int rproc_init_sysfs(void);
  48 void rproc_exit_sysfs(void);
  49
  50 void rproc_free_vring(struct rproc_vring *rvring);
  51 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
  52
  53 void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len);
  54 phys_addr_t rproc_va_to_pa(void *cpu_addr);
  55 int rproc_trigger_recovery(struct rproc *rproc);
  56
  57 int rproc_elf32_sanity_check(struct rproc *rproc, const struct firmware *fw);
  58 int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
  59 u64 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
  60 int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw);
  61 int rproc_elf_load_rsc_table(struct rproc *rproc, const struct firmware *fw);
  62 struct resource_table *rproc_elf_find_loaded_rsc_table(struct rproc *rproc,
  63                                                        const struct firmware *fw);
  64 struct rproc_mem_entry *
  65 rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...);
  66
  67 static inline
  68 int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
  69 {
  70         if (rproc->ops->sanity_check)
  71                 return rproc->ops->sanity_check(rproc, fw);
  72
  73         return 0;
  74 }
  75
  76 static inline
  77 u64 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
  78 {
  79         if (rproc->ops->get_boot_addr)
  80                 return rproc->ops->get_boot_addr(rproc, fw);
  81
  82         return 0;
  83 }
  84
  85 static inline
  86 int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
  87 {
  88         if (rproc->ops->load)
  89                 return rproc->ops->load(rproc, fw);
  90
  91         return -EINVAL;
  92 }
  93
  94 static inline int rproc_parse_fw(struct rproc *rproc, const struct firmware *fw)
  95 {
  96         if (rproc->ops->parse_fw)
  97                 return rproc->ops->parse_fw(rproc, fw);
  98
  99         return 0;
 100 }
 101
 102 static inline
 103 int rproc_handle_rsc(struct rproc *rproc, u32 rsc_type, void *rsc, int offset,
 104                      int avail)
 105 {
 106         if (rproc->ops->handle_rsc)
 107                 return rproc->ops->handle_rsc(rproc, rsc_type, rsc, offset,
 108                                               avail);
 109
 110         return RSC_IGNORED;
 111 }
 112
 113 static inline
 114 struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
 115                                                    const struct firmware *fw)
 116 {
 117         if (rproc->ops->find_loaded_rsc_table)
 118                 return rproc->ops->find_loaded_rsc_table(rproc, fw);
 119
 120         return NULL;
 121 }
 122
 123 static inline
 124 bool rproc_u64_fit_in_size_t(u64 val)
 125 {
 126         if (sizeof(size_t) == sizeof(u64))
 127                 return true;
 128
 129         return (val <= (size_t) -1);
 130 }
 131
 132 #endif /* REMOTEPROC_INTERNAL_H */