[pci] Add support for PCI Enhanced Allocation

Some embedded devices have immovable BARs, which are described via a
PCI Enhanced Allocation capability.

Signed-off-by: Michael Brown <mcb30@ipxe.org>

src/drivers/bus/pciea.c

@@ -0,0 +1,149 @@
+/*
+ * Copyright (C) 2016 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ *
+ * You can also choose to distribute this program under the terms of
+ * the Unmodified Binary Distribution Licence (as given in the file
+ * COPYING.UBDL), provided that you have satisfied its requirements.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <stdint.h>
+#include <errno.h>
+#include <ipxe/pci.h>
+#include <ipxe/pciea.h>
+
+/** @file
+ *
+ * PCI Enhanced Allocation
+ *
+ */
+
+/**
+ * Locate PCI Enhanced Allocation BAR equivalent entry
+ *
+ * @v pci		PCI device
+ * @v bei		BAR equivalent indicator
+ * @ret offset		PCI Enhanced Allocation entry offset, or negative error
+ */
+static int pciea_offset ( struct pci_device *pci, unsigned int bei ) {
+	uint8_t entries;
+	uint32_t desc;
+	unsigned int i;
+	int offset;
+
+	/* Locate Enhanced Allocation capability */
+	offset = pci_find_capability ( pci, PCI_CAP_ID_EA );
+	if ( offset < 0 )
+		return offset;
+
+	/* Get number of entries */
+	pci_read_config_byte ( pci, ( offset + PCIEA_ENTRIES ), &entries );
+	entries &= PCIEA_ENTRIES_MASK;
+
+	/* Locate first entry */
+	offset += PCIEA_FIRST;
+
+	/* Search for a matching entry */
+	for ( i = 0 ; i < entries ; i++ ) {
+
+		/* Read entry descriptor */
+		pci_read_config_dword ( pci, offset, &desc );
+
+		/* Check for a matching entry */
+		if ( ( desc & PCIEA_DESC_ENABLED ) &&
+		     ( bei == PCIEA_DESC_BEI ( desc ) ) )
+			return offset;
+
+		/* Move to next entry */
+		offset += ( ( PCIEA_DESC_SIZE ( desc ) + 1 ) << 2 );
+	}
+
+	return -ENOENT;
+}
+
+/**
+ * Read PCI Enhanced Allocation BAR equivalent value
+ *
+ * @v pci		PCI device
+ * @v bei		BAR equivalent indicator
+ * @v low_offset	Offset to low dword of value
+ * @ret value		BAR equivalent value
+ */
+static unsigned long pciea_bar_value ( struct pci_device *pci, unsigned int bei,
+				       unsigned int low_offset ) {
+	uint32_t low;
+	uint32_t high;
+	int offset;
+
+	/* Locate Enhanced Allocation offset for this BEI */
+	offset = pciea_offset ( pci, bei );
+	if ( offset < 0 )
+		return 0;
+
+	/* Read BAR equivalent */
+	offset += low_offset;
+	pci_read_config_dword ( pci, offset, &low );
+	if ( low & PCIEA_LOW_ATTR_64BIT ) {
+		offset += PCIEA_LOW_HIGH;
+		pci_read_config_dword ( pci, offset, &high );
+		if ( high ) {
+			if ( sizeof ( unsigned long ) > sizeof ( uint32_t ) ) {
+				return ( ( ( uint64_t ) high << 32 ) | low );
+			} else {
+				DBGC ( pci, PCI_FMT " unhandled 64-bit EA BAR "
+				       "%08x%08x\n",
+				       PCI_ARGS ( pci ), high, low );
+				return 0;
+			}
+		}
+	}
+	return low;
+}
+
+/**
+ * Find the start of a PCI Enhanced Allocation BAR equivalent
+ *
+ * @v pci		PCI device
+ * @v bei		BAR equivalent indicator
+ * @ret start		BAR start address
+ *
+ * If the address exceeds the size of an unsigned long (i.e. if a
+ * 64-bit BAR has a non-zero high dword on a 32-bit machine), the
+ * return value will be zero.
+ */
+unsigned long pciea_bar_start ( struct pci_device *pci, unsigned int bei ) {
+	unsigned long base;
+
+	base = pciea_bar_value ( pci, bei, PCIEA_LOW_BASE );
+	return ( base & ~PCIEA_LOW_ATTR_MASK );
+}
+
+/**
+ * Find the size of a PCI Enhanced Allocation BAR equivalent
+ *
+ * @v pci		PCI device
+ * @v bei		BAR equivalent indicator
+ * @ret size		BAR size
+ */
+unsigned long pciea_bar_size ( struct pci_device *pci, unsigned int bei ) {
+	unsigned long limit;
+
+	limit = pciea_bar_value ( pci, bei, PCIEA_LOW_LIMIT );
+	return ( limit ? ( ( limit | PCIEA_LOW_ATTR_MASK ) + 1 ) : 0 );
+}

