Merged BIOS MCSDK codebase for TX queue enhancement (SDOCM00112424)

Signed-off-by: Ivan Pang <i-pang@ti.com>

2 files changed, 314 insertions, 25 deletions

diff --git a/src/srio_drv.c b/src/srio_drv.c
index 737d11c..44a0e29 100644
--- a/src/srio_drv.c
+++ b/src/srio_drv.c
@@ -57,6 +57,7 @@
 #include <ti/drv/srio/srio_drv.h>

 

 /* CSL SRIO Functional Layer */

+#include <ti/csl/csl_qm_queue.h>

 #include <ti/csl/csl_srio.h>

 #include <ti/csl/csl_srioAux.h>

 #include <ti/csl/csl_srioAuxPhyLayer.h>

@@ -205,12 +206,23 @@ typedef struct Srio_DriverInst
      * @brief   SRIO CPPI handle returned by the CPPI library (in Srio_start)

      */

     Cppi_Handle         cppiHnd;

+

+    /**

+     * @brief   SRIO Receive channel handle returned by the CPPI library.

+     */

+    Cppi_ChHnd          rxChHnd;

+

     /**

      * @brief   SRIO Transmit channel handle returned by the CPPI library.

      */

     Cppi_ChHnd          txChHnd;

 

     /**

+     * @brief   SRIO Transmit channel Priority

+     */

+    uint8_t                             txChPriority;

+

+    /**

      * @brief   CPPI Flow Handle.

      */    

     Cppi_FlowHnd        flowHandle;

@@ -300,6 +312,17 @@ typedef struct Srio_DriverInst
     uint32_t            accInterrupts;

 

     /**

+     * @brief The base value for SRIO queue. Must be set by user to use Srio_setTxQueue().

+     */

+    uint16_t                    srioBase;

+

+    /**

+     * @brief The number of SRIO queues available. Must be set by user to use Srio_setTxQueue().

+     */

+    uint16_t                    srioCount;

+

+

+    /**

      * @brief   SRIO Driver configuration block passed by the driver user during 

      * initialization

      */

@@ -460,6 +483,27 @@ typedef struct Srio_Socket
      * overrun and there was no place to receive the new packet.

      */

     uint32_t                sockRxOverrun;

+

+    /**

+     * @brief   SRIO Transmit channel handle returned by the CPPI library. Sock open

+     * will define this equal to the txChHnd in ptr_SrioDrvInst. This is flexible to

+     * change if needed.

+     */

+    Cppi_ChHnd          txChHnd;

+

+    /**

+     * @brief   SRIO Transmit Queue. The queue is the well defined SRIO Tx queue and

+     * is used to send data packets. Sock open will define this equal to the txQueue

+     * in ptr_SrioDrvInst. This is flexible to change if needed.

+     */

+    Qmss_QueueHnd       txQueue;

+

+    /**

+     * @brief   SRIO Transmit channel Priority. This is the priority tied to the opened

+     * CPPI channel. Sock open will define this equal to the txChPriority in

+     * ptr_SrioDrvInst.

+     */

+    uint8_t                             txChPriority;

 }Srio_Socket;

 

 /** 

@@ -1273,6 +1317,134 @@ static int32_t Srio_initSockData (Srio_Socket* ptr_srioSocket)
 }

 

 /**

+ * @b Description

+ * @n

+ *              Utility function to change the txqueue binded to an

+ *              SRIO driver handle.

+ *

+ *  @param[in]  srioSock

+ *      SRIO Socket Handle

+ *  @param[in]  hTxQueue

+ *      TX Queue struct. Contains TX queue number and priority.

+ *

+ *  @retval

+ *      Success - 0

+ *  @retval

+ *      Error   - <0

+ */

+#pragma CODE_SECTION(Srio_setTxQueue, ".text:Srio_setTXQueue");

+int32_t Srio_setTxQueue (Srio_SockHandle srioSock, Srio_txQueueCfg *hTxQueue)

