ceedling 0.11.2 → 0.12.0

data/README.md

@@ -60,7 +60,8 @@ Authors
 =======
 * Mike Karlesky (michael@karlesky.net)
 * Mark VanderVoord (mvandervoord@gmail.com)
-* Greg Williams (williams@atomicobject.com)
+* Greg Williams (williams@atomicembedded.com)
 * Matt Fletcher (fletcher@atomicobject.com)
-* © 2011 [Atomic Object](http://www.atomicobject.com/)
-* More Atomic Object [open source](http://www.atomicobject.com/pages/Software+Commons) projects
+* Nick Christensen (nick.christensen@atomicembedded)
+* 
+* © 2012 [ThrowTheSwitch](http://throwtheswitch.org/

data/bin/ceedling

@@ -46,7 +46,8 @@ class CeedlingTasks < Thor
   end
 
   desc "example PROJ_NAME [DEST]", "create specified example project (in DEST, if specified)"
-  def example(proj_name, dest="temp_sensor")
+  def example(proj_name, dest=nil)
+    dest = proj_name if !dest
     directory Ceedling::NEW_PROJECT_DIR, dest
     remove_file "#{dest}/project.yml"
     remove_file "#{dest}/rakefile.rb"

data/examples/blinky/project.yml

@@ -0,0 +1,98 @@
+---
+
+# Notes:
+# This is a fully tested project that demonstrates the use
+# of a timer ISR to blink the on board LED of an Arduino UNO
+:project:
+  :use_exceptions: FALSE
+  :use_test_preprocessor: TRUE
+  :use_auxiliary_dependencies: TRUE
+  :build_root: build
+  :release_build: TRUE
+  :test_file_prefix: test_
+
+#You'll have to specify these
+:environment:
+  - :mcu: atmega328p
+  - :f_cpu: 16000000UL 
+  - :serial_port: COM8  #change this to the serial port you are using!!!
+  - :objcopy: avr-objcopy
+  # Uncomment these lines if you are using windows and don't have these tools in your path
+  # - :path:
+    # - C:\mingw\bin
+    # - C:\WinAVR-20100110\bin
+    # - C:\WinAVR-20100110\utils\bin
+    # - #{ENV['PATH']}
+
+:extension:
+  :executable: .bin
+
+:release_build:
+  :output: blinky
+
+:paths:
+  :test:
+    - +:test/**
+    - -:test/support
+  :source:
+    - src/**
+  :support:
+    - test/support
+
+:defines:
+  # in order to add common defines:
+  #  1) remove the trailing [] from the :common: section
+  #  2) add entries to the :common: section (e.g. :test: has TEST defined)
+  :commmon: &common_defines []
+  :test:
+    - *common_defines
+    - TEST
+  :test_preprocess:
+    - *common_defines
+    - TEST
+
+:tools:
+  :release_compiler:
+    :executable: avr-gcc
+    :arguments:
+      - ${1}
+      - -DTARGET
+      - -DF_CPU=#{ENV['F_CPU']}
+      - -mmcu=#{ENV['MCU']}
+      - -Iinclude/
+      - -Wall
+      - -Os
+      - -c
+      - -o ${2}
+  :release_linker:
+    :executable: avr-gcc
+    :arguments:
+      - -mmcu=#{ENV['MCU']}
+      - ${1}
+      - -o ${2}.bin
+
+:cmock:
+  :mock_prefix: mock_
+  :when_no_prototypes: :warn
+  :enforce_strict_ordering: TRUE
+  :plugins:
+    - :ignore
+  :treat_as:
+    uint8:    HEX8
+    uint16:   HEX16
+    uint32:   UINT32
+    int8:     INT8
+    bool:     UINT8
+
+#:tools:
+# Ceedling defaults to using gcc for compiling, linking, etc.
+# As [:tools] is blank, gcc will be used (so long as it's in your system path)
+# See documentation to configure a given toolchain for use
+
+:plugins:
+  :load_paths:
+    - vendor/ceedling/plugins
+  :enabled:
+    - stdout_pretty_tests_report
+    - module_generator
+...

data/examples/blinky/rakefile.rb

@@ -0,0 +1,23 @@
+PROJECT_CEEDLING_ROOT = "vendor/ceedling"
+load "#{PROJECT_CEEDLING_ROOT}/lib/rakefile.rb"
+
+task :default => %w[ test:all release ]
+
+# Dummy task to ensure that the SERIAL_PORT environment variable is set.
+# It can be set on the command line as follows:
+#   $ rake SERIAL_PORT=[serial port name]
+task :serial_port do
+  unless ENV['SERIAL_PORT']
+    raise "SERIAL_PORT is not defined in the environment!"
+  end
+end
+
+desc "Convert the output binary to a hex file for programming to the Arduino"
+task :convert => :release do
+  sh "#{ENV['objcopy']} -O ihex -R .eeprom build\\release\\#{RELEASE_BUILD_OUTPUT}.bin build\\release\\#{RELEASE_BUILD_OUTPUT}.hex"
+end
+
+desc "Program the Arduino over the serial port."
+task :program => [:convert, :serial_port] do
+  sh "avrdude -F -V -c arduino -p #{ENV['MCU']} -P #{ENV['SERIAL_PORT']} -b 115200 -U flash:w:build\\release\\#{RELEASE_BUILD_OUTPUT}.hex"
+end

data/examples/blinky/src/BlinkTask.c

@@ -0,0 +1,21 @@
+// #include <stdint.h>
+
+#include "BlinkTask.h"
+
+#ifdef TEST
+  #define LOOP 
+  #include "stub_io.h"
+#else
+  #include <avr/interrupt.h>
+  #include <avr/io.h>
+  #define LOOP while(1)
+#endif // TEST
+
+
+
+void BlinkTask(void)
+{
+  /* toggle the LED */
+  PORTB ^= _BV(PORTB5);
+
+}

data/examples/blinky/src/BlinkTask.h

@@ -0,0 +1,8 @@
+#ifndef BlinkTask_H
+#define BlinkTask_H
+
+void BlinkTask(void);
+
+
+
+#endif

data/examples/blinky/src/Configure.c

@@ -0,0 +1,38 @@
+#include "Configure.h"
+#include "main.h"
+#ifdef TEST
+  #define LOOP 
+  #include "stub_io.h"
+  #include "stub_interrupt.h"
+#else
+  #include <avr/interrupt.h>
+  #include <avr/io.h>
+  #define LOOP while(1)
+#endif // TEST
+
+/* setup timer 0 to divide bus clock by 64.
+   This results in a 1.024ms overflow interrupt
+16000000/64
+    250000
+
+0.000 004s   *256
+0.001024 
+*/
+void Configure(void)
+{
+  /* disable interrupts */
+  cli();
+
+  /* Configure TIMER0 to use the CLK/64 prescaler. */
+  TCCR0B = _BV(CS00) | _BV(CS01);
+
+  /* enable the TIMER0 overflow interrupt */
+  TIMSK0 = _BV(TOIE0);
+
+  /* confiure PB5 as an output. */
+  DDRB |= _BV(DDB5);
+
+  /* enable interrupts. */
+  sei();
+}
+

data/examples/blinky/src/Configure.h

@@ -0,0 +1,6 @@
+#ifndef Configure_H
+#define Configure_H
+
+void Configure(void);
+
+#endif // Configure_H

data/examples/blinky/src/main.c

@@ -0,0 +1,51 @@
+// #include <stdint.h>
+
+#include "main.h"
+#include "BlinkTask.h"
+#include "Configure.h"    
+
+//Most OS's frown upon direct memory access. 
+//So we'll have to use fake registers during testing.
+#ifdef TEST
+  #define LOOP 
+  #include "stub_io.h"
+  #include "stub_interrupt.h"
+#else
+  #include <avr/interrupt.h>
+  #include <avr/io.h>
+  #define LOOP while(1)
+  //The target will need a main. 
+  //Our test runner will provide it's own and call AppMain()
+  int main(void)              
+  {
+    return AppMain();
+  }
+#endif // TEST
+
+int AppMain(void)
+{
+  Configure();
+
+  LOOP
+  {
+    if(BlinkTaskReady==0x01)
+    {
+      BlinkTaskReady = 0x00;
+      BlinkTask();
+    }
+  }
+  return 0;
+}
+
+ISR(TIMER0_OVF_vect)
+{
+  /* toggle every thousand ticks */
+  if (tick >= 1000)
+  {
+    /* signal our periodic task. */
+    BlinkTaskReady = 0x01;
+    /* reset the tick */
+    tick = 0;
+  }    
+  tick++;
+}

data/examples/blinky/src/main.h

@@ -0,0 +1,9 @@
+#ifndef __MAIN_H__
+#define __MAIN_H__
+
+int main(void);
+int AppMain(void);
+volatile int BlinkTaskReady;
+int tick;
+
+#endif /* __MAIN_H__ */

data/examples/blinky/test/support/stub_interrupt.h

@@ -0,0 +1,348 @@
+/* Copyright (c) 2002,2005,2007 Marek Michalkiewicz
+   Copyright (c) 2007, Dean Camera
+
+   All rights reserved.
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions are met:
+
+   * Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+
+   * Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in
+     the documentation and/or other materials provided with the
+     distribution.
+
+   * Neither the name of the copyright holders nor the names of
+     contributors may be used to endorse or promote products derived
+     from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+  POSSIBILITY OF SUCH DAMAGE. */
+
+/* $Id: interrupt.h,v 1.25.2.1 2008/01/05 06:33:11 dmix Exp $ */
+
+#ifndef _AVR_INTERRUPT_H_
+#define _AVR_INTERRUPT_H_
+
+// #include <avr/io.h>
+#include "stub_io.h"
+#if !defined(__DOXYGEN__) && !defined(__STRINGIFY)
+/* Auxiliary macro for ISR_ALIAS(). */
+#define __STRINGIFY(x) #x
+#endif /* !defined(__DOXYGEN__) */
+
+/** 
+\file 
+\@{ 
+*/
+
+
+/** \name Global manipulation of the interrupt flag
+
+    The global interrupt flag is maintained in the I bit of the status
+    register (SREG). 
+*/
+
+// #if defined(__DOXYGEN__)
+#if 1
+/** \def sei()
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Enables interrupts by setting the global interrupt mask. This function
+    actually compiles into a single line of assembly, so there is no function
+    call overhead. */
+#define sei()
+#else  /* !DOXYGEN */
+# define sei()  __asm__ __volatile__ ("sei" ::)
+#endif /* DOXYGEN */
+
+// #if defined(__DOXYGEN__)
+#if 1
+/** \def cli()
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Disables all interrupts by clearing the global interrupt mask. This function
+    actually compiles into a single line of assembly, so there is no function
+    call overhead. */
+#define cli()
+#else  /* !DOXYGEN */
+# define cli()  __asm__ __volatile__ ("cli" ::)
+#endif /* DOXYGEN */
+
+
+/** \name Macros for writing interrupt handler functions */
+
+
+// #if defined(__DOXYGEN__)
+#if 1
+/** \def ISR(vector [, attributes])
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Introduces an interrupt handler function (interrupt service
+    routine) that runs with global interrupts initially disabled
+    by default with no attributes specified.
+
+    The attributes are optional and alter the behaviour and resultant
+    generated code of the interrupt routine. Multiple attributes may
+    be used for a single function, with a space seperating each
+    attribute.
+
+    Valid attributes are ISR_BLOCK, ISR_NOBLOCK, ISR_NAKED and
+    ISR_ALIASOF(vect).
+
+    \c vector must be one of the interrupt vector names that are
+    valid for the particular MCU type.
+*/
+// #  define ISR(vector, [attributes])
+#define ISR void ISR
+#else  /* real code */
+
+#if (__GNUC__ == 4 && __GNUC_MINOR__ >= 1) || (__GNUC__ > 4)
+#  define __INTR_ATTRS used, externally_visible
+#else /* GCC < 4.1 */
+#  define __INTR_ATTRS used
+#endif
+
+#ifdef __cplusplus
+#  define ISR(vector, ...)            \
+    extern "C" void vector (void) __attribute__ ((signal,__INTR_ATTRS)) __VA_ARGS__; \
+    void vector (void)
+#else
+#  define ISR(vector, ...)            \
+    void vector (void) __attribute__ ((signal,__INTR_ATTRS)) __VA_ARGS__; \
+    void vector (void)
+#endif
+
+#endif /* DOXYGEN */
+
+#if defined(__DOXYGEN__)
+/** \def SIGNAL(vector)
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Introduces an interrupt handler function that runs with global interrupts
+    initially disabled.
+
+    This is the same as the ISR macro without optional attributes.
+    \deprecated Do not use SIGNAL() in new code. Use ISR() instead.
+*/
+#  define SIGNAL(vector)
+#else  /* real code */
+
+#ifdef __cplusplus
+#  define SIGNAL(vector)					\
+    extern "C" void vector(void) __attribute__ ((signal, __INTR_ATTRS));	\
+    void vector (void)
+#else
+#  define SIGNAL(vector)					\
+    void vector (void) __attribute__ ((signal, __INTR_ATTRS));		\
+    void vector (void)
+#endif
+
+#endif /* DOXYGEN */
+
+#if defined(__DOXYGEN__)
+/** \def EMPTY_INTERRUPT(vector)
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Defines an empty interrupt handler function. This will not generate
+    any prolog or epilog code and will only return from the ISR. Do not
+    define a function body as this will define it for you.
+    Example:
+    \code EMPTY_INTERRUPT(ADC_vect);\endcode */
+#  define EMPTY_INTERRUPT(vector)
+#else  /* real code */
+
+#ifdef __cplusplus
+#  define EMPTY_INTERRUPT(vector)                \
+    extern "C" void vector(void) __attribute__ ((signal,naked,__INTR_ATTRS));    \
+    void vector (void) {  __asm__ __volatile__ ("reti" ::); }
+#else
+#  define EMPTY_INTERRUPT(vector)                \
+    void vector (void) __attribute__ ((signal,naked,__INTR_ATTRS));    \
+    void vector (void) { __asm__ __volatile__ ("reti" ::); }
+#endif
+
+#endif /* DOXYGEN */
+
+#if defined(__DOXYGEN__)
+/** \def ISR_ALIAS(vector, target_vector)
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Aliases a given vector to another one in the same manner as the
+    ISR_ALIASOF attribute for the ISR() macro. Unlike the ISR_ALIASOF
+    attribute macro however, this is compatible for all versions of
+    GCC rather than just GCC version 4.2 onwards.
+
+    \note This macro creates a trampoline function for the aliased
+    macro.  This will result in a two cycle penalty for the aliased
+    vector compared to the ISR the vector is aliased to, due to the
+    JMP/RJMP opcode used.
+
+    \deprecated
+    For new code, the use of ISR(..., ISR_ALIASOF(...))  is
+    recommended.
+
+    Example:
+    \code
+    ISR(INT0_vect)
+    {
+        PORTB = 42;
+    }
+
+    ISR_ALIAS(INT1_vect, INT0_vect);
+    \endcode 
+*/
+#  define ISR_ALIAS(vector, target_vector)
+#else /* real code */
+
+#ifdef __cplusplus
+#  if defined(__AVR_MEGA__) && __AVR_MEGA__
+#    define ISR_ALIAS(vector, tgt) extern "C" void vector (void) \
+	__attribute__((signal, naked, __INTR_ATTRS)); \
+	void vector (void) { asm volatile ("jmp " __STRINGIFY(tgt) ::); }
+#  else /* !__AVR_MEGA */
+#    define ISR_ALIAS(vector, tgt) extern "C" void vector (void) \
+	__attribute__((signal, naked, __INTR_ATTRS)); \
+	void vector (void) { asm volatile ("rjmp " __STRINGIFY(tgt) ::); }
+#  endif  /* __AVR_MEGA__ */
+#else	  /* !__cplusplus */
+#  if defined(__AVR_MEGA__) && __AVR_MEGA__
+#  define ISR_ALIAS(vector, tgt) void vector (void) \
+	__attribute__((signal, naked, __INTR_ATTRS)); \
+	void vector (void) { asm volatile ("jmp " __STRINGIFY(tgt) ::); }
+#  else /* !__AVR_MEGA */
+#  define ISR_ALIAS(vector, tgt) void vector (void) \
+	__attribute__((signal, naked, __INTR_ATTRS)); \
+	void vector (void) { asm volatile ("rjmp " __STRINGIFY(tgt) ::); }
+#  endif  /* __AVR_MEGA__ */
+#endif	/* __cplusplus */
+
+#endif /* DOXYGEN */
+
+#if defined(__DOXYGEN__)
+/** \def reti()
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    Returns from an interrupt routine, enabling global interrupts. This should
+    be the last command executed before leaving an ISR defined with the ISR_NAKED
+    attribute.
+
+    This macro actually compiles into a single line of assembly, so there is
+    no function call overhead.
+*/
+#  define reti()
+#else  /* !DOXYGEN */
+#  define reti()  __asm__ __volatile__ ("reti" ::)
+#endif /* DOXYGEN */
+
+#if defined(__DOXYGEN__)
+/** \def BADISR_vect
+    \ingroup avr_interrupts
+
+    \code #include <avr/interrupt.h> \endcode
+
+    This is a vector which is aliased to __vector_default, the vector
+    executed when an ISR fires with no accompanying ISR handler. This
+    may be used along with the ISR() macro to create a catch-all for
+    undefined but used ISRs for debugging purposes.
+*/
+#  define BADISR_vect
+#else  /* !DOXYGEN */
+#  define BADISR_vect __vector_default
+#endif /* DOXYGEN */
+
+/** \name ISR attributes */
+
+#if defined(__DOXYGEN__)
+/** \def ISR_BLOCK
+    \ingroup avr_interrupts
+
+    \code# include <avr/interrupt.h> \endcode
+
+    Identical to an ISR with no attributes specified. Global
+    interrupts are initially disabled by the AVR hardware when
+    entering the ISR, without the compiler modifying this state.
+
+    Use this attribute in the attributes parameter of the ISR macro.
+*/
+#  define ISR_BLOCK
+
+/** \def ISR_NOBLOCK
+    \ingroup avr_interrupts
+
+    \code# include <avr/interrupt.h> \endcode
+
+    ISR runs with global interrupts initially enabled.  The interrupt
+    enable flag is activated by the compiler as early as possible
+    within the ISR to ensure minimal processing delay for nested
+    interrupts.
+
+    This may be used to create nested ISRs, however care should be
+    taken to avoid stack overflows, or to avoid infinitely entering
+    the ISR for those cases where the AVR hardware does not clear the
+    respective interrupt flag before entering the ISR.
+
+    Use this attribute in the attributes parameter of the ISR macro.
+*/
+#  define ISR_NOBLOCK
+
+/** \def ISR_NAKED
+    \ingroup avr_interrupts
+
+    \code# include <avr/interrupt.h> \endcode
+
+    ISR is created with no prologue or epilogue code. The user code is
+    responsible for preservation of the machine state including the
+    SREG register, as well as placing a reti() at the end of the
+    interrupt routine.
+
+    Use this attribute in the attributes parameter of the ISR macro.
+*/
+#  define ISR_NAKED
+
+/** \def ISR_ALIASOF(target_vector)
+    \ingroup avr_interrupts
+
+    \code#include <avr/interrupt.h>\endcode
+
+    The ISR is linked to another ISR, specified by the vect parameter.
+    This is compatible with GCC 4.2 and greater only.
+
+    Use this attribute in the attributes parameter of the ISR macro.
+*/
+#  define ISR_ALIASOF(target_vector)
+#else  /* !DOXYGEN */
+#  define ISR_BLOCK
+#  define ISR_NOBLOCK    __attribute__((interrupt))
+#  define ISR_NAKED      __attribute__((naked))
+#  define ISR_ALIASOF(v) __attribute__((alias(__STRINGIFY(v))))
+#endif /* DOXYGEN */
+
+/* \@} */
+
+#endif