src/include/ipxe/errfile.h

@@ -189,6 +189,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define ERRFILE_golan		     ( ERRFILE_DRIVER | 0x007d0000 )
 #define ERRFILE_flexboot_nodnic	     ( ERRFILE_DRIVER | 0x007e0000 )
 #define ERRFILE_virtio_pci	     ( ERRFILE_DRIVER | 0x007f0000 )
+#define ERRFILE_pciea		     ( ERRFILE_DRIVER | 0x00c00000 )
 
 #define ERRFILE_aoe			( ERRFILE_NET | 0x00000000 )
 #define ERRFILE_arp			( ERRFILE_NET | 0x00010000 )

src/include/ipxe/pci.h

@@ -94,6 +94,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
 #define PCI_CAP_ID_VPD			0x03	/**< Vital product data */
 #define PCI_CAP_ID_VNDR			0x09	/**< Vendor-specific */
 #define PCI_CAP_ID_EXP			0x10	/**< PCI Express */
+#define PCI_CAP_ID_EA			0x14	/**< Enhanced Allocation */
 
 /** Next capability */
 #define PCI_CAP_NEXT		0x01

src/include/ipxe/pciea.h

@@ -0,0 +1,70 @@
+#ifndef _IPXE_PCIEA_H
+#define _IPXE_PCIEA_H
+
+/** @file
+ *
+ * PCI Enhanced Allocation
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
+
+#include <ipxe/pci.h>
+
+/** Number of entries */
+#define PCIEA_ENTRIES 2
+#define PCIEA_ENTRIES_MASK 0x3f
+
+/** First entry */
+#define PCIEA_FIRST 4
+
+/** Entry descriptor */
+#define PCIEA_DESC 0
+
+/** Entry size */
+#define PCIEA_DESC_SIZE(desc) ( ( (desc) >> 0 ) & 0x7 )
+
+/** BAR equivalent indicator */
+#define PCIEA_DESC_BEI(desc) ( ( (desc) >> 4 ) & 0xf )
+
+/** BAR equivalent indicators */
+enum pciea_bei {
+	PCIEA_BEI_BAR_0 = 0,		/**< Standard BAR 0 */
+	PCIEA_BEI_BAR_1 = 1,		/**< Standard BAR 1 */
+	PCIEA_BEI_BAR_2 = 2,		/**< Standard BAR 2 */
+	PCIEA_BEI_BAR_3 = 3,		/**< Standard BAR 3 */
+	PCIEA_BEI_BAR_4 = 4,		/**< Standard BAR 4 */
+	PCIEA_BEI_BAR_5 = 5,		/**< Standard BAR 5 */
+	PCIEA_BEI_ROM = 8,		/**< Expansion ROM BAR */
+	PCIEA_BEI_VF_BAR_0 = 9,		/**< Virtual function BAR 0 */
+	PCIEA_BEI_VF_BAR_1 = 10,	/**< Virtual function BAR 1 */
+	PCIEA_BEI_VF_BAR_2 = 11,	/**< Virtual function BAR 2 */
+	PCIEA_BEI_VF_BAR_3 = 12,	/**< Virtual function BAR 3 */
+	PCIEA_BEI_VF_BAR_4 = 13,	/**< Virtual function BAR 4 */
+	PCIEA_BEI_VF_BAR_5 = 14,	/**< Virtual function BAR 5 */
+};
+
+/** Entry is enabled */
+#define PCIEA_DESC_ENABLED 0x80000000UL
+
+/** Base address low dword */
+#define PCIEA_LOW_BASE 4
+
+/** Limit low dword */
+#define PCIEA_LOW_LIMIT 8
+
+/** BAR is 64-bit */
+#define PCIEA_LOW_ATTR_64BIT 0x00000002UL
+
+/** Low dword attribute bit mask */
+#define PCIEA_LOW_ATTR_MASK 0x00000003UL
+
+/** Offset to high dwords */
+#define PCIEA_LOW_HIGH 8
+
+extern unsigned long pciea_bar_start ( struct pci_device *pci,
+				       unsigned int bei );
+extern unsigned long pciea_bar_size ( struct pci_device *pci,
+				      unsigned int bei );
+
+#endif /* _IPXE_PCIEA_H */