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