rpmsg_internal.h 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * remote processor messaging bus internals
  4. *
  5. * Copyright (c) 2020 The Linux Foundation.
  6. * Copyright (C) 2011 Texas Instruments, Inc.
  7. * Copyright (C) 2011 Google, Inc.
  8. *
  9. * Ohad Ben-Cohen <ohad@wizery.com>
  10. * Brian Swetland <swetland@google.com>
  11. */
  12. #ifndef __RPMSG_INTERNAL_H__
  13. #define __RPMSG_INTERNAL_H__
  14. #include <linux/rpmsg.h>
  15. #include <linux/poll.h>
  16. #define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
  17. #define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)
  18. /**
  19. * struct rpmsg_device_ops - indirection table for the rpmsg_device operations
  20. * @create_ept: create backend-specific endpoint, required
  21. * @announce_create: announce presence of new channel, optional
  22. * @announce_destroy: announce destruction of channel, optional
  23. *
  24. * Indirection table for the operations that a rpmsg backend should implement.
  25. * @announce_create and @announce_destroy are optional as the backend might
  26. * advertise new channels implicitly by creating the endpoints.
  27. */
  28. struct rpmsg_device_ops {
  29. struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
  30. rpmsg_rx_cb_t cb, void *priv,
  31. struct rpmsg_channel_info chinfo);
  32. int (*announce_create)(struct rpmsg_device *ept);
  33. int (*announce_destroy)(struct rpmsg_device *ept);
  34. };
  35. /**
  36. * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
  37. * @destroy_ept: see @rpmsg_destroy_ept(), required
  38. * @send: see @rpmsg_send(), required
  39. * @sendto: see @rpmsg_sendto(), optional
  40. * @send_offchannel: see @rpmsg_send_offchannel(), optional
  41. * @trysend: see @rpmsg_trysend(), required
  42. * @trysendto: see @rpmsg_trysendto(), optional
  43. * @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional
  44. * @poll: see @rpmsg_poll(), optional
  45. * @get_signals: see @rpmsg_get_signals(), optional
  46. * @set_signals: see @rpmsg_set_signals(), optional
  47. *
  48. * Indirection table for the operations that a rpmsg backend should implement.
  49. * In addition to @destroy_ept, the backend must at least implement @send and
  50. * @trysend, while the variants sending data off-channel are optional.
  51. */
  52. struct rpmsg_endpoint_ops {
  53. void (*destroy_ept)(struct rpmsg_endpoint *ept);
  54. int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
  55. int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
  56. int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
  57. void *data, int len);
  58. int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
  59. int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
  60. int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
  61. void *data, int len);
  62. __poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
  63. poll_table *wait);
  64. int (*get_signals)(struct rpmsg_endpoint *ept);
  65. int (*set_signals)(struct rpmsg_endpoint *ept, u32 set, u32 clear);
  66. };
  67. int rpmsg_register_device(struct rpmsg_device *rpdev);
  68. int rpmsg_unregister_device(struct device *parent,
  69. struct rpmsg_channel_info *chinfo);
  70. struct device *rpmsg_find_device(struct device *parent,
  71. struct rpmsg_channel_info *chinfo);
  72. /**
  73. * rpmsg_chrdev_register_device() - register chrdev device based on rpdev
  74. * @rpdev: prepared rpdev to be used for creating endpoints
  75. *
  76. * This function wraps rpmsg_register_device() preparing the rpdev for use as
  77. * basis for the rpmsg chrdev.
  78. */
  79. static inline int rpmsg_chrdev_register_device(struct rpmsg_device *rpdev)
  80. {
  81. strcpy(rpdev->id.name, "rpmsg_chrdev");
  82. rpdev->driver_override = "rpmsg_chrdev";
  83. return rpmsg_register_device(rpdev);
  84. }
  85. #endif