Make LUFA for Arduino UNO / atmega16u2

Question

I have an Arduino Uno r3 board which has an atmega16u2 chip that normally contains the usb to serial firmware that allows the board to communicate with the IDE.

I have been learning how to flash that chip with different firmwares that let it act as other types of USB devices ( Keyboard / Mouse specifically ).

I have found some hex files that I can use online, but I am trying to learn how to build my own version of the keyboard and mouse hex files.

Here are the variables that I've set in the make file:

MCU = atmega16u2
ARCH = AVR8
BOARD = UNO
F_CPU = 16000000

the LUFA_PATH is set like this (I did not change it):

LUFA_PATH = ../../../..

When I save the makefile like this and try to run make all an error occurs:

../../../../LUFA/Drivers/Board/Joystick.h:119:31: error: Board/Joystick.h: No such file or directory

../../../../Common/Common.h: No such file or directory

../../../../LUFA/Drivers/Board/Buttons.h:135:30: error: Board/Buttons.h: No such file or directory

The weird part is that I can travel to the path that it states and those files do actually exist and are located there.

How do I need to set my LUFA makefile parameters in order to build for the atmega16u2 that is on the Arduino UNO rev3?

EDIT: These are the only steps that I've taken, which led to these errors.

• Download LUFA project zip.

• Travel to dir: C:\LUFA-111009\Demos\Device\ClassDriver\KeyboardMouse

• Open makefile in this directory.

• change the MCU, Board, and F_CPU speed to the values located above. (Arch is already set correctly)

• save make file

• Open cmd in this dir.

• Type "make all"

this process results in the above errors.

EDIT 2: Ok, I made blank Buttons.h, and Joystick.h and put them in the KeyboardMouse/Board/ folder. that got rid of the file not found errors but still gives me this:

KeyboardMouse.c: In function 'SetupHardware':
KeyboardMouse.c:111: warning: implicit declaration of function 'clock_prescale_s
et'
KeyboardMouse.c:111: error: 'clock_div_1' undeclared (first use in this function
)
KeyboardMouse.c:111: error: (Each undeclared identifier is reported only once
KeyboardMouse.c:111: error: for each function it appears in.)
KeyboardMouse.c:114: warning: implicit declaration of function 'Joystick_Init'
KeyboardMouse.c: In function 'CALLBACK_HID_Device_CreateHIDReport':
KeyboardMouse.c:174: warning: implicit declaration of function 'Joystick_GetStat
us'
KeyboardMouse.c:175: warning: implicit declaration of function 'Buttons_GetStatu
s'
KeyboardMouse.c:183: error: 'BUTTONS_BUTTON1' undeclared (first use in this func
tion)
KeyboardMouse.c:188: error: 'JOY_UP' undeclared (first use in this function)
KeyboardMouse.c:190: error: 'JOY_DOWN' undeclared (first use in this function)
KeyboardMouse.c:193: error: 'JOY_LEFT' undeclared (first use in this function)
KeyboardMouse.c:195: error: 'JOY_RIGHT' undeclared (first use in this function)
KeyboardMouse.c:198: error: 'JOY_PRESS' undeclared (first use in this function)
make: *** [KeyboardMouse.o] Error 1

Answer 1

As per my comment, you have specified UNO board, but it doesn't have Keyboard/Joystick required definitions for the board (I'm not sure if UNO has any buttons to be defined there, it only has Leds, and leds are defined in Led.h - check out \LUFA-111009\LUFA\Drivers\Board\AVR8\UNO)

So what you could do is to create Board folder under your KeyboardMouse and make empty files Joystick.h and Buttons.h there. This should get you going further. Errors you are seeing are due to the following code in \LUFA\Drivers\Board\Buttons.h

#if (BOARD == BOARD_NONE)
    #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
#elif (BOARD == BOARD_USBKEY)
    #include "AVR8/USBKEY/Buttons.h"
....
#else
    #include "Board/Buttons.h" <------ THIS IS EXECUTED SINCE UNO DOES NOT HAVE BUTTONS
#endif

So your error

../../../../LUFA/Drivers/Board/Joystick.h:119:31: error: Board/Joystick.h: No such file or directory

means that your folder structure and your LUFA configuration is correct, but you're missing file Buttons.h in your KeyboardMouse/Board/ folder. Got it?

Try what I've suggested and see how far you get. You can see how to define buttons in other Board's folders, for example in LUFA\Drivers\Board\AVR8\USBKEY\

