xref: /linux-6.15/include/linux/vmw_vmci_api.h (revision b1bba80a)
1685a6bf8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
220259849SGeorge Zhang /*
320259849SGeorge Zhang  * VMware VMCI Driver
420259849SGeorge Zhang  *
520259849SGeorge Zhang  * Copyright (C) 2012 VMware, Inc. All rights reserved.
620259849SGeorge Zhang  */
720259849SGeorge Zhang 
820259849SGeorge Zhang #ifndef __VMW_VMCI_API_H__
920259849SGeorge Zhang #define __VMW_VMCI_API_H__
1020259849SGeorge Zhang 
1120259849SGeorge Zhang #include <linux/uidgid.h>
1220259849SGeorge Zhang #include <linux/vmw_vmci_defs.h>
1320259849SGeorge Zhang 
1420259849SGeorge Zhang #undef  VMCI_KERNEL_API_VERSION
1520259849SGeorge Zhang #define VMCI_KERNEL_API_VERSION_1 1
1620259849SGeorge Zhang #define VMCI_KERNEL_API_VERSION_2 2
1720259849SGeorge Zhang #define VMCI_KERNEL_API_VERSION   VMCI_KERNEL_API_VERSION_2
1820259849SGeorge Zhang 
19d838df2eSAl Viro struct msghdr;
2020259849SGeorge Zhang typedef void (vmci_device_shutdown_fn) (void *device_registration,
2120259849SGeorge Zhang 					void *user_data);
22*b1bba80aSStefano Garzarella typedef void (*vmci_vsock_cb) (bool is_host);
2320259849SGeorge Zhang 
2420259849SGeorge Zhang int vmci_datagram_create_handle(u32 resource_id, u32 flags,
2520259849SGeorge Zhang 				vmci_datagram_recv_cb recv_cb,
2620259849SGeorge Zhang 				void *client_data,
2720259849SGeorge Zhang 				struct vmci_handle *out_handle);
2820259849SGeorge Zhang int vmci_datagram_create_handle_priv(u32 resource_id, u32 flags, u32 priv_flags,
2920259849SGeorge Zhang 				     vmci_datagram_recv_cb recv_cb,
3020259849SGeorge Zhang 				     void *client_data,
3120259849SGeorge Zhang 				     struct vmci_handle *out_handle);
3220259849SGeorge Zhang int vmci_datagram_destroy_handle(struct vmci_handle handle);
3320259849SGeorge Zhang int vmci_datagram_send(struct vmci_datagram *msg);
3420259849SGeorge Zhang int vmci_doorbell_create(struct vmci_handle *handle, u32 flags,
3520259849SGeorge Zhang 			 u32 priv_flags,
3620259849SGeorge Zhang 			 vmci_callback notify_cb, void *client_data);
3720259849SGeorge Zhang int vmci_doorbell_destroy(struct vmci_handle handle);
3820259849SGeorge Zhang int vmci_doorbell_notify(struct vmci_handle handle, u32 priv_flags);
3920259849SGeorge Zhang u32 vmci_get_context_id(void);
4020259849SGeorge Zhang bool vmci_is_context_owner(u32 context_id, kuid_t uid);
41*b1bba80aSStefano Garzarella int vmci_register_vsock_callback(vmci_vsock_cb callback);
4220259849SGeorge Zhang 
4320259849SGeorge Zhang int vmci_event_subscribe(u32 event,
4420259849SGeorge Zhang 			 vmci_event_cb callback, void *callback_data,
4520259849SGeorge Zhang 			 u32 *subid);
4620259849SGeorge Zhang int vmci_event_unsubscribe(u32 subid);
4720259849SGeorge Zhang u32 vmci_context_get_priv_flags(u32 context_id);
4820259849SGeorge Zhang int vmci_qpair_alloc(struct vmci_qp **qpair,
4920259849SGeorge Zhang 		     struct vmci_handle *handle,
5020259849SGeorge Zhang 		     u64 produce_qsize,
5120259849SGeorge Zhang 		     u64 consume_qsize,
5220259849SGeorge Zhang 		     u32 peer, u32 flags, u32 priv_flags);
5320259849SGeorge Zhang int vmci_qpair_detach(struct vmci_qp **qpair);
5420259849SGeorge Zhang int vmci_qpair_get_produce_indexes(const struct vmci_qp *qpair,
5520259849SGeorge Zhang 				   u64 *producer_tail,
5620259849SGeorge Zhang 				   u64 *consumer_head);
5720259849SGeorge Zhang int vmci_qpair_get_consume_indexes(const struct vmci_qp *qpair,
5820259849SGeorge Zhang 				   u64 *consumer_tail,
5920259849SGeorge Zhang 				   u64 *producer_head);
6020259849SGeorge Zhang s64 vmci_qpair_produce_free_space(const struct vmci_qp *qpair);
6120259849SGeorge Zhang s64 vmci_qpair_produce_buf_ready(const struct vmci_qp *qpair);
6220259849SGeorge Zhang s64 vmci_qpair_consume_free_space(const struct vmci_qp *qpair);
6320259849SGeorge Zhang s64 vmci_qpair_consume_buf_ready(const struct vmci_qp *qpair);
6420259849SGeorge Zhang ssize_t vmci_qpair_enqueue(struct vmci_qp *qpair,
6520259849SGeorge Zhang 			   const void *buf, size_t buf_size, int mode);
6620259849SGeorge Zhang ssize_t vmci_qpair_dequeue(struct vmci_qp *qpair,
6720259849SGeorge Zhang 			   void *buf, size_t buf_size, int mode);
6820259849SGeorge Zhang ssize_t vmci_qpair_peek(struct vmci_qp *qpair, void *buf, size_t buf_size,
6920259849SGeorge Zhang 			int mode);
7020259849SGeorge Zhang ssize_t vmci_qpair_enquev(struct vmci_qp *qpair,
714c946d9cSAl Viro 			  struct msghdr *msg, size_t iov_size, int mode);
7220259849SGeorge Zhang ssize_t vmci_qpair_dequev(struct vmci_qp *qpair,
73d838df2eSAl Viro 			  struct msghdr *msg, size_t iov_size, int mode);
74d838df2eSAl Viro ssize_t vmci_qpair_peekv(struct vmci_qp *qpair, struct msghdr *msg, size_t iov_size,
7520259849SGeorge Zhang 			 int mode);
7620259849SGeorge Zhang 
7720259849SGeorge Zhang #endif /* !__VMW_VMCI_API_H__ */
78