I2C devices on BBB

Enable the I2C devices on the BeagleBone Black

On the BeagleBone Black, it's not all of the /dev/i2c-* devices that are enabled by default. The other i2c devices must be enabled before they can be used.

To enable the I2c-1 on the BeagleBone Black Rev A, B and C:

1. Rev A/B: Open the file /media/BEAGLEBONE/uEnv.txt in an editor (vim/nano)
2. Rec C: Open the file /boot/uboot/uEnv.txt in an editor (vim/nano)
3. Add the key "capemgr.enable_partno="
4. Add the ports you want to enable, comma separated (BB-I2C0, BB-I2C1, etc)
5. Reboot

An example line looks like this:

root@beaglebone:/dev# cat /media/BEAGLEBONE/uEnv.txt

optargs=quiet drm.debug=7 capemgr.enable_partno=BB-I2C1

After reboot, the device is present in the device list:

root@beaglebone:/dev# ls -l /dev/i2c*

crw-rw---- 1 root tty     249, 0 Jan  1 01:18 /dev/ttyO0

crw-rw---- 1 root dialout 249, 4 Jan  1 01:18 /dev/ttyO4

Note: The I2C devices do not map one-to-one with the devices in /dev/. I.e. I2C-1 does not necessarily map to /dev/i2c-1, it could just as well be one of the other devs, e.g. /dev/i2c-2.

Testing the I2C devices

You can use the standard Linux i2c tools to test your i2c setup:

List all the enabled devices:

root@beaglebone:/dev# i2cdetect -l
i2c-0   i2c             OMAP I2C adapter                        I2C adapter
i2c-1   i2c             OMAP I2C adapter                        I2C adapter

Scan all addresses on one device:

root@beaglebone:/dev# i2cdetect -r 0
WARNING! This program can confuse your I2C bus, cause data loss and worse!
I will probe file /dev/i2c-0 using read byte commands.
I will probe address range 0x03-0x77.
Continue? [Y/n] Y
     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
00:          -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- -- UU -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- UU -- -- -- -- -- -- -- -- -- -- --
40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
50: UU -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: UU -- -- -- -- -- -- --

Write one byte to a device and an address:

i2cset -y 2 0x77 0xf4 0x34

Read one byte from a device and an address:

i2cdump -y 2 0x77

JavaScript / Node.js

In JavaScript / Node.js you can use the package "i2c" or the latest version of "bonescript" that includes the same package.

 - npm install i2c

 - npm install bonescript

I've had some problems with crashes in the i2c module (segmentation faults).

If you just need to read and write single bytes, you can also do this using normal file system (open /dev/i2c-1 for read+write) and set the device address using the "ioctl" module:

 - npm install ioctl

The code sequence:

1. Open /dev/i2c-1 for read+write

2. Use ioctl to set slave address: ioctl(fileHandle, I2C_SLAVE, address)

(I2C_SLAVE = 0x0703 )

Reference: 

http://beaglebone.cameon.net/home/i2c-devices






Documentation of I2c on 

Usually, i2c devices are controlled by a kernel driver. But it is also
possible to access all devices on an adapter from userspace, through
the /dev interface. You need to load module i2c-dev for this.

Each registered i2c adapter gets a number, counting from 0. You can
examine /sys/class/i2c-dev/ to see what number corresponds to which adapter.
Alternatively, you can run "i2cdetect -l" to obtain a formated list of all
i2c adapters present on your system at a given time. i2cdetect is part of
the i2c-tools package.

I2C device files are character device files with major device number 89
and a minor device number corresponding to the number assigned as 
explained above. They should be called "i2c-%d" (i2c-0, i2c-1, ..., 
i2c-10, ...). All 256 minor device numbers are reserved for i2c.


C example
=========

So let's say you want to access an i2c adapter from a C program. The
first thing to do is "#include <linux/i2c-dev.h>". Please note that
there are two files named "i2c-dev.h" out there, one is distributed
with the Linux kernel and is meant to be included from kernel
driver code, the other one is distributed with i2c-tools and is
meant to be included from user-space programs. You obviously want
the second one here.

