EBC Exercise 12 I2C

This page is for the 3.8 kernel. See EBC Exercise 12 I2C - xM for the 3.2 kernel.

I²C is a "two-wire interface" standard that is used to attach low-speed peripherals to an embedded system. In this exercise we will wire up a couple of I²C temperature sensors (TC74) and learn how to read their values.

bone
The AM3359 on the BeagleBone has three I²C controllers (Section 21 of the TRM). You can see which ones are configured at boot time by running the following on the Beagle:

bone$ dmesg -H | grep i2c [ +0.001817] omap_i2c 44e0b000.i2c: could not find pctldev for node /ocp/l4_wkup@44c00000/scm@210000/pinmux@800/pinmux_i2c0_pins, deferring probe [ +0.001349] omap_i2c 4802a000.i2c: bus 1 rev0.11 at 100 kHz [ +0.002590] omap_i2c 4819c000.i2c: bus 2 rev0.11 at 100 kHz [ +0.002904] i2c /dev entries driver [ +0.000219] omap_i2c 44e0b000.i2c: bus 0 rev0.11 at 400 kHz [Sep 5 14:56] omap_i2c 4802a000.i2c: timeout waiting for bus ready [ +1.008030] omap_i2c 4802a000.i2c: timeout waiting for bus ready [ +1.008041] omap_i2c 4802a000.i2c: timeout waiting for bus ready

Here we see three buses, one running at 400 kHz and the other two at 100 kHz. Table 11 from the SRM shows buses 1 and 2 are brought out to the P9 Expansion Header. We'll use 2.

You can see what's on the i2c buses with bone$ i2cdetect -y -r 0 0 1  2  3  4  5  6  7  8  9  a  b  c  d  e  f 00:          -- -- -- -- -- -- -- -- -- -- -- -- -- 10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 20: -- -- -- -- UU -- -- -- -- -- -- -- -- -- -- -- 30: -- -- -- -- 34 -- -- -- -- -- -- -- -- -- -- -- 40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --  50: UU -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 70: -- -- -- -- -- -- -- --

bone$ i2cdetect -y -r 1 0 1  2  3  4  5  6  7  8  9  a  b  c  d  e  f 00:          -- -- ^C Hmmm... bus 1 is reading slowly. That means something isn't hooked up right on it.

bone$ i2cdetect -y -r 2 0 1  2  3  4  5  6  7  8  9  a  b  c  d  e  f 00:          -- -- -- -- -- -- -- -- -- -- -- -- -- 10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --  30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --  40: -- -- -- -- -- -- -- -- 48 -- 4a -- -- -- -- -- 50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --  70: -- -- -- -- -- -- -- --

I have something at addresses 0x48 and 0x4a on bus 2.



These signals are 3.3V and the TMP101 runs on 2.7 to 5.5V so we are in luck.

I²C is a two-wire bus. The two wires are
 * 1) Serial Clock (SCL), is an input to the TMP101 and is used to clock data into and out of the TMP101.
 * 2) Serial Data (SDA), is bidirectional and carries the data to and from the TMP101.

The only other two pins on the TMP101 that you need to use are the Power Supply (Vdd) and Ground, unless you want to use OS/ALERT, in which case you need to add a pull up resistor to Vdd, and then run another wire to a GPIO in order to properly trigger an interrupt.



Wire up the TMP101 to the Beagle by attaching the Vdd to the 3.3V + bus, the GND to the - bus and SDA to SDA (pin 20) and SCL to SCL (pin 19). You will also need to attach two pull-up resistors. Get two 4.7K&Omega; resistors. Attach one between SDA and Vdd. Attach the other between SCL and Vdd.

Your TMP101 should be labeled with T101. If you have another TMP101 you can wire it in parallel with the first be sure to wire the ADD0 pin differently. That is, attach SDA to SDA and SCL to SCL, etc. No need for additional pull up resistors.

From the Shell
The Beagle brings out I²C bus 1 to the Expansion Header. You can see what devices are on the bus by using the i2cdetect command. On your Beagle try:

bone$ i2cdetect -y -r 2 0 1  2  3  4  5  6  7  8  9  a  b  c  d  e  f 00:          -- -- -- -- -- -- -- -- -- -- -- -- -- 10: -- -- -- -- -- -- -- -- -- -- -- UU -- -- -- -- 20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --  40: -- -- -- -- -- -- -- -- 48 48 4a -- -- -- -- -- 50: -- -- -- -- UU UU UU UU -- -- -- -- -- -- -- -- 60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 70: -- -- -- -- -- -- -- --

What you see is a list of all the devices found on the bus. I've attached three TMP101's, and wired their ADD0 line differently. Their address are,   and   respectively. Converting to hex you get,   and. You can see the three appear in the ic2detect.

Each TMP101 has four registers. Check the TMP101 manual for details. We're interested in the TEMP register. You can read it with:

bone$ i2cget -y 2 0x48 0 0x1b

The -y says don't ask me, just do it. 2 says use bus 2. 0x48 is the device address and 0 is the register number. The value returned is the temperature in degrees C.
 * 1) Convert the hex temperature to decimal.  Is the value reasonable?
 * 2) Write a script to run ic2get in a loop and watch the temperature.  Hold the device between your fingers.  Does the temp go up?

