/*
 * Copyright (c) 2004 Picture Elements, Inc.
 *    Stephen Williams (XXXXXXXXXXXXXXXX)
 *
 * SPDX-License-Identifier:     GPL-2.0+
 */

/*
 * The Xilinx SystemACE chip support is activated by defining
 * CONFIG_SYSTEMACE to turn on support, and CONFIG_SYS_SYSTEMACE_BASE
 * to set the base address of the device. This code currently
 * assumes that the chip is connected via a byte-wide bus.
 *
 * The CONFIG_SYSTEMACE also adds to fat support the device class
 * "ace" that allows the user to execute "fatls ace 0" and the
 * like. This works by making the systemace_get_dev function
 * available to cmd_fat.c:get_dev and filling in a block device
 * description that has all the bits needed for FAT support to
 * read sectors.
 *
 * According to Xilinx technical support, before accessing the
 * SystemACE CF you need to set the following control bits:
 *      FORCECFGMODE : 1
 *      CFGMODE : 0
 *      CFGSTART : 0
 */

#include <common.h>
#include <command.h>
#include <dm.h>
#include <part.h>
#include <asm/io.h>

/*
 * The ace_readw and writew functions read/write 16bit words, but the
 * offset value is the BYTE offset as most used in the Xilinx
 * datasheet for the SystemACE chip. The CONFIG_SYS_SYSTEMACE_BASE is defined
 * to be the base address for the chip, usually in the local
 * peripheral bus.
 */

static u32 base = CONFIG_SYS_SYSTEMACE_BASE;
static u32 width = CONFIG_SYS_SYSTEMACE_WIDTH;

static void ace_writew(u16 val, unsigned off)
{
        if (width == 8) {
#if !defined(__BIG_ENDIAN)
                writeb(val >> 8, base + off);
                writeb(val, base + off + 1);
#else
                writeb(val, base + off);
                writeb(val >> 8, base + off + 1);
#endif
        } else
                out16(base + off, val);
}

static u16 ace_readw(unsigned off)
{
        if (width == 8) {
#if !defined(__BIG_ENDIAN)
                return (readb(base + off) << 8) | readb(base + off + 1);
#else
                return readb(base + off) | (readb(base + off + 1) << 8);
#endif
        }

        return in16(base + off);
}

#ifndef CONFIG_BLK
static struct blk_desc systemace_dev = { 0 };
#endif

static int get_cf_lock(void)
{
        int retry = 10;

        /* CONTROLREG = LOCKREG */
        unsigned val = ace_readw(0x18);
        val |= 0x0002;
        ace_writew((val & 0xffff), 0x18);

        /* Wait for MPULOCK in STATUSREG[15:0] */
        while (!(ace_readw(0x04) & 0x0002)) {

                if (retry < 0)
                        return -1;

                udelay(100000);
                retry -= 1;
        }

        return 0;
}

static void release_cf_lock(void)
{
        unsigned val = ace_readw(0x18);
        val &= ~(0x0002);
        ace_writew((val & 0xffff), 0x18);
}

/*
 * This function is called (by dereferencing the block_read pointer in
 * the dev_desc) to read blocks of data. The return value is the
 * number of blocks read. A zero return indicates an error.
 */
#ifdef CONFIG_BLK
static unsigned long systemace_read(struct udevice *dev, unsigned long start,
                                    lbaint_t blkcnt, void *buffer)
#else
static unsigned long systemace_read(struct blk_desc *block_dev,
                                    unsigned long start, lbaint_t blkcnt,
                                    void *buffer)
