Quelle  onenand_regs.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 *  linux/include/linux/mtd/onenand_regs.h
 *
 *  OneNAND Register header file
 *
 *  Copyright (C) 2005-2007 Samsung Electronics
 *  Kyungmin Park <kyungmin.park@samsung.com>
 */

#ifndef __ONENAND_REG_H
#define __ONENAND_REG_H

/* Memory Address Map Translation (Word order) */
#define ONENAND_MEMORY_MAP(x)  ((x) << 1)

/*
 * External BufferRAM area
 */
#define ONENAND_BOOTRAM   ONENAND_MEMORY_MAP(0x0000)
#define ONENAND_DATARAM   ONENAND_MEMORY_MAP(0x0200)
#define ONENAND_SPARERAM  ONENAND_MEMORY_MAP(0x8010)

/*
 * OneNAND Registers
 */
#define ONENAND_REG_MANUFACTURER_ID ONENAND_MEMORY_MAP(0xF000)
#define ONENAND_REG_DEVICE_ID  ONENAND_MEMORY_MAP(0xF001)
#define ONENAND_REG_VERSION_ID  ONENAND_MEMORY_MAP(0xF002)
#define ONENAND_REG_DATA_BUFFER_SIZE ONENAND_MEMORY_MAP(0xF003)
#define ONENAND_REG_BOOT_BUFFER_SIZE ONENAND_MEMORY_MAP(0xF004)
#define ONENAND_REG_NUM_BUFFERS  ONENAND_MEMORY_MAP(0xF005)
#define ONENAND_REG_TECHNOLOGY  ONENAND_MEMORY_MAP(0xF006)

#define ONENAND_REG_START_ADDRESS1 ONENAND_MEMORY_MAP(0xF100)
#define ONENAND_REG_START_ADDRESS2 ONENAND_MEMORY_MAP(0xF101)
#define ONENAND_REG_START_ADDRESS3 ONENAND_MEMORY_MAP(0xF102)
#define ONENAND_REG_START_ADDRESS4 ONENAND_MEMORY_MAP(0xF103)
#define ONENAND_REG_START_ADDRESS5 ONENAND_MEMORY_MAP(0xF104)
#define ONENAND_REG_START_ADDRESS6 ONENAND_MEMORY_MAP(0xF105)
#define ONENAND_REG_START_ADDRESS7 ONENAND_MEMORY_MAP(0xF106)
#define ONENAND_REG_START_ADDRESS8 ONENAND_MEMORY_MAP(0xF107)

#define ONENAND_REG_START_BUFFER ONENAND_MEMORY_MAP(0xF200)
#define ONENAND_REG_COMMAND  ONENAND_MEMORY_MAP(0xF220)
#define ONENAND_REG_SYS_CFG1  ONENAND_MEMORY_MAP(0xF221)
#define ONENAND_REG_SYS_CFG2  ONENAND_MEMORY_MAP(0xF222)
#define ONENAND_REG_CTRL_STATUS  ONENAND_MEMORY_MAP(0xF240)
#define ONENAND_REG_INTERRUPT  ONENAND_MEMORY_MAP(0xF241)
#define ONENAND_REG_START_BLOCK_ADDRESS ONENAND_MEMORY_MAP(0xF24C)
#define ONENAND_REG_END_BLOCK_ADDRESS ONENAND_MEMORY_MAP(0xF24D)
#define ONENAND_REG_WP_STATUS  ONENAND_MEMORY_MAP(0xF24E)

#define ONENAND_REG_ECC_STATUS  ONENAND_MEMORY_MAP(0xFF00)
#define ONENAND_REG_ECC_M0  ONENAND_MEMORY_MAP(0xFF01)
#define ONENAND_REG_ECC_S0  ONENAND_MEMORY_MAP(0xFF02)
#define ONENAND_REG_ECC_M1  ONENAND_MEMORY_MAP(0xFF03)
#define ONENAND_REG_ECC_S1  ONENAND_MEMORY_MAP(0xFF04)
#define ONENAND_REG_ECC_M2  ONENAND_MEMORY_MAP(0xFF05)
#define ONENAND_REG_ECC_S2  ONENAND_MEMORY_MAP(0xFF06)
#define ONENAND_REG_ECC_M3  ONENAND_MEMORY_MAP(0xFF07)
#define ONENAND_REG_ECC_S3  ONENAND_MEMORY_MAP(0xFF08)

