/*
 * SPDX-License-Identifier: LicenseRef-Unisoc-General-1.0
 *
 * Copyright 2023 Unisoc (Shanghai) Technologies Co., Ltd.
 *
 *	Licensed under the Unisoc General Software License, version 1.0 (the License); 
 *	you may not use this file except in compliance with the License. 
 *	You may obtain a copy of the License at 
 *	https://www.unisoc.com/en_us/license/UNISOC_GENERAL_LICENSE_V1.0-EN_US 
 *	Software distributed under the License is distributed on an "AS IS" BASIS, 
 *	WITHOUT WARRANTIES OF ANY KIND, either express or implied.
 *	See the Unisoc General Software License, version 1.0 for more details.
 *
 *	Alternatively you can use and distribute this file under the terms of the GNU General 
 *	Public License version 2, provided that it has to be used (including but not limited to 
 *	combining, linking) with any other file under the GNU General Public License 
 *	version 2 on platforms that use Unisoc Chips.
 */

#ifndef _NAND_H_
#define _NAND_H_
#include <linux/mtd/compat.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>

#define NAND_LOCK_STATUS_TIGHT	0x01
#define NAND_LOCK_STATUS_LOCK	0x02
#define NAND_LOCK_STATUS_UNLOCK 0x04

int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
		       u_char *buffer);
int nand_read_offset_ret(nand_info_t *nand, loff_t offset, size_t *length,
		       u_char *buffer, loff_t *offset_ret);
int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
			u_char *buffer);
int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
int nand_lock( nand_info_t *meminfo, int tight );
int nand_unlock( nand_info_t *meminfo, ulong start, ulong length );
int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);

extern void nand_init(void);
extern int board_nand_init(struct nand_chip *nand);
extern int nand_curr_device;
extern nand_info_t nand_info[];

typedef struct mtd_info nand_info_t;
typedef struct nand_write_options nand_write_options_t;
typedef struct mtd_oob_ops mtd_oob_ops_t;
typedef struct nand_read_options nand_read_options_t;
typedef struct nand_erase_options nand_erase_options_t;

static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
{
	return info->read(info, ofs, *len, (size_t *)len, buf);
}

static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
{
	return info->write(info, ofs, *len, (size_t *)len, buf);
}

static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
{
	return info->block_isbad(info, ofs);
}

static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
{
	struct erase_info instr;

	instr.mtd = info;
	instr.addr = off;
	instr.len = size;
	instr.callback = 0;

	return info->erase(info, &instr);
}

struct nand_write_options {
	u_char *buffer;
	ulong length;
	ulong offset;		/* start address in NAND */
	int quiet;		/* don't display progress messages */
	int autoplace;		/* if true use auto oob layout */
	int forcejffs2;
	int forceyaffs;
	int noecc;
	int writeoob;		/* image contains oob data */
	int pad;
	int blockalign;		/* 1|2|4 set multiple of eraseblocks to align to */
};

struct nand_read_options {
	u_char *buffer;
	ulong length;
	ulong offset;
	int quiet;
	int readoob;
};

/* Don't include skipped bad blocks in size to be erased */
struct nand_erase_options {
	loff_t length;
	loff_t offset;
	int quiet;
	int jffs2;
	int scrub;		/* if true, clean NAND by erasing bad blocks (UNSAFE) */
	int spread;
};

#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
void board_nand_select_device(struct nand_chip *nand, int chip);
#endif

__attribute__((noreturn)) void nand_boot(void);

#endif

#ifdef CONFIG_ENV_OFFSET_OOB
#define ENV_OOB_MARKER (0x30425645) /*"EVB0" in little-endian -- offset is stored
				    as block number*/
#define ENV_OOB_MARKER_OLD (0x30564e45) /*"ENV0" in little-endian -- offset is
					stored as byte number */
#define ENV_OFFSET_SIZE (8)
int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
#endif