2 * Copyright (C) 2014 Broadcom Corporation
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation version 2.
8 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
9 * kind, whether express or implied; without even the implied warranty
10 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/device.h>
17 #include <linux/i2c.h>
18 #include <linux/interrupt.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/platform_device.h>
23 #include <linux/sched.h>
24 #include <linux/slab.h>
25 #include <linux/version.h>
30 * PER_I2C/BSC count register mask depends on 1 byte/4 byte data register
31 * size. Cable modem and DSL SoCs with Peripheral i2c cores use 1 byte per
32 * data register whereas STB SoCs use 4 byte per data register transfer,
33 * account for this difference in total count per transaction and mask to
36 #define BSC_CNT_REG1_MASK(nb) (nb == 1 ? GENMASK(3, 0) : GENMASK(5, 0))
37 #define BSC_CNT_REG1_SHIFT 0
39 /* BSC CTL register field definitions */
40 #define BSC_CTL_REG_DTF_MASK 0x00000003
41 #define BSC_CTL_REG_SCL_SEL_MASK 0x00000030
42 #define BSC_CTL_REG_SCL_SEL_SHIFT 4
43 #define BSC_CTL_REG_INT_EN_MASK 0x00000040
44 #define BSC_CTL_REG_INT_EN_SHIFT 6
45 #define BSC_CTL_REG_DIV_CLK_MASK 0x00000080
47 /* BSC_IIC_ENABLE r/w enable and interrupt field definitions */
48 #define BSC_IIC_EN_RESTART_MASK 0x00000040
49 #define BSC_IIC_EN_NOSTART_MASK 0x00000020
50 #define BSC_IIC_EN_NOSTOP_MASK 0x00000010
51 #define BSC_IIC_EN_NOACK_MASK 0x00000004
52 #define BSC_IIC_EN_INTRP_MASK 0x00000002
53 #define BSC_IIC_EN_ENABLE_MASK 0x00000001
55 /* BSC_CTLHI control register field definitions */
56 #define BSC_CTLHI_REG_INPUT_SWITCHING_LEVEL_MASK 0x00000080
57 #define BSC_CTLHI_REG_DATAREG_SIZE_MASK 0x00000040
58 #define BSC_CTLHI_REG_IGNORE_ACK_MASK 0x00000002
59 #define BSC_CTLHI_REG_WAIT_DIS_MASK 0x00000001
61 #define I2C_TIMEOUT 100 /* msecs */
63 /* Condition mask used for non combined transfer */
64 #define COND_RESTART BSC_IIC_EN_RESTART_MASK
65 #define COND_NOSTART BSC_IIC_EN_NOSTART_MASK
66 #define COND_NOSTOP BSC_IIC_EN_NOSTOP_MASK
67 #define COND_START_STOP (COND_RESTART | COND_NOSTART | COND_NOSTOP)
69 /* BSC data transfer direction */
70 #define DTF_WR_MASK 0x00000000
71 #define DTF_RD_MASK 0x00000001
72 /* BSC data transfer direction combined format */
73 #define DTF_RD_WR_MASK 0x00000002
74 #define DTF_WR_RD_MASK 0x00000003
76 #define INT_ENABLE true
77 #define INT_DISABLE false
79 /* BSC block register map structure to cache fields to be written */
81 u32 chip_address; /* slave address */
82 u32 data_in[N_DATA_REGS]; /* tx data buffer*/
83 u32 cnt_reg; /* rx/tx data length */
84 u32 ctl_reg; /* control register */
85 u32 iic_enable; /* xfer enable and status */
86 u32 data_out[N_DATA_REGS]; /* rx data buffer */
87 u32 ctlhi_reg; /* more control fields */
88 u32 scl_param; /* reserved */
91 struct bsc_clk_param {
104 static char const *cmd_string[] = {
107 [CMD_WR_NOACK] = "WR NOACK",
108 [CMD_RD_NOACK] = "RD NOACK",
122 static const struct bsc_clk_param bsc_clk[] = {
125 .scl_mask = SPD_375K << BSC_CTL_REG_SCL_SEL_SHIFT,
130 .scl_mask = SPD_390K << BSC_CTL_REG_SCL_SEL_SHIFT,
135 .scl_mask = SPD_187K << BSC_CTL_REG_SCL_SEL_SHIFT,
140 .scl_mask = SPD_200K << BSC_CTL_REG_SCL_SEL_SHIFT,
145 .scl_mask = SPD_375K << BSC_CTL_REG_SCL_SEL_SHIFT,
146 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
150 .scl_mask = SPD_390K << BSC_CTL_REG_SCL_SEL_SHIFT,
151 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
155 .scl_mask = SPD_187K << BSC_CTL_REG_SCL_SEL_SHIFT,
156 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
160 .scl_mask = SPD_200K << BSC_CTL_REG_SCL_SEL_SHIFT,
161 .div_mask = BSC_CTL_REG_DIV_CLK_MASK
165 struct brcmstb_i2c_dev {
166 struct device *device;
168 void __iomem *irq_base;
170 struct bsc_regs *bsc_regmap;
171 struct i2c_adapter adapter;
172 struct completion done;
178 /* register accessors for both be and le cpu arch */
179 #ifdef CONFIG_CPU_BIG_ENDIAN
180 #define __bsc_readl(_reg) ioread32be(_reg)
181 #define __bsc_writel(_val, _reg) iowrite32be(_val, _reg)
183 #define __bsc_readl(_reg) ioread32(_reg)
184 #define __bsc_writel(_val, _reg) iowrite32(_val, _reg)
187 #define bsc_readl(_dev, _reg) \
188 __bsc_readl(_dev->base + offsetof(struct bsc_regs, _reg))
190 #define bsc_writel(_dev, _val, _reg) \
191 __bsc_writel(_val, _dev->base + offsetof(struct bsc_regs, _reg))
193 static inline int brcmstb_i2c_get_xfersz(struct brcmstb_i2c_dev *dev)
195 return (N_DATA_REGS * dev->data_regsz);
198 static inline int brcmstb_i2c_get_data_regsz(struct brcmstb_i2c_dev *dev)
200 return dev->data_regsz;
203 static void brcmstb_i2c_enable_disable_irq(struct brcmstb_i2c_dev *dev,
208 /* Enable BSC CTL interrupt line */
209 dev->bsc_regmap->ctl_reg |= BSC_CTL_REG_INT_EN_MASK;
211 /* Disable BSC CTL interrupt line */
212 dev->bsc_regmap->ctl_reg &= ~BSC_CTL_REG_INT_EN_MASK;
215 bsc_writel(dev, dev->bsc_regmap->ctl_reg, ctl_reg);
218 static irqreturn_t brcmstb_i2c_isr(int irq, void *devid)
220 struct brcmstb_i2c_dev *dev = devid;
221 u32 status_bsc_ctl = bsc_readl(dev, ctl_reg);
222 u32 status_iic_intrp = bsc_readl(dev, iic_enable);
224 dev_dbg(dev->device, "isr CTL_REG %x IIC_EN %x\n",
225 status_bsc_ctl, status_iic_intrp);
227 if (!(status_bsc_ctl & BSC_CTL_REG_INT_EN_MASK))
230 brcmstb_i2c_enable_disable_irq(dev, INT_DISABLE);
231 complete_all(&dev->done);
233 dev_dbg(dev->device, "isr handled");
237 /* Wait for device to be ready */
238 static int brcmstb_i2c_wait_if_busy(struct brcmstb_i2c_dev *dev)
240 unsigned long timeout = jiffies + msecs_to_jiffies(I2C_TIMEOUT);
242 while ((bsc_readl(dev, iic_enable) & BSC_IIC_EN_INTRP_MASK)) {
243 if (time_after(jiffies, timeout))
250 /* i2c xfer completion function, handles both irq and polling mode */
251 static int brcmstb_i2c_wait_for_completion(struct brcmstb_i2c_dev *dev)
254 unsigned long timeout = msecs_to_jiffies(I2C_TIMEOUT);
257 if (!wait_for_completion_timeout(&dev->done, timeout))
260 /* we are in polling mode */
262 unsigned long time_left = jiffies + timeout;
265 bsc_intrp = bsc_readl(dev, iic_enable) &
266 BSC_IIC_EN_INTRP_MASK;
267 if (time_after(jiffies, time_left)) {
272 } while (!bsc_intrp);
275 if (dev->irq < 0 || ret == -ETIMEDOUT)
276 brcmstb_i2c_enable_disable_irq(dev, INT_DISABLE);
281 /* Set xfer START/STOP conditions for subsequent transfer */
282 static void brcmstb_set_i2c_start_stop(struct brcmstb_i2c_dev *dev,
285 u32 regval = dev->bsc_regmap->iic_enable;
287 dev->bsc_regmap->iic_enable = (regval & ~COND_START_STOP) | cond_flag;
290 /* Send I2C request check completion */
291 static int brcmstb_send_i2c_cmd(struct brcmstb_i2c_dev *dev,
292 enum bsc_xfer_cmd cmd)
295 struct bsc_regs *pi2creg = dev->bsc_regmap;
297 /* Make sure the hardware is ready */
298 rc = brcmstb_i2c_wait_if_busy(dev);
302 /* only if we are in interrupt mode */
304 reinit_completion(&dev->done);
306 /* enable BSC CTL interrupt line */
307 brcmstb_i2c_enable_disable_irq(dev, INT_ENABLE);
309 /* initiate transfer by setting iic_enable */
310 pi2creg->iic_enable |= BSC_IIC_EN_ENABLE_MASK;
311 bsc_writel(dev, pi2creg->iic_enable, iic_enable);
313 /* Wait for transaction to finish or timeout */
314 rc = brcmstb_i2c_wait_for_completion(dev);
316 dev_dbg(dev->device, "intr timeout for cmd %s\n",
321 if ((CMD_RD || CMD_WR) &&
322 bsc_readl(dev, iic_enable) & BSC_IIC_EN_NOACK_MASK) {
324 dev_dbg(dev->device, "controller received NOACK intr for %s\n",
329 bsc_writel(dev, 0, cnt_reg);
330 bsc_writel(dev, 0, iic_enable);
335 /* Actual data transfer through the BSC master */
336 static int brcmstb_i2c_xfer_bsc_data(struct brcmstb_i2c_dev *dev,
337 u8 *buf, unsigned int len,
338 struct i2c_msg *pmsg)
340 int cnt, byte, i, rc;
341 enum bsc_xfer_cmd cmd;
343 struct bsc_regs *pi2creg = dev->bsc_regmap;
344 int no_ack = pmsg->flags & I2C_M_IGNORE_NAK;
345 int data_regsz = brcmstb_i2c_get_data_regsz(dev);
346 int xfersz = brcmstb_i2c_get_xfersz(dev);
348 /* see if the transaction needs to check NACK conditions */
349 if (no_ack || len <= xfersz) {
350 cmd = (pmsg->flags & I2C_M_RD) ? CMD_RD_NOACK
352 pi2creg->ctlhi_reg |= BSC_CTLHI_REG_IGNORE_ACK_MASK;
354 cmd = (pmsg->flags & I2C_M_RD) ? CMD_RD : CMD_WR;
355 pi2creg->ctlhi_reg &= ~BSC_CTLHI_REG_IGNORE_ACK_MASK;
357 bsc_writel(dev, pi2creg->ctlhi_reg, ctlhi_reg);
359 /* set data transfer direction */
360 ctl_reg = pi2creg->ctl_reg & ~BSC_CTL_REG_DTF_MASK;
361 if (cmd == CMD_WR || cmd == CMD_WR_NOACK)
362 pi2creg->ctl_reg = ctl_reg | DTF_WR_MASK;
364 pi2creg->ctl_reg = ctl_reg | DTF_RD_MASK;
366 /* set the read/write length */
367 bsc_writel(dev, BSC_CNT_REG1_MASK(data_regsz) &
368 (len << BSC_CNT_REG1_SHIFT), cnt_reg);
370 /* Write data into data_in register */
372 if (cmd == CMD_WR || cmd == CMD_WR_NOACK) {
373 for (cnt = 0, i = 0; cnt < len; cnt += data_regsz, i++) {
376 for (byte = 0; byte < data_regsz; byte++) {
377 word >>= BITS_PER_BYTE;
378 if ((cnt + byte) < len)
379 word |= buf[cnt + byte] <<
380 (BITS_PER_BYTE * (data_regsz - 1));
382 bsc_writel(dev, word, data_in[i]);
386 /* Initiate xfer, the function will return on completion */
387 rc = brcmstb_send_i2c_cmd(dev, cmd);
390 dev_dbg(dev->device, "%s failure", cmd_string[cmd]);
394 /* Read data from data_out register */
395 if (cmd == CMD_RD || cmd == CMD_RD_NOACK) {
396 for (cnt = 0, i = 0; cnt < len; cnt += data_regsz, i++) {
397 u32 data = bsc_readl(dev, data_out[i]);
399 for (byte = 0; byte < data_regsz &&
400 (byte + cnt) < len; byte++) {
401 buf[cnt + byte] = data & 0xff;
402 data >>= BITS_PER_BYTE;
410 /* Write a single byte of data to the i2c bus */
411 static int brcmstb_i2c_write_data_byte(struct brcmstb_i2c_dev *dev,
412 u8 *buf, unsigned int nak_expected)
414 enum bsc_xfer_cmd cmd = nak_expected ? CMD_WR : CMD_WR_NOACK;
416 bsc_writel(dev, 1, cnt_reg);
417 bsc_writel(dev, *buf, data_in);
419 return brcmstb_send_i2c_cmd(dev, cmd);
422 /* Send i2c address */
423 static int brcmstb_i2c_do_addr(struct brcmstb_i2c_dev *dev,
428 if (msg->flags & I2C_M_TEN) {
429 /* First byte is 11110XX0 where XX is upper 2 bits */
430 addr = 0xF0 | ((msg->addr & 0x300) >> 7);
431 bsc_writel(dev, addr, chip_address);
433 /* Second byte is the remaining 8 bits */
434 addr = msg->addr & 0xFF;
435 if (brcmstb_i2c_write_data_byte(dev, &addr, 0) < 0)
438 if (msg->flags & I2C_M_RD) {
439 /* For read, send restart without stop condition */
440 brcmstb_set_i2c_start_stop(dev, COND_RESTART
442 /* Then re-send the first byte with the read bit set */
443 addr = 0xF0 | ((msg->addr & 0x300) >> 7) | 0x01;
444 if (brcmstb_i2c_write_data_byte(dev, &addr, 0) < 0)
449 addr = msg->addr << 1;
450 if (msg->flags & I2C_M_RD)
453 bsc_writel(dev, addr, chip_address);
459 /* Master transfer function */
460 static int brcmstb_i2c_xfer(struct i2c_adapter *adapter,
461 struct i2c_msg msgs[], int num)
463 struct brcmstb_i2c_dev *dev = i2c_get_adapdata(adapter);
464 struct i2c_msg *pmsg;
470 int xfersz = brcmstb_i2c_get_xfersz(dev);
472 if (dev->is_suspended)
475 /* Loop through all messages */
476 for (i = 0; i < num; i++) {
482 "msg# %d/%d flg %x buf %x len %d\n", i,
483 num - 1, pmsg->flags,
484 pmsg->buf ? pmsg->buf[0] : '0', pmsg->len);
486 if (i < (num - 1) && (msgs[i + 1].flags & I2C_M_NOSTART))
487 brcmstb_set_i2c_start_stop(dev, ~(COND_START_STOP));
489 brcmstb_set_i2c_start_stop(dev,
490 COND_RESTART | COND_NOSTOP);
492 /* Send slave address */
493 if (!(pmsg->flags & I2C_M_NOSTART)) {
494 rc = brcmstb_i2c_do_addr(dev, pmsg);
497 "NACK for addr %2.2x msg#%d rc = %d\n",
503 /* Perform data transfer */
505 bytes_to_xfer = min(len, xfersz);
507 if (len <= xfersz && i == (num - 1))
508 brcmstb_set_i2c_start_stop(dev,
511 rc = brcmstb_i2c_xfer_bsc_data(dev, tmp_buf,
512 bytes_to_xfer, pmsg);
516 len -= bytes_to_xfer;
517 tmp_buf += bytes_to_xfer;
527 static u32 brcmstb_i2c_functionality(struct i2c_adapter *adap)
529 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR
530 | I2C_FUNC_NOSTART | I2C_FUNC_PROTOCOL_MANGLING;
533 static const struct i2c_algorithm brcmstb_i2c_algo = {
534 .master_xfer = brcmstb_i2c_xfer,
535 .functionality = brcmstb_i2c_functionality,
538 static void brcmstb_i2c_set_bus_speed(struct brcmstb_i2c_dev *dev)
540 int i = 0, num_speeds = ARRAY_SIZE(bsc_clk);
541 u32 clk_freq_hz = dev->clk_freq_hz;
543 for (i = 0; i < num_speeds; i++) {
544 if (bsc_clk[i].hz == clk_freq_hz) {
545 dev->bsc_regmap->ctl_reg &= ~(BSC_CTL_REG_SCL_SEL_MASK
546 | BSC_CTL_REG_DIV_CLK_MASK);
547 dev->bsc_regmap->ctl_reg |= (bsc_clk[i].scl_mask |
548 bsc_clk[i].div_mask);
549 bsc_writel(dev, dev->bsc_regmap->ctl_reg, ctl_reg);
554 /* in case we did not get find a valid speed */
555 if (i == num_speeds) {
556 i = (bsc_readl(dev, ctl_reg) & BSC_CTL_REG_SCL_SEL_MASK) >>
557 BSC_CTL_REG_SCL_SEL_SHIFT;
558 dev_warn(dev->device, "leaving current clock-frequency @ %dHz\n",
563 static void brcmstb_i2c_set_bsc_reg_defaults(struct brcmstb_i2c_dev *dev)
565 if (brcmstb_i2c_get_data_regsz(dev) == sizeof(u32))
566 /* set 4 byte data in/out xfers */
567 dev->bsc_regmap->ctlhi_reg = BSC_CTLHI_REG_DATAREG_SIZE_MASK;
569 dev->bsc_regmap->ctlhi_reg &= ~BSC_CTLHI_REG_DATAREG_SIZE_MASK;
571 bsc_writel(dev, dev->bsc_regmap->ctlhi_reg, ctlhi_reg);
573 brcmstb_i2c_set_bus_speed(dev);
576 static int brcmstb_i2c_probe(struct platform_device *pdev)
579 struct brcmstb_i2c_dev *dev;
580 struct i2c_adapter *adap;
581 struct resource *iomem;
582 const char *int_name;
584 /* Allocate memory for private data structure */
585 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
589 dev->bsc_regmap = devm_kzalloc(&pdev->dev, sizeof(*dev->bsc_regmap), GFP_KERNEL);
590 if (!dev->bsc_regmap)
593 platform_set_drvdata(pdev, dev);
594 dev->device = &pdev->dev;
595 init_completion(&dev->done);
597 /* Map hardware registers */
598 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
599 dev->base = devm_ioremap_resource(dev->device, iomem);
600 if (IS_ERR(dev->base)) {
605 rc = of_property_read_string(dev->device->of_node, "interrupt-names",
610 /* Get the interrupt number */
611 dev->irq = platform_get_irq(pdev, 0);
613 /* disable the bsc interrupt line */
614 brcmstb_i2c_enable_disable_irq(dev, INT_DISABLE);
616 /* register the ISR handler */
617 rc = devm_request_irq(&pdev->dev, dev->irq, brcmstb_i2c_isr,
619 int_name ? int_name : pdev->name,
623 dev_dbg(dev->device, "falling back to polling mode");
627 if (of_property_read_u32(dev->device->of_node,
628 "clock-frequency", &dev->clk_freq_hz)) {
629 dev_warn(dev->device, "setting clock-frequency@%dHz\n",
631 dev->clk_freq_hz = bsc_clk[0].hz;
634 /* set the data in/out register size for compatible SoCs */
635 if (of_device_is_compatible(dev->device->of_node,
636 "brcmstb,brcmper-i2c"))
637 dev->data_regsz = sizeof(u8);
639 dev->data_regsz = sizeof(u32);
641 brcmstb_i2c_set_bsc_reg_defaults(dev);
643 /* Add the i2c adapter */
644 adap = &dev->adapter;
645 i2c_set_adapdata(adap, dev);
646 adap->owner = THIS_MODULE;
647 strlcpy(adap->name, "Broadcom STB : ", sizeof(adap->name));
649 strlcat(adap->name, int_name, sizeof(adap->name));
650 adap->algo = &brcmstb_i2c_algo;
651 adap->dev.parent = &pdev->dev;
652 adap->dev.of_node = pdev->dev.of_node;
653 rc = i2c_add_adapter(adap);
655 dev_err(dev->device, "failed to add adapter\n");
659 dev_info(dev->device, "%s@%dhz registered in %s mode\n",
660 int_name ? int_name : " ", dev->clk_freq_hz,
661 (dev->irq >= 0) ? "interrupt" : "polling");
669 static int brcmstb_i2c_remove(struct platform_device *pdev)
671 struct brcmstb_i2c_dev *dev = platform_get_drvdata(pdev);
673 i2c_del_adapter(&dev->adapter);
677 #ifdef CONFIG_PM_SLEEP
678 static int brcmstb_i2c_suspend(struct device *dev)
680 struct brcmstb_i2c_dev *i2c_dev = dev_get_drvdata(dev);
682 i2c_lock_adapter(&i2c_dev->adapter);
683 i2c_dev->is_suspended = true;
684 i2c_unlock_adapter(&i2c_dev->adapter);
689 static int brcmstb_i2c_resume(struct device *dev)
691 struct brcmstb_i2c_dev *i2c_dev = dev_get_drvdata(dev);
693 i2c_lock_adapter(&i2c_dev->adapter);
694 brcmstb_i2c_set_bsc_reg_defaults(i2c_dev);
695 i2c_dev->is_suspended = false;
696 i2c_unlock_adapter(&i2c_dev->adapter);
702 static SIMPLE_DEV_PM_OPS(brcmstb_i2c_pm, brcmstb_i2c_suspend,
705 static const struct of_device_id brcmstb_i2c_of_match[] = {
706 {.compatible = "brcm,brcmstb-i2c"},
707 {.compatible = "brcm,brcmper-i2c"},
710 MODULE_DEVICE_TABLE(of, brcmstb_i2c_of_match);
712 static struct platform_driver brcmstb_i2c_driver = {
714 .name = "brcmstb-i2c",
715 .of_match_table = brcmstb_i2c_of_match,
716 .pm = &brcmstb_i2c_pm,
718 .probe = brcmstb_i2c_probe,
719 .remove = brcmstb_i2c_remove,
721 module_platform_driver(brcmstb_i2c_driver);
723 MODULE_AUTHOR("Kamal Dasu <kdasu@broadcom.com>");
724 MODULE_DESCRIPTION("Broadcom Settop I2C Driver");
725 MODULE_LICENSE("GPL v2");