device: Add class and subclass name support

Add support to display class and subclass names for PCI devices.

BRANCH=none
BUG=None
TEST=Build and run on strago/cyan.

Change-Id: I5136fae45b8a1cd02541f233d29a246cdfcd8331
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: a7c9b0d7201b09a06ea32f0db84187d15f767c80
Original-Change-Id: Ibf2ee89dd84040ca6ab0e52857a69f7ed0c28f37
Original-Signed-off-by: Lee Leahy <Leroy.P.Leahy@intel.com>
Original-Reviewed-on: https://chromium-review.googlesource.com/263342
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Original-Commit-Queue: Leroy P Leahy <leroy.p.leahy@intel.com>
Original-Tested-by: Leroy P Leahy <leroy.p.leahy@intel.com>
Reviewed-on: http://review.coreboot.org/9901
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>

3 files changed, 285 insertions, 0 deletions

diff --git a/src/device/Makefile.inc b/src/device/Makefile.inc
index a955bb4350..391811515e 100644
--- a/src/device/Makefile.inc
+++ b/src/device/Makefile.inc
@@ -2,6 +2,7 @@ ramstage-y += device.c
 ramstage-y += root_device.c
 ramstage-y += cpu_device.c
 ramstage-y += device_util.c
+ramstage-$(CONFIG_PCI) += pci_class.c
 ramstage-$(CONFIG_PCI) += pci_device.c
 ramstage-$(CONFIG_HYPERTRANSPORT_PLUGIN_SUPPORT) += hypertransport.c
 ramstage-$(CONFIG_PCIX_PLUGIN_SUPPORT) += pcix_device.c
