nand/driver.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
 *   Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com>       *
 *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
 *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
 ***************************************************************************/
 
#ifndef OPENOCD_FLASH_NAND_DRIVER_H
#define OPENOCD_FLASH_NAND_DRIVER_H
 
struct nand_device;
 
#define __NAND_DEVICE_COMMAND(name) \
    COMMAND_HELPER(name, struct nand_device *nand)
 
struct nand_flash_controller {
    const char *name;
 
    const char *usage;
 
    const struct command_registration *commands;
 
    __NAND_DEVICE_COMMAND((*nand_device_command));
 
    int (*init)(struct nand_device *nand);
 
    int (*reset)(struct nand_device *nand);
 
    int (*command)(struct nand_device *nand, uint8_t command);
 
    int (*address)(struct nand_device *nand, uint8_t address);
 
    int (*write_data)(struct nand_device *nand, uint16_t data);
 
    int (*read_data)(struct nand_device *nand, void *data);
 
    int (*write_block_data)(struct nand_device *nand, uint8_t *data, int size);
 
    int (*read_block_data)(struct nand_device *nand, uint8_t *data, int size);
 
    int (*write_page)(struct nand_device *nand, uint32_t page, uint8_t *data,
              uint32_t data_size, uint8_t *oob, uint32_t oob_size);
 
    int (*read_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size,
             uint8_t *oob, uint32_t oob_size);
 
    int (*nand_ready)(struct nand_device *nand, int timeout);
};
 
#define NAND_DEVICE_COMMAND_HANDLER(name) static __NAND_DEVICE_COMMAND(name)
 
struct nand_flash_controller *nand_driver_find_by_name(const char *name);
 
typedef int (*nand_driver_walker_t)(struct nand_flash_controller *c, void *);
int nand_driver_walk(nand_driver_walker_t f, void *x);
 
#endif /* OPENOCD_FLASH_NAND_DRIVER_H */