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>
46 typedef CLIB_PACKED (union
50 u16 domain; u8 bus; u8 slot: 5; u8 function:3;};
51 u32 as_u32;}) vlib_pci_addr_t;
53 typedef struct vlib_pci_device
55 /* Operating system handle for this device. */
58 vlib_pci_addr_t bus_address;
60 /* First 64 bytes of configuration space. */
63 pci_config_type0_regs_t config0;
64 pci_config_type1_regs_t config1;
68 /* Interrupt handler */
69 void (*interrupt_handler) (struct vlib_pci_device * dev);
77 /* Vital Product Data */
89 u16 vendor_id, device_id;
92 typedef struct _pci_device_registration
94 /* Driver init function. */
95 clib_error_t *(*init_function) (vlib_main_t * vm, vlib_pci_device_t * dev);
97 /* Interrupt handler */
98 void (*interrupt_handler) (vlib_pci_device_t * dev);
100 /* List of registrations */
101 struct _pci_device_registration *next_registration;
103 /* Vendor/device ids supported by this driver. */
104 pci_device_id_t supported_devices[];
105 } pci_device_registration_t;
107 /* Pool of PCI devices. */
110 vlib_main_t *vlib_main;
111 vlib_pci_device_t *pci_devs;
112 pci_device_registration_t *pci_device_registrations;
113 uword *pci_dev_index_by_pci_addr;
116 extern vlib_pci_main_t pci_main;
118 #define PCI_REGISTER_DEVICE(x,...) \
119 __VA_ARGS__ pci_device_registration_t x; \
120 static void __vlib_add_pci_device_registration_##x (void) \
121 __attribute__((__constructor__)) ; \
122 static void __vlib_add_pci_device_registration_##x (void) \
124 vlib_pci_main_t * pm = &pci_main; \
125 x.next_registration = pm->pci_device_registrations; \
126 pm->pci_device_registrations = &x; \
128 __VA_ARGS__ pci_device_registration_t x
130 clib_error_t *vlib_pci_bind_to_uio (vlib_pci_device_t * d,
131 char *uio_driver_name);
133 /* Configuration space read/write. */
134 clib_error_t *vlib_pci_read_write_config (vlib_pci_device_t * dev,
135 vlib_read_or_write_t read_or_write,
137 void *data, u32 n_bytes);
140 static inline clib_error_t * \
141 vlib_pci_read_config_##t (vlib_pci_device_t * dev, \
142 uword address, t * data) \
144 return vlib_pci_read_write_config (dev, VLIB_READ,address, data, \
155 static inline clib_error_t * \
156 vlib_pci_write_config_##t (vlib_pci_device_t * dev, uword address, \
159 return vlib_pci_read_write_config (dev, VLIB_WRITE, \
160 address, data, sizeof (data[0])); \
169 static inline clib_error_t *
170 vlib_pci_intr_enable (vlib_pci_device_t * dev)
175 err = vlib_pci_read_config_u16 (dev, 4, &command);
180 command &= ~PCI_COMMAND_INTX_DISABLE;
182 return vlib_pci_write_config_u16 (dev, 4, &command);
185 static inline clib_error_t *
186 vlib_pci_intr_disable (vlib_pci_device_t * dev)
191 err = vlib_pci_read_config_u16 (dev, 4, &command);
196 command |= PCI_COMMAND_INTX_DISABLE;
198 return vlib_pci_write_config_u16 (dev, 4, &command);
201 static inline clib_error_t *
202 vlib_pci_bus_master_enable (vlib_pci_device_t * dev)
207 /* Set bus master enable (BME) */
208 err = vlib_pci_read_config_u16 (dev, 4, &command);
213 if (!(command & PCI_COMMAND_BUS_MASTER))
216 command |= PCI_COMMAND_BUS_MASTER;
218 return vlib_pci_write_config_u16 (dev, 4, &command);
221 clib_error_t *vlib_pci_map_resource (vlib_pci_device_t * dev, u32 resource,
224 clib_error_t *vlib_pci_map_resource_fixed (vlib_pci_device_t * dev,
225 u32 resource, u8 * addr,
229 void vlib_pci_free_device (vlib_pci_device_t * dev);
231 unformat_function_t unformat_vlib_pci_addr;
232 format_function_t format_vlib_pci_addr;
233 format_function_t format_vlib_pci_handle;
234 format_function_t format_vlib_pci_link_speed;
236 #endif /* included_vlib_pci_h */
239 * fd.io coding-style-patch-verification: ON
242 * eval: (c-set-style "gnu")