Documentation only.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@458 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOSConfig.h b/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOSConfig.h
index c9c29aefe08d4931451712e7907ca4ef6bb7d5e1..e319547c37cfe8576c31d88b0766daae1155fabf 100644 (file)
--- a/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOSConfig.h
+++ b/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOSConfig.h
@@ -62,6 +62,11 @@
  * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.\r
  *----------------------------------------------------------*/\r
 \r
+/*\r
+ * See http://www.freertos.org/a00110.html for a description of these\r
+ * configuration constants.\r
+ */\r
+\r
 #define configUSE_PREEMPTION                   1\r
 #define configUSE_IDLE_HOOK                            0\r
 #define configUSE_TICK_HOOK                            0\r

diff --git a/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOS_Tick_Setup.c b/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOS_Tick_Setup.c
index a314857c753c625041a04f6ebd7f25a567f66de0..8e19f27a66eb87d551aaf403e187c622689cb5fe 100644 (file)
--- a/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOS_Tick_Setup.c
+++ b/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/FreeRTOS_Tick_Setup.c
@@ -50,22 +50,62 @@
 #include "FreeRTOS.h"\r
 #include "task.h"\r
 \r
+/* Constants used to configure the interrupts. */\r
 #define portPRESCALE_VALUE                     64\r
 #define portPRESCALE_REG_SETTING       ( 5 << 8 )\r
 #define portPIT_INTERRUPT_ENABLED      ( 0x08 )\r
 #define configPIT0_INTERRUPT_VECTOR    ( 55 )\r
 \r
+/*\r
+ * FreeRTOS.org requires two interrupts - a tick interrupt generated from a\r
+ * timer source, and a spare interrupt vector used for context switching.\r
+ * The configuration below uses PIT0 for the former, and vector 63 for the\r
+ * latter.  **IF YOUR APPLICATION HAS BOTH OF THESE INTERRUPTS FREE THEN YOU DO\r
+ * NOT NEED TO CHANGE ANY OF THIS CODE** - otherwise instructions are provided\r
+ * here for using alternative interrupt sources.\r
+ *\r
+ * To change the tick interrupt source:\r
+ *\r
+ *     1) Modify vApplicationSetupInterrupts() below to be correct for whichever\r
+ *     peripheral is to be used to generate the tick interrupt.\r
+ *\r
+ *     2) Change the name of the function __cs3_isr_interrupt_119() defined within\r
+ *     this file to be correct for the interrupt vector used by the timer peripheral.\r
+ *     The name of the function should contain the vector number, so by default vector\r
+ *     number 119 is being used.\r
+ *\r
+ *     3) Make sure the tick interrupt is cleared within the interrupt handler function.\r
+ *  Currently __cs3_isr_interrupt_119() clears the PIT0 interrupt.\r
+ *\r
+ * To change the spare interrupt source:\r
+ *\r
+ *  1) Modify vApplicationSetupInterrupts() below to be correct for whichever\r
+ *  interrupt vector is to be used.  Make sure you use a spare interrupt on interrupt\r
+ *  controller 0, otherwise the register used to request context switches will also\r
+ *  require modification.\r
+ *\r
+ *  2) Change the definition of configYIELD_INTERRUPT_VECTOR within FreeRTOSConfig.h\r
+ *  to be correct for your chosen interrupt vector.\r
+ *\r
+ *  3) Change the name of the function __cs3_isr_interrupt_127() within portasm.S\r
+ *  to be correct for whichever vector number is being used.  By default interrupt\r
+ *  controller 0 number 63 is used, which corresponds to vector number 127.
+ */\r
 void vApplicationSetupInterrupts( void )\r
 {\r
 const unsigned portSHORT usCompareMatchValue = ( ( configCPU_CLOCK_HZ / portPRESCALE_VALUE ) / configTICK_RATE_HZ );\r
 \r
-    /* Configure interrupt priority and level and unmask interrupt. */\r
+    /* Configure interrupt priority and level and unmask interrupt for PIT0. */\r
     MCF_INTC0_ICR55 = ( 1 | ( configKERNEL_INTERRUPT_PRIORITY << 3 ) );\r
     MCF_INTC0_IMRH &= ~( MCF_INTC_IMRH_INT_MASK55 );\r
 \r
+    /* Do the same for vector 63 (interrupt controller 0.  I don't think the\r
+    write to MCF_INTC0_IMRH is actually required here but is included for\r
+    completeness. */\r
     MCF_INTC0_ICR63 = ( 0 | configKERNEL_INTERRUPT_PRIORITY << 3 );\r
     MCF_INTC0_IMRH &= ~( MCF_INTC_IMRH_INT_MASK63 );\r
 \r
+    /* Configure PIT0 to generate the RTOS tick. */\r
     MCF_PIT0_PCSR |= MCF_PIT_PCSR_PIF;\r
     MCF_PIT0_PCSR = ( portPRESCALE_REG_SETTING | MCF_PIT_PCSR_PIE | MCF_PIT_PCSR_RLD | MCF_PIT_PCSR_EN );\r
        MCF_PIT0_PMR = usCompareMatchValue;\r
@@ -76,11 +116,16 @@ void __attribute__ ((interrupt)) __cs3_isr_interrupt_119( void )
 {\r
 unsigned portLONG ulSavedInterruptMask;\r
 \r
+       /* Clear the PIT0 interrupt. */\r
        MCF_PIT0_PCSR |= MCF_PIT_PCSR_PIF;\r
+\r
+       /* Increment the RTOS tick. */\r
        ulSavedInterruptMask = portSET_INTERRUPT_MASK_FROM_ISR();\r
                vTaskIncrementTick();\r
        portCLEAR_INTERRUPT_MASK_FROM_ISR( ulSavedInterruptMask );\r
 \r
+       /* If we are using the pre-emptive scheduler then also request a\r
+       context switch as incrementing the tick could have unblocked a task. */\r
        #if configUSE_PREEMPTION == 1\r
        {\r
                taskYIELD();\r

diff --git a/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/Makefile b/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/Makefile
index 3ce41d52d555fe0144e8ee3b7af30de3b0fc3862..4abb17f93263c800d1aa69d97e8f81384336af59 100644 (file)
--- a/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/Makefile
+++ b/Demo/ColdFire_MCF5282_Eclipse/RTOSDemo/Makefile
@@ -1,5 +1,8 @@
 RM := rm -rf\r
 \r
+# Set the optimisation level - this should be set to 0, 1, 2, 3 or s (s for size).\r
+OPTIM=s\r
+\r
 ###############################################################################\r
 # List the directories that contain files to be built.\r
 ###############################################################################\r
@@ -81,9 +84,9 @@ INCLUDE_PATHS=        -I"$(FREERTOS_SOURCE_DIR)/include" \
 \r
 CFLAGS=                $(INCLUDE_PATHS) \\r
                        -D COLDFIRE_V2_GCC \\r
-                       -Os \\r
+                       -O$(OPTIM) \\r
                        -fno-strict-aliasing \\r
-                       -g1 \\r
+                       -g3 \\r
                        -Wall \\r
                        -Wextra \\r
                        -c \\r