954c0791499792c2c2fe9f8081ee675dd2119e4c
[keystone-rtos/ibl.git] / src / device / c661x / c661x.c
1 /*
2  *
3  * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/ 
4  * 
5  * 
6  *  Redistribution and use in source and binary forms, with or without 
7  *  modification, are permitted provided that the following conditions 
8  *  are met:
9  *
10  *    Redistributions of source code must retain the above copyright 
11  *    notice, this list of conditions and the following disclaimer.
12  *
13  *    Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the 
15  *    documentation and/or other materials provided with the   
16  *    distribution.
17  *
18  *    Neither the name of Texas Instruments Incorporated nor the names of
19  *    its contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
26  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
27  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
28  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
31  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
32  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34 */
38 /************************************************************************************
39  * FILE PURPOSE: C661x Device Specific functions
40  ************************************************************************************
41  * FILE NAME: c661x.c
42  *
43  * DESCRIPTION: Implements the device specific functions for the IBL
44  *
45  * @file c661x.c
46  *
47  * @brief
48  *  This file implements the device specific functions for the IBL
49  *
50  ************************************************************************************/
51 #include "ibl.h"
52 #include "iblloc.h"
53 #include "iblcfg.h"
54 #include "device.h"
55 #include "pllapi.h"
56 #include "emif31api.h"
57 #include "pscapi.h"
58 #include "gpio.h"
59 #include "qm_api.h"
60 #include "cpdma_api.h"
61 #include "pa_api.h"
62 #include "serdes_api.h"
63 #include "net.h"
64 #include <string.h>
66 extern cregister unsigned int DNUM;
69 /**
70  *  @brief Determine if an address is local
71  *
72  *  @details
73  *    Examines an input address to determine if it is a local address. Using the largest
74  *    L2 size on the 6616.
75  */
76 bool address_is_local (Uint32 addr)
77 {
78     /* L2 */
79     if ((addr >= 0x00800000) && (addr < 0x00900000))
80         return (TRUE);
82     /* L1P */
83     if ((addr >= 0x00e00000) && (addr < 0x00e08000))
84         return (TRUE);
86     /* L2D */
87     if ((addr >= 0x00f00000) && (addr < 0x00f08000))
88         return (TRUE);
90     return (FALSE);
92 }
95 /**
96  * @brief  Convert a local l1d, l1p or l2 address to a global address
97  *
98  * @details
99  *  The global address is formed. If the address is not local then
100  *  the input address is returned
101  */
102 Uint32 deviceLocalAddrToGlobal (Uint32 addr)
105     if (address_is_local (addr))
106         addr = (1 << 28) | (DNUM << 24) | addr;
108     return (addr);
111         
112         
113 /**
114  * @brief
115  *   Enable the DDR
116  *
117  * @details
118  *   The DDR controller on the c661x is an emif 4.0. The controller is
119  *   initialized directly with the supplied values
120  */
121 void deviceDdrConfig (void)
123     /* The emif registers must be made visible. MPAX mapping 2 is used */
124     DEVICE_REG_XMPAX_L(2) =  0x10000000 | 0xf6;     /* replacement addr + perm*/
125     DEVICE_REG_XMPAX_H(2) =  0x2100000B;         /* base addr + seg size (64KB)*/       
127     if (ibl.ddrConfig.configDdr != 0)
128         hwEmif4p0Enable (&ibl.ddrConfig.uEmif.emif4p0);
131         
133 /**
134  *  @brief Power up a peripheral
135  *
136  *  @details
137  *    Boot peripherals are powered up
138  */
139 int32 devicePowerPeriph (int32 modNum)
141     /* If the input value is < 0 there is nothing to power up */
142     if (modNum < 0)
143         return (0);
146     if (modNum >= TARGET_PWR_MAX_MOD)
147         return (-1);
149     return ((int32)pscEnableModule(modNum));
150         
154 /**
155  *  @brief  Enable the pass through version of the nand controller
156  *
157  *  @details  On the evm the nand controller is enabled by setting 
158  *            gpio 14 high
159  */
160 #ifndef EXCLUDE_NAND
161 int32 deviceConfigureForNand(void)
163     return (0);
167 /**
168  *  @brief
169  *      Return the base memory address for NAND in a given chip select space
170  */
171 uint32 deviceNandMemBase (int32 cs)
173     switch (cs)  {
175         case 2:  return (TARGET_MEM_NAND_CS_2);
177         case 3:  return (TARGET_MEM_NAND_CS_3);
179         case 4:  return (TARGET_MEM_NAND_CS_4);
181         case 5:  return (TARGET_MEM_NAND_CS_5);
183     }
185     return (0xffffffff);
189 /**
190  *  @brief
191  *      Return the PSC number for NAND. Only 6618 has NAND
192  */
193 Int32 deviceNandPscNum (void)
195     Uint32 v;
197     v = *((Uint32 *)DEVICE_JTAG_ID_REG);
198     if (v == DEVICE_C6618_JTAG_ID_VAL)
199         return (TARGET_PWR_NAND_C6618);
201     /* Return a negative number to indicate no PSC module is associated with NAND */
202     return (-1);
207 #endif
210 /**
211  *  @brief
212  *    The e-fuse mac address is loaded
213  */
214 void deviceLoadDefaultEthAddress (uint8 *maddr)
216     uint32 macA, macB;
218     /* Read the e-fuse mac address */
219     macA = *((uint32 *)0x2620110);
220     macB = *((uint32 *)0x2620114);
222     maddr[0] = (macB >>  8) & 0xff;
223     maddr[1] = (macB >>  0) & 0xff;
224     maddr[2] = (macA >> 24) & 0xff;
225     maddr[3] = (macA >> 16) & 0xff;
226     maddr[4] = (macA >>  8) & 0xff;
227     maddr[5] = (macA >>  0) & 0xff;
231 /**
232  *  @brief
233  *    Compile time queue manager information
234  */
235 #define DEVICE_NUM_RX_CPPIS     1
236 #define DEVICE_NUM_TX_CPPIS     1
237 #define DEVICE_NUM_CPPIS        (DEVICE_NUM_RX_CPPIS + DEVICE_NUM_TX_CPPIS)
239 /* The linking RAM */
240 #pragma DATA_SECTION(qm_linkram_buf, ".linkram")
241 #pragma DATA_ALIGN(qm_linkram_buf, 16)
242 uint8 qm_linkram_buf[DEVICE_NUM_CPPIS * 2 * (sizeof(uint32)/sizeof(uint8))];
245 /* The CPPI RAM */
246 #pragma DATA_SECTION(qm_cppi_buf, ".cppi")
247 #pragma DATA_ALIGN(qm_cppi_buf, 16)
248 uint8 qm_cppi_buf[QM_DESC_SIZE_BYTES * DEVICE_NUM_CPPIS];
251 /* The rx data buffers */
252 #pragma DATA_SECTION(qm_buffer, ".mac_buffer")
253 #pragma DATA_ALIGN(qm_buffer, 16)
254 uint8 qm_buffer[MAX_SIZE_STREAM_BUFFER * DEVICE_NUM_RX_CPPIS];
256 const qmConfig_t qmConfig =  {
257     (UINT32) qm_linkram_buf,
258     sizeof  (qm_cppi_buf),
259     (UINT32) qm_cppi_buf,
261     DEVICE_NUM_CPPIS,
262     DEVICE_QM_FREE_Q
263 };
265 /**
266  *  @brief
267  *      Return the queue manager memory configuration information
268  */
269 void *targetGetQmConfig (void)
271     return ((void *)&qmConfig);
274 /**
275  *  @brief
276  *      Attach a packet buffer to each descriptor and push onto the linked buffer queue
277  */
278 void targetInitQs (void)
280     int32 i;
281     qmHostDesc_t *hd;
283     for (i = 0; i < DEVICE_NUM_RX_CPPIS; i++)  {
285         hd                = hwQmQueuePop (DEVICE_QM_FREE_Q);
286         hd->buffLen       = sizeof (qm_buffer) / DEVICE_NUM_CPPIS;
287         hd->buffPtr       = (UINT32) &(qm_buffer[MAX_SIZE_STREAM_BUFFER * i]);
288         hd->nextBDPtr     = 0;
289         hd->origBufferLen = MAX_SIZE_STREAM_BUFFER;
290         hd->origBuffPtr   = hd->buffPtr;
292         hwQmQueuePush (hd, DEVICE_QM_LNK_BUF_Q, QM_DESC_SIZE_BYTES);
294     }
297     for (i = 0; i < DEVICE_NUM_TX_CPPIS; i++)  {
299         hd                = hwQmQueuePop (DEVICE_QM_FREE_Q);
300         hd->buffLen       = 0;
301         hd->buffPtr       = 0;
302         hd->nextBDPtr     = 0;
303         hd->origBufferLen = 0;
304         hd->origBuffPtr   = 0;
306         hwQmQueuePush (hd, DEVICE_QM_TX_Q, QM_DESC_SIZE_BYTES);
308     }
315 const cpdmaRxCfg_t cpdmaEthRxCfg =  {
317     DEVICE_PA_CDMA_RX_CHAN_CFG_BASE,    /* Base address of PA CPDMA rx config registers */
318     DEVICE_PA_CDMA_RX_NUM_CHANNELS,     /* Number of rx channels */
320     DEVICE_PA_CDMA_RX_FLOW_CFG_BASE,    /* Base address of PA CPDMA rx flow registers */
321     DEVICE_PA_CDMA_RX_NUM_FLOWS,        /* Number of rx flows */
323     0,                                  /* Queue manager for descriptor / buffer for received packets */
324     DEVICE_QM_LNK_BUF_Q,                /* Queue of descriptors /buffers for received packets */
326     0,                                  /* Queue manager for received packets */
327     DEVICE_QM_RCV_Q,                    /* Queue for received packets (overridden by PA)  */
329     DEVICE_RX_CDMA_TIMEOUT_COUNT        /* Teardown maximum loop wait */
330 };
333 /**
334  *  @brief
335  *      Return the cpdma configuration information
336  */
337 void *targetGetCpdmaRxConfig (void)
339     return ((void *)&cpdmaEthRxCfg);
344 const cpdmaTxCfg_t cpdmaEthTxCfg = {
346     DEVICE_PA_CDMA_GLOBAL_CFG_BASE,     /* Base address of global config registers      */
347     DEVICE_PA_CDMA_TX_CHAN_CFG_BASE,    /* Base address of PA CPDMA tx config registers */
348     DEVICE_PA_CDMA_TX_NUM_CHANNELS      /* Number of tx channels */
350 };
353 /**
354  *  @brief
355  *      return the tx cpdma configuration information
356  */
357 void *targetGetCpdmaTxConfig (void)
359     return ((void *)&cpdmaEthTxCfg);
363 /**
364  *  @brief
365  *     Configure the PA
366  */
367 void targetPaConfig (uint8 *macAddr)
369     paConfig_t     paCfg;
370     qmHostDesc_t  *hd;
371     SINT16         ret;
373     /* Filter everything except the desired mac address and the broadcast mac */
374     paCfg.mac0ms = ((uint32)macAddr[0] << 24) | ((uint32)macAddr[1] << 16) | ((uint32)macAddr[2] << 8) | (uint32)(macAddr[3]);
375     paCfg.mac0ls = ((uint32)macAddr[4] << 24) | ((uint32)macAddr[5] << 16);
377     paCfg.mac1ms = 0xffffffff;
378     paCfg.mac1ls = 0xffff0000;
380     paCfg.rxQnum = DEVICE_QM_RCV_Q;
382     /* Form the configuration command in a buffer linked to a descriptor */
383     hd = hwQmQueuePop (DEVICE_QM_LNK_BUF_Q);
384     paCfg.cmdBuf = (uint8 *)hd->origBuffPtr;
386     ret = hwPaEnable (&paCfg);
387     if (ret != 0)  {
388         iblStatus.iblFail = ibl_FAIL_CODE_PA;
389         return;
390     }
393     /* Send the command to the PA through the QM */
394     hd->softwareInfo0 = PA_MAGIC_ID;
395     hd->buffLen = 16;
396     QM_DESC_DESCINFO_SET_PKT_LEN(hd->descInfo, 16);
398     /* Set the return Queue */
399     QM_DESC_PINFO_SET_QM    (hd->packetInfo, 0);
400     QM_DESC_PINFO_SET_QUEUE (hd->packetInfo, DEVICE_QM_LNK_BUF_Q);
402     hwQmQueuePush (hd, DEVICE_QM_PA_CFG_Q, QM_DESC_SIZE_BYTES);
407 /**
408  *  @brief
409  *      Chip level SGMII serdes configuration
410  *
411  *  @details
412  *      Both lanes are always setup, regardless of the port value
413  */
414 void targetSgmiiSerdesConfig (int32 port, void *viblSgmii)
416   serdesConfig_t scfg;
417   iblSgmii_t     *sgmii = (iblSgmii_t *)viblSgmii;
419   scfg.cfg      = sgmii->auxConfig;
420   scfg.nLanes   = 2;
421   scfg.rxCfg[0] = scfg.rxCfg[1] = sgmii->rxConfig;
422   scfg.txCfg[0] = scfg.txCfg[1] = sgmii->txConfig;
424   hwSerdesConfig (TARGET_SGMII_SERDES_BASE, &scfg);
426   hwSerdesWaitLock (TARGET_SGMII_SERDES_STATUS_BASE);
431 Int32 targetMacSend (void *vptr_device, Uint8* buffer, int num_bytes) 
433     qmHostDesc_t   *hd;
434     NET_DRV_DEVICE *ptr_device = (NET_DRV_DEVICE *)vptr_device;
435     int             i;
438     for (i = 0, hd = NULL; hd == NULL; i++, chipDelay32 (1000)) 
439         hd = hwQmQueuePop (DEVICE_QM_TX_Q);
440     
441     if (hd == NULL)
442         return (-1);
444     QM_DESC_DESCINFO_SET_PKT_LEN(hd->descInfo, num_bytes);
446     hd->buffLen       = num_bytes;
447     hd->origBufferLen = num_bytes;
449     hd->buffPtr     = deviceLocalAddrToGlobal((UINT32)buffer);
450     hd->origBuffPtr = deviceLocalAddrToGlobal((UINT32)buffer);
452     
453     /* Return the descriptor back to the transmit queue */
454     QM_DESC_PINFO_SET_QM(hd->packetInfo, 0);
455     QM_DESC_PINFO_SET_QUEUE(hd->packetInfo, DEVICE_QM_TX_Q);
457     hwQmQueuePush (hd, DEVICE_QM_ETH_TX_Q, QM_DESC_SIZE_BYTES);
459     return (0);
464 Int32 targetMacRcv (void *vptr_device, UINT8 *buffer)
466     Int32           pktSizeBytes; 
467     qmHostDesc_t   *hd;
468     NET_DRV_DEVICE *ptr_device = (NET_DRV_DEVICE *)vptr_device;
470     hd = hwQmQueuePop (DEVICE_QM_RCV_Q);
471     if (hd == NULL)
472         return (0);
474     pktSizeBytes = QM_DESC_DESCINFO_GET_PKT_LEN(hd->descInfo);
475     iblMemcpy ((void *)buffer, (void *)hd->buffPtr, pktSizeBytes);
477     hd->buffLen = hd->origBufferLen;
478     hd->buffPtr = hd->origBuffPtr;
480     hwQmQueuePush (hd, DEVICE_QM_LNK_BUF_Q, QM_DESC_SIZE_BYTES);
482     return (pktSizeBytes);
486 void targetFreeQs (void)
488     qmHostDesc_t   *hd;
490     do  {
492         hd = hwQmQueuePop (DEVICE_QM_FREE_Q);
494     } while (hd != NULL);
496     do  {
498         hd = hwQmQueuePop (DEVICE_QM_LNK_BUF_Q);
500     } while (hd != NULL);
501     
502     do  {
504         hd = hwQmQueuePop (DEVICE_QM_RCV_Q);
506     } while (hd != NULL);
507     
508     do  {
510         hd = hwQmQueuePop (DEVICE_QM_TX_Q);
512     } while (hd != NULL);
513     
514 }    
517     
523