+{

+        Srio_DriverInst*        ptr_srioDrvInst;

+    Srio_Socket*        ptr_srioSocket;

+        Srio_txQueueCfg*                ptr_txQueue;

+        Cppi_TxChInitCfg    txCfg;

+        Cppi_Result             result;

+        uint16_t                        txQueueNum;

+    uint8_t                     txChPriority, isAllocated;

+

+    /* Get the socket information. */

+    ptr_srioSocket = (Srio_Socket *)srioSock;

+

+    /* Check for valid SRIO socket handle */

+    if (ptr_srioSocket == NULL)

+        return -1;

+

+        /* Local pointer to SRIO driver handle */

+    ptr_srioDrvInst = ptr_srioSocket->ptr_SrioDrvInst;

+

+    /* Check for valid SRIO driver handle */

+    if (ptr_srioDrvInst == NULL)

+        return -1;

+

+    /* Check for valid srioBase and srioCount */

+    if (!ptr_srioDrvInst->srioBase || !ptr_srioDrvInst->srioBase->srioCount)

+        return -1;

+

+    /* Local pointer to the new TX queue struct */

+    ptr_txQueue = hTxQueue;

+

+    /* Check for valid TX queue info */

+    if (ptr_txQueue == NULL)

+        return -1;

+

+    /* Local copy of the new queue's information */

+    txQueueNum = ptr_txQueue->txQueueNum;

+    txChPriority = ptr_txQueue->txChPriority;

+

+    /* Check for valid queue number */

+    if ( (txQueueNum < ptr_srioDrvInst->srioBase) || (txQueueNum > (ptr_srioDrvInst->srioBase + ptr_srioDrvInst->srioCount)) )

+        return -1;

+

+    /* If the socket is already using the driver's queue, do not close it */

+    if ((uint16_t)ptr_srioDrvInst->txQueue != (uint16_t)ptr_srioSocket->txQueue)

+    {

+                /* Close the old queue */

+                if (Qmss_queueClose (ptr_srioSocket->txQueue) == QMSS_INVALID_PARAM)

+                {

+                        Srio_osalLog ("Error: Closing previous queue %d failed\n", (int32_t) ptr_srioSocket->txQueue);

+                        return -1;

+                }

+

+                /* Close the old CPPI channel */

+                result = Cppi_channelClose (ptr_srioSocket->txChHnd);

+                if ( (result == CPPI_INVALID_PARAM) || (result == CPPI_CHANNEL_NOT_OPEN) )

+                {

+                        Srio_osalLog ("Error: Closing previous CPPI channel %d failed\n", (int32_t) ptr_srioSocket->txChHnd);

+                        return -1;

+                }

+    }

+

+    /* If the update request is the driver instance's, simply copy the information over */

+    if (Qmss_getQIDFromHandle(ptr_srioDrvInst->txQueue) == ptr_txQueue->txQueueNum)

+    {

+        ptr_srioSocket->txQueue = ptr_srioDrvInst->txQueue;

+        ptr_srioDrvInst->txChHnd = ptr_srioDrvInst->txChHnd;

+        ptr_srioDrvInst->txChPriority = ptr_srioDrvInst->txChPriority;

+        return 0;

+    }

+

+        /* Open the new SRIO queue. */

+    ptr_srioSocket->txQueue = Qmss_queueOpen (Qmss_QueueType_SRIO_QUEUE , txQueueNum, &isAllocated);

+        if (ptr_srioSocket->txQueue < 0)

+        {

+                Srio_osalLog ("Error: SRIO Transmit Queue failed to open\n");

+                return -1;

+        }

+

+        /* Open the new CPPI channel */

+        txCfg.channelNum        = Qmss_getQIDFromHandle(ptr_srioSocket->txQueue) - ptr_srioDrvInst->srioBase;

+    txCfg.priority              = txChPriority;

+    txCfg.txEnable              = Cppi_ChState_CHANNEL_DISABLE;

+    txCfg.filterEPIB    = 0;

+    txCfg.filterPS              = 0;

+    txCfg.aifMonoMode   = 0;

+    ptr_srioSocket->txChHnd = Cppi_txChannelOpen (gSRIODriverMCB.cppiHnd, &txCfg, &isAllocated);

+    if (ptr_srioSocket->txChHnd == NULL)

+    {

+        Srio_osalLog ("Error: Opening SRIO Tx channel %d failed\n", txCfg.channelNum);

+        return -1;

+    }

+

+    /* Record the txChPriority */

+        ptr_srioDrvInst->txChPriority = txChPriority;

+

+    /* Check if channel is already in use */

+    if (isAllocated > 1)

+        return 0;

+

+    /* Else, enable the channel before returning */

+    if (Cppi_channelEnable (ptr_srioSocket->txChHnd) < 0)

+    {

+        Srio_osalLog ("Error: Enabling SRIO TX Channel %d failed\n", txCfg.channelNum);

+        return -1;

+    }

+

+        // TX queue updated

+        return 0;

+}

