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
2009-01-15 11:59:37 +00:00
parent f468e09499
commit b769685b66
26 changed files with 356 additions and 19 deletions
@@ -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);