common/mlx5: fix user mode register access command
[dpdk.git] / lib / librte_pci / rte_pci.h
index ea0897c..a03235d 100644 (file)
@@ -1,35 +1,6 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
- *   Copyright 2013-2014 6WIND S.A.
- *   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.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2015 Intel Corporation.
+ * Copyright 2013-2014 6WIND S.A.
  */
 
 #ifndef _RTE_PCI_H_
@@ -46,18 +17,13 @@ extern "C" {
 #endif
 
 #include <stdio.h>
-#include <stdlib.h>
 #include <limits.h>
-#include <errno.h>
 #include <sys/queue.h>
-#include <stdint.h>
 #include <inttypes.h>
-
-#include <rte_debug.h>
-#include <rte_interrupts.h>
+#include <sys/types.h>
 
 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
-#define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
+#define PCI_PRI_FMT "%.4" PRIx32 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
 #define PCI_PRI_STR_SIZE sizeof("XXXXXXXX:XX:XX.X")
 
 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
@@ -135,38 +101,6 @@ struct mapped_pci_resource {
 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
 
 /**
- * @deprecated
- * 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.
- */
-int eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr);
-
-/**
- * @deprecated
- * 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.
- */
-int eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr);
-
-/**
- * @deprecated
  * Utility function to write a pci device name, this device name can later be
  * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
  * BDF helpers.
@@ -179,39 +113,8 @@ int eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr);
  *     The output buffer size
  */
 void rte_pci_device_name(const struct rte_pci_addr *addr,
-                        char *output, size_t size);
-
-/**
- * Utility function to write a pci device name, this device name can later be
- * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
- * BDF helpers.
- *
- * @param addr
- *     The PCI Bus-Device-Function address
- * @param output
- *     The output buffer string
- * @param size
- *     The output buffer size
- */
-void pci_device_name(const struct rte_pci_addr *addr,
                     char *output, size_t size);
 
-/**
- * @deprecated
- * Utility function to compare two PCI device addresses.
- *
- * @param addr
- *     The PCI Bus-Device-Function address to compare
- * @param addr2
- *     The PCI Bus-Device-Function address to compare
- * @return
- *     0 on equal PCI address.
- *     Positive on addr is greater than addr2.
- *     Negative on addr is less than addr2, or error.
- */
-int rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
-                            const struct rte_pci_addr *addr2);
-
 /**
  * Utility function to compare two PCI device addresses.
  *
@@ -224,8 +127,8 @@ int rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
  *     Positive on addr is greater than addr2.
  *     Negative on addr is less than addr2, or error.
  */
-int pci_addr_cmp(const struct rte_pci_addr *addr,
-                const struct rte_pci_addr *addr2);
+int rte_pci_addr_cmp(const struct rte_pci_addr *addr,
+                    const struct rte_pci_addr *addr2);
 
 
 /**
@@ -240,7 +143,7 @@ int pci_addr_cmp(const struct rte_pci_addr *addr,
  *     0 on success
  *     <0 otherwise
  */
-int pci_addr_parse(const char *str, struct rte_pci_addr *addr);
+int rte_pci_addr_parse(const char *str, struct rte_pci_addr *addr);
 
 /**
  * Map a particular resource from a file.
@@ -257,7 +160,7 @@ int pci_addr_parse(const char *str, struct rte_pci_addr *addr);
  *      The additional flags for the mapping range.
  * @return
  *   - On success, the function returns a pointer to the mapped area.
- *   - On error, the value MAP_FAILED is returned.
+ *   - On error, MAP_FAILED is returned.
  */
 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
                size_t size, int additional_flags);