PRSDK-415 Add support to verify allocated PaRAM Id
[keystone-rtos/edma3_lld.git] / examples / edma3_driver / src / dma_poll_test.c
1 /*
2 * dma_poll_test.c
3 *
4 * Test case demonstrating the poll mode scenario. User has requested a data 
5 * transfer without giving any callback function. After programming and 
6 * enabling the channel, he uses different APIs (meant to be used in poll mode)
7 * to check the status of ongoing transfer. Interrupt will NOT occur in this 
8 * case.
9 *
10 * Copyright (C) 2009-2018 Texas Instruments Incorporated - http://www.ti.com/
11
12
13 *  Redistribution and use in source and binary forms, with or without 
14 *  modification, are permitted provided that the following conditions 
15 *  are met:
16 *
17 *    Redistributions of source code must retain the above copyright 
18 *    notice, this list of conditions and the following disclaimer.
19 *
20 *    Redistributions in binary form must reproduce the above copyright
21 *    notice, this list of conditions and the following disclaimer in the 
22 *    documentation and/or other materials provided with the   
23 *    distribution.
24 *
25 *    Neither the name of Texas Instruments Incorporated nor the names of
26 *    its contributors may be used to endorse or promote products derived
27 *    from this software without specific prior written permission.
28 *
29 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
30 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
31 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
33 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
34 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
35 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
38 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
39 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 */
43 #include "sample.h"
45 extern signed char   _srcBuff1[MAX_BUFFER_SIZE];
46 extern signed char   _dstBuff1[MAX_BUFFER_SIZE];
48 extern signed char *srcBuff1;
49 extern signed char *dstBuff1;
51 #define EDMA3_DRV_DMA_CHANNEL_USR_REQ     (10)
52 /**
53 *  \brief   EDMA3 mem-to-mem data copy test case, using a DMA channel.
54 *              This test case doesnot rely on the callback mechanism.
55 *              Instead, it Polls the IPR register to check the transfer
56 *              completion status.
57 *
58 *  \param  acnt        [IN]      Number of bytes in an array
59 *  \param  bcnt        [IN]      Number of arrays in a frame
60 *  \param  ccnt        [IN]      Number of frames in a block
61 *  \param  syncType    [IN]      Synchronization type (A/AB Sync)
62 *
63 *  \return  EDMA3_DRV_SOK or EDMA3_DRV Error Code
64 */
65 EDMA3_DRV_Result edma3_test_poll_mode(
66                                       EDMA3_DRV_Handle hEdma,
67                                       uint32_t acnt,
68                                       uint32_t bcnt,
69                                       uint32_t ccnt,
70                                       EDMA3_DRV_SyncType syncType)
71 {
72     EDMA3_DRV_Result result = EDMA3_DRV_SOK;
73     uint32_t chId = 0;
74     uint32_t tcc = 0;
75     int i;
76     uint32_t count;
77     uint32_t Istestpassed = 0u;
78     uint32_t numenabled = 0;
79     uint32_t BRCnt = 0;
80     int srcbidx = 0, desbidx = 0;
81     int srccidx = 0, descidx = 0;
84     srcBuff1 = (signed char*) GLOBAL_ADDR(_srcBuff1);
85     dstBuff1 = (signed char*) GLOBAL_ADDR(_dstBuff1);
87     /* Initalize source and destination buffers */
88     for (count = 0u; count < (acnt*bcnt*ccnt); count++)
89     {
90         srcBuff1[count] = (int)count+5;
91         /**
92         * No need to initialize the destination buffer as it is being invalidated.
93         dstBuff1[count] = initval;
94         */
95     }
98 #ifdef EDMA3_ENABLE_DCACHE
99     /*
100     * Note: These functions are required if the buffer is in DDR.
101     * For other cases, where buffer is NOT in DDR, user
102     * may or may not require the below functions.
103     */
104     /* Flush the Source Buffer */
105     if (result == EDMA3_DRV_SOK)
106     {
107         result = Edma3_CacheFlush((uint32_t)srcBuff1, (acnt*bcnt*ccnt));
108     }
110     /* Invalidate the Destination Buffer */
111     if (result == EDMA3_DRV_SOK)
112     {
113         result = Edma3_CacheInvalidate((uint32_t)dstBuff1, (acnt*bcnt*ccnt));
114     }
115 #endif  /* EDMA3_ENABLE_DCACHE */
118     /* Set B count reload as B count. */
119     BRCnt = bcnt;
121     /* Setting up the SRC/DES Index */
122     srcbidx = (int)acnt;
123     desbidx = (int)acnt;
125     if (syncType == EDMA3_DRV_SYNC_A)
126     {
127         /* A Sync Transfer Mode */
128         srccidx = (int)acnt;
129         descidx = (int)acnt;
130     }
131     else
132     {
133         /* AB Sync Transfer Mode */
134         srccidx = ((int)acnt * (int)bcnt);
135         descidx = ((int)acnt * (int)bcnt);
136     }
139     /* Setup for Channel 1*/
140     tcc = EDMA3_DRV_TCC_ANY;
141 #ifdef EDMA3_RES_USER_REQ
142     chId = EDMA3_DRV_DMA_CHANNEL_USR_REQ;
143 #else
144     chId = EDMA3_DRV_DMA_CHANNEL_ANY;
145 #endif
148     /* Request any DMA channel and any TCC */
149     if (result == EDMA3_DRV_SOK)
150     {
151         result = EDMA3_DRV_requestChannel (hEdma, &chId, &tcc,
152             (EDMA3_RM_EventQueue)0,
153             NULL, NULL);
154 #ifdef EDMA3_RES_USER_REQ
155         printf("\nReserved Channel ID Test\n");
156         printf ("The Requested Channel ID: %d \nThe allocated PARAM Id:%d\n",chId,EDMA3_DRV_getAllocatedPARAMId());
158         if (chId == EDMA3_DRV_getAllocatedPARAMId())
159         {
160             printf("The Requested Param ID is allocated for the given Channel\n");
161         }
162         printf("\n");
163 #endif
164     }
166     if (result == EDMA3_DRV_SOK)
167     {
168         result = EDMA3_DRV_setSrcParams (hEdma, chId, (uint32_t)(srcBuff1),
169             EDMA3_DRV_ADDR_MODE_INCR,
170             EDMA3_DRV_W8BIT);
171     }
173     if (result == EDMA3_DRV_SOK)
174     {
175         result = EDMA3_DRV_setDestParams (hEdma, chId, (uint32_t)(dstBuff1),
176             EDMA3_DRV_ADDR_MODE_INCR,
177             EDMA3_DRV_W8BIT);
178     }
180     if (result == EDMA3_DRV_SOK)
181     {
182         result = EDMA3_DRV_setSrcIndex (hEdma, chId, srcbidx, srccidx);
183     }
185     if (result == EDMA3_DRV_SOK)
186     {
187         result =  EDMA3_DRV_setDestIndex (hEdma, chId, desbidx, descidx);
188     }
190     if (result == EDMA3_DRV_SOK)
191     {
192         if (syncType == EDMA3_DRV_SYNC_A)
193         {
194             result = EDMA3_DRV_setTransferParams (hEdma, chId, acnt, bcnt, ccnt,
195                 BRCnt, EDMA3_DRV_SYNC_A);
196         }
197         else
198         {
199             result = EDMA3_DRV_setTransferParams (hEdma, chId, acnt, bcnt, ccnt,
200                 BRCnt, EDMA3_DRV_SYNC_AB);
201         }
202     }
204     if (result == EDMA3_DRV_SOK)
205     {
206         result = EDMA3_DRV_setOptField (hEdma, chId,
207             EDMA3_DRV_OPT_FIELD_TCINTEN, 1u);
208     }
210     if (result == EDMA3_DRV_SOK)
211     {
212         result = EDMA3_DRV_setOptField (hEdma, chId,
213             EDMA3_DRV_OPT_FIELD_ITCINTEN, 1u);
214     }
216     /*
217     * Since the transfer is going to happen in Manual mode of EDMA3
218     * operation, we have to 'Enable the Transfer' multiple times.
219     * Number of times depends upon the Mode (A/AB Sync)
220     * and the different counts.
221     */
222     if (result == EDMA3_DRV_SOK)
223     {
224         /*Need to activate next param*/
225         if (syncType == EDMA3_DRV_SYNC_A)
226         {
227             numenabled = bcnt * ccnt;
228         }
229         else
230         {
231             /* AB Sync Transfer Mode */
232             numenabled = ccnt;
233         }
236         for (i = 0; i < numenabled; i++)
237         {
238             /*
239             * Now enable the transfer as many times as calculated above.
240             */
241             result = EDMA3_DRV_enableTransfer (hEdma, chId,
242                 EDMA3_DRV_TRIG_MODE_MANUAL);
243             if (result != EDMA3_DRV_SOK)
244             {
245 #ifdef EDMA3_DRV_DEBUG
246                 EDMA3_DRV_PRINTF ("edma3_test_poll_mode: EDMA3_DRV_enableTransfer " \
247                     "Failed, error code: %d\r\n", result);
248 #endif  /* EDMA3_DRV_DEBUG */
249                 break;
250             }
253             /* Wait for the Completion Bit to be SET in the IPR/IPRH register. */
254             result = EDMA3_DRV_waitAndClearTcc (hEdma, tcc);
255             if (result != EDMA3_DRV_SOK)
256             {
257 #ifdef EDMA3_DRV_DEBUG
258                 EDMA3_DRV_PRINTF ("edma3_test_poll_mode: EDMA3_DRV_waitAndClearTcc " \
259                     "Failed, error code: %d\r\n", result);
260 #endif  /* EDMA3_DRV_DEBUG */
261                 break;
262             }
263         }
264     }
267     /* Match the Source and Destination Buffers. */
268     if (EDMA3_DRV_SOK == result)
269     {
270         for (i = 0; i < (acnt*bcnt*ccnt); i++)
271         {
272             if (srcBuff1[i] != dstBuff1[i])
273             {
274                 Istestpassed = 0u;
275 #ifdef EDMA3_DRV_DEBUG
276                 EDMA3_DRV_PRINTF("edma3_test_poll_mode: Data write-read matching" \
277                     "FAILED at i = %d\r\n", i);
278 #endif  /* EDMA3_DRV_DEBUG */
279                 break;
280             }
281         }
282         if (i == (acnt*bcnt*ccnt))
283         {
284             Istestpassed = 1u;
285         }
288         /* Free the previously allocated channel. */
289         result = EDMA3_DRV_freeChannel (hEdma, chId);
290         if (result != EDMA3_DRV_SOK)
291         {
292 #ifdef EDMA3_DRV_DEBUG
293             EDMA3_DRV_PRINTF("edma3_test_poll_mode: EDMA3_DRV_freeChannel() FAILED, " \
294                 "error code: %d\r\n", result);
295 #endif  /* EDMA3_DRV_DEBUG */
296         }
297     }
300     if(Istestpassed == 1u)
301     {
302 #ifdef EDMA3_DRV_DEBUG
303         EDMA3_DRV_PRINTF("edma3_test_poll_mode PASSED\r\n");
304 #endif  /* EDMA3_DRV_DEBUG */
305     }
306     else
307     {
308 #ifdef EDMA3_DRV_DEBUG
309         EDMA3_DRV_PRINTF("edma3_test_poll_mode FAILED\r\n");
310 #endif  /* EDMA3_DRV_DEBUG */
311         result = ((EDMA3_DRV_SOK == result) ?
312                     EDMA3_DATA_MISMATCH_ERROR : result);
313     }
314     return result;