diff --git a/src/device/pci_class.c b/src/device/pci_class.c
new file mode 100644
index 0000000000..607ec0c624
--- /dev/null
+++ b/src/device/pci_class.c
@@ -0,0 +1,282 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2013 Google Inc.
+ * Copyright (C) 2015 Intel Corp.
+ *
+ * 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; version 2 of the License.
+ *
+ * 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 St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include <device/device.h>
+#include <device/pci.h>
+#include <device/pciexp.h>
+#include <device/pci_ids.h>
+#include <stdlib.h>
+
+typedef struct {
+	const unsigned char subclass_id;
+	const char *subclass_name;
+} PCI_SUBCLASS;
+
+typedef struct {
+	const unsigned char class_id;
+	const PCI_SUBCLASS *subclass_list;
+	const unsigned int subclass_entries;
+	const char *class_name;
+} PCI_CLASS;
+
+static const PCI_SUBCLASS unclassified[] = {
+	{ 0x00, "Non-VGA device" },
+	{ 0x01, "VGA compatible device" }
+};
+
+static const PCI_SUBCLASS mass_storage[] = {
+	{ 0x00, "SCSI storage controller" },
+	{ 0x01, "IDE interface" },
+	{ 0x02, "Floppy disk controller" },
+	{ 0x03, "IPI bus controller" },
+	{ 0x04, "RAID bus controller" },
+	{ 0x05, "ATA controller" },
+	{ 0x06, "SATA controller" },
+	{ 0x07, "Serial Attached SCSI controller" },
+	{ 0x08, "Non-Volatile memory controller" },
+	{ 0x80, "Mass storage controller" }
+};
+
+static const PCI_SUBCLASS network[] = {
+	{ 0x00, "Ethernet controller" },
+	{ 0x01, "Token ring network controller" },
+	{ 0x02, "FDDI network controller" },
+	{ 0x03, "ATM network controller" },
+	{ 0x04, "ISDN controller" },
+	{ 0x05, "WorldFip controller" },
+	{ 0x06, "PICMG controller" },
+	{ 0x80, "Network controller" }
+};
+
+static const PCI_SUBCLASS display[] = {
+	{ 0x00, "VGA compatible controller" },
+	{ 0x01, "XGA compatible controller" },
+	{ 0x02, "3D controller" },
+	{ 0x80, "Display controller" }
+};
+
+static const PCI_SUBCLASS multimedia[] = {
+	{ 0x00, "Multimedia video controller" },
+	{ 0x01, "Multimedia audio controller" },
+	{ 0x02, "Computer telephony device" },
+	{ 0x03, "Audio device" },
+	{ 0x80, "Multimedia controller" }
+};
+
+static const PCI_SUBCLASS memory[] = {
+	{ 0x00, "RAM memory" },
+	{ 0x01, "FLASH memory" },
+	{ 0x80, "Memory controller" }
+};
+
+static const PCI_SUBCLASS bridge[] = {
+	{ 0x00, "Host bridge" },
+	{ 0x01, "ISA bridge" },
+	{ 0x02, "EISA bridge" },
+	{ 0x03, "MicroChannel bridge" },
+	{ 0x04, "PCI bridge" },
+	{ 0x05, "PCMCIA bridge" },
+	{ 0x06, "NuBus bridge" },
+	{ 0x07, "CardBus bridge" },
+	{ 0x08, "RACEway bridge" },
+	{ 0x09, "Semi-transparent PCI-to-PCI bridge" },
+	{ 0x0a, "InfiniBand to PCI host bridge" },
+	{ 0x80, "Bridge" }
+};
+
+static const PCI_SUBCLASS communication[] = {
+	{ 0x00, "Serial controller" },
+	{ 0x01, "Parallel controller" },
+	{ 0x02, "Multiport serial controller" },
+	{ 0x03, "Modem" },
+	{ 0x04, "GPIB controller" },
+	{ 0x05, "Smard Card controller" },
+	{ 0x80, "Communication controller" }
+};
+
+static const PCI_SUBCLASS generic[] = {
+	{ 0x00, "PIC" },
+	{ 0x01, "DMA controller" },
+	{ 0x02, "Timer" },
+	{ 0x03, "RTC" },
+	{ 0x04, "PCI Hot-plug controller" },
+	{ 0x05, "SD Host controller" },
+	{ 0x06, "IOMMU" },
+	{ 0x80, "System peripheral" }
+};
+
+static const PCI_SUBCLASS input_device[] = {
+	{ 0x00, "Keyboard controller" },
+	{ 0x01, "Digitizer Pen" },
+	{ 0x02, "Mouse controller" },
+	{ 0x03, "Scanner controller" },
+	{ 0x04, "Gameport controller" },
+	{ 0x80, "Input device controller" }
+};
+
+static const PCI_SUBCLASS docking_station[] = {
+	{ 0x00, "Generic Docking Station" },
+	{ 0x80, "Docking Station" }
+};
+
+static const PCI_SUBCLASS processor[] = {
+	{ 0x00, "386" },
+	{ 0x01, "486" },
+	{ 0x02, "Pentium" },
+	{ 0x10, "Alpha" },
+	{ 0x20, "Power PC" },
+	{ 0x30, "MIPS" },
+	{ 0x40, "Co-processor" }
+};
+
+static const PCI_SUBCLASS serial_bus[] = {
+	{ 0x00, "FireWire (IEEE 1394)" },
+	{ 0x01, "ACCESS Bus" },
+	{ 0x02, "SSA" },
+	{ 0x03, "USB controller" },
+	{ 0x04, "Fibre Channel" },
+	{ 0x05, "SMBus" },
+	{ 0x06, "InfiniBand" },
+	{ 0x07, "IPMI SMIC interface" },
+	{ 0x08, "SERCOS interface" },
+	{ 0x09, "CANBUS" }
+};
+
+static const PCI_SUBCLASS wireless[] = {
+	{ 0x00, "IRDA controller" },
+	{ 0x01, "Consumer IR controller" },
+	{ 0x10, "RF controller" },
+	{ 0x11, "Bluetooth" },
+	{ 0x12, "Broadband" },
+	{ 0x20, "802.1a controller" },
+	{ 0x21, "802.1b controller" },
+	{ 0x80, "Wireless controller" }
+};
+
+static const PCI_SUBCLASS intellegient_controller[] = {
+	{ 0x00, "I2O" }
+};
+
+static const PCI_SUBCLASS satellite_controller[] = {
+	{ 0x01, "Satellite TV controller" },
+	{ 0x02, "Satellite audio communication controller" },
+	{ 0x03, "Satellite voice communication controller" },
+	{ 0x04, "Satellite data communication controller" }
+};
+
+static const PCI_SUBCLASS encryption[] = {
+	{ 0x00, "Network and computing encryption device" },
+	{ 0x10, "Entertainment encryption device" },
+	{ 0x80, "Encryption controller" }
+};
+
+static const PCI_SUBCLASS signal_processing[] = {
+	{ 0x00, "DPIO module" },
+	{ 0x01, "Performance counters" },
+	{ 0x10, "Communication synchronizer" },
+	{ 0x20, "Signal processing management" },
+	{ 0x80, "Signal processing controller" }
+};
+
+static const PCI_CLASS class_list[] = {
+	{ 0x00, &unclassified[0], ARRAY_SIZE(unclassified),
+		"Unclassified device" },
+	{ 0x01, &mass_storage[0], ARRAY_SIZE(mass_storage), "Mass storage" },
+	{ 0x02, &network[0], ARRAY_SIZE(network), "Network" },
+	{ 0x03, &display[0], ARRAY_SIZE(display), "Display" },
+	{ 0x04, &multimedia[0], ARRAY_SIZE(multimedia), "Multimedia" },
+	{ 0x05, &memory[0], ARRAY_SIZE(memory), "Memory" },
+	{ 0x06, &bridge[0], ARRAY_SIZE(bridge), "Bridge" },
+	{ 0x07, &communication[0], ARRAY_SIZE(communication), "Communication" },
+	{ 0x08, &generic[0], ARRAY_SIZE(generic), "Generic system peripheral" },
+	{ 0x09, &input_device[0], ARRAY_SIZE(input_device), "Input device" },
+	{ 0x0a, &docking_station[0], ARRAY_SIZE(docking_station),
+		"Docking station" },
+	{ 0x0b, &processor[0], ARRAY_SIZE(processor), "Processor" },
+	{ 0x0c, &serial_bus[0], ARRAY_SIZE(serial_bus), "Serial bus" },
+	{ 0x0d, &wireless[0], ARRAY_SIZE(wireless), "Wireless" },
+	{ 0x0e, &intellegient_controller[0],
+			ARRAY_SIZE(intellegient_controller),
+			"Intelligent controller" },
+	{ 0x0f, &satellite_controller[0], ARRAY_SIZE(satellite_controller),
+			"Satellite communications" },
+	{ 0x10, &encryption[0], ARRAY_SIZE(encryption), "Encryption" },
+	{ 0x11, &signal_processing[0], ARRAY_SIZE(signal_processing),
+			"Signal processing" },
+	{ 0xff, NULL, 0, "Unassigned class" }
+};
+static const unsigned int class_entries = ARRAY_SIZE(class_list);
+
+static const PCI_CLASS *get_pci_class_entry(device_t dev)
+{
+	unsigned char class;
+	const PCI_CLASS *class_entry;
+	const PCI_CLASS *class_list_end;
+
+	/* Get the PCI device class */
+	class = pci_read_config8(dev, PCI_CLASS_DEVICE+1);
+
+	/* Locate the class entry */
+	class_entry = &class_list[0];
+	class_list_end = &class_entry[class_entries];
+	while (class_list_end > class_entry) {
+		if (class_entry->class_id == class)
+			return class_entry;
+		class_entry += 1;
+	}
+	return NULL;
+}
+
+const char *get_pci_class_name(device_t dev)
+{
+	const PCI_CLASS *class_entry;
+
+	class_entry = get_pci_class_entry(dev);
+	return class_entry ? class_entry->class_name : "???";
+}
+
+const char *get_pci_subclass_name(device_t dev)
+{
+	const PCI_CLASS *class_entry;
+	unsigned char subclass;
+	const PCI_SUBCLASS *subclass_entry;
+	const PCI_SUBCLASS *subclass_list_end;
+	const char *subclass_name;
+
+	/* Get the PCI device subclass */
+	subclass = pci_read_config8(dev, PCI_CLASS_DEVICE);
+
+	/* Locate the subclass name */
+	subclass_name = "???";
+	class_entry = get_pci_class_entry(dev);
+	subclass_entry = class_entry ? class_entry->subclass_list : NULL;
+	if (NULL != subclass_entry) {
+		subclass_list_end =
+			&subclass_entry[class_entry->subclass_entries];
+		while (subclass_list_end > subclass_entry) {
+			if (subclass_entry->subclass_id == subclass) {
+				subclass_name = subclass_entry->subclass_name;
+				break;
+			}
+			subclass_entry += 1;
+		}
+	}
+	return subclass_name;
+}
diff --git a/src/include/device/pci.h b/src/include/device/pci.h
index 4e712f9f7b..141d2e8cb4 100644
--- a/src/include/device/pci.h
+++ b/src/include/device/pci.h
@@ -87,6 +87,8 @@ const char * pin_to_str(int pin);
 int get_pci_irq_pins(device_t dev, device_t *parent_bdg);
 void pci_assign_irqs(unsigned bus, unsigned slot,
 		     const unsigned char pIntAtoD[4]);
+const char *get_pci_class_name(device_t dev);
+const char *get_pci_subclass_name(device_t dev);
 
 #define PCI_IO_BRIDGE_ALIGN 4096
 #define PCI_MEM_BRIDGE_ALIGN (1024*1024)