xnandpsu_bbm.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (C) 2015 - 2022 Xilinx, Inc.  All rights reserved.
* SPDX-License-Identifier: MIT
******************************************************************************/
 
/*****************************************************************************/
#ifndef XNANDPSU_BBM_H      /* prevent circular inclusions */
#define XNANDPSU_BBM_H      /* by using protection macros */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***************************** Include Files *********************************/
#include "xnandpsu.h"
 
/************************** Constant Definitions *****************************/
/* Block definitions for RAM based Bad Block Table (BBT) */
#define XNANDPSU_BLOCK_GOOD         0x0U    
#define XNANDPSU_BLOCK_BAD          0x1U    
#define XNANDPSU_BLOCK_RESERVED         0x2U    
#define XNANDPSU_BLOCK_FACTORY_BAD      0x3U    
/* Block definitions for FLASH based Bad Block Table (BBT) */
#define XNANDPSU_FLASH_BLOCK_GOOD       0x3U    
#define XNANDPSU_FLASH_BLOCK_BAD        0x2U    
#define XNANDPSU_FLASH_BLOCK_RESERVED       0x1U    
#define XNANDPSU_FLASH_BLOCK_FAC_BAD    0x0U    
 
#define XNANDPSU_BBT_SCAN_2ND_PAGE      0x00000001U 
#define XNANDPSU_BBT_DESC_PAGE_OFFSET       0U  
#define XNANDPSU_BBT_DESC_SIG_OFFSET        8U  
#define XNANDPSU_BBT_DESC_VER_OFFSET        12U 
#define XNANDPSU_NO_OOB_BBT_DESC_SIG_OFFSET 0U  
#define XNANDPSU_NO_OOB_BBT_DESC_VER_OFFSET 4U  
#define XNANDPSU_BBT_DESC_SIG_LEN       4U  
#define XNANDPSU_BBT_DESC_MAX_BLOCKS        64U 
 
#define XNANDPSU_BBT_BLOCK_SHIFT        2U  
#define XNANDPSU_BBT_ENTRY_NUM_BLOCKS       4U  
#define XNANDPSU_BB_PTRN_OFF_SML_PAGE   5U  
#define XNANDPSU_BB_PTRN_LEN_SML_PAGE   1U  
#define XNANDPSU_BB_PTRN_OFF_LARGE_PAGE 0U  
#define XNANDPSU_BB_PTRN_LEN_LARGE_PAGE 2U  
#define XNANDPSU_BB_PATTERN         0xFFU   
#define XNANDPSU_BLOCK_TYPE_MASK        0x03U   
#define XNANDPSU_BLOCK_SHIFT_MASK       0x06U   
 
#define XNANDPSU_ONDIE_SIG_OFFSET       0x4U
#define XNANDPSU_ONDIE_VER_OFFSET       0x14U
 
#define XNANDPSU_BBT_VERSION_LENGTH 1U
#define XNANDPSU_BBT_SIG_LENGTH     4U
 
#define XNANDPSU_BBT_BUF_LENGTH     ((XNANDPSU_MAX_BLOCKS >>        \
                     XNANDPSU_BBT_BLOCK_SHIFT) +    \
                    (XNANDPSU_BBT_DESC_SIG_OFFSET + \
                     XNANDPSU_BBT_SIG_LENGTH +  \
                     XNANDPSU_BBT_VERSION_LENGTH))
/**************************** Type Definitions *******************************/
 
/***************** Macros (Inline Functions) Definitions *********************/
 
/****************************************************************************/
#define XNandPsu_BbtBlockShift(Block) \
            (u8)(((Block) * 2U) & XNANDPSU_BLOCK_SHIFT_MASK)
 
/************************** Variable Definitions *****************************/
 
/************************** Function Prototypes ******************************/
 
void XNandPsu_InitBbtDesc(XNandPsu *InstancePtr);
 
s32 XNandPsu_IsBlockBad(XNandPsu *InstancePtr, u32 Block);
 
#ifdef __cplusplus
}
#endif
 
#endif /* end of protection macro */