edited bold-words in dictionary.odt

updated code files

git-svn-id: file:///srv/dev-disk-by-uuid-17e88007-4d0c-45e0-8757-cacfcc458630/repositories/svn/Diplomarbeit@132 9fe90eed-be63-e94b-8204-d34ff4c2ff93

Test_Item/SW/script/cf_test

@@ -0,0 +1,75 @@
+#!/bin/sh
+
+
+# Hint: "ori" = ORIginal; "rb" = ReadBack; "res" = RESult; "err" = ERRor
+
+
+
+# Make shure that mounting Directory exists
+if [ ! -d /mnt/usb1 ]
+then
+    mkdir /mnt/usb1
+fi
+
+# Make shure that result Directory exists
+if [ ! -d /test/result ]
+then
+    mkdir /test/result
+fi
+
+# Make shure that result file of Test does NOT exists
+if [ -s /test/result/usb1.res ]
+then
+    rm /test/result/usb1.res
+fi
+
+# Make shure that error file of Test does NOT exists
+if [ -s /test/result/usb1.err ]
+then
+    rm /test/result/usb1.err
+fi
+
+# Mount USB-Stick to /mnt/usb1
+mount /dev/sda1 /mnt/usb1 2>> /test/result/usb1.err
+
+# Copy Testfile from Test Directory to USB-Stick
+cp /test/testfile /mnt/usb1 2>> /test/result/usb1.err
+
+# Compare original Testfile and copied Testfile on USB-Stick
+# Print compare results to /test/result/usb1.res
+# Print compare errors to /test/result/usb1.err
+if [ ! -e /mnt/usb1/testfile ]
+then
+    echo "TESTFILE DOES NOT EXIST" >> /test/result/usb1.err
+fi
+diff /test/testfile /mnt/usb1/testfile 1>> /test/result/usb1.res 
+                                                                                    2>> /test/result/usb1.err
+
+# Delete Testfile on USB-Stick
+rm /mnt/usb1/testfile 2>> /test/result/usb1.err
+
+# Unmount USB-Stick
+umount /mnt/usb1 2>> /test/result/usb1.err
+
+# Delete Folder usb1 in /mnt
+rmdir /mnt/usb1 2>> /test/result/usb1.err
+
+# Display content of /test/result/usb1.res
+echo -e "\n\rContent of usb1.res"
+cat /test/result/usb1.res
+
+# Display content of /test/result/usb1.err
+echo -e "\n\rContent of usb1.err"
+cat /test/result/usb1.err
+
+# If comparison returned neither results nor errors, the copying and comparision was successful
+if [ ! -s /test/result/usb1.res -a ! -s /test/result/usb1.err ]
+then
+    # Test was successful
+    echo -e "\n\rUSB1 TEST-PASSED"
+    echo "USB1 TEST-PASSED"  >> /test/result/usb1.res
+else
+    # Test failed
+    echo -e "\n\rUSB1 TEST-FAIL"
+    echo "USB1 TEST-FAILED"  >> /test/result/usb1.res
+fi

Tester/SW/Eclipse/Applications/groupings/ledfunctions.h

@@ -65,6 +65,7 @@
  */
 void LEDPauseFlash(t_led_ids LEDnum, UINT8 counts, INT16 delay_length);
 
+
 /* ---------------------------------------------------------------------------
  * Function: LEDResult
  * 
@@ -77,6 +78,7 @@ void LEDPauseFlash(t_led_ids LEDnum, UINT8 counts, INT16 delay_length);
  */
 void LEDResult (BOOLEAN TestResult);
 
+
 /* ---------------------------------------------------------------------------
  * Function: LEDResultDIO
  * 
@@ -90,6 +92,7 @@ void LEDResult (BOOLEAN TestResult);
  */
 void LEDResultDIO (BOOLEAN TestResult, UINT16 dioNo);
 
+
 /* ---------------------------------------------------------------------------
  * Function: LEDToggleForever
  * 
@@ -102,6 +105,7 @@ void LEDResultDIO (BOOLEAN TestResult, UINT16 dioNo);
  */
 void LEDToggleForever( void);
 
+
 /* ---------------------------------------------------------------------------
  * Function: LEDToggle
  * 
@@ -114,6 +118,7 @@ void LEDToggleForever( void);
  */
 void LEDToggle( UINT16 cnts);
 
