xref: /OK3568_Linux_fs/kernel/include/linux/mtd/flashchip.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright © 2000      Red Hat UK Limited
4*4882a593Smuzhiyun  * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef __MTD_FLASHCHIP_H__
8*4882a593Smuzhiyun #define __MTD_FLASHCHIP_H__
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun /* For spinlocks. sched.h includes spinlock.h from whichever directory it
11*4882a593Smuzhiyun  * happens to be in - so we don't have to care whether we're on 2.2, which
12*4882a593Smuzhiyun  * has asm/spinlock.h, or 2.4, which has linux/spinlock.h
13*4882a593Smuzhiyun  */
14*4882a593Smuzhiyun #include <linux/sched.h>
15*4882a593Smuzhiyun #include <linux/mutex.h>
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun typedef enum {
18*4882a593Smuzhiyun 	FL_READY,
19*4882a593Smuzhiyun 	FL_STATUS,
20*4882a593Smuzhiyun 	FL_CFI_QUERY,
21*4882a593Smuzhiyun 	FL_JEDEC_QUERY,
22*4882a593Smuzhiyun 	FL_ERASING,
23*4882a593Smuzhiyun 	FL_ERASE_SUSPENDING,
24*4882a593Smuzhiyun 	FL_ERASE_SUSPENDED,
25*4882a593Smuzhiyun 	FL_WRITING,
26*4882a593Smuzhiyun 	FL_WRITING_TO_BUFFER,
27*4882a593Smuzhiyun 	FL_OTP_WRITE,
28*4882a593Smuzhiyun 	FL_WRITE_SUSPENDING,
29*4882a593Smuzhiyun 	FL_WRITE_SUSPENDED,
30*4882a593Smuzhiyun 	FL_PM_SUSPENDED,
31*4882a593Smuzhiyun 	FL_SYNCING,
32*4882a593Smuzhiyun 	FL_UNLOADING,
33*4882a593Smuzhiyun 	FL_LOCKING,
34*4882a593Smuzhiyun 	FL_UNLOCKING,
35*4882a593Smuzhiyun 	FL_POINT,
36*4882a593Smuzhiyun 	FL_XIP_WHILE_ERASING,
37*4882a593Smuzhiyun 	FL_XIP_WHILE_WRITING,
38*4882a593Smuzhiyun 	FL_SHUTDOWN,
39*4882a593Smuzhiyun 	/* These 2 come from nand_state_t, which has been unified here */
40*4882a593Smuzhiyun 	FL_READING,
41*4882a593Smuzhiyun 	FL_CACHEDPRG,
42*4882a593Smuzhiyun 	/* These 4 come from onenand_state_t, which has been unified here */
43*4882a593Smuzhiyun 	FL_RESETTING,
44*4882a593Smuzhiyun 	FL_OTPING,
45*4882a593Smuzhiyun 	FL_PREPARING_ERASE,
46*4882a593Smuzhiyun 	FL_VERIFYING_ERASE,
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun 	FL_UNKNOWN
49*4882a593Smuzhiyun } flstate_t;
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun /* NOTE: confusingly, this can be used to refer to more than one chip at a time,
54*4882a593Smuzhiyun    if they're interleaved.  This can even refer to individual partitions on
55*4882a593Smuzhiyun    the same physical chip when present. */
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun struct flchip {
58*4882a593Smuzhiyun 	unsigned long start; /* Offset within the map */
59*4882a593Smuzhiyun 	//	unsigned long len;
60*4882a593Smuzhiyun 	/* We omit len for now, because when we group them together
61*4882a593Smuzhiyun 	   we insist that they're all of the same size, and the chip size
62*4882a593Smuzhiyun 	   is held in the next level up. If we get more versatile later,
63*4882a593Smuzhiyun 	   it'll make it a damn sight harder to find which chip we want from
64*4882a593Smuzhiyun 	   a given offset, and we'll want to add the per-chip length field
65*4882a593Smuzhiyun 	   back in.
66*4882a593Smuzhiyun 	*/
67*4882a593Smuzhiyun 	int ref_point_counter;
68*4882a593Smuzhiyun 	flstate_t state;
69*4882a593Smuzhiyun 	flstate_t oldstate;
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	unsigned int write_suspended:1;
72*4882a593Smuzhiyun 	unsigned int erase_suspended:1;
73*4882a593Smuzhiyun 	unsigned long in_progress_block_addr;
74*4882a593Smuzhiyun 	unsigned long in_progress_block_mask;
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 	struct mutex mutex;
77*4882a593Smuzhiyun 	wait_queue_head_t wq; /* Wait on here when we're waiting for the chip
78*4882a593Smuzhiyun 			     to be ready */
79*4882a593Smuzhiyun 	int word_write_time;
80*4882a593Smuzhiyun 	int buffer_write_time;
81*4882a593Smuzhiyun 	int erase_time;
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	int word_write_time_max;
84*4882a593Smuzhiyun 	int buffer_write_time_max;
85*4882a593Smuzhiyun 	int erase_time_max;
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	void *priv;
88*4882a593Smuzhiyun };
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun /* This is used to handle contention on write/erase operations
91*4882a593Smuzhiyun    between partitions of the same physical chip. */
92*4882a593Smuzhiyun struct flchip_shared {
93*4882a593Smuzhiyun 	struct mutex lock;
94*4882a593Smuzhiyun 	struct flchip *writing;
95*4882a593Smuzhiyun 	struct flchip *erasing;
96*4882a593Smuzhiyun };
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun #endif /* __MTD_FLASHCHIP_H__ */
100