doc: replace @return by Return:

[platform/kernel/u-boot.git] / arch / x86 / include / asm / pci.h

diff --git a/arch/x86/include/asm/pci.h b/arch/x86/include/asm/pci.h
index 6d68ab6..1c30b32 100644 (file)
--- a/arch/x86/include/asm/pci.h
+++ b/arch/x86/include/asm/pci.h
@@ -1,37 +1,78 @@
-
-
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * (C) Copyright 2002
  * Daniel Engström, Omicron Ceti AB, daniel@omicron.se
+ */
+
+#ifndef _PCI_I386_H_
+#define _PCI_I386_H_
+
+#include <pci.h>
+
+/* bus mapping constants (used for PCI core initialization) */
+#define PCI_REG_ADDR   0xcf8
+#define PCI_REG_DATA   0xcfc
+
+#define PCI_CFG_EN     0x80000000
+
+#ifndef __ASSEMBLY__
+
+/**
+ * pci_x86_read_config() - Read a configuration value from a device
  *
- * See file CREDITS for list of people who contributed to this
- * project.
+ * This function can be called before PCI is set up in driver model.
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
+ * @bdf:       PCI device address: bus, device and function -see PCI_BDF()
+ * @offset:    Register offset to read
+ * @valuep:    Place to put the returned value
+ * @size:      Access size
+ * Return: 0 if OK, -ve on error
+ */
+int pci_x86_read_config(pci_dev_t bdf, uint offset, ulong *valuep,
+                       enum pci_size_t size);
+
+/**
+ * pci_bus_write_config() - Write a configuration value to a device
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * This function can be called before PCI is set up in driver model.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
+ * @bdf:       PCI device address: bus, device and function -see PCI_BDF()
+ * @offset:    Register offset to write
+ * @value:     Value to write
+ * @size:      Access size
+ * Return: 0 if OK, -ve on error
  */
+int pci_x86_write_config(pci_dev_t bdf, uint offset, ulong value,
+                        enum pci_size_t size);
 
-#ifndef _PCI_I386_H_
-#define _PCI_I386_H_
+/**
+ * pci_bus_clrset_config32() - Update a configuration value for a device
+ *
+ * The register at @offset is updated to (oldvalue & ~clr) | set. This function
+ * can be called before PCI is set up in driver model.
+ *
+ * @bdf:       PCI device address: bus, device and function -see PCI_BDF()
+ * @offset:    Register offset to update
+ * @clr:       Bits to clear
+ * @set:       Bits to set
+ * Return: 0 if OK, -ve on error
+ */
+int pci_x86_clrset_config(pci_dev_t bdf, uint offset, ulong clr, ulong set,
+                         enum pci_size_t size);
+
+/**
+ * Assign IRQ number to a PCI device
+ *
+ * This function assigns IRQ for a PCI device. If the device does not exist
+ * or does not require interrupts then this function has no effect.
+ *
+ * @bus:       PCI bus number
+ * @device:    PCI device number
+ * @irq:       An array of IRQ numbers that are assigned to INTA through
+ *             INTD of this PCI device.
+ */
+void pci_assign_irqs(int bus, int device, u8 irq[4]);
 
-#define DEFINE_PCI_DEVICE_TABLE(_table) \
-       const struct pci_device_id _table[]
+#endif /* __ASSEMBLY__ */
 
-void pci_setup_type1(struct pci_controller *hose);
-int pci_enable_legacy_video_ports(struct pci_controller* hose);
-int pci_shadow_rom(pci_dev_t dev, unsigned char *dest);
-void pci_remove_rom_window(struct pci_controller* hose, u32 addr);
-u32 pci_get_rom_window(struct pci_controller* hose, int size);
-#endif
+#endif /* _PCI_I386_H_ */