FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
pci.h
Go to the documentation of this file.
1 /*
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 
46 /* *INDENT-OFF* */
47 typedef CLIB_PACKED (union
48 {
49  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* */
59 
60 typedef struct vlib_pci_device_info
61 {
63 #define VLIB_PCI_DEVICE_INFO_F_NOIOMMU (1 << 0);
64 
65  /* addr */
66  vlib_pci_addr_t addr;
67 
68  /* Numa Node */
69  int numa_node;
70 
71  /* Device data */
75 
76  /* Vital Product Data */
80 
81  /* Driver name */
83 
84  /* First 64 bytes of configuration space. */
85  union
86  {
90  };
91 
92  /* IOMMU Group */
94 
96 
98 
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 u32 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h);
107  vlib_pci_dev_handle_t h);
108 
109 uword vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h);
110 void vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
111  uword private_data);
112 
113 static inline void
115 {
116  if (!di)
117  return;
118  vec_free (di->product_name);
119  vec_free (di->vpd_r);
120  vec_free (di->vpd_w);
121  vec_free (di->driver_name);
122  clib_mem_free (di);
123 }
124 
125 typedef struct
126 {
129 
131  vlib_pci_dev_handle_t handle);
133  vlib_pci_dev_handle_t handle,
134  u16 line);
135 
136 typedef struct _pci_device_registration
137 {
138  /* Driver init function. */
139  clib_error_t *(*init_function) (vlib_main_t * vm,
140  vlib_pci_dev_handle_t handle);
141 
142  /* Interrupt handler */
143  pci_intx_handler_function_t *interrupt_handler;
144 
145  /* List of registrations */
146  struct _pci_device_registration *next_registration;
147 
148  /* Vendor/device ids supported by this driver. */
149  pci_device_id_t supported_devices[];
151 
152 /* Pool of PCI devices. */
153 typedef struct
154 {
157  /* logging */
160 
162 
163 #define PCI_REGISTER_DEVICE(x,...) \
164  __VA_ARGS__ pci_device_registration_t x; \
165 static void __vlib_add_pci_device_registration_##x (void) \
166  __attribute__((__constructor__)) ; \
167 static void __vlib_add_pci_device_registration_##x (void) \
168 { \
169  vlib_pci_main_t * pm = &pci_main; \
170  x.next_registration = pm->pci_device_registrations; \
171  pm->pci_device_registrations = &x; \
172 } \
173 static void __vlib_rm_pci_device_registration_##x (void) \
174  __attribute__((__destructor__)) ; \
175 static void __vlib_rm_pci_device_registration_##x (void) \
176 { \
177  vlib_pci_main_t * pm = &pci_main; \
178  VLIB_REMOVE_FROM_LINKED_LIST (pm->pci_device_registrations, \
179  &x, next_registration); \
180 } \
181 __VA_ARGS__ pci_device_registration_t x
182 
183 clib_error_t *vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
184  char *uio_driver_name);
185 
186 /* Configuration space read/write. */
188  vlib_pci_dev_handle_t handle,
189  vlib_read_or_write_t read_or_write,
190  uword address, void *data,
191  u32 n_bytes);
192 
193 /* io space read/write. */
195  vlib_pci_dev_handle_t handle,
196  vlib_read_or_write_t read_or_write,
197  uword address, void *data, u32 n_bytes);
198 
199 
200 #define _(t, x) \
201 static inline clib_error_t * \
202 vlib_pci_read_##x##_##t (vlib_main_t *vm, vlib_pci_dev_handle_t h, \
203  uword address, t * data) \
204 { \
205  return vlib_pci_read_write_##x (vm, h, VLIB_READ,address, data, \
206  sizeof (data[0])); \
207 }
208 
209 _(u32, config);
210 _(u16, config);
211 _(u8, config);
212 
213 _(u32, io);
214 _(u16, io);
215 _(u8, io);
216 
217 #undef _
218 
219 #define _(t, x) \
220 static inline clib_error_t * \
221 vlib_pci_write_##x##_##t (vlib_main_t *vm, vlib_pci_dev_handle_t h, \
222  uword address, t * data) \
223 { \
224  return vlib_pci_read_write_##x (vm, h, VLIB_WRITE, \
225  address, data, sizeof (data[0])); \
226 }
227 
228 _(u32, config);
229 _(u16, config);
230 _(u8, config);
231 
232 _(u32, io);
233 _(u16, io);
234 _(u8, io);
235 
236 #undef _
237 
238 static inline clib_error_t *
239 vlib_pci_intr_enable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
240 {
241  u16 command;
242  clib_error_t *err;
243 
244  err = vlib_pci_read_config_u16 (vm, h, 4, &command);
245 
246  if (err)
247  return err;
248 
249  command &= ~PCI_COMMAND_INTX_DISABLE;
250 
251  return vlib_pci_write_config_u16 (vm, h, 4, &command);
252 }
253 
254 static inline clib_error_t *
255 vlib_pci_intr_disable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
256 {
257  u16 command;
258  clib_error_t *err;
259 
260  err = vlib_pci_read_config_u16 (vm, h, 4, &command);
261 
262  if (err)
263  return err;
264 
265  command |= PCI_COMMAND_INTX_DISABLE;
266 
267  return vlib_pci_write_config_u16 (vm, h, 4, &command);
268 }
269 
270 static inline clib_error_t *
271 vlib_pci_bus_master_enable (vlib_main_t * vm, vlib_pci_dev_handle_t h)
272 {
273  clib_error_t *err;
274  u16 command;
275 
276  /* Set bus master enable (BME) */
277  err = vlib_pci_read_config_u16 (vm, h, 4, &command);
278 
279  if (err)
280  return err;
281 
282  if (command & PCI_COMMAND_BUS_MASTER)
283  return 0;
284 
285  command |= PCI_COMMAND_BUS_MASTER;
286 
287  return vlib_pci_write_config_u16 (vm, h, 4, &command);
288 }
289 
290 clib_error_t *vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
291  pci_device_id_t ids[],
292  vlib_pci_dev_handle_t * handle);
293 void vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h);
294 clib_error_t *vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
295  u32 resource, void **result);
297  vlib_pci_dev_handle_t h,
298  u32 resource, u8 * addr,
299  void **result);
300 clib_error_t *vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h,
301  u32 resource);
303  vlib_pci_dev_handle_t h,
305  intx_handler);
307  vlib_pci_dev_handle_t h,
308  u32 start, u32 count,
310  msix_handler);
312  vlib_pci_dev_handle_t h, u16 start,
313  u16 count);
315  vlib_pci_dev_handle_t h, u16 start,
316  u16 count);
317 clib_error_t *vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h,
318  void *ptr);
319 
321  vlib_pci_dev_handle_t h);
322 
327 
328 #endif /* included_vlib_pci_h */
329 
330 /*
331  * fd.io coding-style-patch-verification: ON
332  *
333  * Local Variables:
334  * eval: (c-set-style "gnu")
335  * End:
336  */
typedef address
Definition: ip_types.api:30
static clib_error_t * vlib_pci_intr_enable(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.h:239
uword vlib_pci_get_private_data(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.c:148
static clib_error_t * vlib_pci_bus_master_enable(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.h:271
pci_device_registration_t * pci_device_registrations
Definition: pci.h:156
vlib_read_or_write_t
Definition: defs.h:54
clib_error_t * vlib_pci_device_open(vlib_main_t *vm, vlib_pci_addr_t *addr, pci_device_id_t ids[], vlib_pci_dev_handle_t *handle)
Definition: pci.c:1215
static clib_error_t * vlib_pci_intr_disable(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.h:255
clib_error_t * vlib_pci_register_msix_handler(vlib_main_t *vm, vlib_pci_dev_handle_t h, u32 start, u32 count, pci_msix_handler_function_t *msix_handler)
Definition: pci.c:826
static void vlib_pci_free_device_info(vlib_pci_device_info_t *di)
Definition: pci.h:114
void() pci_msix_handler_function_t(vlib_main_t *vm, vlib_pci_dev_handle_t handle, u16 line)
Definition: pci.h:132
u8 data[128]
Definition: ipsec.api:248
clib_error_t * vlib_pci_io_region(vlib_main_t *vm, vlib_pci_dev_handle_t h, u32 resource)
Definition: pci.c:1160
unsigned char u8
Definition: types.h:56
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
u32 vlib_log_class_t
Definition: vlib.h:50
#define PCI_COMMAND_INTX_DISABLE
Definition: pci_config.h:191
vlib_pci_addr_t * vlib_pci_get_all_dev_addrs()
Definition: pci.c:1430
void di(unformat_input_t *i)
Definition: unformat.c:163
typedef CLIB_PACKED(union { struct { u16 domain;u8 bus;u8 slot:5;u8 function:3;};u32 as_u32;}) vlib_pci_addr_t
unsigned int u32
Definition: types.h:88
pci_config_type1_regs_t config1
Definition: pci.h:88
u8 config_data[256]
Definition: pci.h:89
vlib_pci_device_info_t * vlib_pci_get_device_info(vlib_main_t *vm, vlib_pci_addr_t *addr, clib_error_t **error)
Definition: pci.c:202
u32 vlib_pci_get_num_msix_interrupts(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.c:177
unsigned short u16
Definition: types.h:57
void vlib_pci_device_close(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.c:1275
unformat_function_t unformat_vlib_pci_addr
Definition: pci.h:323
clib_error_t * vlib_pci_map_region(vlib_main_t *vm, vlib_pci_dev_handle_t h, u32 resource, void **result)
Definition: pci.c:1146
u32 vlib_pci_dev_handle_t
Definition: pci.h:97
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:232
vlib_main_t * vm
Definition: buffer.c:312
format_function_t format_vlib_pci_vpd
Definition: pci.h:326
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
u8 * driver_name
Definition: pci.h:82
clib_error_t * vlib_pci_disable_msix_irq(vlib_main_t *vm, vlib_pci_dev_handle_t h, u16 start, u16 count)
Definition: pci.c:905
clib_error_t * vlib_pci_read_write_config(vlib_main_t *vm, vlib_pci_dev_handle_t handle, vlib_read_or_write_t read_or_write, uword address, void *data, u32 n_bytes)
Definition: pci.c:1017
clib_error_t * vlib_pci_enable_msix_irq(vlib_main_t *vm, vlib_pci_dev_handle_t h, u16 start, u16 count)
Definition: pci.c:883
void() pci_intx_handler_function_t(vlib_main_t *vm, vlib_pci_dev_handle_t handle)
Definition: pci.h:130
clib_error_t * vlib_pci_register_intx_handler(vlib_main_t *vm, vlib_pci_dev_handle_t h, pci_intx_handler_function_t *intx_handler)
Definition: pci.c:775
int vlib_pci_supports_virtual_addr_dma(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.c:1207
pci_config_type0_regs_t config0
Definition: pci.h:87
static void clib_mem_free(void *p)
Definition: mem.h:205
vlib_pci_main_t pci_main
Definition: pci.c:53
clib_error_t * vlib_pci_read_write_io(vlib_main_t *vm, vlib_pci_dev_handle_t handle, vlib_read_or_write_t read_or_write, uword address, void *data, u32 n_bytes)
Definition: pci.c:1176
vlib_pci_addr_t addr
Definition: pci.h:66
clib_error_t * vlib_pci_bind_to_uio(vlib_main_t *vm, vlib_pci_addr_t *addr, char *uio_driver_name)
Definition: pci.c:386
clib_error_t * vlib_pci_map_region_fixed(vlib_main_t *vm, vlib_pci_dev_handle_t h, u32 resource, u8 *addr, void **result)
Definition: pci.c:1153
vlib_pci_addr_t * vlib_pci_get_addr(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.c:163
u64 uword
Definition: types.h:112
struct vlib_pci_device_info vlib_pci_device_info_t
struct _pci_device_registration pci_device_registration_t
u32 vlib_pci_get_numa_node(vlib_main_t *vm, vlib_pci_dev_handle_t h)
Definition: pci.c:170
format_function_t format_vlib_pci_link_speed
Definition: pci.h:325
void vlib_pci_set_private_data(vlib_main_t *vm, vlib_pci_dev_handle_t h, uword private_data)
Definition: pci.c:155
vlib_log_class_t log_default
Definition: pci.h:158
u16 device_class
Definition: pci.h:72
vlib_main_t * vlib_main
Definition: pci.h:155
clib_error_t * vlib_pci_map_dma(vlib_main_t *vm, vlib_pci_dev_handle_t h, void *ptr)
Definition: pci.c:1196
u8 * product_name
Definition: pci.h:77
u16 vendor_id
Definition: pci.h:127
format_function_t format_vlib_pci_addr
Definition: pci.h:324
#define PCI_COMMAND_BUS_MASTER
Definition: pci_config.h:183