/*
 * Device ID Register F001h (R)
 */
#define DEVICE_IS_FLEXONENAND  (1 << 9)
#define FLEXONENAND_PI_MASK  (0x3ff)
#define FLEXONENAND_PI_UNLOCK_SHIFT (14)
#define ONENAND_DEVICE_DENSITY_MASK (0xf)
#define ONENAND_DEVICE_DENSITY_SHIFT (4)
#define ONENAND_DEVICE_IS_DDP  (1 << 3)
#define ONENAND_DEVICE_IS_DEMUX  (1 << 2)
#define ONENAND_DEVICE_VCC_MASK  (0x3)

#define ONENAND_DEVICE_DENSITY_512Mb (0x002)
#define ONENAND_DEVICE_DENSITY_1Gb (0x003)
#define ONENAND_DEVICE_DENSITY_2Gb (0x004)
#define ONENAND_DEVICE_DENSITY_4Gb (0x005)
#define ONENAND_DEVICE_DENSITY_8Gb (0x006)

/*
 * Version ID Register F002h (R)
 */
#define ONENAND_VERSION_PROCESS_SHIFT (8)

/*
 * Technology Register F006h (R)
 */
#define ONENAND_TECHNOLOGY_IS_MLC (1 << 0)

/*
 * Start Address 1 F100h (R/W) & Start Address 2 F101h (R/W)
 */
#define ONENAND_DDP_SHIFT  (15)
#define ONENAND_DDP_CHIP0  (0)
#define ONENAND_DDP_CHIP1  (1 << ONENAND_DDP_SHIFT)

/*
 * Start Address 8 F107h (R/W)
 */
/* Note: It's actually 0x3f in case of SLC */
#define ONENAND_FPA_MASK  (0x7f)
#define ONENAND_FPA_SHIFT  (2)
#define ONENAND_FSA_MASK  (0x03)

/*
 * Start Buffer Register F200h (R/W)
 */
#define ONENAND_BSA_MASK  (0x03)
#define ONENAND_BSA_SHIFT  (8)
#define ONENAND_BSA_BOOTRAM  (0 << 2)
#define ONENAND_BSA_DATARAM0  (2 << 2)
#define ONENAND_BSA_DATARAM1  (3 << 2)
/* Note: It's actually 0x03 in case of SLC */
#define ONENAND_BSC_MASK  (0x07)

/*
 * Command Register F220h (R/W)
 */
#define ONENAND_CMD_READ  (0x00)
#define ONENAND_CMD_READOOB  (0x13)
#define ONENAND_CMD_PROG  (0x80)
#define ONENAND_CMD_PROGOOB  (0x1A)
#define ONENAND_CMD_2X_PROG  (0x7D)
#define ONENAND_CMD_2X_CACHE_PROG (0x7F)
#define ONENAND_CMD_UNLOCK  (0x23)
#define ONENAND_CMD_LOCK  (0x2A)
#define ONENAND_CMD_LOCK_TIGHT  (0x2C)
#define ONENAND_CMD_UNLOCK_ALL  (0x27)
#define ONENAND_CMD_ERASE  (0x94)
#define ONENAND_CMD_MULTIBLOCK_ERASE (0x95)
#define ONENAND_CMD_ERASE_VERIFY (0x71)
#define ONENAND_CMD_RESET  (0xF0)
#define ONENAND_CMD_OTP_ACCESS  (0x65)
#define ONENAND_CMD_READID  (0x90)
#define FLEXONENAND_CMD_PI_UPDATE (0x05)
#define FLEXONENAND_CMD_PI_ACCESS (0x66)
#define FLEXONENAND_CMD_RECOVER_LSB (0x05)

/* NOTE: Those are not *REAL* commands */
#define ONENAND_CMD_BUFFERRAM  (0x1978)
#define FLEXONENAND_CMD_READ_PI  (0x1985)

