drivers/mfd/tqmx86.c

0001 // SPDX-License-Identifier: GPL-2.0+
0002 /*
0003  * TQ-Systems PLD MFD core driver, based on vendor driver by
0004  * Vadim V.Vlasov <vvlasov@dev.rtsoft.ru>
0005  *
0006  * Copyright (c) 2015 TQ-Systems GmbH
0007  * Copyright (c) 2019 Andrew Lunn <andrew@lunn.ch>
0008  */
0009
0010 #include <linux/delay.h>
0011 #include <linux/dmi.h>
0012 #include <linux/i2c.h>
0013 #include <linux/io.h>
0014 #include <linux/mfd/core.h>
0015 #include <linux/module.h>
0016 #include <linux/platform_data/i2c-ocores.h>
0017 #include <linux/platform_device.h>
0018
0019 #define TQMX86_IOBASE   0x160
0020 #define TQMX86_IOSIZE   0x3f
0021 #define TQMX86_IOBASE_I2C   0x1a0
0022 #define TQMX86_IOSIZE_I2C   0xa
0023 #define TQMX86_IOBASE_WATCHDOG  0x18b
0024 #define TQMX86_IOSIZE_WATCHDOG  0x2
0025 #define TQMX86_IOBASE_GPIO  0x18d
0026 #define TQMX86_IOSIZE_GPIO  0x4
0027
0028 #define TQMX86_REG_BOARD_ID 0x20
0029 #define TQMX86_REG_BOARD_ID_E38M    1
0030 #define TQMX86_REG_BOARD_ID_50UC    2
0031 #define TQMX86_REG_BOARD_ID_E38C    3
0032 #define TQMX86_REG_BOARD_ID_60EB    4
0033 #define TQMX86_REG_BOARD_ID_E39M    5
0034 #define TQMX86_REG_BOARD_ID_E39C    6
0035 #define TQMX86_REG_BOARD_ID_E39x    7
0036 #define TQMX86_REG_BOARD_ID_70EB    8
0037 #define TQMX86_REG_BOARD_ID_80UC    9
0038 #define TQMX86_REG_BOARD_ID_110EB   11
0039 #define TQMX86_REG_BOARD_ID_E40M    12
0040 #define TQMX86_REG_BOARD_ID_E40S    13
0041 #define TQMX86_REG_BOARD_ID_E40C1   14
0042 #define TQMX86_REG_BOARD_ID_E40C2   15
0043 #define TQMX86_REG_BOARD_REV    0x21
0044 #define TQMX86_REG_IO_EXT_INT   0x26
0045 #define TQMX86_REG_IO_EXT_INT_NONE      0
0046 #define TQMX86_REG_IO_EXT_INT_7         1
0047 #define TQMX86_REG_IO_EXT_INT_9         2
0048 #define TQMX86_REG_IO_EXT_INT_12        3
0049 #define TQMX86_REG_IO_EXT_INT_MASK      0x3
0050 #define TQMX86_REG_IO_EXT_INT_GPIO_SHIFT    4
0051
0052 #define TQMX86_REG_I2C_DETECT   0x47
0053 #define TQMX86_REG_I2C_DETECT_SOFT      0xa5
0054 #define TQMX86_REG_I2C_INT_EN   0x49
0055
0056 static uint gpio_irq;
0057 module_param(gpio_irq, uint, 0);
0058 MODULE_PARM_DESC(gpio_irq, "GPIO IRQ number (7, 9, 12)");
0059
0060 static const struct resource tqmx_i2c_soft_resources[] = {
0061     DEFINE_RES_IO(TQMX86_IOBASE_I2C, TQMX86_IOSIZE_I2C),
0062 };
0063
0064 static const struct resource tqmx_watchdog_resources[] = {
0065     DEFINE_RES_IO(TQMX86_IOBASE_WATCHDOG, TQMX86_IOSIZE_WATCHDOG),
0066 };
0067
0068 /*
0069  * The IRQ resource must be first, since it is updated with the
0070  * configured IRQ in the probe function.
0071  */
0072 static struct resource tqmx_gpio_resources[] = {
0073     DEFINE_RES_IRQ(0),
0074     DEFINE_RES_IO(TQMX86_IOBASE_GPIO, TQMX86_IOSIZE_GPIO),
0075 };
0076
0077 static struct i2c_board_info tqmx86_i2c_devices[] = {
0078     {
0079         /* 4K EEPROM at 0x50 */
0080         I2C_BOARD_INFO("24c32", 0x50),
0081     },
0082 };
0083
0084 static struct ocores_i2c_platform_data ocores_platform_data = {
0085     .num_devices = ARRAY_SIZE(tqmx86_i2c_devices),
0086     .devices = tqmx86_i2c_devices,
0087 };
0088
0089 static const struct mfd_cell tqmx86_i2c_soft_dev[] = {
0090     {
0091         .name = "ocores-i2c",
0092         .platform_data = &ocores_platform_data,
0093         .pdata_size = sizeof(ocores_platform_data),
0094         .resources = tqmx_i2c_soft_resources,
0095         .num_resources = ARRAY_SIZE(tqmx_i2c_soft_resources),
0096     },
0097 };
0098
0099 static const struct mfd_cell tqmx86_devs[] = {
0100     {
0101         .name = "tqmx86-wdt",
0102         .resources = tqmx_watchdog_resources,
0103         .num_resources = ARRAY_SIZE(tqmx_watchdog_resources),
0104         .ignore_resource_conflicts = true,
0105     },
0106     {
0107         .name = "tqmx86-gpio",
0108         .resources = tqmx_gpio_resources,
0109         .num_resources = ARRAY_SIZE(tqmx_gpio_resources),
0110         .ignore_resource_conflicts = true,
0111     },
0112 };
0113
0114 static const char *tqmx86_board_id_to_name(u8 board_id)
0115 {
0116     switch (board_id) {
0117     case TQMX86_REG_BOARD_ID_E38M:
0118         return "TQMxE38M";
0119     case TQMX86_REG_BOARD_ID_50UC:
0120         return "TQMx50UC";
0121     case TQMX86_REG_BOARD_ID_E38C:
0122         return "TQMxE38C";
0123     case TQMX86_REG_BOARD_ID_60EB:
0124         return "TQMx60EB";
0125     case TQMX86_REG_BOARD_ID_E39M:
0126         return "TQMxE39M";
0127     case TQMX86_REG_BOARD_ID_E39C:
0128         return "TQMxE39C";
0129     case TQMX86_REG_BOARD_ID_E39x:
0130         return "TQMxE39x";
0131     case TQMX86_REG_BOARD_ID_70EB:
0132         return "TQMx70EB";
0133     case TQMX86_REG_BOARD_ID_80UC:
0134         return "TQMx80UC";
0135     case TQMX86_REG_BOARD_ID_110EB:
0136         return "TQMx110EB";
0137     case TQMX86_REG_BOARD_ID_E40M:
0138         return "TQMxE40M";
0139     case TQMX86_REG_BOARD_ID_E40S:
0140         return "TQMxE40S";
0141     case TQMX86_REG_BOARD_ID_E40C1:
0142         return "TQMxE40C1";
0143     case TQMX86_REG_BOARD_ID_E40C2:
0144         return "TQMxE40C2";
0145     default:
0146         return "Unknown";
0147     }
0148 }
0149
0150 static int tqmx86_board_id_to_clk_rate(struct device *dev, u8 board_id)
0151 {
0152     switch (board_id) {
0153     case TQMX86_REG_BOARD_ID_50UC:
0154     case TQMX86_REG_BOARD_ID_60EB:
0155     case TQMX86_REG_BOARD_ID_70EB:
0156     case TQMX86_REG_BOARD_ID_80UC:
0157     case TQMX86_REG_BOARD_ID_110EB:
0158     case TQMX86_REG_BOARD_ID_E40M:
0159     case TQMX86_REG_BOARD_ID_E40S:
0160     case TQMX86_REG_BOARD_ID_E40C1:
0161     case TQMX86_REG_BOARD_ID_E40C2:
0162         return 24000;
0163     case TQMX86_REG_BOARD_ID_E39M:
0164     case TQMX86_REG_BOARD_ID_E39C:
0165     case TQMX86_REG_BOARD_ID_E39x:
0166         return 25000;
0167     case TQMX86_REG_BOARD_ID_E38M:
0168     case TQMX86_REG_BOARD_ID_E38C:
0169         return 33000;
0170     default:
0171         dev_warn(dev, "unknown board %d, assuming 24MHz LPC clock\n",
0172              board_id);
0173         return 24000;
0174     }
0175 }
0176
0177 static int tqmx86_probe(struct platform_device *pdev)
0178 {
0179     u8 board_id, rev, i2c_det, io_ext_int_val;
0180     struct device *dev = &pdev->dev;
0181     u8 gpio_irq_cfg, readback;
0182     const char *board_name;
0183     void __iomem *io_base;
0184     int err;
0185
0186     switch (gpio_irq) {
0187     case 0:
0188         gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_NONE;
0189         break;
0190     case 7:
0191         gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_7;
0192         break;
0193     case 9:
0194         gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_9;
0195         break;
0196     case 12:
0197         gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_12;
0198         break;
0199     default:
0200         pr_err("tqmx86: Invalid GPIO IRQ (%d)\n", gpio_irq);
0201         return -EINVAL;
0202     }
0203
0204     io_base = devm_ioport_map(dev, TQMX86_IOBASE, TQMX86_IOSIZE);
0205     if (!io_base)
0206         return -ENOMEM;
0207
0208     board_id = ioread8(io_base + TQMX86_REG_BOARD_ID);
0209     board_name = tqmx86_board_id_to_name(board_id);
0210     rev = ioread8(io_base + TQMX86_REG_BOARD_REV);
0211
0212     dev_info(dev,
0213          "Found %s - Board ID %d, PCB Revision %d, PLD Revision %d\n",
0214          board_name, board_id, rev >> 4, rev & 0xf);
0215
0216     i2c_det = ioread8(io_base + TQMX86_REG_I2C_DETECT);
0217
0218     if (gpio_irq_cfg) {
0219         io_ext_int_val =
0220             gpio_irq_cfg << TQMX86_REG_IO_EXT_INT_GPIO_SHIFT;
0221         iowrite8(io_ext_int_val, io_base + TQMX86_REG_IO_EXT_INT);
0222         readback = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
0223         if (readback != io_ext_int_val) {
0224             dev_warn(dev, "GPIO interrupts not supported.\n");
0225             return -EINVAL;
0226         }
0227
0228         /* Assumes the IRQ resource is first. */
0229         tqmx_gpio_resources[0].start = gpio_irq;
0230     } else {
0231         tqmx_gpio_resources[0].flags = 0;
0232     }
0233
0234     ocores_platform_data.clock_khz = tqmx86_board_id_to_clk_rate(dev, board_id);
0235
0236     if (i2c_det == TQMX86_REG_I2C_DETECT_SOFT) {
0237         err = devm_mfd_add_devices(dev, PLATFORM_DEVID_NONE,
0238                        tqmx86_i2c_soft_dev,
0239                        ARRAY_SIZE(tqmx86_i2c_soft_dev),
0240                        NULL, 0, NULL);
0241         if (err)
0242             return err;
0243     }
0244
0245     return devm_mfd_add_devices(dev, PLATFORM_DEVID_NONE,
0246                     tqmx86_devs,
0247                     ARRAY_SIZE(tqmx86_devs),
0248                     NULL, 0, NULL);
0249 }
0250
0251 static int tqmx86_create_platform_device(const struct dmi_system_id *id)
0252 {
0253     struct platform_device *pdev;
0254     int err;
0255
0256     pdev = platform_device_alloc("tqmx86", -1);
0257     if (!pdev)
0258         return -ENOMEM;
0259
0260     err = platform_device_add(pdev);
0261     if (err)
0262         platform_device_put(pdev);
0263
0264     return err;
0265 }
0266
0267 static const struct dmi_system_id tqmx86_dmi_table[] __initconst = {
0268     {
0269         .ident = "TQMX86",
0270         .matches = {
0271             DMI_MATCH(DMI_SYS_VENDOR, "TQ-Group"),
0272             DMI_MATCH(DMI_PRODUCT_NAME, "TQMx"),
0273         },
0274         .callback = tqmx86_create_platform_device,
0275     },
0276     {
0277         .ident = "TQMX86",
0278         .matches = {
0279             DMI_MATCH(DMI_SYS_VENDOR, "TQ-Systems"),
0280             DMI_MATCH(DMI_PRODUCT_NAME, "TQMx"),
0281         },
0282         .callback = tqmx86_create_platform_device,
0283     },
0284     {}
0285 };
0286 MODULE_DEVICE_TABLE(dmi, tqmx86_dmi_table);
0287
0288 static struct platform_driver tqmx86_driver = {
0289     .driver     = {
0290         .name   = "tqmx86",
0291     },
0292     .probe      = tqmx86_probe,
0293 };
0294
0295 static int __init tqmx86_init(void)
0296 {
0297     if (!dmi_check_system(tqmx86_dmi_table))
0298         return -ENODEV;
0299
0300     return platform_driver_register(&tqmx86_driver);
0301 }
0302
0303 module_init(tqmx86_init);
0304
0305 MODULE_DESCRIPTION("TQMx86 PLD Core Driver");
0306 MODULE_AUTHOR("Andrew Lunn <andrew@lunn.ch>");
0307 MODULE_LICENSE("GPL");
0308 MODULE_ALIAS("platform:tqmx86");