Renamed ifdef flag, init uart from iblmain
[keystone-rtos/ibl.git] / src / device / c66x / c66x.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: C66x Device Specific functions
40  ************************************************************************************
41  * FILE NAME: c66x.c
42  *
43  * DESCRIPTION: Implements the device specific functions for the IBL
44  *
45  * @file c66x.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 "nandhwapi.h"
65 #include "nor_api.h"
66 #include "spi_api.h"
67 #include <string.h>
68 #include <stdint.h>
69 #include "target.h"
70 #include "uart.h"
72 #define PLL_DDR_INIT_LOOPMAX 10
73 #define IBL_RESULT_CODE_STR_LEN 20
74 #define IBL_RESULT_CODE_LOC 17
76 extern cregister unsigned int DNUM;
78 /**
79  *  @brief Determine if an address is local
80  *
81  *  @details
82  *    Examines an input address to determine if it is a local address. Using the largest
83  *    L2 size on the C6670.
84  */
85 bool address_is_local (Uint32 addr)
86 {
87     /* L2 */
88     if ((addr >= 0x00800000) && (addr < 0x00900000))
89         return (TRUE);
91     /* L1P */
92     if ((addr >= 0x00e00000) && (addr < 0x00e08000))
93         return (TRUE);
95     /* L2D */
96     if ((addr >= 0x00f00000) && (addr < 0x00f08000))
97         return (TRUE);
99     return (FALSE);
104 /**
105  * @brief  Convert a local l1d, l1p or l2 address to a global address
106  *
107  * @details
108  *  The global address is formed. If the address is not local then
109  *  the input address is returned
110  */
111 Uint32 deviceLocalAddrToGlobal (Uint32 addr)
114     if (address_is_local (addr))
115         addr = (1 << 28) | (DNUM << 24) | addr;
117     return (addr);
120         
121         
122 /**
123  * @brief
124  *   Enable the DDR
125  *
126  * @details
127  *   The DDR controller on the c66x is an emif 4.0. The controller is
128  *   initialized directly with the supplied values
129  */
130 void deviceDdrConfig (void)
132     uint32 loopcount=0;
133     int8  ddr_result_code_str[IBL_RESULT_CODE_STR_LEN] = "IBL Result code 0";
134     /* The emif registers must be made visible. MPAX mapping 2 is used */
135     DEVICE_REG_XMPAX_L(2) =  0x10000000 | 0xff;     /* replacement addr + perm*/
136     DEVICE_REG_XMPAX_H(2) =  0x2100000B;         /* base addr + seg size (64KB)*/       
137     
138     if (ibl.ddrConfig.configDdr != 0)
139         hwEmif4p0Enable (&ibl.ddrConfig.uEmif.emif4p0);
141 #ifdef PLL_REINIT_WORKAROUND
142     for (loopcount = 0; loopcount < PLL_DDR_INIT_LOOPMAX; loopcount++)
143     {
144         if (ddr3_memory_test() == 0) 
145         {
146             break;
147         }
148         /* Calling MAIN, PA, DDR PLL init  */
149         if (ibl.pllConfig[ibl_MAIN_PLL].doEnable == TRUE)
150             hwPllSetPll (MAIN_PLL, 
151                          ibl.pllConfig[ibl_MAIN_PLL].prediv,
152                          ibl.pllConfig[ibl_MAIN_PLL].mult,
153                          ibl.pllConfig[ibl_MAIN_PLL].postdiv);
154     
155         if (ibl.pllConfig[ibl_NET_PLL].doEnable == TRUE)
156             hwPllSetCfgPll (DEVICE_PLL_BASE(NET_PLL),
157                             ibl.pllConfig[ibl_NET_PLL].prediv,
158                             ibl.pllConfig[ibl_NET_PLL].mult,
159                             ibl.pllConfig[ibl_NET_PLL].postdiv,
160                             ibl.pllConfig[ibl_MAIN_PLL].pllOutFreqMhz,
161                             ibl.pllConfig[ibl_NET_PLL].pllOutFreqMhz);
162     
163         if (ibl.pllConfig[ibl_DDR_PLL].doEnable == TRUE)
164             hwPllSetCfg2Pll (DEVICE_PLL_BASE(DDR_PLL),
165                              ibl.pllConfig[ibl_DDR_PLL].prediv,
166                              ibl.pllConfig[ibl_DDR_PLL].mult,
167                              ibl.pllConfig[ibl_DDR_PLL].postdiv,
168                              ibl.pllConfig[ibl_MAIN_PLL].pllOutFreqMhz,
169                              ibl.pllConfig[ibl_DDR_PLL].pllOutFreqMhz);
170           
171         if (ibl.ddrConfig.configDdr != 0)
172             hwEmif4p0Enable (&ibl.ddrConfig.uEmif.emif4p0);
173     }
174     /* Init UART again because we are re-initializing the PLL's */ 
175     uart_init();
177     if (loopcount < 10) 
178     {
179         ddr_result_code_str[IBL_RESULT_CODE_LOC] = loopcount + '0';
180     }
181     else if ((loopcount >= 10) && (loopcount < 35))
182     {
183         ddr_result_code_str[IBL_RESULT_CODE_LOC] =   loopcount + 'A';
184     }
185     else 
186     {
187         ddr_result_code_str[IBL_RESULT_CODE_LOC] =   loopcount + 'Z';
188     }
190     if (loopcount == PLL_DDR_INIT_LOOPMAX) 
191     {
192         uart_write_string("IBL: DDR INITIALIZATION FAILED",0);
193     }
194     else
195     {
196         uart_write_string("IBL: PLL and DDR Initialization Complete",0);
197     }
198     uart_write_string(ddr_result_code_str,0);
199 #endif
201         
204 /**
205  *  @brief  Enable EMIF25 or SPI interface to the NAND
206  *
207  */
208 int32 deviceConfigureForNand(void)
211     return (0);
215 /**
216  *  @brief
217  *      Return the base memory address for emif25 in a given chip select space
218  */
219 uint32 deviceEmif25MemBase (int32 cs)
221     switch (cs)  {
223         case 2:  return (TARGET_MEM_NAND_CS_2);
225         case 3:  return (TARGET_MEM_NAND_CS_3);
227         case 4:  return (TARGET_MEM_NAND_CS_4);
229         case 5:  return (TARGET_MEM_NAND_CS_5);
231     }
233     return (0xffffffff);
238 /**
239  *  @brief
240  *      Return the PSC number for NAND/NOR through emif. Only 6678 has the emif
241  */
242 Int32 deviceEmifPscNum (void)
244     Uint32 v;
246     v = *((Uint32 *)DEVICE_JTAG_ID_REG);
247     v &= DEVICE_JTAG_ID_MASK;
248     if (v == DEVICE_C6678_JTAG_ID_VAL)
249         return (TARGET_PWR_EMIF_C6678);
251     /* Return a negative number to indicate no PSC module is associated with NAND */
252     return (-1);
258 /**
259  *  @brief
260  *    The e-fuse mac address is loaded
261  */
262 void deviceLoadDefaultEthAddress (uint8 *maddr)
264     uint32 macA, macB;
266     /* Read the e-fuse mac address */
267     macA = *((uint32 *)0x2620110);
268     macB = *((uint32 *)0x2620114);
270     maddr[0] = (macB >>  8) & 0xff;
271     maddr[1] = (macB >>  0) & 0xff;
272     maddr[2] = (macA >> 24) & 0xff;
273     maddr[3] = (macA >> 16) & 0xff;
274     maddr[4] = (macA >>  8) & 0xff;
275     maddr[5] = (macA >>  0) & 0xff;
279 /**
280  *  @brief
281  *    Compile time queue manager information
282  */
283 #define DEVICE_NUM_RX_CPPIS     1
284 #define DEVICE_NUM_TX_CPPIS     1
285 #define DEVICE_NUM_CPPIS        (DEVICE_NUM_RX_CPPIS + DEVICE_NUM_TX_CPPIS)
287 /* The linking RAM */
288 #pragma DATA_SECTION(qm_linkram_buf, ".linkram")
289 #pragma DATA_ALIGN(qm_linkram_buf, 16)
290 uint8 qm_linkram_buf[DEVICE_NUM_CPPIS * 2 * (sizeof(uint32)/sizeof(uint8))];
293 /* The CPPI RAM */
294 #pragma DATA_SECTION(qm_cppi_buf, ".cppi")
295 #pragma DATA_ALIGN(qm_cppi_buf, 16)
296 uint8 qm_cppi_buf[QM_DESC_SIZE_BYTES * DEVICE_NUM_CPPIS];
299 /* The rx data buffers */
300 #pragma DATA_SECTION(qm_buffer, ".mac_buffer")
301 #pragma DATA_ALIGN(qm_buffer, 16)
302 uint8 qm_buffer[MAX_SIZE_STREAM_BUFFER * DEVICE_NUM_RX_CPPIS];
304 const qmConfig_t qmConfig =  {
305     (UINT32) qm_linkram_buf,
306     sizeof  (qm_cppi_buf),
307     (UINT32) qm_cppi_buf,
309     DEVICE_NUM_CPPIS,
310     DEVICE_QM_FREE_Q
311 };
313 /**
314  *  @brief
315  *      Return the queue manager memory configuration information
316  */
317 void *targetGetQmConfig (void)
319     return ((void *)&qmConfig);
322 /**
323  *  @brief
324  *      Attach a packet buffer to each descriptor and push onto the linked buffer queue
325  */
326 void targetInitQs (void)
328     int32 i;
329     qmHostDesc_t *hd;
331     for (i = 0; i < DEVICE_NUM_RX_CPPIS; i++)  {
333         hd                = hwQmQueuePop (DEVICE_QM_FREE_Q);
334         hd->buffLen       = sizeof (qm_buffer) / DEVICE_NUM_CPPIS;
335         hd->buffPtr       = (UINT32) &(qm_buffer[MAX_SIZE_STREAM_BUFFER * i]);
336         hd->nextBDPtr     = 0;
337         hd->origBufferLen = MAX_SIZE_STREAM_BUFFER;
338         hd->origBuffPtr   = hd->buffPtr;
340         hwQmQueuePush (hd, DEVICE_QM_LNK_BUF_Q, QM_DESC_SIZE_BYTES);
342     }
345     for (i = 0; i < DEVICE_NUM_TX_CPPIS; i++)  {
347         hd                = hwQmQueuePop (DEVICE_QM_FREE_Q);
348         hd->buffLen       = 0;
349         hd->buffPtr       = 0;
350         hd->nextBDPtr     = 0;
351         hd->origBufferLen = 0;
352         hd->origBuffPtr   = 0;
354         hwQmQueuePush (hd, DEVICE_QM_TX_Q, QM_DESC_SIZE_BYTES);
356     }
363 const cpdmaRxCfg_t cpdmaEthRxCfg =  {
365     DEVICE_PA_CDMA_RX_CHAN_CFG_BASE,    /* Base address of PA CPDMA rx config registers */
366     DEVICE_PA_CDMA_RX_NUM_CHANNELS,     /* Number of rx channels */
368     DEVICE_PA_CDMA_RX_FLOW_CFG_BASE,    /* Base address of PA CPDMA rx flow registers */
369     DEVICE_PA_CDMA_RX_NUM_FLOWS,        /* Number of rx flows */
371     0,                                  /* Queue manager for descriptor / buffer for received packets */
372     DEVICE_QM_LNK_BUF_Q,                /* Queue of descriptors /buffers for received packets */
374     0,                                  /* Queue manager for received packets */
375     DEVICE_QM_RCV_Q,                    /* Queue for received packets (overridden by PA)  */
377     DEVICE_RX_CDMA_TIMEOUT_COUNT        /* Teardown maximum loop wait */
378 };
381 /**
382  *  @brief
383  *      Return the cpdma configuration information
384  */
385 void *targetGetCpdmaRxConfig (void)
387     return ((void *)&cpdmaEthRxCfg);
392 const cpdmaTxCfg_t cpdmaEthTxCfg = {
394     DEVICE_PA_CDMA_GLOBAL_CFG_BASE,     /* Base address of global config registers      */
395     DEVICE_PA_CDMA_TX_CHAN_CFG_BASE,    /* Base address of PA CPDMA tx config registers */
396     DEVICE_PA_CDMA_TX_NUM_CHANNELS      /* Number of tx channels */
398 };
401 /**
402  *  @brief
403  *      return the tx cpdma configuration information
404  */
405 void *targetGetCpdmaTxConfig (void)
407     return ((void *)&cpdmaEthTxCfg);
411 /**
412  *  @brief
413  *     Configure the PA
414  */
415 void targetPaConfig (uint8 *macAddr)
417     paConfig_t     paCfg;
418     qmHostDesc_t  *hd;
419     SINT16         ret;
421     /* Filter everything except the desired mac address and the broadcast mac */
422     paCfg.mac0ms = ((uint32)macAddr[0] << 24) | ((uint32)macAddr[1] << 16) | ((uint32)macAddr[2] << 8) | (uint32)(macAddr[3]);
423     paCfg.mac0ls = ((uint32)macAddr[4] << 24) | ((uint32)macAddr[5] << 16);
425     paCfg.mac1ms = 0xffffffff;
426     paCfg.mac1ls = 0xffff0000;
428     paCfg.rxQnum = DEVICE_QM_RCV_Q;
430     /* Form the configuration command in a buffer linked to a descriptor */
431     hd = hwQmQueuePop (DEVICE_QM_LNK_BUF_Q);
432     paCfg.cmdBuf = (uint8 *)hd->origBuffPtr;
434     ret = hwPaEnable (&paCfg);
435     if (ret != 0)  {
436         iblStatus.iblFail = ibl_FAIL_CODE_PA;
437         return;
438     }
441     /* Send the command to the PA through the QM */
442     hd->softwareInfo0 = PA_MAGIC_ID;
443     hd->buffLen = 16;
444     QM_DESC_DESCINFO_SET_PKT_LEN(hd->descInfo, 16);
446     /* Set the return Queue */
447     QM_DESC_PINFO_SET_QM    (hd->packetInfo, 0);
448     QM_DESC_PINFO_SET_QUEUE (hd->packetInfo, DEVICE_QM_LNK_BUF_Q);
450     hwQmQueuePush (hd, DEVICE_QM_PA_CFG_Q, QM_DESC_SIZE_BYTES);
455 /**
456  *  @brief
457  *      Chip level SGMII serdes configuration
458  *
459  *  @details
460  *      Both lanes are always setup, regardless of the port value
461  */
462 void targetSgmiiSerdesConfig (int32 port, void *viblSgmii)
464   serdesConfig_t scfg;
465   iblSgmii_t     *sgmii = (iblSgmii_t *)viblSgmii;
467   scfg.cfg      = sgmii->auxConfig;
468   scfg.nLanes   = 2;
469   scfg.rxCfg[0] = scfg.rxCfg[1] = sgmii->rxConfig;
470   scfg.txCfg[0] = scfg.txCfg[1] = sgmii->txConfig;
472   hwSerdesConfig (TARGET_SGMII_SERDES_BASE, &scfg);
474   hwSerdesWaitLock (TARGET_SGMII_SERDES_STATUS_BASE);
479 Int32 targetMacSend (void *vptr_device, Uint8* buffer, int num_bytes) 
481     qmHostDesc_t   *hd;
482     NET_DRV_DEVICE *ptr_device = (NET_DRV_DEVICE *)vptr_device;
483     int             i;
486     /* Must always setup the descriptor to have the minimum packet length */
487     if (num_bytes < 64)
488         num_bytes = 64;
491     for (i = 0, hd = NULL; hd == NULL; i++, chipDelay32 (1000)) 
492         hd = hwQmQueuePop (DEVICE_QM_TX_Q);
493     
494     if (hd == NULL)
495         return (-1);
497     QM_DESC_DESCINFO_SET_PKT_LEN(hd->descInfo, num_bytes);
499     hd->buffLen       = num_bytes;
500     hd->origBufferLen = num_bytes;
502     hd->buffPtr     = deviceLocalAddrToGlobal((UINT32)buffer);
503     hd->origBuffPtr = deviceLocalAddrToGlobal((UINT32)buffer);
505     
506     /* Return the descriptor back to the transmit queue */
507     QM_DESC_PINFO_SET_QM(hd->packetInfo, 0);
508     QM_DESC_PINFO_SET_QUEUE(hd->packetInfo, DEVICE_QM_TX_Q);
510     hwQmQueuePush (hd, DEVICE_QM_ETH_TX_Q, QM_DESC_SIZE_BYTES);
512     return (0);
517 Int32 targetMacRcv (void *vptr_device, UINT8 *buffer)
519     Int32           pktSizeBytes; 
520     qmHostDesc_t   *hd;
521     NET_DRV_DEVICE *ptr_device = (NET_DRV_DEVICE *)vptr_device;
523     hd = hwQmQueuePop (DEVICE_QM_RCV_Q);
524     if (hd == NULL)
525         return (0);
527     pktSizeBytes = QM_DESC_DESCINFO_GET_PKT_LEN(hd->descInfo);
528     iblMemcpy ((void *)buffer, (void *)hd->buffPtr, pktSizeBytes);
530     hd->buffLen = hd->origBufferLen;
531     hd->buffPtr = hd->origBuffPtr;
533     hwQmQueuePush (hd, DEVICE_QM_LNK_BUF_Q, QM_DESC_SIZE_BYTES);
535     return (pktSizeBytes);
539 void targetFreeQs (void)
541     qmHostDesc_t   *hd;
543     do  {
545         hd = hwQmQueuePop (DEVICE_QM_FREE_Q);
547     } while (hd != NULL);
549     do  {
551         hd = hwQmQueuePop (DEVICE_QM_LNK_BUF_Q);
553     } while (hd != NULL);
554     
555     do  {
557         hd = hwQmQueuePop (DEVICE_QM_RCV_Q);
559     } while (hd != NULL);
560     
561     do  {
563         hd = hwQmQueuePop (DEVICE_QM_TX_Q);
565     } while (hd != NULL);
566     
567 }    
569 extern nandCtbl_t nandEmifCtbl;
570 /**
571  *  @brief Return the NAND interface (GPIO, EMIF25 or SPI) used based on the value
572  *         of interface
573  */
574 #ifndef EXCLUDE_NAND_GPIO
575 nandCtbl_t nandGpioCtbl =  {
577     nandHwGpioDriverInit,
578     nandHwGpioDriverReadBytes,
579     nandHwGpioDriverReadPage,
580     nandHwGpioDriverClose
582 };
583 #endif
585 #ifndef EXCLUDE_NAND_EMIF
586 extern Int32 nandHwEmifDriverInit (int32 cs, void *vdevInfo);
587 extern Int32 nandHwEmifDriverReadBytes (Uint32 block, Uint32 page, Uint32 byte, Uint32 nbytes, Uint8 *data);
588 extern Int32 nandHwEmifDriverReadPage (Uint32 block, Uint32 page, Uint8 *data);
589 extern Int32 nandHwEmifDriverClose (void);
591 nandCtbl_t nandEmifCtbl =  {
593     nandHwEmifDriverInit,
594     nandHwEmifDriverReadBytes,
595     nandHwEmifDriverReadPage,
596     nandHwEmifDriverClose
598 };
599 #endif
601 #ifndef EXCLUDE_NAND_SPI
602 nandCtbl_t nandSpiCtbl =  {
605     nandHwSpiDriverInit,
606     nandHwSpiDriverReadBytes,
607     nandHwSpiDriverReadPage,
608     nandHwSpiDriverClose
610 };
611 #endif
613 nandCtbl_t *deviceGetNandCtbl (int32 interface)
615 #ifndef EXCLUDE_NAND_GPIO
617     if (interface == ibl_PMEM_IF_GPIO)
618         return (&nandGpioCtbl);
620 #endif
622 #ifndef EXCLUDE_NAND_SPI
624     if (interface == ibl_PMEM_IF_SPI)
625         return (&nandSpiCtbl);
627 #endif
629 #ifndef EXCLUDE_NAND_EMIF
631     if ((interface >= ibl_PMEM_IF_CHIPSEL_2) && (interface <= ibl_PMEM_IF_CHIPSEL_5))
632         return (&nandEmifCtbl);
634 #endif
636     return (NULL);
641 /**
642  * @brief
643  *      Get the nor call table for the specified nor interface
644  */
646 #ifndef EXCLUDE_NOR_EMIF
647 norCtbl_t norEmifCtbl = {
648     
649     norHwEmifDriverInit,
650     norHwEmifDriverReadBytes,
651     norHwEmifDriverClose
653 };
655 #endif
657 #ifndef EXCLUDE_NOR_SPI
659 norCtbl_t norSpiCtbl = {
660     
661     norHwSpiDriverInit,
662     norHwSpiDriverReadBytes,
663     norHwSpiDriverClose
665 };
667 #endif
669 norCtbl_t *deviceGetNorCtbl (int32 interface)
672 #ifndef EXCLUDE_NOR_SPI
673     
674     if (interface == ibl_PMEM_IF_SPI)
675         return (&norSpiCtbl);
677 #endif
679 #ifndef EXCLUDE_NOR_EMIF
680    
681     if ((interface >= ibl_PMEM_IF_CHIPSEL_2) && (interface <= ibl_PMEM_IF_CHIPSEL_5))
682         return (&norEmifCtbl);
684 #endif
686     return (NULL);
689     
692     
698