1 // SPDX-License-Identifier: GPL-2.0-only
3 * SCOM FSI Client device driver
5 * Copyright (C) IBM Corporation 2016
9 #include <linux/module.h>
10 #include <linux/cdev.h>
11 #include <linux/delay.h>
13 #include <linux/uaccess.h>
14 #include <linux/slab.h>
15 #include <linux/list.h>
17 #include <uapi/linux/fsi.h>
19 #define FSI_ENGID_SCOM 0x5
21 /* SCOM engine register set */
22 #define SCOM_DATA0_REG 0x00
23 #define SCOM_DATA1_REG 0x04
24 #define SCOM_CMD_REG 0x08
25 #define SCOM_FSI2PIB_RESET_REG 0x18
26 #define SCOM_STATUS_REG 0x1C /* Read */
27 #define SCOM_PIB_RESET_REG 0x1C /* Write */
29 /* Command register */
30 #define SCOM_WRITE_CMD 0x80000000
31 #define SCOM_READ_CMD 0x00000000
33 /* Status register bits */
34 #define SCOM_STATUS_ERR_SUMMARY 0x80000000
35 #define SCOM_STATUS_PROTECTION 0x01000000
36 #define SCOM_STATUS_PARITY 0x04000000
37 #define SCOM_STATUS_PIB_ABORT 0x00100000
38 #define SCOM_STATUS_PIB_RESP_MASK 0x00007000
39 #define SCOM_STATUS_PIB_RESP_SHIFT 12
41 #define SCOM_STATUS_ANY_ERR (SCOM_STATUS_PROTECTION | \
42 SCOM_STATUS_PARITY | \
43 SCOM_STATUS_PIB_ABORT | \
44 SCOM_STATUS_PIB_RESP_MASK)
45 /* SCOM address encodings */
46 #define XSCOM_ADDR_IND_FLAG BIT_ULL(63)
47 #define XSCOM_ADDR_INF_FORM1 BIT_ULL(60)
49 /* SCOM indirect stuff */
50 #define XSCOM_ADDR_DIRECT_PART 0x7fffffffull
51 #define XSCOM_ADDR_INDIRECT_PART 0x000fffff00000000ull
52 #define XSCOM_DATA_IND_READ BIT_ULL(63)
53 #define XSCOM_DATA_IND_COMPLETE BIT_ULL(31)
54 #define XSCOM_DATA_IND_ERR_MASK 0x70000000ull
55 #define XSCOM_DATA_IND_ERR_SHIFT 28
56 #define XSCOM_DATA_IND_DATA 0x0000ffffull
57 #define XSCOM_DATA_IND_FORM1_DATA 0x000fffffffffffffull
58 #define XSCOM_ADDR_FORM1_LOW 0x000ffffffffull
59 #define XSCOM_ADDR_FORM1_HI 0xfff00000000ull
60 #define XSCOM_ADDR_FORM1_HI_SHIFT 20
63 #define SCOM_MAX_RETRIES 100 /* Retries on busy */
64 #define SCOM_MAX_IND_RETRIES 10 /* Retries indirect not ready */
67 struct list_head link;
68 struct fsi_device *fsi_dev;
75 static int __put_scom(struct scom_device *scom_dev, uint64_t value,
76 uint32_t addr, uint32_t *status)
78 __be32 data, raw_status;
81 data = cpu_to_be32((value >> 32) & 0xffffffff);
82 rc = fsi_device_write(scom_dev->fsi_dev, SCOM_DATA0_REG, &data,
87 data = cpu_to_be32(value & 0xffffffff);
88 rc = fsi_device_write(scom_dev->fsi_dev, SCOM_DATA1_REG, &data,
93 data = cpu_to_be32(SCOM_WRITE_CMD | addr);
94 rc = fsi_device_write(scom_dev->fsi_dev, SCOM_CMD_REG, &data,
98 rc = fsi_device_read(scom_dev->fsi_dev, SCOM_STATUS_REG, &raw_status,
102 *status = be32_to_cpu(raw_status);
107 static int __get_scom(struct scom_device *scom_dev, uint64_t *value,
108 uint32_t addr, uint32_t *status)
110 __be32 data, raw_status;
115 data = cpu_to_be32(SCOM_READ_CMD | addr);
116 rc = fsi_device_write(scom_dev->fsi_dev, SCOM_CMD_REG, &data,
120 rc = fsi_device_read(scom_dev->fsi_dev, SCOM_STATUS_REG, &raw_status,
126 * Read the data registers even on error, so we don't have
127 * to interpret the status register here.
129 rc = fsi_device_read(scom_dev->fsi_dev, SCOM_DATA0_REG, &data,
133 *value |= (uint64_t)be32_to_cpu(data) << 32;
134 rc = fsi_device_read(scom_dev->fsi_dev, SCOM_DATA1_REG, &data,
138 *value |= be32_to_cpu(data);
139 *status = be32_to_cpu(raw_status);
144 static int put_indirect_scom_form0(struct scom_device *scom, uint64_t value,
145 uint64_t addr, uint32_t *status)
147 uint64_t ind_data, ind_addr;
148 int rc, retries, err = 0;
150 if (value & ~XSCOM_DATA_IND_DATA)
153 ind_addr = addr & XSCOM_ADDR_DIRECT_PART;
154 ind_data = (addr & XSCOM_ADDR_INDIRECT_PART) | value;
155 rc = __put_scom(scom, ind_data, ind_addr, status);
156 if (rc || (*status & SCOM_STATUS_ANY_ERR))
159 for (retries = 0; retries < SCOM_MAX_IND_RETRIES; retries++) {
160 rc = __get_scom(scom, &ind_data, addr, status);
161 if (rc || (*status & SCOM_STATUS_ANY_ERR))
164 err = (ind_data & XSCOM_DATA_IND_ERR_MASK) >> XSCOM_DATA_IND_ERR_SHIFT;
165 *status = err << SCOM_STATUS_PIB_RESP_SHIFT;
166 if ((ind_data & XSCOM_DATA_IND_COMPLETE) || (err != SCOM_PIB_BLOCKED))
174 static int put_indirect_scom_form1(struct scom_device *scom, uint64_t value,
175 uint64_t addr, uint32_t *status)
177 uint64_t ind_data, ind_addr;
179 if (value & ~XSCOM_DATA_IND_FORM1_DATA)
182 ind_addr = addr & XSCOM_ADDR_FORM1_LOW;
183 ind_data = value | (addr & XSCOM_ADDR_FORM1_HI) << XSCOM_ADDR_FORM1_HI_SHIFT;
184 return __put_scom(scom, ind_data, ind_addr, status);
187 static int get_indirect_scom_form0(struct scom_device *scom, uint64_t *value,
188 uint64_t addr, uint32_t *status)
190 uint64_t ind_data, ind_addr;
191 int rc, retries, err = 0;
193 ind_addr = addr & XSCOM_ADDR_DIRECT_PART;
194 ind_data = (addr & XSCOM_ADDR_INDIRECT_PART) | XSCOM_DATA_IND_READ;
195 rc = __put_scom(scom, ind_data, ind_addr, status);
196 if (rc || (*status & SCOM_STATUS_ANY_ERR))
199 for (retries = 0; retries < SCOM_MAX_IND_RETRIES; retries++) {
200 rc = __get_scom(scom, &ind_data, addr, status);
201 if (rc || (*status & SCOM_STATUS_ANY_ERR))
204 err = (ind_data & XSCOM_DATA_IND_ERR_MASK) >> XSCOM_DATA_IND_ERR_SHIFT;
205 *status = err << SCOM_STATUS_PIB_RESP_SHIFT;
206 *value = ind_data & XSCOM_DATA_IND_DATA;
208 if ((ind_data & XSCOM_DATA_IND_COMPLETE) || (err != SCOM_PIB_BLOCKED))
216 static int raw_put_scom(struct scom_device *scom, uint64_t value,
217 uint64_t addr, uint32_t *status)
219 if (addr & XSCOM_ADDR_IND_FLAG) {
220 if (addr & XSCOM_ADDR_INF_FORM1)
221 return put_indirect_scom_form1(scom, value, addr, status);
223 return put_indirect_scom_form0(scom, value, addr, status);
225 return __put_scom(scom, value, addr, status);
228 static int raw_get_scom(struct scom_device *scom, uint64_t *value,
229 uint64_t addr, uint32_t *status)
231 if (addr & XSCOM_ADDR_IND_FLAG) {
232 if (addr & XSCOM_ADDR_INF_FORM1)
234 return get_indirect_scom_form0(scom, value, addr, status);
236 return __get_scom(scom, value, addr, status);
239 static int handle_fsi2pib_status(struct scom_device *scom, uint32_t status)
243 if (status & SCOM_STATUS_PROTECTION)
245 if (status & SCOM_STATUS_PARITY) {
246 fsi_device_write(scom->fsi_dev, SCOM_FSI2PIB_RESET_REG, &dummy,
250 /* Return -EBUSY on PIB abort to force a retry */
251 if (status & SCOM_STATUS_PIB_ABORT)
256 static int handle_pib_status(struct scom_device *scom, uint8_t status)
260 if (status == SCOM_PIB_SUCCESS)
262 if (status == SCOM_PIB_BLOCKED)
265 /* Reset the bridge */
266 fsi_device_write(scom->fsi_dev, SCOM_FSI2PIB_RESET_REG, &dummy,
270 case SCOM_PIB_OFFLINE:
272 case SCOM_PIB_BAD_ADDR:
274 case SCOM_PIB_TIMEOUT:
276 case SCOM_PIB_PARTIAL:
277 case SCOM_PIB_CLK_ERR:
278 case SCOM_PIB_PARITY_ERR:
284 static int put_scom(struct scom_device *scom, uint64_t value,
287 uint32_t status, dummy = -1;
290 for (retries = 0; retries < SCOM_MAX_RETRIES; retries++) {
291 rc = raw_put_scom(scom, value, addr, &status);
293 /* Try resetting the bridge if FSI fails */
294 if (rc != -ENODEV && retries == 0) {
295 fsi_device_write(scom->fsi_dev, SCOM_FSI2PIB_RESET_REG,
296 &dummy, sizeof(uint32_t));
301 rc = handle_fsi2pib_status(scom, status);
302 if (rc && rc != -EBUSY)
305 rc = handle_pib_status(scom,
306 (status & SCOM_STATUS_PIB_RESP_MASK)
307 >> SCOM_STATUS_PIB_RESP_SHIFT);
308 if (rc && rc != -EBUSY)
318 static int get_scom(struct scom_device *scom, uint64_t *value,
321 uint32_t status, dummy = -1;
324 for (retries = 0; retries < SCOM_MAX_RETRIES; retries++) {
325 rc = raw_get_scom(scom, value, addr, &status);
327 /* Try resetting the bridge if FSI fails */
328 if (rc != -ENODEV && retries == 0) {
329 fsi_device_write(scom->fsi_dev, SCOM_FSI2PIB_RESET_REG,
330 &dummy, sizeof(uint32_t));
335 rc = handle_fsi2pib_status(scom, status);
336 if (rc && rc != -EBUSY)
339 rc = handle_pib_status(scom,
340 (status & SCOM_STATUS_PIB_RESP_MASK)
341 >> SCOM_STATUS_PIB_RESP_SHIFT);
342 if (rc && rc != -EBUSY)
352 static ssize_t scom_read(struct file *filep, char __user *buf, size_t len,
355 struct scom_device *scom = filep->private_data;
356 struct device *dev = &scom->fsi_dev->dev;
360 if (len != sizeof(uint64_t))
363 mutex_lock(&scom->lock);
367 rc = get_scom(scom, &val, *offset);
368 mutex_unlock(&scom->lock);
370 dev_dbg(dev, "get_scom fail:%d\n", rc);
374 rc = copy_to_user(buf, &val, len);
376 dev_dbg(dev, "copy to user failed:%d\n", rc);
378 return rc ? rc : len;
381 static ssize_t scom_write(struct file *filep, const char __user *buf,
382 size_t len, loff_t *offset)
385 struct scom_device *scom = filep->private_data;
386 struct device *dev = &scom->fsi_dev->dev;
389 if (len != sizeof(uint64_t))
392 rc = copy_from_user(&val, buf, len);
394 dev_dbg(dev, "copy from user failed:%d\n", rc);
398 mutex_lock(&scom->lock);
402 rc = put_scom(scom, val, *offset);
403 mutex_unlock(&scom->lock);
405 dev_dbg(dev, "put_scom failed with:%d\n", rc);
412 static loff_t scom_llseek(struct file *file, loff_t offset, int whence)
418 file->f_pos = offset;
427 static void raw_convert_status(struct scom_access *acc, uint32_t status)
429 acc->pib_status = (status & SCOM_STATUS_PIB_RESP_MASK) >>
430 SCOM_STATUS_PIB_RESP_SHIFT;
431 acc->intf_errors = 0;
433 if (status & SCOM_STATUS_PROTECTION)
434 acc->intf_errors |= SCOM_INTF_ERR_PROTECTION;
435 else if (status & SCOM_STATUS_PARITY)
436 acc->intf_errors |= SCOM_INTF_ERR_PARITY;
437 else if (status & SCOM_STATUS_PIB_ABORT)
438 acc->intf_errors |= SCOM_INTF_ERR_ABORT;
439 else if (status & SCOM_STATUS_ERR_SUMMARY)
440 acc->intf_errors |= SCOM_INTF_ERR_UNKNOWN;
443 static int scom_raw_read(struct scom_device *scom, void __user *argp)
445 struct scom_access acc;
449 if (copy_from_user(&acc, argp, sizeof(struct scom_access)))
452 rc = raw_get_scom(scom, &acc.data, acc.addr, &status);
455 raw_convert_status(&acc, status);
456 if (copy_to_user(argp, &acc, sizeof(struct scom_access)))
461 static int scom_raw_write(struct scom_device *scom, void __user *argp)
463 u64 prev_data, mask, data;
464 struct scom_access acc;
468 if (copy_from_user(&acc, argp, sizeof(struct scom_access)))
472 rc = raw_get_scom(scom, &prev_data, acc.addr, &status);
475 if (status & SCOM_STATUS_ANY_ERR)
479 prev_data = mask = -1ull;
481 data = (prev_data & ~mask) | (acc.data & mask);
482 rc = raw_put_scom(scom, data, acc.addr, &status);
486 raw_convert_status(&acc, status);
487 if (copy_to_user(argp, &acc, sizeof(struct scom_access)))
492 static int scom_reset(struct scom_device *scom, void __user *argp)
494 uint32_t flags, dummy = -1;
497 if (get_user(flags, (__u32 __user *)argp))
499 if (flags & SCOM_RESET_PIB)
500 rc = fsi_device_write(scom->fsi_dev, SCOM_PIB_RESET_REG, &dummy,
502 if (!rc && (flags & (SCOM_RESET_PIB | SCOM_RESET_INTF)))
503 rc = fsi_device_write(scom->fsi_dev, SCOM_FSI2PIB_RESET_REG, &dummy,
508 static int scom_check(struct scom_device *scom, void __user *argp)
510 /* Still need to find out how to get "protected" */
511 return put_user(SCOM_CHECK_SUPPORTED, (__u32 __user *)argp);
514 static long scom_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
516 struct scom_device *scom = file->private_data;
517 void __user *argp = (void __user *)arg;
520 mutex_lock(&scom->lock);
522 mutex_unlock(&scom->lock);
527 rc = scom_check(scom, argp);
530 rc = scom_raw_read(scom, argp);
533 rc = scom_raw_write(scom, argp);
536 rc = scom_reset(scom, argp);
539 mutex_unlock(&scom->lock);
543 static int scom_open(struct inode *inode, struct file *file)
545 struct scom_device *scom = container_of(inode->i_cdev, struct scom_device, cdev);
547 file->private_data = scom;
552 static const struct file_operations scom_fops = {
553 .owner = THIS_MODULE,
555 .llseek = scom_llseek,
558 .unlocked_ioctl = scom_ioctl,
561 static void scom_free(struct device *dev)
563 struct scom_device *scom = container_of(dev, struct scom_device, dev);
565 put_device(&scom->fsi_dev->dev);
569 static int scom_probe(struct device *dev)
571 struct fsi_device *fsi_dev = to_fsi_dev(dev);
572 struct scom_device *scom;
575 scom = kzalloc(sizeof(*scom), GFP_KERNEL);
578 dev_set_drvdata(dev, scom);
579 mutex_init(&scom->lock);
581 /* Grab a reference to the device (parent of our cdev), we'll drop it later */
582 if (!get_device(dev)) {
586 scom->fsi_dev = fsi_dev;
588 /* Create chardev for userspace access */
589 scom->dev.type = &fsi_cdev_type;
590 scom->dev.parent = dev;
591 scom->dev.release = scom_free;
592 device_initialize(&scom->dev);
594 /* Allocate a minor in the FSI space */
595 rc = fsi_get_new_minor(fsi_dev, fsi_dev_scom, &scom->dev.devt, &didx);
599 dev_set_name(&scom->dev, "scom%d", didx);
600 cdev_init(&scom->cdev, &scom_fops);
601 rc = cdev_device_add(&scom->cdev, &scom->dev);
603 dev_err(dev, "Error %d creating char device %s\n",
604 rc, dev_name(&scom->dev));
610 fsi_free_minor(scom->dev.devt);
612 put_device(&scom->dev);
616 static int scom_remove(struct device *dev)
618 struct scom_device *scom = dev_get_drvdata(dev);
620 mutex_lock(&scom->lock);
622 mutex_unlock(&scom->lock);
623 cdev_device_del(&scom->cdev, &scom->dev);
624 fsi_free_minor(scom->dev.devt);
625 put_device(&scom->dev);
630 static const struct fsi_device_id scom_ids[] = {
632 .engine_type = FSI_ENGID_SCOM,
633 .version = FSI_VERSION_ANY,
638 static struct fsi_driver scom_drv = {
639 .id_table = scom_ids,
642 .bus = &fsi_bus_type,
644 .remove = scom_remove,
648 static int scom_init(void)
650 return fsi_driver_register(&scom_drv);
653 static void scom_exit(void)
655 fsi_driver_unregister(&scom_drv);
658 module_init(scom_init);
659 module_exit(scom_exit);
660 MODULE_LICENSE("GPL");