EBC Exercise 10 Flashing an LED
Embedded Linux Class by Mark A. Yoder
This page is for the Bone (Black or White) running the 3.8 Kernel. See EBC_Exercise_10_Flashing_an_LED_-_xM_WhiteBone for the White Bone or xM running 3.2.
The "Hello World" program is the traditional first program for many classes. Flashing an LED is the embedded equivalent. Here we will explore a few ways to flash and LED on the Beagle and explore General Purpose I/O (gpio) along the way. These calls will be done from the command line of the Beagle, so there is no need for the host computer.
- 1 gpio via the Shell Command Line and sysfs
- 2 Flashing the user LEDs
- 3 Adding your own LED
- 4 Reading a switch
- 5 Analog in
- 6 Assignment: gpio from the shell
- 7 Additional Exercises
- 8 Resources
gpio via the Shell Command Line and sysfs
(Note: Draw the new diagrams with this.)
The easiest way to do general purpose I/O (gpio) on the Beagle is through a terminal window and a shell prompt. In Linux, almost everything is treated as a file, even things that aren't files. In our class we'll use a virtual file system called sysfs. sysfs exposes the drivers for the hardware so you get easily use them.
Try this, open a terminal and type:
beagle$ cd /sys beagle$ ls -F block/ bus/ class/ dev/ devices/ firmware/ fs/ kernel/ module/ power/
Here we see several directories that represent hardware we can control. Explore a bit and see what you find.
beagle$ cd /sys/class beagle$ ls -F backlight/ firmware/ lcd/ mtd/ scsi_disk/ ubi/ bdi/ gpio/ leds/ net/ scsi_host/ udc/ block/ graphics/ mbox/ power_supply/ sound/ uio/ bluetooth/ hwmon/ mdio_bus/ regulator/ spi_master/ usbmon/ bsg/ i2c-adapter/ mem/ rfkill/ spidev/ vc/ dma/ i2c-dev/ misc/ rtc/ thermal/ vtconsole/ drm/ input/ mmc_host/ scsi_device/ tty/ watchdog/
Explore some. What do you find? In graphics you will see the frame buffer supported by the processor. In sound you'll see the alsa sound devices.
Flashing the user LEDs
The Beagle Black has four user LEDS, user0 - user3, that you can control. Try this:
beagle$ cd /sys/class/leds beagle$ ls -F beaglebone:green:usr0 beaglebone:green:usr2 beaglebone:green:usr1 beaglebone:green:usr3
Here you see the directories for controlling each of the usr LEDs. By default, usr0 flashes a heartbeat pattern and usr1 flashes when the micro SD card is accessed. Let's control usr0.
beagle$ cd beagleboard\:\:usr0 beagle$ ls -F brightness device@ max_brightness power/ subsystem@ trigger uevent
See what's in brightness, max_brightness and trigger by using the
cat command. For example:
beagle$ cat trigger none nand-disk mmc0 timer oneshot [heartbeat] backlight gpio cpu0 default-on transient
This shows trigger can have many values. The present value is heartbeat. Check the LED, is it beating? You can stop the heartbeat via:
beagle$ echo none > trigger beagle$ cat trigger [none] nand-disk mmc0 timer oneshot heartbeat backlight gpio cpu0 default-on transient
Did it stop beating? You can now turn it on and off with:
beagle$ echo 1 > brightness beagle$ echo 0 > brightness
Is it responding correctly?
The Bone has more trigger options. Try:
beagle$ cat trigger [none] mmc0 timer heartbeat backlight gpio default-on beagle$ echo timer > trigger beagle$ ls -F brightness delay_on max_brightness subsystem@ uevent delay_off device@ power/ trigger beagle$ echo 100 > delay_on beagle$ echo 900 > delay_off
What does this do?
Adding your own LED
It's not hard to use the gpio pins to control your own LED. All you need is an LED and a 220Ω resistor. Here's a picture of how it's wired. We are just doing the LED at the top of the breadboard for now.
So how do you know where to connect it? The BeagleBone System Reference Manual has the details. Figure 45 on page 74 shows:
There at two expansion headers, P8 and P9. Look at the bottom of the left header and you'll see it's labeled P9. Table 11 on page 78 shows the pinout for P9.
On the first photo above you can see that pin 1 (Ground) is wired to the - bus and pin 3 (3.3V) is wired to the + bus. The 220Ω resistor is wired to the - bus and the other end is attached to the negative lead of the LED. The positive lead is attached to pin 12 which, as shown in Table 11, is attached to gpio1_28. The gpio pins are in banks of 32 each, so to find the gpio number to use on the Beagle, use 1*32+28=60. Here's how you turn it on
beagle$ cd /sys/class/gpio beagle$ ls -F export gpiochip0@ gpiochip32@ gpiochip64@ gpiochip96@ unexport
Presently no gpio pins are visible. You need to tell it which pin to export
beagle$ echo 60 > export beagle$ ls -F export gpio60@ gpiochip0@ gpiochip32@ gpiochip64@ gpiochip96@ unexport
Notice gpio60 has appeared. All we need to do is tell it which direction and then turn it on.
beagle$ cd gpio60 beagle$ echo out > direction beagle$ echo 1 > value
Your LED should be on! When you are done you can unexport the pin and it will disappear.
beagle$ cd .. beagle$ echo 60 > unexport
Reading a switch
Now that you have an LED working, wiring in a switch is easy. The picture above shows a push button switch wired in at the bottom of the P9 header. Attach the + bus to one pole on the switch with a wire. The other end of the switch is attached to pin 42 which is gpio0_7.
Based on what you saw above, show how to read the switch.
Once you have the switch and LED working you can use the following scripts to play with them.
beagle$ cd ~/exercises/gpio beagle$ ./togglegpio.sh 60 0.1
The LED should be blinking on and off.
beagle$ ./readgpio.sh 7
Push the pushbutton and see what happens.
How can this work without a pulldown resistor? It turns out the Bone has an internal pulldown (and up) resistor that can be software enabled. We'll discuss how when we cover device trees.
- Can you modify the scripts above to read the switch and turn the LED on and off?
(This is based on this.)
The bone has eight Analog Inputs. Several are exposed on P9. They are labeled AIN in table 11 above. How many do you find?
The AIN pins are sampled at 12 bits and 100k samples per second. The input voltage is between 0 and 1.8V. Fortunately, both voltages are available on P9.
The photo above shows a small potentiometer wired to the bone. One end goes to the analog ground (pin 34), the other analog 1.8V (pin 32). The wiper is attached to AIN5 which is pin 36.
You interact with the analog in much like the gpio, but it appears in a different. We have to run a command before the AIN interface appears. Just run them now, later we'll explain what you did.
beagle$ SLOTS=/sys/devices/bone_capemgr.*/slots beagle$ PINS=/sys/kernel/debug/pinctrl/44e10800.pinmux/pins beagle$ echo cape-bone-iio > $SLOTS
You can now access the analog interface, but where do they appear. Try using the find command.
beagle$ find /sys -name "*AIN" ./devices/ocp.2/helper.14/AIN0 ./devices/ocp.2/helper.14/AIN1 ./devices/ocp.2/helper.14/AIN2 ./devices/ocp.2/helper.14/AIN3 ./devices/ocp.2/helper.14/AIN4 ./devices/ocp.2/helper.14/AIN5 ./devices/ocp.2/helper.14/AIN6 ./devices/ocp.2/helper.14/AIN7
You paths may be slightly different. Now explore.
beagle$ cd /sys/devices/ocp.2/helper.14 beagle$ ls -F AIN0 AIN2 AIN4 AIN6 driver@ power/ uevent AIN1 AIN3 AIN5 AIN7 modalias subsystem@
There are the various analog inputs, but watch out. This interface starts numbering at 1 and Table 11 starts at 0, so to read AIN5 you need to look at ain6!
beagle$ cat AIN6 1185
Change the pot and rerun cat. What's the min and max value you get? Is it 12 bits?
Rewrite the scripts from before to read an AIN pin and continuously display it's value.
Assignment: gpio from the shell
Measuring a gpio pin on an Oscilloscope
Get an oscilloscope so you can measure the output of your gpio pins. Run
beagle$ ./togglegpio.sh 60 0.1
and answer the following questions about gpio measurements.
- What's the min and max voltage?
- What period is it?
- How close is it to 100ms?
- Why do they differ?
- Run htop and see how much processor you are using.
- Try different values for the sleep time (2nd argument). What's the shortest period you can get? Make a table of the values you try and the corresponding period and processor usage.
- How stable is the period?
- Try launching something like mplayer. How stable is the period?
- Try cleaning up togglegpio.sh and removing unneeded lines. Does it impact the period?
- togglegpio uses bash (first line in file). Try using sh. Is the period shorter?
- What's the shortest period you can get?
Toggling the LEDs
Modify togglegpio (call it toggleLED) to toggle the LEDs. Can you get the LED to appear to dim by changing the duty cycle of the toggling?
User Button to gpio 130
Write a shell script that reads the User Button and outputs it value on gpio pin 130.
Count the User Button Presses
Write a shell script that displays a count of the number of times the User Button has been pressed.
Copy gpio 130 to gpio 131
Write a shell script that copies the value of gpio pin 130 to gpio pin 131. How much CPU time does it take? What's the delay from the time the input changes until the output changes? How constant is the delay?
Reading the Keyboard and Mouse
beagle$ cd /sys/class/input beagle$ ls -F beagle$ evtest /dev/input/event2 Hit ctrl-C to stop
Now move your mouse around, or try you keyboard. My mouse is plugged into the bottom left USB port and event2 responds to it. Where do your keyboard and mouse appear?
Reading the User Button
(Note: This may not work on some versions of the OS. In these versions another program is controlling the gpio port that the User button is attached to.)
It's attached to gpio port 4. You can read it via:
beagle$ cd /sys/class/gpio beagle$ ls -F export gpio133@ gpio137@ gpio141@ gpiochip160@ gpiochip96@ gpio130@ gpio134@ gpio138@ gpio162@ gpiochip192@ unexport gpio131@ gpio135@ gpio139@ gpiochip0@ gpiochip32@ gpio132@ gpio136@ gpio140@ gpiochip128@ gpiochip64@
Notice there is no gpio4. Here's how you can create it, set it to an input port and read its value:
beagle$ echo 4 > export beagle$ ls beagle$ cd gpio4 beagle$ echo in > direction beagle$ cat value
Try holding down the switch and doing
cat value again. Does the value change? There's a shell script called readgpio that repeatedly reads the switch.
beagle$ readgpio 4
Try pushing the switch. Does it work? Hit ctrl-C to stop. Look at readgpio. How does it work?
beagle$ which readgpio beagle$ cp /usr/bin/readgpio ~ beagle$ gedit ~/readgpio
- Here is wh1ts article on flashing an LED. It is referenced in the readgpio file that comes on the Beagle.
- This Make magazine article has a few more details.
- Here in a gpio reference for Linux in general. It includes sample 'C' code for flashing at 1 Hz.
- Here is a posting in the Beagle Google group about gpio.
- Here is some information about gpio from the kernel point of view.
- Here is some info on a GPIO Event Driver
- Here is info on how to set edge to falling and poll() the pin.
- Here is the kernel Documentation on gpio.
Embedded Linux Class by Mark A. Yoder