Changes between Version 3 and Version 4 of ObjectDeveloperGuide

Timestamp:

12/19/08 17:59:58 (16 years ago)

Author:

ismael (IP: 147.83.118.226)

Comment:

--

ObjectDeveloperGuide

@@ -201 +201 @@
 
 }}}
-Finally, the following figure shows where actually the user code should be written. We provide here an skeleton to easy the deployment of new   
-
-#define DATA_OUT_SZ        128
-
-#define FIR_COEF_SZ 12
-
-/* frequency in/out rate */
-
-#define DATA_INOUT_RATE        1
-
-int data_in[DATA_IN_SZ],data_out[DATA_OUT_SZ];
+Finally, the following figure shows where actually the user code should be written. We provide here an skeleton to easy the deployment of new 
+
+'''Figure 6 – Object implementation (myobj_imp.c)'''
+
+{{{
+/** ALOE headers
+ */
+#include <phal.h>
+#include <phal_sw_api.h>
+
+#include "input.h"      /**< Definition of interface 'input' */
+#include "control.h"    /**< Definition of interface 'control' */
+#include "output.h"     /**< Definition of interface 'output' */
+
+#define DATA_INOUT_RATE 2 /**< Output/input frecuencies rate */
+
+struct input_itf input;
+struct output_itf output;
+struct control_itf control;
+
 
 int fir_coef[FIR_COEF];
-
-int fdi,fdo;
-
+int fdi,fdo,fdc;
 int rcv_len;
-
-int long_block;
-
-int nof_coef;
-
+int long_in_block,long_out_block;
 float freq;
-
 int stat_outsignal;
 
 /** Init function
-
 * @return 1 if ok, 0 if error
-
 */
-
 int Init()
-
 {
-
-fdi = !NewFlow(“input”, FLOW_READ_ONLY);
-
-if (fdi < 0) {
-
-!WriteLog(“Error creating flow\n”);
-
-return 0;
-
+        int filter_type;
+
+        fdi = NewFlow(“input”, FLOW_READ_ONLY);
+        if (fdi < 0) {
+                WriteLog(“Error creating flow\n”);
+                return 0;
+        }
+        fdo = CreateFlow(“output”, FLOW_WRITE_ONLY);
+        if (fdo < 0) {
+                WriteLog(“Error creating flow\n”);
+                return 0;
+        }
+        fdc = CreateFlow(“control”, FLOW_READ_ONLY);
+        if (fdo < 0) {
+                WriteLog(“Error creating flow\n”);
+                return 0;
+        }
+        n = InitParamFile();
+        if (n < 0) {
+                WriteLog (“Error initiating params file\n”);
+                return 0;
+        }
+        n = GetParameter(“freq”, &freq, 1);
+        if (n < 0) {
+                WriteLog (“Error getting parameter\n”);
+                return 0;
+        }
+        n = GetParameter(“filter_type”, &filter_type, 1);
+        if (n < 0) {
+                WriteLog (“Error getting parameter\n”);
+                return 0;
+        }
+        calc_fir_coefs(fir_coef,filter_type);
+        n = InitStatsFile();
+        if (n < 0) {
+                WriteLog (“Error initiating stats\n”);
+                return 0;
+        }
+        stat_outsignal = InitStat(“out_signal”);
+        if (stat_outsignal < 0) {
+                WriteLog (“Error initiating stat\n”);
+                return 0;
+        }
+        rcv_len = 0;
+        return 1;
 }
 
-fdo = !CreateFlow(“output”, FLOW_WRITE_ONLY);
-
-if (fdo < 0) {
-
-!WriteLog(“Error creating flow\n”);
-
-return 0;
-
+/** Run function.
+* @return 1 if ok, 0 if error
+*/
+int Run()
+{
+
+        /* Get number of samples to generate in current timeslot only if last block is already send*/
+        if (rcv_len == 0) {
+                long_out_block = GetTempo(freq);
+                long_in_block = long_out_block/DATA_INOUT_RATE;
+                if (long_out_block > OUTPUT_MAX_DATA) {
+                        WriteLog(“Error requested tempo exceeds output buffer.\n”);
+                        return 0;
+                }
+                if (long_in_block > INPUT_MAX_DATA) {
+                        WriteLog(“Error requested tempo exceeds input buffer.\n”);
+                        return 0;
+                }
+                /* Read from control interface */
+                n = ReadFlow(fdc, &control, sizeof(struct control_itf));
+                if (n < 0) {
+                        WriteLog(“Error reading from control flow\n”);
+                        return 0;
+                } else if (n>0) {
+                        do_my_control_reconfiguration(&control);
+                }
+        }
+        /* receive a block of data */
+        do {
+                n = ReadFlow(fdi, &input.data[rcv_len], long_in_block - rcv_len);
+                if (n < 0) {
+                        WriteLog(“Error reading from flow\n”);
+                        return 0;
+                } else if (!n) {
+                        break;
+                }
+                rcv_len += n;
+        } while(n && rcv_len < long_in_block);
+
+        /* when enough data is received, process and send it */
+        if (rcv_len == long_block) {
+                my_process_function(input, output, fir_coef, long_in_block);
+                n = WriteFlow(fdo, data_out.data, long_out_block);
+                if (n < 0) {
+                        LogWrite(“Error writing to flow\n”);
+                        return 0;
+                } else if (!n) {
+                        LogWrite(“Caution, missing packet due to full buffer\n”);
+                }
+        
+                rcv_len=0;
+                /* set stats variable */
+                SetStatsValue(stat_outsignal,output.data,long_out_block);
+        }
 }
-
-n = !InitParamFile();
-
-if (n < 0) {
-
-!WriteLog (“Error initiating params file\n”);
-
-return 0;
-
-}
-
-n = !GetParameter(“freq”, &freq, 1);
-
-if (n < 0) {
-
-!WriteLog (“Error getting parameter\n”);
-
-return 0;
-
-}
-
-n = !GetParameter(“nof_coef”, &nof_coef, 1);
-
-if (n < 0) {
-
-!WriteLog (“Error getting parameter\n”);
-
-return 0;
-
-}
-
-if (nof_coef > FIR_COEF_SZ) {
-
-!WriteLog (“Error getting parameter, too long\n”);
-
-return 0;
-
-}
-
-memset(fir_coef, 0, FIR_COEF_SZ * 4);
-
-n = !GetParameter(“fir_coef”, fir_coef, nof_coef);
-
-if (n < 0) {
-
-!WriteLog (“Error getting parameter\n”);
-
-return 0;
-
-}
-
-n = !InitStatsFile();
-
-if (n < 0) {
-
-!WriteLog (“Error initiating stats\n”);
-
-return 0;
-
-}
-
-stat_outsignal = !InitStat(“out_signal”);
-
-if (stat_outsignal < 0) {
-
-!WriteLog (“Error initiating stat\n”);
-
-return 0;
-
-}
-
-rcv_len = 0;
-
-return 1;
-
-}
-
-/** Run function.
-
-* @return 1 if ok, 0 if error
-
-*/
-
-int Run()
-
-{
-
-/* Get number of samples to generate in current timeslot only if last block is already send*/
-
-if (rcv_len == 0) {
-
-long_block = !GetTempo(freq);
-
-if (long_block > DATA_OUT_SZ) {
-
-!WriteLog(“Error requested tempo exceeds output buffer.\n”);
-
-return 0;
-
-}
-
-if (long_block * DATA_INOUT_RATE > DATA_IN_SZ) {
-
-!WriteLog(“Error requested tempo exceeds input buffer.\n”);
-
-return 0;
-
-}
-
-}
-
-/* receive a block of data */
-
-do {
-
-n = !ReadFlow(fdi, data_in, long_block / DATA_INOUT_RATE - rcv_len);
-
-if (n < 0) {
-
-!WriteLog(“Error reading from flow\n”);
-
-return 0;
-
-} else if (!n) {
-
-break;
-
-}
-
-rcv_len += n;
-
-} while(n && rcv_len < long_block / DATA_INOUT_RATE);
-
-/* when enough data is received, process and send it */
-
-if (rcv_len * DATA_INOUT_RATE == long_block) {
-
-my_process_function(data_in, data_out, fir_coef, long_block);
-
-/* write output data to output flow */
-
-n = !WriteFlow(fdo, data_out, long_block);
-
-if (n < 0) {
-
-!LogWrite(“Error writing to flow\n”);
-
-return 0;
-
-} else if (!n) {
-
-!LogWrite(“Caution, missing packet due to full buffer\n”);
-
-}
-
-/* reset rcv counter */
-
-rcv_len=0;
-
-/* set stats variable */
-
-!SetStatsValue(stat_outsignal,data_out,long_block);
-
-}
-
-}
-
+}}}
+== [[BR]][[BR]] ==
 == Coding Style ==
 !FlexNets Coding style is based on the Linux Kernel Coding Style and, although we strongly recommend its reading, you may first of all check the following document defining basic codying style conventions: [wiki:WrittingCode Writing code for FlexNets].