From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from metis.ext.pengutronix.de ([2001:6f8:1178:4:290:27ff:fe1d:cc33]) by bombadil.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1Z3IZh-0006wx-Ih for barebox@lists.infradead.org; Fri, 12 Jun 2015 06:36:31 +0000 From: Sascha Hauer Date: Fri, 12 Jun 2015 08:35:40 +0200 Message-Id: <1434090946-6574-5-git-send-email-s.hauer@pengutronix.de> In-Reply-To: <1434090946-6574-1-git-send-email-s.hauer@pengutronix.de> References: <1434090946-6574-1-git-send-email-s.hauer@pengutronix.de> List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "barebox" Errors-To: barebox-bounces+u.kleine-koenig=pengutronix.de@lists.infradead.org Subject: [PATCH 04/10] ARM: i.MX6: bbu nand: Move to common place To: Barebox List The code can be used on i.MX28 aswell, so move it to a common place. Signed-off-by: Sascha Hauer --- arch/arm/mach-imx/Kconfig | 9 - arch/arm/mach-imx/Makefile | 1 - arch/arm/mach-imx/imx6-bbu-nand.c | 491 ----------------------------------- arch/arm/mach-imx/include/mach/bbu.h | 9 - common/Kconfig | 8 + common/Makefile | 1 + common/imx-bbu-nand-fcb.c | 491 +++++++++++++++++++++++++++++++++++ include/bbu.h | 9 + 8 files changed, 509 insertions(+), 510 deletions(-) delete mode 100644 arch/arm/mach-imx/imx6-bbu-nand.c create mode 100644 common/imx-bbu-nand-fcb.c diff --git a/arch/arm/mach-imx/Kconfig b/arch/arm/mach-imx/Kconfig index c713477..812a9f9 100644 --- a/arch/arm/mach-imx/Kconfig +++ b/arch/arm/mach-imx/Kconfig @@ -112,15 +112,6 @@ config BAREBOX_UPDATE_IMX_EXTERNAL_NAND depends on MTD_WRITE default y -config BAREBOX_UPDATE_IMX6_NAND - bool - depends on ARCH_IMX6 - depends on BAREBOX_UPDATE - depends on MTD - depends on MTD_WRITE - depends on NAND_MXS - default y - comment "Freescale i.MX System-on-Chip" config ARCH_IMX1 diff --git a/arch/arm/mach-imx/Makefile b/arch/arm/mach-imx/Makefile index ae953b1..0c8ca4b 100644 --- a/arch/arm/mach-imx/Makefile +++ b/arch/arm/mach-imx/Makefile @@ -21,6 +21,5 @@ obj-y += devices.o imx.o esdctl.o obj-y += boot.o obj-$(CONFIG_BAREBOX_UPDATE) += imx-bbu-internal.o obj-$(CONFIG_BAREBOX_UPDATE_IMX_EXTERNAL_NAND) += imx-bbu-external-nand.o -obj-$(CONFIG_BAREBOX_UPDATE_IMX6_NAND) += imx6-bbu-nand.o pbl-y += esdctl.o lwl-y += cpu_init.o diff --git a/arch/arm/mach-imx/imx6-bbu-nand.c b/arch/arm/mach-imx/imx6-bbu-nand.c deleted file mode 100644 index d2bfedb..0000000 --- a/arch/arm/mach-imx/imx6-bbu-nand.c +++ /dev/null @@ -1,491 +0,0 @@ -/* - * Copyright (C) 2014 Sascha Hauer, Pengutronix - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of - * the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation. - * - */ - -#define pr_fmt(fmt) "imx6-bbu-nand: " fmt - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -struct dbbt_block { - uint32_t Checksum; - uint32_t FingerPrint; - uint32_t Version; - uint32_t reserved; - uint32_t DBBTNumOfPages; -}; - -struct fcb_block { - uint32_t Checksum; /* First fingerprint in first byte */ - uint32_t FingerPrint; /* 2nd fingerprint at byte 4 */ - uint32_t Version; /* 3rd fingerprint at byte 8 */ - uint8_t DataSetup; - uint8_t DataHold; - uint8_t AddressSetup; - uint8_t DSAMPLE_TIME; - /* These are for application use only and not for ROM. */ - uint8_t NandTimingState; - uint8_t REA; - uint8_t RLOH; - uint8_t RHOH; - uint32_t PageDataSize; /* 2048 for 2K pages, 4096 for 4K pages */ - uint32_t TotalPageSize; /* 2112 for 2K pages, 4314 for 4K pages */ - uint32_t SectorsPerBlock; /* Number of 2K sections per block */ - uint32_t NumberOfNANDs; /* Total Number of NANDs - not used by ROM */ - uint32_t TotalInternalDie; /* Number of separate chips in this NAND */ - uint32_t CellType; /* MLC or SLC */ - uint32_t EccBlockNEccType; /* Type of ECC, can be one of BCH-0-20 */ - uint32_t EccBlock0Size; /* Number of bytes for Block0 - BCH */ - uint32_t EccBlockNSize; /* Block size in bytes for all blocks other than Block0 - BCH */ - uint32_t EccBlock0EccType; /* Ecc level for Block 0 - BCH */ - uint32_t MetadataBytes; /* Metadata size - BCH */ - uint32_t NumEccBlocksPerPage; /* Number of blocks per page for ROM use - BCH */ - uint32_t EccBlockNEccLevelSDK; /* Type of ECC, can be one of BCH-0-20 */ - uint32_t EccBlock0SizeSDK; /* Number of bytes for Block0 - BCH */ - uint32_t EccBlockNSizeSDK; /* Block size in bytes for all blocks other than Block0 - BCH */ - uint32_t EccBlock0EccLevelSDK; /* Ecc level for Block 0 - BCH */ - uint32_t NumEccBlocksPerPageSDK;/* Number of blocks per page for SDK use - BCH */ - uint32_t MetadataBytesSDK; /* Metadata size - BCH */ - uint32_t EraseThreshold; /* To set into BCH_MODE register */ - uint32_t BootPatch; /* 0 for normal boot and 1 to load patch starting next to FCB */ - uint32_t PatchSectors; /* Size of patch in sectors */ - uint32_t Firmware1_startingPage;/* Firmware image starts on this sector */ - uint32_t Firmware2_startingPage;/* Secondary FW Image starting Sector */ - uint32_t PagesInFirmware1; /* Number of sectors in firmware image */ - uint32_t PagesInFirmware2; /* Number of sector in secondary FW image */ - uint32_t DBBTSearchAreaStartAddress; /* Page address where dbbt search area begins */ - uint32_t BadBlockMarkerByte; /* Byte in page data that have manufacturer marked bad block marker, */ - /* this will be swapped with metadata[0] to complete page data. */ - uint32_t BadBlockMarkerStartBit;/* For BCH ECC sizes other than 8 and 16 the bad block marker does not */ - /* start at 0th bit of BadBlockMarkerByte. This field is used to get to */ - /* the start bit of bad block marker byte with in BadBlockMarkerByte */ - uint32_t BBMarkerPhysicalOffset;/* FCB value that gives byte offset for bad block marker on physical NAND page */ - uint32_t BCHType; - - uint32_t TMTiming2_ReadLatency; - uint32_t TMTiming2_PreambleDelay; - uint32_t TMTiming2_CEDelay; - uint32_t TMTiming2_PostambleDelay; - uint32_t TMTiming2_CmdAddPause; - uint32_t TMTiming2_DataPause; - uint32_t TMSpeed; - uint32_t TMTiming1_BusyTimeout; - - uint32_t DISBBM; /* the flag to enable (1)/disable(0) bi swap */ - uint32_t BBMarkerPhysicalOffsetInSpareData; /* The swap position of main area in spare area */ -}; - -#define BF_VAL(v, bf) (((v) & bf##_MASK) >> bf##_OFFSET) -#define GETBIT(v,n) (((v) >> (n)) & 0x1) - -static uint8_t calculate_parity_13_8(uint8_t d) -{ - uint8_t p = 0; - - p |= (GETBIT(d, 6) ^ GETBIT(d, 5) ^ GETBIT(d, 3) ^ GETBIT(d, 2)) << 0; - p |= (GETBIT(d, 7) ^ GETBIT(d, 5) ^ GETBIT(d, 4) ^ GETBIT(d, 2) ^ GETBIT(d, 1)) << 1; - p |= (GETBIT(d, 7) ^ GETBIT(d, 6) ^ GETBIT(d, 5) ^ GETBIT(d, 1) ^ GETBIT(d, 0)) << 2; - p |= (GETBIT(d, 7) ^ GETBIT(d, 4) ^ GETBIT(d, 3) ^ GETBIT(d, 0)) << 3; - p |= (GETBIT(d, 6) ^ GETBIT(d, 4) ^ GETBIT(d, 3) ^ GETBIT(d, 2) ^ GETBIT(d, 1) ^ GETBIT(d, 0)) << 4; - return p; -} - -static void encode_hamming_13_8(void *_src, void *_ecc, size_t size) -{ - int i; - uint8_t *src = _src; - uint8_t *ecc = _ecc; - - for (i = 0; i < size; i++) - ecc[i] = calculate_parity_13_8(src[i]); -} - -static uint32_t calc_chksum(void *buf, size_t size) -{ - u32 chksum = 0; - u8 *bp = buf; - size_t i; - - for (i = 0; i < size; i++) - chksum += bp[i]; - - return ~chksum; -} - -static __maybe_unused void dump_fcb(void *buf) -{ - struct fcb_block *fcb = buf; - - pr_debug("Checksum: 0x%08x\n", fcb->Checksum); - pr_debug("FingerPrint: 0x%08x\n", fcb->FingerPrint); - pr_debug("Version: 0x%08x\n", fcb->Version); - pr_debug("DataSetup: 0x%02x\n", fcb->DataSetup); - pr_debug("DataHold: 0x%02x\n", fcb->DataHold); - pr_debug("AddressSetup: 0x%02x\n", fcb->AddressSetup); - pr_debug("DSAMPLE_TIME: 0x%02x\n", fcb->DSAMPLE_TIME); - pr_debug("NandTimingState: 0x%02x\n", fcb->NandTimingState); - pr_debug("REA: 0x%02x\n", fcb->REA); - pr_debug("RLOH: 0x%02x\n", fcb->RLOH); - pr_debug("RHOH: 0x%02x\n", fcb->RHOH); - pr_debug("PageDataSize: 0x%08x\n", fcb->PageDataSize); - pr_debug("TotalPageSize: 0x%08x\n", fcb->TotalPageSize); - pr_debug("SectorsPerBlock: 0x%08x\n", fcb->SectorsPerBlock); - pr_debug("NumberOfNANDs: 0x%08x\n", fcb->NumberOfNANDs); - pr_debug("TotalInternalDie: 0x%08x\n", fcb->TotalInternalDie); - pr_debug("CellType: 0x%08x\n", fcb->CellType); - pr_debug("EccBlockNEccType: 0x%08x\n", fcb->EccBlockNEccType); - pr_debug("EccBlock0Size: 0x%08x\n", fcb->EccBlock0Size); - pr_debug("EccBlockNSize: 0x%08x\n", fcb->EccBlockNSize); - pr_debug("EccBlock0EccType: 0x%08x\n", fcb->EccBlock0EccType); - pr_debug("MetadataBytes: 0x%08x\n", fcb->MetadataBytes); - pr_debug("NumEccBlocksPerPage: 0x%08x\n", fcb->NumEccBlocksPerPage); - pr_debug("EccBlockNEccLevelSDK: 0x%08x\n", fcb->EccBlockNEccLevelSDK); - pr_debug("EccBlock0SizeSDK: 0x%08x\n", fcb->EccBlock0SizeSDK); - pr_debug("EccBlockNSizeSDK: 0x%08x\n", fcb->EccBlockNSizeSDK); - pr_debug("EccBlock0EccLevelSDK: 0x%08x\n", fcb->EccBlock0EccLevelSDK); - pr_debug("NumEccBlocksPerPageSDK: 0x%08x\n", fcb->NumEccBlocksPerPageSDK); - pr_debug("MetadataBytesSDK: 0x%08x\n", fcb->MetadataBytesSDK); - pr_debug("EraseThreshold: 0x%08x\n", fcb->EraseThreshold); - pr_debug("BootPatch: 0x%08x\n", fcb->BootPatch); - pr_debug("PatchSectors: 0x%08x\n", fcb->PatchSectors); - pr_debug("Firmware1_startingPage: 0x%08x\n", fcb->Firmware1_startingPage); - pr_debug("Firmware2_startingPage: 0x%08x\n", fcb->Firmware2_startingPage); - pr_debug("PagesInFirmware1: 0x%08x\n", fcb->PagesInFirmware1); - pr_debug("PagesInFirmware2: 0x%08x\n", fcb->PagesInFirmware2); - pr_debug("DBBTSearchAreaStartAddress: 0x%08x\n", fcb->DBBTSearchAreaStartAddress); - pr_debug("BadBlockMarkerByte: 0x%08x\n", fcb->BadBlockMarkerByte); - pr_debug("BadBlockMarkerStartBit: 0x%08x\n", fcb->BadBlockMarkerStartBit); - pr_debug("BBMarkerPhysicalOffset: 0x%08x\n", fcb->BBMarkerPhysicalOffset); - pr_debug("BCHType: 0x%08x\n", fcb->BCHType); - pr_debug("TMTiming2_ReadLatency: 0x%08x\n", fcb->TMTiming2_ReadLatency); - pr_debug("TMTiming2_PreambleDelay: 0x%08x\n", fcb->TMTiming2_PreambleDelay); - pr_debug("TMTiming2_CEDelay: 0x%08x\n", fcb->TMTiming2_CEDelay); - pr_debug("TMTiming2_PostambleDelay: 0x%08x\n", fcb->TMTiming2_PostambleDelay); - pr_debug("TMTiming2_CmdAddPause: 0x%08x\n", fcb->TMTiming2_CmdAddPause); - pr_debug("TMTiming2_DataPause: 0x%08x\n", fcb->TMTiming2_DataPause); - pr_debug("TMSpeed: 0x%08x\n", fcb->TMSpeed); - pr_debug("TMTiming1_BusyTimeout: 0x%08x\n", fcb->TMTiming1_BusyTimeout); - pr_debug("DISBBM: 0x%08x\n", fcb->DISBBM); - pr_debug("BBMarkerPhysOfsInSpareData: 0x%08x\n", fcb->BBMarkerPhysicalOffsetInSpareData); -} - -static __maybe_unused ssize_t raw_read_page(struct mtd_info *mtd, void *dst, loff_t offset) -{ - struct mtd_oob_ops ops; - ssize_t ret; - - ops.mode = MTD_OPS_RAW; - ops.ooboffs = 0; - ops.datbuf = dst; - ops.len = mtd->writesize; - ops.oobbuf = dst + mtd->writesize; - ops.ooblen = mtd->oobsize; - ret = mtd_read_oob(mtd, offset, &ops); - - return ret; -} - -static ssize_t raw_write_page(struct mtd_info *mtd, void *buf, loff_t offset) -{ - struct mtd_oob_ops ops; - ssize_t ret; - - ops.mode = MTD_OPS_RAW; - ops.ooboffs = 0; - ops.datbuf = buf; - ops.len = mtd->writesize; - ops.oobbuf = buf + mtd->writesize; - ops.ooblen = mtd->oobsize; - ret = mtd_write_oob(mtd, offset, &ops); - - return ret; -} - -static int fcb_create(struct fcb_block *fcb, struct mtd_info *mtd) -{ - fcb->FingerPrint = 0x20424346; - fcb->Version = 0x01000000; - fcb->PageDataSize = mtd->writesize; - fcb->TotalPageSize = mtd->writesize + mtd->oobsize; - fcb->SectorsPerBlock = mtd->erasesize / mtd->writesize; - - /* Divide ECC strength by two and save the value into FCB structure. */ - fcb->EccBlock0EccType = - mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize) >> 1; - fcb->EccBlockNEccType = fcb->EccBlock0EccType; - - /* Also hardcoded in kobs-ng */ - fcb->DataSetup = 80; - fcb->DataHold = 60; - fcb->AddressSetup = 25; - fcb->DSAMPLE_TIME = 6; - fcb->MetadataBytes = 0x0000000a; - fcb->EccBlock0Size = 0x00000200; - fcb->EccBlockNSize = 0x00000200; - - fcb->NumEccBlocksPerPage = mtd->writesize / fcb->EccBlock0Size - 1; - - /* DBBT search area starts at third block */ - fcb->DBBTSearchAreaStartAddress = mtd->erasesize / mtd->writesize * 2; - - fcb->BadBlockMarkerByte = mxs_nand_mark_byte_offset(mtd); - fcb->BadBlockMarkerStartBit = mxs_nand_mark_bit_offset(mtd); - - fcb->BBMarkerPhysicalOffset = mtd->writesize; - - fcb->Checksum = calc_chksum((void *)fcb + 4, sizeof(*fcb) - 4); - - return 0; -} - -static int imx6_bbu_erase(struct mtd_info *mtd) -{ - uint64_t offset = 0; - int len = SZ_2M; - struct erase_info erase; - int ret; - - while (len > 0) { - pr_debug("erasing at 0x%08llx\n", offset); - if (mtd_block_isbad(mtd, offset)) { - offset += mtd->erasesize; - pr_debug("erase skip block @ 0x%08llx\n", offset); - continue; - } - - memset(&erase, 0, sizeof(erase)); - erase.addr = offset; - erase.len = mtd->erasesize; - - ret = mtd_erase(mtd, &erase); - if (ret) - return ret; - - offset += mtd->erasesize; - len -= mtd->erasesize; - } - - return 0; -} - -static int imx6_bbu_write_firmware(struct mtd_info *mtd, int block, void *buf, size_t len) -{ - uint64_t offset = block * mtd->erasesize; - int ret; - size_t written; - - while (len > 0) { - int now = min(len, mtd->erasesize); - - pr_debug("writing %p at 0x%08llx, left 0x%08x\n", - buf, offset, len); - - if (mtd_block_isbad(mtd, offset)) { - offset += mtd->erasesize; - block++; - pr_debug("write skip block @ 0x%08llx\n", offset); - continue; - } - - ret = mtd_write(mtd, offset, now, &written, buf); - if (ret) - return ret; - - offset += now; - len -= now; - buf += now; - block++; - } - - return block; -} - -static int dbbt_data_create(struct mtd_info *mtd, void *buf, int block_last) -{ - int n; - int n_bad_blocks = 0; - uint32_t *bb = buf + 0x8; - uint32_t *n_bad_blocksp = buf + 0x4; - - for (n = 0; n <= block_last; n++) { - loff_t offset = n * mtd->erasesize; - if (mtd_block_isbad(mtd, offset)) { - n_bad_blocks++; - *bb = n; - bb++; - } - } - - *n_bad_blocksp = n_bad_blocks; - - return n_bad_blocks; -} - -static int imx6_bbu_nand_update(struct bbu_handler *handler, struct bbu_data *data) -{ - struct cdev *bcb_cdev; - struct mtd_info *mtd; - int ret, block_fw1, block_fw2, block_last; - struct fcb_block *fcb; - struct dbbt_block *dbbt; - void *fcb_raw_page, *dbbt_page, *dbbt_data_page; - void *ecc; - int written; - void *fw; - unsigned fw_size; - int i; - - if (file_detect_type(data->image, data->len) != filetype_arm_barebox && - !bbu_force(data, "Not an ARM barebox image")) - return -EINVAL; - - ret = bbu_confirm(data); - if (ret) - return ret; - - bcb_cdev = cdev_by_name("nand0"); - if (!bcb_cdev) { - pr_err("%s: No FCB device!\n", __func__); - return -ENODEV; - } - - mtd = bcb_cdev->mtd; - - fcb_raw_page = xzalloc(mtd->writesize + mtd->oobsize); - - fcb = fcb_raw_page + 12; - ecc = fcb_raw_page + 512 + 12; - - dbbt_page = xzalloc(mtd->writesize); - dbbt_data_page = xzalloc(mtd->writesize); - dbbt = dbbt_page; - - /* - * We have to write one additional page to make the ROM happy. - * Maybe the PagesInFirmwarex fields are really the number of pages - 1. - * kobs-ng has the same. - */ - fw_size = ALIGN(data->len + mtd->writesize, mtd->writesize); - fw = xzalloc(fw_size); - memcpy(fw, data->image, data->len); - - block_fw1 = 4; - - ret = imx6_bbu_erase(mtd); - if (ret) - goto out; - - ret = imx6_bbu_write_firmware(mtd, block_fw1, fw, fw_size); - if (ret < 0) - goto out; - - block_fw2 = ret; - - ret = imx6_bbu_write_firmware(mtd, block_fw2, fw, fw_size); - if (ret < 0) - goto out; - - block_last = ret; - - fcb->Firmware1_startingPage = block_fw1 * mtd->erasesize / mtd->writesize; - fcb->Firmware2_startingPage = block_fw2 * mtd->erasesize / mtd->writesize; - fcb->PagesInFirmware1 = ALIGN(data->len, mtd->writesize) / mtd->writesize; - fcb->PagesInFirmware2 = fcb->PagesInFirmware1; - - fcb_create(fcb, mtd); - encode_hamming_13_8(fcb, ecc, 512); - - /* - * Set the first and second byte of OOB data to 0xFF, not 0x00. These - * bytes are used as the Manufacturers Bad Block Marker (MBBM). Since - * the FCB is mostly written to the first page in a block, a scan for - * factory bad blocks will detect these blocks as bad, e.g. when - * function nand_scan_bbt() is executed to build a new bad block table. - */ - memset(fcb_raw_page + mtd->writesize, 0xFF, 2); - - ret = raw_write_page(mtd, fcb_raw_page, 0); - if (ret) - goto out; - - ret = raw_write_page(mtd, fcb_raw_page, mtd->erasesize); - if (ret) - goto out; - - dbbt->Checksum = 0; - dbbt->FingerPrint = 0x54424244; - dbbt->Version = 0x01000000; - - ret = dbbt_data_create(mtd, dbbt_data_page, block_last); - if (ret < 0) - goto out; - - if (ret > 0) - dbbt->DBBTNumOfPages = 1; - - for (i = 2; i < 4; i++) { - ret = mtd_write(mtd, mtd->erasesize * i, 2048, &written, dbbt_page); - if (ret) - goto out; - - if (dbbt->DBBTNumOfPages > 0) { - ret = mtd_write(mtd, mtd->erasesize * i + mtd->writesize * 4, - 2048, &written, dbbt_data_page); - if (ret) - goto out; - } - } - -out: - free(dbbt_page); - free(dbbt_data_page); - free(fcb_raw_page); - free(fw); - - return ret; -} - -int imx6_bbu_nand_register_handler(const char *name, unsigned long flags) -{ - struct bbu_handler *handler; - int ret; - - handler = xzalloc(sizeof(*handler)); - handler->devicefile = "/dev/nand0"; - handler->name = name; - handler->flags = flags; - handler->handler = imx6_bbu_nand_update; - - ret = bbu_register_handler(handler); - if (ret) - free(handler); - - return ret; -} diff --git a/arch/arm/mach-imx/include/mach/bbu.h b/arch/arm/mach-imx/include/mach/bbu.h index 5eb9a47..8039091 100644 --- a/arch/arm/mach-imx/include/mach/bbu.h +++ b/arch/arm/mach-imx/include/mach/bbu.h @@ -75,15 +75,6 @@ static inline int imx_bbu_external_nor_register_handler(const char *name, char * } #endif -#if defined(CONFIG_BAREBOX_UPDATE_IMX6_NAND) -int imx6_bbu_nand_register_handler(const char *name, unsigned long flags); -#else -static inline int imx6_bbu_nand_register_handler(const char *name, unsigned long flags) -{ - return -ENOSYS; -} -#endif - #if defined(CONFIG_BAREBOX_UPDATE_IMX_EXTERNAL_NAND) int imx_bbu_external_nand_register_handler(const char *name, char *devicefile, unsigned long flags); diff --git a/common/Kconfig b/common/Kconfig index 1c5d14c..0ebfe1e 100644 --- a/common/Kconfig +++ b/common/Kconfig @@ -94,6 +94,14 @@ config EFI_DEVICEPATH config FILE_LIST bool +config BAREBOX_UPDATE_IMX_NAND_FCB + bool + depends on ARCH_IMX6 + depends on BAREBOX_UPDATE + depends on MTD_WRITE + depends on NAND_MXS + default y + menu "General Settings" config LOCALVERSION diff --git a/common/Makefile b/common/Makefile index 2738238..74801f7 100644 --- a/common/Makefile +++ b/common/Makefile @@ -52,6 +52,7 @@ lwl-$(CONFIG_IMD) += imd-barebox.o obj-$(CONFIG_IMD) += imd.o obj-$(CONFIG_FILE_LIST) += file-list.o obj-$(CONFIG_FIRMWARE) += firmware.o +obj-$(CONFIG_BAREBOX_UPDATE_IMX_NAND_FCB) += imx-bbu-nand-fcb.o quiet_cmd_pwd_h = PWDH $@ ifdef CONFIG_PASSWORD diff --git a/common/imx-bbu-nand-fcb.c b/common/imx-bbu-nand-fcb.c new file mode 100644 index 0000000..d2bfedb --- /dev/null +++ b/common/imx-bbu-nand-fcb.c @@ -0,0 +1,491 @@ +/* + * Copyright (C) 2014 Sascha Hauer, Pengutronix + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of + * the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation. + * + */ + +#define pr_fmt(fmt) "imx6-bbu-nand: " fmt + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +struct dbbt_block { + uint32_t Checksum; + uint32_t FingerPrint; + uint32_t Version; + uint32_t reserved; + uint32_t DBBTNumOfPages; +}; + +struct fcb_block { + uint32_t Checksum; /* First fingerprint in first byte */ + uint32_t FingerPrint; /* 2nd fingerprint at byte 4 */ + uint32_t Version; /* 3rd fingerprint at byte 8 */ + uint8_t DataSetup; + uint8_t DataHold; + uint8_t AddressSetup; + uint8_t DSAMPLE_TIME; + /* These are for application use only and not for ROM. */ + uint8_t NandTimingState; + uint8_t REA; + uint8_t RLOH; + uint8_t RHOH; + uint32_t PageDataSize; /* 2048 for 2K pages, 4096 for 4K pages */ + uint32_t TotalPageSize; /* 2112 for 2K pages, 4314 for 4K pages */ + uint32_t SectorsPerBlock; /* Number of 2K sections per block */ + uint32_t NumberOfNANDs; /* Total Number of NANDs - not used by ROM */ + uint32_t TotalInternalDie; /* Number of separate chips in this NAND */ + uint32_t CellType; /* MLC or SLC */ + uint32_t EccBlockNEccType; /* Type of ECC, can be one of BCH-0-20 */ + uint32_t EccBlock0Size; /* Number of bytes for Block0 - BCH */ + uint32_t EccBlockNSize; /* Block size in bytes for all blocks other than Block0 - BCH */ + uint32_t EccBlock0EccType; /* Ecc level for Block 0 - BCH */ + uint32_t MetadataBytes; /* Metadata size - BCH */ + uint32_t NumEccBlocksPerPage; /* Number of blocks per page for ROM use - BCH */ + uint32_t EccBlockNEccLevelSDK; /* Type of ECC, can be one of BCH-0-20 */ + uint32_t EccBlock0SizeSDK; /* Number of bytes for Block0 - BCH */ + uint32_t EccBlockNSizeSDK; /* Block size in bytes for all blocks other than Block0 - BCH */ + uint32_t EccBlock0EccLevelSDK; /* Ecc level for Block 0 - BCH */ + uint32_t NumEccBlocksPerPageSDK;/* Number of blocks per page for SDK use - BCH */ + uint32_t MetadataBytesSDK; /* Metadata size - BCH */ + uint32_t EraseThreshold; /* To set into BCH_MODE register */ + uint32_t BootPatch; /* 0 for normal boot and 1 to load patch starting next to FCB */ + uint32_t PatchSectors; /* Size of patch in sectors */ + uint32_t Firmware1_startingPage;/* Firmware image starts on this sector */ + uint32_t Firmware2_startingPage;/* Secondary FW Image starting Sector */ + uint32_t PagesInFirmware1; /* Number of sectors in firmware image */ + uint32_t PagesInFirmware2; /* Number of sector in secondary FW image */ + uint32_t DBBTSearchAreaStartAddress; /* Page address where dbbt search area begins */ + uint32_t BadBlockMarkerByte; /* Byte in page data that have manufacturer marked bad block marker, */ + /* this will be swapped with metadata[0] to complete page data. */ + uint32_t BadBlockMarkerStartBit;/* For BCH ECC sizes other than 8 and 16 the bad block marker does not */ + /* start at 0th bit of BadBlockMarkerByte. This field is used to get to */ + /* the start bit of bad block marker byte with in BadBlockMarkerByte */ + uint32_t BBMarkerPhysicalOffset;/* FCB value that gives byte offset for bad block marker on physical NAND page */ + uint32_t BCHType; + + uint32_t TMTiming2_ReadLatency; + uint32_t TMTiming2_PreambleDelay; + uint32_t TMTiming2_CEDelay; + uint32_t TMTiming2_PostambleDelay; + uint32_t TMTiming2_CmdAddPause; + uint32_t TMTiming2_DataPause; + uint32_t TMSpeed; + uint32_t TMTiming1_BusyTimeout; + + uint32_t DISBBM; /* the flag to enable (1)/disable(0) bi swap */ + uint32_t BBMarkerPhysicalOffsetInSpareData; /* The swap position of main area in spare area */ +}; + +#define BF_VAL(v, bf) (((v) & bf##_MASK) >> bf##_OFFSET) +#define GETBIT(v,n) (((v) >> (n)) & 0x1) + +static uint8_t calculate_parity_13_8(uint8_t d) +{ + uint8_t p = 0; + + p |= (GETBIT(d, 6) ^ GETBIT(d, 5) ^ GETBIT(d, 3) ^ GETBIT(d, 2)) << 0; + p |= (GETBIT(d, 7) ^ GETBIT(d, 5) ^ GETBIT(d, 4) ^ GETBIT(d, 2) ^ GETBIT(d, 1)) << 1; + p |= (GETBIT(d, 7) ^ GETBIT(d, 6) ^ GETBIT(d, 5) ^ GETBIT(d, 1) ^ GETBIT(d, 0)) << 2; + p |= (GETBIT(d, 7) ^ GETBIT(d, 4) ^ GETBIT(d, 3) ^ GETBIT(d, 0)) << 3; + p |= (GETBIT(d, 6) ^ GETBIT(d, 4) ^ GETBIT(d, 3) ^ GETBIT(d, 2) ^ GETBIT(d, 1) ^ GETBIT(d, 0)) << 4; + return p; +} + +static void encode_hamming_13_8(void *_src, void *_ecc, size_t size) +{ + int i; + uint8_t *src = _src; + uint8_t *ecc = _ecc; + + for (i = 0; i < size; i++) + ecc[i] = calculate_parity_13_8(src[i]); +} + +static uint32_t calc_chksum(void *buf, size_t size) +{ + u32 chksum = 0; + u8 *bp = buf; + size_t i; + + for (i = 0; i < size; i++) + chksum += bp[i]; + + return ~chksum; +} + +static __maybe_unused void dump_fcb(void *buf) +{ + struct fcb_block *fcb = buf; + + pr_debug("Checksum: 0x%08x\n", fcb->Checksum); + pr_debug("FingerPrint: 0x%08x\n", fcb->FingerPrint); + pr_debug("Version: 0x%08x\n", fcb->Version); + pr_debug("DataSetup: 0x%02x\n", fcb->DataSetup); + pr_debug("DataHold: 0x%02x\n", fcb->DataHold); + pr_debug("AddressSetup: 0x%02x\n", fcb->AddressSetup); + pr_debug("DSAMPLE_TIME: 0x%02x\n", fcb->DSAMPLE_TIME); + pr_debug("NandTimingState: 0x%02x\n", fcb->NandTimingState); + pr_debug("REA: 0x%02x\n", fcb->REA); + pr_debug("RLOH: 0x%02x\n", fcb->RLOH); + pr_debug("RHOH: 0x%02x\n", fcb->RHOH); + pr_debug("PageDataSize: 0x%08x\n", fcb->PageDataSize); + pr_debug("TotalPageSize: 0x%08x\n", fcb->TotalPageSize); + pr_debug("SectorsPerBlock: 0x%08x\n", fcb->SectorsPerBlock); + pr_debug("NumberOfNANDs: 0x%08x\n", fcb->NumberOfNANDs); + pr_debug("TotalInternalDie: 0x%08x\n", fcb->TotalInternalDie); + pr_debug("CellType: 0x%08x\n", fcb->CellType); + pr_debug("EccBlockNEccType: 0x%08x\n", fcb->EccBlockNEccType); + pr_debug("EccBlock0Size: 0x%08x\n", fcb->EccBlock0Size); + pr_debug("EccBlockNSize: 0x%08x\n", fcb->EccBlockNSize); + pr_debug("EccBlock0EccType: 0x%08x\n", fcb->EccBlock0EccType); + pr_debug("MetadataBytes: 0x%08x\n", fcb->MetadataBytes); + pr_debug("NumEccBlocksPerPage: 0x%08x\n", fcb->NumEccBlocksPerPage); + pr_debug("EccBlockNEccLevelSDK: 0x%08x\n", fcb->EccBlockNEccLevelSDK); + pr_debug("EccBlock0SizeSDK: 0x%08x\n", fcb->EccBlock0SizeSDK); + pr_debug("EccBlockNSizeSDK: 0x%08x\n", fcb->EccBlockNSizeSDK); + pr_debug("EccBlock0EccLevelSDK: 0x%08x\n", fcb->EccBlock0EccLevelSDK); + pr_debug("NumEccBlocksPerPageSDK: 0x%08x\n", fcb->NumEccBlocksPerPageSDK); + pr_debug("MetadataBytesSDK: 0x%08x\n", fcb->MetadataBytesSDK); + pr_debug("EraseThreshold: 0x%08x\n", fcb->EraseThreshold); + pr_debug("BootPatch: 0x%08x\n", fcb->BootPatch); + pr_debug("PatchSectors: 0x%08x\n", fcb->PatchSectors); + pr_debug("Firmware1_startingPage: 0x%08x\n", fcb->Firmware1_startingPage); + pr_debug("Firmware2_startingPage: 0x%08x\n", fcb->Firmware2_startingPage); + pr_debug("PagesInFirmware1: 0x%08x\n", fcb->PagesInFirmware1); + pr_debug("PagesInFirmware2: 0x%08x\n", fcb->PagesInFirmware2); + pr_debug("DBBTSearchAreaStartAddress: 0x%08x\n", fcb->DBBTSearchAreaStartAddress); + pr_debug("BadBlockMarkerByte: 0x%08x\n", fcb->BadBlockMarkerByte); + pr_debug("BadBlockMarkerStartBit: 0x%08x\n", fcb->BadBlockMarkerStartBit); + pr_debug("BBMarkerPhysicalOffset: 0x%08x\n", fcb->BBMarkerPhysicalOffset); + pr_debug("BCHType: 0x%08x\n", fcb->BCHType); + pr_debug("TMTiming2_ReadLatency: 0x%08x\n", fcb->TMTiming2_ReadLatency); + pr_debug("TMTiming2_PreambleDelay: 0x%08x\n", fcb->TMTiming2_PreambleDelay); + pr_debug("TMTiming2_CEDelay: 0x%08x\n", fcb->TMTiming2_CEDelay); + pr_debug("TMTiming2_PostambleDelay: 0x%08x\n", fcb->TMTiming2_PostambleDelay); + pr_debug("TMTiming2_CmdAddPause: 0x%08x\n", fcb->TMTiming2_CmdAddPause); + pr_debug("TMTiming2_DataPause: 0x%08x\n", fcb->TMTiming2_DataPause); + pr_debug("TMSpeed: 0x%08x\n", fcb->TMSpeed); + pr_debug("TMTiming1_BusyTimeout: 0x%08x\n", fcb->TMTiming1_BusyTimeout); + pr_debug("DISBBM: 0x%08x\n", fcb->DISBBM); + pr_debug("BBMarkerPhysOfsInSpareData: 0x%08x\n", fcb->BBMarkerPhysicalOffsetInSpareData); +} + +static __maybe_unused ssize_t raw_read_page(struct mtd_info *mtd, void *dst, loff_t offset) +{ + struct mtd_oob_ops ops; + ssize_t ret; + + ops.mode = MTD_OPS_RAW; + ops.ooboffs = 0; + ops.datbuf = dst; + ops.len = mtd->writesize; + ops.oobbuf = dst + mtd->writesize; + ops.ooblen = mtd->oobsize; + ret = mtd_read_oob(mtd, offset, &ops); + + return ret; +} + +static ssize_t raw_write_page(struct mtd_info *mtd, void *buf, loff_t offset) +{ + struct mtd_oob_ops ops; + ssize_t ret; + + ops.mode = MTD_OPS_RAW; + ops.ooboffs = 0; + ops.datbuf = buf; + ops.len = mtd->writesize; + ops.oobbuf = buf + mtd->writesize; + ops.ooblen = mtd->oobsize; + ret = mtd_write_oob(mtd, offset, &ops); + + return ret; +} + +static int fcb_create(struct fcb_block *fcb, struct mtd_info *mtd) +{ + fcb->FingerPrint = 0x20424346; + fcb->Version = 0x01000000; + fcb->PageDataSize = mtd->writesize; + fcb->TotalPageSize = mtd->writesize + mtd->oobsize; + fcb->SectorsPerBlock = mtd->erasesize / mtd->writesize; + + /* Divide ECC strength by two and save the value into FCB structure. */ + fcb->EccBlock0EccType = + mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize) >> 1; + fcb->EccBlockNEccType = fcb->EccBlock0EccType; + + /* Also hardcoded in kobs-ng */ + fcb->DataSetup = 80; + fcb->DataHold = 60; + fcb->AddressSetup = 25; + fcb->DSAMPLE_TIME = 6; + fcb->MetadataBytes = 0x0000000a; + fcb->EccBlock0Size = 0x00000200; + fcb->EccBlockNSize = 0x00000200; + + fcb->NumEccBlocksPerPage = mtd->writesize / fcb->EccBlock0Size - 1; + + /* DBBT search area starts at third block */ + fcb->DBBTSearchAreaStartAddress = mtd->erasesize / mtd->writesize * 2; + + fcb->BadBlockMarkerByte = mxs_nand_mark_byte_offset(mtd); + fcb->BadBlockMarkerStartBit = mxs_nand_mark_bit_offset(mtd); + + fcb->BBMarkerPhysicalOffset = mtd->writesize; + + fcb->Checksum = calc_chksum((void *)fcb + 4, sizeof(*fcb) - 4); + + return 0; +} + +static int imx6_bbu_erase(struct mtd_info *mtd) +{ + uint64_t offset = 0; + int len = SZ_2M; + struct erase_info erase; + int ret; + + while (len > 0) { + pr_debug("erasing at 0x%08llx\n", offset); + if (mtd_block_isbad(mtd, offset)) { + offset += mtd->erasesize; + pr_debug("erase skip block @ 0x%08llx\n", offset); + continue; + } + + memset(&erase, 0, sizeof(erase)); + erase.addr = offset; + erase.len = mtd->erasesize; + + ret = mtd_erase(mtd, &erase); + if (ret) + return ret; + + offset += mtd->erasesize; + len -= mtd->erasesize; + } + + return 0; +} + +static int imx6_bbu_write_firmware(struct mtd_info *mtd, int block, void *buf, size_t len) +{ + uint64_t offset = block * mtd->erasesize; + int ret; + size_t written; + + while (len > 0) { + int now = min(len, mtd->erasesize); + + pr_debug("writing %p at 0x%08llx, left 0x%08x\n", + buf, offset, len); + + if (mtd_block_isbad(mtd, offset)) { + offset += mtd->erasesize; + block++; + pr_debug("write skip block @ 0x%08llx\n", offset); + continue; + } + + ret = mtd_write(mtd, offset, now, &written, buf); + if (ret) + return ret; + + offset += now; + len -= now; + buf += now; + block++; + } + + return block; +} + +static int dbbt_data_create(struct mtd_info *mtd, void *buf, int block_last) +{ + int n; + int n_bad_blocks = 0; + uint32_t *bb = buf + 0x8; + uint32_t *n_bad_blocksp = buf + 0x4; + + for (n = 0; n <= block_last; n++) { + loff_t offset = n * mtd->erasesize; + if (mtd_block_isbad(mtd, offset)) { + n_bad_blocks++; + *bb = n; + bb++; + } + } + + *n_bad_blocksp = n_bad_blocks; + + return n_bad_blocks; +} + +static int imx6_bbu_nand_update(struct bbu_handler *handler, struct bbu_data *data) +{ + struct cdev *bcb_cdev; + struct mtd_info *mtd; + int ret, block_fw1, block_fw2, block_last; + struct fcb_block *fcb; + struct dbbt_block *dbbt; + void *fcb_raw_page, *dbbt_page, *dbbt_data_page; + void *ecc; + int written; + void *fw; + unsigned fw_size; + int i; + + if (file_detect_type(data->image, data->len) != filetype_arm_barebox && + !bbu_force(data, "Not an ARM barebox image")) + return -EINVAL; + + ret = bbu_confirm(data); + if (ret) + return ret; + + bcb_cdev = cdev_by_name("nand0"); + if (!bcb_cdev) { + pr_err("%s: No FCB device!\n", __func__); + return -ENODEV; + } + + mtd = bcb_cdev->mtd; + + fcb_raw_page = xzalloc(mtd->writesize + mtd->oobsize); + + fcb = fcb_raw_page + 12; + ecc = fcb_raw_page + 512 + 12; + + dbbt_page = xzalloc(mtd->writesize); + dbbt_data_page = xzalloc(mtd->writesize); + dbbt = dbbt_page; + + /* + * We have to write one additional page to make the ROM happy. + * Maybe the PagesInFirmwarex fields are really the number of pages - 1. + * kobs-ng has the same. + */ + fw_size = ALIGN(data->len + mtd->writesize, mtd->writesize); + fw = xzalloc(fw_size); + memcpy(fw, data->image, data->len); + + block_fw1 = 4; + + ret = imx6_bbu_erase(mtd); + if (ret) + goto out; + + ret = imx6_bbu_write_firmware(mtd, block_fw1, fw, fw_size); + if (ret < 0) + goto out; + + block_fw2 = ret; + + ret = imx6_bbu_write_firmware(mtd, block_fw2, fw, fw_size); + if (ret < 0) + goto out; + + block_last = ret; + + fcb->Firmware1_startingPage = block_fw1 * mtd->erasesize / mtd->writesize; + fcb->Firmware2_startingPage = block_fw2 * mtd->erasesize / mtd->writesize; + fcb->PagesInFirmware1 = ALIGN(data->len, mtd->writesize) / mtd->writesize; + fcb->PagesInFirmware2 = fcb->PagesInFirmware1; + + fcb_create(fcb, mtd); + encode_hamming_13_8(fcb, ecc, 512); + + /* + * Set the first and second byte of OOB data to 0xFF, not 0x00. These + * bytes are used as the Manufacturers Bad Block Marker (MBBM). Since + * the FCB is mostly written to the first page in a block, a scan for + * factory bad blocks will detect these blocks as bad, e.g. when + * function nand_scan_bbt() is executed to build a new bad block table. + */ + memset(fcb_raw_page + mtd->writesize, 0xFF, 2); + + ret = raw_write_page(mtd, fcb_raw_page, 0); + if (ret) + goto out; + + ret = raw_write_page(mtd, fcb_raw_page, mtd->erasesize); + if (ret) + goto out; + + dbbt->Checksum = 0; + dbbt->FingerPrint = 0x54424244; + dbbt->Version = 0x01000000; + + ret = dbbt_data_create(mtd, dbbt_data_page, block_last); + if (ret < 0) + goto out; + + if (ret > 0) + dbbt->DBBTNumOfPages = 1; + + for (i = 2; i < 4; i++) { + ret = mtd_write(mtd, mtd->erasesize * i, 2048, &written, dbbt_page); + if (ret) + goto out; + + if (dbbt->DBBTNumOfPages > 0) { + ret = mtd_write(mtd, mtd->erasesize * i + mtd->writesize * 4, + 2048, &written, dbbt_data_page); + if (ret) + goto out; + } + } + +out: + free(dbbt_page); + free(dbbt_data_page); + free(fcb_raw_page); + free(fw); + + return ret; +} + +int imx6_bbu_nand_register_handler(const char *name, unsigned long flags) +{ + struct bbu_handler *handler; + int ret; + + handler = xzalloc(sizeof(*handler)); + handler->devicefile = "/dev/nand0"; + handler->name = name; + handler->flags = flags; + handler->handler = imx6_bbu_nand_update; + + ret = bbu_register_handler(handler); + if (ret) + free(handler); + + return ret; +} diff --git a/include/bbu.h b/include/bbu.h index 4a3d35e..c5f22be 100644 --- a/include/bbu.h +++ b/include/bbu.h @@ -50,4 +50,13 @@ static inline int bbu_register_handler(struct bbu_handler *unused) #endif +#if defined(CONFIG_BAREBOX_UPDATE_IMX_NAND_FCB) +int imx6_bbu_nand_register_handler(const char *name, unsigned long flags); +#else +static inline int imx6_bbu_nand_register_handler(const char *name, unsigned long flags) +{ + return -ENOSYS; +} +#endif + #endif /* __INCLUDE_BBU_H */ -- 2.1.4 _______________________________________________ barebox mailing list barebox@lists.infradead.org http://lists.infradead.org/mailman/listinfo/barebox