drivers/soc/qcom/smsm.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (c) 2015, Sony Mobile Communications Inc.
   4  * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
   5  */
   6
   7 #include <linux/interrupt.h>
   8 #include <linux/mfd/syscon.h>
   9 #include <linux/module.h>
  10 #include <linux/of_irq.h>
  11 #include <linux/platform_device.h>
  12 #include <linux/spinlock.h>
  13 #include <linux/regmap.h>
  14 #include <linux/soc/qcom/smem.h>
  15 #include <linux/soc/qcom/smem_state.h>
  16
  17 /*
  18  * This driver implements the Qualcomm Shared Memory State Machine, a mechanism
  19  * for communicating single bit state information to remote processors.
  20  *
  21  * The implementation is based on two sections of shared memory; the first
  22  * holding the state bits and the second holding a matrix of subscription bits.
  23  *
  24  * The state bits are structured in entries of 32 bits, each belonging to one
  25  * system in the SoC. The entry belonging to the local system is considered
  26  * read-write, while the rest should be considered read-only.
  27  *
  28  * The subscription matrix consists of N bitmaps per entry, denoting interest
  29  * in updates of the entry for each of the N hosts. Upon updating a state bit
  30  * each host's subscription bitmap should be queried and the remote system
  31  * should be interrupted if they request so.
  32  *
  33  * The subscription matrix is laid out in entry-major order:
  34  * entry0: [host0 ... hostN]
  35  *      .
  36  *      .
  37  * entryM: [host0 ... hostN]
  38  *
  39  * A third, optional, shared memory region might contain information regarding
  40  * the number of entries in the state bitmap as well as number of columns in
  41  * the subscription matrix.
  42  */
  43
  44 /*
  45  * Shared memory identifiers, used to acquire handles to respective memory
  46  * region.
  47  */
  48 #define SMEM_SMSM_SHARED_STATE          85
  49 #define SMEM_SMSM_CPU_INTR_MASK         333
  50 #define SMEM_SMSM_SIZE_INFO             419
  51
  52 /*
  53  * Default sizes, in case SMEM_SMSM_SIZE_INFO is not found.
  54  */
  55 #define SMSM_DEFAULT_NUM_ENTRIES        8
  56 #define SMSM_DEFAULT_NUM_HOSTS          3
  57
  58 struct smsm_entry;
  59 struct smsm_host;
  60
  61 /**
  62  * struct qcom_smsm - smsm driver context
  63  * @dev:        smsm device pointer
  64  * @local_host: column in the subscription matrix representing this system
  65  * @num_hosts:  number of columns in the subscription matrix
  66  * @num_entries: number of entries in the state map and rows in the subscription
  67  *              matrix
  68  * @local_state: pointer to the local processor's state bits
  69  * @subscription: pointer to local processor's row in subscription matrix
  70  * @state:      smem state handle
  71  * @lock:       spinlock for read-modify-write of the outgoing state
  72  * @entries:    context for each of the entries
  73  * @hosts:      context for each of the hosts
  74  */
  75 struct qcom_smsm {
  76         struct device *dev;
  77
  78         u32 local_host;
  79
  80         u32 num_hosts;
  81         u32 num_entries;
  82
  83         u32 *local_state;
  84         u32 *subscription;
  85         struct qcom_smem_state *state;
  86
  87         spinlock_t lock;
  88
  89         struct smsm_entry *entries;
  90         struct smsm_host *hosts;
  91 };
  92
  93 /**
  94  * struct smsm_entry - per remote processor entry context
  95  * @smsm:       back-reference to driver context
  96  * @domain:     IRQ domain for this entry, if representing a remote system
  97  * @irq_enabled: bitmap of which state bits IRQs are enabled
  98  * @irq_rising: bitmap tracking if rising bits should be propagated
  99  * @irq_falling: bitmap tracking if falling bits should be propagated
 100  * @last_value: snapshot of state bits last time the interrupts where propagated
 101  * @remote_state: pointer to this entry's state bits
 102  * @subscription: pointer to a row in the subscription matrix representing this
 103  *              entry
 104  */
 105 struct smsm_entry {
 106         struct qcom_smsm *smsm;
 107
 108         struct irq_domain *domain;
 109         DECLARE_BITMAP(irq_enabled, 32);
 110         DECLARE_BITMAP(irq_rising, 32);
 111         DECLARE_BITMAP(irq_falling, 32);
 112         unsigned long last_value;
 113
 114         u32 *remote_state;
 115         u32 *subscription;
 116 };
 117
 118 /**
 119  * struct smsm_host - representation of a remote host
 120  * @ipc_regmap: regmap for outgoing interrupt
 121  * @ipc_offset: offset in @ipc_regmap for outgoing interrupt
 122  * @ipc_bit:    bit in @ipc_regmap + @ipc_offset for outgoing interrupt
 123  */
 124 struct smsm_host {
 125         struct regmap *ipc_regmap;
 126         int ipc_offset;
 127         int ipc_bit;
 128 };
 129
 130 /**
 131  * smsm_update_bits() - change bit in outgoing entry and inform subscribers
 132  * @data:       smsm context pointer
 133  * @offset:     bit in the entry
 134  * @value:      new value
 135  *
 136  * Used to set and clear the bits in the outgoing/local entry and inform
 137  * subscribers about the change.
 138  */
 139 static int smsm_update_bits(void *data, u32 mask, u32 value)
 140 {
 141         struct qcom_smsm *smsm = data;
 142         struct smsm_host *hostp;
 143         unsigned long flags;
 144         u32 changes;
 145         u32 host;
 146         u32 orig;
 147         u32 val;
 148
 149         spin_lock_irqsave(&smsm->lock, flags);
 150
 151         /* Update the entry */
 152         val = orig = readl(smsm->local_state);
 153         val &= ~mask;
 154         val |= value;
 155
 156         /* Don't signal if we didn't change the value */
 157         changes = val ^ orig;
 158         if (!changes) {
 159                 spin_unlock_irqrestore(&smsm->lock, flags);
 160                 goto done;
 161         }
 162
 163         /* Write out the new value */
 164         writel(val, smsm->local_state);
 165         spin_unlock_irqrestore(&smsm->lock, flags);
 166
 167         /* Make sure the value update is ordered before any kicks */
 168         wmb();
 169
 170         /* Iterate over all hosts to check whom wants a kick */
 171         for (host = 0; host < smsm->num_hosts; host++) {
 172                 hostp = &smsm->hosts[host];
 173
 174                 val = readl(smsm->subscription + host);
 175                 if (val & changes && hostp->ipc_regmap) {
 176                         regmap_write(hostp->ipc_regmap,
 177                                      hostp->ipc_offset,
 178                                      BIT(hostp->ipc_bit));
 179                 }
 180         }
 181
 182 done:
 183         return 0;
 184 }
 185
 186 static const struct qcom_smem_state_ops smsm_state_ops = {
 187         .update_bits = smsm_update_bits,
 188 };
 189
 190 /**
 191  * smsm_intr() - cascading IRQ handler for SMSM
 192  * @irq:        unused
 193  * @data:       entry related to this IRQ
 194  *
 195  * This function cascades an incoming interrupt from a remote system, based on
 196  * the state bits and configuration.
 197  */
 198 static irqreturn_t smsm_intr(int irq, void *data)
 199 {
 200         struct smsm_entry *entry = data;
 201         unsigned i;
 202         int irq_pin;
 203         u32 changed;
 204         u32 val;
 205
 206         val = readl(entry->remote_state);
 207         changed = val ^ xchg(&entry->last_value, val);
 208
 209         for_each_set_bit(i, entry->irq_enabled, 32) {
 210                 if (!(changed & BIT(i)))
 211                         continue;
 212
 213                 if (val & BIT(i)) {
 214                         if (test_bit(i, entry->irq_rising)) {
 215                                 irq_pin = irq_find_mapping(entry->domain, i);
 216                                 handle_nested_irq(irq_pin);
 217                         }
 218                 } else {
 219                         if (test_bit(i, entry->irq_falling)) {
 220                                 irq_pin = irq_find_mapping(entry->domain, i);
 221                                 handle_nested_irq(irq_pin);
 222                         }
 223                 }
 224         }
 225
 226         return IRQ_HANDLED;
 227 }
 228
 229 /**
 230  * smsm_mask_irq() - un-subscribe from cascades of IRQs of a certain staus bit
 231  * @irqd:       IRQ handle to be masked
 232  *
 233  * This un-subscribes the local CPU from interrupts upon changes to the defines
 234  * status bit. The bit is also cleared from cascading.
 235  */
 236 static void smsm_mask_irq(struct irq_data *irqd)
 237 {
 238         struct smsm_entry *entry = irq_data_get_irq_chip_data(irqd);
 239         irq_hw_number_t irq = irqd_to_hwirq(irqd);
 240         struct qcom_smsm *smsm = entry->smsm;
 241         u32 val;
 242
 243         if (entry->subscription) {
 244                 val = readl(entry->subscription + smsm->local_host);
 245                 val &= ~BIT(irq);
 246                 writel(val, entry->subscription + smsm->local_host);
 247         }
 248
 249         clear_bit(irq, entry->irq_enabled);
 250 }
 251
 252 /**
 253  * smsm_unmask_irq() - subscribe to cascades of IRQs of a certain status bit
 254  * @irqd:       IRQ handle to be unmasked
 255  *
 256
 257  * This subscribes the local CPU to interrupts upon changes to the defined
 258  * status bit. The bit is also marked for cascading.
 259
 260  */
 261 static void smsm_unmask_irq(struct irq_data *irqd)
 262 {
 263         struct smsm_entry *entry = irq_data_get_irq_chip_data(irqd);
 264         irq_hw_number_t irq = irqd_to_hwirq(irqd);
 265         struct qcom_smsm *smsm = entry->smsm;
 266         u32 val;
 267
 268         /* Make sure our last cached state is up-to-date */
 269         if (readl(entry->remote_state) & BIT(irq))
 270                 set_bit(irq, &entry->last_value);
 271         else
 272                 clear_bit(irq, &entry->last_value);
 273
 274         set_bit(irq, entry->irq_enabled);
 275
 276         if (entry->subscription) {
 277                 val = readl(entry->subscription + smsm->local_host);
 278                 val |= BIT(irq);
 279                 writel(val, entry->subscription + smsm->local_host);
 280         }
 281 }
 282
 283 /**
 284  * smsm_set_irq_type() - updates the requested IRQ type for the cascading
 285  * @irqd:       consumer interrupt handle
 286  * @type:       requested flags
 287  */
 288 static int smsm_set_irq_type(struct irq_data *irqd, unsigned int type)
 289 {
 290         struct smsm_entry *entry = irq_data_get_irq_chip_data(irqd);
 291         irq_hw_number_t irq = irqd_to_hwirq(irqd);
 292
 293         if (!(type & IRQ_TYPE_EDGE_BOTH))
 294                 return -EINVAL;
 295
 296         if (type & IRQ_TYPE_EDGE_RISING)
 297                 set_bit(irq, entry->irq_rising);
 298         else
 299                 clear_bit(irq, entry->irq_rising);
 300
 301         if (type & IRQ_TYPE_EDGE_FALLING)
 302                 set_bit(irq, entry->irq_falling);
 303         else
 304                 clear_bit(irq, entry->irq_falling);
 305
 306         return 0;
 307 }
 308
 309 static struct irq_chip smsm_irq_chip = {
 310         .name           = "smsm",
 311         .irq_mask       = smsm_mask_irq,
 312         .irq_unmask     = smsm_unmask_irq,
 313         .irq_set_type   = smsm_set_irq_type,
 314 };
 315
 316 /**
 317  * smsm_irq_map() - sets up a mapping for a cascaded IRQ
 318  * @d:          IRQ domain representing an entry
 319  * @irq:        IRQ to set up
 320  * @hw:         unused
 321  */
 322 static int smsm_irq_map(struct irq_domain *d,
 323                         unsigned int irq,
 324                         irq_hw_number_t hw)
 325 {
 326         struct smsm_entry *entry = d->host_data;
 327
 328         irq_set_chip_and_handler(irq, &smsm_irq_chip, handle_level_irq);
 329         irq_set_chip_data(irq, entry);
 330         irq_set_nested_thread(irq, 1);
 331
 332         return 0;
 333 }
 334
 335 static const struct irq_domain_ops smsm_irq_ops = {
 336         .map = smsm_irq_map,
 337         .xlate = irq_domain_xlate_twocell,
 338 };
 339
 340 /**
 341  * smsm_parse_ipc() - parses a qcom,ipc-%d device tree property
 342  * @smsm:       smsm driver context
 343  * @host_id:    index of the remote host to be resolved
 344  *
 345  * Parses device tree to acquire the information needed for sending the
 346  * outgoing interrupts to a remote host - identified by @host_id.
 347  */
 348 static int smsm_parse_ipc(struct qcom_smsm *smsm, unsigned host_id)
 349 {
 350         struct device_node *syscon;
 351         struct device_node *node = smsm->dev->of_node;
 352         struct smsm_host *host = &smsm->hosts[host_id];
 353         char key[16];
 354         int ret;
 355
 356         snprintf(key, sizeof(key), "qcom,ipc-%d", host_id);
 357         syscon = of_parse_phandle(node, key, 0);
 358         if (!syscon)
 359                 return 0;
 360
 361         host->ipc_regmap = syscon_node_to_regmap(syscon);
 362         of_node_put(syscon);
 363         if (IS_ERR(host->ipc_regmap))
 364                 return PTR_ERR(host->ipc_regmap);
 365
 366         ret = of_property_read_u32_index(node, key, 1, &host->ipc_offset);
 367         if (ret < 0) {
 368                 dev_err(smsm->dev, "no offset in %s\n", key);
 369                 return -EINVAL;
 370         }
 371
 372         ret = of_property_read_u32_index(node, key, 2, &host->ipc_bit);
 373         if (ret < 0) {
 374                 dev_err(smsm->dev, "no bit in %s\n", key);
 375                 return -EINVAL;
 376         }
 377
 378         return 0;
 379 }
 380
 381 /**
 382  * smsm_inbound_entry() - parse DT and set up an entry representing a remote system
 383  * @smsm:       smsm driver context
 384  * @entry:      entry context to be set up
 385  * @node:       dt node containing the entry's properties
 386  */
 387 static int smsm_inbound_entry(struct qcom_smsm *smsm,
 388                               struct smsm_entry *entry,
 389                               struct device_node *node)
 390 {
 391         int ret;
 392         int irq;
 393
 394         irq = irq_of_parse_and_map(node, 0);
 395         if (!irq) {
 396                 dev_err(smsm->dev, "failed to parse smsm interrupt\n");
 397                 return -EINVAL;
 398         }
 399
 400         ret = devm_request_threaded_irq(smsm->dev, irq,
 401                                         NULL, smsm_intr,
 402                                         IRQF_ONESHOT,
 403                                         "smsm", (void *)entry);
 404         if (ret) {
 405                 dev_err(smsm->dev, "failed to request interrupt\n");
 406                 return ret;
 407         }
 408
 409         entry->domain = irq_domain_add_linear(node, 32, &smsm_irq_ops, entry);
 410         if (!entry->domain) {
 411                 dev_err(smsm->dev, "failed to add irq_domain\n");
 412                 return -ENOMEM;
 413         }
 414
 415         return 0;
 416 }
 417
 418 /**
 419  * smsm_get_size_info() - parse the optional memory segment for sizes
 420  * @smsm:       smsm driver context
 421  *
 422  * Attempt to acquire the number of hosts and entries from the optional shared
 423  * memory location. Not being able to find this segment should indicate that
 424  * we're on a older system where these values was hard coded to
 425  * SMSM_DEFAULT_NUM_ENTRIES and SMSM_DEFAULT_NUM_HOSTS.
 426  *
 427  * Returns 0 on success, negative errno on failure.
 428  */
 429 static int smsm_get_size_info(struct qcom_smsm *smsm)
 430 {
 431         size_t size;
 432         struct {
 433                 u32 num_hosts;
 434                 u32 num_entries;
 435                 u32 reserved0;
 436                 u32 reserved1;
 437         } *info;
 438
 439         info = qcom_smem_get(QCOM_SMEM_HOST_ANY, SMEM_SMSM_SIZE_INFO, &size);
 440         if (IS_ERR(info) && PTR_ERR(info) != -ENOENT) {
 441                 if (PTR_ERR(info) != -EPROBE_DEFER)
 442                         dev_err(smsm->dev, "unable to retrieve smsm size info\n");
 443                 return PTR_ERR(info);
 444         } else if (IS_ERR(info) || size != sizeof(*info)) {
 445                 dev_warn(smsm->dev, "no smsm size info, using defaults\n");
 446                 smsm->num_entries = SMSM_DEFAULT_NUM_ENTRIES;
 447                 smsm->num_hosts = SMSM_DEFAULT_NUM_HOSTS;
 448                 return 0;
 449         }
 450
 451         smsm->num_entries = info->num_entries;
 452         smsm->num_hosts = info->num_hosts;
 453
 454         dev_dbg(smsm->dev,
 455                 "found custom size of smsm: %d entries %d hosts\n",
 456                 smsm->num_entries, smsm->num_hosts);
 457
 458         return 0;
 459 }
 460
 461 static int qcom_smsm_probe(struct platform_device *pdev)
 462 {
 463         struct device_node *local_node;
 464         struct device_node *node;
 465         struct smsm_entry *entry;
 466         struct qcom_smsm *smsm;
 467         u32 *intr_mask;
 468         size_t size;
 469         u32 *states;
 470         u32 id;
 471         int ret;
 472
 473         smsm = devm_kzalloc(&pdev->dev, sizeof(*smsm), GFP_KERNEL);
 474         if (!smsm)
 475                 return -ENOMEM;
 476         smsm->dev = &pdev->dev;
 477         spin_lock_init(&smsm->lock);
 478
 479         ret = smsm_get_size_info(smsm);
 480         if (ret)
 481                 return ret;
 482
 483         smsm->entries = devm_kcalloc(&pdev->dev,
 484                                      smsm->num_entries,
 485                                      sizeof(struct smsm_entry),
 486                                      GFP_KERNEL);
 487         if (!smsm->entries)
 488                 return -ENOMEM;
 489
 490         smsm->hosts = devm_kcalloc(&pdev->dev,
 491                                    smsm->num_hosts,
 492                                    sizeof(struct smsm_host),
 493                                    GFP_KERNEL);
 494         if (!smsm->hosts)
 495                 return -ENOMEM;
 496
 497         for_each_child_of_node(pdev->dev.of_node, local_node) {
 498                 if (of_find_property(local_node, "#qcom,smem-state-cells", NULL))
 499                         break;
 500         }
 501         if (!local_node) {
 502                 dev_err(&pdev->dev, "no state entry\n");
 503                 return -EINVAL;
 504         }
 505
 506         of_property_read_u32(pdev->dev.of_node,
 507                              "qcom,local-host",
 508                              &smsm->local_host);
 509
 510         /* Parse the host properties */
 511         for (id = 0; id < smsm->num_hosts; id++) {
 512                 ret = smsm_parse_ipc(smsm, id);
 513                 if (ret < 0)
 514                         goto out_put;
 515         }
 516
 517         /* Acquire the main SMSM state vector */
 518         ret = qcom_smem_alloc(QCOM_SMEM_HOST_ANY, SMEM_SMSM_SHARED_STATE,
 519                               smsm->num_entries * sizeof(u32));
 520         if (ret < 0 && ret != -EEXIST) {
 521                 dev_err(&pdev->dev, "unable to allocate shared state entry\n");
 522                 goto out_put;
 523         }
 524
 525         states = qcom_smem_get(QCOM_SMEM_HOST_ANY, SMEM_SMSM_SHARED_STATE, NULL);
 526         if (IS_ERR(states)) {
 527                 dev_err(&pdev->dev, "Unable to acquire shared state entry\n");
 528                 ret = PTR_ERR(states);
 529                 goto out_put;
 530         }
 531
 532         /* Acquire the list of interrupt mask vectors */
 533         size = smsm->num_entries * smsm->num_hosts * sizeof(u32);
 534         ret = qcom_smem_alloc(QCOM_SMEM_HOST_ANY, SMEM_SMSM_CPU_INTR_MASK, size);
 535         if (ret < 0 && ret != -EEXIST) {
 536                 dev_err(&pdev->dev, "unable to allocate smsm interrupt mask\n");
 537                 goto out_put;
 538         }
 539
 540         intr_mask = qcom_smem_get(QCOM_SMEM_HOST_ANY, SMEM_SMSM_CPU_INTR_MASK, NULL);
 541         if (IS_ERR(intr_mask)) {
 542                 dev_err(&pdev->dev, "unable to acquire shared memory interrupt mask\n");
 543                 ret = PTR_ERR(intr_mask);
 544                 goto out_put;
 545         }
 546
 547         /* Setup the reference to the local state bits */
 548         smsm->local_state = states + smsm->local_host;
 549         smsm->subscription = intr_mask + smsm->local_host * smsm->num_hosts;
 550
 551         /* Register the outgoing state */
 552         smsm->state = qcom_smem_state_register(local_node, &smsm_state_ops, smsm);
 553         if (IS_ERR(smsm->state)) {
 554                 dev_err(smsm->dev, "failed to register qcom_smem_state\n");
 555                 ret = PTR_ERR(smsm->state);
 556                 goto out_put;
 557         }
 558
 559         /* Register handlers for remote processor entries of interest. */
 560         for_each_available_child_of_node(pdev->dev.of_node, node) {
 561                 if (!of_property_read_bool(node, "interrupt-controller"))
 562                         continue;
 563
 564                 ret = of_property_read_u32(node, "reg", &id);
 565                 if (ret || id >= smsm->num_entries) {
 566                         dev_err(&pdev->dev, "invalid reg of entry\n");
 567                         if (!ret)
 568                                 ret = -EINVAL;
 569                         goto unwind_interfaces;
 570                 }
 571                 entry = &smsm->entries[id];
 572
 573                 entry->smsm = smsm;
 574                 entry->remote_state = states + id;
 575
 576                 /* Setup subscription pointers and unsubscribe to any kicks */
 577                 entry->subscription = intr_mask + id * smsm->num_hosts;
 578                 writel(0, entry->subscription + smsm->local_host);
 579
 580                 ret = smsm_inbound_entry(smsm, entry, node);
 581                 if (ret < 0)
 582                         goto unwind_interfaces;
 583         }
 584
 585         platform_set_drvdata(pdev, smsm);
 586         of_node_put(local_node);
 587
 588         return 0;
 589
 590 unwind_interfaces:
 591         of_node_put(node);
 592         for (id = 0; id < smsm->num_entries; id++)
 593                 if (smsm->entries[id].domain)
 594                         irq_domain_remove(smsm->entries[id].domain);
 595
 596         qcom_smem_state_unregister(smsm->state);
 597 out_put:
 598         of_node_put(local_node);
 599         return ret;
 600 }
 601
 602 static int qcom_smsm_remove(struct platform_device *pdev)
 603 {
 604         struct qcom_smsm *smsm = platform_get_drvdata(pdev);
 605         unsigned id;
 606
 607         for (id = 0; id < smsm->num_entries; id++)
 608                 if (smsm->entries[id].domain)
 609                         irq_domain_remove(smsm->entries[id].domain);
 610
 611         qcom_smem_state_unregister(smsm->state);
 612
 613         return 0;
 614 }
 615
 616 static const struct of_device_id qcom_smsm_of_match[] = {
 617         { .compatible = "qcom,smsm" },
 618         {}
 619 };
 620 MODULE_DEVICE_TABLE(of, qcom_smsm_of_match);
 621
 622 static struct platform_driver qcom_smsm_driver = {
 623         .probe = qcom_smsm_probe,
 624         .remove = qcom_smsm_remove,
 625         .driver  = {
 626                 .name  = "qcom-smsm",
 627                 .of_match_table = qcom_smsm_of_match,
 628         },
 629 };
 630 module_platform_driver(qcom_smsm_driver);
 631
 632 MODULE_DESCRIPTION("Qualcomm Shared Memory State Machine driver");
 633 MODULE_LICENSE("GPL v2");