remoteproc_internal.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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. #ifndef REMOTEPROC_INTERNAL_H
  20. #define REMOTEPROC_INTERNAL_H
  21. #include <linux/irqreturn.h>
  22. #include <linux/firmware.h>
  23. struct rproc;
  24. /**
  25. * struct rproc_fw_ops - firmware format specific operations.
  26. * @find_rsc_table: finds the resource table inside the firmware image
  27. * @load: load firmeware to memory, where the remote processor
  28. * expects to find it
  29. * @sanity_check: sanity check the fw image
  30. * @get_boot_addr: get boot address to entry point specified in firmware
  31. */
  32. struct rproc_fw_ops {
  33. struct resource_table *(*find_rsc_table) (struct rproc *rproc,
  34. const struct firmware *fw,
  35. int *tablesz);
  36. int (*load)(struct rproc *rproc, const struct firmware *fw);
  37. int (*sanity_check)(struct rproc *rproc, const struct firmware *fw);
  38. u32 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
  39. };
  40. /* from remoteproc_core.c */
  41. void rproc_release(struct kref *kref);
  42. irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
  43. /* from remoteproc_virtio.c */
  44. int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id);
  45. void rproc_remove_virtio_dev(struct rproc_vdev *rvdev);
  46. /* from remoteproc_debugfs.c */
  47. void rproc_remove_trace_file(struct dentry *tfile);
  48. struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
  49. struct rproc_mem_entry *trace);
  50. void rproc_delete_debug_dir(struct rproc *rproc);
  51. void rproc_create_debug_dir(struct rproc *rproc);
  52. void rproc_init_debugfs(void);
  53. void rproc_exit_debugfs(void);
  54. void rproc_free_vring(struct rproc_vring *rvring);
  55. int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
  56. void *rproc_da_to_va(struct rproc *rproc, u64 da, int len);
  57. int rproc_trigger_recovery(struct rproc *rproc);
  58. static inline
  59. int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
  60. {
  61. if (rproc->fw_ops->sanity_check)
  62. return rproc->fw_ops->sanity_check(rproc, fw);
  63. return 0;
  64. }
  65. static inline
  66. u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
  67. {
  68. if (rproc->fw_ops->get_boot_addr)
  69. return rproc->fw_ops->get_boot_addr(rproc, fw);
  70. return 0;
  71. }
  72. static inline
  73. int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
  74. {
  75. if (rproc->fw_ops->load)
  76. return rproc->fw_ops->load(rproc, fw);
  77. return -EINVAL;
  78. }
  79. static inline
  80. struct resource_table *rproc_find_rsc_table(struct rproc *rproc,
  81. const struct firmware *fw, int *tablesz)
  82. {
  83. if (rproc->fw_ops->find_rsc_table)
  84. return rproc->fw_ops->find_rsc_table(rproc, fw, tablesz);
  85. return NULL;
  86. }
  87. extern const struct rproc_fw_ops rproc_elf_fw_ops;
  88. #endif /* REMOTEPROC_INTERNAL_H */