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);
82 /* Vital Product Data */
94 u16 vendor_id, device_id;
97 typedef struct _pci_device_registration
99 /* Driver init function. */
100 clib_error_t *(*init_function) (vlib_main_t * vm, vlib_pci_device_t * dev);
102 /* Interrupt handler */
103 void (*interrupt_handler) (vlib_pci_device_t * dev);
105 /* List of registrations */
106 struct _pci_device_registration *next_registration;
108 /* Vendor/device ids supported by this driver. */
109 pci_device_id_t supported_devices[];
110 } pci_device_registration_t;
112 /* Pool of PCI devices. */
115 vlib_main_t *vlib_main;
116 vlib_pci_device_t *pci_devs;
117 pci_device_registration_t *pci_device_registrations;
118 uword *pci_dev_index_by_pci_addr;
121 extern vlib_pci_main_t pci_main;
123 #define PCI_REGISTER_DEVICE(x,...) \
124 __VA_ARGS__ pci_device_registration_t x; \
125 static void __vlib_add_pci_device_registration_##x (void) \
126 __attribute__((__constructor__)) ; \
127 static void __vlib_add_pci_device_registration_##x (void) \
129 vlib_pci_main_t * pm = &pci_main; \
130 x.next_registration = pm->pci_device_registrations; \
131 pm->pci_device_registrations = &x; \
133 __VA_ARGS__ pci_device_registration_t x
135 clib_error_t *vlib_pci_bind_to_uio (vlib_pci_device_t * d,
136 char *uio_driver_name);
138 /* Configuration space read/write. */
139 clib_error_t *vlib_pci_read_write_config (vlib_pci_device_t * dev,
140 vlib_read_or_write_t read_or_write,
142 void *data, u32 n_bytes);
145 static inline clib_error_t * \
146 vlib_pci_read_config_##t (vlib_pci_device_t * dev, \
147 uword address, t * data) \
149 return vlib_pci_read_write_config (dev, VLIB_READ,address, data, \
160 static inline clib_error_t * \
161 vlib_pci_write_config_##t (vlib_pci_device_t * dev, uword address, \
164 return vlib_pci_read_write_config (dev, VLIB_WRITE, \
165 address, data, sizeof (data[0])); \
174 static inline clib_error_t *
175 vlib_pci_intr_enable (vlib_pci_device_t * dev)
180 err = vlib_pci_read_config_u16 (dev, 4, &command);
185 command &= ~PCI_COMMAND_INTX_DISABLE;
187 return vlib_pci_write_config_u16 (dev, 4, &command);
190 static inline clib_error_t *
191 vlib_pci_intr_disable (vlib_pci_device_t * dev)
196 err = vlib_pci_read_config_u16 (dev, 4, &command);
201 command |= PCI_COMMAND_INTX_DISABLE;
203 return vlib_pci_write_config_u16 (dev, 4, &command);
206 static inline clib_error_t *
207 vlib_pci_bus_master_enable (vlib_pci_device_t * dev)
212 /* Set bus master enable (BME) */
213 err = vlib_pci_read_config_u16 (dev, 4, &command);
218 if (command & PCI_COMMAND_BUS_MASTER)
221 command |= PCI_COMMAND_BUS_MASTER;
223 return vlib_pci_write_config_u16 (dev, 4, &command);
226 clib_error_t *vlib_pci_map_resource (vlib_pci_device_t * dev, u32 resource,
229 clib_error_t *vlib_pci_map_resource_fixed (vlib_pci_device_t * dev,
230 u32 resource, u8 * addr,
233 vlib_pci_device_t *vlib_get_pci_device (vlib_pci_addr_t * addr);
235 void vlib_pci_free_device (vlib_pci_device_t * dev);
237 unformat_function_t unformat_vlib_pci_addr;
238 format_function_t format_vlib_pci_addr;
239 format_function_t format_vlib_pci_handle;
240 format_function_t format_vlib_pci_link_speed;
241 format_function_t format_vlib_pci_vpd;
243 #endif /* included_vlib_pci_h */
246 * fd.io coding-style-patch-verification: ON
249 * eval: (c-set-style "gnu")