PASDK-577:Add more comments to ASOT select devices function
authorFrank Livingston <frank-livingston@ti.com>
Wed, 9 May 2018 22:18:38 +0000 (17:18 -0500)
committerFrank Livingston <frank-livingston@ti.com>
Wed, 9 May 2018 22:18:38 +0000 (17:18 -0500)
pasdk/test_dsp/framework/audioStreamOutIo.c

index 0827ee0fcaf64924e6c353ebe0574cc745a44f40..a48f75826fc9c2fb64ef6bf04ebad7d1868cffd1 100644 (file)
@@ -74,22 +74,25 @@ Int asopSelectDevices(
     Ptr mcaspChanHandle;
     Aud_STATUS status;
 
-    if ((pOut->hIoBuff == NULL) || (pOut->hIoPhy == NULL) || (!d10Initialized)) {
+    if ((pOut->hIoBuff == NULL) || (pOut->hIoPhy == NULL) || (!d10Initialized)) 
+    {
         return ASOP_IO_ERR_IO_UNINIT;
     }
 
     // Deactivate currently active Output device
     if (pOut->hMcaspChan != NULL)
     {
+        // Delete McASP LLD channel
         status = mcaspDeleteChan(pOut->hMcaspChan);
         if (status != Aud_EOK)
         {
+            Log_info0("asopSelectDevices(): McASP channel deletion failed!\n");
             return ASOP_IO_ERR_MCASP_CFG;
         }
         
-        pOut->hMcaspChan = NULL;
-        pOut->pLldCfg->hMcaspChan = NULL;
-        pOut->pLldCfg = NULL;
+        pOut->hMcaspChan = NULL;            // reset active McASP LLD handle
+        pOut->pLldCfg->hMcaspChan = NULL;   // reset McASP LLD handle for active McASP LLD configuration
+        pOut->pLldCfg = NULL;               // reset pointer to active McASP LLD configuration
     }
 
     // Activate requested device
@@ -102,6 +105,7 @@ Int asopSelectDevices(
         pReqLldCfg = (mcaspLLDconfig *)pOutCfg->sio.pConfig;
         if (pReqLldCfg->hMcaspChan == NULL) 
         {
+            // Create McASP LLD channel
             mcaspChanHandle = NULL;
             status = mcasplldChanCreate(pReqLldCfg, &mcaspChanHandle);
             if (status != Aud_EOK) {
@@ -109,10 +113,13 @@ Int asopSelectDevices(
                 return ASOP_IO_ERR_MCASP_CFG;
             }
 
-            pReqLldCfg->hMcaspChan = mcaspChanHandle;
-            pOut->pLldCfg = pReqLldCfg;
-            pOut->hMcaspChan = pReqLldCfg->hMcaspChan;
-            pOut->stride = pReqLldCfg->mcaspChanParams->noOfSerRequested * pReqLldCfg->mcaspChanParams->noOfChannels;
+            pReqLldCfg->hMcaspChan = mcaspChanHandle;   // set McASP LLD handle for requested McASP LLD configuration
+            pOut->pLldCfg = pReqLldCfg;                 // set pointer to active McASP LLD configuration
+            pOut->hMcaspChan = pReqLldCfg->hMcaspChan;  // set active McASP LLD handle
+            
+            // configure stride according to selected McASP LLD configuration
+            pOut->stride = pReqLldCfg->mcaspChanParams->noOfSerRequested * 
+                pReqLldCfg->mcaspChanParams->noOfChannels;
         }
     }
     else
@@ -121,8 +128,8 @@ Int asopSelectDevices(
         // OutNone device selected
         //
         
-        pOut->hMcaspChan = NULL;
-        pOut->pLldCfg = NULL;
+        pOut->hMcaspChan = NULL;    // reset active McASP LLD handle
+        pOut->pLldCfg = NULL;       // reset pointer to active McASP LLD configuration
     }
 
     return ASOP_IO_SOK;