freebsd-dev/sys/dev/flash/mx25lreg.h

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice unmodified, this list of conditions, and the following
 *    disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef __MX25LREG_H__
#define __MX25LREG_H__

/*
 * Commands 
 */
#define CMD_WRITE_ENABLE	0x06
#define CMD_WRITE_DISABLE	0x04
#define CMD_READ_IDENT		0x9F
#define CMD_READ_STATUS		0x05
#define CMD_WRITE_STATUS	0x01
#define CMD_READ		0x03
#define CMD_FAST_READ		0x0B
#define CMD_PAGE_PROGRAM	0x02
#define CMD_SECTOR_ERASE	0xD8
#define CMD_BULK_ERASE		0xC7
#define	CMD_BLOCK_4K_ERASE	0x20
#define	CMD_BLOCK_32K_ERASE	0x52
#define	CMD_ENTER_4B_MODE	0xB7
#define	CMD_EXIT_4B_MODE	0xE9

/*
 * Status register flags
 */
#define	STATUS_SRWD	(1 << 7)
#define	STATUS_BP2	(1 << 4)
#define	STATUS_BP1	(1 << 3)
#define	STATUS_BP0	(1 << 2)
#define	STATUS_WEL	(1 << 1)
#define	STATUS_WIP	(1 << 0)

#define	FLASH_PAGE_SIZE	256

#endif /* __MX25LREG_H__ */
- Add support for MX25Lxxx SPI flash (readonly atm) 2009-05-18 23:20:56 +00:00			`/*-`
sys/dev: further adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. 2017-11-27 14:52:40 +00:00			`* SPDX-License-Identifier: BSD-2-Clause-FreeBSD`
			`*`
- Add support for MX25Lxxx SPI flash (readonly atm) 2009-05-18 23:20:56 +00:00			`* Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>`
			`* All rights reserved.`
			`*`
			`* Redistribution and use in source and binary forms, with or without`
			`* modification, are permitted provided that the following conditions`
			`* are met:`
			`* 1. Redistributions of source code must retain the above copyright`
			`* notice unmodified, this list of conditions, and the following`
			`* disclaimer.`
			`* 2. Redistributions in binary form must reproduce the above copyright`
			`* notice, this list of conditions and the following disclaimer in the`
			`* documentation and/or other materials provided with the distribution.`
			`*`
			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`* SUCH DAMAGE.`
Include 4k/32k erase commands. These were sourced from the MX25L128 datasheet and match up with what is used in Linux mtd/devices/m25p80.c . Add a FreeBSD keyword whilst I'm here. 2010-07-19 15:05:35 +00:00			`*`
			`* $FreeBSD$`
- Add support for MX25Lxxx SPI flash (readonly atm) 2009-05-18 23:20:56 +00:00			`*/`

			`#ifndef __MX25LREG_H__`
			`#define __MX25LREG_H__`

			`/*`
			`* Commands`
			`*/`
			`#define CMD_WRITE_ENABLE 0x06`
			`#define CMD_WRITE_DISABLE 0x04`
			`#define CMD_READ_IDENT 0x9F`
			`#define CMD_READ_STATUS 0x05`
			`#define CMD_WRITE_STATUS 0x01`
			`#define CMD_READ 0x03`
			`#define CMD_FAST_READ 0x0B`
			`#define CMD_PAGE_PROGRAM 0x02`
			`#define CMD_SECTOR_ERASE 0xD8`
			`#define CMD_BULK_ERASE 0xC7`
Include 4k/32k erase commands. These were sourced from the MX25L128 datasheet and match up with what is used in Linux mtd/devices/m25p80.c . Add a FreeBSD keyword whilst I'm here. 2010-07-19 15:05:35 +00:00			`#define CMD_BLOCK_4K_ERASE 0x20`
			`#define CMD_BLOCK_32K_ERASE 0x52`
Enable 4-byte address support for the mx25l family of SPI flash devices. Introduce 2 new flags: - FL_ENABLE_4B_ADDR (forces the use of 4-byte addresses) - FL_DISABLE_4B_ADDR (forces the use of 3-byte addresses) If an SPI flash chip is defined with FL_ENABLE_4B_ADDR in its flags, then an 'Enter 4-byte mode' command is sent to the chip at attach time and, later, all commands that require addressing are issued with 4-byte addresses. If an SPI flash chip is defined with FL_DISABLE_4B_ADDR in its flags, then an 'Exit 4-byte mode' command is sent to the chip at attach time and, later, all commands that require addressing are issued with 3-byte addresses. For chips that do not have any of these flags defined the behaviour is unchanged. This change also adds support for the MX25L25735F and MX25L25635E chips (vendor id 0xc2, device id 0x2019), which support 4-byte mode and enables 4-byte mode for them. These are 256Mbit devices (32MiB) and, as such, can only be fully addressed by using 4-byte addresses. Approved by: adrian (mentor) Sponsored by: Smartcom - Bulgaria AD Differential Revision: https://reviews.freebsd.org/D5808 2016-04-04 06:55:48 +00:00			`#define CMD_ENTER_4B_MODE 0xB7`
			`#define CMD_EXIT_4B_MODE 0xE9`
- Add support for MX25Lxxx SPI flash (readonly atm) 2009-05-18 23:20:56 +00:00
			`/*`
			`* Status register flags`
			`*/`
			`#define STATUS_SRWD (1 << 7)`
			`#define STATUS_BP2 (1 << 4)`
			`#define STATUS_BP1 (1 << 3)`
			`#define STATUS_BP0 (1 << 2)`
			`#define STATUS_WEL (1 << 1)`
			`#define STATUS_WIP (1 << 0)`

- Add write support for mx25l flash chip - Some minor style(9) fixes 2009-10-25 08:43:38 +00:00			`#define FLASH_PAGE_SIZE 256`

- Add support for MX25Lxxx SPI flash (readonly atm) 2009-05-18 23:20:56 +00:00			`#endif /* __MX25LREG_H__ */`