/*
 *
 * Common board functions for OMAP3 based boards.
 *
 * (C) Copyright 2004-2008
 * Texas Instruments, <www.ti.com>
 *
 * Author :
 *      Sunil Kumar <sunilsaini05@gmail.com>
 *      Shashi Ranjan <shashiranjanmca05@gmail.com>
 *
 * Derived from Beagle Board and 3430 SDP code by
 *      Richard Woodruff <r-woodruff2@ti.com>
 *      Syed Mohammed Khasim <khasim@ti.com>
 *
 *
 * SPDX-License-Identifier:     GPL-2.0+
 */
#include <common.h>
#include <spl.h>
#include <asm/io.h>
#include <asm/arch/sys_proto.h>
#include <asm/arch/mem.h>
#include <asm/cache.h>
#include <asm/armv7.h>
#include <asm/arch/gpio.h>
#include <asm/omap_common.h>
#include <asm/arch/mmc_host_def.h>
#include <i2c.h>
#include <linux/compiler.h>

DECLARE_GLOBAL_DATA_PTR;

/* Declarations */
extern omap3_sysinfo sysinfo;
static void omap3_setup_aux_cr(void);
#ifndef CONFIG_SYS_L2CACHE_OFF
static void omap3_invalidate_l2_cache_secure(void);
#endif

static const struct gpio_bank gpio_bank_34xx[6] = {
        { (void *)OMAP34XX_GPIO1_BASE, METHOD_GPIO_24XX },
        { (void *)OMAP34XX_GPIO2_BASE, METHOD_GPIO_24XX },
        { (void *)OMAP34XX_GPIO3_BASE, METHOD_GPIO_24XX },
        { (void *)OMAP34XX_GPIO4_BASE, METHOD_GPIO_24XX },
        { (void *)OMAP34XX_GPIO5_BASE, METHOD_GPIO_24XX },
        { (void *)OMAP34XX_GPIO6_BASE, METHOD_GPIO_24XX },
};

const struct gpio_bank *const omap_gpio_bank = gpio_bank_34xx;

#ifdef CONFIG_SPL_BUILD
/*
* We use static variables because global data is not ready yet.
* Initialized data is available in SPL right from the beginning.
* We would not typically need to save these parameters in regular
* U-Boot. This is needed only in SPL at the moment.
*/
u32 omap3_boot_device = BOOT_DEVICE_NAND;

/* auto boot mode detection is not possible for OMAP3 - hard code */
u32 spl_boot_mode(void)
{
        switch (spl_boot_device()) {
        case BOOT_DEVICE_MMC2:
                return MMCSD_MODE_RAW;
        case BOOT_DEVICE_MMC1:
                return MMCSD_MODE_FAT;
                break;
        default:
                puts("spl: ERROR:  unknown device - can't select boot mode\n");
                hang();
        }
}

u32 spl_boot_device(void)
{
        return omap3_boot_device;
}

int board_mmc_init(bd_t *bis)
{
        switch (spl_boot_device()) {
        case BOOT_DEVICE_MMC1:
                omap_mmc_init(0, 0, 0, -1, -1);
                break;
        case BOOT_DEVICE_MMC2:
        case BOOT_DEVICE_MMC2_2:
                omap_mmc_init(1, 0, 0, -1, -1);
                break;
        }
        return 0;
}

void spl_board_init(void)
{
#if defined(CONFIG_SPL_NAND_SUPPORT) || defined(CONFIG_SPL_ONENAND_SUPPORT)
        gpmc_init();
#endif
#ifdef CONFIG_SPL_I2C_SUPPORT
        i2c_init(CONFIG_SYS_OMAP24_I2C_SPEED, CONFIG_SYS_OMAP24_I2C_SLAVE);
#endif
}
#endif /* CONFIG_SPL_BUILD */


/******************************************************************************
 * Routine: secure_unlock
 * Description: Setup security registers for access
 *              (GP Device only)
 *****************************************************************************/
