src/vnet/devices/virtio/virtio.api

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "1.0.0";
  17
  18 /** \brief Initialize a new virtio pci interface with the given paramters
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param pci_addr - pci address as unsigned 32bit integer:
  22                       0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
  23     @param use_random_mac - let the system generate a unique mac address
  24     @param mac_address - mac addr to assign to the interface if use_radom not set
  25     @param tx_ring_sz - the number of entries of TX ring
  26     @param rx_ring_sz - the number of entries of RX ring
  27     @param features - the virtio features which driver should negotiate with device
  28 */
  29 define virtio_pci_create
  30 {
  31   u32 client_index;
  32   u32 context;
  33   u32 pci_addr;
  34   u8 use_random_mac;
  35   u8 mac_address[6];
  36   u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  37   u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  38   u64 features;
  39 };
  40
  41 /** \brief Reply for virtio pci create reply
  42     @param context - returned sender context, to match reply w/ request
  43     @param retval - return code
  44     @param sw_if_index - software index allocated for the new virtio pci interface
  45 */
  46 define virtio_pci_create_reply
  47 {
  48   u32 context;
  49   i32 retval;
  50   u32 sw_if_index;
  51 };
  52
  53 /** \brief Delete virtio pci interface
  54     @param client_index - opaque cookie to identify the sender
  55     @param context - sender context, to match reply w/ request
  56     @param sw_if_index - interface index of existing virtio pci interface
  57 */
  58 autoreply define virtio_pci_delete
  59 {
  60   u32 client_index;
  61   u32 context;
  62   u32 sw_if_index;
  63 };
  64
  65 /** \brief Dump virtio pci interfaces request */
  66 define sw_interface_virtio_pci_dump
  67 {
  68   u32 client_index;
  69   u32 context;
  70 };
  71
  72 /** \brief Reply for virtio pci interface dump request
  73     @param sw_if_index - software index of virtio pci interface
  74     @param pci_addr - pci address as unsigned 32bit integer:
  75                       0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
  76     @param mac_addr - native virtio device mac address
  77     @param tx_ring_sz - the number of entries of TX ring
  78     @param rx_ring_sz - the number of entries of RX ring
  79     @param features - the virtio features which driver have negotiated with device
  80 */
  81 define sw_interface_virtio_pci_details
  82 {
  83   u32 context;
  84   u32 sw_if_index;
  85   u32 pci_addr;
  86   u8 mac_addr[6];
  87   u16 tx_ring_sz;
  88   u16 rx_ring_sz;
  89   u64 features;
  90 };
  91
  92 /*
  93  * Local Variables:
  94  * eval: (c-set-style "gnu")
  95  * End:
  96  */