[people/ms/linux.git] / include / linux / mtd / flashchip.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright © 2000      Red Hat UK Limited
 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
 */

#ifndef __MTD_FLASHCHIP_H__
#define __MTD_FLASHCHIP_H__

/* For spinlocks. sched.h includes spinlock.h from whichever directory it
 * happens to be in - so we don't have to care whether we're on 2.2, which
 * has asm/spinlock.h, or 2.4, which has linux/spinlock.h
 */
#include <linux/sched.h>
#include <linux/mutex.h>

typedef enum {
	FL_READY,
	FL_STATUS,
	FL_CFI_QUERY,
	FL_JEDEC_QUERY,
	FL_ERASING,
	FL_ERASE_SUSPENDING,
	FL_ERASE_SUSPENDED,
	FL_WRITING,
	FL_WRITING_TO_BUFFER,
	FL_OTP_WRITE,
	FL_WRITE_SUSPENDING,
	FL_WRITE_SUSPENDED,
	FL_PM_SUSPENDED,
	FL_SYNCING,
	FL_UNLOADING,
	FL_LOCKING,
	FL_UNLOCKING,
	FL_POINT,
	FL_XIP_WHILE_ERASING,
	FL_XIP_WHILE_WRITING,
	FL_SHUTDOWN,
	/* These 2 come from nand_state_t, which has been unified here */
	FL_READING,
	FL_CACHEDPRG,
	/* These 4 come from onenand_state_t, which has been unified here */
	FL_RESETTING,
	FL_OTPING,
	FL_PREPARING_ERASE,
	FL_VERIFYING_ERASE,

	FL_UNKNOWN
} flstate_t;


/* NOTE: confusingly, this can be used to refer to more than one chip at a time,
   if they're interleaved.  This can even refer to individual partitions on
   the same physical chip when present. */

struct flchip {
	unsigned long start; /* Offset within the map */
	//	unsigned long len;
	/* We omit len for now, because when we group them together
	   we insist that they're all of the same size, and the chip size
	   is held in the next level up. If we get more versatile later,
	   it'll make it a damn sight harder to find which chip we want from
	   a given offset, and we'll want to add the per-chip length field
	   back in.
	*/
	int ref_point_counter;
	flstate_t state;
	flstate_t oldstate;

	unsigned int write_suspended:1;
	unsigned int erase_suspended:1;
	unsigned long in_progress_block_addr;
	unsigned long in_progress_block_mask;

	struct mutex mutex;
	wait_queue_head_t wq; /* Wait on here when we're waiting for the chip
			     to be ready */
	int word_write_time;
	int buffer_write_time;
	int erase_time;

	int word_write_time_max;
	int buffer_write_time_max;
	int erase_time_max;

	void *priv;
};

/* This is used to handle contention on write/erase operations
   between partitions of the same physical chip. */
struct flchip_shared {
	struct mutex lock;
	struct flchip *writing;
	struct flchip *erasing;
};


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