remoteproc_internal.h 3.6 KB

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