void secure_unlock_mem(void)
{
        struct pm *pm_rt_ape_base = (struct pm *)PM_RT_APE_BASE_ADDR_ARM;
        struct pm *pm_gpmc_base = (struct pm *)PM_GPMC_BASE_ADDR_ARM;
        struct pm *pm_ocm_ram_base = (struct pm *)PM_OCM_RAM_BASE_ADDR_ARM;
        struct pm *pm_iva2_base = (struct pm *)PM_IVA2_BASE_ADDR_ARM;
        struct sms *sms_base = (struct sms *)OMAP34XX_SMS_BASE;

        /* Protection Module Register Target APE (PM_RT) */
        writel(UNLOCK_1, &pm_rt_ape_base->req_info_permission_1);
        writel(UNLOCK_1, &pm_rt_ape_base->read_permission_0);
        writel(UNLOCK_1, &pm_rt_ape_base->wirte_permission_0);
        writel(UNLOCK_2, &pm_rt_ape_base->addr_match_1);

        writel(UNLOCK_3, &pm_gpmc_base->req_info_permission_0);
        writel(UNLOCK_3, &pm_gpmc_base->read_permission_0);
        writel(UNLOCK_3, &pm_gpmc_base->wirte_permission_0);

        writel(UNLOCK_3, &pm_ocm_ram_base->req_info_permission_0);
        writel(UNLOCK_3, &pm_ocm_ram_base->read_permission_0);
        writel(UNLOCK_3, &pm_ocm_ram_base->wirte_permission_0);
        writel(UNLOCK_2, &pm_ocm_ram_base->addr_match_2);

        /* IVA Changes */
        writel(UNLOCK_3, &pm_iva2_base->req_info_permission_0);
        writel(UNLOCK_3, &pm_iva2_base->read_permission_0);
        writel(UNLOCK_3, &pm_iva2_base->wirte_permission_0);

        /* SDRC region 0 public */
        writel(UNLOCK_1, &sms_base->rg_att0);
}

/******************************************************************************
 * Routine: secureworld_exit()
 * Description: If chip is EMU and boot type is external
 *              configure secure registers and exit secure world
 *              general use.
 *****************************************************************************/
void secureworld_exit()
{
        unsigned long i;

        /* configure non-secure access control register */
        __asm__ __volatile__("mrc p15, 0, %0, c1, c1, 2":"=r"(i));
        /* enabling co-processor CP10 and CP11 accesses in NS world */
        __asm__ __volatile__("orr %0, %0, #0xC00":"=r"(i));
        /*
         * allow allocation of locked TLBs and L2 lines in NS world
         * allow use of PLE registers in NS world also
         */
        __asm__ __volatile__("orr %0, %0, #0x70000":"=r"(i));
        __asm__ __volatile__("mcr p15, 0, %0, c1, c1, 2":"=r"(i));

        /* Enable ASA in ACR register */
        __asm__ __volatile__("mrc p15, 0, %0, c1, c0, 1":"=r"(i));
        __asm__ __volatile__("orr %0, %0, #0x10":"=r"(i));
        __asm__ __volatile__("mcr p15, 0, %0, c1, c0, 1":"=r"(i));

        /* Exiting secure world */
        __asm__ __volatile__("mrc p15, 0, %0, c1, c1, 0":"=r"(i));
        __asm__ __volatile__("orr %0, %0, #0x31":"=r"(i));
        __asm__ __volatile__("mcr p15, 0, %0, c1, c1, 0":"=r"(i));
}

/******************************************************************************
 * Routine: try_unlock_sram()
 * Description: If chip is GP/EMU(special) type, unlock the SRAM for
 *              general use.
 *****************************************************************************/
void try_unlock_memory()
{
        int mode;
        int in_sdram = is_running_in_sdram();

        /*
         * if GP device unlock device SRAM for general use
         * secure code breaks for Secure/Emulation device - HS/E/T
         */
        mode = get_device_type();
        if (mode == GP_DEVICE)
                secure_unlock_mem();

        /*
         * If device is EMU and boot is XIP external booting
         * Unlock firewalls and disable L2 and put chip
         * out of secure world
         *
         * Assuming memories are unlocked by the demon who put us in SDRAM
         */
        if ((mode <= EMU_DEVICE) && (get_boot_type() == 0x1F)
            && (!in_sdram)) {
                secure_unlock_mem();
                secureworld_exit();
        }

        return;
}

/******************************************************************************
 * Routine: s_init
 * Description: Does early system init of muxing and clocks.
 *              - Called path is with SRAM stack.
 *****************************************************************************/
