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