1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2022 Adrian Chadd <adrian@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 __W25NREG_H__ 31 #define __W25NREG_H__ 32 33 /* 34 * Commands 35 */ 36 #define CMD_READ_STATUS 0x05 37 #define CMD_FAST_READ 0x0B 38 #define CMD_PAGE_DATA_READ 0x13 39 #define CMD_READ_IDENT 0x9F 40 #define CMD_LAST_ECC_FAILURE 0xA9 41 #define CMD_BLOCK_ERAS 0xD8 42 43 /* 44 * Three status registers - 0xAx, 0xBx, 0xCx. 45 * 46 * status register 1 (0xA0) is for protection config/status 47 * status register 2 (0xB0) is for configuration config/status 48 * status register 3 (0xC0) is for general status 49 */ 50 51 #define STATUS_REG_1 0xA0 52 #define STATUS_REG_1_SRP1 0x10 53 #define STATUS_REG_1_WP_EN 0x20 54 #define STATUS_REG_1_TOP_BOTTOM_PROT 0x40 55 #define STATUS_REG_1_BP0 0x80 56 #define STATUS_REG_1_BP1 0x10 57 #define STATUS_REG_1_BP2 0x20 58 #define STATUS_REG_1_BP3 0x40 59 #define STATUS_REG_1_SRP0 0x80 60 61 #define STATUS_REG_2 0xB0 62 #define STATUS_REG_2_BUF_EN 0x08 63 #define STATUS_REG_2_ECC_EN 0x10 64 #define STATUS_REG_2_SR1_LOCK 0x20 65 #define STATUS_REG_2_OTP_EN 0x40 66 #define STATUS_REG_2_OTP_L 0x80 67 68 #define STATUS_REG_3 0xC0 69 #define STATUS_REG_3_BUSY 0x01 70 #define STATUS_REG_3_WRITE_EN_LATCH 0x02 71 #define STATUS_REG_3_ERASE_FAIL 0x04 72 #define STATUS_REG_3_PROGRAM_FAIL 0x08 73 #define STATUS_REG_3_ECC_STATUS_0 0x10 74 #define STATUS_REG_3_ECC_STATUS_1 0x20 75 #define STATUS_REG_3_ECC_STATUS_SHIFT 4 76 #define STATUS_REG_3_ECC_STATUS_MASK 0x03 77 #define STATUS_REG_3_BBM_LUT_FULL 0x40 78 79 /* ECC status */ 80 #define STATUS_ECC_OK 0 81 #define STATUS_ECC_1BIT_OK 1 82 #define STATUS_ECC_2BIT_ERR 2 83 #define STATUS_ECC_2BIT_ERR_MULTIPAGE 3 84 85 #endif /* __W25NREG_H__ */ 86