void s_init(void)
{
        int in_sdram = is_running_in_sdram();

        watchdog_init();

        try_unlock_memory();

        /* Errata workarounds */
        omap3_setup_aux_cr();

#ifndef CONFIG_SYS_L2CACHE_OFF
        /* Invalidate L2-cache from secure mode */
        omap3_invalidate_l2_cache_secure();
#endif

        set_muxconf_regs();
        sdelay(100);

        prcm_init();

        per_clocks_enable();

#ifdef CONFIG_USB_EHCI_OMAP
        ehci_clocks_enable();
#endif

#ifdef CONFIG_SPL_BUILD
        gd = &gdata;

        preloader_console_init();

        timer_init();
#endif

        if (!in_sdram)
                mem_init();
}

/*
 * Routine: misc_init_r
 * Description: A basic misc_init_r that just displays the die ID
 */
int __weak misc_init_r(void)
{
        dieid_num_r();

        return 0;
}

/******************************************************************************
 * Routine: wait_for_command_complete
 * Description: Wait for posting to finish on watchdog
 *****************************************************************************/
void wait_for_command_complete(struct watchdog *wd_base)
{
        int pending = 1;
        do {
                pending = readl(&wd_base->wwps);
        } while (pending);
}

/******************************************************************************
 * Routine: watchdog_init
 * Description: Shut down watch dogs
 *****************************************************************************/
void watchdog_init(void)
{
        struct watchdog *wd2_base = (struct watchdog *)WD2_BASE;
        struct prcm *prcm_base = (struct prcm *)PRCM_BASE;

        /*
         * There are 3 watch dogs WD1=Secure, WD2=MPU, WD3=IVA. WD1 is
         * either taken care of by ROM (HS/EMU) or not accessible (GP).
         * We need to take care of WD2-MPU or take a PRCM reset. WD3
         * should not be running and does not generate a PRCM reset.
         */

        sr32(&prcm_base->fclken_wkup, 5, 1, 1);
        sr32(&prcm_base->iclken_wkup, 5, 1, 1);
        wait_on_value(ST_WDT2, 0x20, &prcm_base->idlest_wkup, 5);

        writel(WD_UNLOCK1, &wd2_base->wspr);
        wait_for_command_complete(wd2_base);
        writel(WD_UNLOCK2, &wd2_base->wspr);
}

/******************************************************************************
 * Dummy function to handle errors for EABI incompatibility
 *****************************************************************************/
void abort(void)
{
}

#if defined(CONFIG_NAND_OMAP_GPMC) & !defined(CONFIG_SPL_BUILD)
/******************************************************************************
 * OMAP3 specific command to switch between NAND HW and SW ecc
 *****************************************************************************/
