blob: 4e9cf4aee9ec151a4ab749326664b8d1d2b4676b [file] [log] [blame]
Damjan Mariona42cd342016-04-13 18:03:20 +02001/*
2 * Copyright (c) 2016 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 * pci.h: PCI definitions.
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 */
39
40#ifndef included_vlib_pci_h
41#define included_vlib_pci_h
42
43#include <vlib/vlib.h>
44#include <vlib/pci/pci_config.h>
45
Damjan Marioncef87f12017-10-05 15:32:41 +020046/* *INDENT-OFF* */
Dave Barach9b8ffd92016-07-08 08:13:45 -040047typedef CLIB_PACKED (union
Dave Barach9b8ffd92016-07-08 08:13:45 -040048{
Damjan Marioncef87f12017-10-05 15:32:41 +020049 struct
50 {
51 u16 domain;
52 u8 bus;
53 u8 slot: 5;
54 u8 function:3;
55 };
56 u32 as_u32;
57}) vlib_pci_addr_t;
58/* *INDENT-ON* */
Damjan Mariona42cd342016-04-13 18:03:20 +020059
Damjan Marioncef87f12017-10-05 15:32:41 +020060typedef struct vlib_pci_device_info
61{
Damjan Marion20ba1642018-03-26 15:35:33 +020062 u32 flags;
63#define VLIB_PCI_DEVICE_INFO_F_NOIOMMU (1 << 0);
64
Damjan Marioncef87f12017-10-05 15:32:41 +020065 /* addr */
66 vlib_pci_addr_t addr;
Damjan Marion5a206ea2016-05-12 22:11:03 +020067
68 /* Numa Node */
69 int numa_node;
70
Damjan Marionb1b1a142016-08-23 00:53:22 +020071 /* Device data */
72 u16 device_class;
73 u16 vendor_id;
74 u16 device_id;
75
Damjan Marion5a206ea2016-05-12 22:11:03 +020076 /* Vital Product Data */
Dave Barach9b8ffd92016-07-08 08:13:45 -040077 u8 *product_name;
78 u8 *vpd_r;
79 u8 *vpd_w;
Damjan Marion5a206ea2016-05-12 22:11:03 +020080
Damjan Marioncef87f12017-10-05 15:32:41 +020081 /* Driver name */
82 u8 *driver_name;
Damjan Marion5a206ea2016-05-12 22:11:03 +020083
Damjan Marioncef87f12017-10-05 15:32:41 +020084 /* First 64 bytes of configuration space. */
85 union
86 {
87 pci_config_type0_regs_t config0;
88 pci_config_type1_regs_t config1;
89 u8 config_data[256];
90 };
91
92 /* IOMMU Group */
93 int iommu_group;
94
95} vlib_pci_device_info_t;
96
97typedef u32 vlib_pci_dev_handle_t;
98
Ray Kinsella5714a492021-11-02 13:33:44 +000099vlib_pci_device_info_t *vlib_pci_get_device_info (vlib_main_t *vm,
100 vlib_pci_addr_t *addr,
101 clib_error_t **error);
102clib_error_t *vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr,
103 vlib_pci_addr_t *root_bus);
Damjan Marioncef87f12017-10-05 15:32:41 +0200104vlib_pci_addr_t *vlib_pci_get_all_dev_addrs ();
Damjan Marion23227982018-10-22 13:38:57 +0200105vlib_pci_addr_t *vlib_pci_get_addr (vlib_main_t * vm,
106 vlib_pci_dev_handle_t h);
Damjan Mariond2bfb782019-01-07 20:56:04 +0100107u32 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h);
Mohsin Kazmia402b832019-01-25 15:57:24 +0000108u32 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm,
109 vlib_pci_dev_handle_t h);
110
Damjan Marion23227982018-10-22 13:38:57 +0200111uword vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h);
112void vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
113 uword private_data);
Damjan Marioncef87f12017-10-05 15:32:41 +0200114
115static inline void
116vlib_pci_free_device_info (vlib_pci_device_info_t * di)
117{
118 if (!di)
119 return;
120 vec_free (di->product_name);
121 vec_free (di->vpd_r);
122 vec_free (di->vpd_w);
123 vec_free (di->driver_name);
124 clib_mem_free (di);
125}
Damjan Mariona42cd342016-04-13 18:03:20 +0200126
Dave Barach9b8ffd92016-07-08 08:13:45 -0400127typedef struct
128{
Damjan Mariona42cd342016-04-13 18:03:20 +0200129 u16 vendor_id, device_id;
130} pci_device_id_t;
131
Damjan Marion23227982018-10-22 13:38:57 +0200132typedef void (pci_intx_handler_function_t) (vlib_main_t * vm,
133 vlib_pci_dev_handle_t handle);
134typedef void (pci_msix_handler_function_t) (vlib_main_t * vm,
135 vlib_pci_dev_handle_t handle,
Damjan Marion599a16b2018-03-04 19:35:23 +0100136 u16 line);
137
Dave Barach9b8ffd92016-07-08 08:13:45 -0400138typedef struct _pci_device_registration
139{
Damjan Mariona42cd342016-04-13 18:03:20 +0200140 /* Driver init function. */
Damjan Marioncef87f12017-10-05 15:32:41 +0200141 clib_error_t *(*init_function) (vlib_main_t * vm,
142 vlib_pci_dev_handle_t handle);
Damjan Mariona42cd342016-04-13 18:03:20 +0200143
Damjan Marion5a206ea2016-05-12 22:11:03 +0200144 /* Interrupt handler */
Damjan Marion599a16b2018-03-04 19:35:23 +0100145 pci_intx_handler_function_t *interrupt_handler;
Damjan Mariona42cd342016-04-13 18:03:20 +0200146
147 /* List of registrations */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400148 struct _pci_device_registration *next_registration;
Damjan Mariona42cd342016-04-13 18:03:20 +0200149
150 /* Vendor/device ids supported by this driver. */
151 pci_device_id_t supported_devices[];
152} pci_device_registration_t;
153
Damjan Marion5a206ea2016-05-12 22:11:03 +0200154/* Pool of PCI devices. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400155typedef struct
156{
157 vlib_main_t *vlib_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400158 pci_device_registration_t *pci_device_registrations;
Damjan Marion23227982018-10-22 13:38:57 +0200159 /* logging */
160 vlib_log_class_t log_default;
Damjan Marion5a206ea2016-05-12 22:11:03 +0200161} vlib_pci_main_t;
162
163extern vlib_pci_main_t pci_main;
164
Damjan Mariona42cd342016-04-13 18:03:20 +0200165#define PCI_REGISTER_DEVICE(x,...) \
166 __VA_ARGS__ pci_device_registration_t x; \
167static void __vlib_add_pci_device_registration_##x (void) \
168 __attribute__((__constructor__)) ; \
169static void __vlib_add_pci_device_registration_##x (void) \
170{ \
Damjan Marion5a206ea2016-05-12 22:11:03 +0200171 vlib_pci_main_t * pm = &pci_main; \
172 x.next_registration = pm->pci_device_registrations; \
173 pm->pci_device_registrations = &x; \
Damjan Mariona42cd342016-04-13 18:03:20 +0200174} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200175static void __vlib_rm_pci_device_registration_##x (void) \
176 __attribute__((__destructor__)) ; \
177static void __vlib_rm_pci_device_registration_##x (void) \
178{ \
179 vlib_pci_main_t * pm = &pci_main; \
180 VLIB_REMOVE_FROM_LINKED_LIST (pm->pci_device_registrations, \
181 &x, next_registration); \
182} \
Damjan Marion5a206ea2016-05-12 22:11:03 +0200183__VA_ARGS__ pci_device_registration_t x
Damjan Mariona42cd342016-04-13 18:03:20 +0200184
Benoît Ganne6a073482022-10-13 17:22:26 +0200185clib_error_t *vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
186 char *uio_driver_name, int force);
Damjan Mariona42cd342016-04-13 18:03:20 +0200187
188/* Configuration space read/write. */
Damjan Marion23227982018-10-22 13:38:57 +0200189clib_error_t *vlib_pci_read_write_config (vlib_main_t * vm,
190 vlib_pci_dev_handle_t handle,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400191 vlib_read_or_write_t read_or_write,
Damjan Marion23227982018-10-22 13:38:57 +0200192 uword address, void *data,
193 u32 n_bytes);
Damjan Mariona42cd342016-04-13 18:03:20 +0200194
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200195/* io space read/write. */
196clib_error_t *vlib_pci_read_write_io (vlib_main_t * vm,
197 vlib_pci_dev_handle_t handle,
198 vlib_read_or_write_t read_or_write,
199 uword address, void *data, u32 n_bytes);
200
201
202#define _(t, x) \
Damjan Mariona42cd342016-04-13 18:03:20 +0200203static inline clib_error_t * \
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200204vlib_pci_read_##x##_##t (vlib_main_t *vm, vlib_pci_dev_handle_t h, \
Damjan Marion5a206ea2016-05-12 22:11:03 +0200205 uword address, t * data) \
Damjan Mariona42cd342016-04-13 18:03:20 +0200206{ \
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200207 return vlib_pci_read_write_##x (vm, h, VLIB_READ,address, data, \
Damjan Marion5a206ea2016-05-12 22:11:03 +0200208 sizeof (data[0])); \
Damjan Mariona42cd342016-04-13 18:03:20 +0200209}
210
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200211_(u32, config);
212_(u16, config);
213_(u8, config);
214
215_(u32, io);
216_(u16, io);
217_(u8, io);
Damjan Mariona42cd342016-04-13 18:03:20 +0200218
219#undef _
220
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200221#define _(t, x) \
Damjan Mariona42cd342016-04-13 18:03:20 +0200222static inline clib_error_t * \
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200223vlib_pci_write_##x##_##t (vlib_main_t *vm, vlib_pci_dev_handle_t h, \
Damjan Marion23227982018-10-22 13:38:57 +0200224 uword address, t * data) \
Damjan Mariona42cd342016-04-13 18:03:20 +0200225{ \
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200226 return vlib_pci_read_write_##x (vm, h, VLIB_WRITE, \
Damjan Mariona42cd342016-04-13 18:03:20 +0200227 address, data, sizeof (data[0])); \
228}
229
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200230_(u32, config);
231_(u16, config);
232_(u8, config);
233
234_(u32, io);
235_(u16, io);
236_(u8, io);
Damjan Mariona42cd342016-04-13 18:03:20 +0200237
238#undef _
239
Damjan Marion5a206ea2016-05-12 22:11:03 +0200240static inline clib_error_t *
Damjan Marion23227982018-10-22 13:38:57 +0200241vlib_pci_intr_enable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
Damjan Marion5a206ea2016-05-12 22:11:03 +0200242{
243 u16 command;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400244 clib_error_t *err;
Damjan Marion5a206ea2016-05-12 22:11:03 +0200245
Damjan Marion23227982018-10-22 13:38:57 +0200246 err = vlib_pci_read_config_u16 (vm, h, 4, &command);
Damjan Marion5a206ea2016-05-12 22:11:03 +0200247
248 if (err)
249 return err;
250
251 command &= ~PCI_COMMAND_INTX_DISABLE;
252
Damjan Marion23227982018-10-22 13:38:57 +0200253 return vlib_pci_write_config_u16 (vm, h, 4, &command);
Damjan Marion5a206ea2016-05-12 22:11:03 +0200254}
255
256static inline clib_error_t *
Damjan Marion23227982018-10-22 13:38:57 +0200257vlib_pci_intr_disable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
Damjan Marion5a206ea2016-05-12 22:11:03 +0200258{
259 u16 command;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400260 clib_error_t *err;
Damjan Marion5a206ea2016-05-12 22:11:03 +0200261
Damjan Marion23227982018-10-22 13:38:57 +0200262 err = vlib_pci_read_config_u16 (vm, h, 4, &command);
Damjan Marion5a206ea2016-05-12 22:11:03 +0200263
264 if (err)
265 return err;
266
267 command |= PCI_COMMAND_INTX_DISABLE;
268
Damjan Marion23227982018-10-22 13:38:57 +0200269 return vlib_pci_write_config_u16 (vm, h, 4, &command);
Damjan Marion5a206ea2016-05-12 22:11:03 +0200270}
271
272static inline clib_error_t *
Damjan Marion23227982018-10-22 13:38:57 +0200273vlib_pci_bus_master_enable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
Damjan Marion5a206ea2016-05-12 22:11:03 +0200274{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400275 clib_error_t *err;
Damjan Marion5a206ea2016-05-12 22:11:03 +0200276 u16 command;
277
278 /* Set bus master enable (BME) */
Damjan Marion23227982018-10-22 13:38:57 +0200279 err = vlib_pci_read_config_u16 (vm, h, 4, &command);
Damjan Marion5a206ea2016-05-12 22:11:03 +0200280
281 if (err)
282 return err;
283
Damjan Marion191a1a42017-07-10 15:38:21 +0200284 if (command & PCI_COMMAND_BUS_MASTER)
Damjan Marion5a206ea2016-05-12 22:11:03 +0200285 return 0;
286
287 command |= PCI_COMMAND_BUS_MASTER;
288
Damjan Marion23227982018-10-22 13:38:57 +0200289 return vlib_pci_write_config_u16 (vm, h, 4, &command);
Damjan Marion5a206ea2016-05-12 22:11:03 +0200290}
Damjan Mariona42cd342016-04-13 18:03:20 +0200291
Damjan Marion23227982018-10-22 13:38:57 +0200292clib_error_t *vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
Damjan Marionf313b742018-03-05 14:08:33 +0100293 pci_device_id_t ids[],
294 vlib_pci_dev_handle_t * handle);
Damjan Marion23227982018-10-22 13:38:57 +0200295void vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h);
296clib_error_t *vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
297 u32 resource, void **result);
298clib_error_t *vlib_pci_map_region_fixed (vlib_main_t * vm,
299 vlib_pci_dev_handle_t h,
Damjan Marion2060db82018-03-04 17:37:15 +0100300 u32 resource, u8 * addr,
301 void **result);
Mohsin Kazmi95276ca2018-09-28 11:45:01 +0200302clib_error_t *vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
303 u32 resource);
Damjan Marion23227982018-10-22 13:38:57 +0200304clib_error_t *vlib_pci_register_intx_handler (vlib_main_t * vm,
305 vlib_pci_dev_handle_t h,
Damjan Mariond5ded2d2018-03-05 10:18:50 +0100306 pci_intx_handler_function_t *
307 intx_handler);
Damjan Marion23227982018-10-22 13:38:57 +0200308clib_error_t *vlib_pci_register_msix_handler (vlib_main_t * vm,
309 vlib_pci_dev_handle_t h,
Damjan Marion599a16b2018-03-04 19:35:23 +0100310 u32 start, u32 count,
311 pci_msix_handler_function_t *
312 msix_handler);
Damjan Marion23227982018-10-22 13:38:57 +0200313clib_error_t *vlib_pci_enable_msix_irq (vlib_main_t * vm,
314 vlib_pci_dev_handle_t h, u16 start,
Damjan Marion599a16b2018-03-04 19:35:23 +0100315 u16 count);
Damjan Marion23227982018-10-22 13:38:57 +0200316clib_error_t *vlib_pci_disable_msix_irq (vlib_main_t * vm,
317 vlib_pci_dev_handle_t h, u16 start,
Damjan Marion599a16b2018-03-04 19:35:23 +0100318 u16 count);
Damjan Marion68b4da62018-09-30 18:26:20 +0200319clib_error_t *vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h,
320 void *ptr);
Damjan Marion9c9490c2020-10-07 20:00:39 +0200321uword vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
322 u16 index);
Damjan Marion68b4da62018-09-30 18:26:20 +0200323
324int vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm,
325 vlib_pci_dev_handle_t h);
Damjan Marion599a16b2018-03-04 19:35:23 +0100326
Damjan Marion5a206ea2016-05-12 22:11:03 +0200327unformat_function_t unformat_vlib_pci_addr;
328format_function_t format_vlib_pci_addr;
Damjan Marion5a206ea2016-05-12 22:11:03 +0200329format_function_t format_vlib_pci_link_speed;
Ray Kinsella6efe0252021-11-02 13:26:49 +0000330format_function_t format_vlib_pci_link_port;
Damjan Marion7d221612016-12-26 11:39:42 +0100331format_function_t format_vlib_pci_vpd;
Damjan Mariona42cd342016-04-13 18:03:20 +0200332
333#endif /* included_vlib_pci_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334
335/*
336 * fd.io coding-style-patch-verification: ON
337 *
338 * Local Variables:
339 * eval: (c-set-style "gnu")
340 * End:
341 */