xref: /OK3568_Linux_fs/u-boot/drivers/rkflash/flash_com.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Copyright (c) 2018 Fuzhou Rockchip Electronics Co., Ltd
3  *
4  * SPDX-License-Identifier:	GPL-2.0
5  */
6 
7 #ifndef __FLASH_COM_H
8 #define __FLASH_COM_H
9 
10 #include "typedef.h"
11 
12 #define NAND_ERROR			INVALID_UINT32
13 #define NAND_OK				0
14 
15 #define NAND_STS_OK                     0	/* bit 0 ecc error or ok */
16 #define NAND_STS_REFRESH                256	/* need refresh */
17 #define NAND_STS_EMPTY                  512	/* page is not proged */
18 #define NAND_STS_ECC_ERR                NAND_ERROR
19 
20 #define NAND_IDB_START    64 /* 32 KB*/
21 #define NAND_IDB_SIZE    512 /* 256 KB*/
22 #define NAND_IDB_END    (NAND_IDB_START + NAND_IDB_SIZE - 1)
23 #define DEFAULT_IDB_RESERVED_BLOCK	8
24 
25 #define FULL_SLC			0
26 #define SLC				1
27 
28 #define NAND_FLASH_MLC_PAGE_TAG         0xFFFF
29 #define MAX_FLASH_PAGE_SIZE		0x1000 /* 4KB */
30 
31 #define PAGE_ADDR_BITS			0
32 #define PAGE_ADDR_MASK			((1u << 11) - 1)
33 #define BLOCK_ADDR_BITS			11
34 #define BLOCK_ADDR_MASK			((1u << 14) - 1)
35 #define DIE_ADDR_BITS			25
36 #define DIE_ADDR_MASK			((1u << 3) - 1)
37 #define FLAG_ADDR_BITS			28
38 #define FLAG_ADDR_MASK			((1u << 4) - 1)
39 #define PHY_BLK_DIE_ADDR_BITS		14
40 
41 struct nand_req {
42 	u32 status;
43 	u32 page_addr;   /* 31:28 flag, 27:25: die, 24:11 block, 10:0 page */
44 	u32 *p_data;
45 	u32 *p_spare;
46 	u32 lpa;
47 };
48 
49 struct nand_phy_info {
50 	u16	nand_type;		/* SLC,MLC,TLC */
51 	u16	die_num;		/* number of LUNs */
52 	u16	plane_per_die;
53 	u16	blk_per_plane;
54 	u16	blk_per_die;
55 	u16	page_per_blk;		/* in MLC mode */
56 	u16	page_per_slc_blk;	/* in SLC mode */
57 	u16	sec_per_page;		/* physical page data size */
58 	u16	sec_per_blk;		/* physical page data size */
59 	u16	byte_per_sec;		/* size of logical sectors */
60 	u16	reserved_blk;		/* reserved for boot loader in die 0*/
61 	u8	ecc_bits;
62 };
63 
64 struct nand_ops {
65 	s32 (*get_bad_blk_list)(u16 *table, u32 die);
66 	u32 (*erase_blk)(u8 cs, u32 page_addr);
67 	u32 (*prog_page)(u8 cs, u32 page_addr, u32 *data, u32 *spare);
68 	u32 (*read_page)(u8 cs, u32 page_addr, u32 *data, u32 *spare);
69 	void (*bch_sel)(u8 bits);
70 	void (*set_sec_num)(u8 num);
71 };
72 
73 #endif
74