xref: /freebsd/sys/dev/flash/mx25lreg.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef __MX25LREG_H__
31 #define __MX25LREG_H__
32 
33 /*
34  * Commands
35  */
36 #define CMD_WRITE_ENABLE	0x06
37 #define CMD_WRITE_DISABLE	0x04
38 #define CMD_READ_IDENT		0x9F
39 #define CMD_READ_STATUS		0x05
40 #define CMD_WRITE_STATUS	0x01
41 #define CMD_READ		0x03
42 #define CMD_FAST_READ		0x0B
43 #define CMD_READ_DUAL_IO	0xBB
44 #define CMD_READ_QUAD_OUTPUT	0x6B
45 #define CMD_PAGE_PROGRAM	0x02
46 #define CMD_SECTOR_ERASE	0xD8
47 #define CMD_BULK_ERASE		0xC7
48 #define	CMD_BLOCK_4K_ERASE	0x20
49 #define	CMD_BLOCK_32K_ERASE	0x52
50 #define	CMD_ENTER_4B_MODE	0xB7
51 #define	CMD_EXIT_4B_MODE	0xE9
52 
53 /* Quad 4B-addressing operations. */
54 #define	CMD_QUAD_SECTOR_ERASE	0xDC
55 #define	CMD_QUAD_PAGE_PROGRAM	0x34
56 #define	CMD_READ_4B_QUAD_OUTPUT	0x6C
57 
58 /*
59  * Status register flags
60  */
61 #define	STATUS_SRWD	(1 << 7)
62 #define	STATUS_BP2	(1 << 4)
63 #define	STATUS_BP1	(1 << 3)
64 #define	STATUS_BP0	(1 << 2)
65 #define	STATUS_WEL	(1 << 1)
66 #define	STATUS_WIP	(1 << 0)
67 
68 #define	FLASH_PAGE_SIZE	256
69 
70 #endif /* __MX25LREG_H__ */
71 
72