1 /* SPDX-License-Identifier: (GPL-2.0 OR MIT)
2 * Google virtual Ethernet (gve) driver
4 * Copyright (C) 2015-2019 Google, Inc.
10 #include <linux/build_bug.h>
12 /* Admin queue opcodes */
13 enum gve_adminq_opcodes {
14 GVE_ADMINQ_DESCRIBE_DEVICE = 0x1,
15 GVE_ADMINQ_CONFIGURE_DEVICE_RESOURCES = 0x2,
16 GVE_ADMINQ_REGISTER_PAGE_LIST = 0x3,
17 GVE_ADMINQ_UNREGISTER_PAGE_LIST = 0x4,
18 GVE_ADMINQ_CREATE_TX_QUEUE = 0x5,
19 GVE_ADMINQ_CREATE_RX_QUEUE = 0x6,
20 GVE_ADMINQ_DESTROY_TX_QUEUE = 0x7,
21 GVE_ADMINQ_DESTROY_RX_QUEUE = 0x8,
22 GVE_ADMINQ_DECONFIGURE_DEVICE_RESOURCES = 0x9,
23 GVE_ADMINQ_SET_DRIVER_PARAMETER = 0xB,
24 GVE_ADMINQ_REPORT_STATS = 0xC,
25 GVE_ADMINQ_REPORT_LINK_SPEED = 0xD
28 /* Admin queue status codes */
29 enum gve_adminq_statuses {
30 GVE_ADMINQ_COMMAND_UNSET = 0x0,
31 GVE_ADMINQ_COMMAND_PASSED = 0x1,
32 GVE_ADMINQ_COMMAND_ERROR_ABORTED = 0xFFFFFFF0,
33 GVE_ADMINQ_COMMAND_ERROR_ALREADY_EXISTS = 0xFFFFFFF1,
34 GVE_ADMINQ_COMMAND_ERROR_CANCELLED = 0xFFFFFFF2,
35 GVE_ADMINQ_COMMAND_ERROR_DATALOSS = 0xFFFFFFF3,
36 GVE_ADMINQ_COMMAND_ERROR_DEADLINE_EXCEEDED = 0xFFFFFFF4,
37 GVE_ADMINQ_COMMAND_ERROR_FAILED_PRECONDITION = 0xFFFFFFF5,
38 GVE_ADMINQ_COMMAND_ERROR_INTERNAL_ERROR = 0xFFFFFFF6,
39 GVE_ADMINQ_COMMAND_ERROR_INVALID_ARGUMENT = 0xFFFFFFF7,
40 GVE_ADMINQ_COMMAND_ERROR_NOT_FOUND = 0xFFFFFFF8,
41 GVE_ADMINQ_COMMAND_ERROR_OUT_OF_RANGE = 0xFFFFFFF9,
42 GVE_ADMINQ_COMMAND_ERROR_PERMISSION_DENIED = 0xFFFFFFFA,
43 GVE_ADMINQ_COMMAND_ERROR_UNAUTHENTICATED = 0xFFFFFFFB,
44 GVE_ADMINQ_COMMAND_ERROR_RESOURCE_EXHAUSTED = 0xFFFFFFFC,
45 GVE_ADMINQ_COMMAND_ERROR_UNAVAILABLE = 0xFFFFFFFD,
46 GVE_ADMINQ_COMMAND_ERROR_UNIMPLEMENTED = 0xFFFFFFFE,
47 GVE_ADMINQ_COMMAND_ERROR_UNKNOWN_ERROR = 0xFFFFFFFF,
50 #define GVE_ADMINQ_DEVICE_DESCRIPTOR_VERSION 1
52 /* All AdminQ command structs should be naturally packed. The static_assert
53 * calls make sure this is the case at compile time.
56 struct gve_adminq_describe_device {
57 __be64 device_descriptor_addr;
58 __be32 device_descriptor_version;
59 __be32 available_length;
62 static_assert(sizeof(struct gve_adminq_describe_device) == 16);
64 struct gve_device_descriptor {
65 __be64 max_registered_pages;
67 __be16 tx_queue_entries;
68 __be16 rx_queue_entries;
69 __be16 default_num_queues;
72 __be16 tx_pages_per_qpl;
73 __be16 rx_pages_per_qpl;
75 __be16 num_device_options;
80 static_assert(sizeof(struct gve_device_descriptor) == 40);
82 struct gve_device_option {
88 static_assert(sizeof(struct gve_device_option) == 8);
90 #define GVE_DEV_OPT_ID_RAW_ADDRESSING 0x1
91 #define GVE_DEV_OPT_LEN_RAW_ADDRESSING 0x0
92 #define GVE_DEV_OPT_FEAT_MASK_RAW_ADDRESSING 0x0
94 struct gve_adminq_configure_device_resources {
100 __be32 ntfy_blk_msix_base_idx;
103 static_assert(sizeof(struct gve_adminq_configure_device_resources) == 32);
105 struct gve_adminq_register_page_list {
108 __be64 page_address_list_addr;
111 static_assert(sizeof(struct gve_adminq_register_page_list) == 16);
113 struct gve_adminq_unregister_page_list {
117 static_assert(sizeof(struct gve_adminq_unregister_page_list) == 4);
119 #define GVE_RAW_ADDRESSING_QPL_ID 0xFFFFFFFF
121 struct gve_adminq_create_tx_queue {
124 __be64 queue_resources_addr;
126 __be32 queue_page_list_id;
130 static_assert(sizeof(struct gve_adminq_create_tx_queue) == 32);
132 struct gve_adminq_create_rx_queue {
137 __be64 queue_resources_addr;
138 __be64 rx_desc_ring_addr;
139 __be64 rx_data_ring_addr;
140 __be32 queue_page_list_id;
144 static_assert(sizeof(struct gve_adminq_create_rx_queue) == 48);
146 /* Queue resources that are shared with the device */
147 struct gve_queue_resources {
150 __be32 db_index; /* Device -> Guest */
151 __be32 counter_index; /* Device -> Guest */
157 static_assert(sizeof(struct gve_queue_resources) == 64);
159 struct gve_adminq_destroy_tx_queue {
163 static_assert(sizeof(struct gve_adminq_destroy_tx_queue) == 4);
165 struct gve_adminq_destroy_rx_queue {
169 static_assert(sizeof(struct gve_adminq_destroy_rx_queue) == 4);
171 /* GVE Set Driver Parameter Types */
172 enum gve_set_driver_param_types {
173 GVE_SET_PARAM_MTU = 0x1,
176 struct gve_adminq_set_driver_parameter {
177 __be32 parameter_type;
179 __be64 parameter_value;
182 static_assert(sizeof(struct gve_adminq_set_driver_parameter) == 16);
184 struct gve_adminq_report_stats {
185 __be64 stats_report_len;
186 __be64 stats_report_addr;
190 static_assert(sizeof(struct gve_adminq_report_stats) == 24);
192 struct gve_adminq_report_link_speed {
193 __be64 link_speed_address;
196 static_assert(sizeof(struct gve_adminq_report_link_speed) == 8);
204 static_assert(sizeof(struct stats) == 16);
206 struct gve_stats_report {
207 __be64 written_count;
208 struct stats stats[];
211 static_assert(sizeof(struct gve_stats_report) == 8);
213 enum gve_stat_names {
219 TX_LAST_COMPLETION_PROCESSED = 5,
220 RX_NEXT_EXPECTED_SEQUENCE = 6,
221 RX_BUFFERS_POSTED = 7,
223 RX_QUEUE_DROP_CNT = 65,
224 RX_NO_BUFFERS_POSTED = 66,
225 RX_DROPS_PACKET_OVER_MRU = 67,
226 RX_DROPS_INVALID_CHECKSUM = 68,
229 union gve_adminq_command {
234 struct gve_adminq_configure_device_resources
235 configure_device_resources;
236 struct gve_adminq_create_tx_queue create_tx_queue;
237 struct gve_adminq_create_rx_queue create_rx_queue;
238 struct gve_adminq_destroy_tx_queue destroy_tx_queue;
239 struct gve_adminq_destroy_rx_queue destroy_rx_queue;
240 struct gve_adminq_describe_device describe_device;
241 struct gve_adminq_register_page_list reg_page_list;
242 struct gve_adminq_unregister_page_list unreg_page_list;
243 struct gve_adminq_set_driver_parameter set_driver_param;
244 struct gve_adminq_report_stats report_stats;
245 struct gve_adminq_report_link_speed report_link_speed;
251 static_assert(sizeof(union gve_adminq_command) == 64);
253 int gve_adminq_alloc(struct device *dev, struct gve_priv *priv);
254 void gve_adminq_free(struct device *dev, struct gve_priv *priv);
255 void gve_adminq_release(struct gve_priv *priv);
256 int gve_adminq_describe_device(struct gve_priv *priv);
257 int gve_adminq_configure_device_resources(struct gve_priv *priv,
258 dma_addr_t counter_array_bus_addr,
260 dma_addr_t db_array_bus_addr,
262 int gve_adminq_deconfigure_device_resources(struct gve_priv *priv);
263 int gve_adminq_create_tx_queues(struct gve_priv *priv, u32 num_queues);
264 int gve_adminq_destroy_tx_queues(struct gve_priv *priv, u32 queue_id);
265 int gve_adminq_create_rx_queues(struct gve_priv *priv, u32 num_queues);
266 int gve_adminq_destroy_rx_queues(struct gve_priv *priv, u32 queue_id);
267 int gve_adminq_register_page_list(struct gve_priv *priv,
268 struct gve_queue_page_list *qpl);
269 int gve_adminq_unregister_page_list(struct gve_priv *priv, u32 page_list_id);
270 int gve_adminq_set_mtu(struct gve_priv *priv, u64 mtu);
271 int gve_adminq_report_stats(struct gve_priv *priv, u64 stats_report_len,
272 dma_addr_t stats_report_addr, u64 interval);
273 int gve_adminq_report_link_speed(struct gve_priv *priv);
274 #endif /* _GVE_ADMINQ_H */