tmk
12 years ago
parent
e9e4c0edc5
commit
8215634175
@ -0,0 +1,61 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* |
||||
* Special application to extract an EEPROM image stored in FLASH memory, and |
||||
* copy it to the device EEPROM. This application is designed to be used with |
||||
* the HID build system module of LUFA to program the EEPROM of a target device |
||||
* that uses the HID bootloader protocol, which does not have native EEPROM |
||||
* programming support. |
||||
*/ |
||||
|
||||
#include <avr/io.h> |
||||
#include <avr/eeprom.h> |
||||
#include <avr/pgmspace.h> |
||||
|
||||
/* References to the binary EEPROM data linked in the AVR's FLASH memory space */ |
||||
extern const char _binary_InputEEData_bin_start[]; |
||||
extern const char _binary_InputEEData_bin_end[]; |
||||
extern const char _binary_InputEEData_bin_size[]; |
||||
|
||||
/* Friendly names for the embedded binary data stored in FLASH memory space */ |
||||
#define InputEEData _binary_InputEEData_bin_start |
||||
#define InputEEData_size ((int)_binary_InputEEData_bin_size) |
||||
|
||||
int main(void) |
||||
{ |
||||
/* Copy out the embedded EEPROM data from FLASH to EEPROM memory space */ |
||||
for (uint16_t i = 0; i < InputEEData_size; i++) |
||||
eeprom_update_byte((uint8_t*)i, pgm_read_byte(&InputEEData[i])); |
||||
|
||||
/* Infinite loop once complete */ |
||||
for (;;); |
||||
} |
||||
@ -0,0 +1,40 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
# --------------------------------------
|
||||
# LUFA Project Makefile.
|
||||
# --------------------------------------
|
||||
|
||||
MCU = at90usb1287
|
||||
ARCH = AVR8
|
||||
F_CPU = 1000000
|
||||
F_USB = $(F_CPU)
|
||||
OPTIMIZATION = s
|
||||
TARGET = HID_EEPROM_Loader
|
||||
SRC = $(TARGET).c
|
||||
LUFA_PATH = ../../../LUFA
|
||||
CC_FLAGS =
|
||||
LD_FLAGS =
|
||||
OBJECT_FILES = InputEEData.o
|
||||
|
||||
# Default target
|
||||
all: |
||||
|
||||
# Determine the AVR sub-architecture of the build main application object file
|
||||
FIND_AVR_SUBARCH = avr$(shell avr-objdump -f $(TARGET).o | grep architecture | cut -d':' -f3 | cut -d',' -f1)
|
||||
|
||||
# Create a linkable object file with the input binary EEPROM data stored in the FLASH section
|
||||
InputEEData.o: InputEEData.bin $(TARGET).o $(MAKEFILE_LIST) |
||||
@echo $(MSG_OBJCPY_CMD) Converting \"$<\" to a object file \"$@\"
|
||||
avr-objcopy -I binary -O elf32-avr -B $(call FIND_AVR_SUBARCH) --rename-section .data=.progmem.data,contents,alloc,readonly,data $< $@
|
||||
|
||||
# Include LUFA build script makefiles
|
||||
include $(LUFA_PATH)/Build/lufa_core.mk |
||||
include $(LUFA_PATH)/Build/lufa_build.mk |
||||
include $(LUFA_PATH)/Build/lufa_cppcheck.mk |
||||
include $(LUFA_PATH)/Build/lufa_doxygen.mk |
||||
include $(LUFA_PATH)/Build/lufa_hid.mk |
||||
@ -0,0 +1,101 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += ATPROGRAM
|
||||
LUFA_BUILD_TARGETS += atprogram atprogram-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS += ATPROGRAM_PROGRAMMER ATPROGRAM_INTERFACE ATPROGRAM_PORT
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA ATPROGRAM Programmer Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to re-program a device using the Atmel atprogram
|
||||
# utility in AVR Studio 5.x and Atmel Studio 6.0 onwards.
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# atprogram - Program target FLASH with application using
|
||||
# atprogram
|
||||
# atprogram-ee - Program target EEPROM with application data
|
||||
# using atprogram
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# MCU - Microcontroller device model name
|
||||
# TARGET - Application name
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# ATPROGRAM_PROGRAMMER - Name of programming hardware to use
|
||||
# ATPROGRAM_INTERFACE - Name of programming interface to use
|
||||
# ATPROGRAM_PORT - Name of communication port to use
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Default values of optionally user-supplied variables
|
||||
ATPROGRAM_PROGRAMMER ?= jtagice3
|
||||
ATPROGRAM_INTERFACE ?= jtag
|
||||
ATPROGRAM_PORT ?=
|
||||
|
||||
# Sanity check user supplied values
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, MCU) |
||||
$(call ERROR_IF_EMPTY, TARGET) |
||||
$(call ERROR_IF_EMPTY, ATPROGRAM_PROGRAMMER) |
||||
$(call ERROR_IF_EMPTY, ATPROGRAM_INTERFACE) |
||||
|
||||
# Output Messages
|
||||
MSG_ATPROGRAM_CMD := ' [ATPRGRM] :'
|
||||
|
||||
# Construct base atprogram command flags
|
||||
BASE_ATPROGRAM_FLAGS := --tool $(ATPROGRAM_PROGRAMMER) --interface $(ATPROGRAM_INTERFACE) --device $(MCU)
|
||||
ifneq ($(ATPROGRAM_PORT),) |
||||
BASE_ATPROGRAM_FLAGS += --port $(ATPROGRAM_PORT)
|
||||
endif |
||||
|
||||
# Construct the flags to use for the various memory spaces
|
||||
ifeq ($(ARCH), AVR8) |
||||
ATPROGRAM_FLASH_FLAGS := --chiperase --flash
|
||||
ATPROGRAM_EEPROM_FLAGS := --eeprom
|
||||
else ifeq ($(ARCH), XMEGA) |
||||
ATPROGRAM_FLASH_FLAGS := --erase --flash
|
||||
ATPROGRAM_EEPROM_FLAGS := --eeprom
|
||||
else ifeq ($(ARCH), UC3) |
||||
ATPROGRAM_FLASH_FLAGS := --erase
|
||||
ATPROGRAM_EEPROM_FLAGS := --eeprom
|
||||
else |
||||
$(error Unsupported architecture "$(ARCH)")
|
||||
endif |
||||
|
||||
atprogram: $(TARGET).elf $(MAKEFILE_LIST) |
||||
@echo $(MSG_ATPROGRAM_CMD) Programming device \"$(MCU)\" FLASH using \"$(ATPROGRAM_PROGRAMMER)\"
|
||||
atprogram $(BASE_ATPROGRAM_FLAGS) program $(ATPROGRAM_FLASH_FLAGS) --file $<
|
||||
|
||||
atprogram-ee: $(TARGET).elf $(MAKEFILE_LIST) |
||||
@echo $(MSG_ATPROGRAM_CMD) Programming device \"$(MCU)\" EEPROM using \"$(ATPROGRAM_PROGRAMMER)\"
|
||||
atprogram $(BASE_ATPROGRAM_FLAGS) program $(ATPROGRAM_EEPROM_FLAGS) --file $<
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: atprogram atprogram-ee |
||||
@ -0,0 +1,84 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += AVRDUDE
|
||||
LUFA_BUILD_TARGETS += avrdude avrdude-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS += AVRDUDE_PROGRAMMER AVRDUDE_PORT AVRDUDE_FLAGS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA AVRDUDE Programmer Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to re-program a device using the open source
|
||||
# avr-dude utility.
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# avrdude - Program target FLASH with application using
|
||||
# avrdude
|
||||
# avrdude-ee - Program target EEPROM with application data
|
||||
# using avrdude
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# MCU - Microcontroller device model name
|
||||
# TARGET - Application name
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# AVRDUDE_PROGRAMMER - Name of programming hardware to use
|
||||
# AVRDUDE_PORT - Name of communication port to use
|
||||
# AVRDUDE_FLAGS - Flags to pass to avr-dude
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Default values of optionally user-supplied variables
|
||||
AVRDUDE_PROGRAMMER ?= jtagicemkii
|
||||
AVRDUDE_PORT ?= usb
|
||||
AVRDUDE_FLAGS ?=
|
||||
|
||||
# Sanity check user supplied values
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, MCU) |
||||
$(call ERROR_IF_EMPTY, TARGET) |
||||
$(call ERROR_IF_EMPTY, AVRDUDE_PROGRAMMER) |
||||
$(call ERROR_IF_EMPTY, AVRDUDE_PORT) |
||||
|
||||
# Output Messages
|
||||
MSG_AVRDUDE_CMD := ' [AVRDUDE] :'
|
||||
|
||||
# Construct base avrdude command flags
|
||||
BASE_AVRDUDE_FLAGS := -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER)
|
||||
|
||||
avrdude: $(TARGET).hex $(MAKEFILE_LIST) |
||||
@echo $(MSG_AVRDUDE_CMD) Programming device \"$(MCU)\" FLASH with settings \"$(AVRDUDE_FLASH_FLAGS)\" using \"$(AVRDUDE_PROGRAMMER)\" on port \"$(AVRDUDE_PORT)\"
|
||||
avrdude $(BASE_AVRDUDE_FLAGS) -U flash:w:$< $(AVRDUDE_FLAGS)
|
||||
|
||||
avrdude-ee: $(TARGET).eep $(MAKEFILE_LIST) |
||||
@echo $(MSG_AVRDUDE_CMD) Programming device \"$(MCU)\" EEPROM with settings \"$(AVRDUDE_EEP_FLAGS)\" using \"$(AVRDUDE_PROGRAMMER)\" on port \"$(AVRDUDE_PORT)\"
|
||||
avrdude $(BASE_AVRDUDE_FLAGS) -U eeprom:w:$< $(AVRDUDE_FLAGS)
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: avrdude avrdude-ee |
||||
@ -0,0 +1,296 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += BUILD
|
||||
LUFA_BUILD_TARGETS += size check-source symbol-sizes all lib elf hex lss clean mostlyclean
|
||||
LUFA_BUILD_MANDATORY_VARS += TARGET ARCH MCU SRC F_USB LUFA_PATH
|
||||
LUFA_BUILD_OPTIONAL_VARS += BOARD OPTIMIZATION C_STANDARD CPP_STANDARD F_CPU C_FLAGS CPP_FLAGS ASM_FLAGS CC_FLAGS LD_FLAGS OBJDIR OBJECT_FILES DEBUG_TYPE DEBUG_LEVEL
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA GCC Compiler Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to build a C, C++ and/or Assembly application
|
||||
# via the AVR-GCC compiler.
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# size - List built application size
|
||||
# symbol-sizes - Print application symbols from the binary ELF
|
||||
# file as a list sorted by size in bytes
|
||||
# check-source - Print a list of SRC source files that cannot
|
||||
# be found
|
||||
# all - Build application and list size
|
||||
# lib - Build and archive source files into a library
|
||||
# elf - Build application ELF debug object file
|
||||
# hex - Build application HEX object files
|
||||
# lss - Build application LSS assembly listing file
|
||||
# clean - Remove all project intermediatary and binary
|
||||
# output files
|
||||
# mostlyclean - Remove intermediatary output files, but
|
||||
# preserve binaries
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# TARGET - Application name
|
||||
# ARCH - Device architecture name
|
||||
# MCU - Microcontroller device model name
|
||||
# SRC - List of input source files (*.c, *.cpp, *.S)
|
||||
# F_USB - Speed of the input clock of the USB controller
|
||||
# in Hz
|
||||
# LUFA_PATH - Path to the LUFA library core
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# BOARD - LUFA board hardware
|
||||
# OPTIMIZATION - Optimization level
|
||||
# C_STANDARD - C Language Standard to use
|
||||
# CPP_STANDARD - C++ Language Standard to use
|
||||
# F_CPU - Speed of the CPU, in Hz
|
||||
# C_FLAGS - Flags to pass to the C compiler only
|
||||
# CPP_FLAGS - Flags to pass to the C++ compiler only
|
||||
# ASM_FLAGS - Flags to pass to the assembler only
|
||||
# CC_FLAGS - Common flags to pass to the C/C++ compiler and
|
||||
# assembler
|
||||
# LD_FLAGS - Flags to pass to the linker
|
||||
# OBJDIR - Directory for the output object and dependency
|
||||
# files; if equal to ".", the output files will
|
||||
# be generated in the same folder as the sources
|
||||
# OBJECT_FILES - Extra object files to link in to the binaries
|
||||
# DEBUG_FORMAT - Format of the debugging information to
|
||||
# generate in the compiled object files
|
||||
# DEBUG_LEVEL - Level the debugging information to generate in
|
||||
# the compiled object files
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Default values of optionally user-supplied variables
|
||||
BOARD ?= NONE
|
||||
OPTIMIZATION ?= s
|
||||
F_CPU ?=
|
||||
C_STANDARD ?= gnu99
|
||||
CPP_STANDARD ?= gnu++98
|
||||
C_FLAGS ?=
|
||||
CPP_FLAGS ?=
|
||||
ASM_FLAGS ?=
|
||||
CC_FLAGS ?=
|
||||
OBJDIR ?= .
|
||||
OBJECT_FILES ?=
|
||||
DEBUG_FORMAT ?= dwarf-2
|
||||
DEBUG_LEVEL ?= 3
|
||||
|
||||
# Sanity check user supplied values
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, MCU) |
||||
$(call ERROR_IF_EMPTY, TARGET) |
||||
$(call ERROR_IF_EMPTY, ARCH) |
||||
$(call ERROR_IF_EMPTY, F_USB) |
||||
$(call ERROR_IF_EMPTY, LUFA_PATH) |
||||
$(call ERROR_IF_EMPTY, BOARD) |
||||
$(call ERROR_IF_EMPTY, OPTIMIZATION) |
||||
$(call ERROR_IF_EMPTY, C_STANDARD) |
||||
$(call ERROR_IF_EMPTY, CPP_STANDARD) |
||||
$(call ERROR_IF_EMPTY, OBJDIR) |
||||
$(call ERROR_IF_EMPTY, DEBUG_FORMAT) |
||||
$(call ERROR_IF_EMPTY, DEBUG_LEVEL) |
||||
|
||||
# Determine the utility prefix to use for the selected architecture
|
||||
ifeq ($(ARCH), AVR8) |
||||
CROSS := avr
|
||||
else ifeq ($(ARCH), XMEGA) |
||||
CROSS := avr
|
||||
$(warning The XMEGA device support is currently EXPERIMENTAL (incomplete and/or non-functional), and is included for preview purposes only.)
|
||||
else ifeq ($(ARCH), UC3) |
||||
CROSS := avr32
|
||||
$(warning The UC3 device support is currently EXPERIMENTAL (incomplete and/or non-functional), and is included for preview purposes only.)
|
||||
else |
||||
$(error Unsupported architecture "$(ARCH)")
|
||||
endif |
||||
|
||||
# Output Messages
|
||||
MSG_COMPILE_CMD := ' [GCC] :'
|
||||
MSG_ASSEMBLE_CMD := ' [GAS] :'
|
||||
MSG_NM_CMD := ' [NM] :'
|
||||
MSG_REMOVE_CMD := ' [RM] :'
|
||||
MSG_LINK_CMD := ' [LNK] :'
|
||||
MSG_ARCHIVE_CMD := ' [AR] :'
|
||||
MSG_SIZE_CMD := ' [SIZE] :'
|
||||
MSG_OBJCPY_CMD := ' [OBJCPY] :'
|
||||
MSG_OBJDMP_CMD := ' [OBJDMP] :'
|
||||
|
||||
# Convert input source file list to differentiate them by type
|
||||
C_SOURCE := $(filter %.c, $(SRC))
|
||||
CPP_SOURCE := $(filter %.cpp, $(SRC))
|
||||
ASM_SOURCE := $(filter %.S, $(SRC))
|
||||
|
||||
# Create a list of unknown source file types, if any are found throw an error
|
||||
UNKNOWN_SOURCE := $(filter-out $(C_SOURCE) $(CPP_SOURCE) $(ASM_SOURCE), $(SRC))
|
||||
ifneq ($(UNKNOWN_SOURCE),) |
||||
$(error Unknown input source file formats: $(UNKNOWN_SOURCE))
|
||||
endif |
||||
|
||||
# Convert input source filenames into a list of required output object files
|
||||
OBJECT_FILES += $(addsuffix .o, $(basename $(SRC)))
|
||||
ifneq ($(OBJDIR),.) |
||||
$(shell mkdir $(OBJDIR) 2> /dev/null)
|
||||
VPATH += $(dir $(SRC))
|
||||
OBJECT_FILES := $(addprefix $(patsubst %/,%,$(OBJDIR))/, $(notdir $(OBJECT_FILES)))
|
||||
|
||||
# Check if any object file (without path) appears more than once in the object file list
|
||||
ifneq ($(words $(sort $(OBJECT_FILES))), $(words $(OBJECT_FILES)))
|
||||
$(error Cannot build with OBJDIR parameter set - one or more object file name is not unique)
|
||||
endif
|
||||
endif |
||||
|
||||
# Create a list of dependency files from the list of object files
|
||||
DEPENDENCY_FILES := $(OBJECT_FILES:%.o=%.d)
|
||||
|
||||
# Create a list of common flags to pass to the compiler/linker/assembler
|
||||
BASE_CC_FLAGS := -pipe -g$(DEBUG_FORMAT) -g$(DEBUG_LEVEL)
|
||||
ifeq ($(ARCH), AVR8) |
||||
BASE_CC_FLAGS += -mmcu=$(MCU) -fshort-enums -fno-inline-small-functions -fpack-struct
|
||||
else ifeq ($(ARCH), XMEGA) |
||||
BASE_CC_FLAGS += -mmcu=$(MCU) -fshort-enums -fno-inline-small-functions -fpack-struct
|
||||
else ifeq ($(ARCH), UC3) |
||||
BASE_CC_FLAGS += -mpart=$(MCU:at32%=%) -masm-addr-pseudos
|
||||
endif |
||||
BASE_CC_FLAGS += -Wall -fno-strict-aliasing -funsigned-char -funsigned-bitfields -ffunction-sections
|
||||
BASE_CC_FLAGS += -I. -I$(patsubst %/,%,$(LUFA_PATH))/..
|
||||
BASE_CC_FLAGS += -DARCH=ARCH_$(ARCH) -DBOARD=BOARD_$(BOARD) -DF_USB=$(F_USB)UL
|
||||
ifneq ($(F_CPU),) |
||||
BASE_CC_FLAGS += -DF_CPU=$(F_CPU)UL
|
||||
endif |
||||
|
||||
# Additional language specific compiler flags
|
||||
BASE_C_FLAGS := -x c -O$(OPTIMIZATION) -std=$(C_STANDARD) -Wstrict-prototypes
|
||||
BASE_CPP_FLAGS := -x c++ -O$(OPTIMIZATION) -std=$(CPP_STANDARD)
|
||||
BASE_ASM_FLAGS := -x assembler-with-cpp
|
||||
|
||||
# Create a list of flags to pass to the linker
|
||||
BASE_LD_FLAGS := -lm -Wl,-Map=$(TARGET).map,--cref -Wl,--gc-sections -Wl,--relax
|
||||
ifeq ($(ARCH), AVR8) |
||||
BASE_LD_FLAGS += -mmcu=$(MCU)
|
||||
else ifeq ($(ARCH), XMEGA) |
||||
BASE_LD_FLAGS += -mmcu=$(MCU)
|
||||
else ifeq ($(ARCH), UC3) |
||||
BASE_LD_FLAGS += -mpart=$(MCU:at32%=%) --rodata-writable --direct-data
|
||||
endif |
||||
|
||||
# Determine flags to pass to the size utility based on its reported features (only invoke if size target required)
|
||||
size: SIZE_MCU_FLAG := $(shell $(CROSS)-size --help | grep -- --mcu > /dev/null && echo --mcu=$(MCU) ) |
||||
size: SIZE_FORMAT_FLAG := $(shell $(CROSS)-size --help | grep -- --format=.*avr > /dev/null && echo --format=avr ) |
||||
|
||||
|
||||
build_begin: |
||||
@echo ""
|
||||
@echo Begin compilation of project \"$(TARGET)\"...
|
||||
@echo ""
|
||||
|
||||
build_end: |
||||
@echo Finished building project \"$(TARGET)\".
|
||||
@echo ""
|
||||
|
||||
gcc-version: |
||||
@$(CROSS)-gcc --version
|
||||
|
||||
check-source: |
||||
@for f in $(SRC); do \
|
||||
if [ ! -f $$f ]; then \
|
||||
echo "Error: Source file not found: $$f"; \
|
||||
exit 1; \
|
||||
fi; \
|
||||
done
|
||||
|
||||
size: $(TARGET).elf |
||||
@echo $(MSG_SIZE_CMD) Determining size of \"$<\"
|
||||
@echo ""
|
||||
$(CROSS)-size $(SIZE_MCU_FLAG) $(SIZE_FORMAT_FLAG) $< ; 2>/dev/null;
|
||||
|
||||
symbol-sizes: $(TARGET).elf |
||||
@echo $(MSG_NM_CMD) Extracting \"$<\" symbols with decimal byte sizes
|
||||
$(CROSS)-nm --size-sort --demangle --radix=d $<
|
||||
|
||||
mostlyclean: |
||||
@echo $(MSG_REMOVE_CMD) Removing object files of \"$(TARGET)\"
|
||||
rm -f $(OBJECT_FILES)
|
||||
@echo $(MSG_REMOVE_CMD) Removing dependency files of \"$(TARGET)\"
|
||||
rm -f $(DEPENDENCY_FILES)
|
||||
|
||||
clean: mostlyclean |
||||
@echo $(MSG_REMOVE_CMD) Removing output files of \"$(TARGET)\"
|
||||
rm -f $(TARGET).elf $(TARGET).hex $(TARGET).eep $(TARGET).map $(TARGET).lss $(TARGET).sym $(TARGET).a
|
||||
|
||||
all: build_begin check-source gcc-version elf hex lss sym size build_end |
||||
|
||||
lib: lib$(TARGET).a |
||||
elf: $(TARGET).elf |
||||
hex: $(TARGET).hex $(TARGET).eep |
||||
lss: $(TARGET).lss |
||||
sym: $(TARGET).sym |
||||
|
||||
$(OBJDIR)/%.o: %.c $(MAKEFILE_LIST) |
||||
@echo $(MSG_COMPILE_CMD) Compiling C file \"$(notdir $<)\"
|
||||
$(CROSS)-gcc -c $(BASE_CC_FLAGS) $(BASE_C_FLAGS) $(CC_FLAGS) $(C_FLAGS) -MMD -MP -MF $(@:%.o=%.d) $< -o $@
|
||||
|
||||
$(OBJDIR)/%.o: %.cpp $(MAKEFILE_LIST) |
||||
@echo $(MSG_COMPILE_CMD) Compiling C++ file \"$(notdir $<)\"
|
||||
$(CROSS)-gcc -c $(BASE_CC_FLAGS) $(BASE_CPP_FLAGS) $(CC_FLAGS) $(CPP_FLAGS) -MMD -MP -MF $(@:%.o=%.d) $< -o $@
|
||||
|
||||
$(OBJDIR)/%.o: %.S $(MAKEFILE_LIST) |
||||
@echo $(MSG_ASSEMBLE_CMD) Assembling \"$(notdir $<)\"
|
||||
$(CROSS)-gcc -c $(BASE_CC_FLAGS) $(BASE_ASM_FLAGS) $(CC_FLAGS) $(ASM_FLAGS) -MMD -MP -MF $(@:%.o=%.d) $< -o $@
|
||||
|
||||
.PRECIOUS : $(OBJECT_FILES) |
||||
.SECONDARY : %.a |
||||
%.a: $(OBJECT_FILES) |
||||
@echo $(MSG_ARCHIVE_CMD) Archiving object files into \"$@\"
|
||||
$(CROSS)-ar rcs $@ $(OBJECT_FILES)
|
||||
|
||||
.PRECIOUS : $(OBJECT_FILES) |
||||
.SECONDARY : %.elf |
||||
%.elf: $(OBJECT_FILES) |
||||
@echo $(MSG_LINK_CMD) Linking object files into \"$@\"
|
||||
$(CROSS)-gcc $(BASE_LD_FLAGS) $(LD_FLAGS) $^ -o $@
|
||||
|
||||
%.hex: %.elf |
||||
@echo $(MSG_OBJCPY_CMD) Extracting HEX file data from \"$<\"
|
||||
$(CROSS)-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature $< $@
|
||||
|
||||
%.eep: %.elf |
||||
@echo $(MSG_OBJCPY_CMD) Extracting EEP file data from \"$<\"
|
||||
$(CROSS)-objcopy -j .eeprom --set-section-flags=.eeprom="alloc,load" --change-section-lma .eeprom=0 --no-change-warnings -O ihex $< $@ || exit 0
|
||||
|
||||
%.lss: %.elf |
||||
@echo $(MSG_OBJDMP_CMD) Extracting LSS file data from \"$<\"
|
||||
$(CROSS)-objdump -h -S -z $< > $@
|
||||
|
||||
%.sym: %.elf |
||||
@echo $(MSG_NM_CMD) Extracting SYM file data from \"$<\"
|
||||
$(CROSS)-nm -n $< > $@
|
||||
|
||||
# Include build dependency files
|
||||
-include $(DEPENDENCY_FILES) |
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: build_begin build_end gcc-version check-source size symbol-sizes lib elf hex lss clean mostlyclean |
||||
@ -0,0 +1,152 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += CORE
|
||||
LUFA_BUILD_TARGETS += help list_targets list_modules list_mandatory list_optional list_provided list_macros
|
||||
LUFA_BUILD_MANDATORY_VARS +=
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA Core Build System Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of core build targets for the LUFA build system
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# help - Build system help
|
||||
# list_targets - List all build targets
|
||||
# list_modules - List all build modules
|
||||
# list_mandatory - List all mandatory make variables required by
|
||||
# the included build modules of the application
|
||||
# list_optional - List all optional make variables required by
|
||||
# the included build modules of the application
|
||||
# list_provided - List all provided make variables from the
|
||||
# included build modules of the application
|
||||
# list_macros - List all provided make macros from the
|
||||
# included build modules of the application
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
# Build sorted and filtered lists of the included build module data
|
||||
SORTED_LUFA_BUILD_MODULES = $(sort $(LUFA_BUILD_MODULES))
|
||||
SORTED_LUFA_BUILD_TARGETS = $(sort $(LUFA_BUILD_TARGETS))
|
||||
SORTED_LUFA_MANDATORY_VARS = $(sort $(LUFA_BUILD_MANDATORY_VARS))
|
||||
SORTED_LUFA_OPTIONAL_VARS = $(filter-out $(SORTED_LUFA_MANDATORY_VARS), $(sort $(LUFA_BUILD_OPTIONAL_VARS)))
|
||||
SORTED_LUFA_PROVIDED_VARS = $(sort $(LUFA_BUILD_PROVIDED_VARS))
|
||||
SORTED_LUFA_PROVIDED_MACROS = $(sort $(LUFA_BUILD_PROVIDED_MACROS))
|
||||
|
||||
# Create printable versions of the sorted build module data (use "(None)" when no data is available)
|
||||
PRINTABLE_LUFA_BUILD_MODULES = $(if $(strip $(SORTED_LUFA_BUILD_MODULES)), $(SORTED_LUFA_BUILD_MODULES), (None))
|
||||
PRINTABLE_LUFA_BUILD_TARGETS = $(if $(strip $(SORTED_LUFA_BUILD_TARGETS)), $(SORTED_LUFA_BUILD_TARGETS), (None))
|
||||
PRINTABLE_LUFA_MANDATORY_VARS = $(if $(strip $(SORTED_LUFA_MANDATORY_VARS)), $(SORTED_LUFA_MANDATORY_VARS), (None))
|
||||
PRINTABLE_LUFA_OPTIONAL_VARS = $(if $(strip $(SORTED_LUFA_OPTIONAL_VARS)), $(SORTED_LUFA_OPTIONAL_VARS), (None))
|
||||
PRINTABLE_LUFA_PROVIDED_VARS = $(if $(strip $(SORTED_LUFA_PROVIDED_VARS)), $(SORTED_LUFA_PROVIDED_VARS), (None))
|
||||
PRINTABLE_LUFA_PROVIDED_MACROS = $(if $(strip $(SORTED_LUFA_PROVIDED_MACROS)), $(SORTED_LUFA_PROVIDED_MACROS), (None))
|
||||
|
||||
help: |
||||
@echo "==================================================================="
|
||||
@echo " LUFA Build System 2.0 "
|
||||
@echo " (C) Dean Camera, 2012 { dean @ fourwalledcubicle . com } "
|
||||
@echo "==================================================================="
|
||||
@echo "DESCRIPTION: "
|
||||
@echo " This build system is a set of makefile modules for (GNU) Make, to "
|
||||
@echo " provide a simple system for building LUFA powered applications. "
|
||||
@echo " Each makefile module can be included from within a user makefile, "
|
||||
@echo " to expose the build rules documented in the comments at the top of"
|
||||
@echo " each build module. "
|
||||
@echo " "
|
||||
@echo "USAGE: "
|
||||
@echo " To execute a rule, define all variables indicated in the desired "
|
||||
@echo " module as a required parameter before including the build module "
|
||||
@echo " in your project makefile. Parameters marked as optional will "
|
||||
@echo " assume a default value in the modules if not user-assigned. "
|
||||
@echo " "
|
||||
@echo " By default the target output shows both a friendly summary, as "
|
||||
@echo " well as the actual invoked command. To suppress the output of the "
|
||||
@echo " invoked commands and show only the friendly command output, run "
|
||||
@echo " make with the \"-s\" switch added before the target(s). "
|
||||
@echo "==================================================================="
|
||||
@echo " "
|
||||
@echo " Currently used build system modules in this application: "
|
||||
@echo " "
|
||||
@printf " %b" "$(PRINTABLE_LUFA_BUILD_MODULES:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Currently available build targets in this application: "
|
||||
@echo " "
|
||||
@printf " %b" "$(PRINTABLE_LUFA_BUILD_TARGETS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Mandatory variables required by the selected build Modules: "
|
||||
@echo " "
|
||||
@printf " %b" "$(PRINTABLE_LUFA_MANDATORY_VARS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Optional variables required by the selected build Modules: "
|
||||
@echo " "
|
||||
@printf " %b" "$(PRINTABLE_LUFA_OPTIONAL_VARS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Variables provided by the selected build Modules: "
|
||||
@echo " "
|
||||
@printf " %b" "$(PRINTABLE_LUFA_PROVIDED_VARS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Macros provided by the selected build Modules: "
|
||||
@echo " "
|
||||
@printf " %b" "$(PRINTABLE_LUFA_PROVIDED_MACROS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo "==================================================================="
|
||||
@echo " The LUFA BuildSystem 2.0 - Powered By Unicorns (tm) "
|
||||
@echo "==================================================================="
|
||||
|
||||
list_modules: |
||||
@echo Currently Used Build System Modules: $(PRINTABLE_LUFA_BUILD_MODULES)
|
||||
|
||||
list_targets: |
||||
@echo Currently Available Build Targets: $(PRINTABLE_LUFA_BUILD_TARGETS)
|
||||
|
||||
list_mandatory: |
||||
@echo Mandatory Variables for Included Modules: $(PRINTABLE_LUFA_MANDATORY_VARS)
|
||||
|
||||
list_optional: |
||||
@echo Optional Variables for Included Modules: $(PRINTABLE_LUFA_OPTIONAL_VARS)
|
||||
|
||||
list_provided: |
||||
@echo Variables Provided by the Included Modules: $(PRINTABLE_LUFA_PROVIDED_VARS)
|
||||
|
||||
list_macros: |
||||
@echo Macros Provided by the Included Modules: $(PRINTABLE_LUFA_PROVIDED_MACROS)
|
||||
|
||||
# Disable default in-built make rules (those that are needed are explicitly
|
||||
# defined, and doing so has performance benefits when recursively building)
|
||||
.SUFFIXES: |
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: help list_modules list_targets list_mandatory list_optional list_provided list_macros |
||||
@ -0,0 +1,104 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += CPPCHECK
|
||||
LUFA_BUILD_TARGETS += cppcheck cppcheck-config
|
||||
LUFA_BUILD_MANDATORY_VARS += SRC
|
||||
LUFA_BUILD_OPTIONAL_VARS += CPPCHECK_INCLUDES CPPCHECK_EXCLUDES CPPCHECK_MSG_TEMPLATE CPPCHECK_ENABLE \
|
||||
CPPCHECK_SUPPRESS CPPCHECK_FAIL_ON_WARNING CPPCHECK_QUIET CPPCHECK_FLAGS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA CPPCheck Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to scan a project with the free "cppcheck" static
|
||||
# analysis tool, to check for code errors at runtime (see http://cppcheck.sourceforge.net).
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# cppcheck - Scan the project with CPPCheck
|
||||
# cppcheck-config - Use CPPCheck to look for missing include files
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# SRC - List of source files to statically analyze
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# CPPCHECK_INCLUDES - Extra include paths to search for missing
|
||||
# header files
|
||||
# CPPCHECK_EXCLUDES - Source file paths to exclude checking (can be
|
||||
# a path fragment if desired)
|
||||
# CPPCHECK_MSG_TEMPLATE - Template for cppcheck error and warning output
|
||||
# CPPCHECK_ENABLE - General cppcheck category checks to enable
|
||||
# CPPCHECK_SUPPRESS - Specific cppcheck warnings to disable by ID
|
||||
# CPPCHECK_FAIL_ON_WARNING - Set to Y to fail the build on cppcheck
|
||||
# warnings, N to continue even if warnings occur
|
||||
# CPPCHECK_QUIET - Enable cppcheck verbose or quiet output mode
|
||||
# CPPCHECK_FLAGS - Additional flags to pass to cppcheck
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Default values of optionally user-supplied variables
|
||||
CPPCHECK_INCLUDES ?=
|
||||
CPPCHECK_EXCLUDES ?=
|
||||
CPPCHECK_MSG_TEMPLATE ?= {file}:{line}: {severity} ({id}): {message}
|
||||
CPPCHECK_ENABLE ?= all
|
||||
CPPCHECK_SUPPRESS ?= variableScope missingInclude
|
||||
CPPCHECK_FAIL_ON_WARNING ?= Y
|
||||
CPPCHECK_QUIET ?= Y
|
||||
CPPCHECK_FLAGS ?=
|
||||
|
||||
# Sanity check user supplied values
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, SRC) |
||||
$(call ERROR_IF_EMPTY, CPPCHECK_MSG_TEMPLATE) |
||||
$(call ERROR_IF_EMPTY, CPPCHECK_ENABLE) |
||||
$(call ERROR_IF_NONBOOL, CPPCHECK_FAIL_ON_WARNING) |
||||
$(call ERROR_IF_NONBOOL, CPPCHECK_QUIET) |
||||
|
||||
# Build a default argument list for cppcheck
|
||||
BASE_CPPCHECK_FLAGS := --template="$(CPPCHECK_MSG_TEMPLATE)" $(CPPCHECK_INCLUDES:%=-I%) $(CPPCHECK_EXCLUDES:%=-i%) --inline-suppr --force --std=c99
|
||||
|
||||
# Sanity check parameters and construct additional command line arguments to cppcheck
|
||||
ifeq ($(CPPCHECK_FAIL_ON_WARNING), Y) |
||||
BASE_CPPCHECK_FLAGS += --error-exitcode=1
|
||||
endif |
||||
ifeq ($(CPPCHECK_QUIET), Y) |
||||
BASE_CPPCHECK_FLAGS += --quiet
|
||||
endif |
||||
|
||||
# Output Messages
|
||||
MSG_CPPCHECK_CMD := ' [CPPCHECK]:'
|
||||
|
||||
cppcheck-config: |
||||
@echo $(MSG_CPPCHECK_CMD) Checking cppcheck configuration check on source files
|
||||
cppcheck $(BASE_CPPCHECK_FLAGS) --check-config $(CPPCHECK_FLAGS) $(SRC)
|
||||
|
||||
cppcheck: |
||||
@echo $(MSG_CPPCHECK_CMD) Performing static analysis on source files
|
||||
cppcheck $(BASE_CPPCHECK_FLAGS) --enable=$(CPPCHECK_ENABLE) $(CPPCHECK_SUPPRESS:%=--suppress=%) $(CPPCHECK_FLAGS) $(SRC)
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: cppcheck-config cppcheck |
||||
@ -0,0 +1,93 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += DFU
|
||||
LUFA_BUILD_TARGETS += flip flip-ee dfu dfu-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA DFU Bootloader Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to re-program a device currently running a DFU
|
||||
# class bootloader with a project's FLASH and EEPROM files.
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# flip - Program FLASH into target via Atmel FLIP
|
||||
# flip-ee - Program EEPROM into target via Atmel FLIP
|
||||
# dfu - Program FLASH into target via dfu-programmer
|
||||
# dfu-ee - Program EEPROM into target via dfu-programmer
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# MCU - Microcontroller device model name
|
||||
# TARGET - Application name
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Sanity-check values of mandatory user-supplied variables
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, MCU) |
||||
$(call ERROR_IF_EMPTY, TARGET) |
||||
|
||||
# Output Messages
|
||||
MSG_COPY_CMD := ' [CP] :'
|
||||
MSG_REMOVE_CMD := ' [RM] :'
|
||||
MSG_DFU_CMD := ' [DFU] :'
|
||||
|
||||
flip: $(TARGET).hex $(MAKEFILE_LIST) |
||||
@echo $(MSG_DFU_CMD) Programming FLASH with batchisp using \"$<\"
|
||||
batchisp -hardware usb -device $(MCU) -operation erase f
|
||||
batchisp -hardware usb -device $(MCU) -operation loadbuffer $< program
|
||||
batchisp -hardware usb -device $(MCU) -operation start reset 0
|
||||
|
||||
flip-ee: $(TARGET).eep $(MAKEFILE_LIST) |
||||
@echo $(MSG_DFU_CMD) Copying EEP file to temporary file \"$<.hex\"
|
||||
cp $< $<.hex
|
||||
@echo $(MSG_DFU_CMD) Programming EEPROM with batchisp using \"$<.hex\"
|
||||
batchisp -hardware usb -device $(MCU) -operation memory EEPROM erase
|
||||
batchisp -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $<.hex program
|
||||
batchisp -hardware usb -device $(MCU) -operation start reset 0
|
||||
@echo $(MSG_DFU_CMD) Removing temporary file \"$<.hex\"
|
||||
rm $<.hex
|
||||
|
||||
dfu: $(TARGET).hex $(MAKEFILE_LIST) |
||||
@echo $(MSG_DFU_CMD) Programming FLASH with dfu-programmer using \"$<\"
|
||||
dfu-programmer $(MCU) erase
|
||||
dfu-programmer $(MCU) flash $<
|
||||
dfu-programmer $(MCU) reset
|
||||
|
||||
dfu-ee: $(TARGET).eep $(MAKEFILE_LIST) |
||||
@echo $(MSG_DFU_CMD) Programming EEPROM with dfu-programmer using \"$<\"
|
||||
dfu-programmer $(MCU) eeprom-flash $<
|
||||
dfu-programmer $(MCU) reset
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: flip flip-ee dfu dfu-ee |
||||
@ -0,0 +1,81 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += DOXYGEN
|
||||
LUFA_BUILD_TARGETS += doxygen
|
||||
LUFA_BUILD_MANDATORY_VARS += LUFA_PATH
|
||||
LUFA_BUILD_OPTIONAL_VARS += DOXYGEN_CONF DOXYGEN_FAIL_ON_WARNING DOXYGEN_OVERRIDE_PARAMS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA Doxygen Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to automatically build Doxygen documentation for
|
||||
# a project (see www.doxygen.org).
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# doxygen - Build Doxygen Documentation
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# LUFA_PATH - Path to the LUFA library core
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# DOXYGEN_CONF - Doxygen configuration filename
|
||||
# DOXYGEN_FAIL_ON_WARNING - Set to Y to fail the build on Doxygen warnings,
|
||||
# N to continue even if warnings occur
|
||||
# DOXYGEN_OVERRIDE_PARAMS - Parameters to override in the doxygen
|
||||
# configuration file
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Default values of optionally user-supplied variables
|
||||
DOXYGEN_CONF ?= Doxygen.conf
|
||||
DOXYGEN_FAIL_ON_WARNING ?= Y
|
||||
DOXYGEN_OVERRIDE_PARAMS ?= QUIET=YES HTML_STYLESHEET=$(patsubst %/,%,$(LUFA_PATH))/DoxygenPages/Style/Style.css
|
||||
|
||||
# Sanity check user supplied values
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, DOXYGEN_CONF) |
||||
$(call ERROR_IF_EMPTY, LUFA_PATH) |
||||
$(call ERROR_IF_NONBOOL, DOXYGEN_FAIL_ON_WARNING) |
||||
|
||||
# Output Messages
|
||||
MSG_DOXYGEN_CMD := ' [DOXYGEN] :'
|
||||
|
||||
# Determine Doxygen invocation command
|
||||
BASE_DOXYGEN_CMD := ( cat $(DOXYGEN_CONF) $(DOXYGEN_OVERRIDE_PARAMS:%=; echo "%") ) | doxygen -
|
||||
ifeq ($(DOXYGEN_FAIL_ON_WARNING), Y) |
||||
DOXYGEN_CMD := if ( $(BASE_DOXYGEN_CMD) 2>&1 | grep -v "warning: ignoring unsupported tag" ;); then exit 1; fi;
|
||||
else |
||||
DOXYGEN_CMD := $(BASE_DOXYGEN_CMD)
|
||||
endif |
||||
|
||||
doxygen: |
||||
@echo $(MSG_DOXYGEN_CMD) Configuration file \"$(DOXYGEN_CONF)\" with parameters \"$(DOXYGEN_OVERRIDE_PARAMS)\"
|
||||
$(DOXYGEN_CMD)
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: doxygen |
||||
@ -0,0 +1,88 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += HID
|
||||
LUFA_BUILD_TARGETS += hid hid-ee teensy teensy-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA HID Bootloader Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of targets to re-program a device currently running a HID
|
||||
# class bootloader with a project's FLASH files.
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# hid - Program FLASH into target via
|
||||
# hid_bootloader_cli
|
||||
# hid-ee - Program EEPROM into target via a temporary
|
||||
# AVR application and hid_bootloader_cli
|
||||
# teensy - Program FLASH into target via
|
||||
# teensy_loader_cli
|
||||
# teensy-ee - Program EEPROM into target via a temporary
|
||||
# AVR application and teensy_loader_cli
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# MCU - Microcontroller device model name
|
||||
# TARGET - Application name
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Sanity-check values of mandatory user-supplied variables
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, MCU) |
||||
$(call ERROR_IF_EMPTY, TARGET) |
||||
|
||||
# Output Messages
|
||||
MSG_HID_BOOTLOADER_CMD := ' [HID] :'
|
||||
MSG_OBJCPY_CMD := ' [OBJCPY] :'
|
||||
MSG_MAKE_CMD := ' [MAKE] :'
|
||||
|
||||
hid: $(TARGET).hex $(MAKEFILE_LIST) |
||||
@echo $(MSG_HID_BOOTLOADER_CMD) Programming FLASH with hid_bootloader_cli using \"$<\"
|
||||
hid_bootloader_cli -mmcu=$(MCU) -v $<
|
||||
|
||||
hid-ee: $(TARGET).eep $(MAKEFILE_LIST) |
||||
@echo $(MSG_OBJCPY_CMD) Converting \"$<\" to a binary file \"InputEEData.bin\"
|
||||
avr-objcopy -I ihex -O binary $< $(patsubst %/,%,$(LUFA_PATH))/Build/HID_EEPROM_Loader/InputEEData.bin
|
||||
@echo $(MSG_MAKE_CMD) Making EEPROM loader application for \"$<\"
|
||||
make -C $(patsubst %/,%,$(LUFA_PATH))/Build/HID_EEPROM_Loader/ MCU=$(MCU) clean hid
|
||||
|
||||
teensy: $(TARGET).hex $(MAKEFILE_LIST) |
||||
@echo $(MSG_HID_BOOTLOADER_CMD) Programming FLASH with teensy_loader_cli using \"$<\"
|
||||
teensy_loader_cli -mmcu=$(MCU) -v $<
|
||||
|
||||
teensy-ee: $(TARGET).hex $(MAKEFILE_LIST) |
||||
@echo $(MSG_OBJCPY_CMD) Converting \"$<\" to a binary file \"InputEEData.bin\"
|
||||
avr-objcopy -I ihex -O binary $< $(patsubst %/,%,$(LUFA_PATH))/Build/HID_EEPROM_Loader/InputEEData.bin
|
||||
@echo $(MSG_MAKE_CMD) Making EEPROM loader application for \"$<\"
|
||||
make -s -C $(patsubst %/,%,$(LUFA_PATH))/Build/HID_EEPROM_Loader/ MCU=$(MCU) clean hid-teensy
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: hid hid-ee teensy teensy-ee |
||||
@ -0,0 +1,116 @@ |
||||
#
|
||||
# LUFA Library
|
||||
# Copyright (C) Dean Camera, 2012.
|
||||
#
|
||||
# dean [at] fourwalledcubicle [dot] com
|
||||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += SOURCES
|
||||
LUFA_BUILD_TARGETS +=
|
||||
LUFA_BUILD_MANDATORY_VARS += LUFA_PATH ARCH
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS += LUFA_SRC_USB LUFA_SRC_USBCLASS LUFA_SRC_TEMPERATURE LUFA_SRC_SERIAL LUFA_SRC_TWI LUFA_SRC_PLATFORM
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA Sources Buildsystem Makefile Module.
|
||||
# -----------------------------------------------------------------------------
|
||||
# DESCRIPTION:
|
||||
# Provides a set of makefile variables for the various LUFA module sources.
|
||||
# Once included, the sources required to use a given LUFA module will become
|
||||
# available using the makefile variable names listed in the LUFA project
|
||||
# documentation.
|
||||
# -----------------------------------------------------------------------------
|
||||
# TARGETS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
# LUFA_PATH - Path to the LUFA library core
|
||||
# ARCH - Device architecture name
|
||||
#
|
||||
# OPTIONAL PARAMETERS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# LUFA_SRC_USB - List of LUFA USB driver source files
|
||||
# LUFA_SRC_USBCLASS - List of LUFA USB Class driver source files
|
||||
# LUFA_SRC_TEMPERATURE - List of LUFA temperature sensor driver source
|
||||
# files
|
||||
# LUFA_SRC_SERIAL - List of LUFA Serial U(S)ART driver source files
|
||||
# LUFA_SRC_TWI - List of LUFA TWI driver source files
|
||||
# LUFA_SRC_PLATFORM - List of LUFA architecture specific platform
|
||||
# management source files
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
SHELL = /bin/sh
|
||||
|
||||
ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
|
||||
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
|
||||
|
||||
# Sanity check user supplied values
|
||||
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR))) |
||||
$(call ERROR_IF_EMPTY, LUFA_PATH) |
||||
$(call ERROR_IF_EMPTY, ARCH) |
||||
|
||||
# Allow LUFA_ROOT_PATH to be overridden elsewhere to support legacy LUFA makefiles
|
||||
LUFA_ROOT_PATH ?= $(patsubst %/,%,$(LUFA_PATH))
|
||||
|
||||
# Construct LUFA module source variables
|
||||
LUFA_SRC_USB := $(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/Device_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/Endpoint_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/Host_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/Pipe_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/USBController_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/USBInterrupt_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/EndpointStream_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/$(ARCH)/PipeStream_$(ARCH).c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/ConfigDescriptors.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/DeviceStandardReq.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/Events.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/HostStandardReq.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Core/USBTask.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Common/HIDParser.c
|
||||
LUFA_SRC_USBCLASS := $(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/AudioClassDevice.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/CDCClassDevice.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/HIDClassDevice.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/MassStorageClassDevice.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/MIDIClassDevice.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Device/RNDISClassDevice.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/AndroidAccessoryClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/AudioClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/CDCClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/HIDClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/MassStorageClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/MIDIClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/PrinterClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/RNDISClassHost.c \
|
||||
$(LUFA_ROOT_PATH)/Drivers/USB/Class/Host/StillImageClassHost.c
|
||||
LUFA_SRC_TEMPERATURE := $(LUFA_ROOT_PATH)/Drivers/Board/Temperature.c
|
||||
LUFA_SRC_SERIAL := $(LUFA_ROOT_PATH)/Drivers/Peripheral/$(ARCH)/Serial_$(ARCH).c
|
||||
LUFA_SRC_TWI := $(LUFA_ROOT_PATH)/Drivers/Peripheral/$(ARCH)/TWI_$(ARCH).c
|
||||
|
||||
ifeq ($(ARCH), UC3) |
||||
LUFA_SRC_PLATFORM := $(LUFA_ROOT_PATH)/Platform/UC3/Exception.S \
|
||||
$(LUFA_ROOT_PATH)/Platform/UC3/InterruptManagement.c
|
||||
else |
||||
LUFA_SRC_PLATFORM :=
|
||||
endif |
||||
|
||||
# Build a list of all available module sources
|
||||
LUFA_SRC_ALL_FILES := $(LUFA_SRC_USB) \
|
||||
$(LUFA_SRC_USBCLASS) \
|
||||
$(LUFA_SRC_TEMPERATURE) \
|
||||
$(LUFA_SRC_SERIAL) \
|
||||
$(LUFA_SRC_TWI) \
|
||||
$(LUFA_SRC_PLATFORM)
|
||||
@ -0,0 +1,90 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief LUFA Custom Board Button Hardware Driver (Template) |
||||
* |
||||
* This is a stub driver header file, for implementing custom board |
||||
* layout hardware with compatible LUFA board specific drivers. If |
||||
* the library is configured to use the BOARD_USER board mode, this |
||||
* driver file should be completed and copied into the "/Board/" folder |
||||
* inside the application's folder. |
||||
* |
||||
* This stub is for the board-specific component of the LUFA Buttons driver, |
||||
* for the control of physical board-mounted GPIO pushbuttons. |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_USER_H__ |
||||
#define __BUTTONS_USER_H__ |
||||
|
||||
/* Includes: */ |
||||
// TODO: Add any required includes here
|
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 // TODO: Add mask for first board button here
|
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
// TODO: Initialize the appropriate port pins as an inputs here, with pull-ups
|
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
// TODO: Clear the appropriate port pins as high impedance inputs here
|
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
// TODO: Return current button status here, debounced if required
|
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
@ -0,0 +1,220 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief LUFA Custom Board Dataflash Hardware Driver (Template) |
||||
* |
||||
* This is a stub driver header file, for implementing custom board |
||||
* layout hardware with compatible LUFA board specific drivers. If |
||||
* the library is configured to use the BOARD_USER board mode, this |
||||
* driver file should be completed and copied into the "/Board/" folder |
||||
* inside the application's folder. |
||||
* |
||||
* This stub is for the board-specific component of the LUFA Dataflash |
||||
* driver. |
||||
*/ |
||||
|
||||
#ifndef __DATAFLASH_USER_H__ |
||||
#define __DATAFLASH_USER_H__ |
||||
|
||||
/* Includes: */ |
||||
// TODO: Add any required includes here
|
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_DATAFLASH_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define DATAFLASH_CHIPCS_MASK // TODO: Replace this with a mask of all the /CS pins of all Dataflashes
|
||||
#define DATAFLASH_CHIPCS_DDR // TODO: Replace with the DDR register name for the board's Dataflash ICs
|
||||
#define DATAFLASH_CHIPCS_PORT // TODO: Replace with the PORT register name for the board's Dataflash ICs
|
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Constant indicating the total number of dataflash ICs mounted on the selected board. */ |
||||
#define DATAFLASH_TOTALCHIPS 1 // TODO: Replace with the number of Dataflashes on the board, max 2
|
||||
|
||||
/** Mask for no dataflash chip selected. */ |
||||
#define DATAFLASH_NO_CHIP DATAFLASH_CHIPCS_MASK |
||||
|
||||
/** Mask for the first dataflash chip selected. */ |
||||
#define DATAFLASH_CHIP1 // TODO: Replace with mask to hold /CS of first Dataflash low, and all others high
|
||||
|
||||
/** Mask for the second dataflash chip selected. */ |
||||
#define DATAFLASH_CHIP2 // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high
|
||||
|
||||
/** Internal main memory page size for the board's dataflash ICs. */ |
||||
#define DATAFLASH_PAGE_SIZE // TODO: Replace with the page size for the Dataflash ICs
|
||||
|
||||
/** Total number of pages inside each of the board's dataflash ICs. */ |
||||
#define DATAFLASH_PAGES // TODO: Replace with the total number of pages inside one of the Dataflash ICs
|
||||
|
||||
/* Inline Functions: */ |
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. |
||||
*/ |
||||
static inline void Dataflash_Init(void) |
||||
{ |
||||
DATAFLASH_CHIPCS_DDR |= DATAFLASH_CHIPCS_MASK; |
||||
DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK; |
||||
} |
||||
|
||||
/** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
|
||||
* |
||||
* \param[in] Byte Byte of data to send to the dataflash |
||||
* |
||||
* \return Last response byte from the dataflash |
||||
*/ |
||||
static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; |
||||
static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) |
||||
{ |
||||
// TODO
|
||||
} |
||||
|
||||
/** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
|
||||
* |
||||
* \param[in] Byte Byte of data to send to the dataflash |
||||
*/ |
||||
static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; |
||||
static inline void Dataflash_SendByte(const uint8_t Byte) |
||||
{ |
||||
// TODO
|
||||
} |
||||
|
||||
/** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
|
||||
* |
||||
* \return Last response byte from the dataflash |
||||
*/ |
||||
static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Dataflash_ReceiveByte(void) |
||||
{ |
||||
// TODO
|
||||
} |
||||
|
||||
/** Determines the currently selected dataflash chip.
|
||||
* |
||||
* \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected |
||||
* or a DATAFLASH_CHIPn mask (where n is the chip number). |
||||
*/ |
||||
static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Dataflash_GetSelectedChip(void) |
||||
{ |
||||
return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK); |
||||
} |
||||
|
||||
/** Selects the given dataflash chip.
|
||||
* |
||||
* \param[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is |
||||
* the chip number). |
||||
*/ |
||||
static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE; |
||||
static inline void Dataflash_SelectChip(const uint8_t ChipMask) |
||||
{ |
||||
DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask); |
||||
} |
||||
|
||||
/** Deselects the current dataflash chip, so that no dataflash is selected. */ |
||||
static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE; |
||||
static inline void Dataflash_DeselectChip(void) |
||||
{ |
||||
Dataflash_SelectChip(DATAFLASH_NO_CHIP); |
||||
} |
||||
|
||||
/** Selects a dataflash IC from the given page number, which should range from 0 to
|
||||
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one |
||||
* dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside |
||||
* the total number of pages contained in the boards dataflash ICs, all dataflash ICs |
||||
* are deselected. |
||||
* |
||||
* \param[in] PageAddress Address of the page to manipulate, ranging from |
||||
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). |
||||
*/ |
||||
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) |
||||
{ |
||||
Dataflash_DeselectChip(); |
||||
|
||||
if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS)) |
||||
return; |
||||
|
||||
#if (DATAFLASH_TOTALCHIPS == 2) |
||||
if (PageAddress & 0x01) |
||||
Dataflash_SelectChip(DATAFLASH_CHIP2); |
||||
else |
||||
Dataflash_SelectChip(DATAFLASH_CHIP1); |
||||
#else |
||||
Dataflash_SelectChip(DATAFLASH_CHIP1); |
||||
#endif |
||||
} |
||||
|
||||
/** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
|
||||
* a new command. |
||||
*/ |
||||
static inline void Dataflash_ToggleSelectedChipCS(void) |
||||
{ |
||||
uint8_t SelectedChipMask = Dataflash_GetSelectedChip(); |
||||
|
||||
Dataflash_DeselectChip(); |
||||
Dataflash_SelectChip(SelectedChipMask); |
||||
} |
||||
|
||||
/** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
|
||||
* memory page program or main memory to buffer transfer. |
||||
*/ |
||||
static inline void Dataflash_WaitWhileBusy(void) |
||||
{ |
||||
Dataflash_ToggleSelectedChipCS(); |
||||
Dataflash_SendByte(DF_CMD_GETSTATUS); |
||||
while (!(Dataflash_ReceiveByte() & DF_STATUS_READY)); |
||||
Dataflash_ToggleSelectedChipCS(); |
||||
} |
||||
|
||||
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
|
||||
* dataflash commands which require a complete 24-bit address. |
||||
* |
||||
* \param[in] PageAddress Page address within the selected dataflash IC |
||||
* \param[in] BufferByte Address within the dataflash's buffer |
||||
*/ |
||||
static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte) |
||||
{ |
||||
#if (DATAFLASH_TOTALCHIPS == 2) |
||||
PageAddress >>= 1; |
||||
#endif |
||||
|
||||
Dataflash_SendByte(PageAddress >> 5); |
||||
Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8)); |
||||
Dataflash_SendByte(BufferByte); |
||||
} |
||||
|
||||
#endif |
||||
|
||||
@ -0,0 +1,102 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief LUFA Custom Board Joystick Hardware Driver (Template) |
||||
* |
||||
* This is a stub driver header file, for implementing custom board |
||||
* layout hardware with compatible LUFA board specific drivers. If |
||||
* the library is configured to use the BOARD_USER board mode, this |
||||
* driver file should be completed and copied into the "/Board/" folder |
||||
* inside the application's folder. |
||||
* |
||||
* This stub is for the board-specific component of the LUFA Joystick |
||||
* driver, for a digital four-way (plus button) joystick. |
||||
*/ |
||||
|
||||
#ifndef __JOYSTICK_USER_H__ |
||||
#define __JOYSTICK_USER_H__ |
||||
|
||||
/* Includes: */ |
||||
// TODO: Add any required includes here
|
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_JOYSTICK_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Mask for the joystick being pushed in the left direction. */ |
||||
#define JOY_LEFT // TODO: Add mask to indicate joystick left position here
|
||||
|
||||
/** Mask for the joystick being pushed in the right direction. */ |
||||
#define JOY_RIGHT // TODO: Add mask to indicate joystick right position here
|
||||
|
||||
/** Mask for the joystick being pushed in the upward direction. */ |
||||
#define JOY_UP // TODO: Add mask to indicate joystick up position here
|
||||
|
||||
/** Mask for the joystick being pushed in the downward direction. */ |
||||
#define JOY_DOWN // TODO: Add mask to indicate joystick down position here
|
||||
|
||||
/** Mask for the joystick being pushed inward. */ |
||||
#define JOY_PRESS // TODO: Add mask to indicate joystick pressed position here
|
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Joystick_Init(void) |
||||
{ |
||||
// TODO: Initialize joystick port pins as inputs with pull-ups
|
||||
} |
||||
|
||||
static inline void Joystick_Disable(void) |
||||
{ |
||||
// TODO: Clear the joystick pins as high impedance inputs here
|
||||
} |
||||
|
||||
static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Joystick_GetStatus(void) |
||||
{ |
||||
// TODO: Return current joystick position data which can be obtained by masking against the JOY_* macros
|
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
@ -0,0 +1,130 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief LUFA Custom Board LED Hardware Driver (Template) |
||||
* |
||||
* This is a stub driver header file, for implementing custom board |
||||
* layout hardware with compatible LUFA board specific drivers. If |
||||
* the library is configured to use the BOARD_USER board mode, this |
||||
* driver file should be completed and copied into the "/Board/" folder |
||||
* inside the application's folder. |
||||
* |
||||
* This stub is for the board-specific component of the LUFA LEDs driver, |
||||
* for the LEDs (up to four) mounted on most development boards. |
||||
*/ |
||||
|
||||
#ifndef __LEDS_USER_H__ |
||||
#define __LEDS_USER_H__ |
||||
|
||||
/* Includes: */ |
||||
// TODO: Add any required includes here
|
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 // TODO: Add mask for first board LED here
|
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 // TODO: Add mask for second board LED here
|
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 // TODO: Add mask for third board LED here
|
||||
|
||||
/** LED mask for the fourth LED on the board. */ |
||||
#define LEDS_LED4 // TODO: Add mask for fourth board LED here
|
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
// TODO: Add code to initialize LED port pins as outputs here
|
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
// TODO: Clear the LED port pins as high impedance inputs here
|
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
// TODO: Add code to turn on LEDs given in the LEDMask mask here, leave others as-is
|
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
// TODO: Add code to turn off LEDs given in the LEDMask mask here, leave others as-is
|
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
// TODO: Add code to turn on only LEDs given in the LEDMask mask here, all others off
|
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask) |
||||
{ |
||||
// TODO: Add code to set the Leds in the given LEDMask to the status given in ActiveMask here
|
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
// TODO: Add code to toggle the Leds in the given LEDMask, ignoring all others
|
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
// TODO: Add code to return the current LEDs status' here which can be masked against LED_LED* macros
|
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
@ -0,0 +1,167 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief LUFA Library Configuration Header File (Template) |
||||
* |
||||
* This is a header file which can be used to configure LUFA's |
||||
* compile time options, as an alternative to the compile time |
||||
* constants supplied through a makefile. To use this configuration |
||||
* header, copy this into your project's root directory and supply |
||||
* the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is |
||||
* defined in all compiled source files. |
||||
* |
||||
* For information on what each token does, refer to the LUFA |
||||
* manual section "Summary of Compile Tokens". |
||||
*/ |
||||
|
||||
#ifndef __LUFA_CONFIG_H__ |
||||
#define __LUFA_CONFIG_H__ |
||||
|
||||
#if (ARCH == ARCH_AVR8) |
||||
|
||||
/* Non-USB Related Configuration Tokens: */ |
||||
// #define DISABLE_TERMINAL_CODES
|
||||
|
||||
/* USB Class Driver Related Tokens: */ |
||||
// #define HID_HOST_BOOT_PROTOCOL_ONLY
|
||||
// #define HID_STATETABLE_STACK_DEPTH {Insert Value Here}
|
||||
// #define HID_USAGE_STACK_DEPTH {Insert Value Here}
|
||||
// #define HID_MAX_COLLECTIONS {Insert Value Here}
|
||||
// #define HID_MAX_REPORTITEMS {Insert Value Here}
|
||||
// #define HID_MAX_REPORT_IDS {Insert Value Here}
|
||||
// #define NO_CLASS_DRIVER_AUTOFLUSH
|
||||
|
||||
/* General USB Driver Related Tokens: */ |
||||
// #define ORDERED_EP_CONFIG
|
||||
// #define USE_STATIC_OPTIONS {Insert Value Here}
|
||||
// #define USB_DEVICE_ONLY
|
||||
// #define USB_HOST_ONLY
|
||||
// #define USB_STREAM_TIMEOUT_MS {Insert Value Here}
|
||||
// #define NO_LIMITED_CONTROLLER_CONNECT
|
||||
// #define NO_SOF_EVENTS
|
||||
|
||||
/* USB Device Mode Driver Related Tokens: */ |
||||
// #define USE_RAM_DESCRIPTORS
|
||||
// #define USE_FLASH_DESCRIPTORS
|
||||
// #define USE_EEPROM_DESCRIPTORS
|
||||
// #define NO_INTERNAL_SERIAL
|
||||
// #define FIXED_CONTROL_ENDPOINT_SIZE {Insert Value Here}
|
||||
// #define DEVICE_STATE_AS_GPIOR {Insert Value Here}
|
||||
// #define FIXED_NUM_CONFIGURATIONS {Insert Value Here}
|
||||
// #define CONTROL_ONLY_DEVICE
|
||||
// #define INTERRUPT_CONTROL_ENDPOINT
|
||||
// #define NO_DEVICE_REMOTE_WAKEUP
|
||||
// #define NO_DEVICE_SELF_POWER
|
||||
|
||||
/* USB Host Mode Driver Related Tokens: */ |
||||
// #define HOST_STATE_AS_GPIOR {Insert Value Here}
|
||||
// #define USB_HOST_TIMEOUT_MS {Insert Value Here}
|
||||
// #define HOST_DEVICE_SETTLE_DELAY_MS {Insert Value Here}
|
||||
// #define NO_AUTO_VBUS_MANAGEMENT
|
||||
// #define INVERTED_VBUS_ENABLE_LINE
|
||||
|
||||
#elif (ARCH == ARCH_XMEGA) |
||||
|
||||
/* Non-USB Related Configuration Tokens: */ |
||||
// #define DISABLE_TERMINAL_CODES
|
||||
|
||||
/* USB Class Driver Related Tokens: */ |
||||
// #define HID_HOST_BOOT_PROTOCOL_ONLY
|
||||
// #define HID_STATETABLE_STACK_DEPTH {Insert Value Here}
|
||||
// #define HID_USAGE_STACK_DEPTH {Insert Value Here}
|
||||
// #define HID_MAX_COLLECTIONS {Insert Value Here}
|
||||
// #define HID_MAX_REPORTITEMS {Insert Value Here}
|
||||
// #define HID_MAX_REPORT_IDS {Insert Value Here}
|
||||
// #define NO_CLASS_DRIVER_AUTOFLUSH
|
||||
|
||||
/* General USB Driver Related Tokens: */ |
||||
// #define USE_STATIC_OPTIONS {Insert Value Here}
|
||||
// #define USB_STREAM_TIMEOUT_MS {Insert Value Here}
|
||||
// #define NO_LIMITED_CONTROLLER_CONNECT
|
||||
// #define NO_SOF_EVENTS
|
||||
|
||||
/* USB Device Mode Driver Related Tokens: */ |
||||
// #define USE_RAM_DESCRIPTORS
|
||||
// #define USE_FLASH_DESCRIPTORS
|
||||
// #define USE_EEPROM_DESCRIPTORS
|
||||
// #define NO_INTERNAL_SERIAL
|
||||
// #define FIXED_CONTROL_ENDPOINT_SIZE {Insert Value Here}
|
||||
// #define DEVICE_STATE_AS_GPIOR {Insert Value Here}
|
||||
// #define FIXED_NUM_CONFIGURATIONS {Insert Value Here}
|
||||
// #define CONTROL_ONLY_DEVICE
|
||||
// #define MAX_ENDPOINT_INDEX {Insert Value Here}
|
||||
// #define NO_DEVICE_REMOTE_WAKEUP
|
||||
// #define NO_DEVICE_SELF_POWER
|
||||
|
||||
#elif (ARCH == ARCH_UC3) |
||||
|
||||
/* Non-USB Related Configuration Tokens: */ |
||||
// #define DISABLE_TERMINAL_CODES
|
||||
|
||||
/* USB Class Driver Related Tokens: */ |
||||
// #define HID_HOST_BOOT_PROTOCOL_ONLY
|
||||
// #define HID_STATETABLE_STACK_DEPTH {Insert Value Here}
|
||||
// #define HID_USAGE_STACK_DEPTH {Insert Value Here}
|
||||
// #define HID_MAX_COLLECTIONS {Insert Value Here}
|
||||
// #define HID_MAX_REPORTITEMS {Insert Value Here}
|
||||
// #define HID_MAX_REPORT_IDS {Insert Value Here}
|
||||
// #define NO_CLASS_DRIVER_AUTOFLUSH
|
||||
|
||||
/* General USB Driver Related Tokens: */ |
||||
// #define ORDERED_EP_CONFIG
|
||||
// #define USE_STATIC_OPTIONS {Insert Value Here}
|
||||
// #define USB_DEVICE_ONLY
|
||||
// #define USB_HOST_ONLY
|
||||
// #define USB_STREAM_TIMEOUT_MS {Insert Value Here}
|
||||
// #define NO_SOF_EVENTS
|
||||
|
||||
/* USB Device Mode Driver Related Tokens: */ |
||||
// #define NO_INTERNAL_SERIAL
|
||||
// #define FIXED_CONTROL_ENDPOINT_SIZE {Insert Value Here}
|
||||
// #define FIXED_NUM_CONFIGURATIONS {Insert Value Here}
|
||||
// #define CONTROL_ONLY_DEVICE
|
||||
// #define INTERRUPT_CONTROL_ENDPOINT
|
||||
// #define NO_DEVICE_REMOTE_WAKEUP
|
||||
// #define NO_DEVICE_SELF_POWER
|
||||
|
||||
/* USB Host Mode Driver Related Tokens: */ |
||||
// #define USB_HOST_TIMEOUT_MS {Insert Value Here}
|
||||
// #define HOST_DEVICE_SETTLE_DELAY_MS {Insert Value Here}
|
||||
// #define NO_AUTO_VBUS_MANAGEMENT
|
||||
// #define INVERTED_VBUS_ENABLE_LINE
|
||||
|
||||
#else |
||||
|
||||
#error Unsupported architecture for this LUFA configuration file. |
||||
|
||||
#endif |
||||
#endif |
||||
|
||||
@ -0,0 +1,36 @@ |
||||
# |
||||
# LUFA Library |
||||
# Copyright (C) Dean Camera, 2012. |
||||
# |
||||
# dean [at] fourwalledcubicle [dot] com |
||||
# www.lufa-lib.org |
||||
# |
||||
# -------------------------------------- |
||||
# LUFA Project Makefile. |
||||
# -------------------------------------- |
||||
|
||||
MCU = at90usb1287 |
||||
ARCH = AVR8 |
||||
BOARD = USBKEY |
||||
F_CPU = 8000000 |
||||
F_USB = $(F_CPU) |
||||
OPTIMIZATION = s |
||||
TARGET = Target |
||||
SRC = $(TARGET).c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS) $(LUFA_SRC_PLATFORM) |
||||
LUFA_PATH = ../../LUFA |
||||
CC_FLAGS = -DUSE_LUFA_CONFIG_HEADER -IConfig |
||||
LD_FLAGS = |
||||
|
||||
# Default target |
||||
all: |
||||
|
||||
# Include LUFA build script makefiles |
||||
include $(LUFA_PATH)/Build/lufa_core.mk |
||||
include $(LUFA_PATH)/Build/lufa_sources.mk |
||||
include $(LUFA_PATH)/Build/lufa_build.mk |
||||
include $(LUFA_PATH)/Build/lufa_cppcheck.mk |
||||
include $(LUFA_PATH)/Build/lufa_doxygen.mk |
||||
include $(LUFA_PATH)/Build/lufa_dfu.mk |
||||
include $(LUFA_PATH)/Build/lufa_hid.mk |
||||
include $(LUFA_PATH)/Build/lufa_avrdude.mk |
||||
include $(LUFA_PATH)/Build/lufa_atprogram.mk |
||||
@ -0,0 +1,177 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Architecture specific definitions relating to specific processor architectures. |
||||
* |
||||
* \copydetails Group_ArchitectureSpecific |
||||
* |
||||
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's |
||||
* functionality. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Common
|
||||
* \defgroup Group_ArchitectureSpecific Architecture Specific Definitions |
||||
* \brief Architecture specific definitions relating to specific processor architectures. |
||||
* |
||||
* Architecture specific macros, functions and other definitions, which relate to specific architectures. This |
||||
* definitions may or may not be available in some form on other architectures, and thus should be protected by |
||||
* preprocessor checks in portable code to prevent compile errors. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LUFA_ARCHSPEC_H__ |
||||
#define __LUFA_ARCHSPEC_H__ |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_COMMON_H) |
||||
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality. |
||||
#endif |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
#if (ARCH == ARCH_AVR8) || (ARCH == ARCH_XMEGA) || defined(__DOXYGEN__) |
||||
#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__) |
||||
/** Re-enables the AVR's JTAG bus in software, until a system reset. This will re-enable JTAG debugging
|
||||
* interface after is has been disabled in software via \ref JTAG_DISABLE(). |
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
*/ |
||||
#define JTAG_ENABLE() MACROS{ \ |
||||
__asm__ __volatile__ ( \
|
||||
"in __tmp_reg__,__SREG__" "\n\t" \
|
||||
"cli" "\n\t" \
|
||||
"out %1, %0" "\n\t" \
|
||||
"out __SREG__, __tmp_reg__" "\n\t" \
|
||||
"out %1, %0" "\n\t" \
|
||||
: \
|
||||
: "r" (MCUCR & ~(1 << JTD)), \
|
||||
"M" (_SFR_IO_ADDR(MCUCR)) \
|
||||
: "r0"); \
|
||||
}MACROE |
||||
|
||||
/** Disables the AVR's JTAG bus in software, until a system reset. This will override the current JTAG
|
||||
* status as set by the JTAGEN fuse, disabling JTAG debugging and reverting the JTAG pins back to GPIO |
||||
* mode. |
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
*/ |
||||
#define JTAG_DISABLE() MACROS{ \ |
||||
__asm__ __volatile__ ( \
|
||||
"in __tmp_reg__,__SREG__" "\n\t" \
|
||||
"cli" "\n\t" \
|
||||
"out %1, %0" "\n\t" \
|
||||
"out __SREG__, __tmp_reg__" "\n\t" \
|
||||
"out %1, %0" "\n\t" \
|
||||
: \
|
||||
: "r" (MCUCR | (1 << JTD)), \
|
||||
"M" (_SFR_IO_ADDR(MCUCR)) \
|
||||
: "r0"); \
|
||||
}MACROE |
||||
#endif |
||||
|
||||
/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
|
||||
* be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer |
||||
* removes/reorders code to the point where break points cannot reliably be set. |
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
*/ |
||||
#define JTAG_DEBUG_POINT() __asm__ __volatile__ ("nop" ::) |
||||
|
||||
/** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
|
||||
* a JTAG is used, this causes the program execution to halt when reached until manually resumed. |
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
*/ |
||||
#define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("break" ::) |
||||
|
||||
/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
|
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
* |
||||
* \param[in] Condition Condition that will be evaluated. |
||||
*/ |
||||
#define JTAG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE |
||||
|
||||
/** Macro for testing condition \c "x" and writing debug data to the stdout stream if \c false. The stdout stream
|
||||
* must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's |
||||
* USART peripheral. |
||||
* |
||||
* The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed." |
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
* |
||||
* \param[in] Condition Condition that will be evaluated, |
||||
*/ |
||||
#define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { \ |
||||
printf_P(PSTR("%s: Function \"%s\", Line %d: " \
|
||||
"Assertion \"%s\" failed.\r\n"), \
|
||||
__FILE__, __func__, __LINE__, #Condition); } }MACROE |
||||
|
||||
#if !defined(pgm_read_ptr) || defined(__DOXYGEN__) |
||||
/** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the
|
||||
* avr-libc \c pgm_read_ptr() macro with a \c void* cast, so that its value can be assigned directly |
||||
* to a pointer variable or used in pointer arithmetic without further casting in C. In a future |
||||
* avr-libc distribution this will be part of the standard API and will be implemented in a more formal |
||||
* manner. |
||||
* |
||||
* \note This macro is not available for all architectures. |
||||
* |
||||
* \param[in] Address Address of the pointer to read. |
||||
* |
||||
* \return Pointer retrieved from PROGMEM space. |
||||
*/ |
||||
#define pgm_read_ptr(Address) (void*)pgm_read_word(Address) |
||||
#endif |
||||
#elif (ARCH == ARCH_UC3) |
||||
#define JTAG_DEBUG_POINT() __asm__ __volatile__ ("nop" ::) |
||||
#define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("breakpoint" ::) |
||||
#define JTAG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE |
||||
#define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { \ |
||||
printf("%s: Function \"%s\", Line %d: " \
|
||||
"Assertion \"%s\" failed.\r\n"), \
|
||||
__FILE__, __func__, __LINE__, #Condition); } }MACROE |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,84 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Supported library architecture defines. |
||||
* |
||||
* \copydetails Group_Architectures |
||||
* |
||||
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's |
||||
* functionality. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Common
|
||||
* \defgroup Group_Architectures Hardware Architectures |
||||
* \brief Supported library architecture defines. |
||||
* |
||||
* Architecture macros for selecting the desired target microcontroller architecture. One of these values should be |
||||
* defined as the value of \c ARCH in the user project makefile via the \c -D compiler switch to GCC, to select the |
||||
* target architecture. |
||||
* |
||||
* The selected architecture should remain consistent with the makefile \c ARCH value, which is used to select the |
||||
* underlying driver source files for each architecture. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LUFA_ARCHITECTURES_H__ |
||||
#define __LUFA_ARCHITECTURES_H__ |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_COMMON_H) |
||||
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Selects the Atmel 8-bit AVR (AT90USB* and ATMEGA*U* chips) architecture. */ |
||||
#define ARCH_AVR8 0 |
||||
|
||||
/** Selects the Atmel 32-bit UC3 AVR (AT32UC3* chips) architecture. */ |
||||
#define ARCH_UC3 1 |
||||
|
||||
/** Selects the Atmel XMEGA AVR (ATXMEGA*U chips) architecture. */ |
||||
#define ARCH_XMEGA 2 |
||||
|
||||
#if !defined(__DOXYGEN__) |
||||
#define ARCH_ ARCH_AVR8 |
||||
|
||||
#if !defined(ARCH) |
||||
#define ARCH ARCH_AVR8 |
||||
#endif |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,150 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Special function/variable attribute macros. |
||||
* |
||||
* \copydetails Group_FuncVarAttributes |
||||
* |
||||
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's |
||||
* functionality. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Common
|
||||
* \defgroup Group_FuncVarAttributes Function/Variable Attributes |
||||
* \brief Special function/variable attribute macros. |
||||
* |
||||
* This module contains macros for applying specific attributes to functions and variables to control various |
||||
* optimizer and code generation features of the compiler. Attributes may be placed in the function prototype |
||||
* or variable declaration in any order, and multiple attributes can be specified for a single item via a space |
||||
* separated list. |
||||
* |
||||
* On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are |
||||
* critical to the code's function and thus must throw a compile error when used. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LUFA_ATTR_H__ |
||||
#define __LUFA_ATTR_H__ |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_COMMON_H) |
||||
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
#if (__GNUC__ >= 3) || defined(__DOXYGEN__) |
||||
/** Indicates to the compiler that the function can not ever return, so that any stack restoring or
|
||||
* return code may be omitted by the compiler in the resulting binary. |
||||
*/ |
||||
#define ATTR_NO_RETURN __attribute__ ((noreturn)) |
||||
|
||||
/** Indicates that the function returns a value which should not be ignored by the user code. When
|
||||
* applied, any ignored return value from calling the function will produce a compiler warning. |
||||
*/ |
||||
#define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result)) |
||||
|
||||
/** Indicates that the specified parameters of the function are pointers which should never be \c NULL.
|
||||
* When applied as a 1-based comma separated list the compiler will emit a warning if the specified |
||||
* parameters are known at compiler time to be \c NULL at the point of calling the function. |
||||
*/ |
||||
#define ATTR_NON_NULL_PTR_ARG(...) __attribute__ ((nonnull (__VA_ARGS__))) |
||||
|
||||
/** Removes any preamble or postamble from the function. When used, the function will not have any
|
||||
* register or stack saving code. This should be used with caution, and when used the programmer |
||||
* is responsible for maintaining stack and register integrity. |
||||
*/ |
||||
#define ATTR_NAKED __attribute__ ((naked)) |
||||
|
||||
/** Prevents the compiler from considering a specified function for in-lining. When applied, the given
|
||||
* function will not be in-lined under any circumstances. |
||||
*/ |
||||
#define ATTR_NO_INLINE __attribute__ ((noinline)) |
||||
|
||||
/** Forces the compiler to inline the specified function. When applied, the given function will be
|
||||
* in-lined under all circumstances. |
||||
*/ |
||||
#define ATTR_ALWAYS_INLINE __attribute__ ((always_inline)) |
||||
|
||||
/** Indicates that the specified function is pure, in that it has no side-effects other than global
|
||||
* or parameter variable access. |
||||
*/ |
||||
#define ATTR_PURE __attribute__ ((pure)) |
||||
|
||||
/** Indicates that the specified function is constant, in that it has no side effects other than
|
||||
* parameter access. |
||||
*/ |
||||
#define ATTR_CONST __attribute__ ((const)) |
||||
|
||||
/** Marks a given function as deprecated, which produces a warning if the function is called. */ |
||||
#define ATTR_DEPRECATED __attribute__ ((deprecated)) |
||||
|
||||
/** Marks a function as a weak reference, which can be overridden by other functions with an
|
||||
* identical name (in which case the weak reference is discarded at link time). |
||||
*/ |
||||
#define ATTR_WEAK __attribute__ ((weak)) |
||||
#endif |
||||
|
||||
/** Forces the compiler to not automatically zero the given global variable on startup, so that the
|
||||
* current RAM contents is retained. Under most conditions this value will be random due to the |
||||
* behavior of volatile memory once power is removed, but may be used in some specific circumstances, |
||||
* like the passing of values back after a system watchdog reset. |
||||
*/ |
||||
#define ATTR_NO_INIT __attribute__ ((section (".noinit"))) |
||||
|
||||
/** Places the function in one of the initialization sections, which execute before the main function
|
||||
* of the application. Refer to the avr-libc manual for more information on the initialization sections. |
||||
* |
||||
* \param[in] SectionIndex Initialization section number where the function should be placed. |
||||
*/ |
||||
#define ATTR_INIT_SECTION(SectionIndex) __attribute__ ((used, naked, section (".init" #SectionIndex ))) |
||||
|
||||
/** Marks a function as an alias for another function.
|
||||
* |
||||
* \param[in] Func Name of the function which the given function name should alias. |
||||
*/ |
||||
#define ATTR_ALIAS(Func) __attribute__ ((alias( #Func ))) |
||||
|
||||
/** Marks a variable or struct element for packing into the smallest space available, omitting any
|
||||
* alignment bytes usually added between fields to optimize field accesses. |
||||
*/ |
||||
#define ATTR_PACKED __attribute__ ((packed)) |
||||
|
||||
/** Indicates the minimum alignment in bytes for a variable or struct element.
|
||||
* |
||||
* \param[in] Bytes Minimum number of bytes the item should be aligned to. |
||||
*/ |
||||
#define ATTR_ALIGNED(Bytes) __attribute__ ((aligned(Bytes))) |
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,231 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Supported pre-made board hardware defines. |
||||
* |
||||
* \copydetails Group_BoardTypes |
||||
* |
||||
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's |
||||
* functionality. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Common
|
||||
* \defgroup Group_BoardTypes Board Types |
||||
* \brief Supported pre-made board hardware defines. |
||||
* |
||||
* Board macros for indicating the chosen physical board hardware to the library. These macros should be used when |
||||
* defining the \c BOARD token to the chosen hardware via the \c -D switch in the project makefile. If a custom |
||||
* board is used, the \ref BOARD_NONE or \ref BOARD_USER values should be selected. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LUFA_BOARDTYPES_H__ |
||||
#define __LUFA_BOARDTYPES_H__ |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_COMMON_H) |
||||
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Selects the user-defined board drivers, which should be placed in the user project's folder
|
||||
* under a directory named \c /Board/. Each board driver should be named identically to the LUFA |
||||
* master board driver (i.e., driver in the \c LUFA/Drivers/Board directory) so that the library |
||||
* can correctly identify it. |
||||
*/ |
||||
#define BOARD_USER 0 |
||||
|
||||
/** Disables board drivers when operation will not be adversely affected (e.g. LEDs) - use of board drivers
|
||||
* such as the Joystick driver, where the removal would adversely affect the code's operation is still disallowed. */ |
||||
#define BOARD_NONE 1 |
||||
|
||||
/** Selects the USBKEY specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */ |
||||
#define BOARD_USBKEY 2 |
||||
|
||||
/** Selects the STK525 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */ |
||||
#define BOARD_STK525 3 |
||||
|
||||
/** Selects the STK526 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */ |
||||
#define BOARD_STK526 4 |
||||
|
||||
/** Selects the RZUSBSTICK specific board drivers, including the driver for the boards LEDs. */ |
||||
#define BOARD_RZUSBSTICK 5 |
||||
|
||||
/** Selects the ATAVRUSBRF01 specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_ATAVRUSBRF01 6 |
||||
|
||||
/** Selects the BUMBLEB specific board drivers, using the officially recommended peripheral layout. */ |
||||
#define BOARD_BUMBLEB 7 |
||||
|
||||
/** Selects the XPLAIN (Revision 2 or newer) specific board drivers, including LED and Dataflash drivers. */ |
||||
#define BOARD_XPLAIN 8 |
||||
|
||||
/** Selects the XPLAIN (Revision 1) specific board drivers, including LED and Dataflash drivers. */ |
||||
#define BOARD_XPLAIN_REV1 9 |
||||
|
||||
/** Selects the EVK527 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */ |
||||
#define BOARD_EVK527 10 |
||||
|
||||
/** Selects the Teensy version 1.x specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_TEENSY 11 |
||||
|
||||
/** Selects the USBTINY MKII specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_USBTINYMKII 12 |
||||
|
||||
/** Selects the Benito specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_BENITO 13 |
||||
|
||||
/** Selects the JM-DB-U2 specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_JMDBU2 14 |
||||
|
||||
/** Selects the Olimex AVR-USB-162 specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_OLIMEX162 15 |
||||
|
||||
/** Selects the UDIP specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_UDIP 16 |
||||
|
||||
/** Selects the BUI specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_BUI 17 |
||||
|
||||
/** Selects the Arduino Uno specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_UNO 18 |
||||
|
||||
/** Selects the Busware CUL V3 specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_CULV3 19 |
||||
|
||||
/** Selects the Blackcat USB JTAG specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_BLACKCAT 20 |
||||
|
||||
/** Selects the Maximus specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_MAXIMUS 21 |
||||
|
||||
/** Selects the Minimus specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_MINIMUS 22 |
||||
|
||||
/** Selects the Adafruit U4 specific board drivers, including the Button driver. */ |
||||
#define BOARD_ADAFRUITU4 23 |
||||
|
||||
/** Selects the Microsin AVR-USB162 specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_MICROSIN162 24 |
||||
|
||||
/** Selects the Kernel Concepts USBFOO specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_USBFOO 25 |
||||
|
||||
/** Selects the Sparkfun ATMEGA8U2 specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_SPARKFUN8U2 26 |
||||
|
||||
/** Selects the Atmel EVK1101 specific board drivers, including the Button, Joystick and LED drivers. */ |
||||
#define BOARD_EVK1101 27 |
||||
|
||||
/** Selects the Busware TUL specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_TUL 28 |
||||
|
||||
/** Selects the Atmel EVK1100 specific board drivers, including the Button, Joystick and LED drivers. */ |
||||
#define BOARD_EVK1100 29 |
||||
|
||||
/** Selects the Atmel EVK1104 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_EVK1104 30 |
||||
|
||||
/** Selects the Atmel XMEGA A3BU Xplained specific board drivers, including Dataflash, Button and LED drivers. */ |
||||
#define BOARD_A3BU_XPLAINED 31 |
||||
|
||||
/** Selects the Teensy version 2.x specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_TEENSY2 32 |
||||
|
||||
/** Selects the USB2AX version 1 and 2 specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_USB2AX 33 |
||||
|
||||
/** Selects the USB2AX version 3 specific board drivers, including the Button and LEDs drivers. */ |
||||
#define BOARD_USB2AX_V3 34 |
||||
|
||||
/** Selects the Micropendous 32U2 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_MICROPENDOUS_32U2 35 |
||||
|
||||
/** Selects the Micropendous A specific board drivers, including the driver for the board Button. */ |
||||
#define BOARD_MICROPENDOUS_A 36 |
||||
|
||||
/** Selects the Micropendous 1 specific board drivers, including the driver for the board Button. */ |
||||
#define BOARD_MICROPENDOUS_1 37 |
||||
|
||||
/** Selects the Micropendous 2 specific board drivers, including the driver for the board Button. */ |
||||
#define BOARD_MICROPENDOUS_2 38 |
||||
|
||||
/** Selects the Micropendous 3 specific board drivers, including the driver for the board Button. */ |
||||
#define BOARD_MICROPENDOUS_3 39 |
||||
|
||||
/** Selects the Micropendous 4 specific board drivers, including the driver for the board Button. */ |
||||
#define BOARD_MICROPENDOUS_4 40 |
||||
|
||||
/** Selects the Micropendous DIP specific board drivers, including the driver for the board Button. */ |
||||
#define BOARD_MICROPENDOUS_DIP 41 |
||||
|
||||
/** Selects the Micropendous (Arduino-like) revision 1 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_MICROPENDOUS_REV1 42 |
||||
|
||||
/** Selects the Micropendous (Arduino-like) revision 2 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_MICROPENDOUS_REV2 43 |
||||
|
||||
/** Selects the XMEGA B1 Xplained specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_B1_XPLAINED 44 |
||||
|
||||
/** Selects the Bitwizard Multio specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_MULTIO 45 |
||||
|
||||
/** Selects the Bitwizard Big-Multio specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_BIGMULTIO 46 |
||||
|
||||
/** Selects the DorkbotPDX Duce specific board drivers, including the driver for the board LEDs. */ |
||||
#define BOARD_DUCE 47 |
||||
|
||||
/** Selects the Olimex AVR-USB-32U4 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_OLIMEX32U4 48 |
||||
|
||||
/** Selects the Olimex AVR-USB-T32U4 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_OLIMEXT32U4 49 |
||||
|
||||
/** Selects the Olimex AVR-ISP-MK2 specific board drivers, including the Button and LED drivers. */ |
||||
#define BOARD_OLIMEXISPMK2 50 |
||||
|
||||
|
||||
#if !defined(__DOXYGEN__) |
||||
#define BOARD_ BOARD_NONE |
||||
|
||||
#if !defined(BOARD) |
||||
#define BOARD BOARD_NONE |
||||
#endif |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,381 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \dir
|
||||
* \brief Common library header files. |
||||
* |
||||
* This folder contains header files which are common to all parts of the LUFA library. They may be used freely in |
||||
* user applications. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Common library convenience headers, macros and functions. |
||||
* |
||||
* \copydetails Group_Common |
||||
*/ |
||||
|
||||
/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
|
||||
* \brief Common library convenience headers, macros and functions. |
||||
* |
||||
* Common utility headers containing macros, functions, enums and types which are common to all |
||||
* aspects of the library. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
/** \defgroup Group_GlobalInt Global Interrupt Macros
|
||||
* \brief Convenience macros for the management of interrupts globally within the device. |
||||
* |
||||
* Macros and functions to create and control global interrupts within the device. |
||||
*/ |
||||
|
||||
#ifndef __LUFA_COMMON_H__ |
||||
#define __LUFA_COMMON_H__ |
||||
|
||||
/* Macros: */ |
||||
#define __INCLUDE_FROM_COMMON_H |
||||
|
||||
/* Includes: */ |
||||
#include <stdint.h> |
||||
#include <stdbool.h> |
||||
#include <string.h> |
||||
#include <stddef.h> |
||||
|
||||
#include "Architectures.h" |
||||
#include "BoardTypes.h" |
||||
#include "ArchitectureSpecific.h" |
||||
#include "CompilerSpecific.h" |
||||
#include "Attributes.h" |
||||
|
||||
#if defined(USE_LUFA_CONFIG_HEADER) |
||||
#include "LUFAConfig.h" |
||||
#endif |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Architecture specific utility includes: */ |
||||
#if defined(__DOXYGEN__) |
||||
/** Type define for an unsigned integer the same width as the selected architecture's machine register.
|
||||
* This is distinct from the non-specific standard int data type, whose width is machine dependant but |
||||
* which may not reflect the actual machine register width on some targets (e.g. AVR8). |
||||
*/ |
||||
typedef MACHINE_REG_t uint_reg_t; |
||||
#elif (ARCH == ARCH_AVR8) |
||||
#include <avr/io.h> |
||||
#include <avr/interrupt.h> |
||||
#include <avr/pgmspace.h> |
||||
#include <avr/eeprom.h> |
||||
#include <avr/boot.h> |
||||
#include <math.h> |
||||
#include <util/delay.h> |
||||
|
||||
typedef uint8_t uint_reg_t; |
||||
|
||||
#define ARCH_HAS_EEPROM_ADDRESS_SPACE |
||||
#define ARCH_HAS_FLASH_ADDRESS_SPACE |
||||
#define ARCH_HAS_MULTI_ADDRESS_SPACE |
||||
#define ARCH_LITTLE_ENDIAN |
||||
|
||||
#include "Endianness.h" |
||||
#elif (ARCH == ARCH_UC3) |
||||
#include <avr32/io.h> |
||||
#include <math.h> |
||||
|
||||
// === TODO: Find abstracted way to handle these ===
|
||||
#define PROGMEM |
||||
#define pgm_read_byte(x) *x |
||||
#define memcmp_P(...) memcmp(__VA_ARGS__) |
||||
#define memcpy_P(...) memcpy(__VA_ARGS__) |
||||
// =================================================
|
||||
|
||||
typedef uint32_t uint_reg_t; |
||||
|
||||
#define ARCH_BIG_ENDIAN |
||||
|
||||
#include "Endianness.h" |
||||
#elif (ARCH == ARCH_XMEGA) |
||||
#include <avr/io.h> |
||||
#include <avr/interrupt.h> |
||||
#include <avr/pgmspace.h> |
||||
#include <avr/eeprom.h> |
||||
#include <math.h> |
||||
#include <util/delay.h> |
||||
|
||||
typedef uint8_t uint_reg_t; |
||||
|
||||
#define ARCH_HAS_EEPROM_ADDRESS_SPACE |
||||
#define ARCH_HAS_FLASH_ADDRESS_SPACE |
||||
#define ARCH_HAS_MULTI_ADDRESS_SPACE |
||||
#define ARCH_LITTLE_ENDIAN |
||||
|
||||
#include "Endianness.h" |
||||
#else |
||||
#error Unknown device architecture specified. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Macro for encasing other multi-statement macros. This should be used along with an opening brace
|
||||
* before the start of any multi-statement macro, so that the macros contents as a whole are treated |
||||
* as a discrete block and not as a list of separate statements which may cause problems when used as |
||||
* a block (such as inline \c if statements). |
||||
*/ |
||||
#define MACROS do |
||||
|
||||
/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
|
||||
* brace at the end of any multi-statement macro, so that the macros contents as a whole are treated |
||||
* as a discrete block and not as a list of separate statements which may cause problems when used as |
||||
* a block (such as inline \c if statements). |
||||
*/ |
||||
#define MACROE while (0) |
||||
|
||||
/** Convenience macro to determine the larger of two values.
|
||||
* |
||||
* \attention This macro should only be used with operands that do not have side effects from being evaluated |
||||
* multiple times. |
||||
* |
||||
* \param[in] x First value to compare |
||||
* \param[in] y First value to compare |
||||
* |
||||
* \return The larger of the two input parameters |
||||
*/ |
||||
#if !defined(MAX) || defined(__DOXYGEN__) |
||||
#define MAX(x, y) (((x) > (y)) ? (x) : (y)) |
||||
#endif |
||||
|
||||
/** Convenience macro to determine the smaller of two values.
|
||||
* |
||||
* \attention This macro should only be used with operands that do not have side effects from being evaluated |
||||
* multiple times. |
||||
* |
||||
* \param[in] x First value to compare |
||||
* \param[in] y First value to compare |
||||
* |
||||
* \return The smaller of the two input parameters |
||||
*/ |
||||
#if !defined(MIN) || defined(__DOXYGEN__) |
||||
#define MIN(x, y) (((x) < (y)) ? (x) : (y)) |
||||
#endif |
||||
|
||||
#if !defined(STRINGIFY) || defined(__DOXYGEN__) |
||||
/** Converts the given input into a string, via the C Preprocessor. This macro puts literal quotation
|
||||
* marks around the input, converting the source into a string literal. |
||||
* |
||||
* \param[in] x Input to convert into a string literal. |
||||
* |
||||
* \return String version of the input. |
||||
*/ |
||||
#define STRINGIFY(x) #x |
||||
|
||||
/** Converts the given input into a string after macro expansion, via the C Preprocessor. This macro puts
|
||||
* literal quotation marks around the expanded input, converting the source into a string literal. |
||||
* |
||||
* \param[in] x Input to expand and convert into a string literal. |
||||
* |
||||
* \return String version of the expanded input. |
||||
*/ |
||||
#define STRINGIFY_EXPANDED(x) STRINGIFY(x) |
||||
#endif |
||||
|
||||
#if !defined(ISR) || defined(__DOXYGEN__) |
||||
/** Macro for the definition of interrupt service routines, so that the compiler can insert the required
|
||||
* prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's |
||||
* state with unintentional side-effects. |
||||
* |
||||
* Interrupt handlers written using this macro may still need to be registered with the microcontroller's |
||||
* Interrupt Controller (if present) before they will properly handle incoming interrupt events. |
||||
* |
||||
* \note This macro is only supplied on some architectures, where the standard library does not include a valid |
||||
* definition. If an existing definition exists, the alternative definition here will be ignored. |
||||
* |
||||
* \ingroup Group_GlobalInt |
||||
* |
||||
* \param[in] Name Unique name of the interrupt service routine. |
||||
*/ |
||||
#define ISR(Name, ...) void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void) |
||||
#endif |
||||
|
||||
/* Inline Functions: */ |
||||
/** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
|
||||
* etc. |
||||
* |
||||
* \param[in] Byte Byte of data whose bits are to be reversed. |
||||
* |
||||
* \return Input data with the individual bits reversed (mirrored). |
||||
*/ |
||||
static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST; |
||||
static inline uint8_t BitReverse(uint8_t Byte) |
||||
{ |
||||
Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4)); |
||||
Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2)); |
||||
Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1)); |
||||
|
||||
return Byte; |
||||
} |
||||
|
||||
/** Function to perform a blocking delay for a specified number of milliseconds. The actual delay will be
|
||||
* at a minimum the specified number of milliseconds, however due to loop overhead and internal calculations |
||||
* may be slightly higher. |
||||
* |
||||
* \param[in] Milliseconds Number of milliseconds to delay |
||||
*/ |
||||
static inline void Delay_MS(uint16_t Milliseconds) ATTR_ALWAYS_INLINE; |
||||
static inline void Delay_MS(uint16_t Milliseconds) |
||||
{ |
||||
#if (ARCH == ARCH_AVR8) |
||||
if (GCC_IS_COMPILE_CONST(Milliseconds)) |
||||
{ |
||||
_delay_ms(Milliseconds); |
||||
} |
||||
else |
||||
{ |
||||
while (Milliseconds--) |
||||
_delay_ms(1); |
||||
} |
||||
#elif (ARCH == ARCH_UC3) |
||||
while (Milliseconds--) |
||||
{ |
||||
__builtin_mtsr(AVR32_COUNT, 0); |
||||
while ((uint32_t)__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000)); |
||||
} |
||||
#elif (ARCH == ARCH_XMEGA) |
||||
if (GCC_IS_COMPILE_CONST(Milliseconds)) |
||||
{ |
||||
_delay_ms(Milliseconds); |
||||
} |
||||
else |
||||
{ |
||||
while (Milliseconds--) |
||||
_delay_ms(1); |
||||
} |
||||
#endif |
||||
} |
||||
|
||||
/** Retrieves a mask which contains the current state of the global interrupts for the device. This
|
||||
* value can be stored before altering the global interrupt enable state, before restoring the |
||||
* flag(s) back to their previous values after a critical section using \ref SetGlobalInterruptMask(). |
||||
* |
||||
* \ingroup Group_GlobalInt |
||||
* |
||||
* \return Mask containing the current Global Interrupt Enable Mask bit(s). |
||||
*/ |
||||
static inline uint_reg_t GetGlobalInterruptMask(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint_reg_t GetGlobalInterruptMask(void) |
||||
{ |
||||
GCC_MEMORY_BARRIER(); |
||||
|
||||
#if (ARCH == ARCH_AVR8) |
||||
return SREG; |
||||
#elif (ARCH == ARCH_UC3) |
||||
return __builtin_mfsr(AVR32_SR); |
||||
#elif (ARCH == ARCH_XMEGA) |
||||
return SREG; |
||||
#endif |
||||
} |
||||
|
||||
/** Sets the global interrupt enable state of the microcontroller to the mask passed into the function.
|
||||
* This can be combined with \ref GetGlobalInterruptMask() to save and restore the Global Interrupt Enable |
||||
* Mask bit(s) of the device after a critical section has completed. |
||||
* |
||||
* \ingroup Group_GlobalInt |
||||
* |
||||
* \param[in] GlobalIntState Global Interrupt Enable Mask value to use |
||||
*/ |
||||
static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) ATTR_ALWAYS_INLINE; |
||||
static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) |
||||
{ |
||||
GCC_MEMORY_BARRIER(); |
||||
|
||||
#if (ARCH == ARCH_AVR8) |
||||
SREG = GlobalIntState; |
||||
#elif (ARCH == ARCH_UC3) |
||||
if (GlobalIntState & AVR32_SR_GM) |
||||
__builtin_ssrf(AVR32_SR_GM_OFFSET); |
||||
else |
||||
__builtin_csrf(AVR32_SR_GM_OFFSET); |
||||
#elif (ARCH == ARCH_XMEGA) |
||||
SREG = GlobalIntState; |
||||
#endif |
||||
|
||||
GCC_MEMORY_BARRIER(); |
||||
} |
||||
|
||||
/** Enables global interrupt handling for the device, allowing interrupts to be handled.
|
||||
* |
||||
* \ingroup Group_GlobalInt |
||||
*/ |
||||
static inline void GlobalInterruptEnable(void) ATTR_ALWAYS_INLINE; |
||||
static inline void GlobalInterruptEnable(void) |
||||
{ |
||||
GCC_MEMORY_BARRIER(); |
||||
|
||||
#if (ARCH == ARCH_AVR8) |
||||
sei(); |
||||
#elif (ARCH == ARCH_UC3) |
||||
__builtin_csrf(AVR32_SR_GM_OFFSET); |
||||
#elif (ARCH == ARCH_XMEGA) |
||||
sei(); |
||||
#endif |
||||
|
||||
GCC_MEMORY_BARRIER(); |
||||
} |
||||
|
||||
/** Disabled global interrupt handling for the device, preventing interrupts from being handled.
|
||||
* |
||||
* \ingroup Group_GlobalInt |
||||
*/ |
||||
static inline void GlobalInterruptDisable(void) ATTR_ALWAYS_INLINE; |
||||
static inline void GlobalInterruptDisable(void) |
||||
{ |
||||
GCC_MEMORY_BARRIER(); |
||||
|
||||
#if (ARCH == ARCH_AVR8) |
||||
cli(); |
||||
#elif (ARCH == ARCH_UC3) |
||||
__builtin_ssrf(AVR32_SR_GM_OFFSET); |
||||
#elif (ARCH == ARCH_XMEGA) |
||||
cli(); |
||||
#endif |
||||
|
||||
GCC_MEMORY_BARRIER(); |
||||
} |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,97 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Compiler specific definitions for code optimization and correctness. |
||||
* |
||||
* \copydetails Group_CompilerSpecific |
||||
* |
||||
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's |
||||
* functionality. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Common
|
||||
* \defgroup Group_CompilerSpecific Compiler Specific Definitions |
||||
* \brief Compiler specific definitions for code optimization and correctness. |
||||
* |
||||
* Compiler specific definitions to expose certain compiler features which may increase the level of code optimization |
||||
* for a specific compiler, or correct certain issues that may be present such as memory barriers for use in conjunction |
||||
* with atomic variable access. |
||||
* |
||||
* Where possible, on alternative compilers, these macros will either have no effect, or default to returning a sane value |
||||
* so that they can be used in existing code without the need for extra compiler checks in the user application code. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LUFA_COMPILERSPEC_H__ |
||||
#define __LUFA_COMPILERSPEC_H__ |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_COMMON_H) |
||||
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
#if defined(__GNUC__) || defined(__DOXYGEN__) |
||||
/** Forces GCC to use pointer indirection (via the device's pointer register pairs) when accessing the given
|
||||
* struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through |
||||
* a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before |
||||
* use, it will force GCC to use pointer indirection on the elements rather than direct store and load |
||||
* instructions. |
||||
* |
||||
* \param[in, out] StructPtr Pointer to a structure which is to be forced into indirect access mode. |
||||
*/ |
||||
#define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr)) |
||||
|
||||
/** Forces GCC to create a memory barrier, ensuring that memory accesses are not reordered past the barrier point.
|
||||
* This can be used before ordering-critical operations, to ensure that the compiler does not re-order the resulting |
||||
* assembly output in an unexpected manner on sections of code that are ordering-specific. |
||||
*/ |
||||
#define GCC_MEMORY_BARRIER() __asm__ __volatile__("" ::: "memory"); |
||||
|
||||
/** Determines if the specified value can be determined at compile-time to be a constant value when compiling under GCC.
|
||||
* |
||||
* \param[in] x Value to check compile-time constantness of. |
||||
* |
||||
* \return Boolean true if the given value is known to be a compile time constant, false otherwise. |
||||
*/ |
||||
#define GCC_IS_COMPILE_CONST(x) __builtin_constant_p(x) |
||||
#else |
||||
#define GCC_FORCE_POINTER_ACCESS(StructPtr) |
||||
#define GCC_MEMORY_BARRIER() |
||||
#define GCC_IS_COMPILE_CONST(x) 0 |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,489 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Endianness and Byte Ordering macros and functions. |
||||
* |
||||
* \copydetails Group_Endianness |
||||
*/ |
||||
|
||||
/** \ingroup Group_Endianness
|
||||
* \defgroup Group_ByteSwapping Byte Reordering |
||||
* \brief Macros and functions for forced byte reordering. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Endianness
|
||||
* \defgroup Group_EndianConversion Endianness Conversion |
||||
* \brief Macros and functions for automatic endianness conversion. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Common
|
||||
* \defgroup Group_Endianness Endianness and Byte Ordering |
||||
* \brief Convenience macros and functions relating to byte (re-)ordering |
||||
* |
||||
* Common library convenience macros and functions relating to byte (re-)ordering. |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LUFA_ENDIANNESS_H__ |
||||
#define __LUFA_ENDIANNESS_H__ |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_COMMON_H) |
||||
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality. |
||||
#endif |
||||
|
||||
#if !(defined(ARCH_BIG_ENDIAN) || defined(ARCH_LITTLE_ENDIAN)) |
||||
#error ARCH_BIG_ENDIAN or ARCH_LITTLE_ENDIAN not set for the specified architecture. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Swaps the byte ordering of a 16-bit value at compile-time. Do not use this macro for swapping byte orderings
|
||||
* of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used |
||||
* inside struct or other variable initializers outside of a function, something that is not possible with the |
||||
* inline function variant. |
||||
* |
||||
* \ingroup Group_ByteSwapping |
||||
* |
||||
* \param[in] x 16-bit value whose byte ordering is to be swapped. |
||||
* |
||||
* \return Input value with the byte ordering reversed. |
||||
*/ |
||||
#define SWAPENDIAN_16(x) (uint16_t)((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8)) |
||||
|
||||
/** Swaps the byte ordering of a 32-bit value at compile-time. Do not use this macro for swapping byte orderings
|
||||
* of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used |
||||
* inside struct or other variable initializers outside of a function, something that is not possible with the |
||||
* inline function variant. |
||||
* |
||||
* \ingroup Group_ByteSwapping |
||||
* |
||||
* \param[in] x 32-bit value whose byte ordering is to be swapped. |
||||
* |
||||
* \return Input value with the byte ordering reversed. |
||||
*/ |
||||
#define SWAPENDIAN_32(x) (uint32_t)((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \ |
||||
(((x) & 0x0000FF00UL) << 8UL) | (((x) & 0x000000FFUL) << 24UL)) |
||||
|
||||
#if defined(ARCH_BIG_ENDIAN) && !defined(le16_to_cpu) |
||||
#define le16_to_cpu(x) SwapEndian_16(x) |
||||
#define le32_to_cpu(x) SwapEndian_32(x) |
||||
#define be16_to_cpu(x) (x) |
||||
#define be32_to_cpu(x) (x) |
||||
#define cpu_to_le16(x) SwapEndian_16(x) |
||||
#define cpu_to_le32(x) SwapEndian_32(x) |
||||
#define cpu_to_be16(x) (x) |
||||
#define cpu_to_be32(x) (x) |
||||
#define LE16_TO_CPU(x) SWAPENDIAN_16(x) |
||||
#define LE32_TO_CPU(x) SWAPENDIAN_32(x) |
||||
#define BE16_TO_CPU(x) (x) |
||||
#define BE32_TO_CPU(x) (x) |
||||
#define CPU_TO_LE16(x) SWAPENDIAN_16(x) |
||||
#define CPU_TO_LE32(x) SWAPENDIAN_32(x) |
||||
#define CPU_TO_BE16(x) (x) |
||||
#define CPU_TO_BE32(x) (x) |
||||
#elif !defined(le16_to_cpu) |
||||
/** \name Run-time endianness conversion */ |
||||
//@{
|
||||
|
||||
/** Performs a conversion between a Little Endian encoded 16-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref LE16_TO_CPU instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define le16_to_cpu(x) (x) |
||||
|
||||
/** Performs a conversion between a Little Endian encoded 32-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref LE32_TO_CPU instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define le32_to_cpu(x) (x) |
||||
|
||||
/** Performs a conversion between a Big Endian encoded 16-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref BE16_TO_CPU instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define be16_to_cpu(x) SwapEndian_16(x) |
||||
|
||||
/** Performs a conversion between a Big Endian encoded 32-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref BE32_TO_CPU instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define be32_to_cpu(x) SwapEndian_32(x) |
||||
|
||||
/** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it
|
||||
* is in Little Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref CPU_TO_LE16 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define cpu_to_le16(x) (x) |
||||
|
||||
/** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it
|
||||
* is in Little Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref CPU_TO_LE32 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define cpu_to_le32(x) (x) |
||||
|
||||
/** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it
|
||||
* is in Big Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref CPU_TO_BE16 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define cpu_to_be16(x) SwapEndian_16(x) |
||||
|
||||
/** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it
|
||||
* is in Big Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for run-time conversion of data - for compile-time endianness |
||||
* conversion, use \ref CPU_TO_BE32 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define cpu_to_be32(x) SwapEndian_32(x) |
||||
|
||||
//@}
|
||||
|
||||
/** \name Compile-time endianness conversion */ |
||||
//@{
|
||||
|
||||
/** Performs a conversion between a Little Endian encoded 16-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run time endianness |
||||
* conversion, use \ref le16_to_cpu instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define LE16_TO_CPU(x) (x) |
||||
|
||||
/** Performs a conversion between a Little Endian encoded 32-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run time endianness |
||||
* conversion, use \ref le32_to_cpu instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define LE32_TO_CPU(x) (x) |
||||
|
||||
/** Performs a conversion between a Big Endian encoded 16-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run-time endianness |
||||
* conversion, use \ref be16_to_cpu instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define BE16_TO_CPU(x) SWAPENDIAN_16(x) |
||||
|
||||
/** Performs a conversion between a Big Endian encoded 32-bit piece of data and the
|
||||
* Endianness of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run-time endianness |
||||
* conversion, use \ref be32_to_cpu instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define BE32_TO_CPU(x) SWAPENDIAN_32(x) |
||||
|
||||
/** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it
|
||||
* is in Little Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run-time endianness |
||||
* conversion, use \ref cpu_to_le16 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define CPU_TO_LE16(x) (x) |
||||
|
||||
/** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it
|
||||
* is in Little Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On little endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run-time endianness |
||||
* conversion, use \ref cpu_to_le32 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define CPU_TO_LE32(x) (x) |
||||
|
||||
/** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it
|
||||
* is in Big Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run-time endianness |
||||
* conversion, use \ref cpu_to_be16 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define CPU_TO_BE16(x) SWAPENDIAN_16(x) |
||||
|
||||
/** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it
|
||||
* is in Big Endian format regardless of the currently selected CPU architecture. |
||||
* |
||||
* On big endian architectures, this macro does nothing. |
||||
* |
||||
* \note This macro is designed for compile-time conversion of data - for run-time endianness |
||||
* conversion, use \ref cpu_to_be32 instead. |
||||
* |
||||
* \ingroup Group_EndianConversion |
||||
* |
||||
* \param[in] x Data to perform the endianness conversion on. |
||||
* |
||||
* \return Endian corrected version of the input value. |
||||
*/ |
||||
#define CPU_TO_BE32(x) SWAPENDIAN_32(x) |
||||
|
||||
//! @}
|
||||
#endif |
||||
|
||||
/* Inline Functions: */ |
||||
/** Function to reverse the byte ordering of the individual bytes in a 16 bit value.
|
||||
* |
||||
* \ingroup Group_ByteSwapping |
||||
* |
||||
* \param[in] Word Word of data whose bytes are to be swapped. |
||||
* |
||||
* \return Input data with the individual bytes reversed. |
||||
*/ |
||||
static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST; |
||||
static inline uint16_t SwapEndian_16(const uint16_t Word) |
||||
{ |
||||
if (GCC_IS_COMPILE_CONST(Word)) |
||||
return SWAPENDIAN_16(Word); |
||||
|
||||
uint8_t Temp; |
||||
|
||||
union |
||||
{ |
||||
uint16_t Word; |
||||
uint8_t Bytes[2]; |
||||
} Data; |
||||
|
||||
Data.Word = Word; |
||||
|
||||
Temp = Data.Bytes[0]; |
||||
Data.Bytes[0] = Data.Bytes[1]; |
||||
Data.Bytes[1] = Temp; |
||||
|
||||
return Data.Word; |
||||
} |
||||
|
||||
/** Function to reverse the byte ordering of the individual bytes in a 32 bit value.
|
||||
* |
||||
* \ingroup Group_ByteSwapping |
||||
* |
||||
* \param[in] DWord Double word of data whose bytes are to be swapped. |
||||
* |
||||
* \return Input data with the individual bytes reversed. |
||||
*/ |
||||
static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST; |
||||
static inline uint32_t SwapEndian_32(const uint32_t DWord) |
||||
{ |
||||
if (GCC_IS_COMPILE_CONST(DWord)) |
||||
return SWAPENDIAN_32(DWord); |
||||
|
||||
uint8_t Temp; |
||||
|
||||
union |
||||
{ |
||||
uint32_t DWord; |
||||
uint8_t Bytes[4]; |
||||
} Data; |
||||
|
||||
Data.DWord = DWord; |
||||
|
||||
Temp = Data.Bytes[0]; |
||||
Data.Bytes[0] = Data.Bytes[3]; |
||||
Data.Bytes[3] = Temp; |
||||
|
||||
Temp = Data.Bytes[1]; |
||||
Data.Bytes[1] = Data.Bytes[2]; |
||||
Data.Bytes[2] = Temp; |
||||
|
||||
return Data.DWord; |
||||
} |
||||
|
||||
/** Function to reverse the byte ordering of the individual bytes in a n byte value.
|
||||
* |
||||
* \ingroup Group_ByteSwapping |
||||
* |
||||
* \param[in,out] Data Pointer to a number containing an even number of bytes to be reversed. |
||||
* \param[in] Length Length of the data in bytes. |
||||
* |
||||
* \return Input data with the individual bytes reversed. |
||||
*/ |
||||
static inline void SwapEndian_n(void* const Data, |
||||
uint8_t Length) ATTR_NON_NULL_PTR_ARG(1); |
||||
static inline void SwapEndian_n(void* const Data, |
||||
uint8_t Length) |
||||
{ |
||||
uint8_t* CurrDataPos = (uint8_t*)Data; |
||||
|
||||
while (Length > 1) |
||||
{ |
||||
uint8_t Temp = *CurrDataPos; |
||||
*CurrDataPos = *(CurrDataPos + Length - 1); |
||||
*(CurrDataPos + Length - 1) = Temp; |
||||
|
||||
CurrDataPos++; |
||||
Length -= 2; |
||||
} |
||||
} |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,846 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_BuildSystem The LUFA Build System |
||||
* |
||||
* \section Sec_BuildSystemOverview Overview of the LUFA Build System |
||||
* The LUFA build system is an attempt at making a set of re-usable, modular build make files which |
||||
* can be referenced in a LUFA powered project, to minimise the amount of code required in an |
||||
* application makefile. The system is written in GNU Make, and each module is independant of |
||||
* one-another. |
||||
* |
||||
* For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA |
||||
* build system, see \ref Sec_Prerequisites. |
||||
* |
||||
* To use a LUFA build system module, simply add an include to your project makefile: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_core.mk |
||||
* \endcode |
||||
* |
||||
* And the associated build module targets will be added to your project's build makefile automatically. |
||||
* To call a build target, run <tt>make {TARGET_NAME}</tt> from the command line, substituting in |
||||
* the appropriate target name. |
||||
* |
||||
* \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile. |
||||
* |
||||
* Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i> |
||||
* be supplied in the project makefile for the module to work, and one or more optional parameters which |
||||
* may be defined and which will assume a sensible default if not. |
||||
* |
||||
* \section SSec_BuildSystemModules Available Modules |
||||
* |
||||
* The following modules are included in this LUFA release: |
||||
* |
||||
* \li \subpage Page_BuildModule_ATPROGRAM - Device Programming |
||||
* \li \subpage Page_BuildModule_AVRDUDE - Device Programming |
||||
* \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking |
||||
* \li \subpage Page_BuildModule_CORE - Core Build System Functions |
||||
* \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis |
||||
* \li \subpage Page_BuildModule_DFU - Device Programming |
||||
* \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation |
||||
* \li \subpage Page_BuildModule_HID - Device Programming |
||||
* \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_BUILD The BUILD build module |
||||
* |
||||
* The BUILD LUFA build system module, providing targets for the compilation, |
||||
* assembling and linking of an application from source code into binary files |
||||
* suitable for programming into a target device. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_build.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_BUILD_Requirements Requirements |
||||
* This module requires the the architecture appropriate binaries of the GCC compiler are available in your |
||||
* system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio |
||||
* 5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages. |
||||
* |
||||
* \section SSec_BuildModule_BUILD_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>size</tt></td> |
||||
* <td>Display size of the compiled application FLASH and SRAM segments.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>symbol-sizes</tt></td> |
||||
* <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>check-source</tt></td> |
||||
* <td>Display a list of input SRC source files which cannot be found (if any).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>lib</tt></td> |
||||
* <td>Build and archive all source files into a library A binary file.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>all</tt></td> |
||||
* <td>Build and link the application into ELF debug and HEX binary files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>elf</tt></td> |
||||
* <td>Build and link the application into an ELF debug file.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>hex</tt></td> |
||||
* <td>Build and link the application and produce HEX and EEP binary files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>lss</tt></td> |
||||
* <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>clean</tt></td> |
||||
* <td>Remove all intermediatary files and binary output files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>mostlyclean</tt></td> |
||||
* <td>Remove all intermediatary files but preserve any binary output files.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>TARGET</tt></td> |
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ARCH</tt></td> |
||||
* <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>MCU</tt></td> |
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>SRC</tt></td> |
||||
* <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>F_USB</tt></td> |
||||
* <td>Speed in Hz of the input clock frequency to the target's USB controller.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LUFA_PATH</tt></td> |
||||
* <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>BOARD</tt></td> |
||||
* <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>OPTIMIZATION</tt></td> |
||||
* <td>Optimization level to use when compiling source files (see GCC manual).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>C_STANDARD</tt></td> |
||||
* <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPP_STANDARD</tt></td> |
||||
* <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>DEBUG_FORMAT</tt></td> |
||||
* <td>Format of the debug information to embed in the generated object files (see GCC manual).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>DEBUG_LEVEL</tt></td> |
||||
* <td>Level of the debugging information to embed in the generated object files (see GCC manual).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>F_CPU</tt></td> |
||||
* <td>Speed of the processor CPU clock, in Hz.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>C_FLAGS</tt></td> |
||||
* <td>Flags to pass to the C compiler only, after the automatically generated flags.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPP_FLAGS</tt></td> |
||||
* <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ASM_FLAGS</tt></td> |
||||
* <td>Flags to pass to the assembler only, after the automatically generated flags.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CC_FLAGS</tt></td> |
||||
* <td>Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LD_FLAGS</tt></td> |
||||
* <td>Flags to pass to the linker, after the automatically generated flags.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>OBJDIR</tt></td> |
||||
* <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used. |
||||
* \note When this option is enabled, all source filenames <b>must</b> be unique.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>OBJECT_FILES</tt></td> |
||||
* <td>List of additional object files that should be linked into the resulting binary.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_CORE The CORE build module |
||||
* |
||||
* The core LUFA build system module, providing common build system help and information targets. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_core.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_CORE_Requirements Requirements |
||||
* This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt> |
||||
* shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.). |
||||
* |
||||
* \section SSec_BuildModule_CORE_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>help</tt></td> |
||||
* <td>Display build system help and configuration information.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>list_targets</tt></td> |
||||
* <td>List all available build targets from the build system.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>list_modules</tt></td> |
||||
* <td>List all available build modules from the build system.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>list_mandatory</tt></td> |
||||
* <td>List all mandatory parameters required by the included modules.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>list_optional</tt></td> |
||||
* <td>List all optional parameters required by the included modules.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>list_provided</tt></td> |
||||
* <td>List all variables provided by the included modules.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>list_macros</tt></td> |
||||
* <td>List all macros provided by the included modules.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CORE_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module |
||||
* |
||||
* The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an |
||||
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_atprogram.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_ATPROGRAM_Requirements Requirements |
||||
* This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b> |
||||
* variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x |
||||
* inside the application install folder's "\avrdbg" subdirectory. |
||||
* |
||||
* \section SSec_BuildModule_ATPROGRAM_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>atprogram</tt></td> |
||||
* <td>Program the device FLASH memory with the application's executable data.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>atprogram-ee</tt></td> |
||||
* <td>Program the device EEPROM memory with the application's EEPROM data.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>MCU</tt></td> |
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>TARGET</tt></td> |
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>ATPROGRAM_PROGRAMMER</tt></td> |
||||
* <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ATPROGRAM_INTERFACE</tt></td> |
||||
* <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ATPROGRAM_PORT</tt></td> |
||||
* <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_AVRDUDE The AVRDUDE build module |
||||
* |
||||
* The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an |
||||
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_avrdude.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_AVRDUDE_Requirements Requirements |
||||
* This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b> |
||||
* variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for |
||||
* Windows (<a>winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's |
||||
* source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager. |
||||
* |
||||
* \section SSec_BuildModule_AVRDUDE_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>avrdude</tt></td> |
||||
* <td>Program the device FLASH memory with the application's executable data.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>avrdude</tt></td> |
||||
* <td>Program the device EEPROM memory with the application's EEPROM data.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>MCU</tt></td> |
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>TARGET</tt></td> |
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>AVRDUDE_PROGRAMMER</tt></td> |
||||
* <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ATPROGRAM_PORT</tt></td> |
||||
* <td>Name of the communication port to use when when programming with the connected tool (e.g. <tt>COM2</tt>, <tt>/dev/ttyUSB0</tt> or <tt>usb</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ATPROGRAM_FLAGS</tt></td> |
||||
* <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_CPPCHECK The CPPCHECK build module |
||||
* |
||||
* The CPPCHECK programming utility LUFA build system module, providing targets to statically |
||||
* analyze C and C++ source code for errors and performance/style issues. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_cppcheck.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_CPPCHECK_Requirements Requirements |
||||
* This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b> |
||||
* variable. The <tt>cppcheck</tt> utility is distributed through the project's home page |
||||
* (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via |
||||
* the project's source code or through the package manager. |
||||
* |
||||
* \section SSec_BuildModule_CPPCHECK_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>cppcheck</tt></td> |
||||
* <td>Statically analyze the project source code for issues.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>cppcheck-config</tt></td> |
||||
* <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>SRC</tt></td> |
||||
* <td>List of source files to statically analyze.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_INCLUDES</tt></td> |
||||
* <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_EXCLUDES</tt></td> |
||||
* <td>Paths or path fragments to exclude when analyzing.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td> |
||||
* <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_ENABLE</tt></td> |
||||
* <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_SUPPRESS</tt></td> |
||||
* <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td> |
||||
* <td>Set to <b>Y</b> to fail the analysis job with an error exit code if warnings are found, <b>N</b> to continue without failing.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_QUIET</tt></td> |
||||
* <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>CPPCHECK_FLAGS</tt></td> |
||||
* <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_DFU The DFU build module |
||||
* |
||||
* The DFU programming utility LUFA build system module, providing targets to reprogram an |
||||
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files. |
||||
* This module requires a DFU class bootloader to be running in the target, compatible with |
||||
* the DFU bootloader protocol as published by Atmel. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_dfu.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_DFU_Requirements Requirements |
||||
* This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open |
||||
* source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be |
||||
* available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility |
||||
* can be installed via the project's source code or through the package manager. |
||||
* |
||||
* \section SSec_BuildModule_DFU_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>dfu</tt></td> |
||||
* <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>dfu-ee</tt></td> |
||||
* <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>flip</tt></td> |
||||
* <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>flip-ee</tt></td> |
||||
* <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>MCU</tt></td> |
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>TARGET</tt></td> |
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DFU_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_DOXYGEN The DOXYGEN build module |
||||
* |
||||
* The DOXYGEN code documentation utility LUFA build system module, providing targets to generate |
||||
* project HTML and other format documentation from a set of source files that include special |
||||
* Doxygen comments. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_doxygen.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_DOXYGEN_Requirements Requirements |
||||
* This module requires the <tt>doxygen</tt> utility from the Doxygen website |
||||
* (<a>http://www.stack.nl/~dimitri/doxygen/</a>) to be available in your system's <b>PATH</b> |
||||
* variable. On *nix systems the <tt>doxygen</tt> utility can be installed via the project's source |
||||
* code or through the package manager. |
||||
* |
||||
* \section SSec_BuildModule_DOXYGEN_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>doxygen</tt></td> |
||||
* <td>Generate project documentation.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>LUFA_PATH</tt></td> |
||||
* <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>DOXYGEN_CONF</tt></td> |
||||
* <td>Name and path of the base Doxygen configuration file for the project.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td> |
||||
* <td>Set to <b>Y</b> to fail the generation with an error exit code if warnings are found other than unsupported configuration parameters, <b>N</b> to continue without failing.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td> |
||||
* <td>Extra Doxygen configuration parameters to apply, overriding the corresponding config entry in the project's configuration file (e.g. <tt>QUIET=YES</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_HID The HID build module |
||||
* |
||||
* The HID programming utility LUFA build system module, providing targets to reprogram an |
||||
* Atmel processor's FLASH memory with a project's compiled binary output file. This module |
||||
* requires a HID class bootloader to be running in the target, using a protocol compatible |
||||
* with the PJRC "HalfKay" protocol (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>). |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_hid.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_HID_Requirements Requirements |
||||
* This module requires either the <tt>hid_bootloader_cli</tt> utility from the included LUFA HID |
||||
* class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC |
||||
* (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b> |
||||
* variable. |
||||
* |
||||
* \section SSec_BuildModule_HID_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>hid</tt></td> |
||||
* <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>hid-ee</tt></td> |
||||
* <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and |
||||
* a temporary AVR application programmed into the target's FLASH. |
||||
* \note This will erase the currently loaded application in the target.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>teensy</tt></td> |
||||
* <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>teensy-ee</tt></td> |
||||
* <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and |
||||
* a temporary AVR application programmed into the target's FLASH. |
||||
* \note This will erase the currently loaded application in the target.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>MCU</tt></td> |
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>TARGET</tt></td> |
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_HID_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
|
||||
/** \page Page_BuildModule_SOURCES The SOURCES build module |
||||
* |
||||
* The SOURCES LUFA build system module, providing variables listing the various LUFA source files |
||||
* required to be build by a project for a given LUFA module. This module gives a way to reference |
||||
* LUFA source files symbollically, so that changes to the library structure do not break the library |
||||
* makefile. |
||||
* |
||||
* To use this module in your application makefile, add the following code: |
||||
* \code |
||||
* include $(LUFA_PATH)/Build/lufa_sources.mk |
||||
* \endcode |
||||
* |
||||
* \section SSec_BuildModule_SOURCES_Requirements Requirements |
||||
* None. |
||||
* |
||||
* \section SSec_BuildModule_SOURCES_Targets Targets |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>LUFA_PATH</tt></td> |
||||
* <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>ARCH</tt></td> |
||||
* <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><tt>LUFA_SRC_USB</tt></td> |
||||
* <td>List of LUFA USB driver source files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LUFA_SRC_USBCLASS</tt></td> |
||||
* <td>List of LUFA USB Class driver source files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LUFA_SRC_TEMPERATURE</tt></td> |
||||
* <td>List of LUFA temperature sensor driver source files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LUFA_SRC_SERIAL</tt></td> |
||||
* <td>List of LUFA Serial U(S)ART driver source files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LUFA_SRC_TWI</tt></td> |
||||
* <td>List of LUFA TWI driver source files.</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td><tt>LUFA_SRC_PLATFORM</tt></td> |
||||
* <td>List of LUFA architecture specific platform management source files.</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <td><i>None</i></td> |
||||
* </tr> |
||||
* </table> |
||||
*/ |
||||
@ -0,0 +1,23 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_BuildLibrary Building as a Linkable Library |
||||
* |
||||
* The LUFA library can be built as a proper linkable library (with the extention .a) under AVR-GCC, so that |
||||
* the library does not need to be recompiled with each revision of a user project. Instructions for creating |
||||
* a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install |
||||
* /Docs/ directory. |
||||
* |
||||
* However, building the library is <b>not recommended</b>, as the static (compile-time) options will be |
||||
* unable to be changed without a recompilation of the LUFA code. Therefore, if the library is to be built |
||||
* from the LUFA source, it should be made to be application-specific and compiled with the static options |
||||
* that are required for each project (which should be recorded along with the library). |
||||
* |
||||
* Normal library use has the library components compiled in at the same point as the application code, as |
||||
* demonstrated in the library demos and applications. This is the preferred method, as the library is recompiled |
||||
* each time to ensure that all static options for a particular application are applied. |
||||
*/ |
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,223 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_TokenSummary Summary of Compile Tokens |
||||
* |
||||
* The following lists all the possible tokens which can be defined in a project makefile, and passed to the |
||||
* compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour, |
||||
* or remove features unused by a given application in order to save flash space. |
||||
* |
||||
* \note If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located |
||||
* in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile |
||||
* defined tokens for configuring the library. |
||||
* |
||||
* \section Sec_SummaryNonUSBTokens Non USB Related Tokens |
||||
* This section describes compile tokens which affect non-USB sections of the LUFA library. |
||||
* |
||||
* - <b>DISABLE_TERMINAL_CODES</b> - (\ref Group_Terminal) - <i>All Architectures</i> \n |
||||
* If an application contains ANSI terminal control codes listed in TerminalCodes.h, it might be desired to remove them |
||||
* at compile time for use with a terminal which is non-ANSI control code aware, without modifying the source code. If |
||||
* this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from |
||||
* the source code at compile time. |
||||
* |
||||
* |
||||
* \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens |
||||
* This section describes compile tokens which affect USB class-specific drivers in the LUFA library. |
||||
* |
||||
* - <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - (\ref Group_USBClassHIDHost) - <i>All Architectures</i> \n |
||||
* By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID |
||||
* communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic |
||||
* Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol |
||||
* mode can be removed to save space in the compiled application by defining this token. When defined, it is still necessary |
||||
* to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol(). |
||||
* |
||||
* - <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n |
||||
* HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This |
||||
* allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous |
||||
* state table in a compact manner. This token may be defined to a non-zero 8-bit value to give the maximum depth of the state |
||||
* table stack. If not defined, this defaults to the value indicated in the HID.h file documentation. |
||||
* |
||||
* - <b>HID_USAGE_STACK_DEPTH</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n |
||||
* HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession |
||||
* when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with |
||||
* different usages in a compact manner. This token may be defined to a non-zero 8-bit value to set the maximum depth of the |
||||
* usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT |
||||
* and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation. |
||||
* |
||||
* - <b>HID_MAX_COLLECTIONS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n |
||||
* HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information |
||||
* is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space. |
||||
* This token may be defined to a non-zero 8-bit value to set the maximum number of COLLECTION items which can be processed by the |
||||
* parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file |
||||
* documentation. |
||||
* |
||||
* - <b>HID_MAX_REPORTITEMS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n |
||||
* All HID reports contain one or more INPUT, OUTPUT and/or FEATURE items describing the data which can be sent to and from the HID |
||||
* device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which |
||||
* the report data should be interpreted by the host. This token may be defined to a non-zero 8-bit value to set the maximum number of |
||||
* data elements which can be stored in the processed HID report structure, including INPUT, OUTPUT and (if enabled) FEATURE items. |
||||
* If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the |
||||
* processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation. |
||||
* |
||||
* - <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n |
||||
* HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination |
||||
* keyboard and mouse might use report IDs to separate the keyboard reports from the mouse reports. In order to determine the size of each |
||||
* report, and thus know how many bytes must be read or written, the size of each report (IN, OUT and FEATURE) must be calculated and |
||||
* stored. This token may be defined to a non-zero 8-bit value to set the maximum number of report IDs in a device which can be processed |
||||
* and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in |
||||
* the HID.h file documentation. |
||||
* |
||||
* - <b>NO_CLASS_DRIVER_AUTOFLUSH</b> - (\ref Group_USBClassDrivers) - <i>All Architectures</i> \n |
||||
* Many of the device and host mode class drivers automatically flush any data waiting to be written to an interface, when the corresponding |
||||
* USB management task is executed. This is usually desirable to ensure that any queued data is sent as soon as possible once and new data is |
||||
* constructed in the main program loop. However, if flushing is to be controlled manually by the user application via the *_Flush() commands, |
||||
* the compile time token may be defined in the application's makefile to disable automatic flushing during calls to the class driver USB |
||||
* management tasks. |
||||
* |
||||
* |
||||
* \section Sec_SummaryUSBTokens General USB Driver Related Tokens |
||||
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library. |
||||
* |
||||
* - <b>ORDERED_EP_CONFIG</b> - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - <i>AVR8, UC3</i> \n |
||||
* The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> be configured in an ascending order to |
||||
* prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialization. This compile |
||||
* time token may be used to restrict the initialization order to ascending indexes only in exchange for a smaller compiled binary size. Use |
||||
* caution when applied to applications using the library USB Class drivers; the user application must ensure that all endpoints and pipes are |
||||
* allocated sequentially. |
||||
* |
||||
* - <b>USE_STATIC_OPTIONS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n |
||||
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad |
||||
* voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options |
||||
* mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing |
||||
* the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an |
||||
* Options parameter. |
||||
* |
||||
* - <b>USB_DEVICE_ONLY</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n |
||||
* For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the |
||||
* mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to |
||||
* save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which |
||||
* do not support host mode. |
||||
* |
||||
* - <b>USB_HOST_ONLY</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n |
||||
* Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models. |
||||
* |
||||
* - <b>USB_STREAM_TIMEOUT_MS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n |
||||
* When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host |
||||
* must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero 16-bit value to set the timeout |
||||
* period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead. |
||||
* |
||||
* - <b>NO_LIMITED_CONTROLLER_CONNECT</b> - (\ref Group_Events) - <i>AVR8 Only</i> \n |
||||
* On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of |
||||
* VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be |
||||
* slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is |
||||
* required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global |
||||
* can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro. |
||||
* When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events. |
||||
* |
||||
* - <b>NO_SOF_EVENTS</b> - (\ref Group_Events) - <i>All Architectures</i> \n |
||||
* By default, there exists a LUFA application event for the start of each USB frame while the USB bus is not suspended in either host or device mode. |
||||
* This event can be selectively enabled or disabled by calling the appropriate device or host mode function. When this compile time token is defined, |
||||
* the ability to receive USB Start of Frame events via the \ref EVENT_USB_Device_StartOfFrame() or \ref EVENT_USB_Host_StartOfFrame() events is removed, |
||||
* reducing the compiled program's binary size. |
||||
* |
||||
* |
||||
* \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens |
||||
* This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode. |
||||
* |
||||
* - <b>USE_RAM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n |
||||
* Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one |
||||
* of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime. |
||||
* |
||||
* - <b>USE_FLASH_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n |
||||
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM. |
||||
* |
||||
* - <b>USE_EEPROM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n |
||||
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM. |
||||
* |
||||
* - <b>NO_INTERNAL_SERIAL</b> - (\ref Group_StdDescriptors) - <i>All Architectures</i> \n |
||||
* Some AVR models contain a unique serial number which can be used as the device serial number, while in device mode. This allows |
||||
* the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing allocated |
||||
* resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the code that |
||||
* performs this task can be disabled by defining this option and passing it to the compiler via the -D switch. |
||||
* |
||||
* - <b>FIXED_CONTROL_ENDPOINT_SIZE</b>=<i>x</i> - (\ref Group_EndpointManagement) - <i>All Architectures</i> \n |
||||
* By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor. |
||||
* Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if |
||||
* descriptors are stored in EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this token can be |
||||
* defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled |
||||
* binary. |
||||
* |
||||
* - <b>DEVICE_STATE_AS_GPIOR</b> - (\ref Group_Device) - <i>AVR8 Only</i> \n |
||||
* One of the most frequently used global variables in the stack is the USB_DeviceState global, which indicates the current state of |
||||
* the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token |
||||
* may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR |
||||
* reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except |
||||
* implicitly via the library APIs. |
||||
* |
||||
* - <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - (\ref Group_Device) - <i>All Architectures</i> \n |
||||
* By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces |
||||
* the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in |
||||
* EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project |
||||
* makefile to reduce the compiled size of the binary at the expense of flexibility. |
||||
* |
||||
* - <b>CONTROL_ONLY_DEVICE</b> - (\ref Group_Device) - <i>All Architectures</i> \n |
||||
* In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication |
||||
* is through control endpoint requests. Defining this token will remove several features related to the selection and control of device |
||||
* endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided. |
||||
* |
||||
* - <b>MAX_ENDPOINT_INDEX</b> - (\ref Group_Device) - <i>XMEGA Only</i> \n |
||||
* Defining this value to the highest index (not address - this excludes the direction flag) endpoint within the device will restrict the |
||||
* number of FIFOs created internally for the endpoint buffers, reducing the total RAM usage. |
||||
* |
||||
* - <b>INTERRUPT_CONTROL_ENDPOINT</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n |
||||
* Some applications prefer to not call the USB_USBTask() management task regularly while in device mode, as it can complicate code significantly. |
||||
* Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control |
||||
* endpoint entirely via USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called |
||||
* when in USB device mode. |
||||
* |
||||
* - <b>NO_DEVICE_REMOTE_WAKEUP</b> - (\ref Group_Device) - <i>All Architectures</i> \n |
||||
* Many devices do not require the use of the Remote Wakeup features of USB, used to wake up the USB host when suspended. On these devices, |
||||
* the code required to manage device Remote Wakeup can be disabled by defining this token and passing it to the library via the -D switch. |
||||
* |
||||
* - <b>NO_DEVICE_SELF_POWER</b> - (\ref Group_Device) - <i>All Architectures</i> \n |
||||
* USB devices may be bus powered, self powered, or a combination of both. When a device can be both bus powered and self powered, the host may |
||||
* query the device to determine the current power source, via \ref USB_Device_CurrentlySelfPowered. For solely bus powered devices, this global |
||||
* and the code required to manage it may be disabled by passing this token to the library via the -D switch. |
||||
* |
||||
* |
||||
* \section Sec_SummaryUSBHostTokens USB Host Mode Driver Related Tokens |
||||
* |
||||
* This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode. |
||||
* |
||||
* - <b>HOST_STATE_AS_GPIOR</b> - (\ref Group_Host) - <i>AVR8 Only</i> \n |
||||
* One of the most frequently used global variables in the stack is the USB_HostState global, which indicates the current state of |
||||
* the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token |
||||
* may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR |
||||
* reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except |
||||
* implicitly via the library APIs. |
||||
* |
||||
* - <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - (\ref Group_Host) - <i>All Architectures</i> \n |
||||
* When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached |
||||
* device fails to respond within the timeout period. This token may be defined to a non-zero 16-bit value to set the timeout period for |
||||
* control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead. |
||||
* |
||||
* - <b>HOST_DEVICE_SETTLE_DELAY_MS</b>=<i>x</i> - (\ref Group_Host) - <i>All Architectures</i> \n |
||||
* Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or |
||||
* they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled |
||||
* back to a known idle state before communications occur with the device. This token may be defined to a 16-bit value to set the device |
||||
* settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead. |
||||
* |
||||
* - <b>INVERTED_VBUS_ENABLE_LINE</b> - (\ref Group_Host) - <i>All Architectures</i> \n |
||||
* If enabled, this will indicate that the USB target VBUS line polarity is inverted; i.e. it should be pulled low to enable VBUS to the |
||||
* target, and pulled high to stop the target VBUS generation. |
||||
* |
||||
* \attention On AVR8 architecture devices, this compile time option requires \c NO_AUTO_VBUS_MANAGEMENT to be set. |
||||
* |
||||
* - <b>NO_AUTO_VBUS_MANAGEMENT</b> - (\ref Group_Host) - <i>All Architectures</i> \n |
||||
* Disables the automatic management of VBUS to the target, i.e. automatic shut down in the even of an overcurrent situation. When enabled, VBUS |
||||
* is enabled while the USB controller is initialized in USB Host mode. |
||||
*/ |
||||
|
||||
@ -0,0 +1,50 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_CompilingApps Compiling the Demos, Bootloaders and Projects |
||||
* |
||||
* The following details how to compile the included LUFA demos, applications and bootloaders using AVR-GCC. |
||||
* |
||||
* \section Sec_Prerequisites Prerequisites |
||||
* Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+) |
||||
* and the AVR-GCC (4.2+) compiler. A standard "coreutils" package for your system is also required for command line |
||||
* compilation of LUFA based applications. |
||||
* |
||||
* \subsection SSec_PreqWindows Windows Prerequisites |
||||
* On Windows, you will need a copy of the latest Atmel Toolchain, either downloaded and installed as a standalone |
||||
* package, or installed as part of Atmel Studio. You will need to ensure that the "bin" directory of the toolchain |
||||
* is available in your system's <b>PATH</b> environment variable. |
||||
* |
||||
* In addition, you will need to install a ported version of the ZSH or BASH *nix shells, and a standard set of *nix |
||||
* utilities such as <i>cut</i>, <i>find</i> and <i>sed</i>. These can be found in the "basic" system package of the |
||||
* of the MinGW installer (<a>http://www.mingw.org</a>). Once installed, add the "msys\1.0\bin" of the MinGW installation |
||||
* folder is added to your system's <b>PATH</b> environment variable. |
||||
* |
||||
* The bootloaders currently also require the "bc" application, which can be installed from |
||||
* <a>http://gnuwin32.sourceforge.net/downlinks/bc.php</a>. Once installed add the "GnuWin32\bin" path of the GnuWin32 |
||||
* installation folder to your system's <b>PATH</b> environment variable. |
||||
* |
||||
* \subsection SSec_PreqLinux Linux Prerequisites |
||||
* On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the |
||||
* Atmel website for general development, or use the latest avr-libc and avr-gcc packages for your chosen distribution's |
||||
* package manager. For full device support, the Atmel standalone package is recommended. |
||||
* |
||||
* \section Sec_Compiling Compiling a LUFA Application |
||||
* Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for |
||||
* each individual demo, bootloader and project folder, as well as scripts in the Demos/, Bootloaders/, Projects/ |
||||
* and the LUFA root directory. Compilation of projects can be started from any of the above directories, with a build |
||||
* started from an upper directory in the directory structure executing build of all child directories under it. This |
||||
* means that while a build inside a particular demo directory will build only that particular demo, a build started from |
||||
* the /Demos/ directory will build all LUFA demo projects sequentially. |
||||
* |
||||
* To build a project from the source via the command line, the command <b>"make all"</b> should be executed from the command |
||||
* line in the directory of interest. To remove compiled files (including the binary output, all intermediately files and all |
||||
* diagnostic output files), execute <b>"make clean"</b>. Once a "make all" has been run and no errors were encountered, the |
||||
* resulting binary will be located in the generated ".HEX" file. If your project makes use of pre-initialized EEPROM |
||||
* variables, the generated ".EEP" file will contain the project's EEPROM data. |
||||
* |
||||
* \see \ref Page_BuildSystem for information on the LUFA build system. |
||||
*/ |
||||
@ -0,0 +1,104 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_ConfiguringApps Configuring the Demos, Bootloaders and Projects |
||||
* |
||||
* If the target microcontroller model, architecture, clock speed, board or other settings are different from the current |
||||
* settings, they must be changed and the project recompiled from the source code before being programmed into the microcontroller. |
||||
* Most project configuration options are located in the <tt>makefile</tt> build script inside each LUFA application's folder, |
||||
* however some demo or application-specific configuration settings are located in one or more of the source files of the project. |
||||
* See each project's individual documentation for application-specific configuration values. |
||||
* |
||||
* Each project "makefile" contains all the script and configuration data required to compile each project. When opened with |
||||
* any regular basic text editor such as Notepad or WordPad (ensure that the save format is a pure ASCII text format) the |
||||
* build configuration settings may be altered. |
||||
* |
||||
* \see \ref Page_BuildSystem for information on the LUFA build system. |
||||
* |
||||
* \section Sec_AppConfigParams The Default Application Template |
||||
* |
||||
* Below is a copy of the default LUFA application makefile, which can be used as a template for each application. |
||||
* |
||||
* \verbinclude makefile_template |
||||
* |
||||
* Inside each makefile, a number of configuration variables are listed with the syntax "<VARIABLE NAME> = <VALUE>". For |
||||
* each application, the important standard variables which should be altered are: |
||||
* |
||||
* - <b>MCU</b>, the target processor model |
||||
* - <b>ARCH</b>, the target microcontroller architecture |
||||
* - <b>BOARD</b>, the target board hardware |
||||
* - <b>F_CPU</b>, the target CPU master clock frequency, after any prescaling |
||||
* - <b>F_USB</b>, the target raw input clock to the USB module of the processor |
||||
* - <b>OPTIMIZATION</b>, the level of optimization to compile with |
||||
* - <b>TARGET</b>, the name of the target output binary and other files |
||||
* - <b>SRC</b>, the list of source files to compile/assemble/link |
||||
* - <b>LUFA_PATH</b>, the path to the LUFA library core source code |
||||
* - <b>CC_FLAGS</b>, the common command line flags to pass to the C/C++ compiler, assembler and linker |
||||
* - <b>LD_FLAGS</b>, the command line flags to pass to the linker |
||||
* |
||||
* These values should be changed to reflect the build hardware. |
||||
* |
||||
* \subsection SSec_MCU The MCU Parameter |
||||
* This parameter indicates the target microcontroller model for the compiled application. This should be set to the model of the target |
||||
* microcontroller (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the |
||||
* microcontroller models and architectures, as they may make use of peripherals or modes only present in some devices. |
||||
* |
||||
* For supported processor models, see \ref Page_DeviceSupport. |
||||
* |
||||
* \subsection SSec_ARCH The ARCH Parameter |
||||
* This parameter indicates the target microcontroller architecture the library is to be compiled for. Different microcontroller |
||||
* architectures require different source files to be compiled into the final binary, and so this option must be set to the correct |
||||
* architecture for the selected platform. |
||||
* |
||||
* For supported processor architectures, see \ref Page_DeviceSupport. |
||||
* |
||||
* \subsection SSec_BOARD The BOARD Parameter |
||||
* This parameter indicates the target board hardware for the compiled application. Some LUFA library drivers are board-specific, |
||||
* such as the LED driver, and the library needs to know the layout of the target board. If you are using one of the board models listed |
||||
* on the main library page, change this parameter to the board name in all UPPER-case. |
||||
* |
||||
* If you are not using any board-specific drivers in the LUFA library, or you are using a custom board layout, change this to read |
||||
* "USER" (no quotes) instead of a standard board name. If the USER board type is selected and the application makes use of one or more |
||||
* board-specific hardware drivers inside the LUFA library, then the appropriate stub drives files should be copied from the \c /CodeTemplates/DriverStubs/ |
||||
* directory into a /Board/ folder inside the application directory, and the stub driver completed with the appropriate code to drive the |
||||
* custom board's hardware. |
||||
* |
||||
* For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport. |
||||
* |
||||
* \subsection SSec_F_CPU The F_CPU Parameter |
||||
* This parameter indicates the target microcontroller's main CPU clock frequency, in Hz. This is used by many libraries (and applications) for |
||||
* timing related purposes, and should reflect the actual CPU speed after any prescaling or adjustments are performed. |
||||
* |
||||
* \subsection SSec_F_USB The F_USB Parameter |
||||
* This parameter indicates the raw input clock frequency to the USB module within the microcontroller in Hz. This may be very different on some platforms |
||||
* to the main CPU clock or other peripheral/bus clocks. |
||||
* |
||||
* \subsection SSec_OPTIMIZATION The OPTIMIZATION Parameter |
||||
* This parameter indicates the level of optimization to use when compiling the application. This will allow you to compile with an optimization level |
||||
* supported by GCC, from <tt>0</tt> (no optimization) to <tt>3</tt> (fastest runtime optimization) or <tt>s</tt> (smallest size). |
||||
* |
||||
* \subsection SSec_TARGET The TARGET Parameter |
||||
* This parameter indicates the application target name, which is used as the base filename for the build binary and debugging files. This will be the |
||||
* name of the output files once linked together into the final application, ready to load into the target. |
||||
* |
||||
* \subsection SSec_SRC The SRC Parameter |
||||
* This parameter indicates the source files used to compile the application, as a list of C (<tt>*.c</tt>), C++ (<tt>*.cpp</tt>) and Assembly (<tt>*.S</tt>) files. Note that |
||||
* all assembly files must end in a <b>capital</b> .S extension, as lowercase .s files are reserved for GCC intermediate files. |
||||
* |
||||
* \subsection SSec_LUFA_PATH The LUFA_PATH Parameter |
||||
* As each LUFA program requires the LUFA library source code to compile correctly, the application must know where the LUFA library is located. This |
||||
* value specifies the path to the LUFA library core. This path may be relative or absolute, however note than even under Windows based systems the |
||||
* forward-slash (/) path seperator must be used. |
||||
* |
||||
* \subsection SSec_CC_FLAGS The CC_FLAGS Parameter |
||||
* This parameter lists the compiler flags passed to the C/C++ compiler, the assembler and the linker. These are used as-is directly to GCC and thus |
||||
* must match GCC's command line options as given in the GCC manual. This variable may be used to define tokens directly on the command line, enable or |
||||
* disable warnings, adjust the target-specific tuning parameters or other options. |
||||
* |
||||
* \subsection SSec_LD_FLAGS The LD_FLAGS Parameter |
||||
* This parameter lists the linker flags passed exclusively to the linker. These are used as-is directly to GCC and thus must match GCC's command line |
||||
* linker options as given in the GCC manual. This variable may be used to create or relocate custom data sections, or enable linker specific behaviors. |
||||
*/ |
||||
@ -0,0 +1,23 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_DevelopingWithLUFA Developing With LUFA |
||||
* |
||||
* This section of the manual contains information on LUFA development, such as Getting Started information, |
||||
* information on compile-time tuning of the library and other developer-related sections. |
||||
* |
||||
* <b>Subsections:</b> |
||||
* \li \subpage Page_BuildSystem - The LUFA Buildsystem |
||||
* \li \subpage Page_TokenSummary - Summary of Compile Time Tokens |
||||
* \li \subpage Page_Migration - Migrating from an Older LUFA Version |
||||
* \li \subpage Page_VIDPID - Allocated USB VID and PID Values |
||||
* \li \subpage Page_BuildLibrary - Building as a Linkable Library |
||||
* \li \subpage Page_ExportingLibrary - Exporting LUFA for IDE Use |
||||
* \li \subpage Page_WritingBoardDrivers - How to Write Custom Board Drivers |
||||
* \li \subpage Page_SoftwareBootloaderStart - How to jump to the bootloader in software |
||||
*/ |
||||
|
||||
@ -0,0 +1,432 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_DeviceSupport Device and Hardware Support |
||||
* |
||||
* <b>Atmel Microcontrollers:</b> |
||||
* \li \subpage Page_AVR8Support - Atmel AVR8 Support |
||||
* \li \subpage Page_UC3Support - Atmel AVR32 UC3 Support |
||||
* \li \subpage Page_XMEGASupport - Atmel XMEGA Support |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_AVR8Support Atmel 8-Bit AVR (AVR8) Support |
||||
* |
||||
* \section Sec_AVR8Support_Devices Supported Microcontroller Models |
||||
* |
||||
* Currently supported AVR8 models: |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <th width="150px">Part</th> |
||||
* <th width="150px">USB Device Mode</th> |
||||
* <th width="150px">USB Host Mode</th> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT90USB82</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATMEGA8U2</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT90USB162</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATMEGA16U2</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATMEGA16U4</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATMEGA32U2</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATMEGA32U4</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATMEGA32U6</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT90USB646</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT90USB647</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT90USB1286</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT90USB1287</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section Sec_AVR8Support_Boards Supported Atmel Boards |
||||
* Currently supported Atmel AVR8 boards (see \ref Group_BoardTypes): |
||||
* - AT90USBKEY |
||||
* - ATAVRUSBRF01 |
||||
* - EVK527 |
||||
* - RZUSBSTICK |
||||
* - STK525 |
||||
* - STK526 |
||||
* - XPLAIN (Original green board, <i>not</i> the newer blue XPLAINED family boards) |
||||
* |
||||
* \section Sec_AVR8Support_ThirdParty Supported Third Party Models |
||||
* Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): |
||||
* - Adafruit U4 Breakout Board |
||||
* - Arduino Uno |
||||
* - Bitwizard Multio and Big-Multio |
||||
* - Busware BUI |
||||
* - Busware CUL V3 |
||||
* - Busware TUL |
||||
* - DorkbotPDX Duce |
||||
* - Fletchtronics Bumble-B (using manufacturer recommended peripheral layout) |
||||
* - Kernel Concepts USBFOO |
||||
* - Linnix UDIP |
||||
* - MattairTech JM-DB-U2 |
||||
* - Maximus USB |
||||
* - Micropendous Boards (Micropendous-32U2, Micropendous-1, Micropendous-2) |
||||
* - Microsin AVR-USB162 |
||||
* - Minimus USB |
||||
* - Olimex AVR-USB-162 |
||||
* - Olimex AVR-USB-32U4 |
||||
* - Olimex AVR-USB-T32U4 |
||||
* - Olimex AVR-ISP-MK2 |
||||
* - Paranoid Studio's US2AX (V1, V2 and V3 hardware revisions) |
||||
* - PJRC Teensy (1.x and 2.x versions) |
||||
* - Sparkfun U2 Breakout Board |
||||
* - TCNISO Blackcat USB JTAG |
||||
* - Tempusdictum Benito |
||||
* - Tom's USBTINY-MKII (all revisions and versions) |
||||
* - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_UC3Support Atmel 32-Bit UC3 AVR (UC3) |
||||
* |
||||
* \warning The AVR32 UC3 device support is currently <b>experimental</b>, and is included for preview purposes only. |
||||
* |
||||
* \section Sec_UC3Support_Devices Supported Microcontroller Models |
||||
* |
||||
* Currently supported UC3 models: |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <th width="150px">Part</th> |
||||
* <th width="150px">USB Device Mode</th> |
||||
* <th width="150px">USB Host Mode</th> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A064</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A164</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A364</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A364S</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A464</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A464S</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B064</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B164</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A0128</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A1128</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A3128</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A3128S</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A4128</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A4128S</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B0128</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B1128</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A0256</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A1256</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A3256</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A3256S</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A4256</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A4256S</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B0256</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B1256</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A0512</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3A1512</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B0512</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>AT32UC3B1512</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section Sec_UC3Support_Boards Supported Atmel Boards |
||||
* |
||||
* Currently supported Atmel UC3 boards (see \ref Group_BoardTypes): |
||||
* - EVK1100 |
||||
* - EVK1101 |
||||
* - EVK1104 |
||||
* |
||||
* \section Sec_UC3Support_ThirdParty Supported Third Party Models |
||||
* |
||||
* Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): |
||||
* - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_XMEGASupport Atmel USB XMEGA AVR (XMEGA) |
||||
* |
||||
* \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. |
||||
* |
||||
* \section Sec_XMEGASupport_Devices Supported Microcontroller Models |
||||
* |
||||
* Currently supported XMEGA models: |
||||
* |
||||
* <table> |
||||
* <tr> |
||||
* <th width="150px">Part</th> |
||||
* <th width="150px">USB Device Mode</th> |
||||
* <th width="150px">USB Host Mode</th> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA16A4U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA32A4U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA64A4U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA128A4U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA64A3U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA128A3U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA192A3U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA256A3U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA256A3BU</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA128A1U</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA64B3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA128B3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA64B1</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA128B1</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA64C3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA128C3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA192C3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA256C3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA384C3</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA16C4</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* <tr> |
||||
* <td>ATXMEGA32C4</td> |
||||
* <td bgcolor="#00EE00">Yes</td> |
||||
* <td bgcolor="#EE0000">No</td> |
||||
* </tr> |
||||
* </table> |
||||
* |
||||
* \section Sec_XMEGASupport_Boards Supported Atmel Boards |
||||
* Currently supported Atmel XMEGA boards (see \ref Group_BoardTypes): |
||||
* - XMEGA A3BU Xplained |
||||
* - XMEGA B1 Xplained |
||||
* |
||||
* \section Sec_XMEGASupport_ThirdParty Supported Third Party Models |
||||
* Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): |
||||
* - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) |
||||
*/ |
||||
|
||||
@ -0,0 +1,80 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \dir Platform |
||||
* \brief Platform specific drivers. |
||||
* |
||||
* This folder contains platform specific drivers and defines for various supported architectures. These may or may |
||||
* not be used in a LUFA application, and are provided for convenience purposes. |
||||
* |
||||
* \dir Drivers |
||||
* \brief Library hardware and software drivers. |
||||
* |
||||
* This folder contains all the library hardware and software drivers for each supported board, architecture and |
||||
* microcontroller model. |
||||
* |
||||
* \dir Drivers/Misc |
||||
* \brief Miscellaneous driver files. |
||||
* |
||||
* This folder contains drivers for aspects other than the USB interface, board hardware or microcontroller peripherals. |
||||
* |
||||
* \dir Drivers/Peripheral |
||||
* \brief Microcontroller peripheral driver files. |
||||
* |
||||
* This folder contains drivers for various low level microcontroller peripherals, usually located on the microcontroller |
||||
* die within the same physical chip. |
||||
* |
||||
* \dir Drivers/USB |
||||
* \brief USB controller peripheral driver files. |
||||
* |
||||
* This folder contains the complete LUFA USB stack and controller files, including the core driver and stack, as well |
||||
* as the USB class driver implementations. |
||||
* |
||||
* \dir Drivers/USB/Core |
||||
* \brief Core USB driver files. |
||||
* |
||||
* This folder contains the core USB stack and controller driver files, to correctly implement USB functionality on the |
||||
* target architecture and microcontroller model. This |
||||
* |
||||
* \dir Drivers/USB/Class |
||||
* \brief USB Class helper driver files. |
||||
* |
||||
* This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library, |
||||
* but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive |
||||
* development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications. |
||||
* |
||||
* \dir Drivers/USB/Class/Device |
||||
* \brief USB Device Class helper driver files. |
||||
* |
||||
* Device mode drivers for the standard USB classes. |
||||
* |
||||
* \dir Drivers/USB/Class/Host |
||||
* \brief USB Host Class helper driver files. |
||||
* |
||||
* Host mode drivers for the standard USB classes. |
||||
* |
||||
* \dir Drivers/Board |
||||
* \brief Board hardware driver files. |
||||
* |
||||
* This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from |
||||
* the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of |
||||
* hardware placed on supported boards. |
||||
* |
||||
* \dir CodeTemplates |
||||
* \brief Code templates for use in LUFA powered applications. |
||||
* |
||||
* This contains code templates for board drivers, sample LUFA project makefiles and other similar templates that can be copied into |
||||
* a LUFA powered application and modified to speed up development. |
||||
* |
||||
* \dir CodeTemplates/DriverStubs |
||||
* \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate. |
||||
* |
||||
* This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those |
||||
* directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files |
||||
* copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board, |
||||
* the corresponding LUFA board APIs will work correctly with the non-standard board hardware. |
||||
*/ |
||||
|
||||
@ -0,0 +1,24 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_Donating Donating to Support This Project |
||||
* |
||||
* \image html Images/Author.jpg "Dean Camera, LUFA Developer" |
||||
* |
||||
* I am a 23 year old Atmel Applications Engineer, living in Trondheim, Norway and working on LUFA in my spare time. |
||||
* The development and support of this library requires much effort from myself, as I am the sole developer, maintainer |
||||
* and supporter. Please consider donating a small amount to support this and my future Open Source projects - All |
||||
* donations are <i>greatly</i> appreciated. |
||||
* |
||||
* Note that commercial entities can remove the attribution portion of the LUFA license by a one-time fee - see |
||||
* \ref Page_LicenseInfo for more details (<b>Note: Please do NOT pay this in advance through the donation link below - |
||||
* contact author for payment details.</b>). |
||||
* |
||||
* \image html "http://www.pledgie.com/campaigns/6927.png?skin_name=chrome" |
||||
* <a href='http://www.lufa-lib.org/donate'>Donate to this project via PayPal</a> - Thanks in Advance! |
||||
*/ |
||||
|
||||
@ -0,0 +1,106 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_ExportingLibrary Exporting the Library for IDE Use |
||||
* |
||||
* While LUFA was designed to allow for easy compilation in a makefile driven environment, |
||||
* it is possible to export the library into a form suitable for drop-in use inside of an |
||||
* IDE. |
||||
* |
||||
* \section Sec_LibraryExport Exporting the Library |
||||
* An export of the library is at its most basic, a direct copy of the main "LUFA" source folder from the |
||||
* root download folder; this contains the library core which can be re-used within external projects. |
||||
* However, as many IDEs attempt to automatically compile all included source files, it is neccesary to |
||||
* exclude some directories and files from the library core export to allow for easier integration into |
||||
* an IDE project. |
||||
* |
||||
* \subsection SSec_ManualExport Manual Export |
||||
* To manually export the library core, copy over the main LUFA library folder from the LUFA root directory, |
||||
* renaming as desired. Within the library core folder, the following directories should be removed or |
||||
* excluded from your IDE import: |
||||
* - Documentation/ |
||||
* - DoxygenPages/ |
||||
* - CodeTemplates/ |
||||
* |
||||
* If required, files from the CodeTemplates/ subdirectory may be copied to your IDE project as needed. |
||||
* |
||||
* The resulting copy of the library may then be imported into your chosen IDE according to the instructions |
||||
* shown in \ref Sec_LibraryImport. |
||||
* |
||||
* \subsection SSec_AutomaticExport Automatic Export |
||||
* If desired, the steps indicated in \ref SSec_ManualExport may be automatically performed, by running the |
||||
* command <b><code>make export_tar</code></b> from the command line. This will generate two .tar files in the |
||||
* current directory, named <code>LUFA_YYMMDD.tar</code> and <code>LUFA_YYMMDD_Code_Templates.tar</code> (where |
||||
* "YYMMDD" is the version of the library being exported). The first archive contains the exported LUFA core |
||||
* with the non-required files removed, while the second contains an archived copy of the code template files |
||||
* for the current LUFA version. |
||||
* |
||||
* The resulting archived copy of the library may then be extracted to your chosen IDE project source directory |
||||
* and imported according to the instructions shown in \ref Sec_LibraryImport. |
||||
* |
||||
* \section Sec_LibraryImport Importing the Library |
||||
* An exported copy of the library may be imported wholesale into an IDE project, if the instructions detailed |
||||
* in \ref Sec_LibraryExport are followed. |
||||
* |
||||
* Specific instructions for importing an exported version of LUFA into various IDEs are listed below. |
||||
* |
||||
* \subsection SSec_AS56_Import Importing into AVRStudio 5/Atmel Studio 6 |
||||
* To import LUFA into a new or existing project, the following steps must be followed. |
||||
* |
||||
* \subsubsection SSSec_AS56_Import_Step1 Copy over the exported library |
||||
* Copy over the exported library archive created via the steps listed in \ref Sec_LibraryExport to your AS5/AS6 |
||||
* project directory. |
||||
* |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step1.png |
||||
* |
||||
* \subsubsection SSSec_AS56_Import_Step2 Extract exported library |
||||
* Extract out the contents of the archive to a new folder. This may be any name you wish, however keep in mind |
||||
* that this name will need to be referenced within your user application under most circumstances. It is |
||||
* suggested that this folder be named "LUFA", or "LUFA" followed by the version string for easy reference. |
||||
* |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step2.png |
||||
* |
||||
* \subsubsection SSSec_AS56_Import_Step3 Add the library files |
||||
* Open your AVRStudio 5/Atmel Studio 6 project. From the "Solution Explorer" pane, click the "Show All Files" |
||||
* button on the toolbar to display ghosted icons of files and folders located in the project source directory |
||||
* that are not currently added to the project. |
||||
* |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step3.png |
||||
* |
||||
* Right-click the ghosted version of the extracted LUFA export folder in the Solution Explorer pane, and |
||||
* choose the "Add to Project" option from the context menu. This will add the entire LUFA source tree to the |
||||
* current project. |
||||
* |
||||
* \subsubsection SSSec_AS56_Import_Step4 Open Project Toolchain Properties |
||||
* In the Solution Explorer pane, click the project node, and press the "Properties" button in the toolbar to |
||||
* open the Project Properties window. This window allows you to configure the various project global compiler, |
||||
* assembler and linker options. |
||||
* |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step4.png |
||||
* |
||||
* Click the "Toolchain" tab on the left side of the Project Properties window. |
||||
* |
||||
* \subsubsection SSSec_AS56_Import_Step5 Configure Project Toolchain Properties |
||||
* |
||||
* In the GNU C Compiler section, open the "Symbols" page. Click the "Add Item" button to the top-right of the |
||||
* "Defined Symbols" section to add new symbols. |
||||
* |
||||
* At a minimum, you will need to define the following symbols (for more information on these symbols, see |
||||
* \ref Page_ConfiguringApps): |
||||
* - ARCH |
||||
* - F_CPU |
||||
* - F_USB |
||||
* - BOARD |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step5_1.png |
||||
* |
||||
* Next, open the GNU C Compiler section's "Optimization" page. Ensure that the option to prepare functions for |
||||
* garbage collection is enabled. |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step5_2.png |
||||
* |
||||
* Finally, in the GNU C Linker section, open the "Optimization" page. Ensure that the option to garbage collect |
||||
* unused sections is selected. |
||||
* \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step5_3.png |
||||
*/ |
||||
@ -0,0 +1,49 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_FutureChanges Future Changes |
||||
* |
||||
* Below is a list of future changes which are proposed for the LUFA library, but not yet started/complete. |
||||
* This gives an unordered list of future changes which may be available in future releases of the library. |
||||
* If you have an item to add to this list, please contact the library author via email, the LUFA mailing list, |
||||
* or post your suggestion as an enhancement request to the project bug tracker. |
||||
* |
||||
* <b>Targeted for Future Releases:</b> |
||||
* - Code Features |
||||
* -# Add hub support when in Host mode for multiple devices |
||||
* -# Investigate virtual hubs when in device mode instead of composite devices |
||||
* -# Re-add interrupt Pipe/Endpoint support |
||||
* -# Update stream APIs to use DMA transfers on supported architectures |
||||
* -# Pull out third party libraries into a separate folder and reference them as required |
||||
* -# Add a LUFA_YIELD macro for integration into a third-party RTOS |
||||
* -# Abstract out Mass Storage byte send/receive to prevent low level API use in projects |
||||
* -# Fix HID report parser usage support for array types |
||||
* -# Make HOST_DEVICE_SETTLE_DELAY_MS a global variable that can be changed |
||||
* -# Add MANDATORY_EVENT_FUNCTIONS compile time option |
||||
* -# Add watchdog support to the library and apps/bootloaders |
||||
* - Testing/Verification |
||||
* -# Re-run USBIF test suite on all classes to formally verify operation |
||||
* -# Implement automated functional testing of all demos |
||||
* - Documentation/Support |
||||
* -# Add detailed overviews of how each demo works |
||||
* -# Add board overviews |
||||
* -# Write LUFA tutorials |
||||
* - Demos/Projects |
||||
* -# Device/Host USB bridge |
||||
* -# Finish incomplete demos and projects |
||||
* -# Add class driver support for Test and Measurement class |
||||
* -# Add class driver support for EEM class |
||||
* -# Add class driver support for ECM class |
||||
* -# Add class driver generic HID report host demo |
||||
* -# Implement flow control for USB to Serial project |
||||
* - Ports |
||||
* -# Port all demos to multiple architectures |
||||
* -# Finish USB XMEGA port |
||||
* -# Add AVR32 UC3C, UC3D and UC3L support |
||||
* -# Atmel ARM7 series microcontrollers |
||||
* -# Other (commercial) C compilers |
||||
*/ |
||||
|
||||
@ -0,0 +1,25 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_GettingStarted Getting Started |
||||
* |
||||
* Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and |
||||
* ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and |
||||
* run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz |
||||
* master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most |
||||
* popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included |
||||
* LUFA applications using different settings, see the subsections below. |
||||
* |
||||
* Most of the included demos in the /Demos/ folder come in both ClassDriver and LowLevel varieties. If you are new |
||||
* to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB |
||||
* Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications. |
||||
* |
||||
* <b>Subsections:</b> |
||||
* \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders |
||||
* \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders |
||||
* \li \subpage Page_ProgrammingApps - How to Program an AVR with the Included Demos, Projects and Bootloaders |
||||
*/ |
||||
|
||||
@ -0,0 +1,38 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \defgroup Group_BoardDrivers Board Drivers |
||||
* |
||||
* Functions, macros, variables, enums and types related to the control of physical board hardware. |
||||
*/ |
||||
|
||||
/** \defgroup Group_PeripheralDrivers On-chip Peripheral Drivers |
||||
* |
||||
* Functions, macros, variables, enums and types related to the control of AVR subsystems. |
||||
*/ |
||||
|
||||
/** \defgroup Group_MiscDrivers Miscellaneous Drivers |
||||
* |
||||
* Miscellaneous driver Functions, macros, variables, enums and types. |
||||
*/ |
||||
|
||||
/** \defgroup Group_PlatformDrivers_AVR8 AVR8 |
||||
* \ingroup Group_PlatformDrivers |
||||
* |
||||
* Drivers relating to the AVR8 architecture platform, such as clock setup and interrupt management. |
||||
*/ |
||||
|
||||
/** \defgroup Group_PlatformDrivers_XMEGA XMEGA |
||||
* \ingroup Group_PlatformDrivers |
||||
* |
||||
* Drivers relating to the XMEGA architecture platform, such as clock setup and interrupt management. |
||||
*/ |
||||
|
||||
/** \defgroup Group_PlatformDrivers_UC3 UC3 |
||||
* \ingroup Group_PlatformDrivers |
||||
* |
||||
* Drivers relating to the UC3 architecture platform, such as clock setup and interrupt management. |
||||
*/ |
||||
|
After Width: | Height: | Size: 96 KiB |
|
After Width: | Height: | Size: 98 KiB |
|
After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 158 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 23 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 3.6 KiB |
@ -0,0 +1,44 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_KnownIssues Known Issues |
||||
* The following are known issues present in each official LUFA release. This list should contain all known |
||||
* issues in the library. Most of these issues should be corrected in the future release - see |
||||
* \ref Page_FutureChanges for a list of planned changes in future releases. |
||||
* |
||||
* \section Sec_KnownIssues120730 Version 120730 |
||||
* - AVR8 Architecture |
||||
* - No known issues. |
||||
* - UC3 Architecture |
||||
* \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n |
||||
* |
||||
* - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, |
||||
* although the architecture is supported in the LUFA core library. |
||||
* - DMA transfers to and from the USB controller are not yet implemented for this release. |
||||
* - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their |
||||
* altered USB controller design. |
||||
* - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file |
||||
* streams are not available on the UC3 architecture, due to a lack of suitable library support. |
||||
* - XMEGA Architecture |
||||
* \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. |
||||
* |
||||
* - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release, |
||||
* although the architecture is supported in the LUFA core library. |
||||
* - Endpoints of more than 64 bytes are not currently supported in this release. |
||||
* - Isochronous endpoints are not currently supported in this release. As a result, the audio class |
||||
* cannot be used on XMEGA devices. |
||||
* - Multiple-bank endpoints are not currently supported in this release. |
||||
* - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata |
||||
* relating to the USB controller. |
||||
* - Architecture Independent |
||||
* - The HID parser fails for array type elements that have a MIN and MAX usage applied; each element |
||||
* in the array will receive a unique incrementing usage from the MIN value, up to MAX. |
||||
* - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used |
||||
* and a lengthy USB operation is initiated. |
||||
* - Build System |
||||
* - No known issues. |
||||
*/ |
||||
|
||||
@ -0,0 +1,181 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_LUFAPoweredProjects User Projects Powered by LUFA |
||||
* |
||||
* LUFA is currently in use all around the world, in many applications both commercial and non-commercial. Below is a |
||||
* list of known public LUFA powered projects, which all use the LUFA library in some way. Feel free to visit each project's |
||||
* home page for more information on each project. |
||||
* |
||||
* If you have a project that you would like to add to this list, please contact me via the details on the main page of this |
||||
* documentation. |
||||
* |
||||
* \section Sec_BoardsUsingLUFA AVR-USB Development Boards Using LUFA |
||||
* |
||||
* The following is a list of known AVR USB development boards, which recommend using LUFA for the USB stack. Some of these |
||||
* are open design, and all are available for purchase as completed development boards suitable for project development. |
||||
* |
||||
* \li AVR-USB-162, a USBKEY-like development board for the AT90USB162: http://olimex.com/dev/avr-usb-162.html |
||||
* \li Benito #7, a no-frills USB board: http://www.dorkbotpdx.org/wiki/benito |
||||
* \li Duce, the sucessor to the Benito #7: http://dorkbotpdx.org/wiki/duce |
||||
* \li JM-DB-U2, an ATMEGA32U2 development board: http://u2.mattair.net/index.html |
||||
* \li Micropendous, an open design/source set of AVR USB development boards: http://micropendous.org/ |
||||
* \li Microsin AVR-USB162 breakout board, a DIY AT90USB162 development board: http://microsin.ru/content/view/685/44/ |
||||
* \li Minimus USB, a board specially designed for PSGroove: http://www.minimususb.com/ |
||||
* \li Nanduino, a do-it-yourself AT90USB162 board: http://www.makestuff.eu/wordpress/?page_id=569 |
||||
* \li Sparkfun ATMEGA8U2 breakout board: http://www.sparkfun.com/products/10277 |
||||
* \li Teensy and Teensy++, two other AVR USB development boards: http://www.pjrc.com/teensy/index.html |
||||
* \li U2DIL/U4DIL, a set of DIP layout USB AVR boards: http://www.reworld.eu/re/en/products/u2dil/ |
||||
* \li USB2AX, a tiny USB to serial converter board: http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX |
||||
* \li USBFOO 2, AT90USB162 based development board: http://shop.kernelconcepts.de/product_info.php?products_id=102 |
||||
* |
||||
* \section Sec_LUFAProjects Projects Using LUFA (Hobbyist) |
||||
* |
||||
* The following are known hobbyist projects using LUFA. Most are open source, and show off interesting ways that the LUFA library |
||||
* can be incorporated into many different applications. |
||||
* |
||||
* \li Accelerometer Game Joystick: http://www.crictor.co.il/he/episodes/joystick/ |
||||
* \li Arcade Controller: http://fletchtronics.net/arcade-controller-made-petunia |
||||
* \li Arcade Joystick: http://jamie.lentin.co.uk/embedded/arcade-joystick/ |
||||
* \li AttoBasic AVR BASIC interpreter: http://www.cappels.org/dproj/AttoBasic2_1/AttoBasic_2.1_with_USB_and_Arduino_support.html |
||||
* \li AVR USB Modem, a 3G Wireless Modem host: http://code.google.com/p/avrusbmodem/ |
||||
* \li Bicycle POV: http://www.code.google.com/p/bicycleledpov/ |
||||
* \li Bluetooth Explorerbot: http://code.google.com/p/bluetooth-explorerbot/ |
||||
* \li Bus Ninja, an AVR clone of the popular BusPirate project: http://blog.hodgepig.org/busninja/ |
||||
* \li CAMTRIG, a remote Camera Trigger device: http://code.astraw.com/projects/motmot/camtrig |
||||
* \li CD Driver Emulator Dongle for ISO Files: http://cdemu.blogspot.com/ |
||||
* \li ClockTamer, a configurable clock generator: http://code.google.com/p/clock-tamer/ |
||||
* \li Collection of alternative Arduino Uno firmwares: http://hunt.net.nz/users/darran/ |
||||
* \li Computer controlled LED matrix (Russian): http://we.easyelectronics.ru/AVR/nebolshoy-primer-s-lufa-hidapi.html |
||||
* \li CULFW, a 868MHz RF packet encoder/decoder: http://www.koeniglich.de/culfw/culfw.html |
||||
* \li Dashkey, a custom PC keyboard controller: http://geekhack.org/showwiki.php?title=Island:19096 |
||||
* \li DIY PS3 controller emulator: https://code.google.com/p/diyps3controller/ |
||||
* \li EMuSer, a USB-RS422 adapter for E-Mu samplers: http://www.emxp.net/EMuSer.htm |
||||
* \li Estick JTAG, an ARM JTAG debugger: http://code.google.com/p/estick-jtag/ |
||||
* \li "Fingerlicking Wingdinger" (WARNING: Bad language if no Javascript), a MIDI controller: http://noisybox.net/electronics/wingdinger/ |
||||
* \li Flyatar, a real-time fly tracking system: https://github.com/peterpolidoro/Flyatar |
||||
* \li FootJoy, a 22 button, 6-axis josystick with keyboard and mouse modes: https://bitbucket.org/sirbrialliance/foot-joy/ |
||||
* \li Gamecube controller to USB adapter: https://www.facebook.com/media/set/?set=a.10150202447076304.310536.688776303&l=df53851c50 |
||||
* \li Garmin GPS USB to NMEA standard serial sentence translator: http://github.com/nall/garmin-transmogrifier/tree/master |
||||
* \li Generic HID Device Creator: http://generichid.sourceforge.net/ |
||||
* \li Generic HID Open Source Framework: http://www.waitingforfriday.com/index.php/USB_Generic_HID_Open_Source_Framework_for_Atmel_AVR_and_Windows |
||||
* \li Ghetto Drum, a MIDI drum controller: http://noisybox.net/art/gdrum/ |
||||
* \li GPS enabled lap timer for vehicles: http://www.assembla.com/code/ironlung/subversion/nodes/trunk/LapTimer |
||||
* \li Hardware Volume Control: https://github.com/davidk/hw-volume-control |
||||
* \li Hiduino, a USB-MIDI replacement firmware for the Arduino Uno: http://code.google.com/p/hiduino/ |
||||
* \li Ikea RGB LED USB modification: http://slashhome.se/p/projects/id/ikea_dioder_usb/#project |
||||
* \li IR Remote to Keyboard decoder: http://netzhansa.blogspot.com/2010/04/our-living-room-hi-fi-setup-needs-mp3.html |
||||
* \li Jukebox panic button: http://thinkl33t.co.uk/the-panic-button |
||||
* \li LED Panel controller: http://projects.peterpolidoro.net/caltech/panelscontroller/panelscontroller.htm |
||||
* \li Linux Secure Storage Dongle: http://github.com/TomMD/teensy |
||||
* \li LUFA powered DDR dance mat (French): http://logicien-parfait.fr/dokuwiki/doku.php?id=projet:ddr_repair |
||||
* \li MakeTV Episode Dispenser: http://www.youtube.com/watch?v=BkWUi18hl3g |
||||
* \li MidiMonster, a USB-to-MIDI gateway board: http://www.dorkbotpdx.org/wiki/midimonster |
||||
* \li MIDI Theremin: http://baldwisdom.com/usb-midi-controller-theremin-style-on-arduino-uno/ |
||||
* \li MIDI interface hack of a toy Guitar: http://blog.x37v.info/2011/06/26/toy-guitar-hacked-midi-conroller |
||||
* \li MiniBloq, a graphical Ardunio programming environment : http://minibloq.org/ |
||||
* \li MiXley, a port of the Teacup 3D printer firmware for the USB AVRs: http://codaset.com/michielh/mixley |
||||
* \li Mobo 4.3, a USB controlled all band (160-10m) HF SDR transceiver: http://sites.google.com/site/lofturj/mobo4_3 |
||||
* \li Moco, a native Arduino Uno MIDI replacement firmware: http://web.mac.com/kuwatay/morecat_lab./MocoLUFA.html |
||||
* \li Motherboard BIOS flasher: http://www.coreboot.org/InSystemFlasher |
||||
* \li Multi-button Joystick (French): http://logicien-parfait.fr/dokuwiki/doku.php?id=projet:joystick |
||||
* \li Music Playing Alarm Clock (Tutorial): http://www.instructables.com/id/Music-Playing-Alarm-Clock/ |
||||
* \li Nehebkau, Laptop Controlled Keyboard and Mouse: http://www.frank-zhao.com/cache/nehebkau.php |
||||
* \li NeroJTAG, a JTAG dongle: https://github.com/makestuff/neroJtag |
||||
* \li NES Controller USB modification: http://projects.peterpolidoro.net/video/NESUSB.htm |
||||
* \li Nikon wireless camera remote control (Norwegian): http://hekta.org/~hpe1119/ |
||||
* \li Opendous-JTAG, an open source ARM JTAG debugger: http://code.google.com/p/opendous-jtag/ |
||||
* \li Openkubus, an open source hardware-based authentication dongle: http://code.google.com/p/openkubus/ |
||||
* \li Orbee, a USB connected RGB Orb for notifications: http://www.franksworkshop.com.au/Electronics/Orbee/Orbee.htm |
||||
* \li PPM signal generator over USB: https://github.com/G33KatWork/USBPPM |
||||
* \li Programmable keyboard controller: http://41j.com/blog/2011/10/a-programmable-keyboard-controller/ |
||||
* \li Programmable XBOX controller: http://richard-burke.dyndns.org/wordpress/pan-galactic-gargantuan-gargle-brain-aka-xbox-360-usb-controller/ |
||||
* \li PSGroove, a Playstation 3 Homebrew dongle: http://github.com/psgroove |
||||
* \li PS/2 to USB adapter: https://github.com/makestuff/p2ukbd |
||||
* \li Reprap with LUFA, a LUFA powered 3D printer: http://code.google.com/p/at90usb1287-code-for-arduino-and-eclipse/ |
||||
* \li RFPirate, a RF experimentation platform: https://github.com/ebuller/RF-Pirate |
||||
* \li RF Transciever using the MRF49XA: http://alternet.us.com/?page_id=1494 |
||||
* \li SD Card reader: http://elasticsheep.com/2010/04/teensy2-usb-mass-storage-with-an-sd-card/ |
||||
* \li SDR1, a Software Defined Radio firmware: https://code.google.com/p/sdr-mk1/ |
||||
* \li SEGA Megadrive/Genesis Development Cartridge: http://www.makestuff.eu/wordpress/?page_id=398 |
||||
* \li Serial Line bus analyser: http://www.pjrc.com/teensy/projects/SerialAnalyzer.html |
||||
* \li SNES custom FLASH ROM: http://electrifiedfoolingmachine.co/?page_id=633 |
||||
* \li Smartcard Detective: https://code.google.com/p/smartcarddetective/ |
||||
* \li SmartportVHD Apple II Mass Storage adapter: http://pcedric3.free.fr/SmartportVHD/ |
||||
* \li Single LED Matrix Display: http://guysoft.wordpress.com/2009/10/08/bumble-b/ |
||||
* \li Simple USB LED Controller: https://github.com/scottbez1/sulc |
||||
* \li Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ |
||||
* \li Stylophone, with USB MIDI connectivity: http://www.waitingforfriday.com/index.php/Stylophone_Studio_5 |
||||
* \li Teensy SD Card .WAV file player: http://elasticsheep.com/2010/04/teensy2-usb-wav-player-part-1/ |
||||
* \li Touchscreen Input Device: http://capnstech.blogspot.com/2010/07/touchscreen-update.html |
||||
* \li UDFS, a BBC Micro USB disk filing system: https://github.com/makestuff/udfs |
||||
* \li Universal USB AVR Module: http://usbavr.bplaced.net/ |
||||
* \li USB2AX, a USB to Dynamixel network adapter: http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX |
||||
* \li USB Infrared Receiver/Transmitter: http://vaton4.web2001.cz/ |
||||
* \li USB Interface for Playstation Portable Devices: http://forums.ps2dev.org/viewtopic.php?t=11001 |
||||
* \li USB MIDI to DMX controller: http://github.com/hanshuebner/miDiMX |
||||
* \li USB powered Geiger Counter: http://uhrheber.wordpress.com/2011/04/28/a-usb-powered-geiger-counter-for-the-z2-and-other-computers/ |
||||
* \li Userial, a USB to Serial converter with SPI, I2C and other protocols: http://www.tty1.net/userial/ |
||||
* \li Wireless MIDI Guitar system: http://www.ise.pw.edu.pl/~wzab/wireless_guitar_system/ |
||||
* \li Xnormidi, a C MIDI library: http://x37v.info/projects/xnormidi |
||||
* \li XUM1541, a Commodore 64 floppy drive to USB adapter: http://www.root.org/~nate/c64/xum1541/ |
||||
* \li Zeus, a touch screen computer for music manipulation: http://www.benbengler.com/developments_zeus.html |
||||
* |
||||
* \section Sec_LUFACommercialProjects Projects Using LUFA (Commercial) |
||||
* |
||||
* The following is a list of known commercial products using LUFA. Some of these are open source, although many are "black-box" |
||||
* solutions with no source code given. Those companies which have purchased a Commercial License to LUFA (see \ref Page_LicenseInfo) |
||||
* are not listed here unless specifically requested. |
||||
* |
||||
* \li Arduino Uno, the official Arduino board: http://www.arduino.cc |
||||
* \li ARPS Locator: http://la3t.hamradio.no/lab//?id=tracker_en |
||||
* \li AsTeRICS assistive technologies project, HID actuator: http://www.asterics.eu |
||||
* \li Ceberus, a MadCatz Xbox 360 arcade stick modifier: http://www.phreakmods.com/products/cerberus |
||||
* \li CFFA3000, a CompactFlash interface for the Apple II: http://www.dreher.net/CFforAppleII |
||||
* \li Digital Survey Instruments Magnetometer and Pointer: http://www.digitalsurveyinstruments.com/ |
||||
* \li FinchRobot, a robot designed for educational use: http://www.finchrobot.com/ |
||||
* \li HummingBird Kit, a robotics learning platform: http://www.hummingbirdkit.com/ |
||||
* \li Penguino, an Arduino Board With On-Board LUFA Powered Debugger/Programmer: http://wiki.icy.com.au/PenguinoAVR |
||||
* \li PIR-1, an IR control interface for consumer electronics: http://www.promixis.com/pir-1.php |
||||
* \li PIR-4, a USB Connected 4 port IR transmitter: http://promixis.com/pir-4.php |
||||
* \li KeyGlove, an alternative input system: http://www.keyglove.net/ |
||||
* \li Many of Busware's Products: http://www.busware.de/ |
||||
* \li MIDIFighter, a USB-MIDI controller: http://www.midifighter.com/ |
||||
* \li Norduino, a wireless Arduino: http://norduino.robomotic.com/norduino-is-now-usb-hid/ |
||||
* \li Olimex AVR-ISP-MK2, an AVRISP-MKII Clone AVR Programmer: https://www.olimex.com/dev/avr-isp-mk2.html |
||||
* \li Retrode, a USB Games Console Cartridge Reader: http://www.retrode.org |
||||
* \li RFI21.1EU UHF RFID reader: http://www.metra.cz/rfid/uhf-rfid-ctecky/rfi21-1eu-uhf-rfid-ctecka.htm |
||||
* \li SmartCardDetective, a Smart Card analysis tool: http://www.smartcarddetective.com/ |
||||
* \li USBTINY-MKII, an AVRISP-MKII Clone AVR Programmer: http://tom-itx.dyndns.org:81/~webpage/boards/USBTiny_Mkii/USBTiny_Mkii_index.php |
||||
* \li UDS18B20 USB Temperature sensor: http://toughlog.org/uds18b20/ |
||||
* \li VMeter, a USB MIDI touch strip controller: http://www.vmeter.net/ |
||||
* \li XMEGA Development Board, using LUFA as an On-Board Programmer: http://xmega.mattair.net/ |
||||
* \li Zeptoprog, a multifunction AVR programmer: http://www.mattairtech.com/index.php/featured/zeptoprog.html |
||||
* |
||||
* \section Sec_LUFAPublications Publications Mentioning LUFA |
||||
* The following are published magazines which have either mentioned or featured the LUFA library. |
||||
* |
||||
* \li Elektor Magazine, "My First AVR-USB" by Antoine Authier (feature), January 2010 Issue |
||||
* \li Elektor Magazine, "USB is Cool/Sucks" by Jerry Jacobs and Chris Vossen (minor mention), January 2010 Issue |
||||
* \li Elektor Magazine, "20 x Open Source" by Jens Nickel, March 2010 Issue |
||||
* \li Circuit Cellar Magazine, "Advanced USB Design Debugging" by Collin O'Flynn, August 2010 Issue |
||||
* |
||||
* \section Sec_LUFANotableMentions Other Notable Mentions of LUFA |
||||
* The following are non-magazine but notable mentions of the LUFA library. |
||||
* |
||||
* \li Adafruit "Ask an Engineer", 7th November 2010 |
||||
* \li Arduino 2010 Keynote speech |
||||
* \li The Amp Hour podcast blog #11 |
||||
* \li Blackhat 2011 conference, "Exploiting USB Devices with Arduino" |
||||
* |
||||
* \section Sec_PortsAndForks Non-Official LUFA Ports and Forks |
||||
* The following are unofficial forks of the LUFA codebase, which implement different features such as support for |
||||
* additional architectures. |
||||
* |
||||
* \li NXP's official "nxpusblib" LUFA fork, for LPC devices: http://www.lpcware.com/content/project/nxpusblib |
||||
* \li Kevin Mehall's LUFA port to the NXP LPC13xx: https://github.com/kevinmehall/LUFA-LPC13xx |
||||
* |
||||
*/ |
||||
@ -0,0 +1,34 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_Resources Library Resources |
||||
* |
||||
* \section Sec_UnofficialResources Unofficial Resources |
||||
* Unofficial Russian LUFA documentation translation: http://microsin.ru/Download.cnt/doc/LUFA/ \n |
||||
* Tutorial for LUFA USB Control Transfers: http://www.avrbeginners.net/new/tutorials/usb-control-transfers-with-lufa/ |
||||
* |
||||
* \section Sec_ProjectPages LUFA Related Webpages |
||||
* Project Homepage: http://www.lufa-lib.org \n |
||||
* Commercial Licenses: http://www.lufa-lib.org/license \n |
||||
* Author's Website: http://www.fourwalledcubicle.com \n |
||||
* Development Blog: http://www.fourwalledcubicle.com/blog \n |
||||
* |
||||
* \section Sec_ProjectHelp Assistance With LUFA |
||||
* Support Mailing List: http://www.lufa-lib.org/support \n |
||||
* Author's Email: dean [at] fourwalledcubicle [dot] com \n |
||||
* |
||||
* \section Sec_InDevelopment Latest In-Development Source Code |
||||
* Issue Tracker: http://www.lufa-lib.org/tracker \n |
||||
* Public SVN Repository: http://www.lufa-lib.org/svn \n |
||||
* Public GIT Repository: http://www.lufa-lib.org/git \n |
||||
* Latest Repository Source Archive: http://www.lufa-lib.org/latest-archive \n |
||||
* Commit RSS Feed: http://www.lufa-lib.org/rss \n |
||||
* |
||||
* \section Sec_USBResources USB Resources |
||||
* USB-IF Website: http://www.usb.org \n |
||||
*/ |
||||
|
||||
@ -0,0 +1,22 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_LicenseInfo Source Code License |
||||
* |
||||
* The LUFA library is currently released under the MIT license, included below. |
||||
* |
||||
* Commercial entities can opt out of the public disclosure clause in this license |
||||
* for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which |
||||
* allows for the free use of the LUFA library, bootloaders and (where the sole copyright |
||||
* is attributed to Dean Camera) demos without public disclosure within an organization, in |
||||
* addition to three free hours of consultation with the library author, and priority support. |
||||
* Please visit the Commercial License link on \ref Page_Resources for more information on |
||||
* ordering a commercial license for your company. |
||||
* |
||||
* \verbinclude License.txt |
||||
*/ |
||||
|
||||
@ -0,0 +1,52 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \mainpage |
||||
* |
||||
* \image html Images/LUFA.png |
||||
* <div align="center"><small><i>Logo design by <a href="http://www.studiomonsoon.com">Studio Monsoon Photography</a></i></small></div> |
||||
* \n |
||||
* <div align="center"><a href="http://www.lufa-lib.org">http://www.lufa-lib.org</a></div> |
||||
* \n |
||||
* |
||||
* <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b> |
||||
* |
||||
* LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenseInfo). |
||||
* It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, |
||||
* feature rich framework for the development of USB peripherals and hosts. |
||||
* |
||||
* LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects |
||||
* such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers. |
||||
* While custom USB devices can be made with LUFA using such tools, the included demos all use the inbuilt OS drivers for each USB class for |
||||
* simplicity. |
||||
* |
||||
* The library is currently in a stable release, suitable for download and incorporation into user projects for |
||||
* both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources. |
||||
* |
||||
* LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the |
||||
* library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, |
||||
* from the the WinAVR website (see \ref Page_Resources). |
||||
* |
||||
* The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the |
||||
* microcontroller's timers or other hardware, leaving more hardware to the application developer. |
||||
* |
||||
* Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes |
||||
* and open source LUFA powered projects. |
||||
* |
||||
* <b>Subsections:</b> |
||||
* \li \subpage Page_LicenseInfo - Project source license and commercial use information |
||||
* \li \subpage Page_Donating - Donating to support this project |
||||
* \li \subpage Page_DeviceSupport - Current Device and Hardware Support |
||||
* \li \subpage Page_ChangeLog - Project Changelog |
||||
* \li \subpage Page_KnownIssues - Known Issues |
||||
* \li \subpage Page_FutureChanges - Planned Changes to the Library |
||||
* \li \subpage Page_GettingStarted - Getting started with LUFA |
||||
* \li \subpage Page_DevelopingWithLUFA - Developing with LUFA |
||||
* \li \subpage Page_LUFAPoweredProjects - Other Projects Using LUFA |
||||
* \li \subpage Page_Resources - LUFA and USB Related Resources |
||||
*/ |
||||
|
||||
@ -0,0 +1,674 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_Migration Migrating from Older Versions |
||||
* |
||||
* Below is migration information for updating existing projects based on previous versions of the LUFA library |
||||
* to the next version released. It does not indicate all new additions to the library in each version change, only |
||||
* areas relevant to making older projects compatible with the API changes of each new release. |
||||
* |
||||
* \section Sec_Migration120730 Migrating from 120219 to 120730 |
||||
* <b>Device Mode</b> |
||||
* - The device mode Audio Class driver now requires an additional configuration parameter, the Audio Control interface index. Existing applications should |
||||
* be adjusted to specify the additional configuration parameter. |
||||
* - The HID_DESCRIPTOR_JOYSTICK() macro no longer takes a variable number of axis as a parameter, due to OS incompatibilities; this macro now uses a fixed |
||||
* 3 axis of data. User applications should update their calls to this macro and their report structures to suit a fixed 3-axis joystick report. If a user |
||||
* application requires more than 3 axis' of data, a custom report descriptor will need to be constructed by hand. |
||||
* - The \ref Endpoint_ConfigureEndpoint() function no longer takes in masks for the banks and direction; the number of banks is now an integer argument, and |
||||
* the direction is obtained from the full endpoint address within the device. Applications calling Endpoint_ConfigureEndpoint() should update their API |
||||
* call to use a full endpoint address (including ENDPOINT_DIR_IN or ENDPOINT_DIR_OUT direction in the MSB of the endpoint address) and an integer number |
||||
* of banks. |
||||
* - All endpoint functions now operate on full endpoint addresses within the device, rather than a directionless endpoint index. Applications should update |
||||
* their API calls to use full endpoint addresses when required within the device. |
||||
* - All device mode class drivers have been updated to use a new unified endpoint description structure for all endpoints; existing applications will need |
||||
* to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t). |
||||
* - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing |
||||
* scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint. |
||||
* - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined |
||||
* into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure |
||||
* element name. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The Android Accessory Host class driver property strings are now a array of \c char* rather than a struct of named pointers. Existing applications |
||||
* should use C99 Designated Initializers with the property string indexes located in \ref AOA_Strings_t instead. |
||||
* - The \ref Pipe_ConfigurePipe() function no longer takes in masks for the banks and token; the number of banks is now an integer argument, and the token |
||||
* is now inferred from the full pipe address within the device, and the pipe type. Applications calling Pipe_ConfigurePipe() should update their API |
||||
* call to use a full pipe address (including PIPE_DIR_IN or PIPE_DIR_OUT direction in the MSB of the pipe address) and an integer number of banks. |
||||
* - All pipe functions now operate on full pipe addresses within the device, rather than a directionless pipe index. Applications should update their API |
||||
* calls to use full pipe addresses when required within the device. |
||||
* - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update |
||||
* their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t). |
||||
* - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined |
||||
* into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure |
||||
* element name. |
||||
* - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with |
||||
* files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead |
||||
* of using the makefile module names, you will need to adjust your project makefile. |
||||
* |
||||
* \section Sec_Migration120219 Migrating from 111009 to 120219 |
||||
* <b>USB Core</b> |
||||
* - The HID_KEYBOARD_MODIFER_* macros in the HID class driver have been corrected to HID_KEYBOARD_MODIFIER_* (note the spelling of "modifier"). |
||||
* Existing applications should switch over to the correctly spelled macro names. |
||||
* - The names of the USB Device and USB Host class driver files have changed; a new "ClassDevice" and "ClassHost" postfix has been added to the |
||||
* respective class driver files. Projects referencing the class driver source files by filename rather than the LUFA_SRC_USBCLASS makefile |
||||
* variable should append these postfixes to the source file names. Projects including the USB class driver dispatch headers directly should either |
||||
* switch to including the main USB driver header instead, or use the updated header filenames. |
||||
* - The USB_CONFIG_ATTR_BUSPOWERED constant has been renamed to USB_CONFIG_ATTR_RESERVED, as this was misnamed. All devices must set this bit in |
||||
* the Configuration descriptor's attributes field. As all devices are assumed to be bus-powered unless stated otherwise with the |
||||
* USB_CONFIG_ATTR_SELFPOWERED flag a replacement constant for bus powered devices is not provided. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetInterfaceProperty(). |
||||
* Existing applications must implement this new callback, however if no audio entities are defined in the audio device's descriptors, |
||||
* this function may be hard-coded to always return false for previous behaviour to be retained. |
||||
* |
||||
* \section Sec_Migration111009 Migrating from 110528 to 111009 |
||||
* <b>Non-USB Library Components</b> |
||||
* - The \c JTAG_DEBUG_ASSERT() macro has been renamed \ref JTAG_ASSERT() to be consistent with \ref STDOUT_ASSERT(). |
||||
* |
||||
* <b>USB Core</b> |
||||
* - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of |
||||
* reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimize the compiled program |
||||
* size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering |
||||
* in exchange for a smaller compiled binary size. |
||||
* - The previous \c F_CLOCK symbol, required in the project makefile, has been renamed to \c F_USB. This is due to the previous name |
||||
* being far too generic for use in future architecture ports, where multiple clock domains are used. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The Endpoint stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. |
||||
* This should be set to \c NULL to retain previous behaviour of the functions, or point to a location where the number of bytes |
||||
* processed in the current transaction can be stored. If the \c BytesProcessed parameter is non \c NULL, each time the endpoint |
||||
* bank becomes full and the packet is sent, the routine will exit with the new \ref ENDPOINT_RWSTREAM_IncompleteTransfer |
||||
* error code to allow the user application to determine when to send the next chunk of data. |
||||
* - The \ref CDC_Device_SendString() function now expects a null terminated string instead of an explicit length. Existing code |
||||
* should use the new \ref CDC_Device_SendData() function, or remove the length parameter from the function call. |
||||
* - The \c Endpoint_ResetFIFO() function has been renamed to \ref Endpoint_ResetEndpoint(), to make the API function names more |
||||
* consistent. Existing applications using the old function name should simply replace it with a call to the new function name. |
||||
* - The \c Endpoint_*_Byte() functions have been renamed Endpoint_*_8() to ensure they are correct across all architectures. Existing |
||||
* code using these functions should replace the previous function names with the new function names. |
||||
* - The \c Endpoint_*_Word() functions have been renamed Endpoint_*_16() to ensure they are correct across all architectures. Existing |
||||
* code using these functions should replace the previous function names with the new function names. |
||||
* - The \c Endpoint_*_DWord() functions have been renamed Endpoint_*_32() to ensure they are correct across all architectures. Existing |
||||
* code using these functions should replace the previous function names with the new function names. |
||||
* - The Device mode RNDIS class driver no longer stores the incoming and outgoing packets in the class driver instance; the user is |
||||
* now expected to manually define a storage location for the packet data. Packets must now be sent and received manually via a call |
||||
* to \ref RNDIS_Device_ReadPacket() and/or \ref RNDIS_Device_SendPacket(). |
||||
* - The definition of the Audio class \ref USB_Audio_Descriptor_Format_t has been altered, to remove the fixed singular |
||||
* audio sample rate in the descriptor definition, and to rename the \c SampleFrequencyType to the more appropriate |
||||
* \c TotalDiscreteSampleRates. Existing applications will need to add an array of \ref USB_Audio_SampleFreq_t elements |
||||
* immediately following any \ref USB_Audio_Descriptor_Format_t descriptors, and insert the appropriate sampling rates |
||||
* supported by the device, as well as rename the descriptor elements to match the updated element names. |
||||
* - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetEndpointProperty(). |
||||
* Existing applications must implement this new callback, however if multiple sample rates or pitch control is not used, |
||||
* this function may be hard-coded to always return false for previous behaviour to be retained. |
||||
* - The \c USB_ConfigurationNumber, \c USB_RemoteWakeupEnabled and \c USB_CurrentlySelfPowered globals have been renamed to |
||||
* \ref USB_Device_ConfigurationNumber, \ref USB_Device_RemoteWakeupEnabled and \ref USB_Device_CurrentlySelfPowered to clearly indicate |
||||
* the USB mode they relate to. Existing applications using these variables should rename all references to the previous names. |
||||
* - The \c ENDPOINT_DESCRIPTOR_DIR_IN and \c ENDPOINT_DESCRIPTOR_DIR_OUT macros have now been replaced by \ref ENDPOINT_DIR_IN and |
||||
* \ref ENDPOINT_DIR_OUT to improve code clarity. |
||||
* - The \ref HID_DESCRIPTOR_JOYSTICK() macro now takes an additional (first) parameter indicating the number of axis in the joystick. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. |
||||
* This should be set to \c NULL to retain previous behaviour of the functions, or point to a location where the number of bytes |
||||
* processed in the current transaction can be stored. If the BytesProcessed parameter is non \c NULL, each time the pipe |
||||
* bank becomes full and the packet is sent, the routine will exit with the new \ref PIPE_RWSTREAM_IncompleteTransfer |
||||
* error code to allow the user application to determine when to send the next chunk of data. |
||||
* - The \ref PRNT_Host_SendString() and \ref CDC_Host_SendString() functions now expect a null terminated string instead of an explicit |
||||
* length. Existing code should use the new \ref PRNT_Host_SendData() and \ref CDC_Host_SendData() functions, or remove the |
||||
* length parameter from the function call. |
||||
* - The \c Pipe_ClearErrorFlags() function has been removed, as the pipe error flags are now automatically cleared when the |
||||
* \ref Pipe_ClearError() function is called. |
||||
* - The \c Pipe_*_Byte() functions have been renamed Pipe_*_8() to ensure they are correct across all architectures. Existing code using |
||||
* these functions should replace the previous function names with the new function names. |
||||
* - The \c Pipe_*_Word() functions have been renamed Pipe_*_16() to ensure they are correct across all architectures. Existing code using |
||||
* these functions should replace the previous function names with the new function names. |
||||
* - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using |
||||
* these functions should replace the previous function names with the new function names. |
||||
* - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoing address |
||||
* within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and |
||||
* check for correct usage. |
||||
* |
||||
* \section Sec_Migration101122 Migrating from 100807 to 101122 |
||||
* <b>USB Core</b> |
||||
* - A new USB driver source file, \c Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added |
||||
* to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source |
||||
* variables. |
||||
* - A new USB driver source file, \c Drivers/USB/HighLevel/PipeStream.c now exists. This source file should be added to all |
||||
* project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables. |
||||
* - The \c EVENT_USB_InitFailure() event has been removed, as the \ref USB_Init() function will no longer fail; if not USB mode is |
||||
* specified, the controller will default to UID selection mode. |
||||
* - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent |
||||
* value in the new \ref USB_Modes_t enum. |
||||
* - All class driver headers are now included as part of the standard \c LUFA/Drivers/USB/USB.h master dispatch header, and should |
||||
* no longer be included separately. Class driver module source files must still be added as a separate module in the project's |
||||
* makefile if used. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - Endpoints MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application |
||||
* allocated endpoints in ascending order - or if your application uses the USB device mode class drivers, ensure that each instance's |
||||
* endpoint indexes are not overlapped with other interface's endpoints. |
||||
* - The signature for the \ref CALLBACK_USB_GetDescriptor() callback has changed, the \c void** \c const \c DescriptorAddress parameter is |
||||
* now \c const \c void** \c const \c DescriptorAddress. Existing applications should update their callback signatures to match this, and |
||||
* eliminate any casting of descriptor pointers to a non \c const pointer. |
||||
* - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation |
||||
* for each class driver for the new class specific descriptor type names. |
||||
* - The \c ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \c ENDPOINT_BANKS_SUPPORTED() and now returns the total number of |
||||
* banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the |
||||
* macro is equal to or greater than 2 to regain the previous functionality. |
||||
* - The \c EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after) |
||||
* the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event |
||||
* name, and should ensure that the new execution order does not affect the application's operation. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - Pipes MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application |
||||
* allocated pipes in ascending order - or if your application uses the USB host mode class drivers, ensure that each instance's |
||||
* pipe indexes are not overlapped with other interface's pipes. |
||||
* - The \c PRNT_Host_SendData() function has been renamed to \ref PRNT_Host_SendString(). Existing applications should simply |
||||
* replace all references to the obsolete function name with the new function name. |
||||
* - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation |
||||
* for each class driver for the new class specific descriptor type names. |
||||
* - The Still Image Host class' function prefix has been changed from \c SImage_ to \c SI_, to remain consistent with the rest of the |
||||
* driver's enums, type defines and constants. |
||||
* |
||||
* \section Sec_Migration100807 Migrating from 100513 to 100807 |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal |
||||
* Dataflash driver of the library have now been moved to the individual board files. Existing drivers can |
||||
* copy-paste the new functions from the board Dataflash stub driver. |
||||
* |
||||
* <b>USB Core</b> |
||||
* - A new USB driver source file, \c Drivers/USB/LowLevel/Device.c now exists. This source file should be added to all project |
||||
* makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables. |
||||
* - The \c Drivers/USB/LowLevel/DevChapter9.c source file has moved to \c Drivers/USB/HighLevel/DeviceStandardReq.c - this should |
||||
* be updated in all project makefiles, or the makefile should be updated to use the new module source variables. |
||||
* - The \c Drivers/USB/LowLevel/HostChapter9.h source file has moved to \c Drivers/USB/HighLevel/HostStandardReq.c - this should |
||||
* be updated in all project makefiles, or the makefile should be updated to use the new module source variables. |
||||
* - The \c Drivers/USB/LowLevel/LowLevel.c source file has moved to \c Drivers/LowLevel/USBController.c - this should be updated |
||||
* in all project makefiles, or the makefile should be updated to use the new module source variables. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \c USB_Device_IsRemoteWakeupSent() macro has been removed, as the remote wakeup request is now fully handled by the |
||||
* enhanced \ref USB_Device_SendRemoteWakeup() function. Existing code may now discard any checks to \c USB_Device_IsRemoteWakeupSent(). |
||||
* - The \c USB_Device_IsUSBSuspended() macro has been removed, as it is obsolete. Existing code should compare \ref USB_DeviceState |
||||
* to see if it the device is in the \ref DEVICE_STATE_Suspended state instead. |
||||
* - The \ref CDC_Device_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was |
||||
* received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact |
||||
* number of queued bytes received is not needed. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was |
||||
* received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact |
||||
* number of queued bytes received is not needed. |
||||
* - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual |
||||
* flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask(). |
||||
* |
||||
* \section Sec_Migration100513 Migrating from 100219 to 100513 |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed |
||||
* device must respond or the function will abort. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \ref USB_Init() function no longer calls \c sei() to enable global interrupts, as the user application may need |
||||
* to perform other initialization before it is ready to handle global interrupts. The user application is now responsible |
||||
* for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process |
||||
* functions correctly. |
||||
* - The \c USBInterrupt.c USB driver source file has been relocated from \c LUFA/Drivers/USB/HighLevel/ to \c LUFA/Drivers/USB/LowLevel. |
||||
* Projects must update their makefile SRC values accordingly. |
||||
* - The HID Device Class driver's function signature for the \ref CALLBACK_HID_Device_ProcessHIDReport() function has been changed, to |
||||
* allow for a new \c ReportType parameter. This new parameter must be added in all user applications using the Device mode HID Class |
||||
* Driver, but may be ignored unless Host-to-Device FEATURE HID reports are used. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \ref USB_Init() function no longer calls \c sei() to enable global interrupts, as the user application may need |
||||
* to perform other initialization before it is ready to handle global interrupts. The user application is now responsible |
||||
* for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process |
||||
* functions correctly. |
||||
* - The \c USBInterrupt.c USB driver source file has been relocated from \c LUFA/Drivers/USB/HighLevel/ to \c LUFA/Drivers/USB/LowLevel. |
||||
* Projects must update their makefile \c SRC values accordingly. |
||||
* - The HID Host Class driver's function signature for the \ref HID_Host_SendReportByID() function has been changed, to allow for a new |
||||
* ReportType parameter. Existing calls to this function should substitute \c REPORT_ITEM_TYPE_Out as this parameter's value. |
||||
* |
||||
* \section Sec_Migration100219 Migrating from 091223 to 100219 |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models, |
||||
* the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used |
||||
* when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function |
||||
* is an exception, and should always be called with a channel number rather than a channel mask. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be |
||||
* packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send |
||||
* pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually |
||||
* flush the queued event(s) to the device by calling \ref MIDI_Host_Flush(). |
||||
* - The \ref Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address |
||||
* is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint |
||||
* address against the \ref PIPE_EPNUM_MASK token before calling \ref Pipe_IsEndpointBound(). |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be |
||||
* packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send |
||||
* endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually |
||||
* flush the queued event(s) to the host by calling \ref MIDI_Device_Flush(). |
||||
* |
||||
* \section Sec_Migration091223 Migrating from 091122 to 091223 |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The Still Image Host Class driver \ref SI_Host_USBTask() and \ref SI_Host_ConfigurePipes() functions were misnamed, and are |
||||
* now named \c SImage_Host_USBTask() and \c SImage_Host_ConfigurePipes() respectively. |
||||
* - The \c HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in |
||||
* line with the rest of the library error codes. |
||||
* - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID |
||||
* specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items |
||||
* can be distinguished from one-another. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \ref CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new \c ReportType parameter to |
||||
* indicate the report type to generate. Existing applications may simply add and ignore this additional parameter. |
||||
* |
||||
* \section Sec_Migration091122 Migrating from 090924 to 091122 |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \c HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow |
||||
* - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete \ref HID_ReportItem_t to the |
||||
* user application, instead of just its attributes. |
||||
* - The \c USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor(). |
||||
* |
||||
* \section Sec_Migration090924 Migrating from 090810 to 090924 |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The \c ADC_Off() function has been renamed to \c ADC_ShutDown() to be consistent with the rest of the library. |
||||
* - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See |
||||
* the \ref SPI_Init() function documentation for more details |
||||
* - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a |
||||
* call to \ref SPI_Init() before using the Dataflash driver |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \c USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to |
||||
* preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single |
||||
* call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user |
||||
* application perform these intermediary steps. |
||||
* - The HID report parser now requires a mandatory callback in the user code, to filter only the items the application |
||||
* is interested in into the processed HID report item structure to save RAM. See \ref CALLBACK_HIDParser_FilterHIDReportItem(). |
||||
* - The HID report parser now always parses FEATURE and always ignores constant-data items - the \c HID_ENABLE_FEATURE_PROCESSING |
||||
* and \c HID_INCLUDE_CONSTANT_DATA_ITEMS compile time tokens now have no effect. |
||||
* - The \c USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate \c USB_Descriptor_* |
||||
* and \c USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in |
||||
* the one project. For existing projects using the standardized names, change all code to use the \c USB_StdDescriptor_* variants. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \c USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate \c USB_Descriptor_* |
||||
* and \c USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in |
||||
* the one project. For existing projects using the standardized names, change all code to use the \c USB_StdDescriptor_* variants. |
||||
* |
||||
* \section Sec_Migration090810 Migrating from 090605 to 090810 |
||||
* |
||||
* <b>All</b> |
||||
* - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abstracted loop and caused much confusion. |
||||
* User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future |
||||
* release. |
||||
* - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never |
||||
* used in user applications. |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The \c ATTR_NOINLINE function attribute macro has been renamed to \ref ATTR_NO_INLINE to be in line with the rest of the function attribute |
||||
* macro names. |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - Most demos now have a corresponding Class Driver implementation, which uses the new internal library class drivers for the standard |
||||
* USB classes. This allows for more rapid device and host development, and so should be used in preference to the low level APIs where |
||||
* possible so that fixes to the class drivers propagate to all applications which use them automatically with each new LUFA release. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \c HIDParser.c module has moved from \c LUFA/Drivers/USB/Class/ to \c LUFA/Drivers/USB/Class/Host/. |
||||
* - The \c USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first |
||||
* parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the |
||||
* first configuration descriptor within the device. |
||||
* - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of |
||||
* the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured |
||||
* state. |
||||
* - The \c USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_HostState explicitly to ensure the host is |
||||
* in the desired state instead. |
||||
* - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode |
||||
* events. See the \ref Group_Events page for details on the new event names and firing conditions. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that |
||||
* descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the \c USE_FLASH_DESCRIPTORS |
||||
* token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter. |
||||
* - The \c USB_IsSuspended global has been removed - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead. |
||||
* - The \c USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState explicitly to ensure the device |
||||
* is in the desired state instead. |
||||
* - The VBUS events have been removed, as they are already exposed to the user via the \c USB_Connect and \c USB_Disconnect events. |
||||
* - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode |
||||
* events. See the \ref Group_Events page for details on the new event names and firing conditions. |
||||
* |
||||
* \section Sec_Migration090605 Migrating from 090510 to 090605 |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing |
||||
* projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can |
||||
* manage the control endpoint via interrupts automatically by compiling with the \c INTERRUPT_CONTROL_ENDPOINT token defined. |
||||
* - The \c DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory |
||||
* address. |
||||
* - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See |
||||
* \ref Group_Events for new API details. |
||||
* - The \c STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular |
||||
* function signatures of a function accepting no arguments and returning a \c uint8_t value. |
||||
* - The \c Event_DeviceError() event no longer exists, as its sole caller (unlinked \c USB_GetDescriptor() function) now produces a |
||||
* compilation error rather than a runtime error. The \c StdDescriptors.c file no longer exists as a result, and should be removed |
||||
* from project makefiles. |
||||
* - The \c USB_GetDescriptor() function has been renamed to \ref CALLBACK_USB_GetDescriptor() to be in line with the new \c CALLBACK_ |
||||
* function prefixes for functions which <i>must</i> be implemented in the user application. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing |
||||
* projects using interrupts on non-control pipes should switch to polling. |
||||
* - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See |
||||
* \ref Group_Events for new API details. |
||||
* - The \c STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular |
||||
* function signatures of a function accepting no arguments and returning a \c uint8_t value. |
||||
* - The \c DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with |
||||
* regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a \c uint8_t value. |
||||
* |
||||
* \section Sec_Migration090510 Migrating from 090401 to 090510 |
||||
* |
||||
* <b>All</b> |
||||
* - The \c ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all |
||||
* \c BUTTLOADTAG() elements, or download and extract \c ButtLoadTag.h header from the ButtLoad project. |
||||
* - The \c Drivers/AT90USBXXX/ directory has been renamed to \c Drivers/Peripheral/. |
||||
* - The \c Serial_Stream driver has been renamed to \c SerialStream to remain consistent with the rest of the library naming scheme. |
||||
* - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API. |
||||
* |
||||
* <b>Dual Role Mode</b> |
||||
* - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure. |
||||
* - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more |
||||
* details. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \c Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the \ref Endpoint_ClearIN(), \ref Endpoint_ClearOUT() |
||||
* macros. See \c Endpoint.h documentation for more details on the new endpoint management macros. |
||||
* - The \c Endpoint_ReadWriteAllowed() macro has been renamed to \ref Endpoint_IsReadWriteAllowed() to be more consistent with the rest of |
||||
* the API naming scheme. |
||||
* - The \c Endpoint_IsSetupINReady() and \c Endpoint_IsSetupOUTReceived() macros have been renamed to \ref Endpoint_IsINReady() and |
||||
* \ref Endpoint_IsOUTReceived() respectively. |
||||
* - The \c Endpoint_IsSetupReceived() macro has been renamed to \ref Endpoint_IsSETUPReceived(). |
||||
* - The \c Endpoint_ClearSetupReceived() macro has been renamed to \ref Endpoint_ClearSETUP(). |
||||
* - All endpoint read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Endpoint_Read_Word()) have |
||||
* been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions. |
||||
* - The \c USB_UnhandledControlPacket event no longer has any parameters. User code should no longer attempt to read in the remainder of |
||||
* the Control Request header as all Control Request header data is now preloaded by the library and made available in the |
||||
* USB_ControlRequest structure. |
||||
* - The \c FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to \c CONTROL_ONLY_DEVICE. |
||||
* - The \c STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically. |
||||
* - The values of the \ref Endpoint_Stream_RW_ErrorCodes_t and \ref Endpoint_ControlStream_RW_ErrorCodes_t enums have had the \c ERROR_ portion |
||||
* of their names removed. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \ref USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on |
||||
* other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called |
||||
* in existing projects where the Control pipe is to be operated on. |
||||
* - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer |
||||
* need to manage this manually when calling the USB management task. |
||||
* - The \c Pipe_ClearCurrentBank() macro has been removed, and is now replaced with the Pipe_ClearIN(), Pipe_ClearOUT() macros. See |
||||
* Pipe.h documentation for more details on the new pipe management macros. |
||||
* - The \c Pipe_ReadWriteAllowed() macro has been renamed to \ref Pipe_IsReadWriteAllowed() to be more consistent with the rest of the API |
||||
* naming scheme. |
||||
* - The \c Pipe_IsSetupINReceived() and \c Pipe_IsOutReady() macros have been renamed to \ref Pipe_IsINReceived() and \ref Pipe_IsOUTReady() |
||||
* respectively. |
||||
* - The new \ref Pipe_ClearSETUP() macro should be used to send SETUP transactions, rather than the previous \c Pipe_ClearSetupOUT() macro. |
||||
* - The \c Pipe_IsSetupSent() macro has been renamed to \ref Pipe_IsSETUPSent(). |
||||
* - The \c Pipe_ClearSetupSent() macro is no longer applicable and should be removed. |
||||
* - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Pipe_Read_Word()) have |
||||
* been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions. |
||||
* - The \c Host_IsResetBusDone() macro has been renamed to \c Host_IsBusResetComplete(). |
||||
* - The \c Pipe_Ignore_Word() and \c Pipe_Ignore_DWord() functions have been renamed to \c Pipe_Discard_Word() and \c Pipe_Discard_DWord() |
||||
* to remain consistent with the rest of the pipe API. |
||||
* - It is no longer needed to manually include the headers from \c LUFA/Drivers/USB/Class, as they are now included along with the rest |
||||
* of the USB headers when \c LUFA/Drivers/USB/USB.h is included. |
||||
* - Functions in the \c ConfigDescriptor.h header file no longer have \c Host_ as part of their names. |
||||
* - The \c ProcessHIDReport() has been renamed to \ref USB_ProcessHIDReport(), \c GetReportItemInfo() has been renamed to \ref USB_GetHIDReportItemInfo() |
||||
* and \c SetReportItemInfo() has been renamed to \ref USB_GetHIDReportItemInfo(). |
||||
* - The values of the \ref DSearch_Return_ErrorCodes_t and \ref DSearch_Comp_Return_ErrorCodes_t enums have had their respective \c Descriptor_Search |
||||
* and \c Descriptor_Search_Comp prefixes changed to all caps. |
||||
* - The \c USB_HostRequest global has been renamed to \ref USB_ControlRequest, and is used in Device mode also. The \c USB_Host_Request_Header_t |
||||
* structure type has been renamed to \ref USB_Request_Header_t. |
||||
* - The values of the \ref Pipe_Stream_RW_ErrorCodes_t enum have had the \c ERROR_ portion of their names removed. |
||||
* |
||||
* \section Sec_Migration090401 Migrating from 090209 to 090401 |
||||
* |
||||
* <b>All</b> |
||||
* - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_USB, |
||||
* defined in the project makefile and passed to the compiler via the -D switch. |
||||
* - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the |
||||
* EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called. |
||||
* - As the avr-libc macro has been corrected in recent avr-libc distributions, the \c SetSystemClockPrescaler() macro has been removed. |
||||
* Include \c <avr/power.h> and call \c clock_prescale_set(clock_div_1); instead on recent avr-libc distributions. |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission. |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The \c ATTR_ALWAYSINLINE function attribute macro has been renamed to \ref ATTR_ALWAYS_INLINE. |
||||
* - Custom board Dataflash drivers now require the implementation of \ref Dataflash_SelectChipFromPage() and \ref Dataflash_SendAddressBytes(). |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \c NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to \c FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded |
||||
* to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the |
||||
* \c NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the \c FEATURELESS_CONTROL_ONLY_DEVICE token with no further |
||||
* modifications required. |
||||
* |
||||
* \section Sec_Migration090209 Migrating from 081217 to 090209 |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The \c ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of \c ENDPOINT_TOTAL_ENDPOINTS. |
||||
* - The \c USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user |
||||
* makefile if desired to restore the previous 50ms timeout. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The \c PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of \c PIPE_TOTAL_ENDPOINTS. |
||||
* - The \c USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user |
||||
* makefile if desired to restore the previous 50ms timeout. |
||||
* - The \c USB_DeviceEnumerationFailed event now contains a second \c SubErrorCode parameter, giving the error code of the function |
||||
* which failed. |
||||
* - The \c HID_PARSE_Sucessful enum member constant name has been corrected to \ref HID_PARSE_Successful. |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The previous \c SPI_SendByte() functionality is now located in \ref SPI_TransferByte(). \ref SPI_SendByte() now discards the return byte |
||||
* for speed, to compliment the new \ref SPI_ReceiveByte() function. If bidirectional SPI transfers are required, calls to \ref SPI_SendByte() |
||||
* should be changed to \ref SPI_TransferByte(). |
||||
* - The serial driver now sets the Tx line as an output explicitly, and enables the pull-up of the Rx line. |
||||
* - The \ref Serial_Init() and \c SerialStream_Init() functions now take a second \c DoubleSpeed parameter, which indicates if the USART |
||||
* should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at the given AVR |
||||
* clock speed. |
||||
* |
||||
* \section Sec_Migration171208 Migrating from V1.5.3 to 081217 |
||||
* |
||||
* <b>All</b> |
||||
* - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names, |
||||
* have been changed to LUFA. |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding |
||||
* parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version. |
||||
* - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and |
||||
* KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects |
||||
* built on either "WithParser" demo should update to the latest code. |
||||
* - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not |
||||
* recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes, |
||||
* as it is neither a full nor a standards compliant implementation. |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The Serial_IsCharReceived() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask |
||||
* to be used in the Options parameter of the USB_Init() function. |
||||
* - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is |
||||
* currently initialized. |
||||
* - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library |
||||
* or user request processing code to exceed the strict USB timing requirements on control transfers. |
||||
* - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured |
||||
* after a Reset event, it should be altered to explicitly re-initialize all user endpoints. |
||||
* - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now |
||||
* returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified |
||||
* descriptor does not exist. |
||||
* - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the |
||||
* GetDescriptor function. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask |
||||
* to be used in the Options parameter of the USB_Init() function. |
||||
* - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and |
||||
* SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the |
||||
* current report. If sending a report to a multi-report device, the first byte of the report is automatically |
||||
* set to the report ID of the given report item. |
||||
* - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is |
||||
* currently initialized. |
||||
* |
||||
* \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3 |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number |
||||
* string is required in Mass Storage devices, or devices which are to retain settings when moved between |
||||
* ports on a machine. As people were not changing the serial number value, this was causing conflicts and so |
||||
* the serial number descriptor has been removed from all but the Mass Storage demo, which requires it. |
||||
* - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated |
||||
* them. Projects built upon either demo should upgrade to the latest code. |
||||
* - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented. |
||||
* - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built |
||||
* on the MassStoreDemo code should update to the latest version. |
||||
* - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused |
||||
* problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade |
||||
* to the latest code. |
||||
* - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects |
||||
* built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code. |
||||
* - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should |
||||
* upgrade to the latest code. |
||||
* - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was |
||||
* previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update |
||||
* to the latest code. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream. |
||||
* If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The |
||||
* timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired |
||||
* timeout duration in ms. |
||||
* - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled |
||||
* and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and |
||||
* USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details. |
||||
* - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated |
||||
* to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing |
||||
* the token NO_STREAM_CALLBACKS to the compiler using the -D switch. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream. |
||||
* If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The |
||||
* timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired |
||||
* timeout duration in ms. |
||||
* - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures. |
||||
* - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated |
||||
* to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing |
||||
* the token NO_STREAM_CALLBACKS to the compiler using the -D switch. |
||||
* |
||||
* \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2 |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations |
||||
* of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade |
||||
* to the latest code. |
||||
* - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where |
||||
* possible any existing devices upgrade to the latest bootloader code. |
||||
* |
||||
* \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1 |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the |
||||
* global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo |
||||
* should upgrade to the latest code. |
||||
* - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID |
||||
* demos should upgrade to the latest code. |
||||
* - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors. |
||||
* Projects built upon the HID demos should upgrade to the latest code. |
||||
* - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo |
||||
* should upgrade to the latest code. |
||||
* - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power. |
||||
* Projects built upon the AudioOut demo should upgrade to the latest code. |
||||
* |
||||
* \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0 |
||||
* |
||||
* <b>Library Demos</b> |
||||
* - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To |
||||
* avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing |
||||
* projects should at least manually correct the BCD version numbers, or preferably update the descriptors to |
||||
* encode the version number in BCD format using the new macro. |
||||
* - The mandatory GetReport class-specific request was accidentally omitted from previous versions of the demos |
||||
* based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the |
||||
* HID demos should also be updated accordingly. |
||||
* - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission. |
||||
* Failure to do this on projects which always or frequently send full packets will cause buffering issues on |
||||
* the host OS. All CDC user projects are advised to update their transmission routines in the same manner as |
||||
* the library CDC demos. |
||||
* - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected |
||||
* Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven |
||||
* demos should also update to properly save and restore the selected Endpoint/Pipe. |
||||
* |
||||
* <b>Non-USB Library Components</b> |
||||
* - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only |
||||
* compatible with avr-libc library versions newer than the time before the functionality of the deleted |
||||
* headers was available. |
||||
* |
||||
* <b>Device Mode</b> |
||||
* - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and |
||||
* functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API. |
||||
* The previously split Type and Index parameters are now passed as the original wValue parameter to the |
||||
* function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the |
||||
* previous Index parameter. |
||||
* - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the |
||||
* official USB specification. Existing code will need to be altered to use the new parameter names. |
||||
* - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more |
||||
* appropriate. It fires in an identical manner to the previously named event, thus the only change to be made |
||||
* is the event name itself in the user project. |
||||
* - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a |
||||
* pseudo-descriptor modeled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type |
||||
* descriptor as indicated in the USB specification, thus all device code must be updated accordingly. |
||||
* - The names of several Endpoint macros have been changed to be more consistent with the rest of the library, |
||||
* with no implementation changes. This means that existing code can be altered to use the new macro names |
||||
* with no other considerations required. See Endpoint.h for the new macro names. |
||||
* - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t |
||||
* structure named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this |
||||
* demo should correct the structure value to maintain compatibility across multiple OS platforms. |
||||
* - By default, the descriptor structures use the official USB specification names for the elements. Previous |
||||
* versions of the library used non-standard (but more verbose) names, which are still usable in the current |
||||
* and future releases when the correct compile time option is enabled. See the StdDescriptors.h file |
||||
* documentation for more details. |
||||
* |
||||
* <b>Host Mode</b> |
||||
* - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its |
||||
* members renamed to the official USB specification names for requests. Existing code will need to be updated |
||||
* to use the new names. |
||||
* - The names of several Pipe macros have been changed to be more consistent with the rest of the library, |
||||
* with no implementation changes. This means that existing code can be altered to use the new macro names |
||||
* with no other considerations required. See Pipe.h for the new macro names. |
||||
* - By default, the descriptor structures use the official USB specification names for the elements. Previous |
||||
* versions of the library used non-standard (but more verbose) names, which are still usable in the current |
||||
* and future releases when the correct compile time option is enabled. See the StdDescriptors.h file |
||||
* documentation for more details. |
||||
* - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h |
||||
* module documentation for the new macro names. |
||||
* |
||||
* <b>Dual Role Mode</b> |
||||
* - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing |
||||
* projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG |
||||
* header inside the library. |
||||
* - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has |
||||
* finished enumerating the device. Projects relying on the event only firing in Host mode should be updated |
||||
* so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST. |
||||
*/ |
||||
|
||||
@ -0,0 +1,30 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_ProgrammingApps Programming an Application into a USB AVR |
||||
* |
||||
* Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your |
||||
* application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the |
||||
* reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the |
||||
* supported AVR programming protocols - ISP, HVSP, HVPP, JTAG, dW or PDI. This can be done through a custom programmer, |
||||
* a third party programmer, or an official Atmel AVR tool - for more information, see the <a>atmel.com</a> website. |
||||
* |
||||
* Alternatively, you can use the bootloader. From the Atmel factory, each USB AVR comes preloaded with the Atmel |
||||
* DFU (Device Firmware Update) class bootloader, a small piece of AVR firmware which allows the remainder of the |
||||
* AVR to be programmed through a non-standard interface such as the serial USART port, SPI, or (in this case) USB. |
||||
* Bootloaders have the advantage of not requiring any special hardware for programming, and cannot usually be erased |
||||
* or broken without an external programming device. They have disadvantages however; they cannot change the fuses of |
||||
* the AVR (special configuration settings that control the operation of the chip itself) and a small portion of the |
||||
* AVR's FLASH program memory must be reserved to contain the bootloader firmware, and thus cannot be used by the |
||||
* loaded application. |
||||
* |
||||
* If you wish to use the DFU bootloader to program in your application, refer to your DFU programmer's documentation. |
||||
* Atmel provides a free utility called FLIP which is USB AVR compatible, and an open source (Linux compatible) |
||||
* alternative exists called "dfu-programmer". |
||||
* |
||||
* \see \ref Page_BuildModule_DFU for information on the LUFA build system DFU module, for automatic DFU bootloader |
||||
* programming makefile targets. |
||||
*/ |
||||
@ -0,0 +1,71 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** |
||||
* \page Page_SoftwareBootloaderStart Entering the Bootloader via Software |
||||
* |
||||
* A common requirement of many applications is the ability to jump to the programmed bootloader of a chip |
||||
* on demand, via the code's firmware (i.e. not as a result of any physical user interaction with the |
||||
* hardware). This might be required because the device does not have any physical user input, or simply |
||||
* just to streamline the device upgrade process on the host PC. |
||||
* |
||||
* The following C code snippets may be used to enter the bootloader upon request by the user application. |
||||
* By using the watchdog to physically reset the controller, it is ensured that all system hardware is |
||||
* completely reset to their defaults before the bootloader is run. This is important; since bootloaders |
||||
* are written to occupy a very limited space, they usually make assumptions about the register states based |
||||
* on the default values after a hard-reset of the chip. |
||||
* |
||||
* \section Sec_SoftareBootAVR8 AVR8 Architecture |
||||
* The following software bootloader jump code is written for the AVR8 architecture. |
||||
* |
||||
* \code |
||||
* #include <avr/wdt.h> |
||||
* #include <avr/io.h> |
||||
* #include <util/delay.h> |
||||
* |
||||
* #include <LUFA/Common/Common.h> |
||||
* #include <LUFA/Drivers/USB/USB.h> |
||||
* |
||||
* uint32_t Boot_Key ATTR_NO_INIT; |
||||
* |
||||
* #define MAGIC_BOOT_KEY 0xDC42ACCA |
||||
* #define BOOTLOADER_START_ADDRESS (FLASH_SIZE_BYTES - BOOTLOADER_SEC_SIZE_BYTES) |
||||
* |
||||
* void Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3); |
||||
* void Bootloader_Jump_Check(void) |
||||
* { |
||||
* // If the reset source was the bootloader and the key is correct, clear it and jump to the bootloader |
||||
* if ((MCUSR & (1 << WDRF)) && (Boot_Key == MAGIC_BOOT_KEY)) |
||||
* { |
||||
* Boot_Key = 0; |
||||
* ((void (*)(void))BOOTLOADER_START_ADDRESS)(); |
||||
* } |
||||
* } |
||||
* |
||||
* void Jump_To_Bootloader(void) |
||||
* { |
||||
* // If USB is used, detach from the bus and reset it |
||||
* USB_Disable(); |
||||
* |
||||
* // Disable all interrupts |
||||
* cli(); |
||||
* |
||||
* // Wait two seconds for the USB detachment to register on the host |
||||
* Delay_MS(2000); |
||||
* |
||||
* // Set the bootloader key to the magic value and force a reset |
||||
* Boot_Key = MAGIC_BOOT_KEY; |
||||
* wdt_enable(WDTO_250MS); |
||||
* for (;;); |
||||
* } |
||||
* \endcode |
||||
* |
||||
* Note that the bootloader magic key can be any arbitrary value. The <em>FLASH_SIZE_BYTES</em> and |
||||
* <em>BOOTLOADER_SEC_SIZE_BYTES</em> tokens should be replaced with the total flash size of the AVR |
||||
* in bytes, and the allocated size of the bootloader section for the target AVR. |
||||
* |
||||
*/ |
||||
|
||||
@ -0,0 +1,35 @@ |
||||
<!--BEGIN GENERATE_TREEVIEW--> |
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
||||
<ul> |
||||
<li class="footer" style="float:left !important;"> |
||||
$generatedby |
||||
<a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="$relpath$doxygen.png" alt="doxygen"/> |
||||
</a> |
||||
$doxygenversion |
||||
</li> |
||||
|
||||
<li class="footer"> |
||||
<a href="http://www.lufa-lib.org" title="LUFA Project Page">LUFA Project Page</a> | <a href="http://www.lufa-lib.org/support" title="LUFA Support List">Support Mailing List</a> | <a href="http://www.lufa-lib.org/donate" title="Donate to Support LUFA">Donate</a> | <a href="http://www.fourwalledcubicle.com" title="Four Walled Cubicle Website">Four Walled Cubicle</a> - LUFA, the Lightweight USB Framework for AVRs |
||||
</li> |
||||
</ul> |
||||
</div> |
||||
<!--END GENERATE_TREEVIEW--> |
||||
<!--BEGIN !GENERATE_TREEVIEW--> |
||||
<hr class="footer"/> |
||||
<div class="footer"> |
||||
<span style="float: left;"> |
||||
$generatedby |
||||
<a href="http://www.doxygen.org/index.html"> |
||||
<img class="footer" src="$relpath$doxygen.png" alt="doxygen"/> |
||||
</a> |
||||
$doxygenversion |
||||
</span> |
||||
|
||||
<span style="margin-right: 20px; float: right;"> |
||||
<a href="http://www.lufa-lib.org" title="LUFA Project Page">LUFA Project Page</a> | <a href="http://www.lufa-lib.org/support" title="LUFA Support List">Support Mailing List</a> | <a href="http://www.lufa-lib.org/donate" title="Donate to Support LUFA">Donate</a> | <a href="http://www.fourwalledcubicle.com" title="Four Walled Cubicle Website">Four Walled Cubicle</a> - LUFA, the Lightweight USB Framework for AVRs |
||||
</span> |
||||
</div> |
||||
<!--END !GENERATE_TREEVIEW--> |
||||
</body> |
||||
</html> |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,424 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_VIDPID VID and PID values |
||||
* |
||||
* \section Sec_VIDPID_Allocations VID and PID Allocations |
||||
* The LUFA library uses VID/PID combinations generously donated by Atmel. The following VID/PID combinations |
||||
* are used within the LUFA demos, and thus may be re-used by derivations of each demo. Free PID values may be |
||||
* used by future LUFA demo projects. |
||||
* |
||||
* <b>These VID/PID values should not be used in commercial designs under any circumstances.</b> Private projects |
||||
* may use the following values freely, but must accept any collisions due to other LUFA derived private projects |
||||
* sharing identical values. It is suggested that private projects using interfaces compatible with existing |
||||
* demos share the same VID/PID value. |
||||
* |
||||
* <table> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* <b>VID</b> |
||||
* </td> |
||||
* <td> |
||||
* <b>PID</b> |
||||
* </td> |
||||
* <td> |
||||
* <b>Usage</b> |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2040 |
||||
* </td> |
||||
* <td> |
||||
* Test VID/PID (See below) |
||||
* </td> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2041 |
||||
* </td> |
||||
* <td> |
||||
* Mouse Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2042 |
||||
* </td> |
||||
* <td> |
||||
* Keyboard Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2043 |
||||
* </td> |
||||
* <td> |
||||
* Joystick Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2044 |
||||
* </td> |
||||
* <td> |
||||
* CDC Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2045 |
||||
* </td> |
||||
* <td> |
||||
* Mass Storage Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2046 |
||||
* </td> |
||||
* <td> |
||||
* Audio Output Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2047 |
||||
* </td> |
||||
* <td> |
||||
* Audio Input Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2048 |
||||
* </td> |
||||
* <td> |
||||
* MIDI Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2049 |
||||
* </td> |
||||
* <td> |
||||
* MagStripe Project |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x204A |
||||
* </td> |
||||
* <td> |
||||
* CDC Bootloader |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x204B |
||||
* </td> |
||||
* <td> |
||||
* USB to Serial Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x204C |
||||
* </td> |
||||
* <td> |
||||
* RNDIS Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x204D |
||||
* </td> |
||||
* <td> |
||||
* Combined Keyboard and Mouse Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x204E |
||||
* </td> |
||||
* <td> |
||||
* Dual CDC Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x204F |
||||
* </td> |
||||
* <td> |
||||
* Generic HID Demo Application |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2060 |
||||
* </td> |
||||
* <td> |
||||
* Benito Programmer Project |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2061 |
||||
* </td> |
||||
* <td> |
||||
* Combined Mass Storage and Keyboard Demo |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2062 |
||||
* </td> |
||||
* <td> |
||||
* Combined CDC and Mouse Demo |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2063 |
||||
* </td> |
||||
* <td> |
||||
* Mass Storage/HID Interface Datalogger Project |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2064 |
||||
* </td> |
||||
* <td> |
||||
* Interfaceless Control-Only LUFA Devices |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2065 |
||||
* </td> |
||||
* <td> |
||||
* Test and Measurement Demo |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2066 |
||||
* </td> |
||||
* <td> |
||||
* Multiple Report Keyboard/Mouse HID Demo |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2067 |
||||
* </td> |
||||
* <td> |
||||
* HID Class Bootloader |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2068 |
||||
* </td> |
||||
* <td> |
||||
* Virtual Serial/Mass Storage Demo |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x2069 |
||||
* </td> |
||||
* <td> |
||||
* Webserver Project |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x206A |
||||
* </td> |
||||
* <td> |
||||
* Media Control Project |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x206B |
||||
* </td> |
||||
* <td> |
||||
* <i>Currently Unallocated</i> |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x206C |
||||
* </td> |
||||
* <td> |
||||
* <i>Currently Unallocated</i> |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x206D |
||||
* </td> |
||||
* <td> |
||||
* <i>Currently Unallocated</i> |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x206E |
||||
* </td> |
||||
* <td> |
||||
* <i>Currently Unallocated</i> |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* <tr> |
||||
* <td> |
||||
* 0x03EB |
||||
* </td> |
||||
* <td> |
||||
* 0x206F |
||||
* </td> |
||||
* <td> |
||||
* <i>Currently Unallocated</i> |
||||
* </td> |
||||
* </tr> |
||||
* |
||||
* </table> |
||||
* |
||||
* \section Sec_Test_VIDPID The Test VID/PID Combination |
||||
* For use in testing of LUFA powered devices during development only, by non-commercial entities. |
||||
* All devices must accept collisions on this VID/PID range (from other in-development LUFA devices) |
||||
* to be resolved by using a unique release number in the Device Descriptor. No devices using this |
||||
* VID/PID combination may be released to the general public. |
||||
*/ |
||||
|
||||
@ -0,0 +1,27 @@ |
||||
/** \file |
||||
* |
||||
* This file contains special DoxyGen information for the generation of the main page and other special |
||||
* documentation pages. It is not a project source file. |
||||
*/ |
||||
|
||||
/** \page Page_WritingBoardDrivers Writing LUFA Board Drivers |
||||
* |
||||
* LUFA ships with several basic pre-made board drivers, to control hardware present on the supported board |
||||
* hardware - such as Dataflash ICs, LEDs, Joysticks, or other hardware peripherals. When compiling an application |
||||
* which makes use of one or more board drivers located in LUFA/Drivers/Board, you must also indicate what board |
||||
* hardware you are using in your project makefile. This is done by defining the BOARD macro using the -D switch |
||||
* passed to the compiler, with a constant of BOARD_{Name}. For example <b>-DBOARD=BOARD_USBKEY</b> instructs the |
||||
* compiler to use the USBKEY board hardware drivers. |
||||
* |
||||
* If your application does not use *any* board level drivers, you can omit the definition of the BOARD macro. |
||||
* However, some users may wish to write their own custom board hardware drivers which are to remain compatible |
||||
* with the LUFA hardware API. To do this, the BOARD macro should be defined to the value BOARD_USER. This indicates |
||||
* that the board level drivers should be located in a folder named "Board" located inside the application's folder. |
||||
* |
||||
* When used, the driver stub files located in the LUFA/CodeTemplates/DriverStubs folder should be copied to the user |
||||
* Board/ directory, and fleshed out to include the values and code needed to control the custom board hardware. Once |
||||
* done, the existing LUFA board level APIs (accessed in the regular LUFA/Drivers/Board/ folder) will redirect to the |
||||
* user board drivers, maintaining code compatibility and allowing for a different board to be selected through the |
||||
* project makefile with no code changes. |
||||
*/ |
||||
|
||||
@ -0,0 +1,135 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Adafruit U4 Breakout board. |
||||
* \copydetails Group_LEDs_ADAFRUITU4 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_ADAFRUITU4 ADAFRUITU4 |
||||
* \brief Board specific LED driver header for the Adafruit U4 Breakout board. |
||||
* |
||||
* Board specific LED driver header for the Adafruit U4 Breakout board (http://ladyada.net/products/atmega32u4breakout).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTE.6</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_ADAFRUITU4_H__ |
||||
#define __LEDS_ADAFRUITU4_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 6) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for the none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRE |= LEDS_ALL_LEDS; |
||||
PORTE &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRE &= ~LEDS_ALL_LEDS; |
||||
PORTE &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTE |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTE &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTE = ((PORTE & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTE = ((PORTE & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINE = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTE & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Atmel ATAVRUSBRF01. |
||||
* \copydetails Group_Buttons_ATAVRUSBRF01 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_ATAVRUSBRF01 ATAVRUSBRF01 |
||||
* \brief Board specific Buttons driver header for the Atmel ATAVRUSBRF01. |
||||
* |
||||
* Board specific Buttons driver header for the Atmel ATAVRUSBRF01. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_ATAVRUSBRF01_H__ |
||||
#define __BUTTONS_ATAVRUSBRF01_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,139 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Atmel ATAVRUSBRF01. |
||||
* \copydetails Group_LEDs_ATAVRUSBRF01 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_ATAVRUSBRF01 ATAVRUSBRF01 |
||||
* \brief Board specific LED driver header for the Atmel ATAVRUSBRF01. |
||||
* |
||||
* Board specific LED driver header for the Atmel ATAVRUSBRF01. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>RX LED</td><td>High</td><td>PORTD.0</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Red</td><td>TX LED</td><td>High</td><td>PORTD.1</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_ATAVRUSBRF01_H__ |
||||
#define __LEDS_ATAVRUSBRF01_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 0) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 1) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= (LEDMask & LEDS_ALL_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~(LEDMask & LEDS_ALL_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = (PORTD & ~LEDS_ALL_LEDS) | (LEDMask & LEDS_ALL_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Tempusdictum Benito. |
||||
* \copydetails Group_Buttons_BENITO |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_BENITO BENITO |
||||
* \brief Board specific Buttons driver header for the Tempusdictum Benito. |
||||
* |
||||
* Board specific Buttons driver header for the Tempusdictum Benito (http://dorkbotpdx.org/wiki/benito).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_BENITO_H__ |
||||
#define __BUTTONS_BENITO_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,139 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Tempusdictum Benito. |
||||
* \copydetails Group_LEDs_BENITO |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_BENITO BENITO |
||||
* \brief Board specific LED driver header for the Tempusdictum Benito. |
||||
* |
||||
* Board specific LED driver header for the Tempusdictum Benito (http://dorkbotpdx.org/wiki/benito).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>TX LED</td><td>Low</td><td>PORTC.7</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Red</td><td>RX LED</td><td>Low</td><td>PORTC.6</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_BENITO_H__ |
||||
#define __LEDS_BENITO_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 7) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 6) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRC |= LEDS_ALL_LEDS; |
||||
PORTC |= LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRC &= ~LEDS_ALL_LEDS; |
||||
PORTC &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC = ((PORTC | LEDS_ALL_LEDS) & ~LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTC = ((PORTC | LEDMask) & ~ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINC = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTC & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,161 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Bitwizard Big-Multio. |
||||
* \copydetails Group_LEDs_BIGMULTIO |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_BIGMULTIO BIGMULTIO |
||||
* \brief Board specific LED driver header for the Bitwizard Big-Multio. |
||||
* |
||||
* Board specific LED driver header for the Bitwizard Big-Multio (http://www.bitwizard.nl/wiki/index.php/Usbbigmultio).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Unknown</td><td>LED0</td><td>High</td><td>PORTF.6</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Unknown</td><td>LED1</td><td>High</td><td>PORTF.7</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Unknown</td><td>LED2</td><td>High</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_BIGMULTIO_H__ |
||||
#define __LEDS_BIGMULTIO_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define LEDS_PORTF_LEDS (LEDS_LED1 | LEDS_LED2) |
||||
#define LEDS_PORTE_LEDS LEDS_LED3 |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 6) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 7) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED3 (1 << 2) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRF |= LEDS_PORTF_LEDS; |
||||
DDRE |= LEDS_PORTE_LEDS; |
||||
|
||||
PORTF &= ~LEDS_PORTF_LEDS; |
||||
PORTE &= ~LEDS_PORTE_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRF &= ~LEDS_PORTF_LEDS; |
||||
DDRE &= ~LEDS_PORTE_LEDS; |
||||
|
||||
PORTF &= ~LEDS_PORTF_LEDS; |
||||
PORTE &= ~LEDS_PORTE_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTF |= (LEDMask & LEDS_PORTF_LEDS); |
||||
PORTE |= (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTF &= ~(LEDMask & LEDS_PORTF_LEDS); |
||||
PORTE &= ~(LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTF = (PORTF & ~LEDS_PORTF_LEDS) | (LEDMask & LEDS_PORTF_LEDS); |
||||
PORTE = (PORTE & ~LEDS_PORTE_LEDS) | (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTF = (PORTF & ~(LEDMask & LEDS_PORTF_LEDS)) | (ActiveMask & LEDS_PORTF_LEDS); |
||||
PORTE = (PORTE & ~(LEDMask & LEDS_PORTE_LEDS)) | (ActiveMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINF = (LEDMask & LEDS_PORTF_LEDS); |
||||
PINE = (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return ((PORTF & LEDS_PORTF_LEDS) | (PORTE & LEDS_PORTE_LEDS)); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,139 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the BLACKCAT USB JTAG. |
||||
* \copydetails Group_LEDs_BLACKCAT |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_BLACKCAT BLACKCAT |
||||
* \brief Board specific LED driver header for the BLACKCAT USB JTAG. |
||||
* |
||||
* Board specific LED driver header for the TCNISO Blackcat USB JTAG (http://www.embeddedcomputers.net/products/BlackcatUSB).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Unknown</td><td>LED0</td><td>High</td><td>PORTD.6</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Unknown</td><td>LED1</td><td>High</td><td>PORTD.3</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_BLACKCAT_H__ |
||||
#define __LEDS_BLACKCAT_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 6) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 3) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,143 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Busware BUI. |
||||
* \copydetails Group_LEDs_BUI |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_BUI BUI |
||||
* \brief Board specific LED driver header for the Busware BUI. |
||||
* |
||||
* Board specific LED driver header for the Busware BUI (http://www.busware.de/tiki-index.php?page=BUI).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Red</td><td>RGB LED</td><td>High</td><td>PORTC.2</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Green</td><td>RGB LED</td><td>High</td><td>PORTC.3</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Blue</td><td>RGB LED</td><td>High</td><td>PORTC.4</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_BUI_H__ |
||||
#define __LEDS_BUI_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 2) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 3) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 4) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRC |= LEDS_ALL_LEDS; |
||||
PORTC &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRC &= ~LEDS_ALL_LEDS; |
||||
PORTC &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC = (PORTC & ~LEDS_ALL_LEDS) | LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTC = (PORTC & ~LEDMask) | ActiveMask; |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINC = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTC & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,105 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB. |
||||
* \copydetails Group_Buttons_BUMBLEB |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_BUMBLEB BUMBLEB |
||||
* \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB. |
||||
* |
||||
* Board specific buttons driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
|
||||
* third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral |
||||
* layout for buttons, LEDs and a Joystick. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_BUMBLEB_H__ |
||||
#define __BUTTONS_BUMBLEB_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,123 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific joystick driver header for the Fletchtronics BUMBLEB. |
||||
* \copydetails Group_Joystick_BUMBLEB |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the joystick driver |
||||
* dispatch header located in LUFA/Drivers/Board/Joystick.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Joystick
|
||||
* \defgroup Group_Joystick_BUMBLEB BUMBLEB |
||||
* \brief Board specific joystick driver header for the Fletchtronics BUMBLEB. |
||||
* |
||||
* Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
|
||||
* third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral |
||||
* layout for buttons, LEDs and a Joystick. |
||||
* |
||||
* <table> |
||||
* <tr><th>Left Port Pin</th><th>Up Port Pin</th><th>Right Port Pin</th><th>Down Port Pin</th><th>Press Port Pin</th></tr> |
||||
* <tr><td>PORTD.2</td><td>PORTD.3</td><td>PORTD.0</td><td>PORTD.1</td><td>PORTD.4</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __JOYSTICK_BUMBLEB_H__ |
||||
#define __JOYSTICK_BUMBLEB_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_JOYSTICK_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define JOY_MASK ((1 << 0) | (1 << 1) | (1 << 2) | (1 << 3) | (1 << 4)) |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Mask for the joystick being pushed in the left direction. */ |
||||
#define JOY_LEFT (1 << 2) |
||||
|
||||
/** Mask for the joystick being pushed in the upward direction. */ |
||||
#define JOY_UP (1 << 3) |
||||
|
||||
/** Mask for the joystick being pushed in the right direction. */ |
||||
#define JOY_RIGHT (1 << 0) |
||||
|
||||
/** Mask for the joystick being pushed in the downward direction. */ |
||||
#define JOY_DOWN (1 << 1) |
||||
|
||||
/** Mask for the joystick being pushed inward. */ |
||||
#define JOY_PRESS (1 << 4) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Joystick_Init(void) |
||||
{ |
||||
DDRD &= ~JOY_MASK; |
||||
PORTD |= JOY_MASK; |
||||
} |
||||
|
||||
static inline void Joystick_Disable(void) |
||||
{ |
||||
DDRD &= ~JOY_MASK; |
||||
PORTD &= ~JOY_MASK; |
||||
} |
||||
|
||||
static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Joystick_GetStatus(void) |
||||
{ |
||||
return (uint8_t)(~PIND & JOY_MASK); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,149 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Fletchtronics BUMBLEB. |
||||
* \copydetails Group_LEDs_BUMBLEB |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_BUMBLEB BUMBLEB |
||||
* \brief Board specific LED driver header for the Fletchtronics BUMBLEB. |
||||
* |
||||
* Board specific LED driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
|
||||
* third-party board does not include any on-board peripherals, but does have an officially recommended external |
||||
* peripheral layout for buttons, LEDs and a Joystick. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.4</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.5</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.6</td></tr> |
||||
* <tr><td>LEDS_LED4</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_BUMBLEB_H__ |
||||
#define __LEDS_BUMBLEB_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 4) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 5) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 6) |
||||
|
||||
/** LED mask for the fourth LED on the board. */ |
||||
#define LEDS_LED4 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRB |= LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRB &= ~LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LedMask) |
||||
{ |
||||
PORTB |= LedMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LedMask) |
||||
{ |
||||
PORTB &= ~LedMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LedMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDS_ALL_LEDS) | LedMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LedMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LedMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINB = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTB & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Busware CULV3. |
||||
* \copydetails Group_LEDs_CULV3 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_CULV3 CULV3 |
||||
* \brief Board specific Buttons driver header for the Busware CULV3. |
||||
* |
||||
* Board specific Buttons driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_CULV3_H__ |
||||
#define __BUTTONS_CULV3_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 2) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,135 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Busware CUL V3. |
||||
* \copydetails Group_LEDs_CULV3 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_CULV3 CULV3 |
||||
* \brief Board specific LED driver header for the Busware CUL V3. |
||||
* |
||||
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Yellow</td><td>General Indicator</td><td>High</td><td>PORTE.6</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_CULV3_H__ |
||||
#define __LEDS_CULV3_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 6) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for the none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRE |= LEDS_ALL_LEDS; |
||||
PORTE &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRE &= ~LEDS_ALL_LEDS; |
||||
PORTE &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTE |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTE &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTE = ((PORTE & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTE = ((PORTE & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINE = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTE & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,147 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the DorkbotPDX Duce. |
||||
* \copydetails Group_LEDs_DUCE |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_DUCE DUCE |
||||
* \brief Board specific LED driver header for the DorkbotPDX Duce. |
||||
* |
||||
* Board specific LED driver header for the DorkbotPDX Duce (http://dorkbotpdx.org/wiki/duce).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Red</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTC.4</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Green</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTC.5</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Red</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTC.6</td></tr> |
||||
* <tr><td>LEDS_LED4</td><td>Green</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTC.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_DUCE_H__ |
||||
#define __LEDS_DUCE_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 4) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 5) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 6) |
||||
|
||||
/** LED mask for the fourth LED on the board. */ |
||||
#define LEDS_LED4 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRC |= LEDS_ALL_LEDS; |
||||
PORTC &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRC &= ~LEDS_ALL_LEDS; |
||||
PORTC &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTC = ((PORTC & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTC = ((PORTC & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINC = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTC & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Atmel EVK527. |
||||
* \copydetails Group_Buttons_EVK527 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_EVK527 EVK527 |
||||
* \brief Board specific Buttons driver header for the Atmel EVK527. |
||||
* |
||||
* Board specific Buttons driver header for the Atmel EVK527. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_EVK527_H__ |
||||
#define __BUTTONS_EVK527_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 2) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,220 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Dataflash driver header for the Atmel EVK527. |
||||
* \copydetails Group_Dataflash_EVK527 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver |
||||
* dispatch header located in LUFA/Drivers/Board/Dataflash.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Dataflash
|
||||
* \defgroup Group_Dataflash_EVK527 EVK527 |
||||
* \brief Board specific Dataflash driver header for the Atmel EVK527. |
||||
* |
||||
* Board specific Dataflash driver header for the Atmel EVK527. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Select Pin</th><th>SPI Port</th></tr> |
||||
* <tr><td>DATAFLASH_CHIP1</td><td>AT45DB321C (4MB)</td><td>PORTE.6</td><td>SPI0</td></tr> |
||||
* </table>
|
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __DATAFLASH_EVK527_H__ |
||||
#define __DATAFLASH_EVK527_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
#include "../../../Misc/AT45DB321C.h" |
||||
#include "../../../Peripheral/SPI.h" |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_DATAFLASH_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define DATAFLASH_CHIPCS_MASK (1 << 6) |
||||
#define DATAFLASH_CHIPCS_DDR DDRE |
||||
#define DATAFLASH_CHIPCS_PORT PORTE |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Constant indicating the total number of dataflash ICs mounted on the selected board. */ |
||||
#define DATAFLASH_TOTALCHIPS 1 |
||||
|
||||
/** Mask for no dataflash chip selected. */ |
||||
#define DATAFLASH_NO_CHIP DATAFLASH_CHIPCS_MASK |
||||
|
||||
/** Mask for the first dataflash chip selected. */ |
||||
#define DATAFLASH_CHIP1 0 |
||||
|
||||
/** Internal main memory page size for the board's dataflash IC. */ |
||||
#define DATAFLASH_PAGE_SIZE 512 |
||||
|
||||
/** Total number of pages inside the board's dataflash IC. */ |
||||
#define DATAFLASH_PAGES 8192 |
||||
|
||||
/* Inline Functions: */ |
||||
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
|
||||
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. |
||||
*/ |
||||
static inline void Dataflash_Init(void) |
||||
{ |
||||
DATAFLASH_CHIPCS_DDR |= DATAFLASH_CHIPCS_MASK; |
||||
DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK; |
||||
} |
||||
|
||||
/** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
|
||||
* |
||||
* \param[in] Byte Byte of data to send to the dataflash |
||||
* |
||||
* \return Last response byte from the dataflash |
||||
*/ |
||||
static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; |
||||
static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) |
||||
{ |
||||
return SPI_TransferByte(Byte); |
||||
} |
||||
|
||||
/** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
|
||||
* |
||||
* \param[in] Byte Byte of data to send to the dataflash |
||||
*/ |
||||
static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; |
||||
static inline void Dataflash_SendByte(const uint8_t Byte) |
||||
{ |
||||
SPI_SendByte(Byte); |
||||
} |
||||
|
||||
/** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
|
||||
* |
||||
* \return Last response byte from the dataflash |
||||
*/ |
||||
static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Dataflash_ReceiveByte(void) |
||||
{ |
||||
return SPI_ReceiveByte(); |
||||
} |
||||
|
||||
/** Determines the currently selected dataflash chip.
|
||||
* |
||||
* \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected |
||||
* or a DATAFLASH_CHIPn mask (where n is the chip number). |
||||
*/ |
||||
static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Dataflash_GetSelectedChip(void) |
||||
{ |
||||
return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK); |
||||
} |
||||
|
||||
/** Selects the given dataflash chip.
|
||||
* |
||||
* \param[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is |
||||
* the chip number). |
||||
*/ |
||||
static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE; |
||||
static inline void Dataflash_SelectChip(const uint8_t ChipMask) |
||||
{ |
||||
DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask); |
||||
} |
||||
|
||||
/** Deselects the current dataflash chip, so that no dataflash is selected. */ |
||||
static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE; |
||||
static inline void Dataflash_DeselectChip(void) |
||||
{ |
||||
Dataflash_SelectChip(DATAFLASH_NO_CHIP); |
||||
} |
||||
|
||||
/** Selects a dataflash IC from the given page number, which should range from 0 to
|
||||
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one |
||||
* dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside |
||||
* the total number of pages contained in the boards dataflash ICs, all dataflash ICs |
||||
* are deselected. |
||||
* |
||||
* \param[in] PageAddress Address of the page to manipulate, ranging from |
||||
* 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). |
||||
*/ |
||||
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) |
||||
{ |
||||
Dataflash_DeselectChip(); |
||||
|
||||
if (PageAddress >= DATAFLASH_PAGES) |
||||
return; |
||||
|
||||
Dataflash_SelectChip(DATAFLASH_CHIP1); |
||||
} |
||||
|
||||
/** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
|
||||
* a new command. |
||||
*/ |
||||
static inline void Dataflash_ToggleSelectedChipCS(void) |
||||
{ |
||||
uint8_t SelectedChipMask = Dataflash_GetSelectedChip(); |
||||
|
||||
Dataflash_DeselectChip(); |
||||
Dataflash_SelectChip(SelectedChipMask); |
||||
} |
||||
|
||||
/** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
|
||||
* memory page program or main memory to buffer transfer. |
||||
*/ |
||||
static inline void Dataflash_WaitWhileBusy(void) |
||||
{ |
||||
Dataflash_ToggleSelectedChipCS(); |
||||
Dataflash_SendByte(DF_CMD_GETSTATUS); |
||||
while (!(Dataflash_ReceiveByte() & DF_STATUS_READY)); |
||||
Dataflash_ToggleSelectedChipCS(); |
||||
} |
||||
|
||||
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
|
||||
* dataflash commands which require a complete 24-bit address. |
||||
* |
||||
* \param[in] PageAddress Page address within the selected dataflash IC |
||||
* \param[in] BufferByte Address within the dataflash's buffer |
||||
*/ |
||||
static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, |
||||
const uint16_t BufferByte) |
||||
{ |
||||
Dataflash_SendByte(PageAddress >> 5); |
||||
Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8)); |
||||
Dataflash_SendByte(BufferByte); |
||||
} |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,130 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific joystick driver header for the Atmel EVK527. |
||||
* \copydetails Group_Joystick_EVK527 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the joystick driver |
||||
* dispatch header located in LUFA/Drivers/Board/Joystick.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Joystick
|
||||
* \defgroup Group_Joystick_EVK527 EVK527 |
||||
* \brief Board specific joystick driver header for the Atmel EVK527. |
||||
* |
||||
* Board specific joystick driver header for the Atmel EVK527. |
||||
* |
||||
* <table> |
||||
* <tr><th>Left Port Pin</th><th>Up Port Pin</th><th>Right Port Pin</th><th>Down Port Pin</th><th>Press Port Pin</th></tr> |
||||
* <tr><td>PORTF.4</td><td>PORTF.5</td><td>PORTF.7</td><td>PORTC.6</td><td>PORTF.6</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __JOYSTICK_EVK527_H__ |
||||
#define __JOYSTICK_EVK527_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_JOYSTICK_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define JOY_FMASK ((1 << 4) | (1 << 5) | (1 << 6) | (1 << 7)) |
||||
#define JOY_CMASK (1 << 6) |
||||
|
||||
#define JOY_PORTC_MASK_SHIFT 3 |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Mask for the joystick being pushed in the left direction. */ |
||||
#define JOY_LEFT (1 << 4) |
||||
|
||||
/** Mask for the joystick being pushed in the right direction. */ |
||||
#define JOY_RIGHT (1 << 7) |
||||
|
||||
/** Mask for the joystick being pushed in the upward direction. */ |
||||
#define JOY_UP (1 << 5) |
||||
|
||||
/** Mask for the joystick being pushed in the downward direction. */ |
||||
#define JOY_DOWN ((1 << 6) >> JOY_PORTC_MASK_SHIFT) |
||||
|
||||
/** Mask for the joystick being pushed inward. */ |
||||
#define JOY_PRESS (1 << 6) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Joystick_Init(void) |
||||
{ |
||||
DDRF &= ~JOY_FMASK; |
||||
DDRC &= ~JOY_CMASK; |
||||
|
||||
PORTF |= JOY_FMASK; |
||||
PORTC |= JOY_CMASK; |
||||
} |
||||
|
||||
static inline void Joystick_Disable(void) |
||||
{ |
||||
DDRF &= ~JOY_FMASK; |
||||
DDRC &= ~JOY_CMASK; |
||||
|
||||
PORTF &= ~JOY_FMASK; |
||||
PORTC &= ~JOY_CMASK; |
||||
} |
||||
|
||||
static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Joystick_GetStatus(void) |
||||
{ |
||||
return (((uint8_t)~PINF & JOY_FMASK) | (((uint8_t)~PINC & JOY_CMASK) >> JOY_PORTC_MASK_SHIFT)); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,143 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Atmel EVK527. |
||||
* \copydetails Group_LEDs_EVK527 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_EVK527 EVK527 |
||||
* \brief Board specific LED driver header for the Atmel EVK527. |
||||
* |
||||
* Board specific LED driver header for the Atmel EVK527. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.5</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_EVK527_H__ |
||||
#define __LEDS_EVK527_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 5) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 6) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Mattairtech JM-DB-U2. |
||||
* \copydetails Group_Buttons_JMDBU2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_JMDBU2 JMDBU2 |
||||
* \brief Board specific Buttons driver header for the Mattairtech JM-DB-U2. |
||||
* |
||||
* Board specific Buttons driver header for the Mattairtech JM-DB-U2 (http://u2.mattair.net/index.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_JMDBU2_H__ |
||||
#define __BUTTONS_JMDBU2_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,135 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Mattairtech JM-DB-U2. |
||||
* \copydetails Group_LEDs_JMDBU2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_JMDBU2 JMDBU2 |
||||
* \brief Board specific LED driver header for the Mattairtech JM-DB-U2. |
||||
* |
||||
* Board specific LED driver header for the Mattairtech JM-DB-U2 (http://u2.mattair.net/index.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.4</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_JMDBU2_H__ |
||||
#define __LEDS_JMDBU2_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 4) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,139 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Maximus. |
||||
* \copydetails Group_LEDs_MAXIMUS |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MAXIMUS MAXIMUS |
||||
* \brief Board specific LED driver header for the Maximus. |
||||
* |
||||
* Board specific LED driver header for the Maximus (http://www.avrusb.com/).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>LG</td><td>High</td><td>PORTB.6</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Red</td><td>LR</td><td>High</td><td>PORTB.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_MAXIMUS_H__ |
||||
#define __LEDS_MAXIMUS_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 6) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2) |
||||
|
||||
/** LED mask for the none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRB |= LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRB &= ~LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINB = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTB & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,208 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Micropendous series boards. |
||||
* \copydetails Group_Buttons_MICROPENDOUS_32U2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_A MICROPENDOUS_A |
||||
* \brief Board specific Button driver header for the Micropendous A (https://code.google.com/p/micropendous/wiki/MicropendousA).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_1 MICROPENDOUS_1 |
||||
* \brief Board specific Button driver header for the Micropendous 1 (https://code.google.com/p/micropendous/wiki/Micropendous1).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_2 MICROPENDOUS_2 |
||||
* \brief Board specific Button driver header for the Micropendous 2 (https://code.google.com/p/micropendous/wiki/Micropendous2).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_3 MICROPENDOUS_3 |
||||
* \brief Board specific Button driver header for the Micropendous 3 (https://code.google.com/p/micropendous/wiki/Micropendous3).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_4 MICROPENDOUS_4 |
||||
* \brief Board specific Button driver header for the Micropendous 4 (https://code.google.com/p/micropendous/wiki/Micropendous4).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_DIP MICROPENDOUS_DIP |
||||
* \brief Board specific Button driver header for the Micropendous DIP (https://code.google.com/p/micropendous/wiki/MicropendousDIP).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_REV1 MICROPENDOUS_REV1 |
||||
* \brief Board specific Button driver header for the Micropendous Arduino-like Revision 1 (https://code.google.com/p/micropendous/wiki/Micropendous).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_REV2 MICROPENDOUS_REV2 |
||||
* \brief Board specific Button driver header for the Micropendous Arduino-like Revision 2 (https://code.google.com/p/micropendous/wiki/Micropendous).
|
||||
* |
||||
* See \ref Group_Buttons_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROPENDOUS_32U2 MICROPENDOUS_32U2 |
||||
* \brief Board specific Buttons driver header for the Micropendous 32U2. |
||||
* |
||||
* \note There are multiple supported Micropendous boards, compile with <code>BOARD = MICROPENDOUS_{VERSION}</code>. |
||||
* |
||||
* Board specific Buttons driver header for the Micropendous 32U2 (https://code.google.com/p/micropendous/wiki/Micropendous_32U2).
|
||||
* |
||||
* <b>BOARD_MICROPENDOUS_1 and BOARD_MICROPENDOUS_32U2</b>: |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* <b>Other Revisions</b>: |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_MICROPENDOUS_H__ |
||||
#define __BUTTONS_MICROPENDOUS_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
#if (BOARD == BOARD_MICROPENDOUS_32U2) |
||||
#define _BOARD_BUTTON1_MASK (1 << 7) |
||||
#define _BOARD_BUTTON_PORTLETTER D |
||||
#elif (BOARD == BOARD_MICROPENDOUS_A) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#elif (BOARD == BOARD_MICROPENDOUS_1) |
||||
#define _BOARD_BUTTON1_MASK (1 << 7) |
||||
#define _BOARD_BUTTON_PORTLETTER D |
||||
#elif (BOARD == BOARD_MICROPENDOUS_2) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#elif (BOARD == BOARD_MICROPENDOUS_3) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#elif (BOARD == BOARD_MICROPENDOUS_4) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#elif (BOARD == BOARD_MICROPENDOUS_DIP) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#elif (BOARD == BOARD_MICROPENDOUS_REV1) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#elif (BOARD == BOARD_MICROPENDOUS_REV2) |
||||
#define _BOARD_BUTTON1_MASK (1 << 2) |
||||
#define _BOARD_BUTTON_PORTLETTER E |
||||
#endif |
||||
|
||||
#define _BOARD_BUTTON_CONCAT2(Reg, Letter) Reg ## Letter |
||||
#define _BOARD_BUTTON_CONCAT(Reg, Letter) _BOARD_BUTTON_CONCAT2(Reg, Letter) |
||||
|
||||
#define _BOARD_BUTTON_PORT _BOARD_BUTTON_CONCAT(PORT, _BOARD_BUTTON_PORTLETTER) |
||||
#define _BOARD_BUTTON_PIN _BOARD_BUTTON_CONCAT(PIN, _BOARD_BUTTON_PORTLETTER) |
||||
#define _BOARD_BUTTON_DDR _BOARD_BUTTON_CONCAT(DDR, _BOARD_BUTTON_PORTLETTER) |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 _BOARD_BUTTON1_MASK |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
_BOARD_BUTTON_DDR &= ~BUTTONS_BUTTON1; |
||||
_BOARD_BUTTON_PORT |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
_BOARD_BUTTON_DDR &= ~BUTTONS_BUTTON1; |
||||
_BOARD_BUTTON_PORT &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((_BOARD_BUTTON_PIN & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
|
||||
@ -0,0 +1,177 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Micropendous-32U2. |
||||
* \copydetails Group_LEDs_MICROPENDOUS_32U2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MICROPENDOUS_REV1 MICROPENDOUS_REV1 |
||||
* \brief Board specific LED driver header for the Micropendous Arduino-like Revision 1 (https://code.google.com/p/micropendous/wiki/Micropendous).
|
||||
* |
||||
* See \ref Group_LEDs_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MICROPENDOUS_REV2 MICROPENDOUS_REV2 |
||||
* \brief Board specific LED driver header for the Micropendous Arduino-like Revision 2 (https://code.google.com/p/micropendous/wiki/Micropendous).
|
||||
* |
||||
* See \ref Group_LEDs_MICROPENDOUS_32U2 for more details. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MICROPENDOUS_32U2 MICROPENDOUS_32U2 |
||||
* \brief Board specific LED driver header for the Micropendous-32U2. |
||||
* |
||||
* Board specific LED driver header for the Micropendous 32U2 (https://code.google.com/p/micropendous/wiki/Micropendous_32U2).
|
||||
* |
||||
* <b>BOARD_MICROPENDOUS_32U2</b>: |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr> |
||||
* </table> |
||||
* |
||||
* <b>Other Revisions</b>: |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTB.1</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_MICROPENDOUS_H__ |
||||
#define __LEDS_MICROPENDOUS_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
#if (BOARD == BOARD_MICROPENDOUS_32U2) |
||||
#define _BOARD_LED1_MASK (1 << 6) |
||||
#define _BOARD_LED_PORTLETTER D |
||||
#elif (BOARD == BOARD_MICROPENDOUS_REV1) |
||||
#define _BOARD_LED1_MASK (1 << 1) |
||||
#define _BOARD_LED_PORTLETTER B |
||||
#elif (BOARD == BOARD_MICROPENDOUS_REV2) |
||||
#define _BOARD_LED1_MASK (1 << 1) |
||||
#define _BOARD_LED_PORTLETTER B |
||||
#endif |
||||
|
||||
#define _BOARD_LED_CONCAT2(Reg, Letter) Reg ## Letter |
||||
#define _BOARD_LED_CONCAT(Reg, Letter) _BOARD_LED_CONCAT2(Reg, Letter) |
||||
|
||||
#define _BOARD_LED_PORT _BOARD_LED_CONCAT(PORT, _BOARD_LED_PORTLETTER) |
||||
#define _BOARD_LED_PIN _BOARD_LED_CONCAT(PIN, _BOARD_LED_PORTLETTER) |
||||
#define _BOARD_LED_DDR _BOARD_LED_CONCAT(DDR, _BOARD_LED_PORTLETTER) |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 _BOARD_LED1_MASK |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for the none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
_BOARD_LED_DDR |= LEDS_ALL_LEDS; |
||||
_BOARD_LED_PORT &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
_BOARD_LED_DDR &= ~LEDS_ALL_LEDS; |
||||
_BOARD_LED_PORT &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
_BOARD_LED_PORT |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
_BOARD_LED_PORT &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
_BOARD_LED_PORT = ((_BOARD_LED_PORT & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
_BOARD_LED_PORT = ((_BOARD_LED_PORT & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
_BOARD_LED_PIN = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (_BOARD_LED_PORT & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Microsin AVR-USB162 board. |
||||
* \copydetails Group_Buttons_MICROSIN162 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MICROSIN162 MICROSIN162 |
||||
* \brief Board specific Buttons driver header for the Microsin AVR-USB162 board. |
||||
* |
||||
* Board specific Buttons driver header for the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_MICROSIN162_H__ |
||||
#define __BUTTONS_MICROSIN162_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,135 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Microsin AVR-USB162 board. |
||||
* \copydetails Group_LEDs_MICROSIN162 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MICROSIN162 MICROSIN162 |
||||
* \brief Board specific LED driver header for the Microsin AVR-USB162 board. |
||||
* |
||||
* Board specific LED driver header for the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTD.4</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_MICROSIN162_H__ |
||||
#define __LEDS_MICROSIN162_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 4) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD |= LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD | LEDMask) & ~ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (~PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the MINIMUS. |
||||
* \copydetails Group_Buttons_MINIMUS |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_MINIMUS MINIMUS |
||||
* \brief Board specific Buttons driver header for the MINIMUS. |
||||
* |
||||
* Board specific Buttons driver header for the MINIMUS. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_MINIMUS_H__ |
||||
#define __BUTTONS_MINIMUS_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,143 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the MINIMUS. |
||||
* \copydetails Group_LEDs_MINIMUS |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MINIMUS MINIMUS |
||||
* \brief Board specific LED driver header for the MINIMUS. |
||||
* |
||||
* Board specific LED driver header for the Minimus USB (http://www.minimususb.com/).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Red</td><td>General Indicator</td><td>Low</td><td>PORTD.5</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTD.6</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Blue</td><td>General Indicator</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_MINIMUS_H__ |
||||
#define __LEDS_MINIMUS_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 5) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 6) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for the none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD |= LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,161 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Bitwizard Multio. |
||||
* \copydetails Group_LEDs_MULTIO |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_MULTIO MULTIO |
||||
* \brief Board specific LED driver header for the Bitwizard Multio. |
||||
* |
||||
* Board specific LED driver header for the Bitwizard Multio (http://www.bitwizard.nl/wiki/index.php/USB-multio).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.0</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTC.2</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_MULTIO_H__ |
||||
#define __LEDS_MULTIO_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define LEDS_PORTD_LEDS (LEDS_LED1 | LEDS_LED3) |
||||
#define LEDS_PORTC_LEDS LEDS_LED2 |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 0) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 2) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED3 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_PORTD_LEDS; |
||||
DDRC |= LEDS_PORTC_LEDS; |
||||
|
||||
PORTD &= ~LEDS_PORTD_LEDS; |
||||
PORTC &= ~LEDS_PORTC_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_PORTD_LEDS; |
||||
DDRC &= ~LEDS_PORTC_LEDS; |
||||
|
||||
PORTD &= ~LEDS_PORTD_LEDS; |
||||
PORTC &= ~LEDS_PORTC_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= (LEDMask & LEDS_PORTD_LEDS); |
||||
PORTC |= (LEDMask & LEDS_PORTC_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~(LEDMask & LEDS_PORTD_LEDS); |
||||
PORTC &= ~(LEDMask & LEDS_PORTC_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = (PORTD & ~LEDS_PORTD_LEDS) | (LEDMask & LEDS_PORTD_LEDS); |
||||
PORTC = (PORTC & ~LEDS_PORTC_LEDS) | (LEDMask & LEDS_PORTC_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = (PORTD & ~(LEDMask & LEDS_PORTD_LEDS)) | (ActiveMask & LEDS_PORTD_LEDS); |
||||
PORTC = (PORTC & ~(LEDMask & LEDS_PORTC_LEDS)) | (ActiveMask & LEDS_PORTC_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = (LEDMask & LEDS_PORTD_LEDS); |
||||
PINC = (LEDMask & LEDS_PORTC_LEDS); |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return ((PORTD & LEDS_PORTD_LEDS) | (PORTC & LEDS_PORTC_LEDS)); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board. |
||||
* \copydetails Group_Buttons_OLIMEX162 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_OLIMEX162 OLIMEX162 |
||||
* \brief Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board. |
||||
* |
||||
* Board specific Buttons driver header for the Olimex AVR-USB-162 Development Board (http://www.olimex.com/dev/avr-usb-162.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_OLIMEX162_H__ |
||||
#define __BUTTONS_OLIMEX162_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,135 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Olimex AVR-USB-162. |
||||
* \copydetails Group_LEDs_OLIMEX162 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_OLIMEX162 OLIMEX162 |
||||
* \brief Board specific LED driver header for the Olimex AVR-USB-162. |
||||
* |
||||
* Board specific LED driver header for the Olimex AVR-USB-162 (http://www.olimex.com/dev/avr-usb-162.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Yellow</td><td>General Indicator</td><td>High</td><td>PORTD.4</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_OLIMEX162_H__ |
||||
#define __LEDS_OLIMEX162_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 4) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_ALL_LEDS; |
||||
PORTD &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = ((PORTD & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTD & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Olimex AVR-USB-32U4 Development Board. |
||||
* \copydetails Group_Buttons_OLIMEX32U4 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_OLIMEX32U4 OLIMEX32U4 |
||||
* \brief Board specific Buttons driver header for the Olimex AVR-USB-32U4 Development Board. |
||||
* |
||||
* Board specific Buttons driver header for the Olimex AVR-USB-32U4 Development Board (http://www.olimex.com/dev/olimexino-32u4.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_OLIMEX32U4_H__ |
||||
#define __BUTTONS_OLIMEX32U4_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 2) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,179 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Olimex AVR-USB-32U4. |
||||
* \copydetails Group_LEDs_OLIMEX32U4 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_OLIMEX32U4 OLIMEX32U4 |
||||
* \brief Board specific LED driver header for the Olimex AVR-USB-32U4. |
||||
* |
||||
* Board specific LED driver header for the Olimex AVR-USB-32U4 (http://www.olimex.com/dev/olimexino-32u4.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>TX</td><td>High</td><td>PORTD.5</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Yellow</td><td>RX</td><td>High</td><td>PORTB.0</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Green</td><td>General Indicator (Default Unconnected)</td><td>High</td><td>PORTE.6</td></tr> |
||||
* <tr><td>LEDS_LED4</td><td>Yellow</td><td>General Indicator (Default Unconnected)</td><td>High</td><td>PORTB.5</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_OLIMEX32U4_H__ |
||||
#define __LEDS_OLIMEX32U4_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define LEDS_PORTB_LEDS (LEDS_LED2 | LEDS_LED4) |
||||
#define LEDS_PORTD_LEDS (LEDS_LED1) |
||||
#define LEDS_PORTE_LEDS (LEDS_LED3) |
||||
|
||||
#define LEDS_PORTD_MASK_SHIFT 1 |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 ((1 << 5) >> LEDS_PORTD_MASK_SHIFT) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 0) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 5) |
||||
|
||||
/** LED mask for the fourth LED on the board. */ |
||||
#define LEDS_LED4 (1 << 6) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRB |= LEDS_PORTB_LEDS; |
||||
PORTB &= ~LEDS_PORTB_LEDS; |
||||
DDRD |= (LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT); |
||||
PORTD &= ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT); |
||||
DDRE |= LEDS_PORTE_LEDS; |
||||
PORTE &= ~LEDS_PORTE_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRB &= ~LEDS_PORTB_LEDS; |
||||
PORTB &= ~LEDS_PORTB_LEDS; |
||||
DDRD &= ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT); |
||||
PORTD &= ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT); |
||||
DDRE &= ~LEDS_PORTE_LEDS; |
||||
PORTE &= ~LEDS_PORTE_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB |= (LEDMask & LEDS_PORTB_LEDS); |
||||
PORTD |= ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT); |
||||
PORTE |= (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB &= ~(LEDMask & LEDS_PORTB_LEDS); |
||||
PORTD &= ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT); |
||||
PORTE &= ~(LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDS_PORTB_LEDS) | (LEDMask & LEDS_PORTB_LEDS)); |
||||
PORTD = ((PORTD & ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT)) | |
||||
((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT)); |
||||
PORTE = ((PORTE & ~LEDS_PORTE_LEDS) | (LEDMask & LEDS_PORTE_LEDS)); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTB = ((PORTB & ~(LEDMask & LEDS_PORTB_LEDS)) | (ActiveMask & LEDS_PORTB_LEDS)); |
||||
PORTD = ((PORTD & ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT)) | |
||||
((ActiveMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT)); |
||||
PORTE = ((PORTE & ~(LEDMask & LEDS_PORTE_LEDS)) | (ActiveMask & LEDS_PORTE_LEDS)); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINB = (LEDMask & LEDS_PORTB_LEDS); |
||||
PIND = ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT); |
||||
PINE = (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return ((PORTB & LEDS_PORTB_LEDS) |
|
||||
((PORTD & (LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT)) >> LEDS_PORTD_MASK_SHIFT) | |
||||
(PORTE & LEDS_PORTE_LEDS)); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Olimex AVR-ISP-MK2 Development Board. |
||||
* \copydetails Group_Buttons_OLIMEXISPMK2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_OLIMEXISPMK2 OLIMEXISPMK2 |
||||
* \brief Board specific Buttons driver header for the Olimex AVR-ISP-MK2. |
||||
* |
||||
* Board specific Buttons driver header for the Olimex AVR-ISP-MK2 Development Board (https://www.olimex.com/dev/avr-isp-mk2.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_OLIMEXISPMK2_H__ |
||||
#define __BUTTONS_OLIMEXISPMK2_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 7) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRD &= ~BUTTONS_BUTTON1; |
||||
PORTD &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,143 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Olimex AVR-ISP-MK2 Development Board. |
||||
* \copydetails Group_LEDs_OLIMEXISPMK2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_OLIMEXISPMK2 OLIMEXISPMK2 |
||||
* \brief Board specific LED driver header for the Olimex AVR-ISP-MK2. |
||||
* |
||||
* Board specific LED driver header for the Olimex AVR-ISP-MK2 Development Board (https://www.olimex.com/dev/avr-isp-mk2.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Yellow</td><td>Target Power</td><td>High</td><td>PORTB.5</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Red</td><td>Activity</td><td>High</td><td>PORTB.6</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>Green</td><td>Ready</td><td>High</td><td>PORTB.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_OLIMEXISPMK2_H__ |
||||
#define __LEDS_OLIMEXISPMK2_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 5) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 6) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 7) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRB |= LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRB &= ~LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDS_ALL_LEDS) | LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDMask) | ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINB = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (PORTB & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Olimex AVR-USB-T32U4 Development Board. |
||||
* \copydetails Group_Buttons_OLIMEXT32U4 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_OLIMEXT32U4 OLIMEXT32U4 |
||||
* \brief Board specific Buttons driver header for the Olimex AVR-USB-32U4 Development Board. |
||||
* |
||||
* Board specific Buttons driver header for the Olimex AVR-USB-T32U4 Development Board (http://www.olimex.com/dev/avr-t32u4.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_OLIMEXT32U4_H__ |
||||
#define __BUTTONS_OLIMEXT32U4_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 2) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,169 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Olimex AVR-USB-T32U4. |
||||
* \copydetails Group_LEDs_OLIMEXT32U4 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_OLIMEXT32U4 OLIMEXT32U4 |
||||
* \brief Board specific LED driver header for the Olimex AVR-USB-T32U4. |
||||
* |
||||
* Board specific LED driver header for the Olimex AVR-USB-T32U4 (http://www.olimex.com/dev/avr-t32u4.html).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>TX</td><td>High</td><td>PORTD.5</td></tr> |
||||
* <tr><td>LEDS_LED2</td><td>Yellow</td><td>RX</td><td>High</td><td>PORTB.0</td></tr> |
||||
* <tr><td>LEDS_LED3</td><td>N/A</td><td>General Indicator (Not Mounted)</td><td>High</td><td>PORTE.6</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_OLIMEXT32U4_H__ |
||||
#define __LEDS_OLIMEXT32U4_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define LEDS_PORTB_LEDS (LEDS_LED2) |
||||
#define LEDS_PORTD_LEDS (LEDS_LED1) |
||||
#define LEDS_PORTE_LEDS (LEDS_LED3) |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 5) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 0) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 (1 << 6) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRB |= LEDS_PORTB_LEDS; |
||||
PORTB &= ~LEDS_PORTB_LEDS; |
||||
DDRD |= LEDS_PORTD_LEDS; |
||||
PORTD &= ~LEDS_PORTD_LEDS; |
||||
DDRE |= LEDS_PORTE_LEDS; |
||||
PORTE &= ~LEDS_PORTE_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRB &= ~LEDS_PORTB_LEDS; |
||||
PORTB &= ~LEDS_PORTB_LEDS; |
||||
DDRD &= ~LEDS_PORTD_LEDS; |
||||
PORTD &= ~LEDS_PORTD_LEDS; |
||||
DDRE &= ~LEDS_PORTE_LEDS; |
||||
PORTE &= ~LEDS_PORTE_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB |= (LEDMask & LEDS_PORTB_LEDS); |
||||
PORTD |= (LEDMask & LEDS_PORTD_LEDS); |
||||
PORTE |= (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB &= ~(LEDMask & LEDS_PORTB_LEDS); |
||||
PORTD &= ~(LEDMask & LEDS_PORTD_LEDS); |
||||
PORTE &= ~(LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB = ((PORTB & ~LEDS_PORTB_LEDS) | (LEDMask & LEDS_PORTB_LEDS)); |
||||
PORTD = ((PORTD & ~LEDS_PORTD_LEDS) | (LEDMask & LEDS_PORTD_LEDS)); |
||||
PORTE = ((PORTE & ~LEDS_PORTE_LEDS) | (LEDMask & LEDS_PORTE_LEDS)); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTB = ((PORTB & ~(LEDMask & LEDS_PORTB_LEDS)) | (ActiveMask & LEDS_PORTB_LEDS)); |
||||
PORTD = ((PORTD & ~(LEDMask & LEDS_PORTD_LEDS)) | (ActiveMask & LEDS_PORTD_LEDS)); |
||||
PORTE = ((PORTE & ~(LEDMask & LEDS_PORTE_LEDS)) | (ActiveMask & LEDS_PORTE_LEDS)); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINB = (LEDMask & LEDS_PORTB_LEDS); |
||||
PIND = (LEDMask & LEDS_PORTD_LEDS); |
||||
PINE = (LEDMask & LEDS_PORTE_LEDS); |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return ((PORTB & LEDS_PORTB_LEDS) | (PORTD & LEDS_PORTD_LEDS) | (PORTE & LEDS_PORTE_LEDS)); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,175 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Atmel RZUSBSTICK. |
||||
* \copydetails Group_LEDs_RZUSBSTICK |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_RZUSBSTICK RZUSBSTICK |
||||
* \brief Board specific LED driver header for the Atmel RZUSBSTICK. |
||||
* |
||||
* Board specific LED driver header for the Atmel RZUSBSTICK. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Blue</td><td>General Indicator</td><td>High</td><td>PORTD.7</td></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Red</td><td>General Indicator</td><td>Low</td><td>PORTD.5</td></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTE.6</td></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Yellow</td><td>General Indicator</td><td>Low</td><td>PORTE.7</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_RZUSBSTICK_H__ |
||||
#define __LEDS_RZUSBSTICK_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Private Interface - For use in library only: */ |
||||
#if !defined(__DOXYGEN__) |
||||
/* Macros: */ |
||||
#define LEDS_PORTD_LEDS (LEDS_LED1 | LEDS_LED2) |
||||
#define LEDS_PORTE_LEDS (LEDS_LED3 | LEDS_LED4) |
||||
|
||||
#define LEDS_PORTE_MASK_SHIFT 4 |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 7) |
||||
|
||||
/** LED mask for the second LED on the board. */ |
||||
#define LEDS_LED2 (1 << 5) |
||||
|
||||
/** LED mask for the third LED on the board. */ |
||||
#define LEDS_LED3 ((1 << 6) >> LEDS_PORTE_MASK_SHIFT) |
||||
|
||||
/** LED mask for the fourth LED on the board. */ |
||||
#define LEDS_LED4 ((1 << 7) >> LEDS_PORTE_MASK_SHIFT) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4) |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRD |= LEDS_PORTD_LEDS; |
||||
PORTD &= ~LEDS_LED1; |
||||
PORTD |= LEDS_LED2; |
||||
|
||||
DDRE |= (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT); |
||||
PORTE |= (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT); |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRD &= ~LEDS_PORTD_LEDS; |
||||
PORTD &= ~LEDS_PORTD_LEDS; |
||||
|
||||
DDRE &= ~(LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT); |
||||
PORTE &= ~(LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD |= (LEDMask & LEDS_LED1); |
||||
PORTD &= ~(LEDMask & LEDS_LED2); |
||||
PORTE &= ~((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT); |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD &= ~(LEDMask & LEDS_LED1); |
||||
PORTD |= (LEDMask & LEDS_LED2); |
||||
PORTE |= ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT); |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTD = (((PORTD & ~LEDS_LED1) | (LEDMask & LEDS_LED1)) | |
||||
((PORTD | LEDS_LED2) & ~(LEDMask & LEDS_LED2))); |
||||
PORTE = ((PORTE | (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)) & |
||||
~((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT)); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTD = (((PORTD & ~(LEDMask & LEDS_LED1)) | (ActiveMask & LEDS_LED1)) | |
||||
((PORTD | (LEDMask & LEDS_LED2)) & ~(ActiveMask & LEDS_LED2))); |
||||
PORTE = ((PORTE | ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT)) & |
||||
~((ActiveMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT)); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PIND = (LEDMask & LEDS_PORTD_LEDS); |
||||
PINE = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT); |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (((PORTD & LEDS_LED1) | (~PORTD & LEDS_LED2)) | |
||||
((~PORTE & (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)) >> LEDS_PORTE_MASK_SHIFT)); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,135 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board. |
||||
* \copydetails Group_LEDs_SPARKFUN8U2 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver |
||||
* dispatch header located in LUFA/Drivers/Board/LEDs.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_LEDs
|
||||
* \defgroup Group_LEDs_SPARKFUN8U2 SPARKFUN8U2 |
||||
* \brief Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board. |
||||
* |
||||
* Board specific LED driver header for the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277).
|
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTB.4</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __LEDS_SPARKFUN8U2_H__ |
||||
#define __LEDS_SPARKFUN8U2_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_LEDS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** LED mask for the first LED on the board. */ |
||||
#define LEDS_LED1 (1 << 4) |
||||
|
||||
/** LED mask for all the LEDs on the board. */ |
||||
#define LEDS_ALL_LEDS LEDS_LED1 |
||||
|
||||
/** LED mask for none of the board LEDs. */ |
||||
#define LEDS_NO_LEDS 0 |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void LEDs_Init(void) |
||||
{ |
||||
DDRB |= LEDS_ALL_LEDS; |
||||
PORTB |= LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_Disable(void) |
||||
{ |
||||
DDRB &= ~LEDS_ALL_LEDS; |
||||
PORTB &= ~LEDS_ALL_LEDS; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB &= ~LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB |= LEDMask; |
||||
} |
||||
|
||||
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PORTB = ((PORTB | LEDS_ALL_LEDS) & ~LEDMask); |
||||
} |
||||
|
||||
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, |
||||
const uint8_t ActiveMask) |
||||
{ |
||||
PORTB = ((PORTB | LEDMask) & ~ActiveMask); |
||||
} |
||||
|
||||
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) |
||||
{ |
||||
PINB = LEDMask; |
||||
} |
||||
|
||||
static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t LEDs_GetLEDs(void) |
||||
{ |
||||
return (~PORTB & LEDS_ALL_LEDS); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
@ -0,0 +1,103 @@ |
||||
/*
|
||||
LUFA Library |
||||
Copyright (C) Dean Camera, 2012. |
||||
|
||||
dean [at] fourwalledcubicle [dot] com |
||||
www.lufa-lib.org |
||||
*/ |
||||
|
||||
/*
|
||||
Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) |
||||
|
||||
Permission to use, copy, modify, distribute, and sell this |
||||
software and its documentation for any purpose is hereby granted |
||||
without fee, provided that the above copyright notice appear in |
||||
all copies and that both that the copyright notice and this |
||||
permission notice and warranty disclaimer appear in supporting |
||||
documentation, and that the name of the author not be used in |
||||
advertising or publicity pertaining to distribution of the |
||||
software without specific, written prior permission. |
||||
|
||||
The author disclaim all warranties with regard to this |
||||
software, including all implied warranties of merchantability |
||||
and fitness. In no event shall the author be liable for any |
||||
special, indirect or consequential damages or any damages |
||||
whatsoever resulting from loss of use, data or profits, whether |
||||
in an action of contract, negligence or other tortious action, |
||||
arising out of or in connection with the use or performance of |
||||
this software. |
||||
*/ |
||||
|
||||
/** \file
|
||||
* \brief Board specific Buttons driver header for the Atmel STK525. |
||||
* \copydetails Group_Buttons_STK525 |
||||
* |
||||
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver |
||||
* dispatch header located in LUFA/Drivers/Board/Buttons.h. |
||||
*/ |
||||
|
||||
/** \ingroup Group_Buttons
|
||||
* \defgroup Group_Buttons_STK525 STK525 |
||||
* \brief Board specific Buttons driver header for the Atmel STK525. |
||||
* |
||||
* Board specific Buttons driver header for the Atmel STK525. |
||||
* |
||||
* <table> |
||||
* <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr> |
||||
* <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr> |
||||
* </table> |
||||
* |
||||
* @{ |
||||
*/ |
||||
|
||||
#ifndef __BUTTONS_STK525_H__ |
||||
#define __BUTTONS_STK525_H__ |
||||
|
||||
/* Includes: */ |
||||
#include "../../../../Common/Common.h" |
||||
|
||||
/* Enable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Preprocessor Checks: */ |
||||
#if !defined(__INCLUDE_FROM_BUTTONS_H) |
||||
#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. |
||||
#endif |
||||
|
||||
/* Public Interface - May be used in end-application: */ |
||||
/* Macros: */ |
||||
/** Button mask for the first button on the board. */ |
||||
#define BUTTONS_BUTTON1 (1 << 2) |
||||
|
||||
/* Inline Functions: */ |
||||
#if !defined(__DOXYGEN__) |
||||
static inline void Buttons_Init(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE |= BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline void Buttons_Disable(void) |
||||
{ |
||||
DDRE &= ~BUTTONS_BUTTON1; |
||||
PORTE &= ~BUTTONS_BUTTON1; |
||||
} |
||||
|
||||
static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; |
||||
static inline uint8_t Buttons_GetStatus(void) |
||||
{ |
||||
return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); |
||||
} |
||||
#endif |
||||
|
||||
/* Disable C linkage for C++ Compilers: */ |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif |
||||
|
||||
/** @} */ |
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue