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);
76 /* Vital Product Data */
84 /* First 64 bytes of configuration space. */
87 pci_config_type0_regs_t config0;
88 pci_config_type1_regs_t config1;
95 } vlib_pci_device_info_t;
97 typedef u32 vlib_pci_dev_handle_t;
99 vlib_pci_device_info_t *vlib_pci_get_device_info (vlib_main_t * vm,
100 vlib_pci_addr_t * addr,
101 clib_error_t ** error);
102 vlib_pci_addr_t *vlib_pci_get_all_dev_addrs ();
103 vlib_pci_addr_t *vlib_pci_get_addr (vlib_main_t * vm,
104 vlib_pci_dev_handle_t h);
105 uword vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h);
106 void vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
110 vlib_pci_free_device_info (vlib_pci_device_info_t * di)
114 vec_free (di->product_name);
115 vec_free (di->vpd_r);
116 vec_free (di->vpd_w);
117 vec_free (di->driver_name);
123 u16 vendor_id, device_id;
126 typedef void (pci_intx_handler_function_t) (vlib_main_t * vm,
127 vlib_pci_dev_handle_t handle);
128 typedef void (pci_msix_handler_function_t) (vlib_main_t * vm,
129 vlib_pci_dev_handle_t handle,
132 typedef struct _pci_device_registration
134 /* Driver init function. */
135 clib_error_t *(*init_function) (vlib_main_t * vm,
136 vlib_pci_dev_handle_t handle);
138 /* Interrupt handler */
139 pci_intx_handler_function_t *interrupt_handler;
141 /* List of registrations */
142 struct _pci_device_registration *next_registration;
144 /* Vendor/device ids supported by this driver. */
145 pci_device_id_t supported_devices[];
146 } pci_device_registration_t;
148 /* Pool of PCI devices. */
151 vlib_main_t *vlib_main;
152 pci_device_registration_t *pci_device_registrations;
154 vlib_log_class_t log_default;
157 extern vlib_pci_main_t pci_main;
159 #define PCI_REGISTER_DEVICE(x,...) \
160 __VA_ARGS__ pci_device_registration_t x; \
161 static void __vlib_add_pci_device_registration_##x (void) \
162 __attribute__((__constructor__)) ; \
163 static void __vlib_add_pci_device_registration_##x (void) \
165 vlib_pci_main_t * pm = &pci_main; \
166 x.next_registration = pm->pci_device_registrations; \
167 pm->pci_device_registrations = &x; \
169 static void __vlib_rm_pci_device_registration_##x (void) \
170 __attribute__((__destructor__)) ; \
171 static void __vlib_rm_pci_device_registration_##x (void) \
173 vlib_pci_main_t * pm = &pci_main; \
174 VLIB_REMOVE_FROM_LINKED_LIST (pm->pci_device_registrations, \
175 &x, next_registration); \
177 __VA_ARGS__ pci_device_registration_t x
179 clib_error_t *vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
180 char *uio_driver_name);
182 /* Configuration space read/write. */
183 clib_error_t *vlib_pci_read_write_config (vlib_main_t * vm,
184 vlib_pci_dev_handle_t handle,
185 vlib_read_or_write_t read_or_write,
186 uword address, void *data,
189 /* io space read/write. */
190 clib_error_t *vlib_pci_read_write_io (vlib_main_t * vm,
191 vlib_pci_dev_handle_t handle,
192 vlib_read_or_write_t read_or_write,
193 uword address, void *data, u32 n_bytes);
197 static inline clib_error_t * \
198 vlib_pci_read_##x##_##t (vlib_main_t *vm, vlib_pci_dev_handle_t h, \
199 uword address, t * data) \
201 return vlib_pci_read_write_##x (vm, h, VLIB_READ,address, data, \
216 static inline clib_error_t * \
217 vlib_pci_write_##x##_##t (vlib_main_t *vm, vlib_pci_dev_handle_t h, \
218 uword address, t * data) \
220 return vlib_pci_read_write_##x (vm, h, VLIB_WRITE, \
221 address, data, sizeof (data[0])); \
234 static inline clib_error_t *
235 vlib_pci_intr_enable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
240 err = vlib_pci_read_config_u16 (vm, h, 4, &command);
245 command &= ~PCI_COMMAND_INTX_DISABLE;
247 return vlib_pci_write_config_u16 (vm, h, 4, &command);
250 static inline clib_error_t *
251 vlib_pci_intr_disable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
256 err = vlib_pci_read_config_u16 (vm, h, 4, &command);
261 command |= PCI_COMMAND_INTX_DISABLE;
263 return vlib_pci_write_config_u16 (vm, h, 4, &command);
266 static inline clib_error_t *
267 vlib_pci_bus_master_enable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
272 /* Set bus master enable (BME) */
273 err = vlib_pci_read_config_u16 (vm, h, 4, &command);
278 if (command & PCI_COMMAND_BUS_MASTER)
281 command |= PCI_COMMAND_BUS_MASTER;
283 return vlib_pci_write_config_u16 (vm, h, 4, &command);
286 clib_error_t *vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
287 pci_device_id_t ids[],
288 vlib_pci_dev_handle_t * handle);
289 void vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h);
290 clib_error_t *vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
291 u32 resource, void **result);
292 clib_error_t *vlib_pci_map_region_fixed (vlib_main_t * vm,
293 vlib_pci_dev_handle_t h,
294 u32 resource, u8 * addr,
296 clib_error_t *vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
298 clib_error_t *vlib_pci_register_intx_handler (vlib_main_t * vm,
299 vlib_pci_dev_handle_t h,
300 pci_intx_handler_function_t *
302 clib_error_t *vlib_pci_register_msix_handler (vlib_main_t * vm,
303 vlib_pci_dev_handle_t h,
304 u32 start, u32 count,
305 pci_msix_handler_function_t *
307 clib_error_t *vlib_pci_enable_msix_irq (vlib_main_t * vm,
308 vlib_pci_dev_handle_t h, u16 start,
310 clib_error_t *vlib_pci_disable_msix_irq (vlib_main_t * vm,
311 vlib_pci_dev_handle_t h, u16 start,
313 clib_error_t *vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h,
316 int vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm,
317 vlib_pci_dev_handle_t h);
319 unformat_function_t unformat_vlib_pci_addr;
320 format_function_t format_vlib_pci_addr;
321 format_function_t format_vlib_pci_link_speed;
322 format_function_t format_vlib_pci_vpd;
324 #endif /* included_vlib_pci_h */
327 * fd.io coding-style-patch-verification: ON
330 * eval: (c-set-style "gnu")