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