/*
 * (C) Copyright 2016 Intel Corporation
 * Author: William Widjaja <w.widjaja@intel.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 2
 * of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */

#ifndef __LTQ_MTD_SPI_NAND_H__
#define __LTQ_MTD_SPI_NAND_H__

#include <linux/wait.h>
#include <linux/spinlock.h>
#include <linux/mtd/mtd.h>

/*============================================================================*/

/*
 * Standard SPI-NAND flash commands
 */
#define CMD_READ 0x13
#define CMD_READ_RDM 0x03
#define CMD_PROG_PAGE_CLRCACHE 0x02
#define CMD_PROG_PAGE_CLRCACHE_X4 0x32
#define CMD_PROG_PAGE 0x84
#define CMD_PROG_PAGE_X4 0x34
#define CMD_PROG_PAGE_EXC 0x10
#define CMD_ERASE_BLK 0xd8
#define CMD_WR_ENABLE 0x06
#define CMD_WR_DISABLE 0x04
#define CMD_READ_ID 0x9f
#define CMD_RESET 0xff
#define CMD_READ_REG 0x0f
#define CMD_WRITE_REG 0x1f
#define CMD_READ_CACHE_X2 0x3b
#define CMD_READ_CACHE_X4 0x6b
#define CMD_SWITCH_DIE 0xc2

/* feature registers */
#define REG_BLOCK_LOCK 0xa0
#define REG_OTP 0xb0
#define REG_STATUS 0xc0 /* timing */

/* status */
#define STATUS_OIP_MASK 0x01
#define STATUS_READY (0 << 0)
#define STATUS_BUSY (1 << 0)

#define STATUS_E_FAIL_MASK 0x04
#define STATUS_E_FAIL (1 << 2)

#define STATUS_P_FAIL_MASK 0x08
#define STATUS_P_FAIL (1 << 3)

/* OTP register defines*/
#define OTP_QE_BIT 0x01
#define OTP_BUF_MODE 0x08
#define OTP_ECC_ENABLE 0x10
#define OTP_ENABLE 0x40

/* block lock */
#define BL_ALL_LOCKED 0x38
#define BL_1_2_LOCKED 0x30
#define BL_1_4_LOCKED 0x28
#define BL_1_8_LOCKED 0x20
#define BL_1_16_LOCKED 0x18
#define BL_1_32_LOCKED 0x10
#define BL_1_64_LOCKED 0x08
#define BL_ALL_UNLOCKED 0x00

#define SPI_NAND_MT29F_ECC_MASK 3
#define SPI_NAND_MT29F_ECC_CORRECTED 1
#define SPI_NAND_MT29F_ECC_UNCORR 2
#define SPI_NAND_MT29F_ECC_RESERVED 3
#define SPI_NAND_MT29F_ECC_SHIFT 4

#define SPI_NAND_GD5F_ECC_MASK 7
#define SPI_NAND_GD5F_ECC_UNCORR 7
#define SPI_NAND_GD5F_ECC_SHIFT 4

/*============================================================================*/

struct spinand_info {
	struct nand_ecclayout *ecclayout;
	struct spi_device *spi;
	void *priv;

	/* for die selection */
	u8 current_die;
	u32 num_of_die;
	u32 page_per_die_shift;
};

struct spinand_privbuf {
	uint32_t col;
	uint32_t row;
	int buf_ptr;
	u8 *buf;
};

struct spinand_cmd {
	u8 cmd;
	u32 n_addr; /* Number of address */
	u8 addr[3]; /* Reg Offset */
	u32 n_dummy; /* Dummy use */
	u32 n_tx; /* Number of tx bytes */
	u8 *tx_buf; /* Tx buf */
	u32 n_rx; /* Number of rx bytes */
	u8 *rx_buf; /* Rx buf */
};
#if 0
/*
 * Internal ECC layout control structure. For historical reasons, there is a
 * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
 * for export to user-space via the ECCGETLAYOUT ioctl.
 * nand_ecclayout should be expandable in the future simply by the above macros.
 */
struct nand_ecclayout {
	__u32 eccbytes;
	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
	__u32 oobavail;
	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
};
#endif
/*
 * This constant declares the max. oobsize / page, which
 * is supported now. If you add a chip with bigger oobsize/page
 * adjust this accordingly.
 */
#define NAND_MAX_OOBSIZE 640
#define NAND_MAX_PAGESIZE 8192

/*============================================================================*/

/* Extended chip-options for ltq_spinand
 * For consistency, we use unoccupied value in include/linux/mtd/nand.h
 */

/*
 * this is to diferentiate gigadevice dummy byte with the rest of manufacturer
 *  - CMD_READ_RDM : extra dummy byte before column address
 */
#define GIGADEVICE_DUMMY_TYPE 0x01000000

/* For flash which require us to specify plane id inside cmd */
#define SPINAND_NEED_PLANE_SELECT 0x02000000

#endif /* __LTQ_MTD_SPI_NAND_H__ */