From a2c24ff9fb1f2fc2e79ef01202ea7f0e43f81d49 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Fri, 16 Nov 2012 16:52:50 +0100 Subject: [PATCH] added first revision of firmware (proof of concept) --- src/Makefile | 444 +++++++++++++++++++++++++++++++++ src/avr-mem.sh | 26 ++ src/color.c | 88 +++++++ src/color.h | 45 ++++ src/main.c | 124 +++++++++ src/protocol.c | 15 ++ src/spi.c | 56 +++++ src/spi.h | 40 +++ src/strip.c | 47 ++++ src/strip.h | 15 ++ src/uart.c | 663 +++++++++++++++++++++++++++++++++++++++++++++++++ src/uart.h | 195 +++++++++++++++ 12 files changed, 1758 insertions(+) create mode 100644 src/Makefile create mode 100755 src/avr-mem.sh create mode 100644 src/color.c create mode 100644 src/color.h create mode 100644 src/main.c create mode 100644 src/protocol.c create mode 100644 src/spi.c create mode 100644 src/spi.h create mode 100644 src/strip.c create mode 100644 src/strip.h create mode 100644 src/uart.c create mode 100644 src/uart.h diff --git a/src/Makefile b/src/Makefile new file mode 100644 index 0000000..076d11f --- /dev/null +++ b/src/Makefile @@ -0,0 +1,444 @@ +# Hey Emacs, this is a -*- makefile -*- +#---------------------------------------------------------------------------- +# avr-gcc Makefile +# +# by Steffen Vogel +# +# Released to the Public Domain - Credits to: +# Eric B. Weddington, Jörg Wunsch, Peter Fleury, Tim Henigan Colin O'Flynn, +# Reiner Patommel, Markus Pfaff, Sander Pool, Frederik Rouleau, Carlos Lamas +#---------------------------------------------------------------------------- +# On command line: +# +# make all = Make software +# +# make clean = Clean out built project files +# +# make program = Download the hex file to the device, using avrdude +# Please customize the avrdude settings below first! +# +# make filename.s = Just compile filename.c into the assembler code only +# +# make filename.i = Create a preprocessed source file for use in submitting +# bug reports to the GCC project. +# +# To rebuild project do "make clean" then "make all". +#---------------------------------------------------------------------------- + +#------------------------------ General Options ----------------------------- +# MCU name +MCU = atmega644 + +# Processor frequency +# This will define a symbol, F_CPU, in all source code files equal to the +# processor frequency. You can then use this symbol in your source code to +# calculate timings. Do NOT tack on a 'UL' at the end, this will be done +# automatically to create a 32-bit value in your source code. +# Typical values are: +#F_CPU = 1000000 +#F_CPU = 1843200 +#F_CPU = 2000000 +#F_CPU = 3686400 +#F_CPU = 4000000 +#F_CPU = 7372800 +#F_CPU = 8000000 +#F_CPU = 11059200 +#F_CPU = 14745600 +F_CPU = 16000000 +#F_CPU = 18432000 +#F_CPU = 20000000 + +# Output format +#FORMAT = srec +#FORMAT = binary +FORMAT = ihex + +# Target file name (without extension) +TARGET = main + +# Object files directory +OBJDIR = obj + +# List C source files here (C dependencies are automatically generated) +SRC = $(TARGET).c color.c spi.c uart.c strip.c protocol.c + +# List C++ source files here (C dependencies are automatically generated) +CPPSRC = + +# List Assembler source files here +# Make them always end in a capital .S. Files ending in a lowercase .s +# will not be considered source files but generated files (assembler +# output from the compiler), and will be deleted upon "make clean"! +# Even though the DOS/Win* filesystem matches both .s and .S the same, +# it will preserve the spelling of the filenames, and gcc itself does +# are about how the name is spelled on its command-line. +ASRC = + +# Optimization level, can be [0, 1, 2, 3, ..., s] +# 0 = turn off optimization +# s = optimize for size +# (Note: 3 is not always the best optimization level. See avr-libc FAQ.) +OPT = s + +# Debugging format +# Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs. +# AVR Studio 4.10 requires dwarf-2. +# AVR [Extended] COFF format requires stabs, plus an avr-objcopy run. +DEBUG = dwarf-2 + +# List any extra directories to look for include files here. +# Each directory must be seperated by a space. +# Use forward slashes for directory separators. +# For a directory that has spaces, enclose it in quotes. +EXTRAINCDIRS = + +# Compiler flag to set the C Standard level +# c89 = "ANSI" C +# gnu89 = c89 plus GCC extensions +# c99 = ISO C99 standard (not yet fully implemented) +# gnu99 = c99 plus GCC extensions +CSTANDARD = -std=gnu99 + +# Place -D or -U options here for C sources +CDEFS = -DF_CPU=$(F_CPU)UL + +# Place -D or -U options here for C++ sources +#CPPDEFS += -D__STDC_LIMIT_MACROS +#CPPDEFS += -D__STDC_CONSTANT_MACROS +CPPDEFS = -DF_CPU=$(F_CPU)UL + +#------------------------------ Compiler Options ----------------------------- +# C Compiler Options +# -g generate debugging information +# -O optimization level +# -f tuning, see GCC manual and avr-libc documentation +# -Wall warning level +# -Wa tell GCC to pass this to the assembler. +# -adhlns create assembler listing +#CFLAGS = -g$(DEBUG) +#CFLAGS += -mint8 +#CFLAGS += -mshort-calls +#CFLAGS += -Wunreachable-code +#CFLAGS += -Wsign-compare +CFLAGS += -Wall +CFLAGS += -Wstrict-prototypes +CFLAGS += -Wundef +#CFLAGS += -fno-unit-at-a-time +CFLAGS += -funsigned-char +CFLAGS += -funsigned-bitfields +CFLAGS += -fpack-struct +CFLAGS += -fshort-enums +CFLAGS += $(CDEFS) +CFLAGS += -O$(OPT) +CFLAGS += -Wa,-adhlns=$(<:%.c=$(OBJDIR)/%.lst) +CFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS)) +CFLAGS += $(CSTANDARD) + +# C++ Compiler Options +# -g generate debugging information +# -O optimization level +# -f tuning, see GCC manual and avr-libc documentation +# -Wall warning level +# -Wa tell GCC to pass this to the assembler. +# -adhlns create assembler listing +#CPPFLAGS = -g$(DEBUG) +#CPPFLAGS += -mint8 +#CPPFLAGS += -mshort-calls +#CPPFLAGS += $(CSTANDARD) +#CPPFLAGS += -Wstrict-prototypes +#CPPFLAGS += -Wunreachable-code +#CPPFLAGS += -Wsign-compare +CPPFLAGS += -Wall +CFLAGS += -Wundef +#CPPFLAGS += -fno-unit-at-a-time +CPPFLAGS += -funsigned-char +CPPFLAGS += -funsigned-bitfields +CPPFLAGS += -fpack-struct +CPPFLAGS += -fshort-enums +CPPFLAGS += -fno-exceptions +CPPFLAGS += $(CPPDEFS) +CPPFLAGS += -O$(OPT) +CPPFLAGS += -Wa,-adhlns=$(<:%.cpp=$(OBJDIR)/%.lst) +CPPFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS)) + +# Assembler Options +# -Wa tell GCC to pass this to the assembler. +# -adhlms create listing +# -gstabs have the assembler create line number information; +# note that for use in COFF files, additional information +# about filenames and function names needs to be present +# in the assembler source files +ASFLAGS = -Wa,-adhlns=$(<:%.S=$(OBJDIR)/%.lst),-gstabs + + +#------------------------------ Library Options ------------------------------ +# Minimalistic printf version +PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min + +# Floating point printf version (requires MATH_LIB = -lm below) +PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt + +# If this is left blank, then it will use the Standard printf version. +#PRINTF_LIB = $(PRINTF_LIB_MIN) +#PRINTF_LIB = $(PRINTF_LIB_FLOAT) +PRINTF_LIB = + +# Minimalistic scanf version +SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min + +# Floating point + %[ scanf version (requires MATH_LIB = -lm below) +SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt + +# If this is left blank, then it will use the Standard scanf version. +#SCANF_LIB = $(SCANF_LIB_MIN) +#SCANF_LIB = $(SCANF_LIB_FLOAT) +SCANF_LIB = + +MATH_LIB = -lm + +#-------------------------- External Memory Options -------------------------- +# 64 KB of external RAM, starting after internal RAM (ATmega128!), +# used for variables (.data/.bss) and heap (malloc()). +#EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff + +# 64 KB of external RAM, starting after internal RAM (ATmega128!), +# only used for heap (malloc()). +#EXTMEMOPTS = -Wl,--defsym=__heap_start=0x801100,--defsym=__heap_end=0x80ffff +EXTMEMOPTS = + + +#------------------------------- Linker Options ------------------------------ +# -Wl tell GCC to pass this to linker. +# -Map create map file +# --cref add cross reference to map file +LDFLAGS = -Wl,-Map=$(TARGET).map,--cref +LDFLAGS += $(EXTMEMOPTS) +LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB) + + +#------------------------ Programmer Options (avrdude) ----------------------- +# Programmer hardware +# avr910 +# avrisp +# arduino +# picoweb +# pony-stk200 +# stk200 +# stk500 +# "avrdude -c ?" to get a full listing +#AVRDUDE_PROGRAMMER = avr910 +#AVRDUDE_PROGRAMMER = arduino +AVRDUDE_PROGRAMMER = avrisp2 +#AVRDUDE_PROGRAMMER = usbasp + +# The port your programmer is connected to +#AVRDUDE_PORT = /dev/ttyUSB0 +#AVRDUDE_PORT = /dev/ttyS0 +#AVRDUDE_PORT = /dev/ttyACM0 +AVRDUDE_PORT = usb + +AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex +#AVRDUDE_WRITE_EEPROM = -U eeprom:w:$(TARGET).eep + +# Uncomment the following if you want avrdude's erase cycle counter. +# Note that this counter needs to be initialized first using -Yn, +# see avrdude manual. +#AVRDUDE_ERASE_COUNTER = -y + +# Uncomment the following if you do /not/ wish a verification to be +# performed after programming the device. +#AVRDUDE_NO_VERIFY = -V + +# Increase verbosity level +#AVRDUDE_VERBOSE = -v -v + +AVRDUDE_FLAGS = -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER) +AVRDUDE_FLAGS += $(AVRDUDE_NO_VERIFY) +AVRDUDE_FLAGS += $(AVRDUDE_VERBOSE) +AVRDUDE_FLAGS += $(AVRDUDE_ERASE_COUNTER) + + +#=========================== End of Configuration =========================== +# Define programs and commands. +SHELL = bash +CC = avr-gcc +OBJCOPY = avr-objcopy +OBJDUMP = avr-objdump +SIZE = avr-size +NM = avr-nm +AVRDUDE = avrdude +REMOVE = rm -f +REMOVEDIR = rm -rf +COPY = cp + +# Define messages (english) +MSG_ERRORS_NONE = Errors: none +MSG_SIZE_BEFORE = Size before: +MSG_SIZE_AFTER = Size after: +MSG_FLASH = Creating load file for Flash: +MSG_EEPROM = Creating load file for EEPROM: +MSG_BINARY = Creating binary: +MSG_EXTENDED_LISTING = Creating Extended Listing: +MSG_SYMBOL_TABLE = Creating Symbol Table: +MSG_LINKING = Linking: +MSG_COMPILING = Compiling C: +MSG_COMPILING_CPP = Compiling C++: +MSG_ASSEMBLING = Assembling: +MSG_CLEANING = Cleaning project: +MSG_CREATING_LIBRARY = Creating library: +MSG_PROGRAM = Flashing controller: + +# Define all object files +OBJ = $(SRC:%.c=$(OBJDIR)/%.o) $(CPPSRC:%.cpp=$(OBJDIR)/%.o) $(ASRC:%.S=$(OBJDIR)/%.o) + +# Define all listing files +LST = $(SRC:%.c=$(OBJDIR)/%.lst) $(CPPSRC:%.cpp=$(OBJDIR)/%.lst) $(ASRC:%.S=$(OBJDIR)/%.lst) + +# Compiler flags to generate dependency files +GENDEPFLAGS = -MD -MP -MF .dep/$(@F).d + +# Combine all necessary flags and optional flags +# Add target processor to flags +ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS) +ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS) +ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS) + +# Default target +all: gccversion sizebefore build sizeafter + +# Change the build target to build a HEX file or a library +build: elf hex eep bin lss sym +#build: lib +#LIBNAME=lib$(TARGET).a + +elf: $(TARGET).elf +hex: $(TARGET).hex +eep: $(TARGET).eep +bin: $(TARGET).bin +lss: $(TARGET).lss +sym: $(TARGET).sym +lib: $(LIBNAME) + +# Display size of file +HEXSIZE = $(SIZE) --target=$(FORMAT) $(TARGET).hex +ELFSIZE = $(SIZE) -A $(TARGET).elf + +sizebefore: + @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_BEFORE); $(ELFSIZE); \ + $(SHELL) avr-mem.sh $(TARGET) $(MCU); fi + +sizeafter: + @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_AFTER); $(ELFSIZE); \ + $(SHELL) avr-mem.sh $(TARGET) $(MCU); fi + +# Display compiler version information +gccversion: + @$(CC) --version + +# Program the device +program: $(TARGET).hex $(TARGET).eep + @echo $(MSG_PROGRAM) + @echo + $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) + $(AVRDUDE_WRITE_EEPROM) + +# Create final output files (.hex, .eep) from ELF output file +%.hex: %.elf + @echo + @echo $(MSG_FLASH) $@ + $(OBJCOPY) -O $(FORMAT) -R .eeprom $< $@ + +%.eep: %.elf + @echo + @echo $(MSG_EEPROM) $@ + $(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \ +--change-section-lma .eeprom=0 -O $(FORMAT) $< $@ + +# Create binary output +%.bin: %.elf + @echo + @echo $(MSG_BINARY) $@ + $(OBJCOPY) $(TARGET).elf -O binary $(TARGET).bin + +# Create extended listing file from ELF output file +%.lss: %.elf + @echo + @echo $(MSG_EXTENDED_LISTING) $@ + $(OBJDUMP) -h -S $< > $@ + +# Create a symbol table from ELF output file +%.sym: %.elf + @echo + @echo $(MSG_SYMBOL_TABLE) $@ + $(NM) -n $< > $@ + +# Create library from object files +.SECONDARY: $(TARGET).a +.PRECIOUS: $(OBJ) +%.a: $(OBJ) + @echo + @echo $(MSG_CREATING_LIBRARY) $@ + $(AR) $@ $(OBJ) + +# Link: create ELF output file from object files +.SECONDARY : $(TARGET).elf +.PRECIOUS : $(OBJ) +%.elf: $(OBJ) + @echo + @echo $(MSG_LINKING) $@ + $(CC) $(ALL_CFLAGS) $^ -o $@ $(LDFLAGS) + +# Compile: create object files from C source files +$(OBJDIR)/%.o : %.c + @echo $(MSG_COMPILING) $< + $(CC) -c $(ALL_CFLAGS) $< -o $@ + +# Compile: create object files from C++ source files +$(OBJDIR)/%.o : %.cpp + @echo + @echo $(MSG_COMPILING_CPP) $< + $(CC) -c $(ALL_CPPFLAGS) $< -o $@ + +# Compile: create assembler files from C source files +%.s : %.c + $(CC) -S $(ALL_CFLAGS) $< -o $@ + +# Compile: create assembler files from C++ source files +%.s : %.cpp + $(CC) -S $(ALL_CPPFLAGS) $< -o $@ + +# Assemble: create object files from assembler source files +$(OBJDIR)/%.o : %.S + @echo + @echo $(MSG_ASSEMBLING) $< + $(CC) -c $(ALL_ASFLAGS) $< -o $@ + +# Create preprocessed source for use in sending a bug report +%.i : %.c + $(CC) -E -mmcu=$(MCU) -I. $(CFLAGS) $< -o $@ + +# Clean project +clean: + @echo $(MSG_CLEANING) + $(REMOVE) $(TARGET).hex + $(REMOVE) $(TARGET).bin + $(REMOVE) $(TARGET).eep + $(REMOVE) $(TARGET).elf + $(REMOVE) $(TARGET).map + $(REMOVE) $(TARGET).sym + $(REMOVE) $(TARGET).lss + $(REMOVEDIR) $(OBJDIR) + $(REMOVE) $(SRC:.c=.s) + $(REMOVE) $(SRC:.c=.d) + $(REMOVEDIR) .dep + +# Create object files directory + mkdir $(OBJDIR) + +# Include the dependency files +-include $(shell mkdir .dep 2>/dev/null) $(wildcard .dep/*) + +# Listing of phony targets +.PHONY: all finish sizebefore sizeafter gccversion \ +build elf hex eep lss sym \ +clean program diff --git a/src/avr-mem.sh b/src/avr-mem.sh new file mode 100755 index 0000000..2e89d0d --- /dev/null +++ b/src/avr-mem.sh @@ -0,0 +1,26 @@ +#!/bin/bash +MAXPERCENT=40 +IMAGESIZE=$(ls -l $1.bin | awk '{ print $5 }') +FLASHSIZE=$(perl -e "print 0x$(echo -e "#include \nFLASHEND" | avr-cpp -mmcu=$2 | tail -n 1 |cut -c3-);") +FLASHSIZE=$[$FLASHSIZE + 1] +PERCENT=$(perl -e "printf('%.2f', $IMAGESIZE.0 / $FLASHSIZE.0 *100.0);" ) +PER=$(perl -e "printf('%i', $IMAGESIZE / $FLASHSIZE *$MAXPERCENT);" ) + +echo "Imagesize: $IMAGESIZE/$FLASHSIZE bytes (${PERCENT}%)" +if [ $IMAGESIZE -gt $FLASHSIZE ];then + echo " WARNING! Your Image is too big for the selected chip. WARNING!" + echo "" + exit 1 +else + echo -n " [" + COUNTER=0 + while [ $COUNTER -lt $MAXPERCENT ]; do + if [ $COUNTER -lt $PER ]; then + echo -n "=" + else + echo -n "-" + fi + let COUNTER=COUNTER+1 + done + echo "]" +fi diff --git a/src/color.c b/src/color.c new file mode 100644 index 0000000..e86f9ee --- /dev/null +++ b/src/color.c @@ -0,0 +1,88 @@ +/** + * Color Types + * + * @copyright 2012 Steffen Vogel + * @license http://www.gnu.org/licenses/gpl.txt GNU Public License + * @author Steffen Vogel + * @link http://www.steffenvogel.de + */ +/* + * This file is part of fnordstripe + * + * fnordstripe 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 3 of the License, or + * any later version. + * + * fnordstripe 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 fnordstripe. If not, see . + */ + +#include + +#include "color.h" + +/** + * convert hsv to rgb color + * (see http://en.wikipedia.org/wiki/HSL_and_HSV#Conversion_from_HSV_to_RGB + * and http://www.enide.net/webcms/uploads/file/projects/powerpicrgb-irda/hsvspace.pdf) + */ +struct rgb_color hsv2rgb(struct hsv_color hsv) { + struct rgb_color rgb; + + if (hsv.saturation == 0) { + rgb.red = hsv.value; + rgb.green = hsv.value; + rgb.blue = hsv.value; + } + else { + hsv.hue %= 360; + + uint16_t f = ((hsv.hue % 60) * 255 + 30) / 60; + uint16_t p = (hsv.value * (255 - hsv.saturation)+128)/255; + uint16_t q = ((hsv.value * (255 - (hsv.saturation * f + 128)/255)) + 128) / 255; + uint16_t t = (hsv.value * (255 - ((hsv.saturation * (255 - f)) / 255))) / 255; + + uint8_t i = hsv.hue / 60; + + switch (i) { + case 0: + rgb.red = hsv.value; + rgb.green = t; + rgb.blue = p; + break; + case 1: + rgb.red = q; + rgb.green = hsv.value; + rgb.blue = p; + break; + case 2: + rgb.red = p; + rgb.green = hsv.value; + rgb.blue = t; + break; + case 3: + rgb.red = p; + rgb.green = q; + rgb.blue = hsv.value; + break; + case 4: + rgb.red = t; + rgb.green = p; + rgb.blue = hsv.value; + break; + case 5: + rgb.red = hsv.value; + rgb.green = p; + rgb.blue = q; + break; + } + } + + return rgb; +} diff --git a/src/color.h b/src/color.h new file mode 100644 index 0000000..51d5c50 --- /dev/null +++ b/src/color.h @@ -0,0 +1,45 @@ +/** + * Color Types + * + * @copyright 2012 Steffen Vogel + * @license http://www.gnu.org/licenses/gpl.txt GNU Public License + * @author Steffen Vogel + * @link http://www.steffenvogel.de + */ +/* + * This file is part of fnordstripe + * + * fnordstripe 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 3 of the License, or + * any later version. + * + * fnordstripe 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 fnordstripe. If not, see . + */ + +#ifndef _COLOR_H_ +#define _COLOR_H_ + +#include + +struct rgb_color { + uint8_t blue; + uint8_t green; + uint8_t red; +}; + +struct hsv_color { + uint16_t hue; + uint8_t saturation; + uint8_t value; +}; + +struct rgb_color hsv2rgb(struct hsv_color hsv); + +#endif /* _COLOR_H_ */ diff --git a/src/main.c b/src/main.c new file mode 100644 index 0000000..ce2e9b6 --- /dev/null +++ b/src/main.c @@ -0,0 +1,124 @@ +/** + * Main Routine + * + * @copyright 2012 Steffen Vogel + * @license http://www.gnu.org/licenses/gpl.txt GNU Public License + * @author Steffen Vogel + * @link http://www.steffenvogel.de + */ +/* + * This file is part of fnordstripe + * + * fnordstripe 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 3 of the License, or + * any later version. + * + * fnordstripe 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 fnordstripe. If not, see . + */ + +#include +#include +#include +#include + +#include "spi.h" +#include "strip.h" +#include "color.h" +#include "uart.h" + +#define BAUDRATE 9600 + +void timer_init() { + TCCR0B |= (1 << CS01) | (1 << CS00); /* F_CPU / 64 = 250kHz */ + TIMSK0 |= (1 << TOIE0); +} + +/* ~ 1kHz */ +ISR(TIMER0_OVF_vect ) { + strip_update(); +} + +int main(void) { + /* init serial interface */ + uart_init(UART_BAUD_SELECT(BAUDRATE, F_CPU)); + + /* init spi interface */ + spi_init(); + + /* initialize LEDs */ + strip_init(); + + timer_init(); + + /* enable interrupts */ + sei(); + + /* motd */ + uart_puts_P("\r\n\r\nfnordstripe 0.1\r\n"); + + struct hsv_color hsvd, hsv = { + .hue = 70, + .saturation = 0xff, + .value = 0xff + }; + + enum mode { HUE, SAT, VAL } m = HUE; + char buf[32]; + + while (1) { + uint16_t r = uart_getc(); + char c = r & 0xff; + + if (r & UART_NO_DATA) { + hsv.hue++; + hsv.hue %= 360; + + for (uint8_t i = 0; i < DOTS; i++) { + hsvd = hsv; + hsvd.hue += 7*i; + hsvd.hue %= 360; + + cli(); + strip_setdot(hsv2rgb(hsvd), i); + sei(); + } + _delay_ms(1); + } + else if (r & 0xff00) { + uart_puts_P("error\r\n"); + } + else if ( c == 'h' ) m = HUE; + else if ( c == 'v' ) m = VAL; + else if ( c == 's' ) m = SAT; + else if ( c >= '0' && c <= '9') { + switch (m) { + case HUE: + hsv.hue = (c - '0') * 36; + sprintf(buf, "ok, hue: %d\r\n", hsv.hue); + break; + case SAT: + hsv.saturation = (c- '0') * 25; + sprintf(buf, "ok, saturation: %d\r\n", hsv.saturation); + break; + case VAL: + hsv.value = (c- '0') * 25; + sprintf(buf, "ok, value: %d\r\n", hsv.value); + break; + } + + uart_puts(buf); + } + else { + uart_putc(c); + } + } + + return 0; +} diff --git a/src/protocol.c b/src/protocol.c new file mode 100644 index 0000000..ee01538 --- /dev/null +++ b/src/protocol.c @@ -0,0 +1,15 @@ +/*void parse_message(uint8_t *data) { + struct remote_msg_t *msg = (struct remote_msg_t *) data; + + switch (msg->cmd) { + case REMOTE_CMD_FADE_RGB: + + break; + case REMOTE_CMD_FADE_HSV: + + break; + + default: + // others are not supported yet + } +}*/ diff --git a/src/spi.c b/src/spi.c new file mode 100644 index 0000000..a8cd327 --- /dev/null +++ b/src/spi.c @@ -0,0 +1,56 @@ +/** + * SPI Routines + * + * @copyright 2012 Steffen Vogel + * @license http://www.gnu.org/licenses/gpl.txt GNU Public License + * @author Steffen Vogel + * @link http://www.steffenvogel.de + */ +/* + * This file is part of fnordstripe + * + * fnordstripe 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 3 of the License, or + * any later version. + * + * fnordstripe 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 fnordstripe. If not, see . + */ + +#include + +#include + +#include "spi.h" + +void spi_init(void) { + /* enable pins */ + SPI_DDR |= (1 << SPI_MOSI) | (1 << SPI_SCK) | (1 << SPI_SS); + SPI_PORT |= (1 << SPI_SS); + + SPCR = 0; + SPCR |= (1 << SPE); /* SPI enable */ + SPCR |= (1 << SPIE); /* SPI interrupt enable */ + SPCR |= (1 << MSTR); /* SPI mode */ + + /* set SPI rate */ + SPSR |= (1 << SPI2X); /* double speed (F_CPU / 2) */ +} + +void spi_send(uint8_t byte) { + SPDR = byte; /* start transmission */ + while (!(SPSR & (1 << SPIF))); /* wait for transmission complete */ +} + +void spi_sends(uint8_t *data, uint8_t len) { + for (uint8_t i = 0; i < len; i++) { + SPDR = data[i]; /* start transmission */ + while (!(SPSR & (1 << SPIF))); /* wait for transmission complete */ + } +} diff --git a/src/spi.h b/src/spi.h new file mode 100644 index 0000000..2eb1f9d --- /dev/null +++ b/src/spi.h @@ -0,0 +1,40 @@ +/** + * SPI Routines + * + * @copyright 2012 Steffen Vogel + * @license http://www.gnu.org/licenses/gpl.txt GNU Public License + * @author Steffen Vogel + * @link http://www.steffenvogel.de + */ +/* + * This file is part of fnordstripe + * + * fnordstripe 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 3 of the License, or + * any later version. + * + * fnordstripe 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 fnordstripe. If not, see . + */ + +#ifndef _SPI_H_ +#define _SPI_H_ + +#define SPI_DDR DDRB +#define SPI_PORT PORTB + +#define SPI_MOSI PB5 +#define SPI_SCK PB7 +#define SPI_SS PB4 + +void spi_init(void); +void spi_send(uint8_t byte); +void spi_sends(uint8_t *data, uint8_t len); + +#endif /* _SPI_H_ */ diff --git a/src/strip.c b/src/strip.c new file mode 100644 index 0000000..afb2c50 --- /dev/null +++ b/src/strip.c @@ -0,0 +1,47 @@ +#include +#include + +#include "strip.h" + +volatile dot_t dots[DOTS+2]; + +void strip_init(void) { + for (uint8_t i = 0; i < DOTS+4; i++) { + dots[i] = 0; /* all black */ + } + + strip_update(); /* trigger first update */ +} + +void strip_setdot(struct rgb_color rgb, uint8_t pos) { + dots[pos] = strip_rgbtodot(rgb); +} + +uint16_t strip_rgbtodot(struct rgb_color rgb) { + uint8_t a = (1 << 7) | ((rgb.blue & 0xF8) >> 1) | ((rgb.red & 0xC0) >> 6); + uint8_t b = ((rgb.red & 0x38) << 2) | ((rgb.green & 0xF8) >> 3); + + return a | (b << 8); +} + +void strip_update(void) { + static uint8_t pos = 0; + static uint8_t sync = 4; + + if (sync) { /* send synchronisation */ + SPDR = 0x00; + sync--; + } + else if (pos < sizeof(dots)) { /* send data */ + SPDR = *((uint8_t *) dots+pos); + pos++; + } + else { /* update finished */ + pos = 0; + sync = 4; + } +} + +ISR(SPI_STC_vect) { + strip_update(); +} diff --git a/src/strip.h b/src/strip.h new file mode 100644 index 0000000..73990d7 --- /dev/null +++ b/src/strip.h @@ -0,0 +1,15 @@ +#ifndef _STRIP_H_ +#define _STRIP_H_ + +#include "color.h" + +#define DOTS 50 + +typedef uint16_t dot_t; + +void strip_init(void); +void strip_update(void); +void strip_setdot(struct rgb_color rgb, uint8_t pos); +uint16_t strip_rgbtodot(struct rgb_color rgb); + +#endif /* _STRIP_H_ */ diff --git a/src/uart.c b/src/uart.c new file mode 100644 index 0000000..ab1fb89 --- /dev/null +++ b/src/uart.c @@ -0,0 +1,663 @@ +/************************************************************************* +Title: Interrupt UART library with receive/transmit circular buffers +Author: Peter Fleury http://jump.to/fleury +File: $Id: uart.c,v 1.9 2012/11/10 12:59:31 peter Exp $ +Software: AVR-GCC 4.1, AVR Libc 1.4.6 or higher +Hardware: any AVR with built-in UART, +License: GNU General Public License + +DESCRIPTION: + An interrupt is generated when the UART has finished transmitting or + receiving a byte. The interrupt handling routines use circular buffers + for buffering received and transmitted data. + + The UART_RX_BUFFER_SIZE and UART_TX_BUFFER_SIZE variables define + the buffer size in bytes. Note that these variables must be a + power of 2. + +USAGE: + Refere to the header file uart.h for a description of the routines. + See also example test_uart.c. + +NOTES: + Based on Atmel Application Note AVR306 + +LICENSE: + Copyright (C) 2006 Peter Fleury + + 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 + 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. + +*************************************************************************/ +#include +#include +#include +#include "uart.h" + + +/* + * constants and macros + */ + +/* size of RX/TX buffers */ +#define UART_RX_BUFFER_MASK ( UART_RX_BUFFER_SIZE - 1) +#define UART_TX_BUFFER_MASK ( UART_TX_BUFFER_SIZE - 1) + +#if ( UART_RX_BUFFER_SIZE & UART_RX_BUFFER_MASK ) +#error RX buffer size is not a power of 2 +#endif +#if ( UART_TX_BUFFER_SIZE & UART_TX_BUFFER_MASK ) +#error TX buffer size is not a power of 2 +#endif + +#if defined(__AVR_AT90S2313__) \ + || defined(__AVR_AT90S4414__) || defined(__AVR_AT90S4434__) \ + || defined(__AVR_AT90S8515__) || defined(__AVR_AT90S8535__) \ + || defined(__AVR_ATmega103__) + /* old AVR classic or ATmega103 with one UART */ + #define AT90_UART + #define UART0_RECEIVE_INTERRUPT UART_RX_vect + #define UART0_TRANSMIT_INTERRUPT UART_UDRE_vect + #define UART0_STATUS USR + #define UART0_CONTROL UCR + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined(__AVR_AT90S2333__) || defined(__AVR_AT90S4433__) + /* old AVR classic with one UART */ + #define AT90_UART + #define UART0_RECEIVE_INTERRUPT UART_RX_vect + #define UART0_TRANSMIT_INTERRUPT UART_UDRE_vect + #define UART0_STATUS UCSRA + #define UART0_CONTROL UCSRB + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined(__AVR_ATmega8__) || defined(__AVR_ATmega16__) || defined(__AVR_ATmega32__) \ + || defined(__AVR_ATmega323__) + /* ATmega with one USART */ + #define ATMEGA_USART + #define UART0_RECEIVE_INTERRUPT USART_RXC_vect + #define UART0_TRANSMIT_INTERRUPT USART_UDRE_vect + #define UART0_STATUS UCSRA + #define UART0_CONTROL UCSRB + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined (__AVR_ATmega8515__) || defined(__AVR_ATmega8535__) + #define ATMEGA_USART + #define UART0_RECEIVE_INTERRUPT USART_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART_UDRE_vect + #define UART0_STATUS UCSRA + #define UART0_CONTROL UCSRB + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined(__AVR_ATmega163__) + /* ATmega163 with one UART */ + #define ATMEGA_UART + #define UART0_RECEIVE_INTERRUPT UART_RX_vect + #define UART0_TRANSMIT_INTERRUPT UART_UDRE_vect + #define UART0_STATUS UCSRA + #define UART0_CONTROL UCSRB + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined(__AVR_ATmega162__) + /* ATmega with two USART */ + #define ATMEGA_USART0 + #define ATMEGA_USART1 + #define UART0_RECEIVE_INTERRUPT USART0_RXC_vect + #define UART1_RECEIVE_INTERRUPT USART1_RXC_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART1_TRANSMIT_INTERRUPT USART1_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 + #define UART1_STATUS UCSR1A + #define UART1_CONTROL UCSR1B + #define UART1_DATA UDR1 + #define UART1_UDRIE UDRIE1 +#elif defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) + /* ATmega with two USART */ + #define ATMEGA_USART0 + #define ATMEGA_USART1 + #define UART0_RECEIVE_INTERRUPT USART0_RX_vect + #define UART1_RECEIVE_INTERRUPT USART1_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART1_TRANSMIT_INTERRUPT USART1_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 + #define UART1_STATUS UCSR1A + #define UART1_CONTROL UCSR1B + #define UART1_DATA UDR1 + #define UART1_UDRIE UDRIE1 +#elif defined(__AVR_ATmega161__) + /* ATmega with UART */ + #error "AVR ATmega161 currently not supported by this libaray !" +#elif defined(__AVR_ATmega169__) + /* ATmega with one USART */ + #define ATMEGA_USART + #define UART0_RECEIVE_INTERRUPT USART0_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART0_STATUS UCSRA + #define UART0_CONTROL UCSRB + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined(__AVR_ATmega48__) || defined(__AVR_ATmega88__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega48P__) || defined(__AVR_ATmega88P__) || defined(__AVR_ATmega168P__) || defined(__AVR_ATmega328P__) \ + || defined(__AVR_ATmega3250__) || defined(__AVR_ATmega3290__) ||defined(__AVR_ATmega6450__) || defined(__AVR_ATmega6490__) + /* ATmega with one USART */ + #define ATMEGA_USART0 + #define UART0_RECEIVE_INTERRUPT USART_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 +#elif defined(__AVR_ATtiny2313__) + #define ATMEGA_USART + #define UART0_RECEIVE_INTERRUPT USART_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART_UDRE_vect + #define UART0_STATUS UCSRA + #define UART0_CONTROL UCSRB + #define UART0_DATA UDR + #define UART0_UDRIE UDRIE +#elif defined(__AVR_ATmega329__) || \ + defined(__AVR_ATmega649__) || \ + defined(__AVR_ATmega325__) || \ + defined(__AVR_ATmega645__) + /* ATmega with one USART */ + #define ATMEGA_USART0 + #define UART0_RECEIVE_INTERRUPT USART0_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 +#elif defined(__AVR_ATmega2560__) || defined(__AVR_ATmega2561__) || defined(__AVR_ATmega1280__) || defined(__AVR_ATmega1281__) || defined(__AVR_ATmega640__) +/* ATmega with two USART */ + #define ATMEGA_USART0 + #define ATMEGA_USART1 + #define UART0_RECEIVE_INTERRUPT USART0_RX_vect + #define UART1_RECEIVE_INTERRUPT USART1_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART1_TRANSMIT_INTERRUPT USART1_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 + #define UART1_STATUS UCSR1A + #define UART1_CONTROL UCSR1B + #define UART1_DATA UDR1 + #define UART1_UDRIE UDRIE1 +#elif defined(__AVR_ATmega644__) + /* ATmega with one USART */ + #define ATMEGA_USART0 + #define UART0_RECEIVE_INTERRUPT USART0_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 +#elif defined(__AVR_ATmega164P__) || defined(__AVR_ATmega324P__) || defined(__AVR_ATmega644P__) + /* ATmega with two USART */ + #define ATMEGA_USART0 + #define ATMEGA_USART1 + #define UART0_RECEIVE_INTERRUPT USART0_RX_vect + #define UART1_RECEIVE_INTERRUPT USART1_RX_vect + #define UART0_TRANSMIT_INTERRUPT USART0_UDRE_vect + #define UART1_TRANSMIT_INTERRUPT USART1_UDRE_vect + #define UART0_STATUS UCSR0A + #define UART0_CONTROL UCSR0B + #define UART0_DATA UDR0 + #define UART0_UDRIE UDRIE0 + #define UART1_STATUS UCSR1A + #define UART1_CONTROL UCSR1B + #define UART1_DATA UDR1 + #define UART1_UDRIE UDRIE1 +#else + #error "no UART definition for MCU available" +#endif + + +/* + * module global variables + */ +static volatile unsigned char UART_TxBuf[UART_TX_BUFFER_SIZE]; +static volatile unsigned char UART_RxBuf[UART_RX_BUFFER_SIZE]; +static volatile unsigned char UART_TxHead; +static volatile unsigned char UART_TxTail; +static volatile unsigned char UART_RxHead; +static volatile unsigned char UART_RxTail; +static volatile unsigned char UART_LastRxError; + +#if defined( ATMEGA_USART1 ) +static volatile unsigned char UART1_TxBuf[UART_TX_BUFFER_SIZE]; +static volatile unsigned char UART1_RxBuf[UART_RX_BUFFER_SIZE]; +static volatile unsigned char UART1_TxHead; +static volatile unsigned char UART1_TxTail; +static volatile unsigned char UART1_RxHead; +static volatile unsigned char UART1_RxTail; +static volatile unsigned char UART1_LastRxError; +#endif + + + +ISR (UART0_RECEIVE_INTERRUPT) +/************************************************************************* +Function: UART Receive Complete interrupt +Purpose: called when the UART has received a character +**************************************************************************/ +{ + unsigned char tmphead; + unsigned char data; + unsigned char usr; + unsigned char lastRxError; + + + /* read UART status register and UART data register */ + usr = UART0_STATUS; + data = UART0_DATA; + + /* */ +#if defined( AT90_UART ) + lastRxError = (usr & (_BV(FE)|_BV(DOR)) ); +#elif defined( ATMEGA_USART ) + lastRxError = (usr & (_BV(FE)|_BV(DOR)) ); +#elif defined( ATMEGA_USART0 ) + lastRxError = (usr & (_BV(FE0)|_BV(DOR0)) ); +#elif defined ( ATMEGA_UART ) + lastRxError = (usr & (_BV(FE)|_BV(DOR)) ); +#endif + + /* calculate buffer index */ + tmphead = ( UART_RxHead + 1) & UART_RX_BUFFER_MASK; + + if ( tmphead == UART_RxTail ) { + /* error: receive buffer overflow */ + lastRxError = UART_BUFFER_OVERFLOW >> 8; + }else{ + /* store new index */ + UART_RxHead = tmphead; + /* store received data in buffer */ + UART_RxBuf[tmphead] = data; + } + UART_LastRxError |= lastRxError; +} + + +ISR (UART0_TRANSMIT_INTERRUPT) +/************************************************************************* +Function: UART Data Register Empty interrupt +Purpose: called when the UART is ready to transmit the next byte +**************************************************************************/ +{ + unsigned char tmptail; + + + if ( UART_TxHead != UART_TxTail) { + /* calculate and store new buffer index */ + tmptail = (UART_TxTail + 1) & UART_TX_BUFFER_MASK; + UART_TxTail = tmptail; + /* get one byte from buffer and write it to UART */ + UART0_DATA = UART_TxBuf[tmptail]; /* start transmission */ + }else{ + /* tx buffer empty, disable UDRE interrupt */ + UART0_CONTROL &= ~_BV(UART0_UDRIE); + } +} + + +/************************************************************************* +Function: uart_init() +Purpose: initialize UART and set baudrate +Input: baudrate using macro UART_BAUD_SELECT() +Returns: none +**************************************************************************/ +void uart_init(unsigned int baudrate) +{ + UART_TxHead = 0; + UART_TxTail = 0; + UART_RxHead = 0; + UART_RxTail = 0; + +#if defined( AT90_UART ) + /* set baud rate */ + UBRR = (unsigned char)baudrate; + + /* enable UART receiver and transmmitter and receive complete interrupt */ + UART0_CONTROL = _BV(RXCIE)|_BV(RXEN)|_BV(TXEN); + +#elif defined (ATMEGA_USART) + /* Set baud rate */ + if ( baudrate & 0x8000 ) + { + UART0_STATUS = (1<>8); + UBRRL = (unsigned char) baudrate; + + /* Enable USART receiver and transmitter and receive complete interrupt */ + UART0_CONTROL = _BV(RXCIE)|(1<>8); + UBRR0L = (unsigned char) baudrate; + + /* Enable USART receiver and transmitter and receive complete interrupt */ + UART0_CONTROL = _BV(RXCIE0)|(1<>8); + UBRR = (unsigned char) baudrate; + + /* Enable UART receiver and transmitter and receive complete interrupt */ + UART0_CONTROL = _BV(RXCIE)|(1<> 8; + }else{ + /* store new index */ + UART1_RxHead = tmphead; + /* store received data in buffer */ + UART1_RxBuf[tmphead] = data; + } + UART1_LastRxError |= lastRxError; +} + + +ISR(UART1_TRANSMIT_INTERRUPT) +/************************************************************************* +Function: UART1 Data Register Empty interrupt +Purpose: called when the UART1 is ready to transmit the next byte +**************************************************************************/ +{ + unsigned char tmptail; + + + if ( UART1_TxHead != UART1_TxTail) { + /* calculate and store new buffer index */ + tmptail = (UART1_TxTail + 1) & UART_TX_BUFFER_MASK; + UART1_TxTail = tmptail; + /* get one byte from buffer and write it to UART */ + UART1_DATA = UART1_TxBuf[tmptail]; /* start transmission */ + }else{ + /* tx buffer empty, disable UDRE interrupt */ + UART1_CONTROL &= ~_BV(UART1_UDRIE); + } +} + + +/************************************************************************* +Function: uart1_init() +Purpose: initialize UART1 and set baudrate +Input: baudrate using macro UART_BAUD_SELECT() +Returns: none +**************************************************************************/ +void uart1_init(unsigned int baudrate) +{ + UART1_TxHead = 0; + UART1_TxTail = 0; + UART1_RxHead = 0; + UART1_RxTail = 0; + + + /* Set baud rate */ + if ( baudrate & 0x8000 ) + { + UART1_STATUS = (1<>8); + UBRR1L = (unsigned char) baudrate; + + /* Enable USART receiver and transmitter and receive complete interrupt */ + UART1_CONTROL = _BV(RXCIE1)|(1< http://jump.to/fleury +File: $Id: uart.h,v 1.11 2012/09/15 14:32:27 peter Exp $ +Software: AVR-GCC 4.1, AVR Libc 1.4 +Hardware: any AVR with built-in UART, tested on AT90S8515 & ATmega8 at 4 Mhz +License: GNU General Public License +Usage: see Doxygen manual + +LICENSE: + Copyright (C) 2006 Peter Fleury + + 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 + 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. + +************************************************************************/ + +/** + * @defgroup pfleury_uart UART Library + * @code #include @endcode + * + * @brief Interrupt UART library using the built-in UART with transmit and receive circular buffers. + * + * This library can be used to transmit and receive data through the built in UART. + * + * An interrupt is generated when the UART has finished transmitting or + * receiving a byte. The interrupt handling routines use circular buffers + * for buffering received and transmitted data. + * + * The UART_RX_BUFFER_SIZE and UART_TX_BUFFER_SIZE constants define + * the size of the circular buffers in bytes. Note that these constants must be a power of 2. + * You may need to adapt this constants to your target and your application by adding + * CDEFS += -DUART_RX_BUFFER_SIZE=nn -DUART_RX_BUFFER_SIZE=nn to your Makefile. + * + * @note Based on Atmel Application Note AVR306 + * @author Peter Fleury pfleury@gmx.ch http://jump.to/fleury + */ + +/**@{*/ + + +#if (__GNUC__ * 100 + __GNUC_MINOR__) < 304 +#error "This library requires AVR-GCC 3.4 or later, update to newer AVR-GCC compiler !" +#endif + + +/* +** constants and macros +*/ + +/** @brief UART Baudrate Expression + * @param xtalcpu system clock in Mhz, e.g. 4000000UL for 4Mhz + * @param baudrate baudrate in bps, e.g. 1200, 2400, 9600 + */ +#define UART_BAUD_SELECT(baudRate,xtalCpu) (((xtalCpu) + 8UL * (baudRate)) / (16UL * (baudRate)) -1UL) + +/** @brief UART Baudrate Expression for ATmega double speed mode + * @param xtalcpu system clock in Mhz, e.g. 4000000UL for 4Mhz + * @param baudrate baudrate in bps, e.g. 1200, 2400, 9600 + */ +#define UART_BAUD_SELECT_DOUBLE_SPEED(baudRate,xtalCpu) ((((xtalCpu) + 4UL * (baudRate)) / (8UL * (baudRate)) -1UL))|0x8000) + + +/** Size of the circular receive buffer, must be power of 2 */ +#ifndef UART_RX_BUFFER_SIZE +#define UART_RX_BUFFER_SIZE 32 +#endif +/** Size of the circular transmit buffer, must be power of 2 */ +#ifndef UART_TX_BUFFER_SIZE +#define UART_TX_BUFFER_SIZE 32 +#endif + +/* test if the size of the circular buffers fits into SRAM */ +#if ( (UART_RX_BUFFER_SIZE+UART_TX_BUFFER_SIZE) >= (RAMEND-0x60 ) ) +#error "size of UART_RX_BUFFER_SIZE + UART_TX_BUFFER_SIZE larger than size of SRAM" +#endif + +/* +** high byte error return code of uart_getc() +*/ +#define UART_FRAME_ERROR 0x1000 /* Framing Error by UART */ +#define UART_OVERRUN_ERROR 0x0800 /* Overrun condition by UART */ +#define UART_PARITY_ERROR 0x0400 /* Parity Error by UART */ +#define UART_BUFFER_OVERFLOW 0x0200 /* receive ringbuffer overflow */ +#define UART_NO_DATA 0x0100 /* no receive data available */ + + +/* +** function prototypes +*/ + +/** + @brief Initialize UART and set baudrate + @param baudrate Specify baudrate using macro UART_BAUD_SELECT() + @return none +*/ +extern void uart_init(unsigned int baudrate); + + +/** + * @brief Get received byte from ringbuffer + * + * Returns in the lower byte the received character and in the + * higher byte the last receive error. + * UART_NO_DATA is returned when no data is available. + * + * @param void + * @return lower byte: received byte from ringbuffer + * @return higher byte: last receive status + * - \b 0 successfully received data from UART + * - \b UART_NO_DATA + *
no receive data available + * - \b UART_BUFFER_OVERFLOW + *
Receive ringbuffer overflow. + * We are not reading the receive buffer fast enough, + * one or more received character have been dropped + * - \b UART_OVERRUN_ERROR + *
Overrun condition by UART. + * A character already present in the UART UDR register was + * not read by the interrupt handler before the next character arrived, + * one or more received characters have been dropped. + * - \b UART_FRAME_ERROR + *
Framing Error by UART + */ +extern unsigned int uart_getc(void); + + +/** + * @brief Put byte to ringbuffer for transmitting via UART + * @param data byte to be transmitted + * @return none + */ +extern void uart_putc(unsigned char data); + + +/** + * @brief Put string to ringbuffer for transmitting via UART + * + * The string is buffered by the uart library in a circular buffer + * and one character at a time is transmitted to the UART using interrupts. + * Blocks if it can not write the whole string into the circular buffer. + * + * @param s string to be transmitted + * @return none + */ +extern void uart_puts(const char *s ); + + +/** + * @brief Put string from program memory to ringbuffer for transmitting via UART. + * + * The string is buffered by the uart library in a circular buffer + * and one character at a time is transmitted to the UART using interrupts. + * Blocks if it can not write the whole string into the circular buffer. + * + * @param s program memory string to be transmitted + * @return none + * @see uart_puts_P + */ +extern void uart_puts_p(const char *s ); + +/** + * @brief Macro to automatically put a string constant into program memory + */ +#define uart_puts_P(__s) uart_puts_p(PSTR(__s)) + + + +/** @brief Initialize USART1 (only available on selected ATmegas) @see uart_init */ +extern void uart1_init(unsigned int baudrate); +/** @brief Get received byte of USART1 from ringbuffer. (only available on selected ATmega) @see uart_getc */ +extern unsigned int uart1_getc(void); +/** @brief Put byte to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_putc */ +extern void uart1_putc(unsigned char data); +/** @brief Put string to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_puts */ +extern void uart1_puts(const char *s ); +/** @brief Put string from program memory to ringbuffer for transmitting via USART1 (only available on selected ATmega) @see uart_puts_p */ +extern void uart1_puts_p(const char *s ); +/** @brief Macro to automatically put a string constant into program memory */ +#define uart1_puts_P(__s) uart1_puts_p(PSTR(__s)) + +/**@}*/ + + +#endif // UART_H +