src/flash/nor/sfdp.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2
   3 /***************************************************************************
   4  *   Copyright (C) 2019 by Andreas Bolsch <andreas.bolsch@mni.thm.de       *
   5  ***************************************************************************/
   6
   7 #ifndef OPENOCD_FLASH_NOR_SFDP_H
   8 #define OPENOCD_FLASH_NOR_SFDP_H
   9
  10 /* per JESD216D 'addr' is *byte* based but must be word aligned,
  11  * 'buffer' is word based, word aligned and always little-endian encoded,
  12  * in the flash, 'addr_len' is 3 or 4, 'dummy' ***usually*** 8
  13  *
  14  * the actual number of dummy clocks should be worked out by this function
  15  * dynamically, i.e. by scanning the first few bytes for the SFDP signature
  16  *
  17  * buffer contents is supposed to be returned in ***host*** endianness */
  18 typedef int (*read_sfdp_block_t)(struct flash_bank *bank, uint32_t addr,
  19         uint32_t words, uint32_t *buffer);
  20
  21 extern int spi_sfdp(struct flash_bank *bank, struct flash_device *dev,
  22         read_sfdp_block_t read_sfdp_block);
  23
  24 #endif /* OPENOCD_FLASH_NOR_SFDP_H */