+

+/**

  *  @b Description

  *  @n  

  *      This is the SRIO Driver Initialization API which needs to be 

@@ -2233,6 +2405,28 @@ Srio_DrvHandle Srio_start (Srio_DrvConfig* ptr_cfg)
     /* Invalidate the Cache Contents. */

     Srio_osalBeginMemAccess(&gSRIODriverMCB, sizeof(gSRIODriverMCB));

 

+    /* Save SRIO queue base if specified */

+    ptr_srioDrvInst->srioBase = ptr_srioDrvInst->cfg.srioQueueBase;

+

+    /* Save SRIO queue count if specified */

+    ptr_srioDrvInst->srioCount = ptr_srioDrvInst->cfg.srioQueueCount;

+

+    /* Open the SRIO Transmit Queue; this should lie within the SRIO queue region. */

+    if (ptr_srioDrvInst->cfg.bAppManagedConfig == 1)

+    {

+        txQueueNum = ptr_srioDrvInst->cfg.u.appManagedCfg.txQueueNum;

+    }

+    else

+    {

+        txQueueNum = QMSS_PARAM_NOT_SPECIFIED;

+    }

+    ptr_srioDrvInst->txQueue = Qmss_queueOpen (Qmss_QueueType_SRIO_QUEUE , txQueueNum, &isAllocated);

+    if (ptr_srioDrvInst->txQueue < 0)

+    {

+        Srio_osalLog ("Error: SRIO Transmit Queue failed to open\n");

+        return NULL;

+    }

+

     /* Enable the SRIO Transmit channel for each driver instance. */

     {

         Cppi_TxChInitCfg    txCfg;

@@ -2249,11 +2443,14 @@ Srio_DrvHandle Srio_start (Srio_DrvConfig* ptr_cfg)
             txCfg.priority = 0;

         }

 

+        /* Save the priority used to open TX channel */

+        ptr_srioDrvInst->txChPriority = txCfg.priority;

+

         txCfg.txEnable     = Cppi_ChState_CHANNEL_DISABLE;

         txCfg.filterEPIB   = 0;

         txCfg.filterPS     = 0;

         txCfg.aifMonoMode  = 0;

-        ptr_srioDrvInst->txChHnd = Cppi_txChannelOpen (ptr_srioDrvInst->cppiHnd, &txCfg, &isAllocated);

+        ptr_srioDrvInst->txChHnd = Cppi_txChannelOpen (gSRIODriverMCB.cppiHnd, &txCfg, &isAllocated);

         if (ptr_srioDrvInst->txChHnd == NULL)

         {

             Srio_osalLog ("Error: Opening SRIO Tx channel %d failed\n", txCfg.channelNum);

@@ -2261,22 +2458,6 @@ Srio_DrvHandle Srio_start (Srio_DrvConfig* ptr_cfg)
         }

     }

 

-    /* Open the SRIO Transmit Queue; this should lie within the SRIO queue region. */

-    if (ptr_srioDrvInst->cfg.bAppManagedConfig == 1)

-    {

-        txQueueNum = ptr_srioDrvInst->cfg.u.appManagedCfg.txQueueNum;

-    }

