/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * Handles the M-Systems DiskOnChip G3 chip * * Copyright (C) 2011 Robert Jarzmik */ #ifndef _MTD_DOCG3_H #define _MTD_DOCG3_H #include <linux/mtd/mtd.h> /* * Flash memory areas : * - 0x0000 .. 0x07ff : IPL * - 0x0800 .. 0x0fff : Data area * - 0x1000 .. 0x17ff : Registers * - 0x1800 .. 0x1fff : Unknown */ #define DOC_IOSPACE_IPL … #define DOC_IOSPACE_DATA … #define DOC_IOSPACE_SIZE … /* * DOC G3 layout and adressing scheme * A page address for the block "b", plane "P" and page "p": * address = [bbbb bPpp pppp] */ #define DOC_ADDR_PAGE_MASK … #define DOC_ADDR_BLOCK_SHIFT … #define DOC_LAYOUT_NBPLANES … #define DOC_LAYOUT_PAGES_PER_BLOCK … #define DOC_LAYOUT_PAGE_SIZE … #define DOC_LAYOUT_OOB_SIZE … #define DOC_LAYOUT_WEAR_SIZE … #define DOC_LAYOUT_PAGE_OOB_SIZE … #define DOC_LAYOUT_WEAR_OFFSET … #define DOC_LAYOUT_BLOCK_SIZE … /* * ECC related constants */ #define DOC_ECC_BCH_M … #define DOC_ECC_BCH_T … #define DOC_ECC_BCH_PRIMPOLY … #define DOC_ECC_BCH_SIZE … #define DOC_ECC_BCH_COVERED_BYTES … #define DOC_ECC_BCH_TOTAL_BYTES … /* * Blocks distribution */ #define DOC_LAYOUT_BLOCK_BBT … #define DOC_LAYOUT_BLOCK_OTP … #define DOC_LAYOUT_BLOCK_FIRST_DATA … #define DOC_LAYOUT_PAGE_BBT … /* * Extra page OOB (16 bytes wide) layout */ #define DOC_LAYOUT_OOB_PAGEINFO_OFS … #define DOC_LAYOUT_OOB_HAMMING_OFS … #define DOC_LAYOUT_OOB_BCH_OFS … #define DOC_LAYOUT_OOB_UNUSED_OFS … #define DOC_LAYOUT_OOB_PAGEINFO_SZ … #define DOC_LAYOUT_OOB_HAMMING_SZ … #define DOC_LAYOUT_OOB_BCH_SZ … #define DOC_LAYOUT_OOB_UNUSED_SZ … #define DOC_CHIPID_G3 … #define DOC_ERASE_MARK … #define DOC_MAX_NBFLOORS … /* * Flash registers */ #define DOC_CHIPID … #define DOC_TEST … #define DOC_BUSLOCK … #define DOC_ENDIANCONTROL … #define DOC_DEVICESELECT … #define DOC_ASICMODE … #define DOC_CONFIGURATION … #define DOC_INTERRUPTCONTROL … #define DOC_READADDRESS … #define DOC_DATAEND … #define DOC_INTERRUPTSTATUS … #define DOC_FLASHSEQUENCE … #define DOC_FLASHCOMMAND … #define DOC_FLASHADDRESS … #define DOC_FLASHCONTROL … #define DOC_NOP … #define DOC_ECCCONF0 … #define DOC_ECCCONF1 … #define DOC_ECCPRESET … #define DOC_HAMMINGPARITY … #define DOC_BCH_HW_ECC(idx) … #define DOC_PROTECTION … #define DOC_DPS0_KEY … #define DOC_DPS1_KEY … #define DOC_DPS0_ADDRLOW … #define DOC_DPS0_ADDRHIGH … #define DOC_DPS1_ADDRLOW … #define DOC_DPS1_ADDRHIGH … #define DOC_DPS0_STATUS … #define DOC_DPS1_STATUS … #define DOC_ASICMODECONFIRM … #define DOC_CHIPID_INV … #define DOC_POWERMODE … /* * Flash sequences * A sequence is preset before one or more commands are input to the chip. */ #define DOC_SEQ_RESET … #define DOC_SEQ_PAGE_SIZE_532 … #define DOC_SEQ_SET_FASTMODE … #define DOC_SEQ_SET_RELIABLEMODE … #define DOC_SEQ_READ … #define DOC_SEQ_SET_PLANE1 … #define DOC_SEQ_SET_PLANE2 … #define DOC_SEQ_PAGE_SETUP … #define DOC_SEQ_ERASE … #define DOC_SEQ_PLANES_STATUS … /* * Flash commands */ #define DOC_CMD_READ_PLANE1 … #define DOC_CMD_SET_ADDR_READ … #define DOC_CMD_READ_ALL_PLANES … #define DOC_CMD_READ_PLANE2 … #define DOC_CMD_READ_FLASH … #define DOC_CMD_PAGE_SIZE_532 … #define DOC_CMD_PROG_BLOCK_ADDR … #define DOC_CMD_PROG_CYCLE1 … #define DOC_CMD_PROG_CYCLE2 … #define DOC_CMD_PROG_CYCLE3 … #define DOC_CMD_ERASECYCLE2 … #define DOC_CMD_READ_STATUS … #define DOC_CMD_PLANES_STATUS … #define DOC_CMD_RELIABLE_MODE … #define DOC_CMD_FAST_MODE … #define DOC_CMD_RESET … /* * Flash register : DOC_FLASHCONTROL */ #define DOC_CTRL_VIOLATION … #define DOC_CTRL_CE … #define DOC_CTRL_UNKNOWN_BITS … #define DOC_CTRL_PROTECTION_ERROR … #define DOC_CTRL_SEQUENCE_ERROR … #define DOC_CTRL_FLASHREADY … /* * Flash register : DOC_ASICMODE */ #define DOC_ASICMODE_RESET … #define DOC_ASICMODE_NORMAL … #define DOC_ASICMODE_POWERDOWN … #define DOC_ASICMODE_MDWREN … #define DOC_ASICMODE_BDETCT_RESET … #define DOC_ASICMODE_RSTIN_RESET … #define DOC_ASICMODE_RAM_WE … /* * Flash register : DOC_ECCCONF0 */ #define DOC_ECCCONF0_WRITE_MODE … #define DOC_ECCCONF0_READ_MODE … #define DOC_ECCCONF0_AUTO_ECC_ENABLE … #define DOC_ECCCONF0_HAMMING_ENABLE … #define DOC_ECCCONF0_BCH_ENABLE … #define DOC_ECCCONF0_DATA_BYTES_MASK … /* * Flash register : DOC_ECCCONF1 */ #define DOC_ECCCONF1_BCH_SYNDROM_ERR … #define DOC_ECCCONF1_UNKOWN1 … #define DOC_ECCCONF1_PAGE_IS_WRITTEN … #define DOC_ECCCONF1_UNKOWN3 … #define DOC_ECCCONF1_HAMMING_BITS_MASK … /* * Flash register : DOC_PROTECTION */ #define DOC_PROTECT_FOUNDRY_OTP_LOCK … #define DOC_PROTECT_CUSTOMER_OTP_LOCK … #define DOC_PROTECT_LOCK_INPUT … #define DOC_PROTECT_STICKY_LOCK … #define DOC_PROTECT_PROTECTION_ENABLED … #define DOC_PROTECT_IPL_DOWNLOAD_LOCK … #define DOC_PROTECT_PROTECTION_ERROR … /* * Flash register : DOC_DPS0_STATUS and DOC_DPS1_STATUS */ #define DOC_DPS_OTP_PROTECTED … #define DOC_DPS_READ_PROTECTED … #define DOC_DPS_WRITE_PROTECTED … #define DOC_DPS_HW_LOCK_ENABLED … #define DOC_DPS_KEY_OK … /* * Flash register : DOC_CONFIGURATION */ #define DOC_CONF_IF_CFG … #define DOC_CONF_MAX_ID_MASK … #define DOC_CONF_VCCQ_3V … /* * Flash register : DOC_READADDRESS */ #define DOC_READADDR_INC … #define DOC_READADDR_ONE_BYTE … #define DOC_READADDR_ADDR_MASK … /* * Flash register : DOC_POWERMODE */ #define DOC_POWERDOWN_READY … /* * Status of erase and write operation */ #define DOC_PLANES_STATUS_FAIL … #define DOC_PLANES_STATUS_PLANE0_KO … #define DOC_PLANES_STATUS_PLANE1_KO … /* * DPS key management * * Each floor of docg3 has 2 protection areas: DPS0 and DPS1. These areas span * across block boundaries, and define whether these blocks can be read or * written. * The definition is dynamically stored in page 0 of blocks (2,3) for DPS0, and * page 0 of blocks (4,5) for DPS1. */ #define DOC_LAYOUT_DPS_KEY_LENGTH … /** * struct docg3_cascade - Cascade of 1 to 4 docg3 chips * @floors: floors (ie. one physical docg3 chip is one floor) * @base: IO space to access all chips in the cascade * @bch: the BCH correcting control structure * @lock: lock to protect docg3 IO space from concurrent accesses */ struct docg3_cascade { … }; /** * struct docg3 - DiskOnChip driver private data * @dev: the device currently under control * @cascade: the cascade this device belongs to * @device_id: number of the cascaded DoCG3 device (0, 1, 2 or 3) * @if_cfg: if true, reads are on 16bits, else reads are on 8bits * @reliable: if 0, docg3 in normal mode, if 1 docg3 in fast mode, if 2 in * reliable mode * Fast mode implies more errors than normal mode. * Reliable mode implies that page 2*n and 2*n+1 are clones. * @bbt: bad block table cache * @oob_write_ofs: offset of the MTD where this OOB should belong (ie. in next * page_write) * @oob_autoecc: if 1, use only bytes 0-7, 15, and fill the others with HW ECC * if 0, use all the 16 bytes. * @oob_write_buf: prepared OOB for next page_write */ struct docg3 { … }; #define doc_err(fmt, arg...) … #define doc_info(fmt, arg...) … #define doc_dbg(fmt, arg...) … #define doc_vdbg(fmt, arg...) … #endif /* * Trace events part */ #undef TRACE_SYSTEM #define TRACE_SYSTEM … #if !defined(_MTD_DOCG3_TRACE) || defined(TRACE_HEADER_MULTI_READ) #define _MTD_DOCG3_TRACE #include <linux/tracepoint.h> TRACE_EVENT(docg3_io, TP_PROTO(int op, int width, u16 reg, int val), TP_ARGS(op, width, reg, val), TP_STRUCT__entry( __field(int, op) __field(unsigned char, width) __field(u16, reg) __field(int, val)), TP_fast_assign( __entry->op = op; __entry->width = width; __entry->reg = reg; __entry->val = val;), TP_printk("docg3: %s%02d reg=%04x, val=%04x", __entry->op ? "write" : "read", __entry->width, __entry->reg, __entry->val) ); #endif /* This part must be outside protection */ #undef TRACE_INCLUDE_PATH #undef TRACE_INCLUDE_FILE #define TRACE_INCLUDE_PATH … #define TRACE_INCLUDE_FILE … #include <trace/define_trace.h>
Codebase Browser
linux