FD.io VPP  v18.10-34-gcce845e
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 
99 vlib_pci_device_info_t *vlib_pci_get_device_info (vlib_pci_addr_t * addr,
100  clib_error_t ** error);
101 vlib_pci_addr_t *vlib_pci_get_all_dev_addrs ();
102 vlib_pci_addr_t *vlib_pci_get_addr (vlib_pci_dev_handle_t h);
103 uword vlib_pci_get_private_data (vlib_pci_dev_handle_t h);
104 void vlib_pci_set_private_data (vlib_pci_dev_handle_t h, uword private_data);
105 
106 static inline void
108 {
109  if (!di)
110  return;
111  vec_free (di->product_name);
112  vec_free (di->vpd_r);
113  vec_free (di->vpd_w);
114  vec_free (di->driver_name);
115  clib_mem_free (di);
116 }
117 
118 typedef struct
119 {
122 
123 typedef void (pci_intx_handler_function_t) (vlib_pci_dev_handle_t handle);
124 typedef void (pci_msix_handler_function_t) (vlib_pci_dev_handle_t handle,
125  u16 line);
126 
127 typedef struct _pci_device_registration
128 {
129  /* Driver init function. */
130  clib_error_t *(*init_function) (vlib_main_t * vm,
131  vlib_pci_dev_handle_t handle);
132 
133  /* Interrupt handler */
134  pci_intx_handler_function_t *interrupt_handler;
135 
136  /* List of registrations */
137  struct _pci_device_registration *next_registration;
138 
139  /* Vendor/device ids supported by this driver. */
140  pci_device_id_t supported_devices[];
142 
143 /* Pool of PCI devices. */
144 typedef struct
145 {
149 
151 
152 #define PCI_REGISTER_DEVICE(x,...) \
153  __VA_ARGS__ pci_device_registration_t x; \
154 static void __vlib_add_pci_device_registration_##x (void) \
155  __attribute__((__constructor__)) ; \
156 static void __vlib_add_pci_device_registration_##x (void) \
157 { \
158  vlib_pci_main_t * pm = &pci_main; \
159  x.next_registration = pm->pci_device_registrations; \
160  pm->pci_device_registrations = &x; \
161 } \
162 static void __vlib_rm_pci_device_registration_##x (void) \
163  __attribute__((__destructor__)) ; \
164 static void __vlib_rm_pci_device_registration_##x (void) \
165 { \
166  vlib_pci_main_t * pm = &pci_main; \
167  VLIB_REMOVE_FROM_LINKED_LIST (pm->pci_device_registrations, \
168  &x, next_registration); \
169 } \
170 __VA_ARGS__ pci_device_registration_t x
171 
172 clib_error_t *vlib_pci_bind_to_uio (vlib_pci_addr_t * addr,
173  char *uio_driver_name);
174 
175 /* Configuration space read/write. */
176 clib_error_t *vlib_pci_read_write_config (vlib_pci_dev_handle_t handle,
177  vlib_read_or_write_t read_or_write,
178  uword address,
179  void *data, u32 n_bytes);
180 
181 #define _(t) \
182 static inline clib_error_t * \
183 vlib_pci_read_config_##t (vlib_pci_dev_handle_t h, \
184  uword address, t * data) \
185 { \
186  return vlib_pci_read_write_config (h, VLIB_READ,address, data, \
187  sizeof (data[0])); \
188 }
189 
190 _(u32);
191 _(u16);
192 _(u8);
193 
194 #undef _
195 
196 #define _(t) \
197 static inline clib_error_t * \
198 vlib_pci_write_config_##t (vlib_pci_dev_handle_t h, uword address, \
199  t * data) \
200 { \
201  return vlib_pci_read_write_config (h, VLIB_WRITE, \
202  address, data, sizeof (data[0])); \
203 }
204 
205 _(u32);
206 _(u16);
207 _(u8);
208 
209 #undef _
210 
211 static inline clib_error_t *
212 vlib_pci_intr_enable (vlib_pci_dev_handle_t h)
213 {
214  u16 command;
215  clib_error_t *err;
216 
217  err = vlib_pci_read_config_u16 (h, 4, &command);
218 
219  if (err)
220  return err;
221 
222  command &= ~PCI_COMMAND_INTX_DISABLE;
223 
224  return vlib_pci_write_config_u16 (h, 4, &command);
225 }
226 
227 static inline clib_error_t *
228 vlib_pci_intr_disable (vlib_pci_dev_handle_t h)
229 {
230  u16 command;
231  clib_error_t *err;
232 
233  err = vlib_pci_read_config_u16 (h, 4, &command);
234 
235  if (err)
236  return err;
237 
238  command |= PCI_COMMAND_INTX_DISABLE;
239 
240  return vlib_pci_write_config_u16 (h, 4, &command);
241 }
242 
243 static inline clib_error_t *
244 vlib_pci_bus_master_enable (vlib_pci_dev_handle_t h)
245 {
246  clib_error_t *err;
247  u16 command;
248 
249  /* Set bus master enable (BME) */
250  err = vlib_pci_read_config_u16 (h, 4, &command);
251 
252  if (err)
253  return err;
254 
255  if (command & PCI_COMMAND_BUS_MASTER)
256  return 0;
257 
258  command |= PCI_COMMAND_BUS_MASTER;
259 
260  return vlib_pci_write_config_u16 (h, 4, &command);
261 }
262 
263 clib_error_t *vlib_pci_device_open (vlib_pci_addr_t * addr,
264  pci_device_id_t ids[],
265  vlib_pci_dev_handle_t * handle);
266 void vlib_pci_device_close (vlib_pci_dev_handle_t h);
267 
268 clib_error_t *vlib_pci_map_region (vlib_pci_dev_handle_t h, u32 resource,
269  void **result);
270 
271 clib_error_t *vlib_pci_map_region_fixed (vlib_pci_dev_handle_t h,
272  u32 resource, u8 * addr,
273  void **result);
274 
275 clib_error_t *vlib_pci_register_intx_handler (vlib_pci_dev_handle_t h,
277  intx_handler);
278 clib_error_t *vlib_pci_register_msix_handler (vlib_pci_dev_handle_t h,
279  u32 start, u32 count,
281  msix_handler);
282 clib_error_t *vlib_pci_enable_msix_irq (vlib_pci_dev_handle_t h, u16 start,
283  u16 count);
284 clib_error_t *vlib_pci_disable_msix_irq (vlib_pci_dev_handle_t h, u16 start,
285  u16 count);
286 
291 
292 #endif /* included_vlib_pci_h */
293 
294 /*
295  * fd.io coding-style-patch-verification: ON
296  *
297  * Local Variables:
298  * eval: (c-set-style "gnu")
299  * End:
300  */
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:232
format_function_t format_vlib_pci_addr
Definition: pci.h:288
typedef address
Definition: ip_types.api:35
pci_device_registration_t * pci_device_registrations
Definition: pci.h:147
vlib_read_or_write_t
Definition: defs.h:54
vlib_pci_addr_t * vlib_pci_get_all_dev_addrs()
Definition: pci.c:1242
vlib_pci_main_t pci_main
Definition: pci.c:53
unformat_function_t unformat_vlib_pci_addr
Definition: pci.h:287
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
unsigned char u8
Definition: types.h:56
clib_error_t * vlib_pci_register_intx_handler(vlib_pci_dev_handle_t h, pci_intx_handler_function_t *intx_handler)
Definition: pci.c:723
#define PCI_COMMAND_INTX_DISABLE
Definition: pci_config.h:191
clib_error_t * vlib_pci_read_write_config(vlib_pci_dev_handle_t handle, vlib_read_or_write_t read_or_write, uword address, void *data, u32 n_bytes)
Definition: pci.c:933
void di(unformat_input_t *i)
Definition: unformat.c:163
struct _pci_device_registration pci_device_registration_t
unsigned int u32
Definition: types.h:88
clib_error_t * vlib_pci_bind_to_uio(vlib_pci_addr_t *addr, char *uio_driver_name)
Definition: pci.c:345
static clib_error_t * vlib_pci_intr_disable(vlib_pci_dev_handle_t h)
Definition: pci.h:228
pci_config_type1_regs_t config1
Definition: pci.h:88
u8 config_data[256]
Definition: pci.h:89
unsigned short u16
Definition: types.h:57
u32 vlib_pci_dev_handle_t
Definition: pci.h:97
clib_error_t * vlib_pci_device_open(vlib_pci_addr_t *addr, pci_device_id_t ids[], vlib_pci_dev_handle_t *handle)
Definition: pci.c:1046
static clib_error_t * vlib_pci_bus_master_enable(vlib_pci_dev_handle_t h)
Definition: pci.h:244
vlib_pci_device_info_t * vlib_pci_get_device_info(vlib_pci_addr_t *addr, clib_error_t **error)
Definition: pci.c:162
void( pci_intx_handler_function_t)(vlib_pci_dev_handle_t handle)
Definition: pci.h:123
clib_error_t * vlib_pci_disable_msix_irq(vlib_pci_dev_handle_t h, u16 start, u16 count)
Definition: pci.c:843
vlib_main_t * vm
Definition: buffer.c:294
format_function_t format_vlib_pci_link_speed
Definition: pci.h:289
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:339
u8 * driver_name
Definition: pci.h:82
uword vlib_pci_get_private_data(vlib_pci_dev_handle_t h)
Definition: pci.c:134
void vlib_pci_device_close(vlib_pci_dev_handle_t h)
Definition: pci.c:1091
void( pci_msix_handler_function_t)(vlib_pci_dev_handle_t handle, u16 line)
Definition: pci.h:124
pci_config_type0_regs_t config0
Definition: pci.h:87
static void clib_mem_free(void *p)
Definition: mem.h:205
clib_error_t * vlib_pci_register_msix_handler(vlib_pci_dev_handle_t h, u32 start, u32 count, pci_msix_handler_function_t *msix_handler)
Definition: pci.c:766
clib_error_t * vlib_pci_enable_msix_irq(vlib_pci_dev_handle_t h, u16 start, u16 count)
Definition: pci.c:822
vlib_pci_addr_t addr
Definition: pci.h:66
typedef CLIB_PACKED(union{struct{u16 domain;u8 bus;u8 slot:5;u8 function:3;};u32 as_u32;}) vlib_pci_addr_t
u64 uword
Definition: types.h:112
clib_error_t * vlib_pci_map_region_fixed(vlib_pci_dev_handle_t h, u32 resource, u8 *addr, void **result)
Definition: pci.c:1039
void vlib_pci_set_private_data(vlib_pci_dev_handle_t h, uword private_data)
Definition: pci.c:141
static clib_error_t * vlib_pci_intr_enable(vlib_pci_dev_handle_t h)
Definition: pci.h:212
vlib_pci_addr_t * vlib_pci_get_addr(vlib_pci_dev_handle_t h)
Definition: pci.c:148
clib_error_t * vlib_pci_map_region(vlib_pci_dev_handle_t h, u32 resource, void **result)
Definition: pci.c:1033
format_function_t format_vlib_pci_vpd
Definition: pci.h:290
static void vlib_pci_free_device_info(vlib_pci_device_info_t *di)
Definition: pci.h:107
u16 device_class
Definition: pci.h:72
vlib_main_t * vlib_main
Definition: pci.h:146
u8 * product_name
Definition: pci.h:77
u16 vendor_id
Definition: pci.h:120
struct vlib_pci_device_info vlib_pci_device_info_t
#define PCI_COMMAND_BUS_MASTER
Definition: pci_config.h:183