dev/spi/xqspi_flash.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * Copyright (C) 2023, 2023 Aaron Nyholm
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027
0028 #ifndef XILINX_XQSPI_FLASH_H
0029 #define XILINX_XQSPI_FLASH_H
0030
0031 #include <dev/flash/flashdev.h>
0032 #include <dev/spi/xqspipsu.h>
0033
0034 #define XQSPI_FLASH_MAX_REGIONS ((size_t)32)
0035
0036 /*
0037  * @brief Initializes a flash device using Xilinx's xqspi flash
0038  * driver. The flash device is not registered in this call.
0039  * If an rtems_flashdev is created using xqspi_flash_init it must be
0040  * destroyed using xqspi_flash_destroy.
0041  *
0042  * @param[in] xQspiDev A configured XQspiPsu device to initialise.
0043  *
0044  * @retval A pointer to the rtems_flashdev.
0045  * @retval NULL on failure.
0046 */
0047 rtems_flashdev* xqspi_flash_init(XQspiPsu *xQspiDev);
0048
0049 /*
0050  * @brief Destroys a rtems_flashdev initialised with xqspi_flash_init.
0051  * If an rtems_flashdev is created using xqspi_flash_init it must be
0052  * destroyed using xqspi_flash_destroy. The XQspiPsu originally passed in
0053  * is untouched.
0054  *
0055  * @param[in] flash The flashdev to destroy
0056 */
0057 void xqspi_flash_destroy(rtems_flashdev* flash);
0058
0059 /*
0060  * @brief Struct allocating memory space for flash regions. Used by
0061  * rtems_flashdev to store region allocations.
0062  */
0063 typedef struct xqspi_flash_region_table {
0064   rtems_flashdev_region xqspi_flash_regions[XQSPI_FLASH_MAX_REGIONS];
0065   uint32_t xqspi_flash_bit_allocator;
0066 } xqspi_flash_region_table;
0067
0068 #endif /* XILINX_XQSPI_FLASH_H */