1 // SPDX-License-Identifier: GPL-2.0-only
2 // Copyright (C) 2014 Broadcom Corporation
5 #include <linux/delay.h>
6 #include <linux/device.h>
8 #include <linux/interrupt.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/platform_device.h>
13 #include <linux/sched.h>
14 #include <linux/slab.h>
19 * PER_I2C/BSC count register mask depends on 1 byte/4 byte data register
20 * size. Cable modem and DSL SoCs with Peripheral i2c cores use 1 byte per
21 * data register whereas STB SoCs use 4 byte per data register transfer,
22 * account for this difference in total count per transaction and mask to
25 #define BSC_CNT_REG1_MASK(nb) (nb == 1 ? GENMASK(3, 0) : GENMASK(5, 0))
26 #define BSC_CNT_REG1_SHIFT 0
28 /* BSC CTL register field definitions */
29 #define BSC_CTL_REG_DTF_MASK 0x00000003
30 #define BSC_CTL_REG_SCL_SEL_MASK 0x00000030
31 #define BSC_CTL_REG_SCL_SEL_SHIFT 4
32 #define BSC_CTL_REG_INT_EN_MASK 0x00000040
33 #define BSC_CTL_REG_INT_EN_SHIFT 6
34 #define BSC_CTL_REG_DIV_CLK_MASK 0x00000080
36 /* BSC_IIC_ENABLE r/w enable and interrupt field definitions */
37 #define BSC_IIC_EN_RESTART_MASK 0x00000040
38 #define BSC_IIC_EN_NOSTART_MASK 0x00000020
39 #define BSC_IIC_EN_NOSTOP_MASK 0x00000010
40 #define BSC_IIC_EN_NOACK_MASK 0x00000004
41 #define BSC_IIC_EN_INTRP_MASK 0x00000002
42 #define BSC_IIC_EN_ENABLE_MASK 0x00000001
44 /* BSC_CTLHI control register field definitions */
45 #define BSC_CTLHI_REG_INPUT_SWITCHING_LEVEL_MASK 0x00000080
46 #define BSC_CTLHI_REG_DATAREG_SIZE_MASK 0x00000040
47 #define BSC_CTLHI_REG_IGNORE_ACK_MASK 0x00000002
48 #define BSC_CTLHI_REG_WAIT_DIS_MASK 0x00000001
50 #define I2C_TIMEOUT 100 /* msecs */
52 /* Condition mask used for non combined transfer */
53 #define COND_RESTART BSC_IIC_EN_RESTART_MASK
54 #define COND_NOSTART BSC_IIC_EN_NOSTART_MASK
55 #define COND_NOSTOP BSC_IIC_EN_NOSTOP_MASK
56 #define COND_START_STOP (COND_RESTART | COND_NOSTART | COND_NOSTOP)
58 /* BSC data transfer direction */
59 #define DTF_WR_MASK 0x00000000
60 #define DTF_RD_MASK 0x00000001
61 /* BSC data transfer direction combined format */
62 #define DTF_RD_WR_MASK 0x00000002
63 #define DTF_WR_RD_MASK 0x00000003
65 #define INT_ENABLE true
66 #define INT_DISABLE false
68 /* BSC block register map structure to cache fields to be written */
70 u32 chip_address; /* slave address */
71 u32 data_in[N_DATA_REGS]; /* tx data buffer*/
72 u32 cnt_reg; /* rx/tx data length */
73 u32 ctl_reg; /* control register */
74 u32 iic_enable; /* xfer enable and status */
75 u32 data_out[N_DATA_REGS]; /* rx data buffer */
76 u32 ctlhi_reg; /* more control fields */
77 u32 scl_param; /* reserved */
80 struct bsc_clk_param {
93 static char const *cmd_string[] = {
96 [CMD_WR_NOACK] = "WR NOACK",
97 [CMD_RD_NOACK] = "RD NOACK",
111 static const struct bsc_clk_param bsc_clk[] = {
114 .scl_mask = SPD_375K << BSC_CTL_REG_SCL_SEL_SHIFT,
119 .scl_mask = SPD_390K << BSC_CTL_REG_SCL_SEL_SHIFT,
124 .scl_mask = SPD_187K << BSC_CTL_REG_SCL_SEL_SHIFT,
129 .scl_mask = SPD_200K << BSC_CTL_REG_SCL_SEL_SHIFT,
134 .scl_mask = SPD_375K << BSC_CTL_REG_SCL_SEL_SHIFT,
135 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
139 .scl_mask = SPD_390K << BSC_CTL_REG_SCL_SEL_SHIFT,
140 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
144 .scl_mask = SPD_187K << BSC_CTL_REG_SCL_SEL_SHIFT,
145 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
149 .scl_mask = SPD_200K << BSC_CTL_REG_SCL_SEL_SHIFT,
150 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
154 struct brcmstb_i2c_dev {
155 struct device *device;
158 struct bsc_regs *bsc_regmap;
159 struct i2c_adapter adapter;
160 struct completion done;
165 /* register accessors for both be and le cpu arch */
166 #ifdef CONFIG_CPU_BIG_ENDIAN
167 #define __bsc_readl(_reg) ioread32be(_reg)
168 #define __bsc_writel(_val, _reg) iowrite32be(_val, _reg)
170 #define __bsc_readl(_reg) ioread32(_reg)
171 #define __bsc_writel(_val, _reg) iowrite32(_val, _reg)
174 #define bsc_readl(_dev, _reg) \
175 __bsc_readl(_dev->base + offsetof(struct bsc_regs, _reg))
177 #define bsc_writel(_dev, _val, _reg) \
178 __bsc_writel(_val, _dev->base + offsetof(struct bsc_regs, _reg))
180 static inline int brcmstb_i2c_get_xfersz(struct brcmstb_i2c_dev *dev)
182 return (N_DATA_REGS * dev->data_regsz);
185 static inline int brcmstb_i2c_get_data_regsz(struct brcmstb_i2c_dev *dev)
187 return dev->data_regsz;
190 static void brcmstb_i2c_enable_disable_irq(struct brcmstb_i2c_dev *dev,
195 /* Enable BSC CTL interrupt line */
196 dev->bsc_regmap->ctl_reg |= BSC_CTL_REG_INT_EN_MASK;
198 /* Disable BSC CTL interrupt line */
199 dev->bsc_regmap->ctl_reg &= ~BSC_CTL_REG_INT_EN_MASK;
202 bsc_writel(dev, dev->bsc_regmap->ctl_reg, ctl_reg);
205 static irqreturn_t brcmstb_i2c_isr(int irq, void *devid)
207 struct brcmstb_i2c_dev *dev = devid;
208 u32 status_bsc_ctl = bsc_readl(dev, ctl_reg);
209 u32 status_iic_intrp = bsc_readl(dev, iic_enable);
211 dev_dbg(dev->device, "isr CTL_REG %x IIC_EN %x\n",
212 status_bsc_ctl, status_iic_intrp);
214 if (!(status_bsc_ctl & BSC_CTL_REG_INT_EN_MASK))
217 brcmstb_i2c_enable_disable_irq(dev, INT_DISABLE);
218 complete(&dev->done);
220 dev_dbg(dev->device, "isr handled");
224 /* Wait for device to be ready */
225 static int brcmstb_i2c_wait_if_busy(struct brcmstb_i2c_dev *dev)
227 unsigned long timeout = jiffies + msecs_to_jiffies(I2C_TIMEOUT);
229 while ((bsc_readl(dev, iic_enable) & BSC_IIC_EN_INTRP_MASK)) {
230 if (time_after(jiffies, timeout))
237 /* i2c xfer completion function, handles both irq and polling mode */
238 static int brcmstb_i2c_wait_for_completion(struct brcmstb_i2c_dev *dev)
241 unsigned long timeout = msecs_to_jiffies(I2C_TIMEOUT);
244 if (!wait_for_completion_timeout(&dev->done, timeout))
247 /* we are in polling mode */
249 unsigned long time_left = jiffies + timeout;
252 bsc_intrp = bsc_readl(dev, iic_enable) &
253 BSC_IIC_EN_INTRP_MASK;
254 if (time_after(jiffies, time_left)) {
259 } while (!bsc_intrp);
262 if (dev->irq < 0 || ret == -ETIMEDOUT)
263 brcmstb_i2c_enable_disable_irq(dev, INT_DISABLE);
268 /* Set xfer START/STOP conditions for subsequent transfer */
269 static void brcmstb_set_i2c_start_stop(struct brcmstb_i2c_dev *dev,
272 u32 regval = dev->bsc_regmap->iic_enable;
274 dev->bsc_regmap->iic_enable = (regval & ~COND_START_STOP) | cond_flag;
277 /* Send I2C request check completion */
278 static int brcmstb_send_i2c_cmd(struct brcmstb_i2c_dev *dev,
279 enum bsc_xfer_cmd cmd)
282 struct bsc_regs *pi2creg = dev->bsc_regmap;
284 /* Make sure the hardware is ready */
285 rc = brcmstb_i2c_wait_if_busy(dev);
289 /* only if we are in interrupt mode */
291 reinit_completion(&dev->done);
293 /* enable BSC CTL interrupt line */
294 brcmstb_i2c_enable_disable_irq(dev, INT_ENABLE);
296 /* initiate transfer by setting iic_enable */
297 pi2creg->iic_enable |= BSC_IIC_EN_ENABLE_MASK;
298 bsc_writel(dev, pi2creg->iic_enable, iic_enable);
300 /* Wait for transaction to finish or timeout */
301 rc = brcmstb_i2c_wait_for_completion(dev);
303 dev_dbg(dev->device, "intr timeout for cmd %s\n",
308 if ((cmd == CMD_RD || cmd == CMD_WR) &&
309 bsc_readl(dev, iic_enable) & BSC_IIC_EN_NOACK_MASK) {
311 dev_dbg(dev->device, "controller received NOACK intr for %s\n",
316 bsc_writel(dev, 0, cnt_reg);
317 bsc_writel(dev, 0, iic_enable);
322 /* Actual data transfer through the BSC master */
323 static int brcmstb_i2c_xfer_bsc_data(struct brcmstb_i2c_dev *dev,
324 u8 *buf, unsigned int len,
325 struct i2c_msg *pmsg)
327 int cnt, byte, i, rc;
328 enum bsc_xfer_cmd cmd;
330 struct bsc_regs *pi2creg = dev->bsc_regmap;
331 int no_ack = pmsg->flags & I2C_M_IGNORE_NAK;
332 int data_regsz = brcmstb_i2c_get_data_regsz(dev);
334 /* see if the transaction needs to check NACK conditions */
336 cmd = (pmsg->flags & I2C_M_RD) ? CMD_RD_NOACK
338 pi2creg->ctlhi_reg |= BSC_CTLHI_REG_IGNORE_ACK_MASK;
340 cmd = (pmsg->flags & I2C_M_RD) ? CMD_RD : CMD_WR;
341 pi2creg->ctlhi_reg &= ~BSC_CTLHI_REG_IGNORE_ACK_MASK;
343 bsc_writel(dev, pi2creg->ctlhi_reg, ctlhi_reg);
345 /* set data transfer direction */
346 ctl_reg = pi2creg->ctl_reg & ~BSC_CTL_REG_DTF_MASK;
347 if (cmd == CMD_WR || cmd == CMD_WR_NOACK)
348 pi2creg->ctl_reg = ctl_reg | DTF_WR_MASK;
350 pi2creg->ctl_reg = ctl_reg | DTF_RD_MASK;
352 /* set the read/write length */
353 bsc_writel(dev, BSC_CNT_REG1_MASK(data_regsz) &
354 (len << BSC_CNT_REG1_SHIFT), cnt_reg);
356 /* Write data into data_in register */
358 if (cmd == CMD_WR || cmd == CMD_WR_NOACK) {
359 for (cnt = 0, i = 0; cnt < len; cnt += data_regsz, i++) {
362 for (byte = 0; byte < data_regsz; byte++) {
363 word >>= BITS_PER_BYTE;
364 if ((cnt + byte) < len)
365 word |= buf[cnt + byte] <<
366 (BITS_PER_BYTE * (data_regsz - 1));
368 bsc_writel(dev, word, data_in[i]);
372 /* Initiate xfer, the function will return on completion */
373 rc = brcmstb_send_i2c_cmd(dev, cmd);
376 dev_dbg(dev->device, "%s failure", cmd_string[cmd]);
380 /* Read data from data_out register */
381 if (cmd == CMD_RD || cmd == CMD_RD_NOACK) {
382 for (cnt = 0, i = 0; cnt < len; cnt += data_regsz, i++) {
383 u32 data = bsc_readl(dev, data_out[i]);
385 for (byte = 0; byte < data_regsz &&
386 (byte + cnt) < len; byte++) {
387 buf[cnt + byte] = data & 0xff;
388 data >>= BITS_PER_BYTE;
396 /* Write a single byte of data to the i2c bus */
397 static int brcmstb_i2c_write_data_byte(struct brcmstb_i2c_dev *dev,
398 u8 *buf, unsigned int nak_expected)
400 enum bsc_xfer_cmd cmd = nak_expected ? CMD_WR : CMD_WR_NOACK;
402 bsc_writel(dev, 1, cnt_reg);
403 bsc_writel(dev, *buf, data_in);
405 return brcmstb_send_i2c_cmd(dev, cmd);
408 /* Send i2c address */
409 static int brcmstb_i2c_do_addr(struct brcmstb_i2c_dev *dev,
414 if (msg->flags & I2C_M_TEN) {
415 /* First byte is 11110XX0 where XX is upper 2 bits */
416 addr = 0xF0 | ((msg->addr & 0x300) >> 7);
417 bsc_writel(dev, addr, chip_address);
419 /* Second byte is the remaining 8 bits */
420 addr = msg->addr & 0xFF;
421 if (brcmstb_i2c_write_data_byte(dev, &addr, 0) < 0)
424 if (msg->flags & I2C_M_RD) {
425 /* For read, send restart without stop condition */
426 brcmstb_set_i2c_start_stop(dev, COND_RESTART
428 /* Then re-send the first byte with the read bit set */
429 addr = 0xF0 | ((msg->addr & 0x300) >> 7) | 0x01;
430 if (brcmstb_i2c_write_data_byte(dev, &addr, 0) < 0)
435 addr = i2c_8bit_addr_from_msg(msg);
437 bsc_writel(dev, addr, chip_address);
443 /* Master transfer function */
444 static int brcmstb_i2c_xfer(struct i2c_adapter *adapter,
445 struct i2c_msg msgs[], int num)
447 struct brcmstb_i2c_dev *dev = i2c_get_adapdata(adapter);
448 struct i2c_msg *pmsg;
454 int xfersz = brcmstb_i2c_get_xfersz(dev);
455 u32 cond, cond_per_msg;
457 /* Loop through all messages */
458 for (i = 0; i < num; i++) {
464 "msg# %d/%d flg %x buf %x len %d\n", i,
465 num - 1, pmsg->flags,
466 pmsg->buf ? pmsg->buf[0] : '0', pmsg->len);
468 if (i < (num - 1) && (msgs[i + 1].flags & I2C_M_NOSTART))
469 cond = ~COND_START_STOP;
471 cond = COND_RESTART | COND_NOSTOP;
473 brcmstb_set_i2c_start_stop(dev, cond);
475 /* Send slave address */
476 if (!(pmsg->flags & I2C_M_NOSTART)) {
477 rc = brcmstb_i2c_do_addr(dev, pmsg);
480 "NACK for addr %2.2x msg#%d rc = %d\n",
488 /* Perform data transfer */
490 bytes_to_xfer = min(len, xfersz);
494 cond_per_msg = cond_per_msg &
495 ~(COND_RESTART | COND_NOSTOP);
499 cond_per_msg = (cond_per_msg & ~COND_RESTART) |
503 brcmstb_set_i2c_start_stop(dev, cond_per_msg);
505 rc = brcmstb_i2c_xfer_bsc_data(dev, tmp_buf,
506 bytes_to_xfer, pmsg);
510 len -= bytes_to_xfer;
511 tmp_buf += bytes_to_xfer;
513 cond_per_msg = COND_NOSTART | COND_NOSTOP;
523 static u32 brcmstb_i2c_functionality(struct i2c_adapter *adap)
525 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR
526 | I2C_FUNC_NOSTART | I2C_FUNC_PROTOCOL_MANGLING;
529 static const struct i2c_algorithm brcmstb_i2c_algo = {
530 .master_xfer = brcmstb_i2c_xfer,
531 .functionality = brcmstb_i2c_functionality,
534 static void brcmstb_i2c_set_bus_speed(struct brcmstb_i2c_dev *dev)
536 int i = 0, num_speeds = ARRAY_SIZE(bsc_clk);
537 u32 clk_freq_hz = dev->clk_freq_hz;
539 for (i = 0; i < num_speeds; i++) {
540 if (bsc_clk[i].hz == clk_freq_hz) {
541 dev->bsc_regmap->ctl_reg &= ~(BSC_CTL_REG_SCL_SEL_MASK
542 | BSC_CTL_REG_DIV_CLK_MASK);
543 dev->bsc_regmap->ctl_reg |= (bsc_clk[i].scl_mask |
544 bsc_clk[i].div_mask);
545 bsc_writel(dev, dev->bsc_regmap->ctl_reg, ctl_reg);
550 /* in case we did not get find a valid speed */
551 if (i == num_speeds) {
552 i = (bsc_readl(dev, ctl_reg) & BSC_CTL_REG_SCL_SEL_MASK) >>
553 BSC_CTL_REG_SCL_SEL_SHIFT;
554 dev_warn(dev->device, "leaving current clock-frequency @ %dHz\n",
559 static void brcmstb_i2c_set_bsc_reg_defaults(struct brcmstb_i2c_dev *dev)
561 if (brcmstb_i2c_get_data_regsz(dev) == sizeof(u32))
562 /* set 4 byte data in/out xfers */
563 dev->bsc_regmap->ctlhi_reg = BSC_CTLHI_REG_DATAREG_SIZE_MASK;
565 dev->bsc_regmap->ctlhi_reg &= ~BSC_CTLHI_REG_DATAREG_SIZE_MASK;
567 bsc_writel(dev, dev->bsc_regmap->ctlhi_reg, ctlhi_reg);
569 brcmstb_i2c_set_bus_speed(dev);
572 #define AUTOI2C_CTRL0 0x26c
573 #define AUTOI2C_CTRL0_RELEASE_BSC BIT(1)
575 static int bcm2711_release_bsc(struct brcmstb_i2c_dev *dev)
577 struct platform_device *pdev = to_platform_device(dev->device);
578 void __iomem *autoi2c;
580 /* Map hardware registers */
581 autoi2c = devm_platform_ioremap_resource_byname(pdev, "auto-i2c");
583 return PTR_ERR(autoi2c);
585 writel(AUTOI2C_CTRL0_RELEASE_BSC, autoi2c + AUTOI2C_CTRL0);
586 devm_iounmap(&pdev->dev, autoi2c);
588 /* We need to reset the controller after the release */
589 dev->bsc_regmap->iic_enable = 0;
590 bsc_writel(dev, dev->bsc_regmap->iic_enable, iic_enable);
595 static int brcmstb_i2c_probe(struct platform_device *pdev)
598 struct brcmstb_i2c_dev *dev;
599 struct i2c_adapter *adap;
600 struct resource *iomem;
601 const char *int_name;
603 /* Allocate memory for private data structure */
604 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
608 dev->bsc_regmap = devm_kzalloc(&pdev->dev, sizeof(*dev->bsc_regmap), GFP_KERNEL);
609 if (!dev->bsc_regmap)
612 platform_set_drvdata(pdev, dev);
613 dev->device = &pdev->dev;
614 init_completion(&dev->done);
616 /* Map hardware registers */
617 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
618 dev->base = devm_ioremap_resource(dev->device, iomem);
619 if (IS_ERR(dev->base)) {
624 if (of_device_is_compatible(dev->device->of_node,
625 "brcm,bcm2711-hdmi-i2c")) {
626 rc = bcm2711_release_bsc(dev);
631 rc = of_property_read_string(dev->device->of_node, "interrupt-names",
636 /* Get the interrupt number */
637 dev->irq = platform_get_irq_optional(pdev, 0);
639 /* disable the bsc interrupt line */
640 brcmstb_i2c_enable_disable_irq(dev, INT_DISABLE);
642 /* register the ISR handler */
644 rc = devm_request_irq(&pdev->dev, dev->irq, brcmstb_i2c_isr,
646 int_name ? int_name : pdev->name,
650 dev_dbg(dev->device, "falling back to polling mode");
655 if (of_property_read_u32(dev->device->of_node,
656 "clock-frequency", &dev->clk_freq_hz)) {
657 dev_warn(dev->device, "setting clock-frequency@%dHz\n",
659 dev->clk_freq_hz = bsc_clk[0].hz;
662 /* set the data in/out register size for compatible SoCs */
663 if (of_device_is_compatible(dev->device->of_node,
665 dev->data_regsz = sizeof(u8);
667 dev->data_regsz = sizeof(u32);
669 brcmstb_i2c_set_bsc_reg_defaults(dev);
671 /* Add the i2c adapter */
672 adap = &dev->adapter;
673 i2c_set_adapdata(adap, dev);
674 adap->owner = THIS_MODULE;
675 strscpy(adap->name, dev_name(&pdev->dev), sizeof(adap->name));
676 adap->algo = &brcmstb_i2c_algo;
677 adap->dev.parent = &pdev->dev;
678 adap->dev.of_node = pdev->dev.of_node;
679 rc = i2c_add_adapter(adap);
683 dev_info(dev->device, "%s@%dhz registered in %s mode\n",
684 int_name ? int_name : " ", dev->clk_freq_hz,
685 (dev->irq >= 0) ? "interrupt" : "polling");
693 static void brcmstb_i2c_remove(struct platform_device *pdev)
695 struct brcmstb_i2c_dev *dev = platform_get_drvdata(pdev);
697 i2c_del_adapter(&dev->adapter);
700 #ifdef CONFIG_PM_SLEEP
701 static int brcmstb_i2c_suspend(struct device *dev)
703 struct brcmstb_i2c_dev *i2c_dev = dev_get_drvdata(dev);
705 i2c_mark_adapter_suspended(&i2c_dev->adapter);
709 static int brcmstb_i2c_resume(struct device *dev)
711 struct brcmstb_i2c_dev *i2c_dev = dev_get_drvdata(dev);
713 brcmstb_i2c_set_bsc_reg_defaults(i2c_dev);
714 i2c_mark_adapter_resumed(&i2c_dev->adapter);
720 static SIMPLE_DEV_PM_OPS(brcmstb_i2c_pm, brcmstb_i2c_suspend,
723 static const struct of_device_id brcmstb_i2c_of_match[] = {
724 {.compatible = "brcm,brcmstb-i2c"},
725 {.compatible = "brcm,brcmper-i2c"},
726 {.compatible = "brcm,bcm2711-hdmi-i2c"},
729 MODULE_DEVICE_TABLE(of, brcmstb_i2c_of_match);
731 static struct platform_driver brcmstb_i2c_driver = {
733 .name = "brcmstb-i2c",
734 .of_match_table = brcmstb_i2c_of_match,
735 .pm = &brcmstb_i2c_pm,
737 .probe = brcmstb_i2c_probe,
738 .remove_new = brcmstb_i2c_remove,
740 module_platform_driver(brcmstb_i2c_driver);
742 MODULE_AUTHOR("Kamal Dasu <kdasu@broadcom.com>");
743 MODULE_DESCRIPTION("Broadcom Settop I2C Driver");
744 MODULE_LICENSE("GPL v2");