Now, you have to decide which adapter you want to access. You should
inspect /sys/class/i2c-dev/ or run "i2cdetect -l" to decide this.
Adapter numbers are assigned somewhat dynamically, so you can not
assume much about them. They can even change from one boot to the next.

Next thing, open the device file, as follows:

  int file;
  int adapter_nr = 2; /* probably dynamically determined */
  char filename[20];
  
  snprintf(filename, 19, "/dev/i2c-%d", adapter_nr);
  file = open(filename, O_RDWR);
  if (file < 0) {
    /* ERROR HANDLING; you can check errno to see what went wrong */
    exit(1);
  }

When you have opened the device, you must specify with what device
address you want to communicate:

  int addr = 0x40; /* The I2C address */

  if (ioctl(file, I2C_SLAVE, addr) < 0) {
    /* ERROR HANDLING; you can check errno to see what went wrong */
    exit(1);
  }

Well, you are all set up now. You can now use SMBus commands or plain
I2C to communicate with your device. SMBus commands are preferred if
the device supports them. Both are illustrated below.

  __u8 reg = 0x10; /* Device register to access */
  __s32 res;
  char buf[10];

  /* Using SMBus commands */
  res = i2c_smbus_read_word_data(file, reg);
  if (res < 0) {
    /* ERROR HANDLING: i2c transaction failed */
  } else {
    /* res contains the read word */
  }

  /* Using I2C Write, equivalent of 
     i2c_smbus_write_word_data(file, reg, 0x6543) */
  buf[0] = reg;
  buf[1] = 0x43;
  buf[2] = 0x65;
  if (write(file, buf, 3) != 3) {
    /* ERROR HANDLING: i2c transaction failed */
  }

  /* Using I2C Read, equivalent of i2c_smbus_read_byte(file) */
  if (read(file, buf, 1) != 1) {
    /* ERROR HANDLING: i2c transaction failed */
  } else {
    /* buf[0] contains the read byte */
  }

Note that only a subset of the I2C and SMBus protocols can be achieved by
the means of read() and write() calls. In particular, so-called combined
transactions (mixing read and write messages in the same transaction)
aren't supported. For this reason, this interface is almost never used by
user-space programs.

IMPORTANT: because of the use of inline functions, you *have* to use
'-O' or some variation when you compile your program!


Full interface description
==========================

The following IOCTLs are defined:

ioctl(file, I2C_SLAVE, long addr)
  Change slave address. The address is passed in the 7 lower bits of the
  argument (except for 10 bit addresses, passed in the 10 lower bits in this
  case).

ioctl(file, I2C_TENBIT, long select)
  Selects ten bit addresses if select not equals 0, selects normal 7 bit
  addresses if select equals 0. Default 0.  This request is only valid
  if the adapter has I2C_FUNC_10BIT_ADDR.

ioctl(file, I2C_PEC, long select)
  Selects SMBus PEC (packet error checking) generation and verification
  if select not equals 0, disables if select equals 0. Default 0.
  Used only for SMBus transactions.  This request only has an effect if the
  the adapter has I2C_FUNC_SMBUS_PEC; it is still safe if not, it just
  doesn't have any effect.

ioctl(file, I2C_FUNCS, unsigned long *funcs)
  Gets the adapter functionality and puts it in *funcs.

ioctl(file, I2C_RDWR, struct i2c_rdwr_ioctl_data *msgset)
  Do combined read/write transaction without stop in between.
  Only valid if the adapter has I2C_FUNC_I2C.  The argument is
  a pointer to a

  struct i2c_rdwr_ioctl_data {
      struct i2c_msg *msgs;  /* ptr to array of simple messages */
      int nmsgs;             /* number of messages to exchange */
  }

  The msgs[] themselves contain further pointers into data buffers.
  The function will write or read data to or from that buffers depending
  on whether the I2C_M_RD flag is set in a particular message or not.
  The slave address and whether to use ten bit address mode has to be
  set in each message, overriding the values set with the above ioctl's.