/*
 * System Configuration 1 Register F221h (R, R/W)
 */
#define ONENAND_SYS_CFG1_SYNC_READ (1 << 15)
#define ONENAND_SYS_CFG1_BRL_7  (7 << 12)
#define ONENAND_SYS_CFG1_BRL_6  (6 << 12)
#define ONENAND_SYS_CFG1_BRL_5  (5 << 12)
#define ONENAND_SYS_CFG1_BRL_4  (4 << 12)
#define ONENAND_SYS_CFG1_BRL_3  (3 << 12)
#define ONENAND_SYS_CFG1_BRL_10  (2 << 12)
#define ONENAND_SYS_CFG1_BRL_9  (1 << 12)
#define ONENAND_SYS_CFG1_BRL_8  (0 << 12)
#define ONENAND_SYS_CFG1_BRL_SHIFT (12)
#define ONENAND_SYS_CFG1_BL_32  (4 << 9)
#define ONENAND_SYS_CFG1_BL_16  (3 << 9)
#define ONENAND_SYS_CFG1_BL_8  (2 << 9)
#define ONENAND_SYS_CFG1_BL_4  (1 << 9)
#define ONENAND_SYS_CFG1_BL_CONT (0 << 9)
#define ONENAND_SYS_CFG1_BL_SHIFT (9)
#define ONENAND_SYS_CFG1_NO_ECC  (1 << 8)
#define ONENAND_SYS_CFG1_RDY  (1 << 7)
#define ONENAND_SYS_CFG1_INT  (1 << 6)
#define ONENAND_SYS_CFG1_IOBE  (1 << 5)
#define ONENAND_SYS_CFG1_RDY_CONF (1 << 4)
#define ONENAND_SYS_CFG1_VHF  (1 << 3)
#define ONENAND_SYS_CFG1_HF  (1 << 2)
#define ONENAND_SYS_CFG1_SYNC_WRITE (1 << 1)

/*
 * Controller Status Register F240h (R)
 */
#define ONENAND_CTRL_ONGO  (1 << 15)
#define ONENAND_CTRL_LOCK  (1 << 14)
#define ONENAND_CTRL_LOAD  (1 << 13)
#define ONENAND_CTRL_PROGRAM  (1 << 12)
#define ONENAND_CTRL_ERASE  (1 << 11)
#define ONENAND_CTRL_ERROR  (1 << 10)
#define ONENAND_CTRL_RSTB  (1 << 7)
#define ONENAND_CTRL_OTP_L  (1 << 6)
#define ONENAND_CTRL_OTP_BL  (1 << 5)

/*
 * Interrupt Status Register F241h (R)
 */
#define ONENAND_INT_MASTER  (1 << 15)
#define ONENAND_INT_READ  (1 << 7)
#define ONENAND_INT_WRITE  (1 << 6)
#define ONENAND_INT_ERASE  (1 << 5)
#define ONENAND_INT_RESET  (1 << 4)
#define ONENAND_INT_CLEAR  (0 << 0)

/*
 * NAND Flash Write Protection Status Register F24Eh (R)
 */
#define ONENAND_WP_US   (1 << 2)
#define ONENAND_WP_LS   (1 << 1)
#define ONENAND_WP_LTS   (1 << 0)

/*
 * ECC Status Reigser FF00h (R)
 */
#define ONENAND_ECC_1BIT  (1 << 0)
#define ONENAND_ECC_1BIT_ALL  (0x5555)
#define ONENAND_ECC_2BIT  (1 << 1)
#define ONENAND_ECC_2BIT_ALL  (0xAAAA)
#define FLEXONENAND_UNCORRECTABLE_ERROR (0x1010)
#define ONENAND_ECC_3BIT  (1 << 2)
#define ONENAND_ECC_4BIT  (1 << 3)
#define ONENAND_ECC_4BIT_UNCORRECTABLE (0x1010)

/*
 * One-Time Programmable (OTP)
 */
#define FLEXONENAND_OTP_LOCK_OFFSET  (2048)
#define ONENAND_OTP_LOCK_OFFSET  (14)

#endif /* __ONENAND_REG_H */