summaryrefslogtreecommitdiff
path: root/Radio/HW/BladeRF/src/driver/spi_flash.h
diff options
context:
space:
mode:
Diffstat (limited to 'Radio/HW/BladeRF/src/driver/spi_flash.h')
-rw-r--r--Radio/HW/BladeRF/src/driver/spi_flash.h99
1 files changed, 99 insertions, 0 deletions
diff --git a/Radio/HW/BladeRF/src/driver/spi_flash.h b/Radio/HW/BladeRF/src/driver/spi_flash.h
new file mode 100644
index 0000000..c425494
--- /dev/null
+++ b/Radio/HW/BladeRF/src/driver/spi_flash.h
@@ -0,0 +1,99 @@
+/**
+ * @file flash.h
+ *
+ * @brief Flash conversion and alignment routines
+ *
+ * This file is part of the bladeRF project:
+ * http://www.github.com/nuand/bladeRF
+ *
+ * Copyright (C) 2013 Daniel Gröber <dxld AT darkboxed DOT org>
+ * Copyright (C) 2013 Nuand LLC
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef DRIVER_SPI_FLASH_H_
+#define DRIVER_SPI_FLASH_H_
+
+#include <assert.h>
+#include <stdint.h>
+
+#include <libbladeRF.h>
+
+/**
+ * Erase regions of SPI flash
+ *
+ * @param dev Device handle
+ * @param[in] erase_block Erase block to start erasing at
+ * @param[in] count Number of blocks to erase.
+ *
+ * @return 0 on success, or BLADERF_ERR_INVAL on an invalid `erase_block` or
+ * `count` value, or a value from \ref RETCODES list on other failures
+ */
+int spi_flash_erase(struct bladerf *dev, uint32_t erase_block, uint32_t count);
+
+/**
+ * Read data from flash
+ *
+ * @param dev Device handle
+ * @param[out] buf Buffer to read data into. Must be `count` *
+ * flash-page-size bytes or larger.
+ * @param[in] page Page to begin reading from
+ * @param[in] count Number of pages to read
+ *
+ * @return 0 on success, or BLADERF_ERR_INVAL on an invalid `page` or `count`
+ * value, or a value from \ref RETCODES list on other failures.
+ */
+int spi_flash_read(struct bladerf *dev,
+ uint8_t *buf,
+ uint32_t page,
+ uint32_t count);
+
+/**
+ * Verify data in flash
+ *
+ * @param dev Device handle
+ * @param[out] readback_buf Buffer to read data into. Must be `count` *
+ * flash-page-size bytes or larger.
+ * @param[in] expected_buf Expected contents of buffer
+ * @param[in] page Page to begin reading from
+ * @param[in] count Number of pages to read
+ *
+ * @return 0 on success, or BLADERF_ERR_INVAL on an invalid `page` or `count`
+ * value, or a value from \ref RETCODES list on other failures.
+ */
+int spi_flash_verify(struct bladerf *dev,
+ uint8_t *readback_buf,
+ const uint8_t *expected_buf,
+ uint32_t page,
+ uint32_t count);
+
+/**
+ * Write data to flash
+ *
+ * @param dev Device handle
+ * @param[in] buf Data to write to flash
+ * @param[in] page Page to begin writing at
+ * @param[in] count Number of pages to write
+ *
+ * @return 0 on success, or BLADERF_ERR_INVAL on an invalid `page` or `count`
+ * value, or a value from \ref RETCODES list on other failures.
+ */
+int spi_flash_write(struct bladerf *dev,
+ const uint8_t *buf,
+ uint32_t page,
+ uint32_t count);
+
+#endif