You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

106 lines
4.5 KiB

  1. /***************************************************************************
  2. * Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de> *
  3. * Copyright (C) 2007,2008 √ėyvind Harboe <oyvind.harboe@zylin.com> *
  4. * Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk> *
  5. * Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net> *
  6. * *
  7. * This program is free software; you can redistribute it and/or modify *
  8. * it under the terms of the GNU General Public License as published by *
  9. * the Free Software Foundation; either version 2 of the License, or *
  10. * (at your option) any later version. *
  11. * *
  12. * This program is distributed in the hope that it will be useful, *
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of *
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
  15. * GNU General Public License for more details. *
  16. * *
  17. * You should have received a copy of the GNU General Public License *
  18. * along with this program; if not, write to the *
  19. * Free Software Foundation, Inc., *
  20. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
  21. ***************************************************************************/
  22. #ifndef FLASH_NAND_DRIVER_H
  23. #define FLASH_NAND_DRIVER_H
  24. struct nand_device;
  25. #define __NAND_DEVICE_COMMAND(name) \
  26. COMMAND_HELPER(name, struct nand_device *nand)
  27. /**
  28. * Interface for NAND flash controllers. Not all of these functions are
  29. * required for full functionality of the NAND driver, but better performance
  30. * can be achieved by implementing each function.
  31. */
  32. struct nand_flash_controller {
  33. /** Driver name that is used to select it from configuration files. */
  34. const char *name;
  35. /** Usage of flash command registration. */
  36. const char *usage;
  37. const struct command_registration *commands;
  38. /** NAND device command called when driver is instantiated during configuration. */
  39. __NAND_DEVICE_COMMAND((*nand_device_command));
  40. /** Initialize the NAND device. */
  41. int (*init)(struct nand_device *nand);
  42. /** Reset the NAND device. */
  43. int (*reset)(struct nand_device *nand);
  44. /** Issue a command to the NAND device. */
  45. int (*command)(struct nand_device *nand, uint8_t command);
  46. /** Write an address to the NAND device. */
  47. int (*address)(struct nand_device *nand, uint8_t address);
  48. /** Write word of data to the NAND device. */
  49. int (*write_data)(struct nand_device *nand, uint16_t data);
  50. /** Read word of data from the NAND device. */
  51. int (*read_data)(struct nand_device *nand, void *data);
  52. /** Write a block of data to the NAND device. */
  53. int (*write_block_data)(struct nand_device *nand, uint8_t *data, int size);
  54. /** Read a block of data from the NAND device. */
  55. int (*read_block_data)(struct nand_device *nand, uint8_t *data, int size);
  56. /** Write a page to the NAND device. */
  57. int (*write_page)(struct nand_device *nand, uint32_t page, uint8_t *data,
  58. uint32_t data_size, uint8_t *oob, uint32_t oob_size);
  59. /** Read a page from the NAND device. */
  60. int (*read_page)(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size,
  61. uint8_t *oob, uint32_t oob_size);
  62. /** Check if the NAND device is ready for more instructions with timeout. */
  63. int (*nand_ready)(struct nand_device *nand, int timeout);
  64. };
  65. #define NAND_DEVICE_COMMAND_HANDLER(name) static __NAND_DEVICE_COMMAND(name)
  66. /**
  67. * Find a NAND flash controller by name.
  68. * @param name Identifies the NAND controller to find.
  69. * @returns The nand_flash_controller named @c name, or NULL if not found.
  70. */
  71. struct nand_flash_controller *nand_driver_find_by_name(const char *name);
  72. /** Signature for callback functions passed to nand_driver_walk */
  73. typedef int (*nand_driver_walker_t)(struct nand_flash_controller *c, void *);
  74. /**
  75. * Walk the list of drivers, encapsulating the data structure type.
  76. * Application state/context can be passed through the @c x pointer.
  77. * @param f The callback function to invoke for each function.
  78. * @param x For use as private data storate, passed directly to @c f.
  79. * @returns ERROR_OK if successful, or the non-zero return value of @c f.
  80. * This allows a walker to terminate the loop early.
  81. */
  82. int nand_driver_walk(nand_driver_walker_t f, void *x);
  83. #endif /* FLASH_NAND_DRIVER_H */