4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #ifndef _RTE_CRYPTODEV_PCI_H_
34 #define _RTE_CRYPTODEV_PCI_H_
37 #include "rte_cryptodev.h"
40 * Initialisation function of a crypto driver invoked for each matching
41 * crypto PCI device detected during the PCI probing phase.
43 * @param dev The dev pointer is the address of the *rte_cryptodev*
44 * structure associated with the matching device and which
45 * has been [automatically] allocated in the
46 * *rte_crypto_devices* array.
49 * - 0: Success, the device is properly initialised by the driver.
50 * In particular, the driver MUST have set up the *dev_ops* pointer
51 * of the *dev* structure.
52 * - <0: Error code of the device initialisation failure.
54 typedef int (*cryptodev_pci_init_t)(struct rte_cryptodev *dev);
57 * Finalisation function of a driver invoked for each matching
58 * PCI device detected during the PCI closing phase.
60 * @param dev The dev pointer is the address of the *rte_cryptodev*
61 * structure associated with the matching device and which
62 * has been [automatically] allocated in the
63 * *rte_crypto_devices* array.
66 * - 0: Success, the device is properly finalised by the driver.
67 * In particular, the driver MUST free the *dev_ops* pointer
68 * of the *dev* structure.
69 * - <0: Error code of the device initialisation failure.
71 typedef int (*cryptodev_pci_uninit_t)(struct rte_cryptodev *dev);
75 * Wrapper for use by pci drivers as a .probe function to attach to a crypto
79 rte_cryptodev_pci_generic_probe(struct rte_pci_device *pci_dev,
80 size_t private_data_size,
81 cryptodev_pci_init_t dev_init);
85 * Wrapper for use by pci drivers as a .remove function to detach a crypto
89 rte_cryptodev_pci_generic_remove(struct rte_pci_device *pci_dev,
90 cryptodev_pci_uninit_t dev_uninit);
92 #endif /* _RTE_CRYPTODEV_PCI_H_ */