drivers/bus/brcmstb_gisb.c

   1 /*
   2  * Copyright (C) 2014 Broadcom Corporation
   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
  27 #ifdef CONFIG_ARM
  28 #include <asm/bug.h>
  29 #include <asm/signal.h>
  30 #endif
  31
  32 #define  ARB_ERR_CAP_CLEAR              (1 << 0)
  33 #define  ARB_ERR_CAP_STATUS_TIMEOUT     (1 << 12)
  34 #define  ARB_ERR_CAP_STATUS_TEA         (1 << 11)
  35 #define  ARB_ERR_CAP_STATUS_BS_SHIFT    (1 << 2)
  36 #define  ARB_ERR_CAP_STATUS_BS_MASK     0x3c
  37 #define  ARB_ERR_CAP_STATUS_WRITE       (1 << 1)
  38 #define  ARB_ERR_CAP_STATUS_VALID       (1 << 0)
  39
  40 enum {
  41         ARB_TIMER,
  42         ARB_ERR_CAP_CLR,
  43         ARB_ERR_CAP_HI_ADDR,
  44         ARB_ERR_CAP_ADDR,
  45         ARB_ERR_CAP_DATA,
  46         ARB_ERR_CAP_STATUS,
  47         ARB_ERR_CAP_MASTER,
  48 };
  49
  50 static const int gisb_offsets_bcm7038[] = {
  51         [ARB_TIMER]             = 0x00c,
  52         [ARB_ERR_CAP_CLR]       = 0x0c4,
  53         [ARB_ERR_CAP_HI_ADDR]   = -1,
  54         [ARB_ERR_CAP_ADDR]      = 0x0c8,
  55         [ARB_ERR_CAP_DATA]      = 0x0cc,
  56         [ARB_ERR_CAP_STATUS]    = 0x0d0,
  57         [ARB_ERR_CAP_MASTER]    = -1,
  58 };
  59
  60 static const int gisb_offsets_bcm7400[] = {
  61         [ARB_TIMER]             = 0x00c,
  62         [ARB_ERR_CAP_CLR]       = 0x0c8,
  63         [ARB_ERR_CAP_HI_ADDR]   = -1,
  64         [ARB_ERR_CAP_ADDR]      = 0x0cc,
  65         [ARB_ERR_CAP_DATA]      = 0x0d0,
  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_DATA]      = 0x170,
  76         [ARB_ERR_CAP_STATUS]    = 0x174,
  77         [ARB_ERR_CAP_MASTER]    = 0x178,
  78 };
  79
  80 static const int gisb_offsets_bcm7445[] = {
  81         [ARB_TIMER]             = 0x008,
  82         [ARB_ERR_CAP_CLR]       = 0x7e4,
  83         [ARB_ERR_CAP_HI_ADDR]   = 0x7e8,
  84         [ARB_ERR_CAP_ADDR]      = 0x7ec,
  85         [ARB_ERR_CAP_DATA]      = 0x7f0,
  86         [ARB_ERR_CAP_STATUS]    = 0x7f4,
  87         [ARB_ERR_CAP_MASTER]    = 0x7f8,
  88 };
  89
  90 struct brcmstb_gisb_arb_device {
  91         void __iomem    *base;
  92         const int       *gisb_offsets;
  93         struct mutex    lock;
  94         struct list_head next;
  95         u32 valid_mask;
  96         const char *master_names[sizeof(u32) * BITS_PER_BYTE];
  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         /* return 1 if the hardware doesn't have ARB_ERR_CAP_MASTER */
 106         if (offset == -1)
 107                 return 1;
 108
 109         return ioread32(gdev->base + offset);
 110 }
 111
 112 static void gisb_write(struct brcmstb_gisb_arb_device *gdev, u32 val, int reg)
 113 {
 114         int offset = gdev->gisb_offsets[reg];
 115
 116         if (offset == -1)
 117                 return;
 118         iowrite32(val, gdev->base + reg);
 119 }
 120
 121 static ssize_t gisb_arb_get_timeout(struct device *dev,
 122                                     struct device_attribute *attr,
 123                                     char *buf)
 124 {
 125         struct platform_device *pdev = to_platform_device(dev);
 126         struct brcmstb_gisb_arb_device *gdev = platform_get_drvdata(pdev);
 127         u32 timeout;
 128
 129         mutex_lock(&gdev->lock);
 130         timeout = gisb_read(gdev, ARB_TIMER);
 131         mutex_unlock(&gdev->lock);
 132
 133         return sprintf(buf, "%d", timeout);
 134 }
 135
 136 static ssize_t gisb_arb_set_timeout(struct device *dev,
 137                                     struct device_attribute *attr,
 138                                     const char *buf, size_t count)
 139 {
 140         struct platform_device *pdev = to_platform_device(dev);
 141         struct brcmstb_gisb_arb_device *gdev = platform_get_drvdata(pdev);
 142         int val, ret;
 143
 144         ret = kstrtoint(buf, 10, &val);
 145         if (ret < 0)
 146                 return ret;
 147
 148         if (val == 0 || val >= 0xffffffff)
 149                 return -EINVAL;
 150
 151         mutex_lock(&gdev->lock);
 152         gisb_write(gdev, val, ARB_TIMER);
 153         mutex_unlock(&gdev->lock);
 154
 155         return count;
 156 }
 157
 158 static const char *
 159 brcmstb_gisb_master_to_str(struct brcmstb_gisb_arb_device *gdev,
 160                                                 u32 masters)
 161 {
 162         u32 mask = gdev->valid_mask & masters;
 163
 164         if (hweight_long(mask) != 1)
 165                 return NULL;
 166
 167         return gdev->master_names[ffs(mask) - 1];
 168 }
 169
 170 static int brcmstb_gisb_arb_decode_addr(struct brcmstb_gisb_arb_device *gdev,
 171                                         const char *reason)
 172 {
 173         u32 cap_status;
 174         unsigned long arb_addr;
 175         u32 master;
 176         const char *m_name;
 177         char m_fmt[11];
 178
 179         cap_status = gisb_read(gdev, ARB_ERR_CAP_STATUS);
 180
 181         /* Invalid captured address, bail out */
 182         if (!(cap_status & ARB_ERR_CAP_STATUS_VALID))
 183                 return 1;
 184
 185         /* Read the address and master */
 186         arb_addr = gisb_read(gdev, ARB_ERR_CAP_ADDR) & 0xffffffff;
 187 #if (IS_ENABLED(CONFIG_PHYS_ADDR_T_64BIT))
 188         arb_addr |= (u64)gisb_read(gdev, ARB_ERR_CAP_HI_ADDR) << 32;
 189 #endif
 190         master = gisb_read(gdev, ARB_ERR_CAP_MASTER);
 191
 192         m_name = brcmstb_gisb_master_to_str(gdev, master);
 193         if (!m_name) {
 194                 snprintf(m_fmt, sizeof(m_fmt), "0x%08x", master);
 195                 m_name = m_fmt;
 196         }
 197
 198         pr_crit("%s: %s at 0x%lx [%c %s], core: %s\n",
 199                 __func__, reason, arb_addr,
 200                 cap_status & ARB_ERR_CAP_STATUS_WRITE ? 'W' : 'R',
 201                 cap_status & ARB_ERR_CAP_STATUS_TIMEOUT ? "timeout" : "",
 202                 m_name);
 203
 204         /* clear the GISB error */
 205         gisb_write(gdev, ARB_ERR_CAP_CLEAR, ARB_ERR_CAP_CLR);
 206
 207         return 0;
 208 }
 209
 210 #ifdef CONFIG_ARM
 211 static int brcmstb_bus_error_handler(unsigned long addr, unsigned int fsr,
 212                                      struct pt_regs *regs)
 213 {
 214         int ret = 0;
 215         struct brcmstb_gisb_arb_device *gdev;
 216
 217         /* iterate over each GISB arb registered handlers */
 218         list_for_each_entry(gdev, &brcmstb_gisb_arb_device_list, next)
 219                 ret |= brcmstb_gisb_arb_decode_addr(gdev, "bus error");
 220         /*
 221          * If it was an imprecise abort, then we need to correct the
 222          * return address to be _after_ the instruction.
 223         */
 224         if (fsr & (1 << 10))
 225                 regs->ARM_pc += 4;
 226
 227         return ret;
 228 }
 229
 230 void __init brcmstb_hook_fault_code(void)
 231 {
 232         hook_fault_code(22, brcmstb_bus_error_handler, SIGBUS, 0,
 233                         "imprecise external abort");
 234 }
 235 #endif
 236
 237 static irqreturn_t brcmstb_gisb_timeout_handler(int irq, void *dev_id)
 238 {
 239         brcmstb_gisb_arb_decode_addr(dev_id, "timeout");
 240
 241         return IRQ_HANDLED;
 242 }
 243
 244 static irqreturn_t brcmstb_gisb_tea_handler(int irq, void *dev_id)
 245 {
 246         brcmstb_gisb_arb_decode_addr(dev_id, "target abort");
 247
 248         return IRQ_HANDLED;
 249 }
 250
 251 static DEVICE_ATTR(gisb_arb_timeout, S_IWUSR | S_IRUGO,
 252                 gisb_arb_get_timeout, gisb_arb_set_timeout);
 253
 254 static struct attribute *gisb_arb_sysfs_attrs[] = {
 255         &dev_attr_gisb_arb_timeout.attr,
 256         NULL,
 257 };
 258
 259 static struct attribute_group gisb_arb_sysfs_attr_group = {
 260         .attrs = gisb_arb_sysfs_attrs,
 261 };
 262
 263 static const struct of_device_id brcmstb_gisb_arb_of_match[] = {
 264         { .compatible = "brcm,gisb-arb",         .data = gisb_offsets_bcm7445 },
 265         { .compatible = "brcm,bcm7445-gisb-arb", .data = gisb_offsets_bcm7445 },
 266         { .compatible = "brcm,bcm7435-gisb-arb", .data = gisb_offsets_bcm7435 },
 267         { .compatible = "brcm,bcm7400-gisb-arb", .data = gisb_offsets_bcm7400 },
 268         { .compatible = "brcm,bcm7038-gisb-arb", .data = gisb_offsets_bcm7038 },
 269         { },
 270 };
 271
 272 static int __init brcmstb_gisb_arb_probe(struct platform_device *pdev)
 273 {
 274         struct device_node *dn = pdev->dev.of_node;
 275         struct brcmstb_gisb_arb_device *gdev;
 276         const struct of_device_id *of_id;
 277         struct resource *r;
 278         int err, timeout_irq, tea_irq;
 279         unsigned int num_masters, j = 0;
 280         int i, first, last;
 281
 282         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 283         timeout_irq = platform_get_irq(pdev, 0);
 284         tea_irq = platform_get_irq(pdev, 1);
 285
 286         gdev = devm_kzalloc(&pdev->dev, sizeof(*gdev), GFP_KERNEL);
 287         if (!gdev)
 288                 return -ENOMEM;
 289
 290         mutex_init(&gdev->lock);
 291         INIT_LIST_HEAD(&gdev->next);
 292
 293         gdev->base = devm_ioremap_resource(&pdev->dev, r);
 294         if (IS_ERR(gdev->base))
 295                 return PTR_ERR(gdev->base);
 296
 297         of_id = of_match_node(brcmstb_gisb_arb_of_match, dn);
 298         if (!of_id) {
 299                 pr_err("failed to look up compatible string\n");
 300                 return -EINVAL;
 301         }
 302         gdev->gisb_offsets = of_id->data;
 303
 304         err = devm_request_irq(&pdev->dev, timeout_irq,
 305                                 brcmstb_gisb_timeout_handler, 0, pdev->name,
 306                                 gdev);
 307         if (err < 0)
 308                 return err;
 309
 310         err = devm_request_irq(&pdev->dev, tea_irq,
 311                                 brcmstb_gisb_tea_handler, 0, pdev->name,
 312                                 gdev);
 313         if (err < 0)
 314                 return err;
 315
 316         /* If we do not have a valid mask, assume all masters are enabled */
 317         if (of_property_read_u32(dn, "brcm,gisb-arb-master-mask",
 318                                 &gdev->valid_mask))
 319                 gdev->valid_mask = 0xffffffff;
 320
 321         /* Proceed with reading the litteral names if we agree on the
 322          * number of masters
 323          */
 324         num_masters = of_property_count_strings(dn,
 325                         "brcm,gisb-arb-master-names");
 326         if (hweight_long(gdev->valid_mask) == num_masters) {
 327                 first = ffs(gdev->valid_mask) - 1;
 328                 last = fls(gdev->valid_mask) - 1;
 329
 330                 for (i = first; i < last; i++) {
 331                         if (!(gdev->valid_mask & BIT(i)))
 332                                 continue;
 333
 334                         of_property_read_string_index(dn,
 335                                         "brcm,gisb-arb-master-names", j,
 336                                         &gdev->master_names[i]);
 337                         j++;
 338                 }
 339         }
 340
 341         err = sysfs_create_group(&pdev->dev.kobj, &gisb_arb_sysfs_attr_group);
 342         if (err)
 343                 return err;
 344
 345         platform_set_drvdata(pdev, gdev);
 346
 347         list_add_tail(&gdev->next, &brcmstb_gisb_arb_device_list);
 348
 349         dev_info(&pdev->dev, "registered mem: %p, irqs: %d, %d\n",
 350                         gdev->base, timeout_irq, tea_irq);
 351
 352         return 0;
 353 }
 354
 355 static struct platform_driver brcmstb_gisb_arb_driver = {
 356         .driver = {
 357                 .name   = "brcm-gisb-arb",
 358                 .owner  = THIS_MODULE,
 359                 .of_match_table = brcmstb_gisb_arb_of_match,
 360         },
 361 };
 362
 363 static int __init brcm_gisb_driver_init(void)
 364 {
 365         return platform_driver_probe(&brcmstb_gisb_arb_driver,
 366                                      brcmstb_gisb_arb_probe);
 367 }
 368
 369 module_init(brcm_gisb_driver_init);