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 * @type: PCC subspace type
95 * @plat_irq_flags: platform interrupt flags
96 * @chan_in_use: this flag is used just to check if the interrupt needs
97 * handling when it is shared. Since only one transfer can occur
98 * at a time and mailbox takes care of locking, this flag can be
99 * accessed without a lock. Note: the type only support the
100 * communication from OSPM to Platform, like type3, use it, and
101 * other types completely ignore it.
102 */
103 struct pcc_chan_info {
104 struct pcc_mbox_chan chan;
105 struct pcc_chan_reg db;
106 struct pcc_chan_reg plat_irq_ack;
107 struct pcc_chan_reg cmd_complete;
108 struct pcc_chan_reg cmd_update;
109 struct pcc_chan_reg error;
110 int plat_irq;
111 u8 type;
112 unsigned int plat_irq_flags;
113 bool chan_in_use;
114 };
115
116 #define to_pcc_chan_info(c) container_of(c, struct pcc_chan_info, chan)
117 static struct pcc_chan_info *chan_info;
118 static int pcc_chan_count;
119
120 static int pcc_send_data(struct mbox_chan *chan, void *data);
121
122 /*
123 * PCC can be used with perf critical drivers such as CPPC
124 * So it makes sense to locally cache the virtual address and
125 * use it to read/write to PCC registers such as doorbell register
126 *
127 * The below read_register and write_registers are used to read and
128 * write from perf critical registers such as PCC doorbell register
129 */
read_register(void __iomem * vaddr,u64 * val,unsigned int bit_width)130 static void read_register(void __iomem *vaddr, u64 *val, unsigned int bit_width)
131 {
132 switch (bit_width) {
133 case 8:
134 *val = readb(vaddr);
135 break;
136 case 16:
137 *val = readw(vaddr);
138 break;
139 case 32:
140 *val = readl(vaddr);
141 break;
142 case 64:
143 *val = readq(vaddr);
144 break;
145 }
146 }
147
write_register(void __iomem * vaddr,u64 val,unsigned int bit_width)148 static void write_register(void __iomem *vaddr, u64 val, unsigned int bit_width)
149 {
150 switch (bit_width) {
151 case 8:
152 writeb(val, vaddr);
153 break;
154 case 16:
155 writew(val, vaddr);
156 break;
157 case 32:
158 writel(val, vaddr);
159 break;
160 case 64:
161 writeq(val, vaddr);
162 break;
163 }
164 }
165
pcc_chan_reg_read(struct pcc_chan_reg * reg,u64 * val)166 static int pcc_chan_reg_read(struct pcc_chan_reg *reg, u64 *val)
167 {
168 int ret = 0;
169
170 if (!reg->gas) {
171 *val = 0;
172 return 0;
173 }
174
175 if (reg->vaddr)
176 read_register(reg->vaddr, val, reg->gas->bit_width);
177 else
178 ret = acpi_read(val, reg->gas);
179
180 return ret;
181 }
182
pcc_chan_reg_write(struct pcc_chan_reg * reg,u64 val)183 static int pcc_chan_reg_write(struct pcc_chan_reg *reg, u64 val)
184 {
185 int ret = 0;
186
187 if (!reg->gas)
188 return 0;
189
190 if (reg->vaddr)
191 write_register(reg->vaddr, val, reg->gas->bit_width);
192 else
193 ret = acpi_write(val, reg->gas);
194
195 return ret;
196 }
197
pcc_chan_reg_read_modify_write(struct pcc_chan_reg * reg)198 static int pcc_chan_reg_read_modify_write(struct pcc_chan_reg *reg)
199 {
200 int ret = 0;
201 u64 val;
202
203 ret = pcc_chan_reg_read(reg, &val);
204 if (ret)
205 return ret;
206
207 val &= reg->preserve_mask;
208 val |= reg->set_mask;
209
210 return pcc_chan_reg_write(reg, val);
211 }
212
213 /**
214 * pcc_map_interrupt - Map a PCC subspace GSI to a linux IRQ number
215 * @interrupt: GSI number.
216 * @flags: interrupt flags
217 *
218 * Returns: a valid linux IRQ number on success
219 * 0 or -EINVAL on failure
220 */
pcc_map_interrupt(u32 interrupt,u32 flags)221 static int pcc_map_interrupt(u32 interrupt, u32 flags)
222 {
223 int trigger, polarity;
224
225 if (!interrupt)
226 return 0;
227
228 trigger = (flags & ACPI_PCCT_INTERRUPT_MODE) ? ACPI_EDGE_SENSITIVE
229 : ACPI_LEVEL_SENSITIVE;
230
231 polarity = (flags & ACPI_PCCT_INTERRUPT_POLARITY) ? ACPI_ACTIVE_LOW
232 : ACPI_ACTIVE_HIGH;
233
234 return acpi_register_gsi(NULL, interrupt, trigger, polarity);
235 }
236
pcc_chan_plat_irq_can_be_shared(struct pcc_chan_info * pchan)237 static bool pcc_chan_plat_irq_can_be_shared(struct pcc_chan_info *pchan)
238 {
239 return (pchan->plat_irq_flags & ACPI_PCCT_INTERRUPT_MODE) ==
240 ACPI_LEVEL_SENSITIVE;
241 }
242
pcc_mbox_cmd_complete_check(struct pcc_chan_info * pchan)243 static bool pcc_mbox_cmd_complete_check(struct pcc_chan_info *pchan)
244 {
245 u64 val;
246 int ret;
247
248 ret = pcc_chan_reg_read(&pchan->cmd_complete, &val);
249 if (ret)
250 return false;
251
252 if (!pchan->cmd_complete.gas)
253 return true;
254
255 /*
256 * Judge if the channel respond the interrupt based on the value of
257 * command complete.
258 */
259 val &= pchan->cmd_complete.status_mask;
260
261 /*
262 * If this is PCC slave subspace channel, and the command complete
263 * bit 0 indicates that Platform is sending a notification and OSPM
264 * needs to respond this interrupt to process this command.
265 */
266 if (pchan->type == ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE)
267 return !val;
268
269 return !!val;
270 }
271
check_and_ack(struct pcc_chan_info * pchan,struct mbox_chan * chan)272 static void check_and_ack(struct pcc_chan_info *pchan, struct mbox_chan *chan)
273 {
274 struct acpi_pcct_ext_pcc_shared_memory pcc_hdr;
275
276 if (pchan->type != ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE)
277 return;
278 /* If the memory region has not been mapped, we cannot
279 * determine if we need to send the message, but we still
280 * need to set the cmd_update flag before returning.
281 */
282 if (pchan->chan.shmem == NULL) {
283 pcc_chan_reg_read_modify_write(&pchan->cmd_update);
284 return;
285 }
286 memcpy_fromio(&pcc_hdr, pchan->chan.shmem,
287 sizeof(struct acpi_pcct_ext_pcc_shared_memory));
288 /*
289 * The PCC slave subspace channel needs to set the command complete bit
290 * after processing message. If the PCC_ACK_FLAG is set, it should also
291 * ring the doorbell.
292 *
293 * The PCC master subspace channel clears chan_in_use to free channel.
294 */
295 if (le32_to_cpup(&pcc_hdr.flags) & PCC_ACK_FLAG_MASK)
296 pcc_send_data(chan, NULL);
297 else
298 pcc_chan_reg_read_modify_write(&pchan->cmd_update);
299 }
300
301 /**
302 * pcc_mbox_irq - PCC mailbox interrupt handler
303 * @irq: interrupt number
304 * @p: data/cookie passed from the caller to identify the channel
305 *
306 * Returns: IRQ_HANDLED if interrupt is handled or IRQ_NONE if not
307 */
pcc_mbox_irq(int irq,void * p)308 static irqreturn_t pcc_mbox_irq(int irq, void *p)
309 {
310 struct pcc_chan_info *pchan;
311 struct mbox_chan *chan = p;
312 u64 val;
313 int ret;
314
315 pchan = chan->con_priv;
316
317 if (pcc_chan_reg_read_modify_write(&pchan->plat_irq_ack))
318 return IRQ_NONE;
319
320 if (pchan->type == ACPI_PCCT_TYPE_EXT_PCC_MASTER_SUBSPACE &&
321 !pchan->chan_in_use)
322 return IRQ_NONE;
323
324 if (!pcc_mbox_cmd_complete_check(pchan))
325 return IRQ_NONE;
326
327 ret = pcc_chan_reg_read(&pchan->error, &val);
328 if (ret)
329 return IRQ_NONE;
330 val &= pchan->error.status_mask;
331 if (val) {
332 val &= ~pchan->error.status_mask;
333 pcc_chan_reg_write(&pchan->error, val);
334 return IRQ_NONE;
335 }
336
337 /*
338 * Clear this flag after updating interrupt ack register and just
339 * before mbox_chan_received_data() which might call pcc_send_data()
340 * where the flag is set again to start new transfer. This is
341 * required to avoid any possible race in updatation of this flag.
342 */
343 pchan->chan_in_use = false;
344 mbox_chan_received_data(chan, NULL);
345
346 check_and_ack(pchan, chan);
347
348 return IRQ_HANDLED;
349 }
350
351 /**
352 * pcc_mbox_request_channel - PCC clients call this function to
353 * request a pointer to their PCC subspace, from which they
354 * can get the details of communicating with the remote.
355 * @cl: Pointer to Mailbox client, so we know where to bind the
356 * Channel.
357 * @subspace_id: The PCC Subspace index as parsed in the PCC client
358 * ACPI package. This is used to lookup the array of PCC
359 * subspaces as parsed by the PCC Mailbox controller.
360 *
361 * Return: Pointer to the PCC Mailbox Channel if successful or ERR_PTR.
362 */
363 struct pcc_mbox_chan *
pcc_mbox_request_channel(struct mbox_client * cl,int subspace_id)364 pcc_mbox_request_channel(struct mbox_client *cl, int subspace_id)
365 {
366 struct pcc_chan_info *pchan;
367 struct mbox_chan *chan;
368 int rc;
369
370 if (subspace_id < 0 || subspace_id >= pcc_chan_count)
371 return ERR_PTR(-ENOENT);
372
373 pchan = chan_info + subspace_id;
374 chan = pchan->chan.mchan;
375 if (IS_ERR(chan) || chan->cl) {
376 pr_err("Channel not found for idx: %d\n", subspace_id);
377 return ERR_PTR(-EBUSY);
378 }
379
380 rc = mbox_bind_client(chan, cl);
381 if (rc)
382 return ERR_PTR(rc);
383
384 return &pchan->chan;
385 }
386 EXPORT_SYMBOL_GPL(pcc_mbox_request_channel);
387
388 /**
389 * pcc_mbox_free_channel - Clients call this to free their Channel.
390 *
391 * @pchan: Pointer to the PCC mailbox channel as returned by
392 * pcc_mbox_request_channel()
393 */
pcc_mbox_free_channel(struct pcc_mbox_chan * pchan)394 void pcc_mbox_free_channel(struct pcc_mbox_chan *pchan)
395 {
396 struct mbox_chan *chan = pchan->mchan;
397 struct pcc_chan_info *pchan_info;
398 struct pcc_mbox_chan *pcc_mbox_chan;
399
400 if (!chan || !chan->cl)
401 return;
402 pchan_info = chan->con_priv;
403 pcc_mbox_chan = &pchan_info->chan;
404 if (pcc_mbox_chan->shmem) {
405 iounmap(pcc_mbox_chan->shmem);
406 pcc_mbox_chan->shmem = NULL;
407 }
408
409 mbox_free_channel(chan);
410 }
411 EXPORT_SYMBOL_GPL(pcc_mbox_free_channel);
412
pcc_mbox_ioremap(struct mbox_chan * chan)413 int pcc_mbox_ioremap(struct mbox_chan *chan)
414 {
415 struct pcc_chan_info *pchan_info;
416 struct pcc_mbox_chan *pcc_mbox_chan;
417
418 if (!chan || !chan->cl)
419 return -1;
420 pchan_info = chan->con_priv;
421 pcc_mbox_chan = &pchan_info->chan;
422
423 pcc_mbox_chan->shmem = acpi_os_ioremap(pcc_mbox_chan->shmem_base_addr,
424 pcc_mbox_chan->shmem_size);
425 if (!pcc_mbox_chan->shmem)
426 return -ENXIO;
427
428 return 0;
429 }
430 EXPORT_SYMBOL_GPL(pcc_mbox_ioremap);
431
432 /**
433 * pcc_send_data - Called from Mailbox Controller code. Used
434 * here only to ring the channel doorbell. The PCC client
435 * specific read/write is done in the client driver in
436 * order to maintain atomicity over PCC channel once
437 * OS has control over it. See above for flow of operations.
438 * @chan: Pointer to Mailbox channel over which to send data.
439 * @data: Client specific data written over channel. Used here
440 * only for debug after PCC transaction completes.
441 *
442 * Return: Err if something failed else 0 for success.
443 */
pcc_send_data(struct mbox_chan * chan,void * data)444 static int pcc_send_data(struct mbox_chan *chan, void *data)
445 {
446 int ret;
447 struct pcc_chan_info *pchan = chan->con_priv;
448
449 ret = pcc_chan_reg_read_modify_write(&pchan->cmd_update);
450 if (ret)
451 return ret;
452
453 ret = pcc_chan_reg_read_modify_write(&pchan->db);
454 if (!ret && pchan->plat_irq > 0)
455 pchan->chan_in_use = true;
456
457 return ret;
458 }
459
460 /**
461 * pcc_startup - Called from Mailbox Controller code. Used here
462 * to request the interrupt.
463 * @chan: Pointer to Mailbox channel to startup.
464 *
465 * Return: Err if something failed else 0 for success.
466 */
pcc_startup(struct mbox_chan * chan)467 static int pcc_startup(struct mbox_chan *chan)
468 {
469 struct pcc_chan_info *pchan = chan->con_priv;
470 unsigned long irqflags;
471 int rc;
472
473 if (pchan->plat_irq > 0) {
474 irqflags = pcc_chan_plat_irq_can_be_shared(pchan) ?
475 IRQF_SHARED | IRQF_ONESHOT : 0;
476 rc = devm_request_irq(chan->mbox->dev, pchan->plat_irq, pcc_mbox_irq,
477 irqflags, MBOX_IRQ_NAME, chan);
478 if (unlikely(rc)) {
479 dev_err(chan->mbox->dev, "failed to register PCC interrupt %d\n",
480 pchan->plat_irq);
481 return rc;
482 }
483 }
484
485 return 0;
486 }
487
488 /**
489 * pcc_shutdown - Called from Mailbox Controller code. Used here
490 * to free the interrupt.
491 * @chan: Pointer to Mailbox channel to shutdown.
492 */
pcc_shutdown(struct mbox_chan * chan)493 static void pcc_shutdown(struct mbox_chan *chan)
494 {
495 struct pcc_chan_info *pchan = chan->con_priv;
496
497 if (pchan->plat_irq > 0)
498 devm_free_irq(chan->mbox->dev, pchan->plat_irq, chan);
499 }
500
501 static const struct mbox_chan_ops pcc_chan_ops = {
502 .send_data = pcc_send_data,
503 .startup = pcc_startup,
504 .shutdown = pcc_shutdown,
505 };
506
507 /**
508 * parse_pcc_subspace - Count PCC subspaces defined
509 * @header: Pointer to the ACPI subtable header under the PCCT.
510 * @end: End of subtable entry.
511 *
512 * Return: If we find a PCC subspace entry of a valid type, return 0.
513 * Otherwise, return -EINVAL.
514 *
515 * This gets called for each entry in the PCC table.
516 */
parse_pcc_subspace(union acpi_subtable_headers * header,const unsigned long end)517 static int parse_pcc_subspace(union acpi_subtable_headers *header,
518 const unsigned long end)
519 {
520 struct acpi_pcct_subspace *ss = (struct acpi_pcct_subspace *) header;
521
522 if (ss->header.type < ACPI_PCCT_TYPE_RESERVED)
523 return 0;
524
525 return -EINVAL;
526 }
527
528 static int
pcc_chan_reg_init(struct pcc_chan_reg * reg,struct acpi_generic_address * gas,u64 preserve_mask,u64 set_mask,u64 status_mask,char * name)529 pcc_chan_reg_init(struct pcc_chan_reg *reg, struct acpi_generic_address *gas,
530 u64 preserve_mask, u64 set_mask, u64 status_mask, char *name)
531 {
532 if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
533 if (!(gas->bit_width >= 8 && gas->bit_width <= 64 &&
534 is_power_of_2(gas->bit_width))) {
535 pr_err("Error: Cannot access register of %u bit width",
536 gas->bit_width);
537 return -EFAULT;
538 }
539
540 reg->vaddr = acpi_os_ioremap(gas->address, gas->bit_width / 8);
541 if (!reg->vaddr) {
542 pr_err("Failed to ioremap PCC %s register\n", name);
543 return -ENOMEM;
544 }
545 }
546 reg->gas = gas;
547 reg->preserve_mask = preserve_mask;
548 reg->set_mask = set_mask;
549 reg->status_mask = status_mask;
550 return 0;
551 }
552
553 /**
554 * pcc_parse_subspace_irq - Parse the PCC IRQ and PCC ACK register
555 *
556 * @pchan: Pointer to the PCC channel info structure.
557 * @pcct_entry: Pointer to the ACPI subtable header.
558 *
559 * Return: 0 for Success, else errno.
560 *
561 * There should be one entry per PCC channel. This gets called for each
562 * entry in the PCC table. This uses PCCY Type1 structure for all applicable
563 * types(Type 1-4) to fetch irq
564 */
pcc_parse_subspace_irq(struct pcc_chan_info * pchan,struct acpi_subtable_header * pcct_entry)565 static int pcc_parse_subspace_irq(struct pcc_chan_info *pchan,
566 struct acpi_subtable_header *pcct_entry)
567 {
568 int ret = 0;
569 struct acpi_pcct_hw_reduced *pcct_ss;
570
571 if (pcct_entry->type < ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE ||
572 pcct_entry->type > ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE)
573 return 0;
574
575 pcct_ss = (struct acpi_pcct_hw_reduced *)pcct_entry;
576 pchan->plat_irq = pcc_map_interrupt(pcct_ss->platform_interrupt,
577 (u32)pcct_ss->flags);
578 if (pchan->plat_irq <= 0) {
579 pr_err("PCC GSI %d not registered\n",
580 pcct_ss->platform_interrupt);
581 return -EINVAL;
582 }
583 pchan->plat_irq_flags = pcct_ss->flags;
584
585 if (pcct_ss->header.type == ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2) {
586 struct acpi_pcct_hw_reduced_type2 *pcct2_ss = (void *)pcct_ss;
587
588 ret = pcc_chan_reg_init(&pchan->plat_irq_ack,
589 &pcct2_ss->platform_ack_register,
590 pcct2_ss->ack_preserve_mask,
591 pcct2_ss->ack_write_mask, 0,
592 "PLAT IRQ ACK");
593
594 } else if (pcct_ss->header.type == ACPI_PCCT_TYPE_EXT_PCC_MASTER_SUBSPACE ||
595 pcct_ss->header.type == ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE) {
596 struct acpi_pcct_ext_pcc_master *pcct_ext = (void *)pcct_ss;
597
598 ret = pcc_chan_reg_init(&pchan->plat_irq_ack,
599 &pcct_ext->platform_ack_register,
600 pcct_ext->ack_preserve_mask,
601 pcct_ext->ack_set_mask, 0,
602 "PLAT IRQ ACK");
603 }
604
605 if (pcc_chan_plat_irq_can_be_shared(pchan) &&
606 !pchan->plat_irq_ack.gas) {
607 pr_err("PCC subspace has level IRQ with no ACK register\n");
608 return -EINVAL;
609 }
610
611 return ret;
612 }
613
614 /**
615 * pcc_parse_subspace_db_reg - Parse the PCC doorbell register
616 *
617 * @pchan: Pointer to the PCC channel info structure.
618 * @pcct_entry: Pointer to the ACPI subtable header.
619 *
620 * Return: 0 for Success, else errno.
621 */
pcc_parse_subspace_db_reg(struct pcc_chan_info * pchan,struct acpi_subtable_header * pcct_entry)622 static int pcc_parse_subspace_db_reg(struct pcc_chan_info *pchan,
623 struct acpi_subtable_header *pcct_entry)
624 {
625 int ret = 0;
626
627 if (pcct_entry->type <= ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2) {
628 struct acpi_pcct_subspace *pcct_ss;
629
630 pcct_ss = (struct acpi_pcct_subspace *)pcct_entry;
631
632 ret = pcc_chan_reg_init(&pchan->db,
633 &pcct_ss->doorbell_register,
634 pcct_ss->preserve_mask,
635 pcct_ss->write_mask, 0, "Doorbell");
636
637 } else {
638 struct acpi_pcct_ext_pcc_master *pcct_ext;
639
640 pcct_ext = (struct acpi_pcct_ext_pcc_master *)pcct_entry;
641
642 ret = pcc_chan_reg_init(&pchan->db,
643 &pcct_ext->doorbell_register,
644 pcct_ext->preserve_mask,
645 pcct_ext->write_mask, 0, "Doorbell");
646 if (ret)
647 return ret;
648
649 ret = pcc_chan_reg_init(&pchan->cmd_complete,
650 &pcct_ext->cmd_complete_register,
651 0, 0, pcct_ext->cmd_complete_mask,
652 "Command Complete Check");
653 if (ret)
654 return ret;
655
656 ret = pcc_chan_reg_init(&pchan->cmd_update,
657 &pcct_ext->cmd_update_register,
658 pcct_ext->cmd_update_preserve_mask,
659 pcct_ext->cmd_update_set_mask, 0,
660 "Command Complete Update");
661 if (ret)
662 return ret;
663
664 ret = pcc_chan_reg_init(&pchan->error,
665 &pcct_ext->error_status_register,
666 0, 0, pcct_ext->error_status_mask,
667 "Error Status");
668 }
669 return ret;
670 }
671
672 /**
673 * pcc_parse_subspace_shmem - Parse the PCC Shared Memory Region information
674 *
675 * @pchan: Pointer to the PCC channel info structure.
676 * @pcct_entry: Pointer to the ACPI subtable header.
677 *
678 */
pcc_parse_subspace_shmem(struct pcc_chan_info * pchan,struct acpi_subtable_header * pcct_entry)679 static void pcc_parse_subspace_shmem(struct pcc_chan_info *pchan,
680 struct acpi_subtable_header *pcct_entry)
681 {
682 if (pcct_entry->type <= ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2) {
683 struct acpi_pcct_subspace *pcct_ss =
684 (struct acpi_pcct_subspace *)pcct_entry;
685
686 pchan->chan.shmem_base_addr = pcct_ss->base_address;
687 pchan->chan.shmem_size = pcct_ss->length;
688 pchan->chan.latency = pcct_ss->latency;
689 pchan->chan.max_access_rate = pcct_ss->max_access_rate;
690 pchan->chan.min_turnaround_time = pcct_ss->min_turnaround_time;
691 } else {
692 struct acpi_pcct_ext_pcc_master *pcct_ext =
693 (struct acpi_pcct_ext_pcc_master *)pcct_entry;
694
695 pchan->chan.shmem_base_addr = pcct_ext->base_address;
696 pchan->chan.shmem_size = pcct_ext->length;
697 pchan->chan.latency = pcct_ext->latency;
698 pchan->chan.max_access_rate = pcct_ext->max_access_rate;
699 pchan->chan.min_turnaround_time = pcct_ext->min_turnaround_time;
700 }
701 }
702
703 /**
704 * acpi_pcc_probe - Parse the ACPI tree for the PCCT.
705 *
706 * Return: 0 for Success, else errno.
707 */
acpi_pcc_probe(void)708 static int __init acpi_pcc_probe(void)
709 {
710 int count, i, rc = 0;
711 acpi_status status;
712 struct acpi_table_header *pcct_tbl;
713 struct acpi_subtable_proc proc[ACPI_PCCT_TYPE_RESERVED];
714
715 status = acpi_get_table(ACPI_SIG_PCCT, 0, &pcct_tbl);
716 if (ACPI_FAILURE(status) || !pcct_tbl)
717 return -ENODEV;
718
719 /* Set up the subtable handlers */
720 for (i = ACPI_PCCT_TYPE_GENERIC_SUBSPACE;
721 i < ACPI_PCCT_TYPE_RESERVED; i++) {
722 proc[i].id = i;
723 proc[i].count = 0;
724 proc[i].handler = parse_pcc_subspace;
725 }
726
727 count = acpi_table_parse_entries_array(ACPI_SIG_PCCT,
728 sizeof(struct acpi_table_pcct), proc,
729 ACPI_PCCT_TYPE_RESERVED, MAX_PCC_SUBSPACES);
730 if (count <= 0 || count > MAX_PCC_SUBSPACES) {
731 if (count < 0)
732 pr_warn("Error parsing PCC subspaces from PCCT\n");
733 else
734 pr_warn("Invalid PCCT: %d PCC subspaces\n", count);
735
736 rc = -EINVAL;
737 } else {
738 pcc_chan_count = count;
739 }
740
741 acpi_put_table(pcct_tbl);
742
743 return rc;
744 }
745
746 /**
747 * pcc_mbox_probe - Called when we find a match for the
748 * PCCT platform device. This is purely used to represent
749 * the PCCT as a virtual device for registering with the
750 * generic Mailbox framework.
751 *
752 * @pdev: Pointer to platform device returned when a match
753 * is found.
754 *
755 * Return: 0 for Success, else errno.
756 */
pcc_mbox_probe(struct platform_device * pdev)757 static int pcc_mbox_probe(struct platform_device *pdev)
758 {
759 struct device *dev = &pdev->dev;
760 struct mbox_controller *pcc_mbox_ctrl;
761 struct mbox_chan *pcc_mbox_channels;
762 struct acpi_table_header *pcct_tbl;
763 struct acpi_subtable_header *pcct_entry;
764 struct acpi_table_pcct *acpi_pcct_tbl;
765 acpi_status status = AE_OK;
766 int i, rc, count = pcc_chan_count;
767
768 /* Search for PCCT */
769 status = acpi_get_table(ACPI_SIG_PCCT, 0, &pcct_tbl);
770
771 if (ACPI_FAILURE(status) || !pcct_tbl)
772 return -ENODEV;
773
774 pcc_mbox_channels = devm_kcalloc(dev, count, sizeof(*pcc_mbox_channels),
775 GFP_KERNEL);
776 if (!pcc_mbox_channels) {
777 rc = -ENOMEM;
778 goto err;
779 }
780
781 chan_info = devm_kcalloc(dev, count, sizeof(*chan_info), GFP_KERNEL);
782 if (!chan_info) {
783 rc = -ENOMEM;
784 goto err;
785 }
786
787 pcc_mbox_ctrl = devm_kzalloc(dev, sizeof(*pcc_mbox_ctrl), GFP_KERNEL);
788 if (!pcc_mbox_ctrl) {
789 rc = -ENOMEM;
790 goto err;
791 }
792
793 /* Point to the first PCC subspace entry */
794 pcct_entry = (struct acpi_subtable_header *) (
795 (unsigned long) pcct_tbl + sizeof(struct acpi_table_pcct));
796
797 acpi_pcct_tbl = (struct acpi_table_pcct *) pcct_tbl;
798 if (acpi_pcct_tbl->flags & ACPI_PCCT_DOORBELL)
799 pcc_mbox_ctrl->txdone_irq = true;
800
801 for (i = 0; i < count; i++) {
802 struct pcc_chan_info *pchan = chan_info + i;
803
804 pcc_mbox_channels[i].con_priv = pchan;
805 pchan->chan.mchan = &pcc_mbox_channels[i];
806
807 if (pcct_entry->type == ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE &&
808 !pcc_mbox_ctrl->txdone_irq) {
809 pr_err("Platform Interrupt flag must be set to 1");
810 rc = -EINVAL;
811 goto err;
812 }
813
814 if (pcc_mbox_ctrl->txdone_irq) {
815 rc = pcc_parse_subspace_irq(pchan, pcct_entry);
816 if (rc < 0)
817 goto err;
818 }
819 rc = pcc_parse_subspace_db_reg(pchan, pcct_entry);
820 if (rc < 0)
821 goto err;
822
823 pcc_parse_subspace_shmem(pchan, pcct_entry);
824
825 pchan->type = pcct_entry->type;
826 pcct_entry = (struct acpi_subtable_header *)
827 ((unsigned long) pcct_entry + pcct_entry->length);
828 }
829
830 pcc_mbox_ctrl->num_chans = count;
831
832 pr_info("Detected %d PCC Subspaces\n", pcc_mbox_ctrl->num_chans);
833
834 pcc_mbox_ctrl->chans = pcc_mbox_channels;
835 pcc_mbox_ctrl->ops = &pcc_chan_ops;
836 pcc_mbox_ctrl->dev = dev;
837
838 pr_info("Registering PCC driver as Mailbox controller\n");
839 rc = mbox_controller_register(pcc_mbox_ctrl);
840 if (rc)
841 pr_err("Err registering PCC as Mailbox controller: %d\n", rc);
842 else
843 return 0;
844 err:
845 acpi_put_table(pcct_tbl);
846 return rc;
847 }
848
849 static struct platform_driver pcc_mbox_driver = {
850 .probe = pcc_mbox_probe,
851 .driver = {
852 .name = "PCCT",
853 },
854 };
855
pcc_init(void)856 static int __init pcc_init(void)
857 {
858 int ret;
859 struct platform_device *pcc_pdev;
860
861 if (acpi_disabled)
862 return -ENODEV;
863
864 /* Check if PCC support is available. */
865 ret = acpi_pcc_probe();
866
867 if (ret) {
868 pr_debug("ACPI PCC probe failed.\n");
869 return -ENODEV;
870 }
871
872 pcc_pdev = platform_create_bundle(&pcc_mbox_driver,
873 pcc_mbox_probe, NULL, 0, NULL, 0);
874
875 if (IS_ERR(pcc_pdev)) {
876 pr_debug("Err creating PCC platform bundle\n");
877 pcc_chan_count = 0;
878 return PTR_ERR(pcc_pdev);
879 }
880
881 return 0;
882 }
883
884 /*
885 * Make PCC init postcore so that users of this mailbox
886 * such as the ACPI Processor driver have it available
887 * at their init.
888 */
889 postcore_initcall(pcc_init);
890