+
 /* ---------------------------------------------------------------------------
  * Function: LEDShowStatus
  * 
@@ -126,6 +131,7 @@ void LEDToggle( UINT16 cnts);
  */
 void LEDShowStatus (UINT16 status);
 
+
 /* ---------------------------------------------------------------------------
  * Functions: gLEDToggle / rLEDToggle
  * 
@@ -140,6 +146,7 @@ void LEDShowStatus (UINT16 status);
 void gLEDToggle (UINT16 time);
 void rLEDToggle (UINT16 time);
 
+
 /* ---------------------------------------------------------------------------
  * Function: dioToggle
  * 
@@ -153,6 +160,7 @@ void rLEDToggle (UINT16 time);
  */
 void dioToggle (UINT16 LEDnr);
 
+
 /* ---------------------------------------------------------------------------
  * Function: dioToggleNC
  * 
@@ -166,6 +174,7 @@ void dioToggle (UINT16 LEDnr);
  */
 void dioToggleNC (UINT16 LEDnr);
 
+
 /* ---------------------------------------------------------------------------
  * Function: dio2x4
  * 
@@ -180,6 +189,7 @@ void dioToggleNC (UINT16 LEDnr);
  */
 void dio2x4 (UINT32 ToggleTime);
 
+
 /* ---------------------------------------------------------------------------
  * Function: dioClean
  * 
@@ -192,6 +202,7 @@ void dio2x4 (UINT32 ToggleTime);
  */
 void dioClean (void);
 
+
 /* ---------------------------------------------------------------------------
  * Function: dioCapture
  * 
@@ -204,6 +215,7 @@ void dioClean (void);
  */
 UINT8 dioCapture (void);
 
+
 /* ---------------------------------------------------------------------------
  * Function: dioResume
  * 

Tester/SW/Eclipse/Applications/groupings/protocolfunctions.c

@@ -1,5 +1,5 @@
 /* ---------------------------------------------------------------------------
- * protocolfunctions.c - v0.1                           (c) 2008 Micro-key bv
+ * protocolfunctions.c                                  (c) 2008 Micro-key bv
  * ---------------------------------------------------------------------------
  * Micro-key bv
  * Industrieweg 28, 9804 TG Noordhorn
@@ -54,8 +54,6 @@
  * Global variable definitions
  * ---------------------------------------------------------------------------
  */
-
-
 extern BOOLEAN auto_testResult;
 extern UINT32 UINT32result;
 /* ---------------------------------------------------------------------------

Tester/SW/Eclipse/Applications/groupings/protocolfunctions.h

@@ -157,6 +157,18 @@ void slaveRestartFunction (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 void UINT32ResultFunction (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 
 
+/* ---------------------------------------------------------------------------
+ * Function: receiveRemoteAttachedFunctions
+ * 
+ * Function to receive and print the name of a attached remote function
+ * 
+ * Parameters:  UINT8 requestNr  - number of the request
+ *              UINT8 nrOfResult - Number of Attached Results
+ *              UIN32 *results   - Attached Results 
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void receiveRemoteAttachedFunctions (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 
 #endif /* __PROTOCOLTEST_H__ */

Tester/SW/Eclipse/Applications/main.c

@@ -37,7 +37,7 @@
 /* ---------------------------------------------------------------------------
  * Description: MAIN File to Application Project
  * ---------------------------------------------------------------------------
- * Version(s):  0.1, Jul 07, 2008, MMi
+ * Version(s):  0.1, Jul 08, 2008, MMi
  *                 
  * ---------------------------------------------------------------------------
  */

Tester/SW/Eclipse/Applications/menu/menuargs.c

@@ -111,7 +111,7 @@ const char *command_table[NUMBER_OF_COMMANDS] =
         "volout"
 };
 
