2 * Copyright (c) 2013 Qualcomm Atheros, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted (subject to the limitations in the
7 * disclaimer below) provided that the following conditions are met:
9 * * Redistributions of source code must retain the above copyright
10 * 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 the
14 * documentation and/or other materials provided with the
17 * * Neither the name of Qualcomm Atheros 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.
21 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
22 * GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
23 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
32 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
33 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * @ingroup adf_os_public
38 * This file abstracts the PCI subsystem.
40 #ifndef __ADF_OS_PCI_H
41 #define __ADF_OS_PCI_H
43 #include <adf_os_pci_pvt.h>
46 * @brief Define the entry point for the PCI module.
48 #define adf_os_pci_module_init(_fn) __adf_os_pci_module_init(_fn)
51 * @brief Define the exit point for the PCI module.
53 #define adf_os_pci_module_exit(_fn) __adf_os_pci_module_exit(_fn)
56 * @brief Setup the following driver information: name, PCI IDs of devices
57 * supported and some device handlers.
59 #define adf_os_pci_set_drv_info(_name, _pci_ids, _attach, _detach, _suspend, _resume) \
60 __adf_os_pci_set_drv_info(_name, _pci_ids, _attach, _detach, _suspend, _resume)
63 * @brief Read a byte of PCI config space.
65 * @param[in] osdev platform device instance
66 * @param[in] offset offset to read
67 * @param[out] val value read
69 * @return status of operation
72 adf_os_pci_config_read8(adf_os_device_t osdev, int offset, a_uint8_t *val)
74 return __adf_os_pci_config_read8(osdev, offset, val);
78 * @brief Write a byte to PCI config space.
80 * @param[in] osdev platform device instance
81 * @param[in] offset offset to write
82 * @param[in] val value to write
84 * @return status of operation
87 adf_os_pci_config_write8(adf_os_device_t osdev, int offset, a_uint8_t val)
89 return __adf_os_pci_config_write8(osdev, offset, val);
93 * @brief Read 2 bytes of PCI config space.
95 * @param[in] osdev platform device instance
96 * @param[in] offset offset to read
97 * @param[out] val value read
99 * @return status of operation
102 adf_os_pci_config_read16(adf_os_device_t osdev, int offset, a_uint16_t *val)
104 return __adf_os_pci_config_read16(osdev, offset, val);
108 * @brief Write 2 bytes to PCI config space.
110 * @param[in] osdev platform device instance
111 * @param[in] offset offset to write
112 * @param[in] val value to write
114 * @return status of operation
117 adf_os_pci_config_write16(adf_os_device_t osdev, int offset, a_uint16_t val)
119 return __adf_os_pci_config_write16(osdev, offset, val);
123 * @brief Read 4 bytes of PCI config space.
125 * @param[in] osdev platform device instance
126 * @param[in] offset offset to read
127 * @param[out] val value read
129 * @return status of operation
132 adf_os_pci_config_read32(adf_os_device_t osdev, int offset, a_uint32_t *val)
134 return __adf_os_pci_config_read32(osdev, offset, val);
138 * @brief Write 4 bytes to PCI config space.
140 * @param[in] osdev platform device instance
141 * @param[in] offset offset to write
142 * @param[in] val value to write
144 * @return status of operation
147 adf_os_pci_config_write32(adf_os_device_t osdev, int offset, a_uint32_t val)
149 return __adf_os_pci_config_write32(osdev, offset, val);