Add config.h wrapper to simplify test automation

Test code which wants to customize config.h can do so without touching config.h itself by wrapping config.h in a macro variable which is passed in to the compiler. It defaults to "config.h" if no override is provided. This change would break makefile dependency checking since the selection of a different header file on the command line is not noticed by make as a build-trigger. To solve this, we add a layer to the BUILDDIR path so build products are now specific to the USER_CONFIG choice if it is not "config.h".
2013-12-13 13:31:12 -05:00 · 2013-12-13 13:31:12 -05:00 · 21e5343552
parent 08179ccbbe
commit 21e5343552
33 changed files with 56 additions and 38 deletions
--- a/8
+++ b/8
@ -32,7 +32,13 @@
 ##############################################################################

 BUILDDIR = build
-CFLAGS += -save-temps=obj
+USER_CONFIG ?= config.h
+
+ifneq ($(USER_CONFIG),config.h)
+BUILDDIR := $(BUILDDIR)/$(USER_CONFIG:.h=)
+endif
+
+CFLAGS += -save-temps=obj -DUSER_CONFIG='"$(USER_CONFIG)"'

 CC = $(TOOLCHAIN)gcc
 OBJDUMP = $(TOOLCHAIN)objdump
--- a/analog.c
+++ b/analog.c
@ -19,7 +19,7 @@
 #else
 	static const uint8_t analog_mask = 0
 #endif
-#include "config.h"
+#include "config_wrapper.h"
 ;
 #undef DEFINE_TEMP_SENSOR

