1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/device.h>
5 #include <linux/errno.h>
7 #include <linux/fsi-sbefifo.h>
10 #include <linux/kernel.h>
11 #include <linux/list.h>
12 #include <linux/miscdevice.h>
14 #include <linux/module.h>
15 #include <linux/mutex.h>
16 #include <linux/fsi-occ.h>
18 #include <linux/of_device.h>
19 #include <linux/platform_device.h>
20 #include <linux/sched.h>
21 #include <linux/slab.h>
22 #include <linux/uaccess.h>
23 #include <asm/unaligned.h>
25 #define OCC_SRAM_BYTES 4096
26 #define OCC_CMD_DATA_BYTES 4090
27 #define OCC_RESP_DATA_BYTES 4089
29 #define OCC_P9_SRAM_CMD_ADDR 0xFFFBE000
30 #define OCC_P9_SRAM_RSP_ADDR 0xFFFBF000
32 #define OCC_P10_SRAM_CMD_ADDR 0xFFFFD000
33 #define OCC_P10_SRAM_RSP_ADDR 0xFFFFE000
35 #define OCC_P10_SRAM_MODE 0x58 /* Normal mode, OCB channel 2 */
37 #define OCC_TIMEOUT_MS 1000
38 #define OCC_CMD_IN_PRG_WAIT_MS 50
40 enum versions { occ_p9, occ_p10 };
44 struct device *sbefifo;
51 size_t client_buffer_size;
52 size_t client_response_size;
53 enum versions version;
54 struct miscdevice mdev;
55 struct mutex occ_lock;
58 #define to_occ(x) container_of((x), struct occ, mdev)
65 u8 data[OCC_RESP_DATA_BYTES + 2]; /* two bytes checksum */
76 #define to_client(x) container_of((x), struct occ_client, xfr)
78 static DEFINE_IDA(occ_ida);
80 static int occ_open(struct inode *inode, struct file *file)
82 struct occ_client *client = kzalloc(sizeof(*client), GFP_KERNEL);
83 struct miscdevice *mdev = file->private_data;
84 struct occ *occ = to_occ(mdev);
89 client->buffer = (u8 *)__get_free_page(GFP_KERNEL);
90 if (!client->buffer) {
96 mutex_init(&client->lock);
97 file->private_data = client;
100 /* We allocate a 1-page buffer, make sure it all fits */
101 BUILD_BUG_ON((OCC_CMD_DATA_BYTES + 3) > PAGE_SIZE);
102 BUILD_BUG_ON((OCC_RESP_DATA_BYTES + 7) > PAGE_SIZE);
107 static ssize_t occ_read(struct file *file, char __user *buf, size_t len,
110 struct occ_client *client = file->private_data;
116 if (len > OCC_SRAM_BYTES)
119 mutex_lock(&client->lock);
121 /* This should not be possible ... */
122 if (WARN_ON_ONCE(client->read_offset > client->data_size)) {
127 /* Grab how much data we have to read */
128 rc = min(len, client->data_size - client->read_offset);
129 if (copy_to_user(buf, client->buffer + client->read_offset, rc))
132 client->read_offset += rc;
135 mutex_unlock(&client->lock);
140 static ssize_t occ_write(struct file *file, const char __user *buf,
141 size_t len, loff_t *offset)
143 struct occ_client *client = file->private_data;
144 size_t rlen, data_length;
151 if (len > (OCC_CMD_DATA_BYTES + 3) || len < 3)
154 mutex_lock(&client->lock);
156 /* Construct the command */
157 cmd = client->buffer;
160 * Copy the user command (assume user data follows the occ command
162 * byte 0: command type
163 * bytes 1-2: data length (msb first)
166 if (copy_from_user(&cmd[1], buf, len)) {
171 /* Extract data length */
172 data_length = (cmd[2] << 8) + cmd[3];
173 if (data_length > OCC_CMD_DATA_BYTES) {
178 /* Submit command; 4 bytes before the data and 2 bytes after */
180 rc = fsi_occ_submit(client->occ->dev, cmd, data_length + 6, cmd,
185 /* Set read tracking data */
186 client->data_size = rlen;
187 client->read_offset = 0;
193 mutex_unlock(&client->lock);
198 static int occ_release(struct inode *inode, struct file *file)
200 struct occ_client *client = file->private_data;
202 put_device(client->occ->dev);
203 free_page((unsigned long)client->buffer);
209 static const struct file_operations occ_fops = {
210 .owner = THIS_MODULE,
214 .release = occ_release,
217 static void occ_save_ffdc(struct occ *occ, __be32 *resp, size_t parsed_len,
220 if (resp_len > parsed_len) {
221 size_t dh = resp_len - parsed_len;
222 size_t ffdc_len = (dh - 1) * 4; /* SBE words are four bytes */
223 __be32 *ffdc = &resp[parsed_len];
225 if (ffdc_len > occ->client_buffer_size)
226 ffdc_len = occ->client_buffer_size;
228 memcpy(occ->client_buffer, ffdc, ffdc_len);
229 occ->client_response_size = ffdc_len;
233 static int occ_verify_checksum(struct occ *occ, struct occ_response *resp,
236 /* Fetch the two bytes after the data for the checksum. */
237 u16 checksum_resp = get_unaligned_be16(&resp->data[data_length]);
241 checksum = resp->seq_no;
242 checksum += resp->cmd_type;
243 checksum += resp->return_status;
244 checksum += (data_length >> 8) + (data_length & 0xFF);
246 for (i = 0; i < data_length; ++i)
247 checksum += resp->data[i];
249 if (checksum != checksum_resp) {
250 dev_err(occ->dev, "Bad checksum: %04x!=%04x\n", checksum,
258 static int occ_getsram(struct occ *occ, u32 offset, void *data, ssize_t len)
260 u32 data_len = ((len + 7) / 8) * 8; /* must be multiples of 8 B */
261 size_t cmd_len, parsed_len, resp_data_len;
262 size_t resp_len = OCC_MAX_RESP_WORDS;
263 __be32 *resp = occ->buffer;
268 * Magic sequence to do SBE getsram command. SBE will fetch data from
269 * specified SRAM address.
271 switch (occ->version) {
275 cmd[2] = cpu_to_be32(1); /* Normal mode */
276 cmd[3] = cpu_to_be32(OCC_P9_SRAM_RSP_ADDR + offset);
281 cmd[2] = cpu_to_be32(OCC_P10_SRAM_MODE);
283 cmd[4] = cpu_to_be32(OCC_P10_SRAM_RSP_ADDR + offset);
287 cmd[0] = cpu_to_be32(cmd_len);
288 cmd[1] = cpu_to_be32(SBEFIFO_CMD_GET_OCC_SRAM);
289 cmd[4 + idx] = cpu_to_be32(data_len);
291 rc = sbefifo_submit(occ->sbefifo, cmd, cmd_len, resp, &resp_len);
295 rc = sbefifo_parse_status(occ->sbefifo, SBEFIFO_CMD_GET_OCC_SRAM,
296 resp, resp_len, &parsed_len);
298 dev_err(occ->dev, "SRAM read returned failure status: %08x\n",
300 occ_save_ffdc(occ, resp, parsed_len, resp_len);
306 resp_data_len = be32_to_cpu(resp[parsed_len - 1]);
307 if (resp_data_len != data_len) {
308 dev_err(occ->dev, "SRAM read expected %d bytes got %zd\n",
309 data_len, resp_data_len);
312 memcpy(data, resp, len);
318 static int occ_putsram(struct occ *occ, const void *data, ssize_t len,
319 u8 seq_no, u16 checksum)
321 u32 data_len = ((len + 7) / 8) * 8; /* must be multiples of 8 B */
322 size_t cmd_len, parsed_len, resp_data_len;
323 size_t resp_len = OCC_MAX_RESP_WORDS;
324 __be32 *buf = occ->buffer;
328 cmd_len = (occ->version == occ_p10) ? 6 : 5;
329 cmd_len += data_len >> 2;
332 * Magic sequence to do SBE putsram command. SBE will transfer
333 * data to specified SRAM address.
335 buf[0] = cpu_to_be32(cmd_len);
336 buf[1] = cpu_to_be32(SBEFIFO_CMD_PUT_OCC_SRAM);
338 switch (occ->version) {
341 buf[2] = cpu_to_be32(1); /* Normal mode */
342 buf[3] = cpu_to_be32(OCC_P9_SRAM_CMD_ADDR);
346 buf[2] = cpu_to_be32(OCC_P10_SRAM_MODE);
348 buf[4] = cpu_to_be32(OCC_P10_SRAM_CMD_ADDR);
352 buf[4 + idx] = cpu_to_be32(data_len);
353 memcpy(&buf[5 + idx], data, len);
355 byte_buf = (u8 *)&buf[5 + idx];
357 * Overwrite the first byte with our sequence number and the last two
358 * bytes with the checksum.
360 byte_buf[0] = seq_no;
361 byte_buf[len - 2] = checksum >> 8;
362 byte_buf[len - 1] = checksum & 0xff;
364 rc = sbefifo_submit(occ->sbefifo, buf, cmd_len, buf, &resp_len);
368 rc = sbefifo_parse_status(occ->sbefifo, SBEFIFO_CMD_PUT_OCC_SRAM,
369 buf, resp_len, &parsed_len);
371 dev_err(occ->dev, "SRAM write returned failure status: %08x\n",
373 occ_save_ffdc(occ, buf, parsed_len, resp_len);
379 if (parsed_len != 1) {
380 dev_err(occ->dev, "SRAM write response length invalid: %zd\n",
384 resp_data_len = be32_to_cpu(buf[0]);
385 if (resp_data_len != data_len) {
387 "SRAM write expected %d bytes got %zd\n",
388 data_len, resp_data_len);
396 static int occ_trigger_attn(struct occ *occ)
398 __be32 *buf = occ->buffer;
399 size_t cmd_len, parsed_len, resp_data_len;
400 size_t resp_len = OCC_MAX_RESP_WORDS;
403 switch (occ->version) {
407 buf[2] = cpu_to_be32(3); /* Circular mode */
413 buf[2] = cpu_to_be32(0xd0); /* Circular mode, OCB Channel 1 */
419 buf[0] = cpu_to_be32(cmd_len); /* Chip-op length in words */
420 buf[1] = cpu_to_be32(SBEFIFO_CMD_PUT_OCC_SRAM);
421 buf[4 + idx] = cpu_to_be32(8); /* Data length in bytes */
422 buf[5 + idx] = cpu_to_be32(0x20010000); /* Trigger OCC attention */
425 rc = sbefifo_submit(occ->sbefifo, buf, cmd_len, buf, &resp_len);
429 rc = sbefifo_parse_status(occ->sbefifo, SBEFIFO_CMD_PUT_OCC_SRAM,
430 buf, resp_len, &parsed_len);
432 dev_err(occ->dev, "SRAM attn returned failure status: %08x\n",
434 occ_save_ffdc(occ, buf, parsed_len, resp_len);
440 if (parsed_len != 1) {
441 dev_err(occ->dev, "SRAM attn response length invalid: %zd\n",
445 resp_data_len = be32_to_cpu(buf[0]);
446 if (resp_data_len != 8) {
448 "SRAM attn expected 8 bytes got %zd\n",
457 static bool fsi_occ_response_not_ready(struct occ_response *resp, u8 seq_no,
460 return resp->return_status == OCC_RESP_CMD_IN_PRG ||
461 resp->return_status == OCC_RESP_CRIT_INIT ||
462 resp->seq_no != seq_no || resp->cmd_type != cmd_type;
465 int fsi_occ_submit(struct device *dev, const void *request, size_t req_len,
466 void *response, size_t *resp_len)
468 const unsigned long timeout = msecs_to_jiffies(OCC_TIMEOUT_MS);
469 const unsigned long wait_time =
470 msecs_to_jiffies(OCC_CMD_IN_PRG_WAIT_MS);
471 struct occ *occ = dev_get_drvdata(dev);
472 struct occ_response *resp = response;
473 size_t user_resp_len = *resp_len;
477 u16 resp_data_length;
478 const u8 *byte_request = (const u8 *)request;
488 if (user_resp_len < 7) {
489 dev_dbg(dev, "Bad resplen %zd\n", user_resp_len);
493 cmd_type = byte_request[1];
495 /* Checksum the request, ignoring first byte (sequence number). */
496 for (i = 1; i < req_len - 2; ++i)
497 checksum += byte_request[i];
499 rc = mutex_lock_interruptible(&occ->occ_lock);
503 occ->client_buffer = response;
504 occ->client_buffer_size = user_resp_len;
505 occ->client_response_size = 0;
513 * Get a sequence number and update the counter. Avoid a sequence
514 * number of 0 which would pass the response check below even if the
515 * OCC response is uninitialized. Any sequence number the user is
516 * trying to send is overwritten since this function is the only common
517 * interface to the OCC and therefore the only place we can guarantee
518 * unique sequence numbers.
520 seq_no = occ->sequence_number++;
521 if (!occ->sequence_number)
522 occ->sequence_number = 1;
525 rc = occ_putsram(occ, request, req_len, seq_no, checksum);
529 rc = occ_trigger_attn(occ);
533 end = jiffies + timeout;
535 /* Read occ response header */
536 rc = occ_getsram(occ, 0, resp, 8);
540 if (fsi_occ_response_not_ready(resp, seq_no, cmd_type)) {
541 if (time_after(jiffies, end)) {
543 "resp timeout status=%02x seq=%d cmd=%d, our seq=%d cmd=%d\n",
544 resp->return_status, resp->seq_no,
545 resp->cmd_type, seq_no, cmd_type);
550 set_current_state(TASK_UNINTERRUPTIBLE);
551 schedule_timeout(wait_time);
553 /* Extract size of response data */
555 get_unaligned_be16(&resp->data_length);
558 * Message size is data length + 5 bytes header + 2
561 if ((resp_data_length + 7) > user_resp_len) {
567 * Get the entire response including the header again,
570 if (resp_data_length > 1) {
571 rc = occ_getsram(occ, 0, resp,
572 resp_data_length + 7);
576 if (!fsi_occ_response_not_ready(resp, seq_no,
585 dev_dbg(dev, "resp_status=%02x resp_data_len=%d\n",
586 resp->return_status, resp_data_length);
588 rc = occ_verify_checksum(occ, resp, resp_data_length);
592 occ->client_response_size = resp_data_length + 7;
595 *resp_len = occ->client_response_size;
596 mutex_unlock(&occ->occ_lock);
600 EXPORT_SYMBOL_GPL(fsi_occ_submit);
602 static int occ_unregister_platform_child(struct device *dev, void *data)
604 struct platform_device *hwmon_dev = to_platform_device(dev);
606 platform_device_unregister(hwmon_dev);
611 static int occ_unregister_of_child(struct device *dev, void *data)
613 struct platform_device *hwmon_dev = to_platform_device(dev);
615 of_device_unregister(hwmon_dev);
617 of_node_clear_flag(dev->of_node, OF_POPULATED);
622 static int occ_probe(struct platform_device *pdev)
628 struct platform_device *hwmon_dev = NULL;
629 struct device_node *hwmon_node;
630 struct device *dev = &pdev->dev;
631 struct platform_device_info hwmon_dev_info = {
636 occ = devm_kzalloc(dev, sizeof(*occ), GFP_KERNEL);
640 /* SBE words are always four bytes */
641 occ->buffer = kvmalloc(OCC_MAX_RESP_WORDS * 4, GFP_KERNEL);
645 occ->version = (uintptr_t)of_device_get_match_data(dev);
647 occ->sbefifo = dev->parent;
649 * Quickly derive a pseudo-random number from jiffies so that
650 * re-probing the driver doesn't accidentally overlap sequence numbers.
652 occ->sequence_number = (u8)((jiffies % 0xff) + 1);
653 mutex_init(&occ->occ_lock);
656 rc = of_property_read_u32(dev->of_node, "reg", ®);
658 /* make sure we don't have a duplicate from dts */
659 occ->idx = ida_simple_get(&occ_ida, reg, reg + 1,
662 occ->idx = ida_simple_get(&occ_ida, 1, INT_MAX,
665 occ->idx = ida_simple_get(&occ_ida, 1, INT_MAX,
669 occ->idx = ida_simple_get(&occ_ida, 1, INT_MAX, GFP_KERNEL);
672 platform_set_drvdata(pdev, occ);
674 snprintf(occ->name, sizeof(occ->name), "occ%d", occ->idx);
675 occ->mdev.fops = &occ_fops;
676 occ->mdev.minor = MISC_DYNAMIC_MINOR;
677 occ->mdev.name = occ->name;
678 occ->mdev.parent = dev;
680 rc = misc_register(&occ->mdev);
682 dev_err(dev, "failed to register miscdevice: %d\n", rc);
683 ida_simple_remove(&occ_ida, occ->idx);
688 hwmon_node = of_get_child_by_name(dev->of_node, hwmon_dev_info.name);
690 snprintf(child_name, sizeof(child_name), "%s.%d", hwmon_dev_info.name, occ->idx);
691 hwmon_dev = of_platform_device_create(hwmon_node, child_name, dev);
692 of_node_put(hwmon_node);
696 occ->platform_hwmon = true;
697 hwmon_dev_info.id = occ->idx;
698 hwmon_dev = platform_device_register_full(&hwmon_dev_info);
699 if (IS_ERR(hwmon_dev))
700 dev_warn(dev, "failed to create hwmon device\n");
706 static int occ_remove(struct platform_device *pdev)
708 struct occ *occ = platform_get_drvdata(pdev);
710 misc_deregister(&occ->mdev);
712 mutex_lock(&occ->occ_lock);
715 mutex_unlock(&occ->occ_lock);
717 if (occ->platform_hwmon)
718 device_for_each_child(&pdev->dev, NULL, occ_unregister_platform_child);
720 device_for_each_child(&pdev->dev, NULL, occ_unregister_of_child);
722 ida_simple_remove(&occ_ida, occ->idx);
727 static const struct of_device_id occ_match[] = {
729 .compatible = "ibm,p9-occ",
730 .data = (void *)occ_p9
733 .compatible = "ibm,p10-occ",
734 .data = (void *)occ_p10
738 MODULE_DEVICE_TABLE(of, occ_match);
740 static struct platform_driver occ_driver = {
743 .of_match_table = occ_match,
746 .remove = occ_remove,
749 static int occ_init(void)
751 return platform_driver_register(&occ_driver);
754 static void occ_exit(void)
756 platform_driver_unregister(&occ_driver);
758 ida_destroy(&occ_ida);
761 module_init(occ_init);
762 module_exit(occ_exit);
764 MODULE_AUTHOR("Eddie James <eajames@linux.ibm.com>");
765 MODULE_DESCRIPTION("BMC P9 OCC driver");
766 MODULE_LICENSE("GPL");