forked from auracaster/openocd
5d77897526
The static analyser 'sparse' complains, while compiling a nand driver, that the struct nand_flash_controller is declared in the file as non static, but it is not exposed through an include file. The message is: warning: symbol 'XXX' was not declared. Should it be static? Move the list of nand_flash_controller's declaration in driver.h While there, drop the unused/commented boundary scan controller. Change-Id: I7dc32cef55be13ba537abe0f4c47b135d837126c Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: https://review.openocd.org/c/openocd/+/7661 Tested-by: jenkins
108 lines
4.3 KiB
C
108 lines
4.3 KiB
C
/* 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)
|
|
|
|
/**
|
|
* Interface for NAND flash controllers. Not all of these functions are
|
|
* required for full functionality of the NAND driver, but better performance
|
|
* can be achieved by implementing each function.
|
|
*/
|
|
struct nand_flash_controller {
|
|
/** Driver name that is used to select it from configuration files. */
|
|
const char *name;
|
|
|
|
/** Usage of flash command registration. */
|
|
const char *usage;
|
|
|
|
const struct command_registration *commands;
|
|
|
|
/** NAND device command called when driver is instantiated during configuration. */
|
|
__NAND_DEVICE_COMMAND((*nand_device_command));
|
|
|
|
/** Initialize the NAND device. */
|
|
int (*init)(struct nand_device *nand);
|
|
|
|
/** Reset the NAND device. */
|
|
int (*reset)(struct nand_device *nand);
|
|
|
|
/** Issue a command to the NAND device. */
|
|
int (*command)(struct nand_device *nand, uint8_t command);
|
|
|
|
/** Write an address to the NAND device. */
|
|
int (*address)(struct nand_device *nand, uint8_t address);
|
|
|
|
/** Write word of data to the NAND device. */
|
|
int (*write_data)(struct nand_device *nand, uint16_t data);
|
|
|
|
/** Read word of data from the NAND device. */
|
|
int (*read_data)(struct nand_device *nand, void *data);
|
|
|
|
/** Write a block of data to the NAND device. */
|
|
int (*write_block_data)(struct nand_device *nand, uint8_t *data, int size);
|
|
|
|
/** Read a block of data from the NAND device. */
|
|
int (*read_block_data)(struct nand_device *nand, uint8_t *data, int size);
|
|
|
|
/** Write a page to the NAND device. */
|
|
int (*write_page)(struct nand_device *nand, uint32_t page, uint8_t *data,
|
|
uint32_t data_size, uint8_t *oob, uint32_t oob_size);
|
|
|
|
/** Read a page from the NAND device. */
|
|
int (*read_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size,
|
|
uint8_t *oob, uint32_t oob_size);
|
|
|
|
/** Check if the NAND device is ready for more instructions with timeout. */
|
|
int (*nand_ready)(struct nand_device *nand, int timeout);
|
|
};
|
|
|
|
#define NAND_DEVICE_COMMAND_HANDLER(name) static __NAND_DEVICE_COMMAND(name)
|
|
|
|
/**
|
|
* Find a NAND flash controller by name.
|
|
* @param name Identifies the NAND controller to find.
|
|
* @returns The nand_flash_controller named @c name, or NULL if not found.
|
|
*/
|
|
struct nand_flash_controller *nand_driver_find_by_name(const char *name);
|
|
|
|
/** Signature for callback functions passed to nand_driver_walk */
|
|
typedef int (*nand_driver_walker_t)(struct nand_flash_controller *c, void *);
|
|
/**
|
|
* Walk the list of drivers, encapsulating the data structure type.
|
|
* Application state/context can be passed through the @c x pointer.
|
|
* @param f The callback function to invoke for each function.
|
|
* @param x For use as private data storage, passed directly to @c f.
|
|
* @returns ERROR_OK if successful, or the non-zero return value of @c f.
|
|
* This allows a walker to terminate the loop early.
|
|
*/
|
|
int nand_driver_walk(nand_driver_walker_t f, void *x);
|
|
|
|
extern struct nand_flash_controller at91sam9_nand_controller;
|
|
extern struct nand_flash_controller davinci_nand_controller;
|
|
extern struct nand_flash_controller imx31_nand_flash_controller;
|
|
extern struct nand_flash_controller lpc3180_nand_controller;
|
|
extern struct nand_flash_controller lpc32xx_nand_controller;
|
|
extern struct nand_flash_controller mxc_nand_flash_controller;
|
|
extern struct nand_flash_controller nonce_nand_controller;
|
|
extern struct nand_flash_controller nuc910_nand_controller;
|
|
extern struct nand_flash_controller orion_nand_controller;
|
|
extern struct nand_flash_controller s3c2410_nand_controller;
|
|
extern struct nand_flash_controller s3c2412_nand_controller;
|
|
extern struct nand_flash_controller s3c2440_nand_controller;
|
|
extern struct nand_flash_controller s3c2443_nand_controller;
|
|
extern struct nand_flash_controller s3c6400_nand_controller;
|
|
|
|
#endif /* OPENOCD_FLASH_NAND_DRIVER_H */
|