ethdev: decouple from PCI device
[dpdk.git] / lib / librte_eal / common / include / rte_pci.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 /*   BSD LICENSE
34  *
35  *   Copyright 2013-2014 6WIND S.A.
36  *
37  *   Redistribution and use in source and binary forms, with or without
38  *   modification, are permitted provided that the following conditions
39  *   are met:
40  *
41  *     * Redistributions of source code must retain the above copyright
42  *       notice, this list of conditions and the following disclaimer.
43  *     * Redistributions in binary form must reproduce the above copyright
44  *       notice, this list of conditions and the following disclaimer in
45  *       the documentation and/or other materials provided with the
46  *       distribution.
47  *     * Neither the name of 6WIND S.A. nor the names of its
48  *       contributors may be used to endorse or promote products derived
49  *       from this software without specific prior written permission.
50  *
51  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  */
63
64 #ifndef _RTE_PCI_H_
65 #define _RTE_PCI_H_
66
67 /**
68  * @file
69  *
70  * RTE PCI Interface
71  */
72
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76
77 #include <stdio.h>
78 #include <stdlib.h>
79 #include <limits.h>
80 #include <errno.h>
81 #include <sys/queue.h>
82 #include <stdint.h>
83 #include <inttypes.h>
84
85 #include <rte_debug.h>
86 #include <rte_interrupts.h>
87 #include <rte_dev.h>
88
89 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
90 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
91
92 extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
93 extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
94
95 /** Pathname of PCI devices directory. */
96 const char *pci_get_sysfs_path(void);
97
98 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
99 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
100 #define PCI_PRI_STR_SIZE sizeof("XXXX:XX:XX.X")
101
102 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
103 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
104
105 /** Nb. of values in PCI device identifier format string. */
106 #define PCI_FMT_NVAL 4
107
108 /** Nb. of values in PCI resource format. */
109 #define PCI_RESOURCE_FMT_NVAL 3
110
111 /** Maximum number of PCI resources. */
112 #define PCI_MAX_RESOURCE 6
113
114 /**
115  * A structure describing an ID for a PCI driver. Each driver provides a
116  * table of these IDs for each device that it supports.
117  */
118 struct rte_pci_id {
119         uint32_t class_id;            /**< Class ID (class, subclass, pi) or RTE_CLASS_ANY_ID. */
120         uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
121         uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
122         uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
123         uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
124 };
125
126 /**
127  * A structure describing the location of a PCI device.
128  */
129 struct rte_pci_addr {
130         uint16_t domain;                /**< Device domain */
131         uint8_t bus;                    /**< Device bus */
132         uint8_t devid;                  /**< Device ID */
133         uint8_t function;               /**< Device function. */
134 };
135
136 struct rte_devargs;
137
138 enum rte_kernel_driver {
139         RTE_KDRV_UNKNOWN = 0,
140         RTE_KDRV_IGB_UIO,
141         RTE_KDRV_VFIO,
142         RTE_KDRV_UIO_GENERIC,
143         RTE_KDRV_NIC_UIO,
144         RTE_KDRV_NONE,
145 };
146
147 /**
148  * A structure describing a PCI device.
149  */
150 struct rte_pci_device {
151         TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
152         struct rte_device device;               /**< Inherit core device */
153         struct rte_pci_addr addr;               /**< PCI location. */
154         struct rte_pci_id id;                   /**< PCI ID. */
155         struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
156                                                 /**< PCI Memory Resource */
157         struct rte_intr_handle intr_handle;     /**< Interrupt handle */
158         struct rte_pci_driver *driver;          /**< Associated driver */
159         uint16_t max_vfs;                       /**< sriov enable if not zero */
160         enum rte_kernel_driver kdrv;            /**< Kernel driver passthrough */
161 };
162
163 /**
164  * @internal
165  * Helper macro for drivers that need to convert to struct rte_pci_device.
166  */
167 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
168
169 /** Any PCI device identifier (vendor, device, ...) */
170 #define PCI_ANY_ID (0xffff)
171 #define RTE_CLASS_ANY_ID (0xffffff)
172
173 #ifdef __cplusplus
174 /** C++ macro used to help building up tables of device IDs */
175 #define RTE_PCI_DEVICE(vend, dev) \
176         RTE_CLASS_ANY_ID,         \
177         (vend),                   \
178         (dev),                    \
179         PCI_ANY_ID,               \
180         PCI_ANY_ID
181 #else
182 /** Macro used to help building up tables of device IDs */
183 #define RTE_PCI_DEVICE(vend, dev)          \
184         .class_id = RTE_CLASS_ANY_ID,      \
185         .vendor_id = (vend),               \
186         .device_id = (dev),                \
187         .subsystem_vendor_id = PCI_ANY_ID, \
188         .subsystem_device_id = PCI_ANY_ID
189 #endif
190
191 struct rte_pci_driver;
192
193 /**
194  * Initialisation function for the driver called during PCI probing.
195  */
196 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
197
198 /**
199  * Uninitialisation function for the driver called during hotplugging.
200  */
201 typedef int (pci_remove_t)(struct rte_pci_device *);
202
203 /**
204  * A structure describing a PCI driver.
205  */
206 struct rte_pci_driver {
207         TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
208         struct rte_driver driver;               /**< Inherit core driver. */
209         pci_probe_t *probe;                     /**< Device Probe function. */
210         pci_remove_t *remove;                   /**< Device Remove function. */
211         const struct rte_pci_id *id_table;      /**< ID table, NULL terminated. */
212         uint32_t drv_flags;                     /**< Flags contolling handling of device. */
213 };
214
215 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
216 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
217 /** Device driver supports link state interrupt */
218 #define RTE_PCI_DRV_INTR_LSC    0x0008
219 /** Device driver supports detaching capability */
220 #define RTE_PCI_DRV_DETACHABLE  0x0010
221
222 /**
223  * A structure describing a PCI mapping.
224  */
225 struct pci_map {
226         void *addr;
227         char *path;
228         uint64_t offset;
229         uint64_t size;
230         uint64_t phaddr;
231 };
232
233 /**
234  * A structure describing a mapped PCI resource.
235  * For multi-process we need to reproduce all PCI mappings in secondary
236  * processes, so save them in a tailq.
237  */
238 struct mapped_pci_resource {
239         TAILQ_ENTRY(mapped_pci_resource) next;
240
241         struct rte_pci_addr pci_addr;
242         char path[PATH_MAX];
243         int nb_maps;
244         struct pci_map maps[PCI_MAX_RESOURCE];
245 };
246
247 /** mapped pci device list */
248 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
249
250 /**< Internal use only - Macro used by pci addr parsing functions **/
251 #define GET_PCIADDR_FIELD(in, fd, lim, dlm)                   \
252 do {                                                               \
253         unsigned long val;                                      \
254         char *end;                                              \
255         errno = 0;                                              \
256         val = strtoul((in), &end, 16);                          \
257         if (errno != 0 || end[0] != (dlm) || val > (lim))       \
258                 return -EINVAL;                                 \
259         (fd) = (typeof (fd))val;                                \
260         (in) = end + 1;                                         \
261 } while(0)
262
263 /**
264  * Utility function to produce a PCI Bus-Device-Function value
265  * given a string representation. Assumes that the BDF is provided without
266  * a domain prefix (i.e. domain returned is always 0)
267  *
268  * @param input
269  *      The input string to be parsed. Should have the format XX:XX.X
270  * @param dev_addr
271  *      The PCI Bus-Device-Function address to be returned. Domain will always be
272  *      returned as 0
273  * @return
274  *  0 on success, negative on error.
275  */
276 static inline int
277 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
278 {
279         dev_addr->domain = 0;
280         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
281         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
282         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
283         return 0;
284 }
285
286 /**
287  * Utility function to produce a PCI Bus-Device-Function value
288  * given a string representation. Assumes that the BDF is provided including
289  * a domain prefix.
290  *
291  * @param input
292  *      The input string to be parsed. Should have the format XXXX:XX:XX.X
293  * @param dev_addr
294  *      The PCI Bus-Device-Function address to be returned
295  * @return
296  *  0 on success, negative on error.
297  */
298 static inline int
299 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
300 {
301         GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
302         GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
303         GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
304         GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
305         return 0;
306 }
307 #undef GET_PCIADDR_FIELD
308
309 /**
310  * Utility function to write a pci device name, this device name can later be
311  * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
312  * BDF helpers.
313  *
314  * @param addr
315  *      The PCI Bus-Device-Function address
316  * @param output
317  *      The output buffer string
318  * @param size
319  *      The output buffer size
320  */
321 static inline void
322 rte_eal_pci_device_name(const struct rte_pci_addr *addr,
323                     char *output, size_t size)
324 {
325         RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
326         RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
327                             addr->domain, addr->bus,
328                             addr->devid, addr->function) >= 0);
329 }
330
331 /* Compare two PCI device addresses. */
332 /**
333  * Utility function to compare two PCI device addresses.
334  *
335  * @param addr
336  *      The PCI Bus-Device-Function address to compare
337  * @param addr2
338  *      The PCI Bus-Device-Function address to compare
339  * @return
340  *      0 on equal PCI address.
341  *      Positive on addr is greater than addr2.
342  *      Negative on addr is less than addr2, or error.
343  */
344 static inline int
345 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
346                          const struct rte_pci_addr *addr2)
347 {
348         uint64_t dev_addr, dev_addr2;
349
350         if ((addr == NULL) || (addr2 == NULL))
351                 return -1;
352
353         dev_addr = (addr->domain << 24) | (addr->bus << 16) |
354                                 (addr->devid << 8) | addr->function;
355         dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
356                                 (addr2->devid << 8) | addr2->function;
357
358         if (dev_addr > dev_addr2)
359                 return 1;
360         else if (dev_addr < dev_addr2)
361                 return -1;
362         else
363                 return 0;
364 }
365
366 /**
367  * Scan the content of the PCI bus, and the devices in the devices
368  * list
369  *
370  * @return
371  *  0 on success, negative on error
372  */
373 int rte_eal_pci_scan(void);
374
375 /**
376  * Probe the PCI bus for registered drivers.
377  *
378  * Scan the content of the PCI bus, and call the probe() function for
379  * all registered drivers that have a matching entry in its id_table
380  * for discovered devices.
381  *
382  * @return
383  *   - 0 on success.
384  *   - Negative on error.
385  */
386 int rte_eal_pci_probe(void);
387
388 /**
389  * Map the PCI device resources in user space virtual memory address
390  *
391  * Note that driver should not call this function when flag
392  * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
393  * you when it's on.
394  *
395  * @param dev
396  *   A pointer to a rte_pci_device structure describing the device
397  *   to use
398  *
399  * @return
400  *   0 on success, negative on error and positive if no driver
401  *   is found for the device.
402  */
403 int rte_eal_pci_map_device(struct rte_pci_device *dev);
404
405 /**
406  * Unmap this device
407  *
408  * @param dev
409  *   A pointer to a rte_pci_device structure describing the device
410  *   to use
411  */
412 void rte_eal_pci_unmap_device(struct rte_pci_device *dev);
413
414 /**
415  * @internal
416  * Map a particular resource from a file.
417  *
418  * @param requested_addr
419  *      The starting address for the new mapping range.
420  * @param fd
421  *      The file descriptor.
422  * @param offset
423  *      The offset for the mapping range.
424  * @param size
425  *      The size for the mapping range.
426  * @param additional_flags
427  *      The additional flags for the mapping range.
428  * @return
429  *   - On success, the function returns a pointer to the mapped area.
430  *   - On error, the value MAP_FAILED is returned.
431  */
432 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
433                 size_t size, int additional_flags);
434
435 /**
436  * @internal
437  * Unmap a particular resource.
438  *
439  * @param requested_addr
440  *      The address for the unmapping range.
441  * @param size
442  *      The size for the unmapping range.
443  */
444 void pci_unmap_resource(void *requested_addr, size_t size);
445
446 /**
447  * Probe the single PCI device.
448  *
449  * Scan the content of the PCI bus, and find the pci device specified by pci
450  * address, then call the probe() function for registered driver that has a
451  * matching entry in its id_table for discovered device.
452  *
453  * @param addr
454  *      The PCI Bus-Device-Function address to probe.
455  * @return
456  *   - 0 on success.
457  *   - Negative on error.
458  */
459 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
460
461 /**
462  * Close the single PCI device.
463  *
464  * Scan the content of the PCI bus, and find the pci device specified by pci
465  * address, then call the remove() function for registered driver that has a
466  * matching entry in its id_table for discovered device.
467  *
468  * @param addr
469  *      The PCI Bus-Device-Function address to close.
470  * @return
471  *   - 0 on success.
472  *   - Negative on error.
473  */
474 int rte_eal_pci_detach(const struct rte_pci_addr *addr);
475
476 /**
477  * Dump the content of the PCI bus.
478  *
479  * @param f
480  *   A pointer to a file for output
481  */
482 void rte_eal_pci_dump(FILE *f);
483
484 /**
485  * Register a PCI driver.
486  *
487  * @param driver
488  *   A pointer to a rte_pci_driver structure describing the driver
489  *   to be registered.
490  */
491 void rte_eal_pci_register(struct rte_pci_driver *driver);
492
493 /** Helper for PCI device registration from driver (eth, crypto) instance */
494 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
495 RTE_INIT(pciinitfn_ ##nm); \
496 static void pciinitfn_ ##nm(void) \
497 {\
498         (pci_drv).driver.name = RTE_STR(nm);\
499         rte_eal_pci_register(&pci_drv); \
500 } \
501 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
502
503 /**
504  * Unregister a PCI driver.
505  *
506  * @param driver
507  *   A pointer to a rte_pci_driver structure describing the driver
508  *   to be unregistered.
509  */
510 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
511
512 /**
513  * Read PCI config space.
514  *
515  * @param device
516  *   A pointer to a rte_pci_device structure describing the device
517  *   to use
518  * @param buf
519  *   A data buffer where the bytes should be read into
520  * @param len
521  *   The length of the data buffer.
522  * @param offset
523  *   The offset into PCI config space
524  */
525 int rte_eal_pci_read_config(const struct rte_pci_device *device,
526                             void *buf, size_t len, off_t offset);
527
528 /**
529  * Write PCI config space.
530  *
531  * @param device
532  *   A pointer to a rte_pci_device structure describing the device
533  *   to use
534  * @param buf
535  *   A data buffer containing the bytes should be written
536  * @param len
537  *   The length of the data buffer.
538  * @param offset
539  *   The offset into PCI config space
540  */
541 int rte_eal_pci_write_config(const struct rte_pci_device *device,
542                              const void *buf, size_t len, off_t offset);
543
544 /**
545  * A structure used to access io resources for a pci device.
546  * rte_pci_ioport is arch, os, driver specific, and should not be used outside
547  * of pci ioport api.
548  */
549 struct rte_pci_ioport {
550         struct rte_pci_device *dev;
551         uint64_t base;
552         uint64_t len; /* only filled for memory mapped ports */
553 };
554
555 /**
556  * Initialize a rte_pci_ioport object for a pci device io resource.
557  *
558  * This object is then used to gain access to those io resources (see below).
559  *
560  * @param dev
561  *   A pointer to a rte_pci_device structure describing the device
562  *   to use.
563  * @param bar
564  *   Index of the io pci resource we want to access.
565  * @param p
566  *   The rte_pci_ioport object to be initialized.
567  * @return
568  *  0 on success, negative on error.
569  */
570 int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
571                            struct rte_pci_ioport *p);
572
573 /**
574  * Release any resources used in a rte_pci_ioport object.
575  *
576  * @param p
577  *   The rte_pci_ioport object to be uninitialized.
578  * @return
579  *  0 on success, negative on error.
580  */
581 int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p);
582
583 /**
584  * Read from a io pci resource.
585  *
586  * @param p
587  *   The rte_pci_ioport object from which we want to read.
588  * @param data
589  *   A data buffer where the bytes should be read into
590  * @param len
591  *   The length of the data buffer.
592  * @param offset
593  *   The offset into the pci io resource.
594  */
595 void rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
596                              void *data, size_t len, off_t offset);
597
598 /**
599  * Write to a io pci resource.
600  *
601  * @param p
602  *   The rte_pci_ioport object to which we want to write.
603  * @param data
604  *   A data buffer where the bytes should be read into
605  * @param len
606  *   The length of the data buffer.
607  * @param offset
608  *   The offset into the pci io resource.
609  */
610 void rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
611                               const void *data, size_t len, off_t offset);
612
613 #ifdef __cplusplus
614 }
615 #endif
616
617 #endif /* _RTE_PCI_H_ */