cd2fcf5252
Most tools used for compliance and SBOM generation use SPDX identifiers This change brings us a step closer to an easy SBOM generation. Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
297 lines
11 KiB
C
297 lines
11 KiB
C
/****************************************************************************
|
|
* include/nuttx/mtd/nand_raw.h
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
* SPDX-FileCopyrightText: 2012, Atmel Corporation
|
|
*
|
|
* 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, 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.
|
|
* 3. Neither the names NuttX nor Atmel nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
|
|
* COPYRIGHT OWNER 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_MTD_NAND_RAW_H
|
|
#define __INCLUDE_NUTTX_MTD_NAND_RAW_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include <nuttx/mtd/nand_config.h>
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#include <nuttx/mtd/nand_model.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Nand flash commands */
|
|
|
|
#define COMMAND_READ_1 0x00
|
|
#define COMMAND_READ_2 0x30
|
|
#define COMMAND_COPYBACK_READ_1 0x00
|
|
#define COMMAND_COPYBACK_READ_2 0x35
|
|
#define COMMAND_COPYBACK_PROGRAM_1 0x85
|
|
#define COMMAND_COPYBACK_PROGRAM_2 0x10
|
|
#define COMMAND_RANDOM_OUT 0x05
|
|
#define COMMAND_RANDOM_OUT_2 0xe0
|
|
#define COMMAND_RANDOM_IN 0x85
|
|
#define COMMAND_READID 0x90
|
|
#define COMMAND_WRITE_1 0x80
|
|
#define COMMAND_WRITE_2 0x10
|
|
#define COMMAND_ERASE_1 0x60
|
|
#define COMMAND_ERASE_2 0xd0
|
|
#define COMMAND_STATUS 0x70
|
|
#define COMMAND_RESET 0xff
|
|
|
|
/* Nand flash commands (small blocks) */
|
|
|
|
#define COMMAND_READ_A 0x00
|
|
#define COMMAND_READ_C 0x50
|
|
|
|
/* Type of ECC to be performed (may also need to be enabled in the
|
|
* configuration)
|
|
*
|
|
* NANDECC_NONE No ECC, only raw NAND FLASH accesses
|
|
* NANDECC_SWECC Software ECC. Handled by the common MTD logic.
|
|
* NANDECC_HWECC Values >= 2 are various hardware ECC implementations
|
|
* all handled by the lower-half, raw NAND FLASH driver.
|
|
* These hardware ECC types may be extended beginning
|
|
* with the value NANDECC_HWECC.
|
|
*
|
|
* Software ECC is performed by common, upper-half MTD logic; All
|
|
* hardware assisted ECC operations are handled by the platform-specific,
|
|
* lower-half driver.
|
|
*/
|
|
|
|
#define NANDECC_NONE 0
|
|
#define NANDECC_SWECC 1
|
|
#define NANDECC_HWECC 2
|
|
|
|
/* NAND access macros */
|
|
|
|
#define WRITE_COMMAND8(raw, command) \
|
|
{*((volatile uint8_t *)(raw)->cmdaddr) = (uint8_t)command;}
|
|
#define WRITE_COMMAND16(raw, command) \
|
|
{*((volatile uint16_t *)(raw)->cmdaddr) = (uint16_t)command;}
|
|
#define WRITE_ADDRESS8(raw, address) \
|
|
{*((volatile uint8_t *)(raw)->addraddr) = (uint8_t)address;}
|
|
#define WRITE_ADDRESS16(raw, address) \
|
|
{*((volatile uint16_t *)(raw)->addraddr) = (uint16_t)address;}
|
|
#define WRITE_DATA8(raw, data) \
|
|
{*((volatile uint8_t *)(raw)->dataaddr) = (uint8_t)data;}
|
|
#define READ_DATA8(raw) \
|
|
(*((volatile uint8_t *)(raw)->dataaddr))
|
|
#define WRITE_DATA16(raw, data) \
|
|
{*((volatile uint16_t *)(raw)->dataaddr) = (uint16_t)data;}
|
|
#define READ_DATA16(raw) \
|
|
(*((volatile uint16_t *)(raw)->dataaddr))
|
|
|
|
/* struct nand_raw_s operations */
|
|
|
|
/****************************************************************************
|
|
* Name: NAND_ERASEBLOCK
|
|
*
|
|
* Description:
|
|
* Erases the specified block of the device.
|
|
*
|
|
* Input Parameters:
|
|
* raw - Lower-half, raw NAND FLASH interface
|
|
* block - Number of the physical block to erase.
|
|
*
|
|
* Returned Value:
|
|
* OK is returned in success; a negated errno value is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#define NAND_ERASEBLOCK(r,b) ((r)->eraseblock(r,b))
|
|
|
|
/****************************************************************************
|
|
* Name: NAND_RAWREAD
|
|
*
|
|
* Description:
|
|
* Reads the data and/or the spare areas of a page of a NAND FLASH into the
|
|
* provided buffers. This is a raw read of the flash contents.
|
|
*
|
|
* Input Parameters:
|
|
* raw - Lower-half, raw NAND FLASH interface
|
|
* block - Number of the block where the page to read resides.
|
|
* page - Number of the page to read inside the given block.
|
|
* data - Buffer where the data area will be stored.
|
|
* spare - Buffer where the spare area will be stored.
|
|
*
|
|
* Returned Value:
|
|
* OK is returned in success; a negated errno value is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#define NAND_RAWREAD(r,b,p,d,s) ((r)->rawread(r,b,p,d,s))
|
|
|
|
/****************************************************************************
|
|
* Name: NAND_RAWWRITE
|
|
*
|
|
* Description:
|
|
* Writes the data and/or the spare area of a page on a NAND FLASH chip.
|
|
* This is a raw write of the flash contents.
|
|
*
|
|
* Input Parameters:
|
|
* raw - Lower-half, raw NAND FLASH interface
|
|
* block - Number of the block where the page to write resides.
|
|
* page - Number of the page to write inside the given block.
|
|
* data - Buffer containing the data to be writing
|
|
* spare - Buffer containing the spare data to be written.
|
|
*
|
|
* Returned Value:
|
|
* OK is returned in success; a negated errno value is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#define NAND_RAWWRITE(r,b,p,d,s) ((r)->rawwrite(r,b,p,d,s))
|
|
|
|
/****************************************************************************
|
|
* Name: NAND_READPAGE
|
|
*
|
|
* Description:
|
|
* Reads the data and/or the spare areas of a page of a NAND FLASH into the
|
|
* provided buffers. Hardware ECC checking will be performed if so
|
|
* configured.
|
|
*
|
|
* Input Parameters:
|
|
* raw - Lower-half, raw NAND FLASH interface
|
|
* block - Number of the block where the page to read resides.
|
|
* page - Number of the page to read inside the given block.
|
|
* data - Buffer where the data area will be stored.
|
|
* spare - Buffer where the spare area will be stored.
|
|
*
|
|
* Returned Value:
|
|
* OK is returned in success; a negated errno value is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_MTD_NAND_HWECC
|
|
# define NAND_READPAGE(r,b,p,d,s) ((r)->readpage(r,b,p,d,s))
|
|
#else
|
|
# define NAND_READPAGE(r,b,p,d,s) ((r)->rawread(r,b,p,d,s))
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: NAND_WRITEPAGE
|
|
*
|
|
* Description:
|
|
* Writes the data and/or the spare area of a page on a NAND FLASH chip.
|
|
* Hardware ECC checking will be performed if so configured.
|
|
*
|
|
* Input Parameters:
|
|
* raw - Lower-half, raw NAND FLASH interface
|
|
* block - Number of the block where the page to write resides.
|
|
* page - Number of the page to write inside the given block.
|
|
* data - Buffer containing the data to be writing
|
|
* spare - Buffer containing the spare data to be written.
|
|
*
|
|
* Returned Value:
|
|
* OK is returned in success; a negated errno value is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_MTD_NAND_HWECC
|
|
# define NAND_WRITEPAGE(r,b,p,d,s) ((r)->writepage(r,b,p,d,s))
|
|
#else
|
|
# define NAND_WRITEPAGE(r,b,p,d,s) ((r)->rawwrite(r,b,p,d,s))
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* This type represents the visible portion of the lower-half, raw NAND MTD
|
|
* device. The lower-half driver may freely append additional information
|
|
* after this required header information.
|
|
*/
|
|
|
|
struct nand_raw_s
|
|
{
|
|
/* NAND data description */
|
|
|
|
struct nand_model_s model; /* The NAND model storage */
|
|
uintptr_t cmdaddr; /* NAND command address base */
|
|
uintptr_t addraddr; /* NAND address address base */
|
|
uintptr_t dataaddr; /* NAND data address */
|
|
uint8_t ecctype; /* See NANDECC_* definitions */
|
|
|
|
/* NAND operations */
|
|
|
|
CODE int (*eraseblock)(FAR struct nand_raw_s *raw, off_t block);
|
|
CODE int (*rawread)(FAR struct nand_raw_s *raw, off_t block,
|
|
unsigned int page, FAR void *data, FAR void *spare);
|
|
CODE int (*rawwrite)(FAR struct nand_raw_s *raw, off_t block,
|
|
unsigned int page, FAR const void *data,
|
|
FAR const void *spare);
|
|
|
|
#ifdef CONFIG_MTD_NAND_HWECC
|
|
CODE int (*readpage)(FAR struct nand_raw_s *raw, off_t block,
|
|
unsigned int page, FAR void *data, FAR void *spare);
|
|
CODE int (*writepage)(FAR struct nand_raw_s *raw, off_t block,
|
|
unsigned int page, FAR const void *data,
|
|
FAR const void *spare);
|
|
#endif
|
|
|
|
#if defined(CONFIG_MTD_NAND_SWECC) || defined(CONFIG_MTD_NAND_HWECC)
|
|
/* ECC working buffers */
|
|
|
|
uint8_t spare[CONFIG_MTD_NAND_MAXPAGESPARESIZE];
|
|
uint8_t ecc[CONFIG_MTD_NAND_MAXSPAREECCBYTES];
|
|
#endif
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* __INCLUDE_NUTTX_MTD_NAND_RAW_H */
|