Zephyr Project API  3.3.0
A Scalable Open Source RTOS
ivshmem.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_DRIVERS_VIRTUALIZATION_IVSHMEM_H_
8#define ZEPHYR_INCLUDE_DRIVERS_VIRTUALIZATION_IVSHMEM_H_
9
16#include <zephyr/types.h>
17#include <stddef.h>
18#include <zephyr/device.h>
19#include <zephyr/kernel.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25typedef size_t (*ivshmem_get_mem_f)(const struct device *dev,
26 uintptr_t *memmap);
27
28typedef uint32_t (*ivshmem_get_id_f)(const struct device *dev);
29
30typedef uint16_t (*ivshmem_get_vectors_f)(const struct device *dev);
31
32typedef int (*ivshmem_int_peer_f)(const struct device *dev,
33 uint32_t peer_id, uint16_t vector);
34
35typedef int (*ivshmem_register_handler_f)(const struct device *dev,
36 struct k_poll_signal *signal,
37 uint16_t vector);
38
39__subsystem struct ivshmem_driver_api {
45};
46
55__syscall size_t ivshmem_get_mem(const struct device *dev,
56 uintptr_t *memmap);
57
58static inline size_t z_impl_ivshmem_get_mem(const struct device *dev,
59 uintptr_t *memmap)
60{
61 const struct ivshmem_driver_api *api =
62 (const struct ivshmem_driver_api *)dev->api;
63
64 return api->get_mem(dev, memmap);
65}
66
74__syscall uint32_t ivshmem_get_id(const struct device *dev);
75
76static inline uint32_t z_impl_ivshmem_get_id(const struct device *dev)
77{
78 const struct ivshmem_driver_api *api =
79 (const struct ivshmem_driver_api *)dev->api;
80
81 return api->get_id(dev);
82}
83
91__syscall uint16_t ivshmem_get_vectors(const struct device *dev);
92
93static inline uint16_t z_impl_ivshmem_get_vectors(const struct device *dev)
94{
95 const struct ivshmem_driver_api *api =
96 (const struct ivshmem_driver_api *)dev->api;
97
98 return api->get_vectors(dev);
99}
100
110__syscall int ivshmem_int_peer(const struct device *dev,
111 uint32_t peer_id, uint16_t vector);
112
113static inline int z_impl_ivshmem_int_peer(const struct device *dev,
114 uint32_t peer_id, uint16_t vector)
115{
116 const struct ivshmem_driver_api *api =
117 (const struct ivshmem_driver_api *)dev->api;
118
119 return api->int_peer(dev, peer_id, vector);
120}
121
137__syscall int ivshmem_register_handler(const struct device *dev,
138 struct k_poll_signal *signal,
139 uint16_t vector);
140
141static inline int z_impl_ivshmem_register_handler(const struct device *dev,
142 struct k_poll_signal *signal,
143 uint16_t vector)
144{
145 const struct ivshmem_driver_api *api =
146 (const struct ivshmem_driver_api *)dev->api;
147
148 return api->register_handler(dev, signal, vector);
149}
150
151#ifdef __cplusplus
152}
153#endif
154
159#include <syscalls/ivshmem.h>
160
161#endif /* ZEPHYR_INCLUDE_DRIVERS_VIRTUALIZATION_IVSHMEM_H_ */
int(* ivshmem_int_peer_f)(const struct device *dev, uint32_t peer_id, uint16_t vector)
Definition: ivshmem.h:32
uint16_t(* ivshmem_get_vectors_f)(const struct device *dev)
Definition: ivshmem.h:30
int(* ivshmem_register_handler_f)(const struct device *dev, struct k_poll_signal *signal, uint16_t vector)
Definition: ivshmem.h:35
int ivshmem_register_handler(const struct device *dev, struct k_poll_signal *signal, uint16_t vector)
Register a vector notification (interrupt) handler.
uint32_t(* ivshmem_get_id_f)(const struct device *dev)
Definition: ivshmem.h:28
uint32_t ivshmem_get_id(const struct device *dev)
Get our VM ID.
int ivshmem_int_peer(const struct device *dev, uint32_t peer_id, uint16_t vector)
Interrupt another VM.
size_t ivshmem_get_mem(const struct device *dev, uintptr_t *memmap)
Get the inter-VM shared memory.
size_t(* ivshmem_get_mem_f)(const struct device *dev, uintptr_t *memmap)
Definition: ivshmem.h:25
uint16_t ivshmem_get_vectors(const struct device *dev)
Get the number of interrupt vectors we can use.
Public kernel APIs.
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINTPTR_TYPE__ uintptr_t
Definition: stdint.h:105
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition: device.h:378
const void * api
Definition: device.h:384
Definition: ivshmem.h:39
ivshmem_register_handler_f register_handler
Definition: ivshmem.h:44
ivshmem_get_id_f get_id
Definition: ivshmem.h:41
ivshmem_int_peer_f int_peer
Definition: ivshmem.h:43
ivshmem_get_vectors_f get_vectors
Definition: ivshmem.h:42
ivshmem_get_mem_f get_mem
Definition: ivshmem.h:40
Definition: kernel.h:5459
static struct k_poll_signal signal
Definition: test_poll.c:704