ioctl(file, I2C_SMBUS, struct i2c_smbus_ioctl_data *args)
  Not meant to be called  directly; instead, use the access functions
  below.

You can do plain i2c transactions by using read(2) and write(2) calls.
You do not need to pass the address byte; instead, set it through
ioctl I2C_SLAVE before you try to access the device.

You can do SMBus level transactions (see documentation file smbus-protocol 
for details) through the following functions:
  __s32 i2c_smbus_write_quick(int file, __u8 value);
  __s32 i2c_smbus_read_byte(int file);
  __s32 i2c_smbus_write_byte(int file, __u8 value);
  __s32 i2c_smbus_read_byte_data(int file, __u8 command);
  __s32 i2c_smbus_write_byte_data(int file, __u8 command, __u8 value);
  __s32 i2c_smbus_read_word_data(int file, __u8 command);
  __s32 i2c_smbus_write_word_data(int file, __u8 command, __u16 value);
  __s32 i2c_smbus_process_call(int file, __u8 command, __u16 value);
  __s32 i2c_smbus_read_block_data(int file, __u8 command, __u8 *values);
  __s32 i2c_smbus_write_block_data(int file, __u8 command, __u8 length, 
                                   __u8 *values);
All these transactions return -1 on failure; you can read errno to see
what happened. The 'write' transactions return 0 on success; the
'read' transactions return the read value, except for read_block, which
returns the number of values read. The block buffers need not be longer
than 32 bytes.

The above functions are all inline functions, that resolve to calls to
the i2c_smbus_access function, that on its turn calls a specific ioctl
with the data in a specific format. Read the source code if you
want to know what happens behind the screens.


Implementation details
======================

For the interested, here's the code flow which happens inside the kernel
when you use the /dev interface to I2C:

1* Your program opens /dev/i2c-N and calls ioctl() on it, as described in
section "C example" above.

2* These open() and ioctl() calls are handled by the i2c-dev kernel
driver: see i2c-dev.c:i2cdev_open() and i2c-dev.c:i2cdev_ioctl(),
respectively. You can think of i2c-dev as a generic I2C chip driver
that can be programmed from user-space.

3* Some ioctl() calls are for administrative tasks and are handled by
i2c-dev directly. Examples include I2C_SLAVE (set the address of the
device you want to access) and I2C_PEC (enable or disable SMBus error
checking on future transactions.)

4* Other ioctl() calls are converted to in-kernel function calls by
i2c-dev. Examples include I2C_FUNCS, which queries the I2C adapter
functionality using i2c.h:i2c_get_functionality(), and I2C_SMBUS, which
performs an SMBus transaction using i2c-core.c:i2c_smbus_xfer().

The i2c-dev driver is responsible for checking all the parameters that
come from user-space for validity. After this point, there is no
difference between these calls that came from user-space through i2c-dev
and calls that would have been performed by kernel I2C chip drivers
directly. This means that I2C bus drivers don't need to implement
anything special to support access from user-space.

5* These i2c-core.c/i2c.h functions are wrappers to the actual
implementation of your I2C bus driver. Each adapter must declare
callback functions implementing these standard calls.
i2c.h:i2c_get_functionality() calls i2c_adapter.algo->functionality(),
while i2c-core.c:i2c_smbus_xfer() calls either
adapter.algo->smbus_xfer() if it is implemented, or if not,
i2c-core.c:i2c_smbus_xfer_emulated() which in turn calls
i2c_adapter.algo->master_xfer().

After your I2C bus driver has processed these requests, execution runs
up the call chain, with almost no processing done, except by i2c-dev to
package the returned data, if any, in suitable format for the ioctl.

EEPROM I2C 