static int do_switch_ecc(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
{
        if (argc < 2 || argc > 3)
                goto usage;

        if (strncmp(argv[1], "hw", 2) == 0) {
                if (argc == 2) {
                        omap_nand_switch_ecc(1, 1);
                } else {
                        if (strncmp(argv[2], "hamming", 7) == 0)
                                omap_nand_switch_ecc(1, 1);
                        else if (strncmp(argv[2], "bch8", 4) == 0)
                                omap_nand_switch_ecc(1, 8);
                        else
                                goto usage;
                }
        } else if (strncmp(argv[1], "sw", 2) == 0) {
                omap_nand_switch_ecc(0, 0);
        } else {
                goto usage;
        }

        return 0;

usage:
        printf ("Usage: nandecc %s\n", cmdtp->usage);
        return 1;
}

U_BOOT_CMD(
        nandecc, 3, 1,  do_switch_ecc,
        "switch OMAP3 NAND ECC calculation algorithm",
        "hw [hamming|bch8] - Switch between NAND hardware 1-bit hamming and"
        " 8-bit BCH\n"
        "                           ecc calculation (second parameter may"
        " be omitted).\n"
        "nandecc sw               - Switch to NAND software ecc algorithm."
);

#endif /* CONFIG_NAND_OMAP_GPMC & !CONFIG_SPL_BUILD */

#ifdef CONFIG_DISPLAY_BOARDINFO
/**
 * Print board information
 */
int checkboard (void)
{
        char *mem_s ;

        if (is_mem_sdr())
                mem_s = "mSDR";
        else
                mem_s = "LPDDR";

        printf("%s + %s/%s\n", sysinfo.board_string, mem_s,
                        sysinfo.nand_string);

        return 0;
}
#endif  /* CONFIG_DISPLAY_BOARDINFO */

static void omap3_emu_romcode_call(u32 service_id, u32 *parameters)
{
        u32 i, num_params = *parameters;
        u32 *sram_scratch_space = (u32 *)OMAP3_PUBLIC_SRAM_SCRATCH_AREA;

        /*
         * copy the parameters to an un-cached area to avoid coherency
         * issues
         */
        for (i = 0; i < num_params; i++) {
                __raw_writel(*parameters, sram_scratch_space);
                parameters++;
                sram_scratch_space++;
        }

        /* Now make the PPA call */
        do_omap3_emu_romcode_call(service_id, OMAP3_PUBLIC_SRAM_SCRATCH_AREA);
}

static void omap3_update_aux_cr_secure(u32 set_bits, u32 clear_bits)
{
        u32 acr;

        /* Read ACR */
        asm volatile ("mrc p15, 0, %0, c1, c0, 1" : "=r" (acr));
        acr &= ~clear_bits;
        acr |= set_bits;

        if (get_device_type() == GP_DEVICE) {
                omap3_gp_romcode_call(OMAP3_GP_ROMCODE_API_WRITE_ACR,
                                       acr);
        } else {
                struct emu_hal_params emu_romcode_params;
                emu_romcode_params.num_params = 1;
                emu_romcode_params.param1 = acr;
                omap3_emu_romcode_call(OMAP3_EMU_HAL_API_WRITE_ACR,
                                       (u32 *)&emu_romcode_params);
        }
}

static void omap3_setup_aux_cr(void)
{
        /* Workaround for Cortex-A8 errata: #454179 #430973
         *      Set "IBE" bit
         *      Set "Disable Branch Size Mispredicts" bit
         * Workaround for erratum #621766
         *      Enable L1NEON bit
         * ACR |= (IBE | DBSM | L1NEON) => ACR |= 0xE0
         */
        omap3_update_aux_cr_secure(0xE0, 0);
}

#ifndef CONFIG_SYS_L2CACHE_OFF
static void omap3_update_aux_cr(u32 set_bits, u32 clear_bits)
{
        u32 acr;

        /* Read ACR */
        asm volatile ("mrc p15, 0, %0, c1, c0, 1" : "=r" (acr));
        acr &= ~clear_bits;
        acr |= set_bits;

        /* Write ACR - affects non-secure banked bits */
        asm volatile ("mcr p15, 0, %0, c1, c0, 1" : : "r" (acr));
}

/* Invalidate the entire L2 cache from secure mode */
static void omap3_invalidate_l2_cache_secure(void)
{
        if (get_device_type() == GP_DEVICE) {
                omap3_gp_romcode_call(OMAP3_GP_ROMCODE_API_L2_INVAL,
                                      0);
        } else {
                struct emu_hal_params emu_romcode_params;
                emu_romcode_params.num_params = 1;
                emu_romcode_params.param1 = 0;
                omap3_emu_romcode_call(OMAP3_EMU_HAL_API_L2_INVAL,
                                       (u32 *)&emu_romcode_params);
        }
}

void v7_outer_cache_enable(void)
{
        /* Set L2EN */
        omap3_update_aux_cr_secure(0x2, 0);

        /*
         * On some revisions L2EN bit is banked on some revisions it's not
         * No harm in setting both banked bits(in fact this is required
         * by an erratum)
         */
        omap3_update_aux_cr(0x2, 0);
}

void omap3_outer_cache_disable(void)
{
        /* Clear L2EN */
        omap3_update_aux_cr_secure(0, 0x2);

        /*
         * On some revisions L2EN bit is banked on some revisions it's not
         * No harm in clearing both banked bits(in fact this is required
         * by an erratum)
         */
        omap3_update_aux_cr(0, 0x2);
}
#endif /* !CONFIG_SYS_L2CACHE_OFF */

#ifndef CONFIG_SYS_DCACHE_OFF
void enable_caches(void)
{
        /* Enable D-cache. I-cache is already enabled in start.S */
        dcache_enable();
}
#endif /* !CONFIG_SYS_DCACHE_OFF */