[i2c] [PATCH] AT91RM9200 I2C bus driver
Mark M. Hoffman
mhoffman at lightlink.com
Tue Jul 4 17:13:53 CEST 2006
Hi Andrew:
After consulting with some other kernel developers, I must insist:
1) You need to reformat this code to fit 80 columns.
2) The correct way to prepare for memory-mapped device IO is ioremap().
Also...
* Andrew Victor <andrew at sanpeople.com> [2006-06-27 17:24:15 +0200]:
> This patch adds support for the I2C (Two-wire interface) controller
> integrated in the Atmel AT91RM9200 processor.
>
> Major changes from previous version:
> - Corrected calculation of clock divisors.
> - Read/Write procedure now correctly matches flow-charts in data-sheet.
>
> Signed-off-by: Andrew Victor <andrew at sanpeople.com>
>
>
>
> diff -urN linux-2.6.17-git11.orig/drivers/i2c/busses/Kconfig linux-2.6.17-git11/drivers/i2c/busses/Kconfig
> --- linux-2.6.17-git11.orig/drivers/i2c/busses/Kconfig Tue Jun 27 16:51:28 2006
> +++ linux-2.6.17-git11/drivers/i2c/busses/Kconfig Tue Jun 27 16:56:21 2006
> @@ -74,6 +74,13 @@
> This driver can also be built as a module. If so, the module
> will be called i2c-amd8111.
>
> +config I2C_AT91
> + tristate "Atmel AT91 I2C Two-Wire interface (TWI)"
> + depends on I2C && ARCH_AT91RM9200 && EXPERIMENTAL
> + help
> + This supports the use of the I2C interface on the AT91RM9200
> + processor.
> +
> config I2C_AU1550
> tristate "Au1550 SMBus interface"
> depends on I2C && SOC_AU1550
> diff -urN linux-2.6.17-git11.orig/drivers/i2c/busses/Makefile linux-2.6.17-git11/drivers/i2c/busses/Makefile
> --- linux-2.6.17-git11.orig/drivers/i2c/busses/Makefile Tue Jun 27 16:51:29 2006
> +++ linux-2.6.17-git11/drivers/i2c/busses/Makefile Tue Jun 27 16:56:57 2006
> @@ -8,6 +8,7 @@
> obj-$(CONFIG_I2C_AMD756) += i2c-amd756.o
> obj-$(CONFIG_I2C_AMD756_S4882) += i2c-amd756-s4882.o
> obj-$(CONFIG_I2C_AMD8111) += i2c-amd8111.o
> +obj-$(CONFIG_I2C_AT91) += i2c-at91.o
> obj-$(CONFIG_I2C_AU1550) += i2c-au1550.o
> obj-$(CONFIG_I2C_ELEKTOR) += i2c-elektor.o
> obj-$(CONFIG_I2C_HYDRA) += i2c-hydra.o
> diff -urN linux-2.6.17-git11.orig/drivers/i2c/busses/i2c-at91.c linux-2.6.17-git11/drivers/i2c/busses/i2c-at91.c
> --- linux-2.6.17-git11.orig/drivers/i2c/busses/i2c-at91.c Thu Jan 1 02:00:00 1970
> +++ linux-2.6.17-git11/drivers/i2c/busses/i2c-at91.c Tue Jun 27 16:57:15 2006
> @@ -0,0 +1,258 @@
> +/*
> + i2c Support for Atmel's AT91 Two-Wire Interface (TWI)
> +
> + Copyright (C) 2004 Rick Bronson
> + Converted to 2.6 by Andrew Victor <andrew at sanpeople.com>
> +
> + Borrowed heavily from original work by:
> + Copyright (C) 2000 Philip Edelbrock <phil at stimpy.netroedge.com>
> +
> + This program is free software; you can redistribute it and/or modify
> + it under the terms of the GNU General Public License as published by
> + the Free Software Foundation; either version 2 of the License, or
> + (at your option) any later version.
> +*/
> +
> +#include <linux/module.h>
> +#include <linux/version.h>
> +#include <linux/kernel.h>
> +#include <linux/slab.h>
> +#include <linux/pci.h>
> +#include <linux/types.h>
> +#include <linux/delay.h>
> +#include <linux/i2c.h>
> +#include <linux/init.h>
> +#include <linux/clk.h>
> +#include <linux/platform_device.h>
> +
> +#include <asm/io.h>
> +
> +#include <asm/arch/at91rm9200_twi.h>
> +#include <asm/arch/board.h>
> +
> +#define TWI_CLOCK 100000 /* Hz. max 400 Kbits/sec */
> +
> +
> +static struct clk *twi_clk;
> +
> +/*
> + * Read from a TWI register.
> + */
> +static inline unsigned long at91_twi_read(unsigned int reg)
> +{
> + void __iomem *twi_base = (void __iomem *)AT91_VA_BASE_TWI;
> +
> + return __raw_readl(twi_base + reg);
> +}
> +
> +/*
> + * Write to a TWI register.
> + */
> +static inline void at91_twi_write(unsigned int reg, unsigned long value)
> +{
> + void __iomem *twi_base = (void __iomem *)AT91_VA_BASE_TWI;
> +
> + __raw_writel(value, twi_base + reg);
> +}
> +
> +/*
> + * Initialize the TWI hardware registers.
> + */
> +static void __init at91_twi_hwinit(void)
The caller is __devinit, so this has to be __devinit also.
http://lists.lm-sensors.org/pipermail/i2c/2006-June/000028.html
> +{
> + unsigned long cdiv, ckdiv;
> +
> + at91_twi_write(AT91_TWI_IDR, 0x1ff); /* Disable all interrupts */
Get rid of the magic number 0x1ff. According to the datasheet it's
wrong anyway.
> + at91_twi_write(AT91_TWI_CR, AT91_TWI_SWRST); /* Reset peripheral */
> + at91_twi_write(AT91_TWI_CR, AT91_TWI_MSEN); /* Set Master mode */
> +
> + /* Calcuate clock dividers */
> + cdiv = (clk_get_rate(twi_clk) / (2 * TWI_CLOCK)) - 3;
> + cdiv = cdiv + 1; /* round up */
> + ckdiv = 0;
> + while (cdiv > 255) {
> + ckdiv++;
> + cdiv = cdiv >> 1;
> + }
> +
> + BUG_ON(ckdiv > 5); /* AT91RM9200 Errata #22 */
> +
> + at91_twi_write(AT91_TWI_CWGR, (ckdiv << 16) | cdiv | (cdiv << 8));
> +}
No: return status so that you can fail the driver load. Write something to
the kernel log while you're at it... but BUG_ON() is way too harsh for this.
> +
> +/*
> + * Poll the i2c status register until the specified bit is set.
> + * Returns 0 if timed out (100 msec).
> + */
> +static short at91_poll_status(unsigned long bit)
> +{
> + int loop_cntr = 10000;
> +
> + do {
> + udelay(10);
> + } while (!(at91_twi_read(AT91_TWI_SR) & bit) && (--loop_cntr > 0));
> +
> + return (loop_cntr > 0);
> +}
> +
> +/*
> + * Generic i2c master transfer entrypoint.
> + */
> +static int at91_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
Use struct i2c_msg *pmsg in the declaration and get rid of the local.
> +{
> + struct i2c_msg *pmsg;
> + int length;
> + unsigned char *buf;
> + int i;
> +
> + dev_dbg(&adap->dev, "at91_xfer: processing %d messages:\n", num);
> +
> + pmsg = msgs; /* get 1st message */
> +
> + for (i = 0; i < num; i++) {
> + dev_dbg(&adap->dev, " #%d: %sing %d byte%s %s 0x%02x ...", i,
> + pmsg->flags & I2C_M_RD ? "read" : "write",
> + pmsg->len, pmsg->len > 1 ? "s" : "",
> + pmsg->flags & I2C_M_RD ? "from" : "to", pmsg->addr);
> +
> + /*
> + * Set the TWI Master Mode Register:
> + * We do _not_ use Atmel's feature of storing the "internal device address"
> + * in TWI_IADR. Thus the IADRSZ bits in TWI_MMR are set to zero.
> + * Instead the "internal device address" has to be written using a seperate
> + * i2c message.
> + * See http://lists.arm.linux.org.uk/pipermail/linux-arm-kernel/2004-September/024411.html
> + */
> + at91_twi_write(AT91_TWI_MMR, (pmsg->addr << 16) | (pmsg->flags & I2C_M_RD ? AT91_TWI_MREAD : 0));
> +
> + length = pmsg->len;
> + buf = pmsg->buf;
> + if (length && buf) { /* sanity check */
> + /* Send Start */
> + at91_twi_write(AT91_TWI_CR, AT91_TWI_START);
> +
> + if (pmsg->flags & I2C_M_RD) {
> + while (length--) {
> + if (!at91_poll_status(AT91_TWI_RXRDY)) {
> + dev_dbg(&adap->dev, "RXRDY timeout\n");
> + return -ETIMEDOUT;
> + }
> + *buf++ = (at91_twi_read(AT91_TWI_RHR) & 0xff);
> + }
> + } else {
> + while (length--) {
> + at91_twi_write(AT91_TWI_THR, *buf++);
The datasheet flowchart shows the first write to TWI_THR before the
CR/START write when writing (which makes sense).
> + if (!at91_poll_status(AT91_TWI_TXRDY)) {
> + dev_dbg(&adap->dev, "TXRDY timeout\n");
> + return -ETIMEDOUT;
> + }
> + }
> + }
> +
> + /* Send Stop, and Wait until transfer is finished */
> + at91_twi_write(AT91_TWI_CR, AT91_TWI_STOP);
> + if (!at91_poll_status(AT91_TWI_TXCOMP)) {
> + dev_dbg(&adap->dev, "TXCOMP timeout\n");
> + return -ETIMEDOUT;
> + }
> + }
> + dev_dbg(&adap->dev, "ok\n");
You're trying to complete the previous dev_dbg statement here. But doesn't
it print the device name again right in the middle? Anyway, some other log
message could come in between. Please just write a full line above and a
full line here.
> + pmsg++; /* next message */
> + }
> + return i;
> +}
> +
> +/*
> + * Return list of supported functionality.
> + */
> +static u32 at91_func(struct i2c_adapter *adapter)
> +{
> + return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
> +}
> +
> +/* For now, we only handle combined mode (smbus) */
Kill that comment, it's wrong.
> +static struct i2c_algorithm at91_algorithm = {
> + .master_xfer = at91_xfer,
> + .functionality = at91_func,
> +};
> +
> +/*
> + * Main initialization routine.
> + */
> +static int __devinit at91_i2c_probe(struct platform_device *pdev)
> +{
> + struct i2c_adapter *adapter;
> + int rc;
> +
> + twi_clk = clk_get(NULL, "twi_clk");
You should use clk_put() in the error paths of this function. (Yes, I
realize that's a no-op right now).
> + if (IS_ERR(twi_clk)) {
> + dev_err(&pdev->dev, "no clock defined\n");
> + return -ENODEV;
> + }
> +
> + adapter = kzalloc(sizeof(struct i2c_adapter), GFP_KERNEL);
> + if (adapter == NULL) {
> + dev_err(&pdev->dev, "can't allocate inteface!\n");
> + return -ENOMEM;
> + }
> + sprintf(adapter->name, "AT91");
> + adapter->algo = &at91_algorithm;
> + adapter->class = I2C_CLASS_HWMON;
> + adapter->dev.parent = &pdev->dev;
> +
> + platform_set_drvdata(pdev, adapter);
> +
> + clk_enable(twi_clk); /* enable peripheral clock */
> + at91_twi_hwinit(); /* initialize TWI controller */
Wouldn't it make more sense to move the clock enable into the hwinit?
> +
> + rc = i2c_add_adapter(adapter);
> + if (rc) {
> + dev_err(&pdev->dev, "Adapter %s registration failed\n", adapter->name);
> + platform_set_drvdata(pdev, NULL);
> + kfree(adapter);
> + clk_disable(twi_clk);
> + } else
> + dev_info(&pdev->dev, "AT91 i2c bus driver.\n");
> +
> + return rc;
> +}
> +
> +static int __devexit at91_i2c_remove(struct platform_device *pdev)
> +{
> + struct i2c_adapter *adapter = platform_get_drvdata(pdev);
> + int res;
> +
> + res = i2c_del_adapter(adapter);
> + platform_set_drvdata(pdev, NULL);
> +
> + clk_disable(twi_clk); /* disable peripheral clock */
> + clk_put(twi_clk);
> +
Ah, but you did use clk_put() here... good.
> + return res;
> +}
> +
> +static struct platform_driver at91_i2c_driver = {
> + .probe = at91_i2c_probe,
> + .remove = __devexit_p(at91_i2c_remove),
> + .driver = {
> + .name = "at91_i2c",
> + .owner = THIS_MODULE,
> + },
> +};
> +
> +static int __init at91_i2c_init(void)
> +{
> + return platform_driver_register(&at91_i2c_driver);
> +}
> +
> +static void __exit at91_i2c_exit(void)
> +{
> + platform_driver_unregister(&at91_i2c_driver);
> +}
> +
> +module_init(at91_i2c_init);
> +module_exit(at91_i2c_exit);
> +
> +MODULE_AUTHOR("Rick Bronson");
> +MODULE_DESCRIPTION("I2C (TWI) driver for Atmel AT91");
> +MODULE_LICENSE("GPL");
> diff -urN linux-2.6.17-git11.orig/include/asm-arm/arch-at91rm9200/at91rm9200_twi.h linux-2.6.17-git11/include/asm-arm/arch-at91rm9200/at91rm9200_twi.h
> --- linux-2.6.17-git11.orig/include/asm-arm/arch-at91rm9200/at91rm9200_twi.h Thu Jan 1 02:00:00 1970
> +++ linux-2.6.17-git11/include/asm-arm/arch-at91rm9200/at91rm9200_twi.h Tue Jun 27 16:57:34 2006
> @@ -0,0 +1,57 @@
> +/*
> + * include/asm-arm/arch-at91rm9200/at91rm9200_twi.h
> + *
> + * Copyright (C) 2005 Ivan Kokshaysky
> + * Copyright (C) SAN People
> + *
> + * Two-wire Interface (TWI) registers.
> + * Based on AT91RM9200 datasheet revision E.
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + */
> +
> +#ifndef AT91RM9200_TWI_H
> +#define AT91RM9200_TWI_H
> +
> +#define AT91_TWI_CR 0x00 /* Control Register */
> +#define AT91_TWI_START (1 << 0) /* Send a Start Condition */
> +#define AT91_TWI_STOP (1 << 1) /* Send a Stop Condition */
> +#define AT91_TWI_MSEN (1 << 2) /* Master Transfer Enable */
> +#define AT91_TWI_MSDIS (1 << 3) /* Master Transfer Disable */
> +#define AT91_TWI_SWRST (1 << 7) /* Software Reset */
> +
> +#define AT91_TWI_MMR 0x04 /* Master Mode Register */
> +#define AT91_TWI_IADRSZ (3 << 8) /* Internal Device Address Size */
> +#define AT91_TWI_IADRSZ_NO (0 << 8)
> +#define AT91_TWI_IADRSZ_1 (1 << 8)
> +#define AT91_TWI_IADRSZ_2 (2 << 8)
> +#define AT91_TWI_IADRSZ_3 (3 << 8)
> +#define AT91_TWI_MREAD (1 << 12) /* Master Read Direction */
> +#define AT91_TWI_DADR (0x7f << 16) /* Device Address */
> +
> +#define AT91_TWI_IADR 0x0c /* Internal Address Register */
> +
> +#define AT91_TWI_CWGR 0x10 /* Clock Waveform Generator Register */
> +#define AT91_TWI_CLDIV (0xff << 0) /* Clock Low Divisor */
> +#define AT91_TWI_CHDIV (0xff << 8) /* Clock High Divisor */
> +#define AT91_TWI_CKDIV (7 << 16) /* Clock Divider */
> +
> +#define AT91_TWI_SR 0x20 /* Status Register */
> +#define AT91_TWI_TXCOMP (1 << 0) /* Transmission Complete */
> +#define AT91_TWI_RXRDY (1 << 1) /* Receive Holding Register Ready */
> +#define AT91_TWI_TXRDY (1 << 2) /* Transmit Holding Register Ready */
> +#define AT91_TWI_OVRE (1 << 6) /* Overrun Error */
> +#define AT91_TWI_UNRE (1 << 7) /* Underrun Error */
> +#define AT91_TWI_NACK (1 << 8) /* Not Acknowledged */
> +
> +#define AT91_TWI_IER 0x24 /* Interrupt Enable Register */
> +#define AT91_TWI_IDR 0x28 /* Interrupt Disable Register */
> +#define AT91_TWI_IMR 0x2c /* Interrupt Mask Register */
> +#define AT91_TWI_RHR 0x30 /* Receive Holding Register */
> +#define AT91_TWI_THR 0x34 /* Transmit Holding Register */
> +
> +#endif
> +
>
>
Regards,
--
Mark M. Hoffman
mhoffman at lightlink.com
More information about the i2c
mailing list