drivers/bus/brcmstb_gisb.c

   1 /*
   2  * Copyright (C) 2014-2017 Broadcom
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #include <linux/init.h>
  15 #include <linux/types.h>
  16 #include <linux/module.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/sysfs.h>
  20 #include <linux/io.h>
  21 #include <linux/string.h>
  22 #include <linux/device.h>
  23 #include <linux/list.h>
  24 #include <linux/of.h>
  25 #include <linux/bitops.h>
  26 #include <linux/pm.h>
  27
  28 #ifdef CONFIG_ARM
  29 #include <asm/bug.h>
  30 #include <asm/signal.h>
  31 #endif
  32
  33 #ifdef CONFIG_MIPS
  34 #include <asm/traps.h>
  35 #endif
  36
  37 #define  ARB_ERR_CAP_CLEAR              (1 << 0)
  38 #define  ARB_ERR_CAP_STATUS_TIMEOUT     (1 << 12)
  39 #define  ARB_ERR_CAP_STATUS_TEA         (1 << 11)
  40 #define  ARB_ERR_CAP_STATUS_WRITE       (1 << 1)
  41 #define  ARB_ERR_CAP_STATUS_VALID       (1 << 0)
  42
  43 enum {
  44         ARB_TIMER,
  45         ARB_ERR_CAP_CLR,
  46         ARB_ERR_CAP_HI_ADDR,
  47         ARB_ERR_CAP_ADDR,
  48         ARB_ERR_CAP_STATUS,
  49         ARB_ERR_CAP_MASTER,
  50 };
  51
  52 static const int gisb_offsets_bcm7038[] = {
  53         [ARB_TIMER]             = 0x00c,
  54         [ARB_ERR_CAP_CLR]       = 0x0c4,
  55         [ARB_ERR_CAP_HI_ADDR]   = -1,
  56         [ARB_ERR_CAP_ADDR]      = 0x0c8,
  57         [ARB_ERR_CAP_STATUS]    = 0x0d0,
  58         [ARB_ERR_CAP_MASTER]    = -1,
  59 };
  60
  61 static const int gisb_offsets_bcm7400[] = {
  62         [ARB_TIMER]             = 0x00c,
  63         [ARB_ERR_CAP_CLR]       = 0x0c8,
  64         [ARB_ERR_CAP_HI_ADDR]   = -1,
  65         [ARB_ERR_CAP_ADDR]      = 0x0cc,
  66         [ARB_ERR_CAP_STATUS]    = 0x0d4,
  67         [ARB_ERR_CAP_MASTER]    = 0x0d8,
  68 };
  69
  70 static const int gisb_offsets_bcm7435[] = {
  71         [ARB_TIMER]             = 0x00c,
  72         [ARB_ERR_CAP_CLR]       = 0x168,
  73         [ARB_ERR_CAP_HI_ADDR]   = -1,
  74         [ARB_ERR_CAP_ADDR]      = 0x16c,
  75         [ARB_ERR_CAP_STATUS]    = 0x174,
  76         [ARB_ERR_CAP_MASTER]    = 0x178,
  77 };
  78
  79 static const int gisb_offsets_bcm7445[] = {
  80         [ARB_TIMER]             = 0x008,
  81         [ARB_ERR_CAP_CLR]       = 0x7e4,
  82         [ARB_ERR_CAP_HI_ADDR]   = 0x7e8,
  83         [ARB_ERR_CAP_ADDR]      = 0x7ec,
  84         [ARB_ERR_CAP_STATUS]    = 0x7f4,
  85         [ARB_ERR_CAP_MASTER]    = 0x7f8,
  86 };
  87
  88 struct brcmstb_gisb_arb_device {
  89         void __iomem    *base;
  90         const int       *gisb_offsets;
  91         bool            big_endian;
  92         struct mutex    lock;
  93         struct list_head next;
  94         u32 valid_mask;
  95         const char *master_names[sizeof(u32) * BITS_PER_BYTE];
  96         u32 saved_timeout;
  97 };
  98
  99 static LIST_HEAD(brcmstb_gisb_arb_device_list);
 100
 101 static u32 gisb_read(struct brcmstb_gisb_arb_device *gdev, int reg)
 102 {
 103         int offset = gdev->gisb_offsets[reg];
 104
 105         if (offset < 0) {
 106                 /* return 1 if the hardware doesn't have ARB_ERR_CAP_MASTER */
 107                 if (reg == ARB_ERR_CAP_MASTER)
 108                         return 1;
 109                 else
 110                         return 0;
 111         }
 112
 113         if (gdev->big_endian)
 114                 return ioread32be(gdev->base + offset);
 115         else
 116                 return ioread32(gdev->base + offset);
 117 }
 118
 119 static u64 gisb_read_address(struct brcmstb_gisb_arb_device *gdev)
 120 {
 121         u64 value;
 122
 123         value = gisb_read(gdev, ARB_ERR_CAP_ADDR);
 124         value |= (u64)gisb_read(gdev, ARB_ERR_CAP_HI_ADDR) << 32;
 125
 126         return value;
 127 }
 128
 129 static void gisb_write(struct brcmstb_gisb_arb_device *gdev, u32 val, int reg)
 130 {
 131         int offset = gdev->gisb_offsets[reg];
 132
 133         if (offset == -1)
 134                 return;
 135
 136         if (gdev->big_endian)
 137                 iowrite32be(val, gdev->base + offset);
 138         else
 139                 iowrite32(val, gdev->base + offset);
 140 }
 141
 142 static ssize_t gisb_arb_get_timeout(struct device *dev,
 143                                     struct device_attribute *attr,
 144                                     char *buf)
 145 {
 146         struct platform_device *pdev = to_platform_device(dev);
 147         struct brcmstb_gisb_arb_device *gdev = platform_get_drvdata(pdev);
 148         u32 timeout;
 149
 150         mutex_lock(&gdev->lock);
 151         timeout = gisb_read(gdev, ARB_TIMER);
 152         mutex_unlock(&gdev->lock);
 153
 154         return sprintf(buf, "%d", timeout);
 155 }
 156
 157 static ssize_t gisb_arb_set_timeout(struct device *dev,
 158                                     struct device_attribute *attr,
 159                                     const char *buf, size_t count)
 160 {
 161         struct platform_device *pdev = to_platform_device(dev);
 162         struct brcmstb_gisb_arb_device *gdev = platform_get_drvdata(pdev);
 163         int val, ret;
 164
 165         ret = kstrtoint(buf, 10, &val);
 166         if (ret < 0)
 167                 return ret;
 168
 169         if (val == 0 || val >= 0xffffffff)
 170                 return -EINVAL;
 171
 172         mutex_lock(&gdev->lock);
 173         gisb_write(gdev, val, ARB_TIMER);
 174         mutex_unlock(&gdev->lock);
 175
 176         return count;
 177 }
 178
 179 static const char *
 180 brcmstb_gisb_master_to_str(struct brcmstb_gisb_arb_device *gdev,
 181                                                 u32 masters)
 182 {
 183         u32 mask = gdev->valid_mask & masters;
 184
 185         if (hweight_long(mask) != 1)
 186                 return NULL;
 187
 188         return gdev->master_names[ffs(mask) - 1];
 189 }
 190
 191 static int brcmstb_gisb_arb_decode_addr(struct brcmstb_gisb_arb_device *gdev,
 192                                         const char *reason)
 193 {
 194         u32 cap_status;
 195         u64 arb_addr;
 196         u32 master;
 197         const char *m_name;
 198         char m_fmt[11];
 199
 200         cap_status = gisb_read(gdev, ARB_ERR_CAP_STATUS);
 201
 202         /* Invalid captured address, bail out */
 203         if (!(cap_status & ARB_ERR_CAP_STATUS_VALID))
 204                 return 1;
 205
 206         /* Read the address and master */
 207         arb_addr = gisb_read_address(gdev);
 208         master = gisb_read(gdev, ARB_ERR_CAP_MASTER);
 209
 210         m_name = brcmstb_gisb_master_to_str(gdev, master);
 211         if (!m_name) {
 212                 snprintf(m_fmt, sizeof(m_fmt), "0x%08x", master);
 213                 m_name = m_fmt;
 214         }
 215
 216         pr_crit("%s: %s at 0x%llx [%c %s], core: %s\n",
 217                 __func__, reason, arb_addr,
 218                 cap_status & ARB_ERR_CAP_STATUS_WRITE ? 'W' : 'R',
 219                 cap_status & ARB_ERR_CAP_STATUS_TIMEOUT ? "timeout" : "",
 220                 m_name);
 221
 222         /* clear the GISB error */
 223         gisb_write(gdev, ARB_ERR_CAP_CLEAR, ARB_ERR_CAP_CLR);
 224
 225         return 0;
 226 }
 227
 228 #ifdef CONFIG_ARM
 229 static int brcmstb_bus_error_handler(unsigned long addr, unsigned int fsr,
 230                                      struct pt_regs *regs)
 231 {
 232         int ret = 0;
 233         struct brcmstb_gisb_arb_device *gdev;
 234
 235         /* iterate over each GISB arb registered handlers */
 236         list_for_each_entry(gdev, &brcmstb_gisb_arb_device_list, next)
 237                 ret |= brcmstb_gisb_arb_decode_addr(gdev, "bus error");
 238         /*
 239          * If it was an imprecise abort, then we need to correct the
 240          * return address to be _after_ the instruction.
 241         */
 242         if (fsr & (1 << 10))
 243                 regs->ARM_pc += 4;
 244
 245         return ret;
 246 }
 247 #endif
 248
 249 #ifdef CONFIG_MIPS
 250 static int brcmstb_bus_error_handler(struct pt_regs *regs, int is_fixup)
 251 {
 252         int ret = 0;
 253         struct brcmstb_gisb_arb_device *gdev;
 254         u32 cap_status;
 255
 256         list_for_each_entry(gdev, &brcmstb_gisb_arb_device_list, next) {
 257                 cap_status = gisb_read(gdev, ARB_ERR_CAP_STATUS);
 258
 259                 /* Invalid captured address, bail out */
 260                 if (!(cap_status & ARB_ERR_CAP_STATUS_VALID)) {
 261                         is_fixup = 1;
 262                         goto out;
 263                 }
 264
 265                 ret |= brcmstb_gisb_arb_decode_addr(gdev, "bus error");
 266         }
 267 out:
 268         return is_fixup ? MIPS_BE_FIXUP : MIPS_BE_FATAL;
 269 }
 270 #endif
 271
 272 static irqreturn_t brcmstb_gisb_timeout_handler(int irq, void *dev_id)
 273 {
 274         brcmstb_gisb_arb_decode_addr(dev_id, "timeout");
 275
 276         return IRQ_HANDLED;
 277 }
 278
 279 static irqreturn_t brcmstb_gisb_tea_handler(int irq, void *dev_id)
 280 {
 281         brcmstb_gisb_arb_decode_addr(dev_id, "target abort");
 282
 283         return IRQ_HANDLED;
 284 }
 285
 286 static DEVICE_ATTR(gisb_arb_timeout, S_IWUSR | S_IRUGO,
 287                 gisb_arb_get_timeout, gisb_arb_set_timeout);
 288
 289 static struct attribute *gisb_arb_sysfs_attrs[] = {
 290         &dev_attr_gisb_arb_timeout.attr,
 291         NULL,
 292 };
 293
 294 static struct attribute_group gisb_arb_sysfs_attr_group = {
 295         .attrs = gisb_arb_sysfs_attrs,
 296 };
 297
 298 static const struct of_device_id brcmstb_gisb_arb_of_match[] = {
 299         { .compatible = "brcm,gisb-arb",         .data = gisb_offsets_bcm7445 },
 300         { .compatible = "brcm,bcm7445-gisb-arb", .data = gisb_offsets_bcm7445 },
 301         { .compatible = "brcm,bcm7435-gisb-arb", .data = gisb_offsets_bcm7435 },
 302         { .compatible = "brcm,bcm7400-gisb-arb", .data = gisb_offsets_bcm7400 },
 303         { .compatible = "brcm,bcm7038-gisb-arb", .data = gisb_offsets_bcm7038 },
 304         { },
 305 };
 306
 307 static int __init brcmstb_gisb_arb_probe(struct platform_device *pdev)
 308 {
 309         struct device_node *dn = pdev->dev.of_node;
 310         struct brcmstb_gisb_arb_device *gdev;
 311         const struct of_device_id *of_id;
 312         struct resource *r;
 313         int err, timeout_irq, tea_irq;
 314         unsigned int num_masters, j = 0;
 315         int i, first, last;
 316
 317         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 318         timeout_irq = platform_get_irq(pdev, 0);
 319         tea_irq = platform_get_irq(pdev, 1);
 320
 321         gdev = devm_kzalloc(&pdev->dev, sizeof(*gdev), GFP_KERNEL);
 322         if (!gdev)
 323                 return -ENOMEM;
 324
 325         mutex_init(&gdev->lock);
 326         INIT_LIST_HEAD(&gdev->next);
 327
 328         gdev->base = devm_ioremap_resource(&pdev->dev, r);
 329         if (IS_ERR(gdev->base))
 330                 return PTR_ERR(gdev->base);
 331
 332         of_id = of_match_node(brcmstb_gisb_arb_of_match, dn);
 333         if (!of_id) {
 334                 pr_err("failed to look up compatible string\n");
 335                 return -EINVAL;
 336         }
 337         gdev->gisb_offsets = of_id->data;
 338         gdev->big_endian = of_device_is_big_endian(dn);
 339
 340         err = devm_request_irq(&pdev->dev, timeout_irq,
 341                                 brcmstb_gisb_timeout_handler, 0, pdev->name,
 342                                 gdev);
 343         if (err < 0)
 344                 return err;
 345
 346         err = devm_request_irq(&pdev->dev, tea_irq,
 347                                 brcmstb_gisb_tea_handler, 0, pdev->name,
 348                                 gdev);
 349         if (err < 0)
 350                 return err;
 351
 352         /* If we do not have a valid mask, assume all masters are enabled */
 353         if (of_property_read_u32(dn, "brcm,gisb-arb-master-mask",
 354                                 &gdev->valid_mask))
 355                 gdev->valid_mask = 0xffffffff;
 356
 357         /* Proceed with reading the litteral names if we agree on the
 358          * number of masters
 359          */
 360         num_masters = of_property_count_strings(dn,
 361                         "brcm,gisb-arb-master-names");
 362         if (hweight_long(gdev->valid_mask) == num_masters) {
 363                 first = ffs(gdev->valid_mask) - 1;
 364                 last = fls(gdev->valid_mask) - 1;
 365
 366                 for (i = first; i < last; i++) {
 367                         if (!(gdev->valid_mask & BIT(i)))
 368                                 continue;
 369
 370                         of_property_read_string_index(dn,
 371                                         "brcm,gisb-arb-master-names", j,
 372                                         &gdev->master_names[i]);
 373                         j++;
 374                 }
 375         }
 376
 377         err = sysfs_create_group(&pdev->dev.kobj, &gisb_arb_sysfs_attr_group);
 378         if (err)
 379                 return err;
 380
 381         platform_set_drvdata(pdev, gdev);
 382
 383         list_add_tail(&gdev->next, &brcmstb_gisb_arb_device_list);
 384
 385 #ifdef CONFIG_ARM
 386         hook_fault_code(22, brcmstb_bus_error_handler, SIGBUS, 0,
 387                         "imprecise external abort");
 388 #endif
 389 #ifdef CONFIG_MIPS
 390         board_be_handler = brcmstb_bus_error_handler;
 391 #endif
 392
 393         dev_info(&pdev->dev, "registered mem: %p, irqs: %d, %d\n",
 394                         gdev->base, timeout_irq, tea_irq);
 395
 396         return 0;
 397 }
 398
 399 #ifdef CONFIG_PM_SLEEP
 400 static int brcmstb_gisb_arb_suspend(struct device *dev)
 401 {
 402         struct platform_device *pdev = to_platform_device(dev);
 403         struct brcmstb_gisb_arb_device *gdev = platform_get_drvdata(pdev);
 404
 405         gdev->saved_timeout = gisb_read(gdev, ARB_TIMER);
 406
 407         return 0;
 408 }
 409
 410 /* Make sure we provide the same timeout value that was configured before, and
 411  * do this before the GISB timeout interrupt handler has any chance to run.
 412  */
 413 static int brcmstb_gisb_arb_resume_noirq(struct device *dev)
 414 {
 415         struct platform_device *pdev = to_platform_device(dev);
 416         struct brcmstb_gisb_arb_device *gdev = platform_get_drvdata(pdev);
 417
 418         gisb_write(gdev, gdev->saved_timeout, ARB_TIMER);
 419
 420         return 0;
 421 }
 422 #else
 423 #define brcmstb_gisb_arb_suspend       NULL
 424 #define brcmstb_gisb_arb_resume_noirq  NULL
 425 #endif
 426
 427 static const struct dev_pm_ops brcmstb_gisb_arb_pm_ops = {
 428         .suspend        = brcmstb_gisb_arb_suspend,
 429         .resume_noirq   = brcmstb_gisb_arb_resume_noirq,
 430 };
 431
 432 static struct platform_driver brcmstb_gisb_arb_driver = {
 433         .driver = {
 434                 .name   = "brcm-gisb-arb",
 435                 .of_match_table = brcmstb_gisb_arb_of_match,
 436                 .pm     = &brcmstb_gisb_arb_pm_ops,
 437         },
 438 };
 439
 440 static int __init brcm_gisb_driver_init(void)
 441 {
 442         return platform_driver_probe(&brcmstb_gisb_arb_driver,
 443                                      brcmstb_gisb_arb_probe);
 444 }
 445
 446 module_init(brcm_gisb_driver_init);