@ -30,7 +30,7 @@ static volatile uint16_t adc_result[NUM_TEMP_SENSORS] __attribute__ ((__section_
 	((type == TT_THERMISTOR) || (type == TT_AD595)) ? (pin ## _ADC) : 255,
 static uint8_t adc_channel[NUM_TEMP_SENSORS] =
 {
-  #include "config.h"
+  #include "config_wrapper.h"
 };
 #undef DEFINE_TEMP_SENSOR

--- a/analog.h
+++ b/analog.h
@ -13,7 +13,7 @@
 	#define	REFERENCE_2V56	192
 #endif

-#include	"config.h"
+#include	"config_wrapper.h"

 #ifndef	REFERENCE
 #warning	define REFERENCE as one of
--- a/attic/accel_clock/dda.h
+++ b/attic/accel_clock/dda.h
@ -3,7 +3,7 @@

 #include	<stdint.h>

-#include	"config.h"
+#include	"config_wrapper.h"

 #ifdef ACCELERATION_REPRAP
 	#ifdef ACCELERATION_RAMPING
--- a/config_wrapper.h
+++ b/config_wrapper.h
@ -0,0 +1,12 @@
+/*
+ * This wrapper config header is used to allow makefiles and test scripts to
+ * replace or augment the user's 'config.h' file in a controlled manner. A
+ * makefile may add CFLAGS+=-DUSER_CONFIG=alternate_config.h to cause Teacup
+ * to build with a different config header.
+ */
+
+#ifndef USER_CONFIG
+#define USER_CONFIG "config.h"
+#endif
+
+#include USER_CONFIG
--- a/dda.h
+++ b/dda.h
@ -3,7 +3,7 @@

 #include	<stdint.h>

-#include	"config.h"
+#include	"config_wrapper.h"

 #ifdef ACCELERATION_REPRAP
 	#ifdef ACCELERATION_RAMPING
--- a/dda_lookahead.h
+++ b/dda_lookahead.h
@ -2,7 +2,7 @@
 #define DDA_LOOKAHEAD_H_

 #include <stdint.h>
-#include "config.h"
+#include "config_wrapper.h"
 #include "dda.h"

 #ifndef ACCELERATION_RAMPING
--- a/dda_maths.h
+++ b/dda_maths.h
@ -3,7 +3,7 @@

 #include	<stdint.h>

-#include	"config.h"
+#include	"config_wrapper.h"

 // return rounded result of multiplicand * multiplier / divisor
 // this version is with quotient and remainder precalculated elsewhere
--- a/dda_queue.c
+++ b/dda_queue.c
@ -9,7 +9,7 @@
 #include	<avr/interrupt.h>
 #endif

-#include	"config.h"
+#include	"config_wrapper.h"
 #include	"timer.h"
 #include	"serial.h"
 #include	"sermsg.h"
--- a/extruder/analog.c
+++ b/extruder/analog.c
@ -13,7 +13,7 @@
 //! automagically generate analog_mask from DEFINE_TEMP_SENSOR entries in config.h
 #define DEFINE_TEMP_SENSOR(name, type, pin, additional) | (((type == TT_THERMISTOR) || (type == TT_AD595)) ? 1 << (pin) : 0)
 static const uint8_t analog_mask = 0
-#include "config.h"
+#include "config_wrapper.h"
 ;
 #undef DEFINE_TEMP_SENSOR

--- a/extruder/analog.h
+++ b/extruder/analog.h
@ -12,7 +12,7 @@
 	#define	REFERENCE_2V56	192
 #endif

-#include	"config.h"
+#include	"config_wrapper.h"

 #ifndef	REFERENCE
 #warning	define REFERENCE as one of
--- a/extruder/extruder.c
+++ b/extruder/extruder.c
@ -5,7 +5,7 @@

 #include	"intercom.h"
 #include	"analog.h"
-#include	"config.h"
+#include	"config_wrapper.h"
 #include	"watchdog.h"
 #include	"heater.h"
 #include	"temp.h"
--- a/extruder/heater.c
+++ b/extruder/heater.c
@ -31,7 +31,7 @@ typedef struct {
 #define	DEFINE_HEATER(name, pin) { &(pin ## _WPORT), pin ## _PIN, (pin ## _PWM) },
 static const heater_definition_t heaters[NUM_HEATERS] =
 {
-	#include	"config.h"
+	#include	"config_wrapper.h"
 };
 #undef DEFINE_HEATER

--- a/extruder/heater.h
+++ b/extruder/heater.h
@ -1,7 +1,7 @@
 #ifndef	_HEATER_H
 #define	_HEATER_H

-#include "config.h"
+#include "config_wrapper.h"
 #include	<stdint.h>
 #include "temp.h"

@ -12,7 +12,7 @@
 #define DEFINE_HEATER(name, pin) HEATER_ ## name,
 typedef enum
 {
-	#include "config.h"
+	#include "config_wrapper.h"
 	NUM_HEATERS,
 	HEATER_noheater
 } heater_t;
--- a/extruder/intercom.c
+++ b/extruder/intercom.c
@ -7,7 +7,7 @@
 #include	<avr/io.h>
 #include	<avr/interrupt.h>

-#include	"config.h"
+#include	"config_wrapper.h"
 #include	"delay.h"

 #if	 (defined TEMP_INTERCOM) || (defined EXTRUDER)
--- a/extruder/intercom.h
+++ b/extruder/intercom.h
@ -2,7 +2,7 @@
 #define	_INTERCOM_H

 #include	<stdint.h>
-#include	"config.h"
+#include	"config_wrapper.h"

 #ifdef HOST
 	#define enable_transmit()			do { WRITE(TX_ENABLE_PIN,1);  UCSR1B &=~MASK(RXEN1); } while(0)
--- a/extruder/temp.c
+++ b/extruder/temp.c
@ -51,7 +51,7 @@ typedef struct {
 #define DEFINE_TEMP_SENSOR(name, type, pin, additional) { (type), (pin), (HEATER_ ## name), (additional) },
 static const temp_sensor_definition_t temp_sensors[NUM_TEMP_SENSORS] =
 {
-	#include	"config.h"
+	#include	"config_wrapper.h"
 };
 #undef DEFINE_TEMP_SENSOR

--- a/extruder/temp.h
+++ b/extruder/temp.h
@ -1,7 +1,7 @@
 #ifndef	_TEMP_H
 #define	_TEMP_H

-#include	"config.h"
+#include	"config_wrapper.h"
 #include	<stdint.h>

 /*
@ -15,7 +15,7 @@ we still need to specify which analog pins we use in machine.h for the analog se
 #undef DEFINE_TEMP_SENSOR
 #define DEFINE_TEMP_SENSOR(name, type, pin, additional) TEMP_SENSOR_ ## name,
 typedef enum {
-	#include "config.h"
+	#include "config_wrapper.h"
 	NUM_TEMP_SENSORS,
 	TEMP_SENSOR_none
 } temp_sensor_t;
--- a/extruder/timer.c
+++ b/extruder/timer.c
@ -13,7 +13,7 @@
 #include	<avr/interrupt.h>

 #include	"arduino.h"
-#include	"config.h"
+#include	"config_wrapper.h"

 #ifdef	HOST
 #include	"dda_queue.h"
--- a/extruder/watchdog.h
+++ b/extruder/watchdog.h
@ -1,7 +1,7 @@
 #ifndef	_WATCHDOG_H
 #define	_WATCHDOG_H

-#include "config.h"
+#include "config_wrapper.h"

 #ifdef USE_WATCHDOG

--- a/gcode_process.c
+++ b/gcode_process.c
@ -24,7 +24,7 @@
 #include	"pinio.h"
 #include	"debug.h"
 #include	"clock.h"
-#include	"config.h"
+#include	"config_wrapper.h"
 #include	"home.h"

 /// the current tool
--- a/heater.c
+++ b/heater.c
@ -32,7 +32,7 @@ typedef struct {
                                        pwm ? (pin ## _PWM) : NULL},
 static const heater_definition_t heaters[NUM_HEATERS] =
 {
-	#include	"config.h"
+	#include	"config_wrapper.h"
 };
 #undef DEFINE_HEATER

@ -271,7 +271,7 @@ void heater_init() {
 	do {
 		#undef	DEFINE_HEATER
 		#define	DEFINE_HEATER(name, pin, pwm) WRITE(pin, 0); SET_OUTPUT(pin);
-			#include "config.h"
+			#include "config_wrapper.h"
 		#undef DEFINE_HEATER
 	} while (0);
 }
--- a/heater.h
+++ b/heater.h
@ -1,7 +1,7 @@
 #ifndef	_HEATER_H
 #define	_HEATER_H

-#include "config.h"
+#include "config_wrapper.h"
 #include	<stdint.h>
 #include "simulator.h"
 #include "temp.h"
@ -10,7 +10,7 @@
 #define DEFINE_HEATER(name, pin, pwm) HEATER_ ## name,
 typedef enum
 {
-	#include "config.h"
+	#include "config_wrapper.h"
 	NUM_HEATERS,
 	HEATER_noheater
 } heater_t;
--- a/intercom.c
+++ b/intercom.c
@ -10,7 +10,7 @@
 #endif
 #include	"memory_barrier.h"

-#include	"config.h"
+#include	"config_wrapper.h"
 #include	"delay.h"

 #if	 (defined TEMP_INTERCOM) || (defined EXTRUDER)
--- a/intercom.h
+++ b/intercom.h
@ -2,7 +2,7 @@
 #define	_INTERCOM_H

 #include	<stdint.h>
-#include	"config.h"
+#include	"config_wrapper.h"

 #ifndef enable_transmit
 #ifdef MOTHERBOARD
--- a/mendel.c
+++ b/mendel.c
@ -29,7 +29,7 @@
 #include	<avr/interrupt.h>
 #endif

-#include	"config.h"
+#include	"config_wrapper.h"
 #include	"fuses.h"

 #include	"serial.h"
--- a/pinio.h
+++ b/pinio.h
@ -5,7 +5,7 @@
 #ifndef	_PINIO_H
 #define	_PINIO_H

-#include	"config.h"
+#include	"config_wrapper.h"

 #ifdef SIMULATOR
  #include "simulator.h"
--- a/serial.h
+++ b/serial.h
@ -1,7 +1,7 @@
 #ifndef	_SERIAL_H
 #define	_SERIAL_H

-#include "config.h"
+#include "config_wrapper.h"
 #include	<stdint.h>
 #ifndef SIMULATOR
 #include	<avr/io.h>
--- a/temp.c
+++ b/temp.c
@ -57,7 +57,7 @@ typedef struct {
 #endif
 static const temp_sensor_definition_t temp_sensors[NUM_TEMP_SENSORS] =
 {
-	#include	"config.h"
+	#include	"config_wrapper.h"
 };
 #undef DEFINE_TEMP_SENSOR

--- a/temp.h
+++ b/temp.h
@ -1,7 +1,7 @@
 #ifndef	_TEMP_H
 #define	_TEMP_H

-#include	"config.h"
+#include	"config_wrapper.h"
 #include	<stdint.h>

 /*
@ -15,7 +15,7 @@ we still need to specify which analog pins we use in machine.h for the analog se
 #undef DEFINE_TEMP_SENSOR
 #define DEFINE_TEMP_SENSOR(name, type, pin, additional) TEMP_SENSOR_ ## name,
 typedef enum {
-	#include "config.h"
+	#include "config_wrapper.h"
 	NUM_TEMP_SENSORS,
 	TEMP_SENSOR_none
 } temp_sensor_t;
--- a/timer.c
+++ b/timer.c
@ -16,7 +16,7 @@
 #include	"memory_barrier.h"

 #include	"arduino.h"
-#include	"config.h"
+#include	"config_wrapper.h"

 #ifdef	MOTHERBOARD
 #include	"dda_queue.h"
--- a/usb_serial.c
+++ b/usb_serial.c
@ -31,7 +31,7 @@
 // Version 1.7: fix usb_serial_set_control
 // 2012-10-17: Import to Teacup firmware

-#include "config.h"
+#include "config_wrapper.h"
 #include "simulator.h"

 /* protect this file from Arduino IDE */
--- a/watchdog.h
+++ b/watchdog.h
@ -1,7 +1,7 @@
 #ifndef	_WATCHDOG_H
 #define	_WATCHDOG_H

-#include "config.h"
+#include "config_wrapper.h"

 #ifdef USE_WATCHDOG