1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright (c) 2023 Cisco Systems, Inc.
5 #include "vppinfra/pool.h"
7 #include <vnet/ethernet/ethernet.h>
8 #include <vnet/dev/dev.h>
9 #include <vnet/dev/counters.h>
10 #include <vnet/dev/log.h>
11 #include <vnet/dev/api.h>
13 VLIB_REGISTER_LOG_CLASS (dev_log, static) = {
15 .subclass_name = "api",
19 _vnet_dev_queue_size_validate (u32 size, vnet_dev_queue_config_t c)
21 if (size < c.min_size)
23 if (size > c.max_size)
25 if (c.size_is_power_of_two && count_set_bits (size) != 1)
27 if (c.multiplier && size % c.multiplier)
34 vnet_dev_api_attach (vlib_main_t *vm, vnet_dev_api_attach_args_t *args)
36 vnet_dev_main_t *dm = &vnet_dev_main;
38 vnet_dev_rv_t rv = VNET_DEV_OK;
40 vnet_dev_driver_t *driver;
41 void *bus_dev_info = 0;
44 log_debug (0, "%s driver %s flags '%U' args '%v'", args->device_id,
45 args->driver_name, format_vnet_dev_flags, &args->flags,
48 if (vnet_dev_by_id (args->device_id))
49 return VNET_DEV_ERR_ALREADY_IN_USE;
51 bus = vnet_dev_find_device_bus (vm, args->device_id);
54 log_err (dev, "unknown bus");
55 rv = VNET_DEV_ERR_INVALID_BUS;
59 bus_dev_info = vnet_dev_get_device_info (vm, args->device_id);
62 log_err (dev, "invalid or unsupported device id");
63 rv = VNET_DEV_ERR_INVALID_DEVICE_ID;
67 vec_foreach (driver, dm->drivers)
69 if (args->driver_name[0] &&
70 strcmp (args->driver_name, driver->registration->name))
72 if (driver->ops.probe &&
73 (dev_desc = driver->ops.probe (vm, bus->index, bus_dev_info)))
79 log_err (dev, "driver not available for %s", args->device_id);
80 rv = VNET_DEV_ERR_DRIVER_NOT_AVAILABLE;
84 dev = vnet_dev_alloc (vm, args->device_id, driver);
87 log_err (dev, "dev alloc failed for %s", args->device_id);
88 rv = VNET_DEV_ERR_BUG;
91 dev->description = dev_desc;
93 if (driver->registration->args)
94 for (vnet_dev_arg_t *a = driver->registration->args;
95 a->type != VNET_DEV_ARG_END; a++)
96 vec_add1 (dev->args, *a);
100 if ((rv = vnet_dev_arg_parse (vm, dev, dev->args, args->args)) !=
105 if ((args->flags.e & VNET_DEV_F_NO_STATS) == 0)
108 log_debug (0, "found '%v'", dev->description);
110 rv = vnet_dev_process_call_op (vm, dev, vnet_dev_init);
114 bus->ops.free_device_info (vm, bus_dev_info);
116 if (rv != VNET_DEV_OK && dev)
117 vnet_dev_process_call_op_no_rv (vm, dev, vnet_dev_free);
119 args->dev_index = dev->index;
125 vnet_dev_api_detach (vlib_main_t *vm, vnet_dev_api_detach_args_t *args)
127 vnet_dev_t *dev = vnet_dev_by_index (args->dev_index);
129 log_debug (dev, "detach");
132 return vnet_dev_process_call_op_no_rv (vm, dev, vnet_dev_detach);
134 return VNET_DEV_ERR_NOT_FOUND;
138 vnet_dev_api_reset (vlib_main_t *vm, vnet_dev_api_reset_args_t *args)
140 vnet_dev_t *dev = vnet_dev_by_id (args->device_id);
142 log_debug (dev, "detach");
145 return VNET_DEV_ERR_NOT_FOUND;
148 return VNET_DEV_ERR_NOT_SUPPORTED;
150 return vnet_dev_process_call_op (vm, dev, vnet_dev_reset);
154 vnet_dev_api_create_port_if (vlib_main_t *vm,
155 vnet_dev_api_create_port_if_args_t *args)
157 vnet_dev_t *dev = vnet_dev_by_index (args->dev_index);
158 vnet_dev_port_t *port = 0;
159 u16 n_threads = vlib_get_n_threads ();
160 int default_is_intr_mode;
164 "create_port_if: dev_index %u port %u intf_name '%s' num_rx_q %u "
165 "num_tx_q %u rx_q_sz %u tx_q_sz %u, flags '%U' args '%v'",
166 args->dev_index, args->port_id, args->intf_name,
167 args->num_rx_queues, args->num_tx_queues, args->rx_queue_size,
168 args->tx_queue_size, format_vnet_dev_port_flags, &args->flags,
172 return VNET_DEV_ERR_NOT_FOUND;
174 foreach_vnet_dev_port (p, dev)
175 if (p->port_id == args->port_id)
182 return VNET_DEV_ERR_INVALID_DEVICE_ID;
184 if (port->interface_created)
185 return VNET_DEV_ERR_ALREADY_EXISTS;
189 rv = vnet_dev_arg_parse (vm, dev, port->args, args->args);
190 if (rv != VNET_DEV_OK)
194 default_is_intr_mode = (args->flags.e & VNET_DEV_PORT_F_INTERRUPT_MODE) != 0;
195 if (default_is_intr_mode && port->attr.caps.interrupt_mode == 0)
197 log_err (dev, "interrupt mode requested and port doesn't support it");
198 return VNET_DEV_ERR_NOT_SUPPORTED;
201 if (args->num_rx_queues)
203 if (args->num_rx_queues > port->attr.max_rx_queues)
204 return VNET_DEV_ERR_INVALID_NUM_RX_QUEUES;
205 port->intf.num_rx_queues = args->num_rx_queues;
208 port->intf.num_rx_queues = clib_min (port->attr.max_tx_queues, 1);
210 if (args->num_tx_queues)
212 if (args->num_tx_queues > port->attr.max_tx_queues)
213 return VNET_DEV_ERR_INVALID_NUM_TX_QUEUES;
214 port->intf.num_tx_queues = args->num_tx_queues;
217 port->intf.num_tx_queues = clib_min (port->attr.max_tx_queues, n_threads);
219 if (args->rx_queue_size)
221 if (!_vnet_dev_queue_size_validate (args->rx_queue_size,
222 port->rx_queue_config))
223 return VNET_DEV_ERR_INVALID_RX_QUEUE_SIZE;
224 port->intf.rxq_sz = args->rx_queue_size;
227 port->intf.rxq_sz = port->rx_queue_config.default_size;
229 if (args->tx_queue_size)
231 if (!_vnet_dev_queue_size_validate (args->tx_queue_size,
232 port->tx_queue_config))
233 return VNET_DEV_ERR_INVALID_TX_QUEUE_SIZE;
234 port->intf.txq_sz = args->tx_queue_size;
237 port->intf.txq_sz = port->tx_queue_config.default_size;
239 clib_memcpy (port->intf.name, args->intf_name, sizeof (port->intf.name));
240 port->intf.default_is_intr_mode = default_is_intr_mode;
242 rv = vnet_dev_process_call_port_op (vm, port, vnet_dev_port_if_create);
243 args->sw_if_index = (rv == VNET_DEV_OK) ? port->intf.sw_if_index : ~0;
249 vnet_dev_api_remove_port_if (vlib_main_t *vm,
250 vnet_dev_api_remove_port_if_args_t *args)
252 vnet_dev_main_t *dm = &vnet_dev_main;
253 vnet_main_t *vnm = vnet_get_main ();
254 vnet_sw_interface_t *si;
255 vnet_hw_interface_t *hi;
256 vnet_dev_port_t *port;
258 si = vnet_get_sw_interface_or_null (vnm, args->sw_if_index);
260 return VNET_DEV_ERR_UNKNOWN_INTERFACE;
262 hi = vnet_get_hw_interface_or_null (vnm, si->hw_if_index);
264 return VNET_DEV_ERR_UNKNOWN_INTERFACE;
266 if (pool_is_free_index (dm->ports_by_dev_instance, hi->dev_instance))
267 return VNET_DEV_ERR_UNKNOWN_INTERFACE;
269 port = vnet_dev_get_port_from_dev_instance (hi->dev_instance);
271 if (port->intf.hw_if_index != si->hw_if_index)
272 return VNET_DEV_ERR_UNKNOWN_INTERFACE;
274 return vnet_dev_process_call_port_op (vm, port, vnet_dev_port_if_remove);