-    else

-    {

-        txQueueNum = QMSS_PARAM_NOT_SPECIFIED;

-    }

-    ptr_srioDrvInst->txQueue = Qmss_queueOpen (Qmss_QueueType_SRIO_QUEUE , txQueueNum, &isAllocated);

-    if (ptr_srioDrvInst->txQueue < 0)

-    {

-        Srio_osalLog ("Error: SRIO Transmit Queue failed to open\n");

-        return NULL;

-    }

-

     /* CRITICAL Section Start: */

     multiCoreCSInfo  = Srio_osalEnterMultipleCoreCriticalSection();

 

@@ -2325,7 +2506,7 @@ Srio_DrvHandle Srio_start (Srio_DrvConfig* ptr_cfg)
  *      Error   - <0

  */

 #ifdef _TMS320C6X

-#pragma CODE_SECTION(Srio_start, ".text:Srio_start");

+#pragma CODE_SECTION(Srio_stop, ".text:Srio_stop");

 #endif

 int32_t Srio_stop (Srio_DrvHandle hSrio)

 {

@@ -2542,6 +2723,11 @@ Srio_SockHandle Srio_sockOpen
         ptr_srioSocket->ptr_SrioDrvInst   = ptr_SrioDrvInst;

         ptr_srioSocket->maxPendingPackets = DEFAULT_SRIO_MAX_PENDING_PACKETS;

 

+        /* Initialize the txQueue, txChHnd, and txChPriority to the driver instance's */

+        ptr_srioSocket->txQueue                 = ptr_SrioDrvInst->txQueue;

+        ptr_srioSocket->txChHnd                 = ptr_SrioDrvInst->txChHnd;

+        ptr_srioSocket->txChPriority    = ptr_SrioDrvInst->txChPriority;

+

         /* Remember the allocated index. */

         ptr_srioSocket->sockIndex       = sockNum;

 

@@ -2584,6 +2770,12 @@ Srio_SockHandle Srio_sockOpen
             errorFlag = 0;

         }

     }

+    else {

+        /* Initialize the txQueue, txChHnd, and txChPriority to the driver instance's */

+        ptr_srioSocket->txQueue                 = ptr_SrioDrvInst->txQueue;

+        ptr_srioSocket->txChHnd                 = ptr_SrioDrvInst->txChHnd;

+        ptr_srioSocket->txChPriority    = ptr_SrioDrvInst->txChPriority;

+    }

 

     /* Are there any errors in getting a socket? */

     if (errorFlag == 0)

@@ -3217,7 +3409,7 @@ int32_t Srio_sockBind_DIO (Srio_SockHandle srioSock, Srio_SockBindAddrInfo* ptr_
     }

 #endif

 

-    if ((mappingNum >= 0) && (mappingNum < NUM_SRIO_TYPE9_TYPE11_SOCKETS))

+    if ((mappingNum >= 0) && (mappingNum < NUM_DIO_SOCKETS))

     {

         /* Remember the index. */

         ptr_srioSocket->mapIndex = mappingNum;

@@ -3236,7 +3428,7 @@ int32_t Srio_sockBind_DIO (Srio_SockHandle srioSock, Srio_SockBindAddrInfo* ptr_
     Srio_osalExitMultipleCoreCriticalSection (multiCoreCSInfo);

 

     /* Did we get a free entry? If not then the binding failed. */

-    if ((mappingNum < 0) || (mappingNum >= NUM_SRIO_TYPE9_TYPE11_SOCKETS))

+    if ((mappingNum < 0) || (mappingNum >= NUM_DIO_SOCKETS))

     {

         return -1;

     }

@@ -3519,7 +3711,7 @@ int32_t Srio_sockSend_TYPE11
                                         ptr_srioDrvInst->txDescSize);

 

         /* Push the transmit buffer descriptor into the Transmit Queue. */

-        Qmss_queuePushDescSize (ptr_srioDrvInst->txQueue, (uint32_t*)hDrvBuffer, ptr_srioDrvInst->txDescSize);

+        Qmss_queuePushDescSize (ptr_srioSocket->txQueue, (uint32_t*)hDrvBuffer, ptr_srioDrvInst->txDescSize);

     }

     else

     {

@@ -3536,7 +3728,7 @@ int32_t Srio_sockSend_TYPE11
         Srio_osalEndDescriptorAccess ((Srio_DrvHandle)ptr_srioDrvInst, (void *)hDrvBuffer, numBytes);

 

         /* Push the buffer descriptor into the transmit queue.*/

-        Qmss_queuePushDescSize (ptr_srioDrvInst->txQueue, (uint32_t*)hDrvBuffer, numBytes);

+        Qmss_queuePushDescSize (ptr_srioSocket->txQueue, (uint32_t*)hDrvBuffer, numBytes);

     }

 

     /* The packet has been successfully transmitted. */