/*
       Copyright (C) 1998, 1999  Frodo Looijaard <frodol@dds.nl> and
                                  Philip Edelbrock <phil@netroedge.com>
       Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
       Copyright (C) 2003 IBM Corp.
       Copyright (C) 2004 Jean Delvare <khali@linux-fr.org>
   
       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.
  
      This program is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      GNU General Public License for more details.
  
      You should have received a copy of the GNU General Public License
      along with this program; if not, write to the Free Software
      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
  
  #include <linux/kernel.h>
  #include <linux/init.h>
  #include <linux/module.h>
  #include <linux/slab.h>
  #include <linux/jiffies.h>
  #include <linux/i2c.h>
  #include <linux/mutex.h>
  
  /* Addresses to scan */
  static const unsigned short normal_i2c[] = { 0x50, 0x51, 0x52, 0x53, 0x54,
                                          0x55, 0x56, 0x57, I2C_CLIENT_END };
  
  /* Insmod parameters */
  I2C_CLIENT_INSMOD_1(eeprom);
  
  
  /* Size of EEPROM in bytes */
  #define EEPROM_SIZE             256
  
  /* possible types of eeprom devices */
  enum eeprom_nature {
          UNKNOWN,
          VAIO,
  };
  
  /* Each client has this additional data */
  struct eeprom_data {
          struct mutex update_lock;
          u8 valid;                       /* bitfield, bit!=0 if slice is valid */
          unsigned long last_updated[8];  /* In jiffies, 8 slices */
          u8 data[EEPROM_SIZE];           /* Register values */
          enum eeprom_nature nature;
  };
  
  
  static void eeprom_update_client(struct i2c_client *client, u8 slice)
  {
          struct eeprom_data *data = i2c_get_clientdata(client);
          int i;
  
          mutex_lock(&data->update_lock);
  
          if (!(data->valid & (1 << slice)) ||
              time_after(jiffies, data->last_updated[slice] + 300 * HZ)) {
                  dev_dbg(&client->dev, "Starting eeprom update, slice %u\n", slice);
  
                  if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
                          for (i = slice << 5; i < (slice + 1) << 5; i += 32)
                                  if (i2c_smbus_read_i2c_block_data(client, i,
                                                          32, data->data + i)
                                                          != 32)
                                          goto exit;
                  } else {
                          for (i = slice << 5; i < (slice + 1) << 5; i += 2) {
                                  int word = i2c_smbus_read_word_data(client, i);
                                  if (word < 0)
                                          goto exit;
                                  data->data[i] = word & 0xff;
                                  data->data[i + 1] = word >> 8;
                          }
                  }
                  data->last_updated[slice] = jiffies;
                  data->valid |= (1 << slice);
          }
  exit:
          mutex_unlock(&data->update_lock);
  }
  
  static ssize_t eeprom_read(struct kobject *kobj, struct bin_attribute *bin_attr,
                             char *buf, loff_t off, size_t count)
  {
          struct i2c_client *client = to_i2c_client(container_of(kobj, struct device, kobj));
          struct eeprom_data *data = i2c_get_clientdata(client);
          u8 slice;
  
          if (off > EEPROM_SIZE)
                  return 0;
         if (off + count > EEPROM_SIZE)
                 count = EEPROM_SIZE - off;
 
         /* Only refresh slices which contain requested bytes */
         for (slice = off >> 5; slice <= (off + count - 1) >> 5; slice++)
                 eeprom_update_client(client, slice);
 
         /* Hide Vaio private settings to regular users:
            - BIOS passwords: bytes 0x00 to 0x0f
            - UUID: bytes 0x10 to 0x1f
            - Serial number: 0xc0 to 0xdf */
         if (data->nature == VAIO && !capable(CAP_SYS_ADMIN)) {
                 int i;
 
                 for (i = 0; i < count; i++) {
                         if ((off + i <= 0x1f) ||
                             (off + i >= 0xc0 && off + i <= 0xdf))
                                 buf[i] = 0;
                         else
                                 buf[i] = data->data[off + i];
                 }
         } else {
                 memcpy(buf, &data->data[off], count);
         }
 
         return count;
 }
 
 static struct bin_attribute eeprom_attr = {
         .attr = {
                 .name = "eeprom",
                 .mode = S_IRUGO,
         },
         .size = EEPROM_SIZE,
         .read = eeprom_read,
 };
 
 /* Return 0 if detection is successful, -ENODEV otherwise */
 static int eeprom_detect(struct i2c_client *client, int kind,
                          struct i2c_board_info *info)
 {
         struct i2c_adapter *adapter = client->adapter;
 
         /* EDID EEPROMs are often 24C00 EEPROMs, which answer to all
            addresses 0x50-0x57, but we only care about 0x50. So decline
            attaching to addresses >= 0x51 on DDC buses */
         if (!(adapter->class & I2C_CLASS_SPD) && client->addr >= 0x51)
                 return -ENODEV;
 
         /* There are four ways we can read the EEPROM data:
            (1) I2C block reads (faster, but unsupported by most adapters)
            (2) Word reads (128% overhead)
            (3) Consecutive byte reads (88% overhead, unsafe)
            (4) Regular byte data reads (265% overhead)
            The third and fourth methods are not implemented by this driver
            because all known adapters support one of the first two. */
         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_WORD_DATA)
          && !i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
                 return -ENODEV;
 
         strlcpy(info->type, "eeprom", I2C_NAME_SIZE);
 
         return 0;
 }
 
 static int eeprom_probe(struct i2c_client *client,
                         const struct i2c_device_id *id)
 {
         struct i2c_adapter *adapter = client->adapter;
         struct eeprom_data *data;
         int err;
 
         if (!(data = kzalloc(sizeof(struct eeprom_data), GFP_KERNEL))) {
                 err = -ENOMEM;
                 goto exit;
         }
 
         memset(data->data, 0xff, EEPROM_SIZE);
         i2c_set_clientdata(client, data);
         mutex_init(&data->update_lock);
         data->nature = UNKNOWN;
 
         /* Detect the Vaio nature of EEPROMs.
            We use the "PCG-" or "VGN-" prefix as the signature. */
         if (client->addr == 0x57
          && i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA)) {
                 char name[4];
 
                 name[0] = i2c_smbus_read_byte_data(client, 0x80);
                 name[1] = i2c_smbus_read_byte_data(client, 0x81);
                 name[2] = i2c_smbus_read_byte_data(client, 0x82);
                 name[3] = i2c_smbus_read_byte_data(client, 0x83);
 
                 if (!memcmp(name, "PCG-", 4) || !memcmp(name, "VGN-", 4)) {
                         dev_info(&client->dev, "Vaio EEPROM detected, "
                                  "enabling privacy protection\n");
                         data->nature = VAIO;
                 }
         }
 
         /* create the sysfs eeprom file */
         err = sysfs_create_bin_file(&client->dev.kobj, &eeprom_attr);
         if (err)
                 goto exit_kfree;
 
         return 0;
 
 exit_kfree:
         kfree(data);
 exit:
         return err;
 }
 
 static int eeprom_remove(struct i2c_client *client)
 {
         sysfs_remove_bin_file(&client->dev.kobj, &eeprom_attr);
         kfree(i2c_get_clientdata(client));
 
         return 0;
 }
 
 static const struct i2c_device_id eeprom_id[] = {
         { "eeprom", 0 },
         { }
 };
 
 static struct i2c_driver eeprom_driver = {
         .driver = {
                 .name   = "eeprom",
         },
         .probe          = eeprom_probe,
         .remove         = eeprom_remove,
         .id_table       = eeprom_id,
 
         .class          = I2C_CLASS_DDC | I2C_CLASS_SPD,
         .detect         = eeprom_detect,
         .address_data   = &addr_data,
 };
 
 static int __init eeprom_init(void)
 {
         return i2c_add_driver(&eeprom_driver);
 }
 
 static void __exit eeprom_exit(void)
 {
         i2c_del_driver(&eeprom_driver);
 }
 
 
 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
                 "Philip Edelbrock <phil@netroedge.com> and "
                 "Greg Kroah-Hartman <greg@kroah.com>");
 MODULE_DESCRIPTION("I2C EEPROM driver");
 MODULE_LICENSE("GPL");
 
 module_init(eeprom_init);
 module_exit(eeprom_exit);