LXR linux/drivers/remoteproc/remoteproc

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