@@ -3647,7 +3839,7 @@ int32_t Srio_sockSend_TYPE9
                                        ptr_srioDrvInst->txDescSize);

 

         /* Push the transmit buffer descriptor into the Transmit Queue. */

-        Qmss_queuePushDescSize (ptr_srioDrvInst->txQueue, (uint32_t*)hDrvBuffer, ptr_srioDrvInst->txDescSize);

+        Qmss_queuePushDescSize (ptr_srioSocket->txQueue, (uint32_t*)hDrvBuffer, ptr_srioDrvInst->txDescSize);

     }

     else

     {

@@ -3664,7 +3856,7 @@ int32_t Srio_sockSend_TYPE9
         Srio_osalEndDescriptorAccess ((Srio_DrvHandle)ptr_srioDrvInst, (void *)hDrvBuffer, numBytes);

 

         /* Push the buffer descriptor into the transmit queue.*/

-        Qmss_queuePushDescSize (ptr_srioDrvInst->txQueue, (uint32_t*)hDrvBuffer, numBytes);

+        Qmss_queuePushDescSize (ptr_srioSocket->txQueue, (uint32_t*)hDrvBuffer, numBytes);

     }

 

     /* The packet has been successfully transmitted. */

@@ -4199,6 +4391,23 @@ int32_t Srio_setSockOpt
             /* Socket has been registered successfully. */

             return 0;

         }

+        case Srio_Opt_UPDATE_TXQUEUE:

+        {

+                /* If it is a DIO socket, do nothing and return */

+                if (ptr_srioSocket->type == Srio_SocketType_DIO)

+                        return 0;

+

+            /* This option takes a 'Srio_txQueue' configuration data */

+            if (optlen == sizeof(Srio_txQueueCfg))

+            {

+                if (Srio_setTxQueue(srioSock, (Srio_txQueueCfg *) optval) != 0 )

+                        return -1;

+

+                /* TX queue updated successfully. */

+                return 0;

+            }

+            break;

+        }

         default: /* fall through and return error */

             break;

 

@@ -4323,6 +4532,20 @@ int32_t Srio_getSockOpt
             /* Option has been successfully handled. */

             return 0; 

         }

+        case Srio_Opt_UPDATE_TXQUEUE:

+        {

+            /* This option takes a 'Srio_txQueue' configuration data */

+            if (optlen == sizeof(Srio_txQueueCfg))

+            {

+                /* return the socket's TX queue number */

+                ((Srio_txQueueCfg *)optval)->txQueueNum = Qmss_getQIDFromHandle(ptr_srioSocket->txQueue);

+                ((Srio_txQueueCfg *)optval)->txChPriority = ptr_srioSocket->txChPriority;

+

+                /* Optval updated successfully. */

+                return 0;

+            }

+            break;

+        }

         default:

             break; /* Fall through and return error */

     }

@@ -4450,6 +4673,15 @@ int32_t Srio_sockClose_TYPE11 (Srio_SockHandle srioSock)
     Srio_osalExitMultipleCoreCriticalSection (csInfo);

 #endif

 

+    /* If the socket instance's queue differ from the driver instance, close it */

+        if ((uint16_t)ptr_SrioDrvInst->txQueue != (uint16_t)ptr_srioSocket->txQueue)

