i40e_virtchnl.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. /*******************************************************************************
  2. *
  3. * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
  4. * Copyright(c) 2013 - 2014 Intel Corporation.
  5. *
  6. * This program is free software; you can redistribute it and/or modify it
  7. * under the terms and conditions of the GNU General Public License,
  8. * version 2, as published by the Free Software Foundation.
  9. *
  10. * This program is distributed in the hope it will be useful, but WITHOUT
  11. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12. * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13. * more details.
  14. *
  15. * You should have received a copy of the GNU General Public License along
  16. * with this program. If not, see <http://www.gnu.org/licenses/>.
  17. *
  18. * The full GNU General Public License is included in this distribution in
  19. * the file called "COPYING".
  20. *
  21. * Contact Information:
  22. * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  23. * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24. *
  25. ******************************************************************************/
  26. #ifndef _I40E_VIRTCHNL_H_
  27. #define _I40E_VIRTCHNL_H_
  28. #include "i40e_type.h"
  29. /* Description:
  30. * This header file describes the VF-PF communication protocol used
  31. * by the various i40e drivers.
  32. *
  33. * Admin queue buffer usage:
  34. * desc->opcode is always i40e_aqc_opc_send_msg_to_pf
  35. * flags, retval, datalen, and data addr are all used normally.
  36. * Firmware copies the cookie fields when sending messages between the PF and
  37. * VF, but uses all other fields internally. Due to this limitation, we
  38. * must send all messages as "indirect", i.e. using an external buffer.
  39. *
  40. * All the vsi indexes are relative to the VF. Each VF can have maximum of
  41. * three VSIs. All the queue indexes are relative to the VSI. Each VF can
  42. * have a maximum of sixteen queues for all of its VSIs.
  43. *
  44. * The PF is required to return a status code in v_retval for all messages
  45. * except RESET_VF, which does not require any response. The return value is of
  46. * i40e_status_code type, defined in the i40e_type.h.
  47. *
  48. * In general, VF driver initialization should roughly follow the order of these
  49. * opcodes. The VF driver must first validate the API version of the PF driver,
  50. * then request a reset, then get resources, then configure queues and
  51. * interrupts. After these operations are complete, the VF driver may start
  52. * its queues, optionally add MAC and VLAN filters, and process traffic.
  53. */
  54. /* Opcodes for VF-PF communication. These are placed in the v_opcode field
  55. * of the virtchnl_msg structure.
  56. */
  57. enum i40e_virtchnl_ops {
  58. /* The PF sends status change events to VFs using
  59. * the I40E_VIRTCHNL_OP_EVENT opcode.
  60. * VFs send requests to the PF using the other ops.
  61. */
  62. I40E_VIRTCHNL_OP_UNKNOWN = 0,
  63. I40E_VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
  64. I40E_VIRTCHNL_OP_RESET_VF = 2,
  65. I40E_VIRTCHNL_OP_GET_VF_RESOURCES = 3,
  66. I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
  67. I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
  68. I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
  69. I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
  70. I40E_VIRTCHNL_OP_ENABLE_QUEUES = 8,
  71. I40E_VIRTCHNL_OP_DISABLE_QUEUES = 9,
  72. I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS = 10,
  73. I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS = 11,
  74. I40E_VIRTCHNL_OP_ADD_VLAN = 12,
  75. I40E_VIRTCHNL_OP_DEL_VLAN = 13,
  76. I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
  77. I40E_VIRTCHNL_OP_GET_STATS = 15,
  78. I40E_VIRTCHNL_OP_FCOE = 16,
  79. I40E_VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
  80. I40E_VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
  81. I40E_VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
  82. I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
  83. I40E_VIRTCHNL_OP_SET_RSS_HENA = 26,
  84. };
  85. /* Virtual channel message descriptor. This overlays the admin queue
  86. * descriptor. All other data is passed in external buffers.
  87. */
  88. struct i40e_virtchnl_msg {
  89. u8 pad[8]; /* AQ flags/opcode/len/retval fields */
  90. enum i40e_virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
  91. i40e_status v_retval; /* ditto for desc->retval */
  92. u32 vfid; /* used by PF when sending to VF */
  93. };
  94. /* Message descriptions and data structures.*/
  95. /* I40E_VIRTCHNL_OP_VERSION
  96. * VF posts its version number to the PF. PF responds with its version number
  97. * in the same format, along with a return code.
  98. * Reply from PF has its major/minor versions also in param0 and param1.
  99. * If there is a major version mismatch, then the VF cannot operate.
  100. * If there is a minor version mismatch, then the VF can operate but should
  101. * add a warning to the system log.
  102. *
  103. * This enum element MUST always be specified as == 1, regardless of other
  104. * changes in the API. The PF must always respond to this message without
  105. * error regardless of version mismatch.
  106. */
  107. #define I40E_VIRTCHNL_VERSION_MAJOR 1
  108. #define I40E_VIRTCHNL_VERSION_MINOR 1
  109. #define I40E_VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0
  110. struct i40e_virtchnl_version_info {
  111. u32 major;
  112. u32 minor;
  113. };
  114. /* I40E_VIRTCHNL_OP_RESET_VF
  115. * VF sends this request to PF with no parameters
  116. * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
  117. * until reset completion is indicated. The admin queue must be reinitialized
  118. * after this operation.
  119. *
  120. * When reset is complete, PF must ensure that all queues in all VSIs associated
  121. * with the VF are stopped, all queue configurations in the HMC are set to 0,
  122. * and all MAC and VLAN filters (except the default MAC address) on all VSIs
  123. * are cleared.
  124. */
  125. /* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
  126. * Version 1.0 VF sends this request to PF with no parameters
  127. * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
  128. * PF responds with an indirect message containing
  129. * i40e_virtchnl_vf_resource and one or more
  130. * i40e_virtchnl_vsi_resource structures.
  131. */
  132. struct i40e_virtchnl_vsi_resource {
  133. u16 vsi_id;
  134. u16 num_queue_pairs;
  135. enum i40e_vsi_type vsi_type;
  136. u16 qset_handle;
  137. u8 default_mac_addr[ETH_ALEN];
  138. };
  139. /* VF offload flags */
  140. #define I40E_VIRTCHNL_VF_OFFLOAD_L2 0x00000001
  141. #define I40E_VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002
  142. #define I40E_VIRTCHNL_VF_OFFLOAD_FCOE 0x00000004
  143. #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008
  144. #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010
  145. #define I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020
  146. #define I40E_VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000
  147. #define I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000
  148. #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 0x00040000
  149. #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF 0X00080000
  150. #define I40E_VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM 0X00100000
  151. struct i40e_virtchnl_vf_resource {
  152. u16 num_vsis;
  153. u16 num_queue_pairs;
  154. u16 max_vectors;
  155. u16 max_mtu;
  156. u32 vf_offload_flags;
  157. u32 rss_key_size;
  158. u32 rss_lut_size;
  159. struct i40e_virtchnl_vsi_resource vsi_res[1];
  160. };
  161. /* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
  162. * VF sends this message to set up parameters for one TX queue.
  163. * External data buffer contains one instance of i40e_virtchnl_txq_info.
  164. * PF configures requested queue and returns a status code.
  165. */
  166. /* Tx queue config info */
  167. struct i40e_virtchnl_txq_info {
  168. u16 vsi_id;
  169. u16 queue_id;
  170. u16 ring_len; /* number of descriptors, multiple of 8 */
  171. u16 headwb_enabled;
  172. u64 dma_ring_addr;
  173. u64 dma_headwb_addr;
  174. };
  175. /* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
  176. * VF sends this message to set up parameters for one RX queue.
  177. * External data buffer contains one instance of i40e_virtchnl_rxq_info.
  178. * PF configures requested queue and returns a status code.
  179. */
  180. /* Rx queue config info */
  181. struct i40e_virtchnl_rxq_info {
  182. u16 vsi_id;
  183. u16 queue_id;
  184. u32 ring_len; /* number of descriptors, multiple of 32 */
  185. u16 hdr_size;
  186. u16 splithdr_enabled;
  187. u32 databuffer_size;
  188. u32 max_pkt_size;
  189. u64 dma_ring_addr;
  190. enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
  191. };
  192. /* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
  193. * VF sends this message to set parameters for all active TX and RX queues
  194. * associated with the specified VSI.
  195. * PF configures queues and returns status.
  196. * If the number of queues specified is greater than the number of queues
  197. * associated with the VSI, an error is returned and no queues are configured.
  198. */
  199. struct i40e_virtchnl_queue_pair_info {
  200. /* NOTE: vsi_id and queue_id should be identical for both queues. */
  201. struct i40e_virtchnl_txq_info txq;
  202. struct i40e_virtchnl_rxq_info rxq;
  203. };
  204. struct i40e_virtchnl_vsi_queue_config_info {
  205. u16 vsi_id;
  206. u16 num_queue_pairs;
  207. struct i40e_virtchnl_queue_pair_info qpair[1];
  208. };
  209. /* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
  210. * VF uses this message to map vectors to queues.
  211. * The rxq_map and txq_map fields are bitmaps used to indicate which queues
  212. * are to be associated with the specified vector.
  213. * The "other" causes are always mapped to vector 0.
  214. * PF configures interrupt mapping and returns status.
  215. */
  216. struct i40e_virtchnl_vector_map {
  217. u16 vsi_id;
  218. u16 vector_id;
  219. u16 rxq_map;
  220. u16 txq_map;
  221. u16 rxitr_idx;
  222. u16 txitr_idx;
  223. };
  224. struct i40e_virtchnl_irq_map_info {
  225. u16 num_vectors;
  226. struct i40e_virtchnl_vector_map vecmap[1];
  227. };
  228. /* I40E_VIRTCHNL_OP_ENABLE_QUEUES
  229. * I40E_VIRTCHNL_OP_DISABLE_QUEUES
  230. * VF sends these message to enable or disable TX/RX queue pairs.
  231. * The queues fields are bitmaps indicating which queues to act upon.
  232. * (Currently, we only support 16 queues per VF, but we make the field
  233. * u32 to allow for expansion.)
  234. * PF performs requested action and returns status.
  235. */
  236. struct i40e_virtchnl_queue_select {
  237. u16 vsi_id;
  238. u16 pad;
  239. u32 rx_queues;
  240. u32 tx_queues;
  241. };
  242. /* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
  243. * VF sends this message in order to add one or more unicast or multicast
  244. * address filters for the specified VSI.
  245. * PF adds the filters and returns status.
  246. */
  247. /* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
  248. * VF sends this message in order to remove one or more unicast or multicast
  249. * filters for the specified VSI.
  250. * PF removes the filters and returns status.
  251. */
  252. struct i40e_virtchnl_ether_addr {
  253. u8 addr[ETH_ALEN];
  254. u8 pad[2];
  255. };
  256. struct i40e_virtchnl_ether_addr_list {
  257. u16 vsi_id;
  258. u16 num_elements;
  259. struct i40e_virtchnl_ether_addr list[1];
  260. };
  261. /* I40E_VIRTCHNL_OP_ADD_VLAN
  262. * VF sends this message to add one or more VLAN tag filters for receives.
  263. * PF adds the filters and returns status.
  264. * If a port VLAN is configured by the PF, this operation will return an
  265. * error to the VF.
  266. */
  267. /* I40E_VIRTCHNL_OP_DEL_VLAN
  268. * VF sends this message to remove one or more VLAN tag filters for receives.
  269. * PF removes the filters and returns status.
  270. * If a port VLAN is configured by the PF, this operation will return an
  271. * error to the VF.
  272. */
  273. struct i40e_virtchnl_vlan_filter_list {
  274. u16 vsi_id;
  275. u16 num_elements;
  276. u16 vlan_id[1];
  277. };
  278. /* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
  279. * VF sends VSI id and flags.
  280. * PF returns status code in retval.
  281. * Note: we assume that broadcast accept mode is always enabled.
  282. */
  283. struct i40e_virtchnl_promisc_info {
  284. u16 vsi_id;
  285. u16 flags;
  286. };
  287. #define I40E_FLAG_VF_UNICAST_PROMISC 0x00000001
  288. #define I40E_FLAG_VF_MULTICAST_PROMISC 0x00000002
  289. /* I40E_VIRTCHNL_OP_GET_STATS
  290. * VF sends this message to request stats for the selected VSI. VF uses
  291. * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
  292. * field is ignored by the PF.
  293. *
  294. * PF replies with struct i40e_eth_stats in an external buffer.
  295. */
  296. /* I40E_VIRTCHNL_OP_CONFIG_RSS_KEY
  297. * I40E_VIRTCHNL_OP_CONFIG_RSS_LUT
  298. * VF sends these messages to configure RSS. Only supported if both PF
  299. * and VF drivers set the I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
  300. * configuration negotiation. If this is the case, then the RSS fields in
  301. * the VF resource struct are valid.
  302. * Both the key and LUT are initialized to 0 by the PF, meaning that
  303. * RSS is effectively disabled until set up by the VF.
  304. */
  305. struct i40e_virtchnl_rss_key {
  306. u16 vsi_id;
  307. u16 key_len;
  308. u8 key[1]; /* RSS hash key, packed bytes */
  309. };
  310. struct i40e_virtchnl_rss_lut {
  311. u16 vsi_id;
  312. u16 lut_entries;
  313. u8 lut[1]; /* RSS lookup table*/
  314. };
  315. /* I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS
  316. * I40E_VIRTCHNL_OP_SET_RSS_HENA
  317. * VF sends these messages to get and set the hash filter enable bits for RSS.
  318. * By default, the PF sets these to all possible traffic types that the
  319. * hardware supports. The VF can query this value if it wants to change the
  320. * traffic types that are hashed by the hardware.
  321. * Traffic types are defined in the i40e_filter_pctype enum in i40e_type.h
  322. */
  323. struct i40e_virtchnl_rss_hena {
  324. u64 hena;
  325. };
  326. /* I40E_VIRTCHNL_OP_EVENT
  327. * PF sends this message to inform the VF driver of events that may affect it.
  328. * No direct response is expected from the VF, though it may generate other
  329. * messages in response to this one.
  330. */
  331. enum i40e_virtchnl_event_codes {
  332. I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
  333. I40E_VIRTCHNL_EVENT_LINK_CHANGE,
  334. I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
  335. I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
  336. };
  337. #define I40E_PF_EVENT_SEVERITY_INFO 0
  338. #define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM 255
  339. struct i40e_virtchnl_pf_event {
  340. enum i40e_virtchnl_event_codes event;
  341. union {
  342. struct {
  343. enum i40e_aq_link_speed link_speed;
  344. bool link_status;
  345. } link_event;
  346. } event_data;
  347. int severity;
  348. };
  349. /* VF reset states - these are written into the RSTAT register:
  350. * I40E_VFGEN_RSTAT1 on the PF
  351. * I40E_VFGEN_RSTAT on the VF
  352. * When the PF initiates a reset, it writes 0
  353. * When the reset is complete, it writes 1
  354. * When the PF detects that the VF has recovered, it writes 2
  355. * VF checks this register periodically to determine if a reset has occurred,
  356. * then polls it to know when the reset is complete.
  357. * If either the PF or VF reads the register while the hardware
  358. * is in a reset state, it will return DEADBEEF, which, when masked
  359. * will result in 3.
  360. */
  361. enum i40e_vfr_states {
  362. I40E_VFR_INPROGRESS = 0,
  363. I40E_VFR_COMPLETED,
  364. I40E_VFR_VFACTIVE,
  365. I40E_VFR_UNKNOWN,
  366. };
  367. #endif /* _I40E_VIRTCHNL_H_ */