0001
0002
0003
0004
0005
0006
0007
0008
0009
0010
0011
0012
0013
0014
0015
0016 #include <linux/delay.h>
0017 #include <linux/device.h>
0018 #include <linux/errno.h>
0019 #include <linux/init.h>
0020 #include <linux/interrupt.h>
0021 #include <linux/io.h>
0022 #include <linux/module.h>
0023 #include <linux/slab.h>
0024
0025 #include <asm/intel_scu_ipc.h>
0026
0027
0028 #define IPCMSG_PCNTRL 0xff
0029
0030
0031 #define IPC_CMD_PCNTRL_W 0
0032 #define IPC_CMD_PCNTRL_R 1
0033 #define IPC_CMD_PCNTRL_M 2
0034
0035
0036
0037
0038
0039
0040
0041
0042
0043
0044
0045
0046
0047
0048
0049
0050
0051
0052 #define IPC_WWBUF_SIZE 20
0053 #define IPC_RWBUF_SIZE 20
0054 #define IPC_IOC 0x100
0055
0056 struct intel_scu_ipc_dev {
0057 struct device dev;
0058 struct resource mem;
0059 struct module *owner;
0060 int irq;
0061 void __iomem *ipc_base;
0062 struct completion cmd_complete;
0063 };
0064
0065 #define IPC_STATUS 0x04
0066 #define IPC_STATUS_IRQ BIT(2)
0067 #define IPC_STATUS_ERR BIT(1)
0068 #define IPC_STATUS_BUSY BIT(0)
0069
0070
0071
0072
0073
0074 #define IPC_WRITE_BUFFER 0x80
0075 #define IPC_READ_BUFFER 0x90
0076
0077
0078 #define IPC_TIMEOUT (10 * HZ)
0079
0080 static struct intel_scu_ipc_dev *ipcdev;
0081 static DEFINE_MUTEX(ipclock);
0082
0083 static struct class intel_scu_ipc_class = {
0084 .name = "intel_scu_ipc",
0085 .owner = THIS_MODULE,
0086 };
0087
0088
0089
0090
0091
0092
0093
0094
0095
0096
0097
0098
0099
0100 struct intel_scu_ipc_dev *intel_scu_ipc_dev_get(void)
0101 {
0102 struct intel_scu_ipc_dev *scu = NULL;
0103
0104 mutex_lock(&ipclock);
0105 if (ipcdev) {
0106 get_device(&ipcdev->dev);
0107
0108
0109
0110
0111 if (!try_module_get(ipcdev->owner))
0112 put_device(&ipcdev->dev);
0113 else
0114 scu = ipcdev;
0115 }
0116
0117 mutex_unlock(&ipclock);
0118 return scu;
0119 }
0120 EXPORT_SYMBOL_GPL(intel_scu_ipc_dev_get);
0121
0122
0123
0124
0125
0126
0127
0128
0129
0130 void intel_scu_ipc_dev_put(struct intel_scu_ipc_dev *scu)
0131 {
0132 if (scu) {
0133 module_put(scu->owner);
0134 put_device(&scu->dev);
0135 }
0136 }
0137 EXPORT_SYMBOL_GPL(intel_scu_ipc_dev_put);
0138
0139 struct intel_scu_ipc_devres {
0140 struct intel_scu_ipc_dev *scu;
0141 };
0142
0143 static void devm_intel_scu_ipc_dev_release(struct device *dev, void *res)
0144 {
0145 struct intel_scu_ipc_devres *dr = res;
0146 struct intel_scu_ipc_dev *scu = dr->scu;
0147
0148 intel_scu_ipc_dev_put(scu);
0149 }
0150
0151
0152
0153
0154
0155
0156
0157
0158
0159
0160
0161
0162 struct intel_scu_ipc_dev *devm_intel_scu_ipc_dev_get(struct device *dev)
0163 {
0164 struct intel_scu_ipc_devres *dr;
0165 struct intel_scu_ipc_dev *scu;
0166
0167 dr = devres_alloc(devm_intel_scu_ipc_dev_release, sizeof(*dr), GFP_KERNEL);
0168 if (!dr)
0169 return NULL;
0170
0171 scu = intel_scu_ipc_dev_get();
0172 if (!scu) {
0173 devres_free(dr);
0174 return NULL;
0175 }
0176
0177 dr->scu = scu;
0178 devres_add(dev, dr);
0179
0180 return scu;
0181 }
0182 EXPORT_SYMBOL_GPL(devm_intel_scu_ipc_dev_get);
0183
0184
0185
0186
0187
0188
0189
0190
0191 static inline void ipc_command(struct intel_scu_ipc_dev *scu, u32 cmd)
0192 {
0193 reinit_completion(&scu->cmd_complete);
0194 writel(cmd | IPC_IOC, scu->ipc_base);
0195 }
0196
0197
0198
0199
0200
0201
0202
0203 static inline void ipc_data_writel(struct intel_scu_ipc_dev *scu, u32 data, u32 offset)
0204 {
0205 writel(data, scu->ipc_base + IPC_WRITE_BUFFER + offset);
0206 }
0207
0208
0209
0210
0211
0212
0213
0214
0215 static inline u8 ipc_read_status(struct intel_scu_ipc_dev *scu)
0216 {
0217 return __raw_readl(scu->ipc_base + IPC_STATUS);
0218 }
0219
0220
0221 static inline u8 ipc_data_readb(struct intel_scu_ipc_dev *scu, u32 offset)
0222 {
0223 return readb(scu->ipc_base + IPC_READ_BUFFER + offset);
0224 }
0225
0226
0227 static inline u32 ipc_data_readl(struct intel_scu_ipc_dev *scu, u32 offset)
0228 {
0229 return readl(scu->ipc_base + IPC_READ_BUFFER + offset);
0230 }
0231
0232
0233 static inline int busy_loop(struct intel_scu_ipc_dev *scu)
0234 {
0235 unsigned long end = jiffies + IPC_TIMEOUT;
0236
0237 do {
0238 u32 status;
0239
0240 status = ipc_read_status(scu);
0241 if (!(status & IPC_STATUS_BUSY))
0242 return (status & IPC_STATUS_ERR) ? -EIO : 0;
0243
0244 usleep_range(50, 100);
0245 } while (time_before(jiffies, end));
0246
0247 return -ETIMEDOUT;
0248 }
0249
0250
0251 static inline int ipc_wait_for_interrupt(struct intel_scu_ipc_dev *scu)
0252 {
0253 int status;
0254
0255 if (!wait_for_completion_timeout(&scu->cmd_complete, IPC_TIMEOUT))
0256 return -ETIMEDOUT;
0257
0258 status = ipc_read_status(scu);
0259 if (status & IPC_STATUS_ERR)
0260 return -EIO;
0261
0262 return 0;
0263 }
0264
0265 static int intel_scu_ipc_check_status(struct intel_scu_ipc_dev *scu)
0266 {
0267 return scu->irq > 0 ? ipc_wait_for_interrupt(scu) : busy_loop(scu);
0268 }
0269
0270
0271 static int pwr_reg_rdwr(struct intel_scu_ipc_dev *scu, u16 *addr, u8 *data,
0272 u32 count, u32 op, u32 id)
0273 {
0274 int nc;
0275 u32 offset = 0;
0276 int err;
0277 u8 cbuf[IPC_WWBUF_SIZE];
0278 u32 *wbuf = (u32 *)&cbuf;
0279
0280 memset(cbuf, 0, sizeof(cbuf));
0281
0282 mutex_lock(&ipclock);
0283 if (!scu)
0284 scu = ipcdev;
0285 if (!scu) {
0286 mutex_unlock(&ipclock);
0287 return -ENODEV;
0288 }
0289
0290 for (nc = 0; nc < count; nc++, offset += 2) {
0291 cbuf[offset] = addr[nc];
0292 cbuf[offset + 1] = addr[nc] >> 8;
0293 }
0294
0295 if (id == IPC_CMD_PCNTRL_R) {
0296 for (nc = 0, offset = 0; nc < count; nc++, offset += 4)
0297 ipc_data_writel(scu, wbuf[nc], offset);
0298 ipc_command(scu, (count * 2) << 16 | id << 12 | 0 << 8 | op);
0299 } else if (id == IPC_CMD_PCNTRL_W) {
0300 for (nc = 0; nc < count; nc++, offset += 1)
0301 cbuf[offset] = data[nc];
0302 for (nc = 0, offset = 0; nc < count; nc++, offset += 4)
0303 ipc_data_writel(scu, wbuf[nc], offset);
0304 ipc_command(scu, (count * 3) << 16 | id << 12 | 0 << 8 | op);
0305 } else if (id == IPC_CMD_PCNTRL_M) {
0306 cbuf[offset] = data[0];
0307 cbuf[offset + 1] = data[1];
0308 ipc_data_writel(scu, wbuf[0], 0);
0309 ipc_command(scu, 4 << 16 | id << 12 | 0 << 8 | op);
0310 }
0311
0312 err = intel_scu_ipc_check_status(scu);
0313 if (!err && id == IPC_CMD_PCNTRL_R) {
0314
0315 memcpy_fromio(cbuf, scu->ipc_base + 0x90, 16);
0316 for (nc = 0; nc < count; nc++)
0317 data[nc] = ipc_data_readb(scu, nc);
0318 }
0319 mutex_unlock(&ipclock);
0320 return err;
0321 }
0322
0323
0324
0325
0326
0327
0328
0329
0330
0331
0332
0333
0334 int intel_scu_ipc_dev_ioread8(struct intel_scu_ipc_dev *scu, u16 addr, u8 *data)
0335 {
0336 return pwr_reg_rdwr(scu, &addr, data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R);
0337 }
0338 EXPORT_SYMBOL(intel_scu_ipc_dev_ioread8);
0339
0340
0341
0342
0343
0344
0345
0346
0347
0348
0349
0350
0351 int intel_scu_ipc_dev_iowrite8(struct intel_scu_ipc_dev *scu, u16 addr, u8 data)
0352 {
0353 return pwr_reg_rdwr(scu, &addr, &data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W);
0354 }
0355 EXPORT_SYMBOL(intel_scu_ipc_dev_iowrite8);
0356
0357
0358
0359
0360
0361
0362
0363
0364
0365
0366
0367
0368
0369
0370
0371 int intel_scu_ipc_dev_readv(struct intel_scu_ipc_dev *scu, u16 *addr, u8 *data,
0372 size_t len)
0373 {
0374 return pwr_reg_rdwr(scu, addr, data, len, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R);
0375 }
0376 EXPORT_SYMBOL(intel_scu_ipc_dev_readv);
0377
0378
0379
0380
0381
0382
0383
0384
0385
0386
0387
0388
0389
0390
0391
0392 int intel_scu_ipc_dev_writev(struct intel_scu_ipc_dev *scu, u16 *addr, u8 *data,
0393 size_t len)
0394 {
0395 return pwr_reg_rdwr(scu, addr, data, len, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W);
0396 }
0397 EXPORT_SYMBOL(intel_scu_ipc_dev_writev);
0398
0399
0400
0401
0402
0403
0404
0405
0406
0407
0408
0409
0410
0411
0412
0413
0414 int intel_scu_ipc_dev_update(struct intel_scu_ipc_dev *scu, u16 addr, u8 data,
0415 u8 mask)
0416 {
0417 u8 tmp[2] = { data, mask };
0418 return pwr_reg_rdwr(scu, &addr, tmp, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_M);
0419 }
0420 EXPORT_SYMBOL(intel_scu_ipc_dev_update);
0421
0422
0423
0424
0425
0426
0427
0428
0429
0430
0431
0432
0433
0434
0435 int intel_scu_ipc_dev_simple_command(struct intel_scu_ipc_dev *scu, int cmd,
0436 int sub)
0437 {
0438 u32 cmdval;
0439 int err;
0440
0441 mutex_lock(&ipclock);
0442 if (!scu)
0443 scu = ipcdev;
0444 if (!scu) {
0445 mutex_unlock(&ipclock);
0446 return -ENODEV;
0447 }
0448 scu = ipcdev;
0449 cmdval = sub << 12 | cmd;
0450 ipc_command(scu, cmdval);
0451 err = intel_scu_ipc_check_status(scu);
0452 mutex_unlock(&ipclock);
0453 if (err)
0454 dev_err(&scu->dev, "IPC command %#x failed with %d\n", cmdval, err);
0455 return err;
0456 }
0457 EXPORT_SYMBOL(intel_scu_ipc_dev_simple_command);
0458
0459
0460
0461
0462
0463
0464
0465
0466
0467
0468
0469
0470
0471
0472
0473
0474
0475 int intel_scu_ipc_dev_command_with_size(struct intel_scu_ipc_dev *scu, int cmd,
0476 int sub, const void *in, size_t inlen,
0477 size_t size, void *out, size_t outlen)
0478 {
0479 size_t outbuflen = DIV_ROUND_UP(outlen, sizeof(u32));
0480 size_t inbuflen = DIV_ROUND_UP(inlen, sizeof(u32));
0481 u32 cmdval, inbuf[4] = {};
0482 int i, err;
0483
0484 if (inbuflen > 4 || outbuflen > 4)
0485 return -EINVAL;
0486
0487 mutex_lock(&ipclock);
0488 if (!scu)
0489 scu = ipcdev;
0490 if (!scu) {
0491 mutex_unlock(&ipclock);
0492 return -ENODEV;
0493 }
0494
0495 memcpy(inbuf, in, inlen);
0496 for (i = 0; i < inbuflen; i++)
0497 ipc_data_writel(scu, inbuf[i], 4 * i);
0498
0499 cmdval = (size << 16) | (sub << 12) | cmd;
0500 ipc_command(scu, cmdval);
0501 err = intel_scu_ipc_check_status(scu);
0502
0503 if (!err) {
0504 u32 outbuf[4] = {};
0505
0506 for (i = 0; i < outbuflen; i++)
0507 outbuf[i] = ipc_data_readl(scu, 4 * i);
0508
0509 memcpy(out, outbuf, outlen);
0510 }
0511
0512 mutex_unlock(&ipclock);
0513 if (err)
0514 dev_err(&scu->dev, "IPC command %#x failed with %d\n", cmdval, err);
0515 return err;
0516 }
0517 EXPORT_SYMBOL(intel_scu_ipc_dev_command_with_size);
0518
0519
0520
0521
0522
0523
0524
0525
0526 static irqreturn_t ioc(int irq, void *dev_id)
0527 {
0528 struct intel_scu_ipc_dev *scu = dev_id;
0529 int status = ipc_read_status(scu);
0530
0531 writel(status | IPC_STATUS_IRQ, scu->ipc_base + IPC_STATUS);
0532 complete(&scu->cmd_complete);
0533
0534 return IRQ_HANDLED;
0535 }
0536
0537 static void intel_scu_ipc_release(struct device *dev)
0538 {
0539 struct intel_scu_ipc_dev *scu;
0540
0541 scu = container_of(dev, struct intel_scu_ipc_dev, dev);
0542 if (scu->irq > 0)
0543 free_irq(scu->irq, scu);
0544 iounmap(scu->ipc_base);
0545 release_mem_region(scu->mem.start, resource_size(&scu->mem));
0546 kfree(scu);
0547 }
0548
0549
0550
0551
0552
0553
0554
0555
0556
0557
0558
0559
0560 struct intel_scu_ipc_dev *
0561 __intel_scu_ipc_register(struct device *parent,
0562 const struct intel_scu_ipc_data *scu_data,
0563 struct module *owner)
0564 {
0565 int err;
0566 struct intel_scu_ipc_dev *scu;
0567 void __iomem *ipc_base;
0568
0569 mutex_lock(&ipclock);
0570
0571 if (ipcdev) {
0572 err = -EBUSY;
0573 goto err_unlock;
0574 }
0575
0576 scu = kzalloc(sizeof(*scu), GFP_KERNEL);
0577 if (!scu) {
0578 err = -ENOMEM;
0579 goto err_unlock;
0580 }
0581
0582 scu->owner = owner;
0583 scu->dev.parent = parent;
0584 scu->dev.class = &intel_scu_ipc_class;
0585 scu->dev.release = intel_scu_ipc_release;
0586 dev_set_name(&scu->dev, "intel_scu_ipc");
0587
0588 if (!request_mem_region(scu_data->mem.start, resource_size(&scu_data->mem),
0589 "intel_scu_ipc")) {
0590 err = -EBUSY;
0591 goto err_free;
0592 }
0593
0594 ipc_base = ioremap(scu_data->mem.start, resource_size(&scu_data->mem));
0595 if (!ipc_base) {
0596 err = -ENOMEM;
0597 goto err_release;
0598 }
0599
0600 scu->ipc_base = ipc_base;
0601 scu->mem = scu_data->mem;
0602 scu->irq = scu_data->irq;
0603 init_completion(&scu->cmd_complete);
0604
0605 if (scu->irq > 0) {
0606 err = request_irq(scu->irq, ioc, 0, "intel_scu_ipc", scu);
0607 if (err)
0608 goto err_unmap;
0609 }
0610
0611
0612
0613
0614
0615 err = device_register(&scu->dev);
0616 if (err) {
0617 put_device(&scu->dev);
0618 goto err_unlock;
0619 }
0620
0621
0622 ipcdev = scu;
0623 mutex_unlock(&ipclock);
0624
0625 return scu;
0626
0627 err_unmap:
0628 iounmap(ipc_base);
0629 err_release:
0630 release_mem_region(scu_data->mem.start, resource_size(&scu_data->mem));
0631 err_free:
0632 kfree(scu);
0633 err_unlock:
0634 mutex_unlock(&ipclock);
0635
0636 return ERR_PTR(err);
0637 }
0638 EXPORT_SYMBOL_GPL(__intel_scu_ipc_register);
0639
0640
0641
0642
0643
0644
0645
0646
0647 void intel_scu_ipc_unregister(struct intel_scu_ipc_dev *scu)
0648 {
0649 mutex_lock(&ipclock);
0650 if (!WARN_ON(!ipcdev)) {
0651 ipcdev = NULL;
0652 device_unregister(&scu->dev);
0653 }
0654 mutex_unlock(&ipclock);
0655 }
0656 EXPORT_SYMBOL_GPL(intel_scu_ipc_unregister);
0657
0658 static void devm_intel_scu_ipc_unregister(struct device *dev, void *res)
0659 {
0660 struct intel_scu_ipc_devres *dr = res;
0661 struct intel_scu_ipc_dev *scu = dr->scu;
0662
0663 intel_scu_ipc_unregister(scu);
0664 }
0665
0666
0667
0668
0669
0670
0671
0672
0673
0674
0675
0676
0677 struct intel_scu_ipc_dev *
0678 __devm_intel_scu_ipc_register(struct device *parent,
0679 const struct intel_scu_ipc_data *scu_data,
0680 struct module *owner)
0681 {
0682 struct intel_scu_ipc_devres *dr;
0683 struct intel_scu_ipc_dev *scu;
0684
0685 dr = devres_alloc(devm_intel_scu_ipc_unregister, sizeof(*dr), GFP_KERNEL);
0686 if (!dr)
0687 return NULL;
0688
0689 scu = __intel_scu_ipc_register(parent, scu_data, owner);
0690 if (IS_ERR(scu)) {
0691 devres_free(dr);
0692 return scu;
0693 }
0694
0695 dr->scu = scu;
0696 devres_add(parent, dr);
0697
0698 return scu;
0699 }
0700 EXPORT_SYMBOL_GPL(__devm_intel_scu_ipc_register);
0701
0702 static int __init intel_scu_ipc_init(void)
0703 {
0704 return class_register(&intel_scu_ipc_class);
0705 }
0706 subsys_initcall(intel_scu_ipc_init);
0707
0708 static void __exit intel_scu_ipc_exit(void)
0709 {
0710 class_unregister(&intel_scu_ipc_class);
0711 }
0712 module_exit(intel_scu_ipc_exit);