via a kernel driver
The cleanest way to read the temperature from at TMP101 sensor is to use the kernel drive.

Assuming the TMP101 is on bus 2 (the last digit is the bus number)

bone$ cd /sys/class/i2c-adapter/i2c-2 bone$ ls -ls total 0 0 drwxr-xr-x 4 root root   0 Sep 20 15:40 2-0054 0 drwxr-xr-x 4 root root   0 Sep 20 15:40 2-0055 0 drwxr-xr-x 4 root root   0 Sep 20 15:40 2-0056 0 drwxr-xr-x 4 root root   0 Sep 20 15:40 2-0057 0 --w--- 1 root root 4096 Sep 20 15:40 delete_device 0 lrwxrwxrwx 1 root root   0 Sep 20 15:40 device -> ../../4819c000.i2c 0 drwxr-xr-x 3 root root   0 Sep 20 15:40 i2c-dev 0 -r--r--r-- 1 root root 4096 Sep 20 15:40 name 0 --w--- 1 root root 4096 Sep 20 15:40 new_device 0 lrwxrwxrwx 1 root root   0 Sep 20 15:40 of_node -> ../../../../../firmware/devicetree/base/ocp/i2c@4819c000 0 drwxr-xr-x 2 root root   0 Sep 20 15:40 power 0 lrwxrwxrwx 1 root root   0 Sep 20 15:40 subsystem -> ../../../../../bus/i2c 0 -rw-r--r-- 1 root root 4096 Sep 20 15:40 uevent

Unfortunately the group isn't set right. Fix it with.

bone$ sudo chgrp debian * bone$ sudo chmod g+w delete_device new_device bone$ ls -ls total 0 0 drwxr-xr-x 4 root debian   0 Sep 20 15:41 2-0054 0 drwxr-xr-x 4 root debian   0 Sep 20 15:41 2-0055 0 drwxr-xr-x 4 root debian   0 Sep 20 15:41 2-0056 0 drwxr-xr-x 4 root debian   0 Sep 20 15:41 2-0057 0 --w--w 1 root debian 4096 Sep 20 15:41 delete_device 0 lrwxrwxrwx 1 root root     0 Sep 20 15:41 device -> ../../4819c000.i2c 0 drwxr-xr-x 3 root debian   0 Sep 20 15:41 i2c-dev 0 -r--r--r-- 1 root debian 4096 Sep 20 15:41 name 0 --w--w 1 root debian 4096 Sep 20 15:41 new_device 0 lrwxrwxrwx 1 root root     0 Sep 20 15:41 of_node -> ../../../../../firmware/devicetree/base/ocp/i2c@4819c000 0 drwxr-xr-x 2 root debian   0 Sep 20 15:41 power 0 lrwxrwxrwx 1 root root     0 Sep 20 15:41 subsystem -> ../../../../../bus/i2c 0 -rw-r--r-- 1 root debian 4096 Sep 20 15:41 uevent Good, now we can write to it. Assuming the TMP101 is at address 0x48 bone$ echo tmp101 0x48 > new_device This tells the kernel you have a TMP101 sensor at address 0x48. Check the log to be sure. bone$ demsg -H | tail -3 [Sep20 13:21] systemd: 38 output lines suppressed due to ratelimiting [Sep20 15:42] i2c i2c-2: new_device: Instantiated device tmp101 at 0x48 [ +0.049729] lm75 2-0048: hwmon0: sensor 'tmp101'

Yes, it's there, now see what happened. bone$ ls 2-0048 2-0055  2-0057         device   name        of_node  subsystem 2-0054 2-0056  delete_device  i2c-dev  new_device  power    uevent Notice a new directory has appeared. It's for i2c bus 2, address 0x48. Look into it.

bone$ cd 2-0048/hwmon/hwmon0 bone$ ls -F device@ name  power/  subsystem@  temp1_input  temp1_max  temp1_max_hyst  uevent  update_interval bone$ cat temp1_input 24250 There is the temperature in milli-degrees C.

From C
Another approach to using I²C on the Beagle is from a C program. You can open  and do   calls on it to read and write data.

Pull the exercises bone$ cd exercises bone$ git pull bone$ cd i2c

Compile and run myi2cget.c.

bone$ make bone$ ./myi2cget Usage: ./myi2cget   bone$ ./myi2cget 2 72 0 0x1b (27)

It takes many of the arguments as i2cget, but none of the flags. It's very stripped down version of i2cget. Note that 72 is the decimal representation of 0x48. myi2cget requires the use of decimal numbers, while the "traiditional" i2cget can use either decimal or hex representations.

The original i2cget code came from here.

Challenge

 * 1) Look over myi2cget.
 * 2) Find the open which opens the device.
 * 3) Find the ioctl call that sets the address.  What other values can be used instead of  ?  Hint:  Look in the include files for the definition of I2C_SLAVE.
 * 4) Find the ioctl call reads the register.  Hint: There are a couple of wrappers hiding it. Find where i2c_smbus_read_byte_data is defined and then keep going until you find ioctl.  I2C_SLAVE is used by the previous ioctl to set the slave address.  What's used at the 2nd argument to ioctl to read a byte?
 * 5) Challenge 1:  Write a C program that will print the current temperature every time the USER button is pressed. Print the temp in F.
 * 6) Challenge 2:  Modify your program to update the temperature every second if the USER button isn't pressed.