luban-lite-t3e-pro/bsp/peripheral/nftl/nftl_api/inc/nftl_api.h

/*
 * Copyright (c) 2022-2023, ArtInChip Technology Co., Ltd
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Authors: mingfeng.li <mingfeng.li@artinchip.com>
 */

#ifndef _NFTL_API_H
#define _NFTL_API_H

#include <aic_common.h>
#include <aic_core.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <malloc.h>

#define NFTL_BURN 0
#define BARE_PORT_HW_DEBUG 0
#define DRV_PORT_HW_DEBUG 0
#define NFTL_SECTOR_SIZE 512

//this for nand page
struct nand_page{
    u16 page_num;
    u16 block_num;
};

// this is for physicals side
struct physical_op_info{
    struct nand_page physical_page;
    u16 page_bitmap;
    u8 *user_data_addr;
    u8 *spare_data_addr;
};

struct nftl_api_nand_t {
    u16 page_size; /* The Page size in the flash */
    u16 oob_size;  /* Out of bank size */
    u16 oob_free;  /* the free area_node in oob that flash driver not use */
    u16 plane_num; /* the number of plane in the NAND Flash */

    u32 pages_per_block; /* The number of page a block */
    u16 block_total;

    /* Only be touched by driver */
    u32 block_start; /* The start of available block*/
    u32 block_end;   /* The end of available block */
};

struct nftl_api_handler_t {
    void *priv;
    void *priv_mtd;
    struct nftl_api_nand_t *nandt;
};

int weak_debug(void);
int nftl_api_init(struct nftl_api_handler_t *handler, int index);
int nftl_api_write(struct nftl_api_handler_t *handler, u32 start_sector, u32 len, unsigned char *buffer);
int nftl_api_read(struct nftl_api_handler_t *handler, u32 start_sector, u32 len, unsigned char *buffer);
int nftl_api_write_cache(struct nftl_api_handler_t *handler, u32 num);
void nftl_api_print_nftl_area_node(struct nftl_api_handler_t *handler);
void nftl_api_print_free_list(struct nftl_api_handler_t *handler);
void nftl_api_print_block_invalid_list(struct nftl_api_handler_t *handler);
void nftl_api_print_logic_page_map(struct nftl_api_handler_t *handler);
void nftl_api_lib_info(void);
void nftl_spare_info(u8 *buffer);
#endif /*_NFTL_API_H*/