drivers/bus/vmbus/private.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright (c) 2018, Microsoft Corporation.
   3  * All Rights Reserved.
   4  */
   5
   6 #ifndef _VMBUS_PRIVATE_H_
   7 #define _VMBUS_PRIVATE_H_
   8
   9 #include <stdbool.h>
  10 #include <sys/uio.h>
  11 #include <rte_log.h>
  12 #include <rte_vmbus_reg.h>
  13
  14 #ifndef PAGE_SIZE
  15 #define PAGE_SIZE       4096
  16 #endif
  17
  18 extern int vmbus_logtype_bus;
  19 #define VMBUS_LOG(level, fmt, args...) \
  20         rte_log(RTE_LOG_ ## level, vmbus_logtype_bus, "%s(): " fmt "\n", \
  21                 __func__, ##args)
  22
  23 struct vmbus_br {
  24         struct vmbus_bufring *vbr;
  25         uint32_t        dsize;
  26         uint32_t        windex; /* next available location */
  27 };
  28
  29 #define UIO_NAME_MAX 64
  30
  31 struct vmbus_map {
  32         void *addr;     /* user mmap of resource */
  33         uint64_t size;  /* length */
  34 };
  35
  36 /*
  37  * For multi-process we need to reproduce all vmbus mappings in secondary
  38  * processes, so save them in a tailq.
  39  */
  40 struct mapped_vmbus_resource {
  41         TAILQ_ENTRY(mapped_vmbus_resource) next;
  42
  43         rte_uuid_t id;
  44         int nb_maps;
  45         struct vmbus_map maps[VMBUS_MAX_RESOURCE];
  46         char path[PATH_MAX];
  47 };
  48
  49 TAILQ_HEAD(mapped_vmbus_res_list, mapped_vmbus_resource);
  50
  51 #define HV_MON_TRIG_LEN 32
  52 #define HV_MON_TRIG_MAX 4
  53
  54 struct vmbus_channel {
  55         STAILQ_HEAD(, vmbus_channel) subchannel_list;
  56         STAILQ_ENTRY(vmbus_channel) next;
  57         const struct rte_vmbus_device *device;
  58
  59         struct vmbus_br rxbr;
  60         struct vmbus_br txbr;
  61
  62         uint16_t relid;
  63         uint16_t subchannel_id;
  64         uint8_t monitor_id;
  65 };
  66
  67 #define VMBUS_MAX_CHANNELS      64
  68
  69 struct rte_devargs *
  70 vmbus_devargs_lookup(struct rte_vmbus_device *dev);
  71
  72 int vmbus_chan_create(const struct rte_vmbus_device *device,
  73                       uint16_t relid, uint16_t subid, uint8_t monitor_id,
  74                       struct vmbus_channel **new_chan);
  75
  76 void vmbus_add_device(struct rte_vmbus_device *vmbus_dev);
  77 void vmbus_insert_device(struct rte_vmbus_device *exist_vmbus_dev,
  78                          struct rte_vmbus_device *new_vmbus_dev);
  79 void vmbus_remove_device(struct rte_vmbus_device *vmbus_device);
  80
  81 void vmbus_uio_irq_control(struct rte_vmbus_device *dev, int32_t onoff);
  82 int vmbus_uio_irq_read(struct rte_vmbus_device *dev);
  83
  84 int vmbus_uio_map_resource(struct rte_vmbus_device *dev);
  85 void vmbus_uio_unmap_resource(struct rte_vmbus_device *dev);
  86
  87 int vmbus_uio_alloc_resource(struct rte_vmbus_device *dev,
  88                 struct mapped_vmbus_resource **uio_res);
  89 void vmbus_uio_free_resource(struct rte_vmbus_device *dev,
  90                 struct mapped_vmbus_resource *uio_res);
  91
  92 struct mapped_vmbus_resource *
  93 vmbus_uio_find_resource(const struct rte_vmbus_device *dev);
  94 int vmbus_uio_map_resource_by_index(struct rte_vmbus_device *dev, int res_idx,
  95                                     struct mapped_vmbus_resource *uio_res,
  96                                     int flags);
  97
  98 void *vmbus_map_resource(void *requested_addr, int fd, off_t offset,
  99                 size_t size, int additional_flags);
 100 void vmbus_unmap_resource(void *requested_addr, size_t size);
 101
 102 bool vmbus_uio_subchannels_supported(const struct rte_vmbus_device *dev,
 103                                      const struct vmbus_channel *chan);
 104 int vmbus_uio_get_subchan(struct vmbus_channel *primary,
 105                           struct vmbus_channel **subchan);
 106 int vmbus_uio_map_rings(struct vmbus_channel *chan);
 107
 108 void vmbus_br_setup(struct vmbus_br *br, void *buf, unsigned int blen);
 109
 110 /* Amount of space available for write */
 111 static inline uint32_t
 112 vmbus_br_availwrite(const struct vmbus_br *br, uint32_t windex)
 113 {
 114         uint32_t rindex = br->vbr->rindex;
 115
 116         if (windex >= rindex)
 117                 return br->dsize - (windex - rindex);
 118         else
 119                 return rindex - windex;
 120 }
 121
 122 static inline uint32_t
 123 vmbus_br_availread(const struct vmbus_br *br)
 124 {
 125         return br->dsize - vmbus_br_availwrite(br, br->vbr->windex);
 126 }
 127
 128 int vmbus_txbr_write(struct vmbus_br *tbr, const struct iovec iov[], int iovlen,
 129                      bool *need_sig);
 130
 131 int vmbus_rxbr_peek(const struct vmbus_br *rbr, void *data, size_t dlen);
 132
 133 int vmbus_rxbr_read(struct vmbus_br *rbr, void *data, size_t dlen, size_t hlen);
 134
 135 #endif /* _VMBUS_PRIVATE_H_ */