+        {

+                if (Qmss_queueClose (ptr_srioSocket->txQueue) < 0)

+                        return -1;

+                if (Cppi_channelClose (ptr_srioSocket->txChHnd) < 0)

+                        return -1;

+        }

+

     /* The socket memory can now be cleaned up. */

     Srio_osalFree(ptr_srioSocket, sizeof(Srio_Socket));

     return error;

@@ -4573,6 +4805,15 @@ int32_t Srio_sockClose_TYPE9 (Srio_SockHandle srioSock)
     Srio_osalExitMultipleCoreCriticalSection (csInfo);

 #endif

 

+    /* If the socket instance's queue differ from the driver instance, close it */

+        if ((uint16_t)ptr_SrioDrvInst->txQueue != (uint16_t)ptr_srioSocket->txQueue)

+        {

+                if (Qmss_queueClose (ptr_srioSocket->txQueue) < 0)

+                        return -1;

+                if (Cppi_channelClose (ptr_srioSocket->txChHnd) < 0)

+                        return -1;

+        }

+

     /* The socket memory can now be cleaned up. */

     Srio_osalFree(ptr_srioSocket, sizeof(Srio_Socket));

     return error;

diff --git a/srio_drv.h b/srio_drv.h
index 8b98ee9..a582640 100644
--- a/srio_drv.h
+++ b/srio_drv.h
@@ -506,6 +506,20 @@ typedef struct Srio_DrvConfig
     uint16_t            bAppManagedConfig;

 

     /**

+     * @brief   This value specifies the queue base for the SRIO driver

+     * to use. If left unassigned, SRIO driver will default to

+     * SRIO_QUEUE_BASE in srio_drv.c. This default value is 672.

+     */

+    uint16_t                    srioQueueBase;

+

+    /**

+     * @brief   This value specifies the number of SRIO queue in the

+     * device. If left unassigned, SRIO driver will default to

+     * SRIO_QUEUE_COUNT in srio_drv.c. This default value is 16.

+     */

+    uint16_t                    srioQueueCount;

+

+    /**

      * @brief    Union structure for the driver configuration.

      */

     Srio_DrvConfigType  u;

@@ -808,6 +822,29 @@ typedef struct Srio_DioAddrInfo
 

 /** 

  * @brief 

+ *  SRIO Socket TX Queue Information

+ *

+ * @details

+ *  The structure describes the transmission queue to use and allows

+ *  for updating the socket with Srio_setSockOpt.

+ */

+typedef struct Srio_txQueue

+{

+    /**

+     * @brief   16b number for the queue to open. This number should be based

+     * on a device-specific QMSS_SRIO_QUEUE_BASE, with a maximum offset amount

+     * of QMSS_MAX_SRIO_QUEUE.

+     */

+    uint16_t    txQueueNum;

+

+    /**

+     * @brief   8b number to describe the queue priority

+     */

+    uint8_t             txChPriority;

+}Srio_txQueueCfg;

+

+/**

+ * @brief

  *  SRIO Socket Bind Information

  *

  * @details

@@ -880,7 +917,18 @@ typedef enum Srio_Opt
      * configuration data to return the completion code. A value of 0 indicates 

      * transfer was complete with no errors. All other values indicate an error.

      */

-    Srio_Opt_DIO_READ_SOCK_COMP_CODE = 0x4

+    Srio_Opt_DIO_READ_SOCK_COMP_CODE = 0x4,

+

+    /**

+     * @brief   This command is for changing the txQueue and its associated CPPI

+     * txChHnd on a given socket instance. The txQueue and txChHnd default when

+     * opening the socket comes from the driver instance. This option allows for

+     * changing the transmit to a different queue by opening the new queue and

+     * CPPI channel base on the txQueueNum. Queue close and channel close will only

+     * be called if the updated queue number is different from the txQueue in the

+     * driver instance.

+     */

+    Srio_Opt_UPDATE_TXQUEUE = 0x5

 

 }Srio_Opt;