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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * pci.h: PCI definitions.
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vlib_pci_h
41 #define included_vlib_pci_h
43 #include <vlib/vlib.h>
44 #include <vlib/pci/pci_config.h>
47 typedef CLIB_PACKED (union
60 typedef struct vlib_pci_device_info
63 #define VLIB_PCI_DEVICE_INFO_F_NOIOMMU (1 << 0);
77 /* Vital Product Data */
85 /* First 64 bytes of configuration space. */
86 vlib_pci_config_t config;
91 } vlib_pci_device_info_t;
93 typedef u32 vlib_pci_dev_handle_t;
95 vlib_pci_device_info_t *vlib_pci_get_device_info (vlib_main_t *vm,
96 vlib_pci_addr_t *addr,
97 clib_error_t **error);
98 clib_error_t *vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr,
99 vlib_pci_addr_t *root_bus);
100 vlib_pci_addr_t *vlib_pci_get_all_dev_addrs ();
101 vlib_pci_addr_t *vlib_pci_get_addr (vlib_main_t * vm,
102 vlib_pci_dev_handle_t h);
103 u32 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h);
104 u32 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm,
105 vlib_pci_dev_handle_t h);
107 uword vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h);
108 void vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
112 vlib_pci_free_device_info (vlib_pci_device_info_t * di)
116 vec_free (di->product_name);
117 vec_free (di->vpd_r);
118 vec_free (di->vpd_w);
119 vec_free (di->driver_name);
125 u16 vendor_id, device_id;
128 #define PCI_DEVICE_IDS(...) \
129 (pci_device_id_t[]) \
134 typedef void (pci_intx_handler_function_t) (vlib_main_t * vm,
135 vlib_pci_dev_handle_t handle);
136 typedef void (pci_msix_handler_function_t) (vlib_main_t * vm,
137 vlib_pci_dev_handle_t handle,
140 typedef struct _pci_device_registration
142 /* Driver init function. */
143 clib_error_t *(*init_function) (vlib_main_t * vm,
144 vlib_pci_dev_handle_t handle);
146 /* Interrupt handler */
147 pci_intx_handler_function_t *interrupt_handler;
149 /* List of registrations */
150 struct _pci_device_registration *next_registration;
152 /* Vendor/device ids supported by this driver. */
153 pci_device_id_t supported_devices[];
154 } pci_device_registration_t;
156 /* Pool of PCI devices. */
159 vlib_main_t *vlib_main;
160 pci_device_registration_t *pci_device_registrations;
162 vlib_log_class_t log_default;
165 extern vlib_pci_main_t pci_main;
167 #define PCI_REGISTER_DEVICE(x,...) \
168 __VA_ARGS__ pci_device_registration_t x; \
169 static void __vlib_add_pci_device_registration_##x (void) \
170 __attribute__((__constructor__)) ; \
171 static void __vlib_add_pci_device_registration_##x (void) \
173 vlib_pci_main_t * pm = &pci_main; \
174 x.next_registration = pm->pci_device_registrations; \
175 pm->pci_device_registrations = &x; \
177 static void __vlib_rm_pci_device_registration_##x (void) \
178 __attribute__((__destructor__)) ; \
179 static void __vlib_rm_pci_device_registration_##x (void) \
181 vlib_pci_main_t * pm = &pci_main; \
182 VLIB_REMOVE_FROM_LINKED_LIST (pm->pci_device_registrations, \
183 &x, next_registration); \
185 __VA_ARGS__ pci_device_registration_t x
187 clib_error_t *vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
188 char *uio_driver_name, int force);
190 /* Configuration space read/write. */
191 clib_error_t *vlib_pci_read_write_config (vlib_main_t * vm,
192 vlib_pci_dev_handle_t handle,
193 vlib_read_or_write_t read_or_write,
194 uword address, void *data,
197 /* io space read/write. */
198 clib_error_t *vlib_pci_read_write_io (vlib_main_t * vm,
199 vlib_pci_dev_handle_t handle,
200 vlib_read_or_write_t read_or_write,
201 uword address, void *data, u32 n_bytes);
204 static inline clib_error_t *vlib_pci_read_##x##_##t ( \
205 vlib_main_t *vm, vlib_pci_dev_handle_t h, uword address, t *data) \
207 return vlib_pci_read_write_##x (vm, h, VLIB_READ, address, data, \
210 static inline clib_error_t *vlib_pci_write_##x##_##t ( \
211 vlib_main_t *vm, vlib_pci_dev_handle_t h, uword address, t *data) \
213 return vlib_pci_read_write_##x (vm, h, VLIB_WRITE, address, data, \
227 clib_error_t *vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
228 pci_device_id_t ids[],
229 vlib_pci_dev_handle_t * handle);
230 void vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h);
231 clib_error_t *vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
232 u32 resource, void **result);
233 clib_error_t *vlib_pci_map_region_fixed (vlib_main_t * vm,
234 vlib_pci_dev_handle_t h,
235 u32 resource, u8 * addr,
237 clib_error_t *vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
239 clib_error_t *vlib_pci_register_intx_handler (vlib_main_t * vm,
240 vlib_pci_dev_handle_t h,
241 pci_intx_handler_function_t *
243 clib_error_t *vlib_pci_register_msix_handler (vlib_main_t * vm,
244 vlib_pci_dev_handle_t h,
245 u32 start, u32 count,
246 pci_msix_handler_function_t *
248 clib_error_t *vlib_pci_enable_msix_irq (vlib_main_t * vm,
249 vlib_pci_dev_handle_t h, u16 start,
251 clib_error_t *vlib_pci_disable_msix_irq (vlib_main_t * vm,
252 vlib_pci_dev_handle_t h, u16 start,
254 clib_error_t *vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h,
256 uword vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
259 int vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm,
260 vlib_pci_dev_handle_t h);
261 clib_error_t *vlib_pci_intr_enable (vlib_main_t *, vlib_pci_dev_handle_t);
262 clib_error_t *vlib_pci_intr_disable (vlib_main_t *, vlib_pci_dev_handle_t);
263 clib_error_t *vlib_pci_bus_master_enable (vlib_main_t *,
264 vlib_pci_dev_handle_t);
265 clib_error_t *vlib_pci_bus_master_disable (vlib_main_t *,
266 vlib_pci_dev_handle_t);
267 clib_error_t *vlib_pci_function_level_reset (vlib_main_t *,
268 vlib_pci_dev_handle_t);
270 unformat_function_t unformat_vlib_pci_addr;
271 format_function_t format_vlib_pci_addr;
272 format_function_t format_vlib_pci_link_speed;
273 format_function_t format_vlib_pci_link_speed_cap;
274 format_function_t format_vlib_pci_link_port;
275 format_function_t format_vlib_pci_vpd;
276 format_function_t format_vlib_pci_log;
278 #endif /* included_vlib_pci_h */
281 * fd.io coding-style-patch-verification: ON
284 * eval: (c-set-style "gnu")