vmw_vmci_api.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * VMware VMCI Driver
  4. *
  5. * Copyright (C) 2012 VMware, Inc. All rights reserved.
  6. */
  7. #ifndef __VMW_VMCI_API_H__
  8. #define __VMW_VMCI_API_H__
  9. #include <linux/uidgid.h>
  10. #include <linux/vmw_vmci_defs.h>
  11. #undef VMCI_KERNEL_API_VERSION
  12. #define VMCI_KERNEL_API_VERSION_1 1
  13. #define VMCI_KERNEL_API_VERSION_2 2
  14. #define VMCI_KERNEL_API_VERSION VMCI_KERNEL_API_VERSION_2
  15. struct msghdr;
  16. typedef void (vmci_device_shutdown_fn) (void *device_registration,
  17. void *user_data);
  18. typedef void (*vmci_vsock_cb) (bool is_host);
  19. int vmci_datagram_create_handle(u32 resource_id, u32 flags,
  20. vmci_datagram_recv_cb recv_cb,
  21. void *client_data,
  22. struct vmci_handle *out_handle);
  23. int vmci_datagram_create_handle_priv(u32 resource_id, u32 flags, u32 priv_flags,
  24. vmci_datagram_recv_cb recv_cb,
  25. void *client_data,
  26. struct vmci_handle *out_handle);
  27. int vmci_datagram_destroy_handle(struct vmci_handle handle);
  28. int vmci_datagram_send(struct vmci_datagram *msg);
  29. int vmci_doorbell_create(struct vmci_handle *handle, u32 flags,
  30. u32 priv_flags,
  31. vmci_callback notify_cb, void *client_data);
  32. int vmci_doorbell_destroy(struct vmci_handle handle);
  33. int vmci_doorbell_notify(struct vmci_handle handle, u32 priv_flags);
  34. u32 vmci_get_context_id(void);
  35. bool vmci_is_context_owner(u32 context_id, kuid_t uid);
  36. int vmci_register_vsock_callback(vmci_vsock_cb callback);
  37. int vmci_event_subscribe(u32 event,
  38. vmci_event_cb callback, void *callback_data,
  39. u32 *subid);
  40. int vmci_event_unsubscribe(u32 subid);
  41. u32 vmci_context_get_priv_flags(u32 context_id);
  42. int vmci_qpair_alloc(struct vmci_qp **qpair,
  43. struct vmci_handle *handle,
  44. u64 produce_qsize,
  45. u64 consume_qsize,
  46. u32 peer, u32 flags, u32 priv_flags);
  47. int vmci_qpair_detach(struct vmci_qp **qpair);
  48. int vmci_qpair_get_produce_indexes(const struct vmci_qp *qpair,
  49. u64 *producer_tail,
  50. u64 *consumer_head);
  51. int vmci_qpair_get_consume_indexes(const struct vmci_qp *qpair,
  52. u64 *consumer_tail,
  53. u64 *producer_head);
  54. s64 vmci_qpair_produce_free_space(const struct vmci_qp *qpair);
  55. s64 vmci_qpair_produce_buf_ready(const struct vmci_qp *qpair);
  56. s64 vmci_qpair_consume_free_space(const struct vmci_qp *qpair);
  57. s64 vmci_qpair_consume_buf_ready(const struct vmci_qp *qpair);
  58. ssize_t vmci_qpair_enqueue(struct vmci_qp *qpair,
  59. const void *buf, size_t buf_size, int mode);
  60. ssize_t vmci_qpair_dequeue(struct vmci_qp *qpair,
  61. void *buf, size_t buf_size, int mode);
  62. ssize_t vmci_qpair_peek(struct vmci_qp *qpair, void *buf, size_t buf_size,
  63. int mode);
  64. ssize_t vmci_qpair_enquev(struct vmci_qp *qpair,
  65. struct msghdr *msg, size_t iov_size, int mode);
  66. ssize_t vmci_qpair_dequev(struct vmci_qp *qpair,
  67. struct msghdr *msg, size_t iov_size, int mode);
  68. ssize_t vmci_qpair_peekv(struct vmci_qp *qpair, struct msghdr *msg, size_t iov_size,
  69. int mode);
  70. #endif /* !__VMW_VMCI_API_H__ */