Skip to content

Commit

Permalink
Initial upload of the Patapata input device firmware.
Browse files Browse the repository at this point in the history
Moving Morse key files to mozc-morse/ directory.
  • Loading branch information
yamaguchi@google.com committed Apr 19, 2013
1 parent 661298a commit 2518500
Show file tree
Hide file tree
Showing 18 changed files with 1,312 additions and 3 deletions.
339 changes: 339 additions & 0 deletions mozc-flap/COPYING

Large diffs are not rendered by default.

122 changes: 122 additions & 0 deletions mozc-flap/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
#
# Copyright 2013 Google Inc.
#
# 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., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#


DEVICE = attiny2313
F_CPU = 12000000 # in Hz

AVRDUDE = avrdude -c usbasp -p $(DEVICE) # edit this line for your programmer

USBDRV_DIR = ../third_party/usbdrv

CFLAGS = -I$(USBDRV_DIR) -I. -DDEBUG_LEVEL=0


OBJECTS = $(USBDRV_DIR)/usbdrv.o $(USBDRV_DIR)/usbdrvasm.o $(USBDRV_DIR)/oddebug.o usb_keyboard.o flap.o

COMPILE = avr-gcc -Wall -Os -DF_CPU=$(F_CPU) $(CFLAGS) -mmcu=$(DEVICE)

FUSE_L = 0xef
FUSE_H = 0xdb
# ATTiny2313 FUSE_L (Fuse low byte):
# 0xef = 1 1 1 0 1 1 1 1
# ^ ^ \+/ \--+--/
# | | | +------- CKSEL 3..0 (clock selection -> crystal @ 12 MHz)
# | | +--------------- SUT 1..0 (BOD enabled, fast rising power)
# | +------------------ CKOUT (clock output on CKOUT pin -> disabled)
# +-------------------- CKDIV8 (divide clock by 8 -> don't divide)
# ATTiny2313 FUSE_H (Fuse high byte):
# 0xdb = 1 1 0 1 1 0 1 1
# ^ ^ ^ ^ \-+-/ ^
# | | | | | +---- RSTDISBL (disable external reset -> enabled)
# | | | | +-------- BODLEVEL 2..0 (brownout trigger level -> 2.7V)
# | | | +-------------- WDTON (watchdog timer always on -> disable)
# | | +---------------- SPIEN (enable serial programming -> enabled)
# | +------------------ EESAVE (preserve EEPROM on Chip Erase -> not preserved)
# +-------------------- DWEN (debug wire enable)


# symbolic targets:
help:
@echo "This Makefile has no default rule. Use one of the following:"
@echo "make hex ........... to build flap.hex"
@echo "make program ....... to flash fuses and the flap firmware"
@echo "make fuse .......... to flash the fuses"
@echo "make flash ......... to flash the flap firmware"
@echo "make clean ......... to delete objects and hex file"

hex: flap.hex

program: flash fuse

# rule for programming fuse bits:
fuse:
@[ "$(FUSE_H)" != "" -a "$(FUSE_L)" != "" ] || \
{ echo "*** Edit Makefile and choose values for FUSE_L and FUSE_H!"; exit 1; }
$(AVRDUDE) -U hfuse:w:$(FUSE_H):m -U lfuse:w:$(FUSE_L):m

# rule for uploading firmware:
flash: flap.hex
$(AVRDUDE) -U flash:w:flap.hex:i

# rule for deleting dependent files (those which can be built by Make):
clean:
rm -f flap.{hex,lst,obj,cof,list,map,eep.hex,elf,s} $(OBJECTS) $(USBDRV_DIR)/oddebug.s $(USBDRV_DIR)/usbdrv.s

# Generic rule for compiling C files:
.c.o:
$(COMPILE) -c $< -o $@

$(USBDRV_DIR)/usbdrvasm.o: $(USBDRV_DIR)/usbdrvasm.S \
$(USBDRV_DIR)/usbportability.h $(USBDRV_DIR)/usbdrv.h \
usbconfig.h $(USBDRV_DIR)/usbdrvasm12.inc \
$(USBDRV_DIR)/asmcommon.inc

