Fixed documentation issues tracked by PRSDK-4872, PRSDK-4873, PRSDK-4875.
[ep-processor-libraries/dsplib.git] / ti / dsplib / src / DSPF_sp_dotprod / c674 / DSPF_sp_dotprod_d.c
1 /* ======================================================================= */
2 /* DSP_dotprod_d.c -- Dot Product                                          */
3 /*                Driver code; tests kernel and reports result in stdout   */
4 /*                                                                         */
5 /* Rev 0.0.1                                                               */
6 /*                                                                         */
7 /* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/  */ 
8 /*                                                                         */
9 /*                                                                         */
10 /*  Redistribution and use in source and binary forms, with or without     */
11 /*  modification, are permitted provided that the following conditions     */
12 /*  are met:                                                               */
13 /*                                                                         */
14 /*    Redistributions of source code must retain the above copyright       */
15 /*    notice, this list of conditions and the following disclaimer.        */
16 /*                                                                         */
17 /*    Redistributions in binary form must reproduce the above copyright    */
18 /*    notice, this list of conditions and the following disclaimer in the  */
19 /*    documentation and/or other materials provided with the               */
20 /*    distribution.                                                        */
21 /*                                                                         */
22 /*    Neither the name of Texas Instruments Incorporated nor the names of  */
23 /*    its contributors may be used to endorse or promote products derived  */
24 /*    from this software without specific prior written permission.        */
25 /*                                                                         */
26 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    */
27 /*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      */
28 /*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  */
29 /*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
30 /*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  */
31 /*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT       */
32 /*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  */
33 /*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  */
34 /*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT    */
35 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  */
36 /*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
37 /*                                                                         */
38 /* ======================================================================= */
40 #include <stdio.h>
41 #include <time.h>
42 #include <stdlib.h>
43 #include <limits.h>
44 #include <c6x.h>
46 /* ======================================================================= */
47 /* Interface header files for the natural C and optimized C code           */
48 /* ======================================================================= */
49 #include "DSPF_sp_dotprod_cn.h"
50 #include "DSPF_sp_dotprod.h"
52 /* Defines */
53 #if defined(__TI_EABI__)
54 #define kernel_size _kernel_size
55 #endif
57 extern char kernel_size;
58 #define FORMULA_SIZE          2
59 #define FORMULA_DEVIDE        2
60 #define CYCLE_FORMULA_NX_PT1  64
61 #define CYCLE_FORMULA_NX_PT2  128
62 /* inverse of [ 64 1] */
63 /*            [128 1] */
64 float form_inv[FORMULA_SIZE][FORMULA_SIZE] = 
65 {{-0.0156,  0.0156},
66  { 2.0000, -1.0000}
67 };
68 float form_temp  [FORMULA_SIZE];
69 int   form_cycle [FORMULA_SIZE];
70 int   form_result[FORMULA_SIZE];
72 /* ======================================================================= */
73 /* Tell compiler arrays are double word alligned                           */
74 /* ======================================================================= */
75 #pragma DATA_ALIGN(y_opt, 8);
76 #pragma DATA_ALIGN(y_cn, 8);
77 #pragma DATA_ALIGN(ptr_x1, 8);
78 #pragma DATA_ALIGN(ptr_x2, 8);
80 /* ======================================================================= */
81 /* Parameters of fixed dataset                                             */
82 /* ======================================================================= */
83 #define N (128)
85 float y_opt, y_cn;
86 float ptr_x1[N], ptr_x2[N];
88 /* ======================================================================= */
89 /* Prototypes for timing functions                                         */
90 /* ======================================================================= */
91 clock_t time_opt(int n);
92 clock_t time_cn(int n);
94 /* ======================================================================= */
95 /* Prototypes for utility functions                                        */
96 /* ======================================================================= */
97 void UTIL_fillRandSP(float *ptr_x, int n, float factor);
99 /* ======================================================================= */
100 /* Main -- Top level driver for testing the algorithm                      */
101 /* ======================================================================= */
102 int main()
104     clock_t t_overhead, t_start, t_stop, t_opt, t_cn;
105     int i, j=1, n, form_error = 0;
106     float pct_diff, max_pct_diff = 0;
108     /* ------------------------------------------------------------------- */
109     /* Compute the overhead of calling clock twice to get timing info      */
110     /* ------------------------------------------------------------------- */
111     /* Initialize timer for clock */
112     TSCL= 0,TSCH=0;
113     t_start = _itoll(TSCH, TSCL);
114     t_stop = _itoll(TSCH, TSCL);
115     t_overhead = t_stop - t_start;
117     /* ------------------------------------------------------------------- */
118     /*  Fill input arrays with randomized data in range (-10, 10).         */
119     /* ------------------------------------------------------------------- */
120     UTIL_fillRandSP(ptr_x1, N, 10.0);
121     UTIL_fillRandSP(ptr_x2, N, 10.0);
123     /* ------------------------------------------------------------------- */
124     /*  Clear state/output buffers with fixed values.                      */
125     /* ------------------------------------------------------------------- */
126     for (n = 8; n <= N; n += 8) {
127       /* ----------------------------------------------------------------- */
128       /* Call the individual timing routines                               */
129       /* ----------------------------------------------------------------- */
130       t_opt = time_opt(n) - t_overhead;
131       t_cn  = time_cn(n)  - t_overhead;
133       printf("DSPF_sp_dotprod_d\tIter#: %d\t", j++);
135       /* ----------------------------------------------------------------- */
136       /* compute percent difference and track max difference               */  
137       /* ----------------------------------------------------------------- */
138       pct_diff = (y_cn - y_opt) / y_cn * 100.0;
139       if (pct_diff < 0) pct_diff *= -1;
140       if (pct_diff > max_pct_diff) max_pct_diff = pct_diff;
141       if (max_pct_diff > 0.001)
142           printf("Result Failure  max_pct_diff = %f", max_pct_diff);
143       else
144           printf("Result Successful ");
145           
146       /* ----------------------------------------------------------------- */
147       /* Print timing results                                              */
148       /* ----------------------------------------------------------------- */
149       printf("\tN = %d\tnatC: %d\toptC: %d\n", n, t_cn, t_opt);
151       if (n == CYCLE_FORMULA_NX_PT1)
152         form_cycle[0] = t_opt;
153       if (n == CYCLE_FORMULA_NX_PT2)
154         form_cycle[1] = t_opt;
155     }
157     /* Provide memory information */
158 #ifdef __TI_COMPILER_VERSION__            // for TI compiler only
159     printf("Memory:  %d bytes\n", &kernel_size);
160 #endif
161     
162     /* Provide profiling information */
163     for (i = 0; i < FORMULA_SIZE; i++) {
164         form_temp[i] = 0;
165         for (j = 0; j < FORMULA_SIZE; j++) {
166             form_temp[i] += form_inv[i][j] * form_cycle[j];
167         }
168         if (i != (FORMULA_SIZE-1)) {
169             form_result[i] = (int) (form_temp[i] * FORMULA_DEVIDE + 0.5);
170             if ((form_result[i] - form_temp[i] * FORMULA_DEVIDE) >  0.1 ||
171                 (form_result[i] - form_temp[i] * FORMULA_DEVIDE) < -0.1) {
172                 form_error = 1;
173             }
174         }
175         else {
176             form_result[i] = (int) (form_temp[i] + 0.5);
177         }
178     }
180     if (!form_error)
181         if (FORMULA_DEVIDE == 1) {
182             printf("Cycles:  %d*Nx + %d \n", form_result[0], form_result[1]);
183         }
184         else {
185             printf("Cycles:  %d/%d*Nx + %d \n", form_result[0], FORMULA_DEVIDE, form_result[1]);
186         }
187     else
188         printf("Cycles Formula Not Available\n");
191 /* ======================================================================= */
192 /* Prototypes for timing functions                                         */
193 /* ======================================================================= */
194 clock_t time_cn(int n)
196     clock_t t_start, t_stop;
198     /* ------------------------------------------------------------------- */
199     /* Measure the cycle count                                             */
200     /* ------------------------------------------------------------------- */
201     t_start = _itoll(TSCH, TSCL);
202     y_cn = DSPF_sp_dotprod_cn(ptr_x1, ptr_x2, n);
203     t_stop = _itoll(TSCH, TSCL);
205     return t_stop - t_start;
208 clock_t time_opt(int n)
210     clock_t t_start, t_stop;
211     
212     /* ------------------------------------------------------------------- */
213     /* Measure the cycle count                                             */
214     /* ------------------------------------------------------------------- */
215     t_start = _itoll(TSCH, TSCL);
216     y_opt = DSPF_sp_dotprod(ptr_x1, ptr_x2, n);
217     t_stop = _itoll(TSCH, TSCL);
219     return t_stop - t_start;
222 void UTIL_fillRandSP(float *ptr_x, int n, float factor)
224     float rand_midpoint = RAND_MAX / 2.0;
225     int i;
227     // fill array with floats in the range (-factor, factor)
228     for (i = 0; i < n; i++)
229         ptr_x[i] = ((rand() - rand_midpoint) / rand_midpoint) * factor;
231 /* ======================================================================= */
232 /*  End of file:  DSPF_sp_dotprod_d.c                                      */
233 /* ----------------------------------------------------------------------- */
234 /*            Copyright (c) 2011 Texas Instruments, Incorporated.          */
235 /*                           All Rights Reserved.                          */
236 /* ======================================================================= */