/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * Generic driver for pretty much all known Standard Microsystems Corporation * (SMSC) Super I/O chips. * * Datasheets are available from: http://www.smsc.com/main/datasheet.html * * Most of the SMSC Super I/O chips seem to be similar enough (for our * purposes) so that we can handle them with a unified driver. * * So far only the ASUS A8000 has been tested on real hardware! * * The floppy disk controller, the parallel port, the serial ports, and the * keyboard controller should work with all the chips. For the more advanced * stuff (e.g. HWM, ACPI, SMBus) more work is probably required. */ #include <device/device.h> #include <device/pnp.h> #include <superio/conf_mode.h> #include <console/console.h> #include <pc80/keyboard.h> /* The following Super I/O chips are currently supported by this driver: */ #define LPC47M172 0x14 #define FDC37B80X 0x42 /* Same ID: FDC37M70X (a.k.a. FDC37M707) */ #define FDC37B78X 0x44 #define FDC37B72X 0x4c #define FDC37M81X 0x4d #define FDC37M60X 0x47 #define LPC47B27X 0x51 /* a.k.a. LPC47B272 */ #define LPC47U33X 0x54 #define LPC47M10X 0x59 /* Same ID: LPC47M112, LPC47M13X */ #define LPC47M15X 0x60 /* Same ID: LPC47M192 */ #define LPC47S45X 0x62 #define LPC47B397 0x6f #define A8000 0x77 /* ASUS A8000, a rebranded DME1737(?) */ #define DME1737 0x78 #define SCH5504 0x79 #define SCH3112 0x7c #define SCH3114 0x7d #define SCH5307 0x81 /* Rebranded LPC47B397(?) */ #define SCH5027D 0x89 #define SCH4304 0x90 /* SCH4304, SCH4307 */ #define SCH5147 0xc1 /* Register defines */ #define DEVICE_ID_REG 0x20 /* Device ID register */ #define DEVICE_REV_REG 0x21 /* Device revision register */ #define DEVICE_TEST7_REG 0x29 /* Device test 7 register */ /* Static variables for the Super I/O device ID and revision. */ static int first_time = 1; static u8 superio_id = 0; static u8 superio_rev = 0; /** * A list of all possible logical devices which may be supported by at least * one of the Super I/O chips. These values are used as index into the * logical_device_table[i].devs array(s). * * If you change this enum, you must also adapt the logical_device_table[] * array and MAX_LOGICAL_DEVICES! */ enum { LD_FDC, /* Floppy disk controller */ LD_PP, /* Parallel port */ LD_SP1, /* Serial port 1 (COM1) */ LD_SP2, /* Serial port 2 (COM2) */ LD_RTC, /* Real-time clock */ LD_KBC, /* Keyboard controller */ LD_AUX, /* Auxiliary I/O */ LD_XBUS, /* X-Bus */ LD_HWM, /* Hardware monitor */ LD_GAME, /* Game port */ LD_PME, /* Power management events */ LD_MPU401, /* MPU-401 MIDI UART */ LD_RT, /* Runtime registers / security key registers */ LD_ACPI, /* ACPI */ LD_SMB, /* SMBus */ }; /* Note: This value must match the number of items in the enum above! */ #define MAX_LOGICAL_DEVICES 15 /** * A table describing the logical devices which are present on the * supported Super I/O chips. * * The first entry (superio_id) is the device ID of the Super I/O chip * as stored in the (read-only) DEVICE_ID_REG register. * * The second entry (devs) is the list of logical device IDs which are * present on that particular Super I/O chip. A value of -1 means the * device is not present on that chip. * * Note: Do _not_ list chips with different name but same device ID twice! * The result would be that the init code would be executed twice! */ static const struct logical_devices { u8 superio_id; int devs[MAX_LOGICAL_DEVICES]; } logical_device_table[] = { /* Chip FDC PP SP1 SP2 RTC KBC AUX XBUS HWM GAME PME MPU RT ACPI SMB */ {LPC47M172,{0, 3, 4, 2, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, {FDC37B80X,{0, 3, 4, 5, -1, 7, 8, -1, -1, -1, -1, -1, -1, -1, -1}}, {FDC37B78X,{0, 3, 4, 5, 6, 7, 8, -1, -1, -1, -1, -1, -1, 10, -1}}, {FDC37B72X,{0, 3, 4, 5, -1, 7, 8, -1, -1, -1, -1, -1, -1, 10, -1}}, {FDC37M81X,{0, 3, 4, 5, -1, 7, 8, -1, -1, -1, -1, -1, -1, -1, -1}}, {FDC37M60X,{0, 3, 4, 5, -1, 7, 8, -1, -1, -1, -1, -1, -1, -1, -1}}, {LPC47B27X,{0, 3, 4, 5, -1, 7, -1, -1, -1, 9, -1, 11, 10, -1, -1}}, {LPC47M10X,{0, 3, 4, 5, -1, 7, -1, -1, -1, 9, 10, 11, -1, -1, -1}}, {LPC47M15X,{0, 3, 4, 5, -1, 7, -1, -1, -1, 9, 10, 11, -1, -1, -1}}, {LPC47S45X,{0, 3, 4, 5, 6, 7, -1, 8, -1, -1, -1, -1, 10, -1, 11}}, {LPC47B397,{0, 3, 4, 5, -1, 7, -1, -1, 8, -1, -1, -1, 10, -1, -1}}, {LPC47U33X,{0, 3, 4, -1, -1, 7, -1, -1, -1, 9, 0, 5, 10, 0, 11}}, {A8000, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, {DME1737, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, {SCH5504, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, {SCH3112, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, {SCH3114, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, {SCH5307, {0, 3, 4, 5, -1, 7, -1, -1, 8, -1, -1, -1, 10, -1, -1}}, {SCH5027D, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, 11}}, {SCH4304, {0, 3, 4, 5, -1, 7, -1, 11, -1, -1, -1, -1, 10, -1, -1}}, {SCH5147, {0, 3, 4, 5, -1, 7, -1, -1, -1, -1, -1, -1, 10, -1, -1}}, }; /** * Initialize those logical devices which need a special init. * * @param dev The device to use. */ static void smsc_init(struct device *dev) { int i, ld; /* Do not initialize disabled devices. */ if (!dev->enabled) return; /* Find the correct Super I/O. */ for (i = 0; i < ARRAY_SIZE(logical_device_table); i++) if (logical_device_table[i].superio_id == superio_id) break; /* If no Super I/O was found, return. */ if (i == ARRAY_SIZE(logical_device_table)) return; /* A Super I/O was found, so initialize the respective device. */ ld = dev->path.pnp.device; if (ld == logical_device_table[i].devs[LD_KBC]) { pc_keyboard_init(NO_AUX_DEVICE); } } /** Standard device operations. */ static struct device_operations ops = { .read_resources = pnp_read_resources, .set_resources = pnp_set_resources, .enable_resources = pnp_enable_resources, .enable = pnp_alt_enable, .init = smsc_init, .ops_pnp_mode = &pnp_conf_mode_55_aa, }; /** * TODO. * * This table should contain all possible entries for any of the supported * Super I/O chips, even if some of them don't have the respective logical * devices. That will be handled correctly by our code. * * The LD_FOO entries are device markers which tell you the type of the logical * device (e.g. whether it's a floppy disk controller or a serial port etc.). * * Before using pnp_dev_info[] in pnp_enable_devices() these markers have * to be replaced with the real logical device IDs of the respective * Super I/O chip. This is done in enable_dev(). * * TODO: FDC, PP, SP1, SP2, and KBC should work, the rest probably not (yet). */ static struct pnp_info pnp_dev_info[] = { { NULL, LD_FDC, PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, 0x07f8, }, { NULL, LD_PP, PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, 0x07f8, }, { NULL, LD_SP1, PNP_IO0 | PNP_IRQ0, 0x07f8, }, { NULL, LD_SP2, PNP_IO0 | PNP_IRQ0, 0x07f8, }, { NULL, LD_RTC, }, { NULL, LD_KBC, PNP_IO0 | PNP_IO1 | PNP_IRQ0 | PNP_IRQ1, 0x07ff, 0x07ff, }, { NULL, LD_AUX, }, { NULL, LD_XBUS, }, { NULL, LD_HWM, PNP_IO0, 0x07f0, }, { NULL, LD_GAME, }, { NULL, LD_PME, }, { NULL, LD_MPU401, }, { NULL, LD_RT, PNP_IO0, 0x0780, }, { NULL, LD_ACPI, }, { NULL, LD_SMB, }, }; /** * Enable the logical devices of the Super I/O chip. * * TODO: Think about how to handle the case when a mainboard has multiple * Super I/O chips soldered on. * TODO: Can this code be simplified a bit? * * @param dev The device to use. */ static void enable_dev(struct device *dev) { int i, j, fn; int tmp[MAX_LOGICAL_DEVICES]; u8 test7; if (first_time) { pnp_enter_conf_mode_55(dev); /* Read the device ID and revision of the Super I/O chip. */ superio_id = pnp_read_config(dev, DEVICE_ID_REG); superio_rev = pnp_read_config(dev, DEVICE_REV_REG); /* TODO: Error handling? */ printk(BIOS_INFO, "Found SMSC Super I/O (ID = 0x%02x, " "rev = 0x%02x)\n", superio_id, superio_rev); first_time = 0; if (superio_id == LPC47M172) { /* * Do not use the default logical device number but * instead the standard SMSC registers set. */ /* * TEST7 configuration register (0x29) * Bit 0: LD_NUM (0 = new, 1 = std SMSC) */ test7 = pnp_read_config(dev, DEVICE_TEST7_REG); test7 |= (1 << 0); pnp_write_config(dev, DEVICE_TEST7_REG, test7); } pnp_exit_conf_mode_aa(dev); } /* Find the correct Super I/O. */ for (i = 0; i < ARRAY_SIZE(logical_device_table); i++) if (logical_device_table[i].superio_id == superio_id) break; /* If no Super I/O was found, return. */ if (i == ARRAY_SIZE(logical_device_table)) return; /* Temporarily save the LD_FOO values. */ for (j = 0; j < ARRAY_SIZE(pnp_dev_info); j++) tmp[j] = pnp_dev_info[j].function; /* * Replace the LD_FOO markers in pnp_dev_info[] with * the real logical device IDs of this Super I/O chip. */ for (j = 0; j < ARRAY_SIZE(pnp_dev_info); j++) { fn = pnp_dev_info[j].function; if (logical_device_table[i].devs[fn] != -1) pnp_dev_info[j].function = logical_device_table[i].devs[fn]; else pnp_dev_info[j].function = PNP_SKIP_FUNCTION; } /* Enable the specified devices (if present on the chip). */ pnp_enable_devices(dev, &ops, ARRAY_SIZE(pnp_dev_info), pnp_dev_info); /* Restore LD_FOO values. */ for (j = 0; j < ARRAY_SIZE(pnp_dev_info); j++) pnp_dev_info[j].function = tmp[j]; } struct chip_operations superio_smsc_smscsuperio_ops = { CHIP_NAME("Various SMSC Super I/Os") .enable_dev = enable_dev };