text: /*-
   *   BSD LICENSE
   *
   *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   *   All rights reserved.
   *
   *   Redistribution and use in source and binary forms, with or without
   *   modification, are permitted provided that the following conditions
   *   are met:
   *
   *     * Redistributions of source code must retain the above copyright
   *       notice, this list of conditions and the following disclaimer.
   *     * Redistributions in binary form must reproduce the above copyright
   *       notice, this list of conditions and the following disclaimer in
   *       the documentation and/or other materials provided with the
   *       distribution.
   *     * Neither the name of Intel Corporation nor the names of its
   *       contributors may be used to endorse or promote products derived
   *       from this software without specific prior written permission.
   *
   *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  /*   BSD LICENSE
   *
   *   Copyright 2013-2014 6WIND S.A.
   *
   *   Redistribution and use in source and binary forms, with or without
   *   modification, are permitted provided that the following conditions
   *   are met:
   *
   *     * Redistributions of source code must retain the above copyright
   *       notice, this list of conditions and the following disclaimer.
   *     * Redistributions in binary form must reproduce the above copyright
   *       notice, this list of conditions and the following disclaimer in
   *       the documentation and/or other materials provided with the
   *       distribution.
   *     * Neither the name of 6WIND S.A. nor the names of its
   *       contributors may be used to endorse or promote products derived
   *       from this software without specific prior written permission.
   *
   *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  
  #ifndef _RTE_PCI_H_
  #define _RTE_PCI_H_
  
  /**
   * @file
   *
   * RTE PCI Interface
   */
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  #include <stdlib.h>
  #include <limits.h>
  #include <errno.h>
  #include <sys/queue.h>
  #include <stdint.h>
  #include <inttypes.h>
  
  #include <rte_interrupts.h>
  
  TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
  TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
  
  extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
  extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
  
  /** Pathname of PCI devices directory. */
  #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
  
  /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
  #define PCI_PRI_FMT "%.4"PRIx16":%.2"PRIx8":%.2"PRIx8".%"PRIx8
  
  /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
  #define PCI_SHORT_PRI_FMT "%.2"PRIx8":%.2"PRIx8".%"PRIx8
  
  /** Nb. of values in PCI device identifier format string. */
  #define PCI_FMT_NVAL 4
  
  /** Nb. of values in PCI resource format. */
  #define PCI_RESOURCE_FMT_NVAL 3
  
  /**
   * A structure describing a PCI resource.
   */
  struct rte_pci_resource {
  	uint64_t phys_addr;   /**< Physical address, 0 if no resource. */
  	uint64_t len;         /**< Length of the resource. */
  	void *addr;           /**< Virtual address, NULL when not mapped. */
  };
  
  /** Maximum number of PCI resources. */
  #define PCI_MAX_RESOURCE 7
  
  /**
   * A structure describing an ID for a PCI driver. Each driver provides a
   * table of these IDs for each device that it supports.
   */
  struct rte_pci_id {
  	uint16_t vendor_id;           /**< Vendor ID or PCI_ANY_ID. */
  	uint16_t device_id;           /**< Device ID or PCI_ANY_ID. */
  	uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
  	uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
  };
  
  /**
   * A structure describing the location of a PCI device.
   */
  struct rte_pci_addr {
  	uint16_t domain;                /**< Device domain */
  	uint8_t bus;                    /**< Device bus */
  	uint8_t devid;                  /**< Device ID */
  	uint8_t function;               /**< Device function. */
  };
  
  struct rte_devargs;
  
  /**
   * A structure describing a PCI device.
   */
  struct rte_pci_device {
  	TAILQ_ENTRY(rte_pci_device) next;       /**< Next probed PCI device. */
  	struct rte_pci_addr addr;               /**< PCI location. */
  	struct rte_pci_id id;                   /**< PCI ID. */
  	struct rte_pci_resource mem_resource[PCI_MAX_RESOURCE];   /**< PCI Memory Resource */
  	struct rte_intr_handle intr_handle;     /**< Interrupt handle */
  	const struct rte_pci_driver *driver;    /**< Associated driver */
  	uint16_t max_vfs;                       /**< sriov enable if not zero */
  	int numa_node;                          /**< NUMA node connection */
  	struct rte_devargs *devargs;            /**< Device user arguments */
  };
  
  /** Any PCI device identifier (vendor, device, ...) */
  #define PCI_ANY_ID (0xffff)
  
  #ifdef __cplusplus
  /** C++ macro used to help building up tables of device IDs */
  #define RTE_PCI_DEVICE(vend, dev) \
  	(vend),                   \
  	(dev),                    \
  	PCI_ANY_ID,               \
  	PCI_ANY_ID
  #else
  /** Macro used to help building up tables of device IDs */
  #define RTE_PCI_DEVICE(vend, dev)          \
  	.vendor_id = (vend),               \
  	.device_id = (dev),                \
  	.subsystem_vendor_id = PCI_ANY_ID, \
  	.subsystem_device_id = PCI_ANY_ID
  #endif
  
  struct rte_pci_driver;
  
  /**
   * Initialisation function for the driver called during PCI probing.
   */
  typedef int (pci_devinit_t)(struct rte_pci_driver *, struct rte_pci_device *);
  
  /**
   * A structure describing a PCI driver.
   */
  struct rte_pci_driver {
  	TAILQ_ENTRY(rte_pci_driver) next;       /**< Next in list. */
  	const char *name;                       /**< Driver name. */
  	pci_devinit_t *devinit;                 /**< Device init. function. */
  	struct rte_pci_id *id_table;            /**< ID table, NULL terminated. */
  	uint32_t drv_flags;                     /**< Flags contolling handling of device. */
  };
  
  /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
  #define RTE_PCI_DRV_NEED_MAPPING 0x0001
  /** Device driver must be registered several times until failure - deprecated */
  #pragma GCC poison RTE_PCI_DRV_MULTIPLE
  /** Device needs to be unbound even if no module is provided */
  #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
  /** Device driver supports link state interrupt */
  #define RTE_PCI_DRV_INTR_LSC	0x0008
  
  /**< Internal use only - Macro used by pci addr parsing functions **/
  #define GET_PCIADDR_FIELD(in, fd, lim, dlm)                   \
  do {                                                               \
  	unsigned long val;                                      \
  	char *end;                                              \
  	errno = 0;                                              \
  	val = strtoul((in), &end, 16);                          \
  	if (errno != 0 || end[0] != (dlm) || val > (lim))       \
  		return (-EINVAL);                               \
  	(fd) = (typeof (fd))val;                                \
  	(in) = end + 1;                                         \
  } while(0)
  
  /**
   * Utility function to produce a PCI Bus-Device-Function value
   * given a string representation. Assumes that the BDF is provided without
   * a domain prefix (i.e. domain returned is always 0)
   *
   * @param input
   * 	The input string to be parsed. Should have the format XX:XX.X
   * @param dev_addr
   * 	The PCI Bus-Device-Function address to be returned. Domain will always be
   * 	returned as 0
   * @return
   *  0 on success, negative on error.
   */
  static inline int
  eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
  {
  	dev_addr->domain = 0;
  	GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
  	GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
  	GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
  	return (0);
  }
  
  /**
   * Utility function to produce a PCI Bus-Device-Function value
   * given a string representation. Assumes that the BDF is provided including
   * a domain prefix.
   *
   * @param input
   * 	The input string to be parsed. Should have the format XXXX:XX:XX.X
   * @param dev_addr
   * 	The PCI Bus-Device-Function address to be returned
   * @return
   *  0 on success, negative on error.
   */
  static inline int
  eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
  {
  	GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
  	GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
  	GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
  	GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
  	return (0);
  }
  #undef GET_PCIADDR_FIELD
  
  /**
   * Probe the PCI bus for registered drivers.
   *
   * Scan the content of the PCI bus, and call the probe() function for
   * all registered drivers that have a matching entry in its id_table
   * for discovered devices.
   *
   * @return
   *   - 0 on success.
   *   - Negative on error.
   */
  int rte_eal_pci_probe(void);
  
  /**
   * Dump the content of the PCI bus.
   *
   * @param f
   *   A pointer to a file for output
   */
  void rte_eal_pci_dump(FILE *f);
  
  /**
   * Register a PCI driver.
   *
   * @param driver
   *   A pointer to a rte_pci_driver structure describing the driver
   *   to be registered.
   */
  void rte_eal_pci_register(struct rte_pci_driver *driver);
  
  /**
   * Unregister a PCI driver.
   *
   * @param driver
   *   A pointer to a rte_pci_driver structure describing the driver
   *   to be unregistered.
   */
  void rte_eal_pci_unregister(struct rte_pci_driver *driver);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* _RTE_PCI_H_ */
  