xref: /OK3568_Linux_fs/u-boot/drivers/rknand/rknand.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Copyright (C) (C) Copyright 2016-2017 Rockchip Electronics Co., Ltd
3  *
4  * SPDX-License-Identifier:	GPL-2.0+
5  */
6 
7 #ifndef __DRIVER_RKNAND_H__
8 #define __DRIVER_RKNAND_H__
9 
10 #include <asm/io.h>
11 #include <clk.h>
12 #include <asm/arch/clock.h>
13 
14 /* Represents an NVM Express device. Each nvme_dev is a PCI function. */
15 struct rknand_dev {
16 	void *ioaddr;
17 	struct clk nandc_clk;
18 	struct clk nandc_hclk;
19 	u32 density;
20 	struct udevice *dev;
21 
22 	/*
23 	 * read() - read from a block device
24 	 *
25 	 * @start:	Start block number to read (0=first)
26 	 * @blkcnt:	Number of blocks to read
27 	 * @buffer:	Destination buffer for data read
28 	 * @return 0 is OK, -1 is error.
29 	 */
30 	u32 (*read)(u8 lun, u32 start, u32 blkcnt, void *buffer);
31 	/*
32 	 * write() - write to a block device
33 	 *
34 	 * @dev:	Device to write to
35 	 * @start:	Start block number to write (0=first)
36 	 * @blkcnt:	Number of blocks to write
37 	 * @buffer:	Source buffer for data to write
38 	 * @return 0 is OK, -1 is error.
39 	 */
40 	u32 (*write)(u8 lun, u32 start, u32 blkcnt, const void *buffer);
41 	/*
42 	 * erase() - erase a section of a block device
43 	 *
44 	 * @dev:	Device to (partially) erase
45 	 * @start:	Start block number to erase (0=first)
46 	 * @blkcnt:	Number of blocks to erase
47 	 * @return 0 is OK, -1 is error.
48 	 */
49 	u32 (*erase)(u8 lun, u32 start, u32 blkcnt);
50 };
51 
52 struct rknand_uclass_priv {
53 	struct rknand_dev *ndev;
54 };
55 
56 u32 ftl_write(u8 lun, u32 start, u32 blkcnt, const void *buffer);
57 u32 ftl_read(u8 lun, u32 start, u32 blkcnt, void *buffer);
58 u32 ftl_discard(u8 lun, u32 start, u32 blkcnt);
59 u32 ftl_get_density(u8 lun);
60 int rk_ftl_init(u32 *reg_base);
61 u32 ftl_vendor_read(u32 index, u32 nsec, void *buf);
62 u32 ftl_vendor_write(u32 index, u32 nsec, void *buf);
63 #endif /* __DRIVER_RKNAND_H__ */
64