$(USBDRV_DIR)/oddebug.o: $(USBDRV_DIR)/oddebug.c $(USBDRV_DIR)/oddebug.h \
$(USBDRV_DIR)/usbportability.h

$(USBDRV_DIR)/usbdrv.o: $(USBDRV_DIR)/usbdrv.c $(USBDRV_DIR)/usbportability.h \
$(USBDRV_DIR)/usbdrv.h usbconfig.h $(USBDRV_DIR)/oddebug.h

usb_keyboard.o: usb_keyboard.c usb_keyboard.h $(USBDRV_DIR)/usbdrv.h \
usbconfig.h $(USBDRV_DIR)/usbportability.h

flap.o: flap.c usbconfig.h usb_keyboard.h

# Generic rule for assembling Assembler source files:
.S.o:
$(COMPILE) -x assembler-with-cpp -c $< -o $@
# "-x assembler-with-cpp" should not be necessary since this is the default
# file type for the .S (with capital S) extension. However, upper case
# characters are not always preserved on Windows. To ensure WinAVR
# compatibility define the file type manually.

# Generic rule for compiling C to assembler, used for debugging only.
.c.s:
$(COMPILE) -S $< -o $@

# file targets:

flap.elf: $(OBJECTS)
$(COMPILE) -o flap.elf $(OBJECTS)

flap.hex: flap.elf
rm -f flap.hex flap.eep.hex
avr-objcopy -j .text -j .data -O ihex flap.elf flap.hex
avr-size flap.hex
106 changes: 106 additions & 0 deletions mozc-flap/Readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
Copyright 2013 Google Inc.

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., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.


=====================================
Summary
=====================================

Circuit diagram and firmware of split-flap display input device for
Google Japanese Input.


=====================================
Files
=====================================

* V-USB library files
../third_party/usbdrv/

The directory and files were copied from V-USB files available at
http://www.obdev.at/vusb/

* Documents
COPYING ...... Open Source license for this software.
Readme.txt ... The file you are currently reading.

* Circuit diagram
circuit.png

* Firmware source codes
Makefile
flap.c
usbconfig.h
usb_keyboard.c
usb_keyboard.h


=====================================
Building & Writing Firmware
=====================================

* Building firmware binaries

AVR-gcc is required.

$ make hex


* Writing to the program memory

Please refer documents of AVR programmer device you use.
Makefile contains "flash" rule that writes a hex file using Avrdude as an
example.


* Programming the fuse bits

Fuse bits must be configured in order to run the firmware correctly.

lower byte: 0xef
higher byte: 0xdb

# ATTiny2313 FUSE_L (Fuse low byte):
# 0xef = 1 1 1 0 1 1 1 1
# ^ ^ \+/ \--+--/
# | | | +------- CKSEL 3..0 (clock selection -> crystal @ 12 MHz)
# | | +--------------- SUT 1..0 (BOD enabled, fast rising power)
# | +------------------ CKOUT (clock output on CKOUT pin -> disabled)
# +-------------------- CKDIV8 (divide clock by 8 -> don't divide)
# ATTiny2313 FUSE_H (Fuse high byte):
# 0xdb = 1 1 0 1 1 0 1 1
# ^ ^ ^ ^ \-+-/ ^
# | | | | | +---- RSTDISBL (disable external reset -> enabled)
# | | | | +-------- BODLEVEL 2..0 (brownout trigger level -> 2.7V)
# | | | +-------------- WDTON (watchdog timer always on -> disable)
# | | +---------------- SPIEN (enable serial programming -> enabled)
# | +------------------ EESAVE (preserve EEPROM on Chip Erase
# | -> not preserved)
# +-------------------- DWEN (debug wire enable)

Makefile contains "fuse" rule that programs fuse bits using Avrdude as an
example.


==================
References
==================

The firmware and circuit diagram has been developed based on V-USB.

* V-USB
http://www.obdev.at/vusb/
Binary file added mozc-flap/circuit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2518500

Please sign in to comment.