OpenOCD
nand/driver.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  nand_flash_controller
 Interface for NAND flash controllers. More...
 

Macros

#define __NAND_DEVICE_COMMAND(name)    COMMAND_HELPER(name, struct nand_device *nand)
 
#define NAND_DEVICE_COMMAND_HANDLER(name)   static __NAND_DEVICE_COMMAND(name)
 

Typedefs

typedef int(* nand_driver_walker_t) (struct nand_flash_controller *c, void *)
 Signature for callback functions passed to nand_driver_walk. More...
 

Functions

struct nand_flash_controllernand_driver_find_by_name (const char *name)
 Find a NAND flash controller by name. More...
 
int nand_driver_walk (nand_driver_walker_t f, void *x)
 Walk the list of drivers, encapsulating the data structure type. More...
 

Macro Definition Documentation

◆ __NAND_DEVICE_COMMAND

#define __NAND_DEVICE_COMMAND (   name)     COMMAND_HELPER(name, struct nand_device *nand)

Definition at line 15 of file nand/driver.h.

◆ NAND_DEVICE_COMMAND_HANDLER

#define NAND_DEVICE_COMMAND_HANDLER (   name)    static __NAND_DEVICE_COMMAND(name)

Definition at line 71 of file nand/driver.h.

Typedef Documentation

◆ nand_driver_walker_t

typedef int(* nand_driver_walker_t) (struct nand_flash_controller *c, void *)

Signature for callback functions passed to nand_driver_walk.

Definition at line 81 of file nand/driver.h.

Function Documentation

◆ nand_driver_find_by_name()

struct nand_flash_controller* nand_driver_find_by_name ( const char *  name)

Find a NAND flash controller by name.

Parameters
nameIdentifies the NAND controller to find.
Returns
The nand_flash_controller named name, or NULL if not found.

Definition at line 54 of file flash/nand/driver.c.

References nand_flash_controller::name, name, nand_flash_controllers, and NULL.

Referenced by COMMAND_HANDLER().

◆ nand_driver_walk()

int nand_driver_walk ( nand_driver_walker_t  f,
void *  x 
)

Walk the list of drivers, encapsulating the data structure type.

Application state/context can be passed through the x pointer.

Parameters
fThe callback function to invoke for each function.
xFor use as private data storage, passed directly to f.
Returns
ERROR_OK if successful, or the non-zero return value of f. This allows a walker to terminate the loop early.

Definition at line 63 of file flash/nand/driver.c.

References ERROR_OK, and nand_flash_controllers.

Referenced by COMMAND_HANDLER().