logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

virtio_pci.h (9631B)


  1. /*
  2. * Virtio PCI driver
  3. *
  4. * This module allows virtio devices to be used over a virtual PCI device.
  5. * This can be used with QEMU based VMMs like KVM or Xen.
  6. *
  7. * Copyright IBM Corp. 2007
  8. *
  9. * Authors:
  10. * Anthony Liguori <aliguori@us.ibm.com>
  11. *
  12. * This header is BSD licensed so anyone can use the definitions to implement
  13. * compatible drivers/servers.
  14. *
  15. * Redistribution and use in source and binary forms, with or without
  16. * modification, are permitted provided that the following conditions
  17. * are met:
  18. * 1. Redistributions of source code must retain the above copyright
  19. * notice, this list of conditions and the following disclaimer.
  20. * 2. Redistributions in binary form must reproduce the above copyright
  21. * notice, this list of conditions and the following disclaimer in the
  22. * documentation and/or other materials provided with the distribution.
  23. * 3. Neither the name of IBM nor the names of its contributors
  24. * may be used to endorse or promote products derived from this software
  25. * without specific prior written permission.
  26. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
  27. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29. * ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
  30. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36. * SUCH DAMAGE.
  37. */
  38. #ifndef _LINUX_VIRTIO_PCI_H
  39. #define _LINUX_VIRTIO_PCI_H
  40. #include <linux/types.h>
  41. #ifndef VIRTIO_PCI_NO_LEGACY
  42. /* A 32-bit r/o bitmask of the features supported by the host */
  43. #define VIRTIO_PCI_HOST_FEATURES 0
  44. /* A 32-bit r/w bitmask of features activated by the guest */
  45. #define VIRTIO_PCI_GUEST_FEATURES 4
  46. /* A 32-bit r/w PFN for the currently selected queue */
  47. #define VIRTIO_PCI_QUEUE_PFN 8
  48. /* A 16-bit r/o queue size for the currently selected queue */
  49. #define VIRTIO_PCI_QUEUE_NUM 12
  50. /* A 16-bit r/w queue selector */
  51. #define VIRTIO_PCI_QUEUE_SEL 14
  52. /* A 16-bit r/w queue notifier */
  53. #define VIRTIO_PCI_QUEUE_NOTIFY 16
  54. /* An 8-bit device status register. */
  55. #define VIRTIO_PCI_STATUS 18
  56. /* An 8-bit r/o interrupt status register. Reading the value will return the
  57. * current contents of the ISR and will also clear it. This is effectively
  58. * a read-and-acknowledge. */
  59. #define VIRTIO_PCI_ISR 19
  60. /* MSI-X registers: only enabled if MSI-X is enabled. */
  61. /* A 16-bit vector for configuration changes. */
  62. #define VIRTIO_MSI_CONFIG_VECTOR 20
  63. /* A 16-bit vector for selected queue notifications. */
  64. #define VIRTIO_MSI_QUEUE_VECTOR 22
  65. /* The remaining space is defined by each driver as the per-driver
  66. * configuration space */
  67. #define VIRTIO_PCI_CONFIG_OFF(msix_enabled) ((msix_enabled) ? 24 : 20)
  68. /* Deprecated: please use VIRTIO_PCI_CONFIG_OFF instead */
  69. #define VIRTIO_PCI_CONFIG(dev) VIRTIO_PCI_CONFIG_OFF((dev)->msix_enabled)
  70. /* Virtio ABI version, this must match exactly */
  71. #define VIRTIO_PCI_ABI_VERSION 0
  72. /* How many bits to shift physical queue address written to QUEUE_PFN.
  73. * 12 is historical, and due to x86 page size. */
  74. #define VIRTIO_PCI_QUEUE_ADDR_SHIFT 12
  75. /* The alignment to use between consumer and producer parts of vring.
  76. * x86 pagesize again. */
  77. #define VIRTIO_PCI_VRING_ALIGN 4096
  78. #endif /* VIRTIO_PCI_NO_LEGACY */
  79. /* The bit of the ISR which indicates a device configuration change. */
  80. #define VIRTIO_PCI_ISR_CONFIG 0x2
  81. /* Vector value used to disable MSI for queue */
  82. #define VIRTIO_MSI_NO_VECTOR 0xffff
  83. #ifndef VIRTIO_PCI_NO_MODERN
  84. /* IDs for different capabilities. Must all exist. */
  85. /* Common configuration */
  86. #define VIRTIO_PCI_CAP_COMMON_CFG 1
  87. /* Notifications */
  88. #define VIRTIO_PCI_CAP_NOTIFY_CFG 2
  89. /* ISR access */
  90. #define VIRTIO_PCI_CAP_ISR_CFG 3
  91. /* Device specific configuration */
  92. #define VIRTIO_PCI_CAP_DEVICE_CFG 4
  93. /* PCI configuration access */
  94. #define VIRTIO_PCI_CAP_PCI_CFG 5
  95. /* Additional shared memory capability */
  96. #define VIRTIO_PCI_CAP_SHARED_MEMORY_CFG 8
  97. /* This is the PCI capability header: */
  98. struct virtio_pci_cap {
  99. __u8 cap_vndr; /* Generic PCI field: PCI_CAP_ID_VNDR */
  100. __u8 cap_next; /* Generic PCI field: next ptr. */
  101. __u8 cap_len; /* Generic PCI field: capability length */
  102. __u8 cfg_type; /* Identifies the structure. */
  103. __u8 bar; /* Where to find it. */
  104. __u8 id; /* Multiple capabilities of the same type */
  105. __u8 padding[2]; /* Pad to full dword. */
  106. __le32 offset; /* Offset within bar. */
  107. __le32 length; /* Length of the structure, in bytes. */
  108. };
  109. struct virtio_pci_cap64 {
  110. struct virtio_pci_cap cap;
  111. __le32 offset_hi; /* Most sig 32 bits of offset */
  112. __le32 length_hi; /* Most sig 32 bits of length */
  113. };
  114. struct virtio_pci_notify_cap {
  115. struct virtio_pci_cap cap;
  116. __le32 notify_off_multiplier; /* Multiplier for queue_notify_off. */
  117. };
  118. /* Fields in VIRTIO_PCI_CAP_COMMON_CFG: */
  119. struct virtio_pci_common_cfg {
  120. /* About the whole device. */
  121. __le32 device_feature_select; /* read-write */
  122. __le32 device_feature; /* read-only */
  123. __le32 guest_feature_select; /* read-write */
  124. __le32 guest_feature; /* read-write */
  125. __le16 msix_config; /* read-write */
  126. __le16 num_queues; /* read-only */
  127. __u8 device_status; /* read-write */
  128. __u8 config_generation; /* read-only */
  129. /* About a specific virtqueue. */
  130. __le16 queue_select; /* read-write */
  131. __le16 queue_size; /* read-write, power of 2. */
  132. __le16 queue_msix_vector; /* read-write */
  133. __le16 queue_enable; /* read-write */
  134. __le16 queue_notify_off; /* read-only */
  135. __le32 queue_desc_lo; /* read-write */
  136. __le32 queue_desc_hi; /* read-write */
  137. __le32 queue_avail_lo; /* read-write */
  138. __le32 queue_avail_hi; /* read-write */
  139. __le32 queue_used_lo; /* read-write */
  140. __le32 queue_used_hi; /* read-write */
  141. };
  142. /*
  143. * Warning: do not use sizeof on this: use offsetofend for
  144. * specific fields you need.
  145. */
  146. struct virtio_pci_modern_common_cfg {
  147. struct virtio_pci_common_cfg cfg;
  148. __le16 queue_notify_data; /* read-write */
  149. __le16 queue_reset; /* read-write */
  150. __le16 admin_queue_index; /* read-only */
  151. __le16 admin_queue_num; /* read-only */
  152. };
  153. /* Fields in VIRTIO_PCI_CAP_PCI_CFG: */
  154. struct virtio_pci_cfg_cap {
  155. struct virtio_pci_cap cap;
  156. __u8 pci_cfg_data[4]; /* Data for BAR access. */
  157. };
  158. /* Macro versions of offsets for the Old Timers! */
  159. #define VIRTIO_PCI_CAP_VNDR 0
  160. #define VIRTIO_PCI_CAP_NEXT 1
  161. #define VIRTIO_PCI_CAP_LEN 2
  162. #define VIRTIO_PCI_CAP_CFG_TYPE 3
  163. #define VIRTIO_PCI_CAP_BAR 4
  164. #define VIRTIO_PCI_CAP_OFFSET 8
  165. #define VIRTIO_PCI_CAP_LENGTH 12
  166. #define VIRTIO_PCI_NOTIFY_CAP_MULT 16
  167. #define VIRTIO_PCI_COMMON_DFSELECT 0
  168. #define VIRTIO_PCI_COMMON_DF 4
  169. #define VIRTIO_PCI_COMMON_GFSELECT 8
  170. #define VIRTIO_PCI_COMMON_GF 12
  171. #define VIRTIO_PCI_COMMON_MSIX 16
  172. #define VIRTIO_PCI_COMMON_NUMQ 18
  173. #define VIRTIO_PCI_COMMON_STATUS 20
  174. #define VIRTIO_PCI_COMMON_CFGGENERATION 21
  175. #define VIRTIO_PCI_COMMON_Q_SELECT 22
  176. #define VIRTIO_PCI_COMMON_Q_SIZE 24
  177. #define VIRTIO_PCI_COMMON_Q_MSIX 26
  178. #define VIRTIO_PCI_COMMON_Q_ENABLE 28
  179. #define VIRTIO_PCI_COMMON_Q_NOFF 30
  180. #define VIRTIO_PCI_COMMON_Q_DESCLO 32
  181. #define VIRTIO_PCI_COMMON_Q_DESCHI 36
  182. #define VIRTIO_PCI_COMMON_Q_AVAILLO 40
  183. #define VIRTIO_PCI_COMMON_Q_AVAILHI 44
  184. #define VIRTIO_PCI_COMMON_Q_USEDLO 48
  185. #define VIRTIO_PCI_COMMON_Q_USEDHI 52
  186. #define VIRTIO_PCI_COMMON_Q_NDATA 56
  187. #define VIRTIO_PCI_COMMON_Q_RESET 58
  188. #define VIRTIO_PCI_COMMON_ADM_Q_IDX 60
  189. #define VIRTIO_PCI_COMMON_ADM_Q_NUM 62
  190. #endif /* VIRTIO_PCI_NO_MODERN */
  191. /* Admin command status. */
  192. #define VIRTIO_ADMIN_STATUS_OK 0
  193. /* Admin command opcode. */
  194. #define VIRTIO_ADMIN_CMD_LIST_QUERY 0x0
  195. #define VIRTIO_ADMIN_CMD_LIST_USE 0x1
  196. /* Admin command group type. */
  197. #define VIRTIO_ADMIN_GROUP_TYPE_SRIOV 0x1
  198. /* Transitional device admin command. */
  199. #define VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_WRITE 0x2
  200. #define VIRTIO_ADMIN_CMD_LEGACY_COMMON_CFG_READ 0x3
  201. #define VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_WRITE 0x4
  202. #define VIRTIO_ADMIN_CMD_LEGACY_DEV_CFG_READ 0x5
  203. #define VIRTIO_ADMIN_CMD_LEGACY_NOTIFY_INFO 0x6
  204. struct virtio_admin_cmd_hdr {
  205. __le16 opcode;
  206. /*
  207. * 1 - SR-IOV
  208. * 2-65535 - reserved
  209. */
  210. __le16 group_type;
  211. /* Unused, reserved for future extensions. */
  212. __u8 reserved1[12];
  213. __le64 group_member_id;
  214. };
  215. struct virtio_admin_cmd_status {
  216. __le16 status;
  217. __le16 status_qualifier;
  218. /* Unused, reserved for future extensions. */
  219. __u8 reserved2[4];
  220. };
  221. struct virtio_admin_cmd_legacy_wr_data {
  222. __u8 offset; /* Starting offset of the register(s) to write. */
  223. __u8 reserved[7];
  224. __u8 registers[];
  225. };
  226. struct virtio_admin_cmd_legacy_rd_data {
  227. __u8 offset; /* Starting offset of the register(s) to read. */
  228. };
  229. #define VIRTIO_ADMIN_CMD_NOTIFY_INFO_FLAGS_END 0
  230. #define VIRTIO_ADMIN_CMD_NOTIFY_INFO_FLAGS_OWNER_DEV 0x1
  231. #define VIRTIO_ADMIN_CMD_NOTIFY_INFO_FLAGS_OWNER_MEM 0x2
  232. #define VIRTIO_ADMIN_CMD_MAX_NOTIFY_INFO 4
  233. struct virtio_admin_cmd_notify_info_data {
  234. __u8 flags; /* 0 = end of list, 1 = owner device, 2 = member device */
  235. __u8 bar; /* BAR of the member or the owner device */
  236. __u8 padding[6];
  237. __le64 offset; /* Offset within bar. */
  238. };
  239. struct virtio_admin_cmd_notify_info_result {
  240. struct virtio_admin_cmd_notify_info_data entries[VIRTIO_ADMIN_CMD_MAX_NOTIFY_INFO];
  241. };
  242. #endif