EDIT Btw, I forgot to mention, error about common.h should go away hopefully after fixing this since that ........\ is coming from a file in a different location in folder structure thus confusion.

EDIT OK, so here's the link on how to build custom board drivers: http://www.fourwalledcubicle.com/files/LUFA/Doc/111009/html/page_writing_board_drivers.html

What you need to do is to copy files Buttons.h and Joystick.h LUFA\CodeTemplates\DriverStubs\ (or try copying Buttons.h and Joystick.h from USBKEY better, I think you still would need to specify a value for each definition otherwise) This should get rid of undefined errors. You have TODO sections in the files that you need to update.

OK, so I think I should also mention how this is supposed to be used before going further. These drivers/definitions are meant to be used in a specific manner in your code, and LUFA is unifying the approach for you. As far as I can tell, buttons are used in a following manner:

if (Buttons_GetStatus() & BUTTONS_BUTTON1){ ... do something when button 1 pressed....

This way, if you have several boards with at least one button, your code should theoretically stay the same across the boards. Similar stands for LEDs, you can use them like:

LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
....
LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);

I hope you get the picture. In order to use these library functions you have to define buttons/joystick/led specifics in their respective header files. So for example - in buttons.h you need to specify any custom header files you need, add port masks for buttons (on which pin of which port they are connected), specify port initialization and how to read the status of the buttons. You can find all of that in the USBKEY's buttons.h - e.g. it's importing common.h, defines BUTTONS_BUTTON1 like pin 2 of a port, initializes PortE with this button (so button is pin 2 on port E), and in Buttons_GetStatus it reads the status of the button.

I could go on and on in the same manner for joystick as well, but I hope you get the picture. Joystick is more involved but it's like having 4 buttons of which 0, 1 or 2 can be active at any time.

BTW, this is only useful if you have any buttons on your board. For example, I made keyboard driver without any buttons (I had to remove buttons specific code though). I used Ir Diode to read remote control codes and make the board act as keyboard. So you don't really need the buttons, nor the joystick (of course, it completely depends on what you're doing).

Answer 2

Making Arduino HID firmware for the r3 UNO should be basically the same as for the earlier UNO. Take a look at my blog for example code, firmware, and directions: Arduino Hacking (HID keyboard, mouse, joystick, and MIDI firmware).

Here's the meat of the post:

Build and install binutils for the AVR

wget ftp://sourceware.org/pub/binutils/releases/binutils-2.21.tar.bz2
tar xjf binutils-2.21.tar.bz2
cd binutils-2.21
mkdir build
cd build
../configure --target=avr
make
sudo make install
cd ../..

Build and install libgmp (needed for gcc-4.5.3)

wget ftp://ftp.gmplib.org/pub/gmp-5.0.2/gmp-5.0.2.tar.bz2
tar xjf gmp-5.0.2.tar.bz2
sudo apt-get install m4
cd gmp-5.0.2
./configure
make
sudo make install
cd ..

Install libmpfr and libmpc (needed for gcc-4.5.3)

sudo apt-get install libmpfr-dev
sudo apt-get install libmpc-dev

Build and install gcc-4.5.3 for AVR

wget ftp://ftp.mirrorservice.org/sites/sourceware.org/pub/gcc/releases/gcc-4.5.3/gcc-4.5.3.tar.bz2
tar xjf gcc-4.5.3.tar.bz2
cd gcc-4.5.3
mkdir build
cd build
CFLAGS="-g -O2" ../configure --target=avr --with-gcc --with-gnu-as --enable-languages=c,c++ --disable-nls --disable-libssp --with-dwarf2
make
sudo make install
cd ../..

Build and install avr-libc

wget http://download.savannah.gnu.org/releases/avr-libc/avr-libc-1.7.1.tar.bz2
tar xjf avr-libc-1.7.1.tar.bz2
cd avr-libc-1.7.1
mkdir build
cd build
CFLAGS=-Os ../configure --build=`../config.guess` --host=avr
make
sudo make install

Do a test build of Arduino-usbserial

The Arduino-usbserial firmware is the default firmware that the UNO comes installed with on its atmega8u2. It implements a serial interface over USB. Build this firmware to check that your avr-gcc toolchain and avr-libc are working.

cd Arduino/hardware/arduino/firmwares/arduino-usbserial

edit the makefile and make sure that MCU = atmega8u2 and ARDUINO_PID = 0x0001

make

You should have an newly built Arduino-usbserial.hex file.