#endif
{
        int retry;
        unsigned blk_countdown;
        unsigned char *dp = buffer;
        unsigned val;

        if (get_cf_lock() < 0) {
                unsigned status = ace_readw(0x04);

                /* If CFDETECT is false, card is missing. */
                if (!(status & 0x0010)) {
                        printf("** CompactFlash card not present. **\n");
                        return 0;
                }

                printf("**** ACE locked away from me (STATUSREG=%04x)\n",
                       status);
                return 0;
        }
#ifdef DEBUG_SYSTEMACE
        printf("... systemace read %lu sectors at %lu\n", blkcnt, start);
#endif

        retry = 2000;
        for (;;) {
                val = ace_readw(0x04);

                /* If CFDETECT is false, card is missing. */
                if (!(val & 0x0010)) {
                        printf("**** ACE CompactFlash not found.\n");
                        release_cf_lock();
                        return 0;
                }

                /* If RDYFORCMD, then we are ready to go. */
                if (val & 0x0100)
                        break;

                if (retry < 0) {
                        printf("**** SystemACE not ready.\n");
                        release_cf_lock();
                        return 0;
                }

                udelay(1000);
                retry -= 1;
        }

        /* The SystemACE can only transfer 256 sectors at a time, so
           limit the current chunk of sectors. The blk_countdown
           variable is the number of sectors left to transfer. */

        blk_countdown = blkcnt;
        while (blk_countdown > 0) {
                unsigned trans = blk_countdown;

                if (trans > 256)
                        trans = 256;

#ifdef DEBUG_SYSTEMACE
                printf("... transfer %lu sector in a chunk\n", trans);
#endif
                /* Write LBA block address */
                ace_writew((start >> 0) & 0xffff, 0x10);
                ace_writew((start >> 16) & 0x0fff, 0x12);

                /* NOTE: in the Write Sector count below, a count of 0
                   causes a transfer of 256, so &0xff gives the right
                   value for whatever transfer count we want. */

                /* Write sector count | ReadMemCardData. */
                ace_writew((trans & 0xff) | 0x0300, 0x14);

/*
 * For FPGA configuration via SystemACE is reset unacceptable
 * CFGDONE bit in STATUSREG is not set to 1.
 */
#ifndef SYSTEMACE_CONFIG_FPGA
                /* Reset the configruation controller */
                val = ace_readw(0x18);
                val |= 0x0080;
                ace_writew(val, 0x18);
#endif

                retry = trans * 16;
                while (retry > 0) {
                        int idx;

                        /* Wait for buffer to become ready. */
                        while (!(ace_readw(0x04) & 0x0020)) {
                                udelay(100);
                        }

                        /* Read 16 words of 2bytes from the sector buffer. */
                        for (idx = 0; idx < 16; idx += 1) {
                                unsigned short val = ace_readw(0x40);
                                *dp++ = val & 0xff;
                                *dp++ = (val >> 8) & 0xff;
                        }

                        retry -= 1;
                }

                /* Clear the configruation controller reset */
                val = ace_readw(0x18);
                val &= ~0x0080;
                ace_writew(val, 0x18);

                /* Count the blocks we transfer this time. */
                start += trans;
                blk_countdown -= trans;
        }

        release_cf_lock();

        return blkcnt;
}

#ifdef CONFIG_BLK
static int systemace_bind(struct udevice *dev)
{
        struct blk_desc *bdesc;
        struct udevice *bdev;
        int ret;

        ret = blk_create_devicef(dev, "systemace_blk", "blk", IF_TYPE_SYSTEMACE,
                                 -1, 512, 0, &bdev);
        if (ret) {
                debug("Cannot create block device\n");
                return ret;
        }
        bdesc = dev_get_uclass_platdata(bdev);
        bdesc->removable = 1;
        bdesc->part_type = PART_TYPE_UNKNOWN;
        bdesc->log2blksz = LOG2(bdesc->blksz);

        /* Ensure the correct bus mode (8/16 bits) gets enabled */
        ace_writew(width == 8 ? 0 : 0x0001, 0);

        return 0;
}

static const struct blk_ops systemace_blk_ops = {
        .read   = systemace_read,
};

U_BOOT_DRIVER(systemace_blk) = {
        .name           = "systemace_blk",
        .id             = UCLASS_BLK,
        .ops            = &systemace_blk_ops,
        .bind           = systemace_bind,
};
#else
static int systemace_get_dev(int dev, struct blk_desc **descp)
{
        /* The first time through this, the systemace_dev object is
           not yet initialized. In that case, fill it in. */
        if (systemace_dev.blksz == 0) {
                systemace_dev.if_type = IF_TYPE_UNKNOWN;
                systemace_dev.devnum = 0;
                systemace_dev.part_type = PART_TYPE_UNKNOWN;
                systemace_dev.type = DEV_TYPE_HARDDISK;
                systemace_dev.blksz = 512;
                systemace_dev.log2blksz = LOG2(systemace_dev.blksz);
                systemace_dev.removable = 1;
                systemace_dev.block_read = systemace_read;

                /*
                 * Ensure the correct bus mode (8/16 bits) gets enabled
                 */
                ace_writew(width == 8 ? 0 : 0x0001, 0);

                part_init(&systemace_dev);
        }
        *descp = &systemace_dev;

        return 0;
}

U_BOOT_LEGACY_BLK(systemace) = {
        .if_typename    = "ace",
        .if_type        = IF_TYPE_SYSTEMACE,
        .max_devs       = 1,
        .get_dev        = systemace_get_dev,
};
#endif