-/* Make Sure that at least the first letter of this is in alphabetical order*/
+
 const fpointer command_pointer[NUMBER_OF_COMMANDS] = 
 {
         m_aio,

Tester/SW/Eclipse/Applications/menu/menuargs.h

@@ -38,7 +38,7 @@
  * Type definitions.
  * ---------------------------------------------------------------------------
  */
-typedef void (*fpointer)(void);
+typedef void (*fpointer)(void);             /* Function pointer for menu    */
 /* ---------------------------------------------------------------------------
  * Variable declarations.
  * ---------------------------------------------------------------------------

Tester/SW/Eclipse/Applications/menu/menufunctions.c

@@ -10,7 +10,7 @@
  * Email: support@microkey.nl  
  * Web: www.microkey.nl
  * ---------------------------------------------------------------------------
- * Description: 
+ * Description: All called, menu-specific functions are defined here 
  * ---------------------------------------------------------------------------
  * Version(s):  0.1, Nov 14, 2008, MMi
  *                   Creation.
@@ -118,7 +118,7 @@ void m_run(void)
 {
     dioClean();
     diotasksdelete();
-    // \MARK Automatic Test not necessary on Olimex Board
+// \MARK Automatic Test not necessary on Olimex Board
 #if ((PINSET_TESTER == 1) || (PINSET_TESTER == 2)) 
 //    automaticdesigntest();                  // \TODO NO AUTOMATIC TEST AVAILABLE
 #else
@@ -329,7 +329,8 @@ void m_curout(void)
             sendString(MenuPort, TRUE, importantMessage, "Wrote Output to: ",
                     ItoDStr(dacReadBack(arg1, arg2)), " uA");
             }
-        } else
+        } 
+    else
         {
         sendString(MenuPort, TRUE, importantMessage,
                 "ARGUMENT ERROR! Did nothing... ", Dummy, Dummy);

Tester/SW/Eclipse/Applications/remote/remote_analogue.h

@@ -64,20 +64,123 @@ xSemaphoreHandle remoteAnalogueSemaphore;
  * ---------------------------------------------------------------------------
  */
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAioInit
+ * 
+ * Initialisation of the remote analogue driver; takes the analogue semaphore
+ * 
+ * Parameter: void
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void remoteAioInit (void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAioWrite
+ * 
+ * Writes to one remote analogue output
+ * 
+ * Parameter:   UINT8 device    - Number of the device to write one
+                UINT8 channel   - Channelnumber that should be affected
+                INT32 value     - Value that should be written
+ * 
+ * Return: RESULT - Write result
+ * ---------------------------------------------------------------------------
+ */
 RESULT remoteAioWrite (UINT8 device, UINT8 channel, INT32 value);
 
+/* ---------------------------------------------------------------------------
+ * Function: remoteAioWriteAll
+ * 
+ * Writes to all remote analogue outputs
+ * 
+ * Parameter:   UINT8 device                - Number of the device to write on 
+                t_boardtype_analogue board  - type of board (MB or EB)
+                INT32 value                 - Value that should be written
+ * 
+ * Return: RESULT - Write result
+ * ---------------------------------------------------------------------------
+ */
 RESULT remoteAioWriteAll (UINT8 device, t_boardtype_analogue board, BOOLEAN value);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAioread
+ * 
+ * Reads on one remote analogue outputs
+ * 
+ * Parameter:   UINT8 device   - Number of the device to write on 
+                UINT8 channel  - Number of affected channel
+ * 
+ * Return: UINT32 - Read value
+ * ---------------------------------------------------------------------------
+ */
 UINT32 remoteAioRead (UINT8 device, UINT8 channel);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAioread
+ * 
+ * Reads on one remote analogue outputs
+ * 
+ * Parameter:   UINT8 device                - Number of the device to write on 
+                t_boardtype_analogue board  - type of board (MB or EB)
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void remoteAioReadAll (UINT8 device, t_boardtype_analogue board);
 
+
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueSemaphoreRelease
+ * 
+ * Is called as a result from the remote device to release the analogue 
+ * Semaphore. This call is the last statement within the remote procedure.
+ * It assures that the complete function is executed before the local 
+ * software resumes working.
+ * 
+ * Parameters:  UINT8 requestNr     - Number of the momentary request
+ *              UINT8 nrOfResults   - Indicates how many values are returned
+ *              UINT32 *results     - Result-Array of "NrOfResults"-size
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void remoteAnalogueSemaphoreRelease (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: analogueReadResult
+ * 
+ * Is called as result function; receives the remotely read value
+ * 
+ * Parameters:  UINT8 requestNr     - Number of the momentary request
+ *              UINT8 nrOfResults   - Indicates how many values are returned
+ *              UINT32 *results     - Result-Array of "NrOfResults"-size
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void analogueReadResult (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: analogueReadAllResult
+ * 
+ * Is called as result function; receives the remotely read values
+ * 
+ * Parameters:  UINT8 requestNr     - Number of the momentary request
+ *              UINT8 nrOfResults   - Indicates how many values are returned
+ *              UINT32 *results     - Result-Array of "NrOfResults"-size
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void analogueReadAllResult (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 
 

Tester/SW/Eclipse/Applications/remote/remote_misc.c

@@ -85,6 +85,7 @@ BOOLEAN makeHandshake (void)
 }
 #endif
 
+
 UINT8 returnRemoteCalibrationStatus (INT32 correctionType)
 {
     xSemaphoreTake(generalSemaphore, 0);

Tester/SW/Eclipse/Applications/remote/remote_misc.h

@@ -16,13 +16,14 @@
  *                   Creation.
  * ---------------------------------------------------------------------------
  */
-#include "lpc23xx.h"
+#ifndef REMOTE_MISC_H_
-#include "types.h" 
+#define REMOTE_MISC_H_
 /* ---------------------------------------------------------------------------
  * System include files.
  * ---------------------------------------------------------------------------
  */
-
+#include "lpc23xx.h"
+#include "types.h" 
 /* ---------------------------------------------------------------------------
  * Application include files.
  * ---------------------------------------------------------------------------
@@ -67,7 +68,5 @@ UINT8 showRemoteCalibrationStatus (INT32 correctionType);
 
 void digitalReadResult (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);
 
-#ifndef REMOTE_MISC_H_
-#define REMOTE_MISC_H_
 
 #endif /*REMOTE_MISC_H_*/

Tester/SW/Eclipse/Applications/remote/remote_relay.h

@@ -59,12 +59,63 @@ xSemaphoreHandle remoteRelaySemaphore;
  * ---------------------------------------------------------------------------
  */
  
+ 
+/* ---------------------------------------------------------------------------
+ * Function: remoteRelayInit
+ * 
+ * Initialisation of the relay remote driver, creates and takes relay
+ * Semaphore.
+ * 
+ * Parameters: void
+ * 
+ * Return: void
+ * ---------------------------------------------------------------------------
+ */
 void remoteRelayInit(void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteRelaySet
+ * 
+ * Sets or cleans a relay output on the remote device
+ * 
+ * Parameters:  UINT8 device    - Number of the remote device
+ *              UINT8 channel   - Number of the effected remote channel
+ *              BOOLEAN value   - Value to be written
+ * 
+ * Return: RESULT - Indicates the status of the write action
+ * ---------------------------------------------------------------------------
+ */
 RESULT remoteRelaySet (UINT8 device, UINT8 channel, BOOLEAN value);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteRelayRead
+ * 
+ * reads from one remote relay input. If the result fails, the previous 
+ * generated result will be returned.
+ * 
+ * Parameters:  UINT8 device    - Number of the remote device
+ *              UINT8 channel   - Number of the effected remote channel
+ * 
+ * Return: BOOLEAN - The read result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteRelayRead (UINT8 device, UINT8 channel);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteRelaySetAll
+ * 
+ * Sets or cleans all relay outputs on the remote device
+ * 
+ * Parameters:  UINT8 device    - Number of the remote device
+ *              UINT8 channel   - Number of the effected remote channel
+ *              BOOLEAN value   - Value to be written
+ * 
+ * Return: RESULT - Indicates the status of the write action
+ * ---------------------------------------------------------------------------
+ */
 RESULT remoteRelaySetAll (UINT8 device, t_boardtype_relay board, BOOLEAN value);
 
 void remoteRelaySemaphoreRelease (UINT8 requestNr, UINT8 nrOfResults, UINT32 *results);

Tester/SW/Eclipse/Applications/remote/test_analogue.h

@@ -53,16 +53,81 @@
  * ---------------------------------------------------------------------------
  */
 
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueLinetestMBExecute
+ * 
+ * Main function to the analogue connectivity test of the main board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteAnalogueLinetestMBExecute (void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueLinetestEBExecute
+ * 
+ * Main function to the analogue connectivity test of the extension board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteAnalogueLinetestEBExecute (void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueOutputTest_MB
+ * 
+ * Analogue output test for test_item main board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteAnalogueOutputTest_MB (void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueInputTest_MB
+ * 
+ * Analogue input test for test_item main board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteAnalogueInputTest_MB (void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueOutputTest_EB
+ * 
+ * Analogue output test for test_item extension board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteAnalogueOutputTest_EB (void);
 
+
+/* ---------------------------------------------------------------------------
+ * Function: remoteAnalogueInputTest_EB
+ * 
+ * Analogue input test for test_item extension board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteAnalogueInputTest_EB (void);
 
 

Tester/SW/Eclipse/Applications/remote/test_leds.h

@@ -50,6 +50,16 @@
  * ---------------------------------------------------------------------------
  */
 
+/* ---------------------------------------------------------------------------
+ * Function: remoteLEDTestMBexecute
+ * 
+ * LED test for all LEDS available on CPU and main board
+ * 
+ * Parameter: void
+ * 
+ * Return: BOOLEAN - test result
+ * ---------------------------------------------------------------------------
+ */
 BOOLEAN remoteLEDTestMBexecute (void);
 
 

Tester/SW/Eclipse/lib/Drivers/SerOut.c

@@ -15,7 +15,7 @@
  * Contains some handy Functions to convert different DataTypes to Strings
  *  
  * ---------------------------------------------------------------------------
- * Version(s):  0.1, Feb 11, 2008, MMi
+ * Version(s):  0.1, Apr 11, 2008, MMi
  *                   Creation.
  * ---------------------------------------------------------------------------
  */

Tester/SW/Eclipse/lib/Drivers/SerOut.h

@@ -13,7 +13,7 @@
  * Description: 
  * Headerfile for SerOut.c
  * ---------------------------------------------------------------------------
- * Version(s):  0.1, Feb 11, 2008, MMi
+ * Version(s):  0.1, Apr 11, 2008, MMi
  *                   Creation.
  * ---------------------------------------------------------------------------
  */

Tester/SW/Eclipse/lib/Drivers/adc.c

@@ -14,6 +14,8 @@
  * ---------------------------------------------------------------------------
  * Version(s):  0.1, 28-11-2007, fvds.
  *                   Creation.
+ *              
+ *              Calibration updates by MMi
  * ---------------------------------------------------------------------------
  */
 

Tester/SW/Eclipse/lib/Drivers/adc.h

@@ -14,6 +14,8 @@
  * ---------------------------------------------------------------------------
  * Version(s):  0.1, 10-09-2007, Marcel Mulder.
  *                   Creation.
+ *
+ *              Calibration updates by MMi
  * ---------------------------------------------------------------------------
  */
 #ifndef __ADC_H__

Tester/SW/Eclipse/lib/Drivers/can.c

@@ -12,7 +12,7 @@
  * ---------------------------------------------------------------------------
  * Description: 
  * ---------------------------------------------------------------------------
- * Version(s):  0.1, Feb 11, 2008, MMi
+ * Version(s):  0.1, Dez 11, 2008, MMi
  *                   Creation.
  * ---------------------------------------------------------------------------
  */

Tester/SW/Eclipse/lib/Drivers/can.h

@@ -12,7 +12,7 @@
  * ---------------------------------------------------------------------------
  * Description: 
  * ---------------------------------------------------------------------------
- * Version(s):  0.1, Feb 11, 2008, MMi
+ * Version(s):  0.1, Dez 11, 2008, MMi
  *                   Creation.
  * ---------------------------------------------------------------------------
  */

Tester/SW/Eclipse/lib/Drivers/dac.c

@@ -14,6 +14,8 @@
  * ---------------------------------------------------------------------------
  * Version(s):  0.1, 28-11-2007, fvds.
  *                   Creation.
+ *
+ *              Calibration updates by MMi
  * ---------------------------------------------------------------------------
  */
 

Tester/SW/Eclipse/lib/Drivers/dac.h

@@ -14,6 +14,8 @@
  * ---------------------------------------------------------------------------
  * Version(s):  0.1, 10-09-2007, Marcel Mulder.
  *                   Creation.
+ *
+ *              Calibration updates by MMi
  * ---------------------------------------------------------------------------
  */
 #ifndef __DAC_H__

Tester/SW/Eclipse/lib/Drivers/rtc.c

@@ -14,6 +14,8 @@
  * ---------------------------------------------------------------------------
  * Version(s):  0.1, 28-11-2007, fvds.
  *                   Creation.
+ *
+ *              Updates by MMi
  * ---------------------------------------------------------------------------
  */