drivers/mailbox/pcc.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *      Copyright (C) 2014 Linaro Ltd.
   4  *      Author: Ashwin Chaugule <ashwin.chaugule@linaro.org>
   5  *
   6  *  PCC (Platform Communication Channel) is defined in the ACPI 5.0+
   7  *  specification. It is a mailbox like mechanism to allow clients
   8  *  such as CPPC (Collaborative Processor Performance Control), RAS
   9  *  (Reliability, Availability and Serviceability) and MPST (Memory
  10  *  Node Power State Table) to talk to the platform (e.g. BMC) through
  11  *  shared memory regions as defined in the PCC table entries. The PCC
  12  *  specification supports a Doorbell mechanism for the PCC clients
  13  *  to notify the platform about new data. This Doorbell information
  14  *  is also specified in each PCC table entry.
  15  *
  16  *  Typical high level flow of operation is:
  17  *
  18  *  PCC Reads:
  19  *  * Client tries to acquire a channel lock.
  20  *  * After it is acquired it writes READ cmd in communication region cmd
  21  *              address.
  22  *  * Client issues mbox_send_message() which rings the PCC doorbell
  23  *              for its PCC channel.
  24  *  * If command completes, then client has control over channel and
  25  *              it can proceed with its reads.
  26  *  * Client releases lock.
  27  *
  28  *  PCC Writes:
  29  *  * Client tries to acquire channel lock.
  30  *  * Client writes to its communication region after it acquires a
  31  *              channel lock.
  32  *  * Client writes WRITE cmd in communication region cmd address.
  33  *  * Client issues mbox_send_message() which rings the PCC doorbell
  34  *              for its PCC channel.
  35  *  * If command completes, then writes have succeeded and it can release
  36  *              the channel lock.
  37  *
  38  *  There is a Nominal latency defined for each channel which indicates
  39  *  how long to wait until a command completes. If command is not complete
  40  *  the client needs to retry or assume failure.
  41  *
  42  *      For more details about PCC, please see the ACPI specification from
  43  *  http://www.uefi.org/ACPIv5.1 Section 14.
  44  *
  45  *  This file implements PCC as a Mailbox controller and allows for PCC
  46  *  clients to be implemented as its Mailbox Client Channels.
  47  */
  48
  49 #include <linux/acpi.h>
  50 #include <linux/delay.h>
  51 #include <linux/io.h>
  52 #include <linux/init.h>
  53 #include <linux/interrupt.h>
  54 #include <linux/list.h>
  55 #include <linux/log2.h>
  56 #include <linux/platform_device.h>
  57 #include <linux/mailbox_controller.h>
  58 #include <linux/mailbox_client.h>
  59 #include <linux/io-64-nonatomic-lo-hi.h>
  60 #include <acpi/pcc.h>
  61
  62 #include "mailbox.h"
  63
  64 #define MBOX_IRQ_NAME           "pcc-mbox"
  65
  66 /**
  67  * struct pcc_chan_reg - PCC register bundle
  68  *
  69  * @vaddr: cached virtual address for this register
  70  * @gas: pointer to the generic address structure for this register
  71  * @preserve_mask: bitmask to preserve when writing to this register
  72  * @set_mask: bitmask to set when writing to this register
  73  * @status_mask: bitmask to determine and/or update the status for this register
  74  */
  75 struct pcc_chan_reg {
  76         void __iomem *vaddr;
  77         struct acpi_generic_address *gas;
  78         u64 preserve_mask;
  79         u64 set_mask;
  80         u64 status_mask;
  81 };
  82
  83 /**
  84  * struct pcc_chan_info - PCC channel specific information
  85  *
  86  * @chan: PCC channel information with Shared Memory Region info
  87  * @db: PCC register bundle for the doorbell register
  88  * @plat_irq_ack: PCC register bundle for the platform interrupt acknowledge
  89  *      register
  90  * @cmd_complete: PCC register bundle for the command complete check register
  91  * @cmd_update: PCC register bundle for the command complete update register
  92  * @error: PCC register bundle for the error status register
  93  * @plat_irq: platform interrupt
  94  */
  95 struct pcc_chan_info {
  96         struct pcc_mbox_chan chan;
  97         struct pcc_chan_reg db;
  98         struct pcc_chan_reg plat_irq_ack;
  99         struct pcc_chan_reg cmd_complete;
 100         struct pcc_chan_reg cmd_update;
 101         struct pcc_chan_reg error;
 102         int plat_irq;
 103 };
 104
 105 #define to_pcc_chan_info(c) container_of(c, struct pcc_chan_info, chan)
 106 static struct pcc_chan_info *chan_info;
 107 static int pcc_chan_count;
 108
 109 /*
 110  * PCC can be used with perf critical drivers such as CPPC
 111  * So it makes sense to locally cache the virtual address and
 112  * use it to read/write to PCC registers such as doorbell register
 113  *
 114  * The below read_register and write_registers are used to read and
 115  * write from perf critical registers such as PCC doorbell register
 116  */
 117 static void read_register(void __iomem *vaddr, u64 *val, unsigned int bit_width)
 118 {
 119         switch (bit_width) {
 120         case 8:
 121                 *val = readb(vaddr);
 122                 break;
 123         case 16:
 124                 *val = readw(vaddr);
 125                 break;
 126         case 32:
 127                 *val = readl(vaddr);
 128                 break;
 129         case 64:
 130                 *val = readq(vaddr);
 131                 break;
 132         }
 133 }
 134
 135 static void write_register(void __iomem *vaddr, u64 val, unsigned int bit_width)
 136 {
 137         switch (bit_width) {
 138         case 8:
 139                 writeb(val, vaddr);
 140                 break;
 141         case 16:
 142                 writew(val, vaddr);
 143                 break;
 144         case 32:
 145                 writel(val, vaddr);
 146                 break;
 147         case 64:
 148                 writeq(val, vaddr);
 149                 break;
 150         }
 151 }
 152
 153 static int pcc_chan_reg_read(struct pcc_chan_reg *reg, u64 *val)
 154 {
 155         int ret = 0;
 156
 157         if (!reg->gas) {
 158                 *val = 0;
 159                 return 0;
 160         }
 161
 162         if (reg->vaddr)
 163                 read_register(reg->vaddr, val, reg->gas->bit_width);
 164         else
 165                 ret = acpi_read(val, reg->gas);
 166
 167         return ret;
 168 }
 169
 170 static int pcc_chan_reg_write(struct pcc_chan_reg *reg, u64 val)
 171 {
 172         int ret = 0;
 173
 174         if (!reg->gas)
 175                 return 0;
 176
 177         if (reg->vaddr)
 178                 write_register(reg->vaddr, val, reg->gas->bit_width);
 179         else
 180                 ret = acpi_write(val, reg->gas);
 181
 182         return ret;
 183 }
 184
 185 static int pcc_chan_reg_read_modify_write(struct pcc_chan_reg *reg)
 186 {
 187         int ret = 0;
 188         u64 val;
 189
 190         ret = pcc_chan_reg_read(reg, &val);
 191         if (ret)
 192                 return ret;
 193
 194         val &= reg->preserve_mask;
 195         val |= reg->set_mask;
 196
 197         return pcc_chan_reg_write(reg, val);
 198 }
 199
 200 /**
 201  * pcc_map_interrupt - Map a PCC subspace GSI to a linux IRQ number
 202  * @interrupt: GSI number.
 203  * @flags: interrupt flags
 204  *
 205  * Returns: a valid linux IRQ number on success
 206  *              0 or -EINVAL on failure
 207  */
 208 static int pcc_map_interrupt(u32 interrupt, u32 flags)
 209 {
 210         int trigger, polarity;
 211
 212         if (!interrupt)
 213                 return 0;
 214
 215         trigger = (flags & ACPI_PCCT_INTERRUPT_MODE) ? ACPI_EDGE_SENSITIVE
 216                         : ACPI_LEVEL_SENSITIVE;
 217
 218         polarity = (flags & ACPI_PCCT_INTERRUPT_POLARITY) ? ACPI_ACTIVE_LOW
 219                         : ACPI_ACTIVE_HIGH;
 220
 221         return acpi_register_gsi(NULL, interrupt, trigger, polarity);
 222 }
 223
 224 /**
 225  * pcc_mbox_irq - PCC mailbox interrupt handler
 226  * @irq:        interrupt number
 227  * @p: data/cookie passed from the caller to identify the channel
 228  *
 229  * Returns: IRQ_HANDLED if interrupt is handled or IRQ_NONE if not
 230  */
 231 static irqreturn_t pcc_mbox_irq(int irq, void *p)
 232 {
 233         struct pcc_chan_info *pchan;
 234         struct mbox_chan *chan = p;
 235         u64 val;
 236         int ret;
 237
 238         pchan = chan->con_priv;
 239
 240         ret = pcc_chan_reg_read(&pchan->cmd_complete, &val);
 241         if (ret)
 242                 return IRQ_NONE;
 243
 244         val &= pchan->cmd_complete.status_mask;
 245         if (!val)
 246                 return IRQ_NONE;
 247
 248         ret = pcc_chan_reg_read(&pchan->error, &val);
 249         if (ret)
 250                 return IRQ_NONE;
 251         val &= pchan->error.status_mask;
 252         if (val) {
 253                 val &= ~pchan->error.status_mask;
 254                 pcc_chan_reg_write(&pchan->error, val);
 255                 return IRQ_NONE;
 256         }
 257
 258         if (pcc_chan_reg_read_modify_write(&pchan->plat_irq_ack))
 259                 return IRQ_NONE;
 260
 261         mbox_chan_received_data(chan, NULL);
 262
 263         return IRQ_HANDLED;
 264 }
 265
 266 /**
 267  * pcc_mbox_request_channel - PCC clients call this function to
 268  *              request a pointer to their PCC subspace, from which they
 269  *              can get the details of communicating with the remote.
 270  * @cl: Pointer to Mailbox client, so we know where to bind the
 271  *              Channel.
 272  * @subspace_id: The PCC Subspace index as parsed in the PCC client
 273  *              ACPI package. This is used to lookup the array of PCC
 274  *              subspaces as parsed by the PCC Mailbox controller.
 275  *
 276  * Return: Pointer to the PCC Mailbox Channel if successful or ERR_PTR.
 277  */
 278 struct pcc_mbox_chan *
 279 pcc_mbox_request_channel(struct mbox_client *cl, int subspace_id)
 280 {
 281         struct pcc_chan_info *pchan;
 282         struct mbox_chan *chan;
 283         struct device *dev;
 284         unsigned long flags;
 285
 286         if (subspace_id < 0 || subspace_id >= pcc_chan_count)
 287                 return ERR_PTR(-ENOENT);
 288
 289         pchan = chan_info + subspace_id;
 290         chan = pchan->chan.mchan;
 291         if (IS_ERR(chan) || chan->cl) {
 292                 dev_err(dev, "Channel not found for idx: %d\n", subspace_id);
 293                 return ERR_PTR(-EBUSY);
 294         }
 295         dev = chan->mbox->dev;
 296
 297         spin_lock_irqsave(&chan->lock, flags);
 298         chan->msg_free = 0;
 299         chan->msg_count = 0;
 300         chan->active_req = NULL;
 301         chan->cl = cl;
 302         init_completion(&chan->tx_complete);
 303
 304         if (chan->txdone_method == TXDONE_BY_POLL && cl->knows_txdone)
 305                 chan->txdone_method = TXDONE_BY_ACK;
 306
 307         spin_unlock_irqrestore(&chan->lock, flags);
 308
 309         if (pchan->plat_irq > 0) {
 310                 int rc;
 311
 312                 rc = devm_request_irq(dev, pchan->plat_irq, pcc_mbox_irq, 0,
 313                                       MBOX_IRQ_NAME, chan);
 314                 if (unlikely(rc)) {
 315                         dev_err(dev, "failed to register PCC interrupt %d\n",
 316                                 pchan->plat_irq);
 317                         pcc_mbox_free_channel(&pchan->chan);
 318                         return ERR_PTR(rc);
 319                 }
 320         }
 321
 322         return &pchan->chan;
 323 }
 324 EXPORT_SYMBOL_GPL(pcc_mbox_request_channel);
 325
 326 /**
 327  * pcc_mbox_free_channel - Clients call this to free their Channel.
 328  *
 329  * @pchan: Pointer to the PCC mailbox channel as returned by
 330  *         pcc_mbox_request_channel()
 331  */
 332 void pcc_mbox_free_channel(struct pcc_mbox_chan *pchan)
 333 {
 334         struct pcc_chan_info *pchan_info = to_pcc_chan_info(pchan);
 335         struct mbox_chan *chan = pchan->mchan;
 336         unsigned long flags;
 337
 338         if (!chan || !chan->cl)
 339                 return;
 340
 341         if (pchan_info->plat_irq > 0)
 342                 devm_free_irq(chan->mbox->dev, pchan_info->plat_irq, chan);
 343
 344         spin_lock_irqsave(&chan->lock, flags);
 345         chan->cl = NULL;
 346         chan->active_req = NULL;
 347         if (chan->txdone_method == TXDONE_BY_ACK)
 348                 chan->txdone_method = TXDONE_BY_POLL;
 349
 350         spin_unlock_irqrestore(&chan->lock, flags);
 351 }
 352 EXPORT_SYMBOL_GPL(pcc_mbox_free_channel);
 353
 354 /**
 355  * pcc_send_data - Called from Mailbox Controller code. Used
 356  *              here only to ring the channel doorbell. The PCC client
 357  *              specific read/write is done in the client driver in
 358  *              order to maintain atomicity over PCC channel once
 359  *              OS has control over it. See above for flow of operations.
 360  * @chan: Pointer to Mailbox channel over which to send data.
 361  * @data: Client specific data written over channel. Used here
 362  *              only for debug after PCC transaction completes.
 363  *
 364  * Return: Err if something failed else 0 for success.
 365  */
 366 static int pcc_send_data(struct mbox_chan *chan, void *data)
 367 {
 368         int ret;
 369         struct pcc_chan_info *pchan = chan->con_priv;
 370
 371         ret = pcc_chan_reg_read_modify_write(&pchan->cmd_update);
 372         if (ret)
 373                 return ret;
 374
 375         return pcc_chan_reg_read_modify_write(&pchan->db);
 376 }
 377
 378 static const struct mbox_chan_ops pcc_chan_ops = {
 379         .send_data = pcc_send_data,
 380 };
 381
 382 /**
 383  * parse_pcc_subspace - Count PCC subspaces defined
 384  * @header: Pointer to the ACPI subtable header under the PCCT.
 385  * @end: End of subtable entry.
 386  *
 387  * Return: If we find a PCC subspace entry of a valid type, return 0.
 388  *      Otherwise, return -EINVAL.
 389  *
 390  * This gets called for each entry in the PCC table.
 391  */
 392 static int parse_pcc_subspace(union acpi_subtable_headers *header,
 393                 const unsigned long end)
 394 {
 395         struct acpi_pcct_subspace *ss = (struct acpi_pcct_subspace *) header;
 396
 397         if (ss->header.type < ACPI_PCCT_TYPE_RESERVED)
 398                 return 0;
 399
 400         return -EINVAL;
 401 }
 402
 403 static int
 404 pcc_chan_reg_init(struct pcc_chan_reg *reg, struct acpi_generic_address *gas,
 405                   u64 preserve_mask, u64 set_mask, u64 status_mask, char *name)
 406 {
 407         if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 408                 if (!(gas->bit_width >= 8 && gas->bit_width <= 64 &&
 409                       is_power_of_2(gas->bit_width))) {
 410                         pr_err("Error: Cannot access register of %u bit width",
 411                                gas->bit_width);
 412                         return -EFAULT;
 413                 }
 414
 415                 reg->vaddr = acpi_os_ioremap(gas->address, gas->bit_width / 8);
 416                 if (!reg->vaddr) {
 417                         pr_err("Failed to ioremap PCC %s register\n", name);
 418                         return -ENOMEM;
 419                 }
 420         }
 421         reg->gas = gas;
 422         reg->preserve_mask = preserve_mask;
 423         reg->set_mask = set_mask;
 424         reg->status_mask = status_mask;
 425         return 0;
 426 }
 427
 428 /**
 429  * pcc_parse_subspace_irq - Parse the PCC IRQ and PCC ACK register
 430  *
 431  * @pchan: Pointer to the PCC channel info structure.
 432  * @pcct_entry: Pointer to the ACPI subtable header.
 433  *
 434  * Return: 0 for Success, else errno.
 435  *
 436  * There should be one entry per PCC channel. This gets called for each
 437  * entry in the PCC table. This uses PCCY Type1 structure for all applicable
 438  * types(Type 1-4) to fetch irq
 439  */
 440 static int pcc_parse_subspace_irq(struct pcc_chan_info *pchan,
 441                                   struct acpi_subtable_header *pcct_entry)
 442 {
 443         int ret = 0;
 444         struct acpi_pcct_hw_reduced *pcct_ss;
 445
 446         if (pcct_entry->type < ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE ||
 447             pcct_entry->type > ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE)
 448                 return 0;
 449
 450         pcct_ss = (struct acpi_pcct_hw_reduced *)pcct_entry;
 451         pchan->plat_irq = pcc_map_interrupt(pcct_ss->platform_interrupt,
 452                                             (u32)pcct_ss->flags);
 453         if (pchan->plat_irq <= 0) {
 454                 pr_err("PCC GSI %d not registered\n",
 455                        pcct_ss->platform_interrupt);
 456                 return -EINVAL;
 457         }
 458
 459         if (pcct_ss->header.type == ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2) {
 460                 struct acpi_pcct_hw_reduced_type2 *pcct2_ss = (void *)pcct_ss;
 461
 462                 ret = pcc_chan_reg_init(&pchan->plat_irq_ack,
 463                                         &pcct2_ss->platform_ack_register,
 464                                         pcct2_ss->ack_preserve_mask,
 465                                         pcct2_ss->ack_write_mask, 0,
 466                                         "PLAT IRQ ACK");
 467
 468         } else if (pcct_ss->header.type == ACPI_PCCT_TYPE_EXT_PCC_MASTER_SUBSPACE ||
 469                    pcct_ss->header.type == ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE) {
 470                 struct acpi_pcct_ext_pcc_master *pcct_ext = (void *)pcct_ss;
 471
 472                 ret = pcc_chan_reg_init(&pchan->plat_irq_ack,
 473                                         &pcct_ext->platform_ack_register,
 474                                         pcct_ext->ack_preserve_mask,
 475                                         pcct_ext->ack_set_mask, 0,
 476                                         "PLAT IRQ ACK");
 477         }
 478
 479         return ret;
 480 }
 481
 482 /**
 483  * pcc_parse_subspace_db_reg - Parse the PCC doorbell register
 484  *
 485  * @pchan: Pointer to the PCC channel info structure.
 486  * @pcct_entry: Pointer to the ACPI subtable header.
 487  *
 488  * Return: 0 for Success, else errno.
 489  */
 490 static int pcc_parse_subspace_db_reg(struct pcc_chan_info *pchan,
 491                                      struct acpi_subtable_header *pcct_entry)
 492 {
 493         int ret = 0;
 494
 495         if (pcct_entry->type <= ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2) {
 496                 struct acpi_pcct_subspace *pcct_ss;
 497
 498                 pcct_ss = (struct acpi_pcct_subspace *)pcct_entry;
 499
 500                 ret = pcc_chan_reg_init(&pchan->db,
 501                                         &pcct_ss->doorbell_register,
 502                                         pcct_ss->preserve_mask,
 503                                         pcct_ss->write_mask, 0, "Doorbell");
 504
 505         } else {
 506                 struct acpi_pcct_ext_pcc_master *pcct_ext;
 507
 508                 pcct_ext = (struct acpi_pcct_ext_pcc_master *)pcct_entry;
 509
 510                 ret = pcc_chan_reg_init(&pchan->db,
 511                                         &pcct_ext->doorbell_register,
 512                                         pcct_ext->preserve_mask,
 513                                         pcct_ext->write_mask, 0, "Doorbell");
 514                 if (ret)
 515                         return ret;
 516
 517                 ret = pcc_chan_reg_init(&pchan->cmd_complete,
 518                                         &pcct_ext->cmd_complete_register,
 519                                         0, 0, pcct_ext->cmd_complete_mask,
 520                                         "Command Complete Check");
 521                 if (ret)
 522                         return ret;
 523
 524                 ret = pcc_chan_reg_init(&pchan->cmd_update,
 525                                         &pcct_ext->cmd_update_register,
 526                                         pcct_ext->cmd_update_preserve_mask,
 527                                         pcct_ext->cmd_update_set_mask, 0,
 528                                         "Command Complete Update");
 529                 if (ret)
 530                         return ret;
 531
 532                 ret = pcc_chan_reg_init(&pchan->error,
 533                                         &pcct_ext->error_status_register,
 534                                         0, 0, pcct_ext->error_status_mask,
 535                                         "Error Status");
 536         }
 537         return ret;
 538 }
 539
 540 /**
 541  * pcc_parse_subspace_shmem - Parse the PCC Shared Memory Region information
 542  *
 543  * @pchan: Pointer to the PCC channel info structure.
 544  * @pcct_entry: Pointer to the ACPI subtable header.
 545  *
 546  */
 547 static void pcc_parse_subspace_shmem(struct pcc_chan_info *pchan,
 548                                      struct acpi_subtable_header *pcct_entry)
 549 {
 550         if (pcct_entry->type <= ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2) {
 551                 struct acpi_pcct_subspace *pcct_ss =
 552                         (struct acpi_pcct_subspace *)pcct_entry;
 553
 554                 pchan->chan.shmem_base_addr = pcct_ss->base_address;
 555                 pchan->chan.shmem_size = pcct_ss->length;
 556                 pchan->chan.latency = pcct_ss->latency;
 557                 pchan->chan.max_access_rate = pcct_ss->max_access_rate;
 558                 pchan->chan.min_turnaround_time = pcct_ss->min_turnaround_time;
 559         } else {
 560                 struct acpi_pcct_ext_pcc_master *pcct_ext =
 561                         (struct acpi_pcct_ext_pcc_master *)pcct_entry;
 562
 563                 pchan->chan.shmem_base_addr = pcct_ext->base_address;
 564                 pchan->chan.shmem_size = pcct_ext->length;
 565                 pchan->chan.latency = pcct_ext->latency;
 566                 pchan->chan.max_access_rate = pcct_ext->max_access_rate;
 567                 pchan->chan.min_turnaround_time = pcct_ext->min_turnaround_time;
 568         }
 569 }
 570
 571 /**
 572  * acpi_pcc_probe - Parse the ACPI tree for the PCCT.
 573  *
 574  * Return: 0 for Success, else errno.
 575  */
 576 static int __init acpi_pcc_probe(void)
 577 {
 578         int count, i, rc = 0;
 579         acpi_status status;
 580         struct acpi_table_header *pcct_tbl;
 581         struct acpi_subtable_proc proc[ACPI_PCCT_TYPE_RESERVED];
 582
 583         status = acpi_get_table(ACPI_SIG_PCCT, 0, &pcct_tbl);
 584         if (ACPI_FAILURE(status) || !pcct_tbl)
 585                 return -ENODEV;
 586
 587         /* Set up the subtable handlers */
 588         for (i = ACPI_PCCT_TYPE_GENERIC_SUBSPACE;
 589              i < ACPI_PCCT_TYPE_RESERVED; i++) {
 590                 proc[i].id = i;
 591                 proc[i].count = 0;
 592                 proc[i].handler = parse_pcc_subspace;
 593         }
 594
 595         count = acpi_table_parse_entries_array(ACPI_SIG_PCCT,
 596                         sizeof(struct acpi_table_pcct), proc,
 597                         ACPI_PCCT_TYPE_RESERVED, MAX_PCC_SUBSPACES);
 598         if (count <= 0 || count > MAX_PCC_SUBSPACES) {
 599                 if (count < 0)
 600                         pr_warn("Error parsing PCC subspaces from PCCT\n");
 601                 else
 602                         pr_warn("Invalid PCCT: %d PCC subspaces\n", count);
 603
 604                 rc = -EINVAL;
 605         } else {
 606                 pcc_chan_count = count;
 607         }
 608
 609         acpi_put_table(pcct_tbl);
 610
 611         return rc;
 612 }
 613
 614 /**
 615  * pcc_mbox_probe - Called when we find a match for the
 616  *      PCCT platform device. This is purely used to represent
 617  *      the PCCT as a virtual device for registering with the
 618  *      generic Mailbox framework.
 619  *
 620  * @pdev: Pointer to platform device returned when a match
 621  *      is found.
 622  *
 623  *      Return: 0 for Success, else errno.
 624  */
 625 static int pcc_mbox_probe(struct platform_device *pdev)
 626 {
 627         struct device *dev = &pdev->dev;
 628         struct mbox_controller *pcc_mbox_ctrl;
 629         struct mbox_chan *pcc_mbox_channels;
 630         struct acpi_table_header *pcct_tbl;
 631         struct acpi_subtable_header *pcct_entry;
 632         struct acpi_table_pcct *acpi_pcct_tbl;
 633         acpi_status status = AE_OK;
 634         int i, rc, count = pcc_chan_count;
 635
 636         /* Search for PCCT */
 637         status = acpi_get_table(ACPI_SIG_PCCT, 0, &pcct_tbl);
 638
 639         if (ACPI_FAILURE(status) || !pcct_tbl)
 640                 return -ENODEV;
 641
 642         pcc_mbox_channels = devm_kcalloc(dev, count, sizeof(*pcc_mbox_channels),
 643                                          GFP_KERNEL);
 644         if (!pcc_mbox_channels) {
 645                 rc = -ENOMEM;
 646                 goto err;
 647         }
 648
 649         chan_info = devm_kcalloc(dev, count, sizeof(*chan_info), GFP_KERNEL);
 650         if (!chan_info) {
 651                 rc = -ENOMEM;
 652                 goto err;
 653         }
 654
 655         pcc_mbox_ctrl = devm_kmalloc(dev, sizeof(*pcc_mbox_ctrl), GFP_KERNEL);
 656         if (!pcc_mbox_ctrl) {
 657                 rc = -ENOMEM;
 658                 goto err;
 659         }
 660
 661         /* Point to the first PCC subspace entry */
 662         pcct_entry = (struct acpi_subtable_header *) (
 663                 (unsigned long) pcct_tbl + sizeof(struct acpi_table_pcct));
 664
 665         acpi_pcct_tbl = (struct acpi_table_pcct *) pcct_tbl;
 666         if (acpi_pcct_tbl->flags & ACPI_PCCT_DOORBELL)
 667                 pcc_mbox_ctrl->txdone_irq = true;
 668
 669         for (i = 0; i < count; i++) {
 670                 struct pcc_chan_info *pchan = chan_info + i;
 671
 672                 pcc_mbox_channels[i].con_priv = pchan;
 673                 pchan->chan.mchan = &pcc_mbox_channels[i];
 674
 675                 if (pcct_entry->type == ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE &&
 676                     !pcc_mbox_ctrl->txdone_irq) {
 677                         pr_err("Plaform Interrupt flag must be set to 1");
 678                         rc = -EINVAL;
 679                         goto err;
 680                 }
 681
 682                 if (pcc_mbox_ctrl->txdone_irq) {
 683                         rc = pcc_parse_subspace_irq(pchan, pcct_entry);
 684                         if (rc < 0)
 685                                 goto err;
 686                 }
 687                 rc = pcc_parse_subspace_db_reg(pchan, pcct_entry);
 688                 if (rc < 0)
 689                         goto err;
 690
 691                 pcc_parse_subspace_shmem(pchan, pcct_entry);
 692
 693                 pcct_entry = (struct acpi_subtable_header *)
 694                         ((unsigned long) pcct_entry + pcct_entry->length);
 695         }
 696
 697         pcc_mbox_ctrl->num_chans = count;
 698
 699         pr_info("Detected %d PCC Subspaces\n", pcc_mbox_ctrl->num_chans);
 700
 701         pcc_mbox_ctrl->chans = pcc_mbox_channels;
 702         pcc_mbox_ctrl->ops = &pcc_chan_ops;
 703         pcc_mbox_ctrl->dev = dev;
 704
 705         pr_info("Registering PCC driver as Mailbox controller\n");
 706         rc = mbox_controller_register(pcc_mbox_ctrl);
 707         if (rc)
 708                 pr_err("Err registering PCC as Mailbox controller: %d\n", rc);
 709         else
 710                 return 0;
 711 err:
 712         acpi_put_table(pcct_tbl);
 713         return rc;
 714 }
 715
 716 static struct platform_driver pcc_mbox_driver = {
 717         .probe = pcc_mbox_probe,
 718         .driver = {
 719                 .name = "PCCT",
 720         },
 721 };
 722
 723 static int __init pcc_init(void)
 724 {
 725         int ret;
 726         struct platform_device *pcc_pdev;
 727
 728         if (acpi_disabled)
 729                 return -ENODEV;
 730
 731         /* Check if PCC support is available. */
 732         ret = acpi_pcc_probe();
 733
 734         if (ret) {
 735                 pr_debug("ACPI PCC probe failed.\n");
 736                 return -ENODEV;
 737         }
 738
 739         pcc_pdev = platform_create_bundle(&pcc_mbox_driver,
 740                         pcc_mbox_probe, NULL, 0, NULL, 0);
 741
 742         if (IS_ERR(pcc_pdev)) {
 743                 pr_debug("Err creating PCC platform bundle\n");
 744                 return PTR_ERR(pcc_pdev);
 745         }
 746
 747         return 0;
 748 }
 749
 750 /*
 751  * Make PCC init postcore so that users of this mailbox
 752  * such as the ACPI Processor driver have it available
 753  * at their init.
 754  */
 755 postcore_initcall(pcc_init);