aboutsummaryrefslogtreecommitdiff
path: root/src/drivers/boards/px4cannode-v1/bootloader/src/flash.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/drivers/boards/px4cannode-v1/bootloader/src/flash.h')
-rw-r--r--src/drivers/boards/px4cannode-v1/bootloader/src/flash.h94
1 files changed, 89 insertions, 5 deletions
diff --git a/src/drivers/boards/px4cannode-v1/bootloader/src/flash.h b/src/drivers/boards/px4cannode-v1/bootloader/src/flash.h
index 2be47848b..db5f5827b 100644
--- a/src/drivers/boards/px4cannode-v1/bootloader/src/flash.h
+++ b/src/drivers/boards/px4cannode-v1/bootloader/src/flash.h
@@ -1,7 +1,54 @@
+/****************************************************************************
+ *
+ * Copyright (c) 2015 PX4 Development Team. All rights reserved.
+ * Author: Ben Dyer <ben_dyer@mac.com>
+ * Pavel Kirienko <pavel.kirienko@zubax.com>
+ * David Sidrane <david_s5@nscdg.com>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ * 3. Neither the name PX4 nor the names of its contributors may be
+ * used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
#pragma once
-typedef enum
- {
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Type Definitions
+ ****************************************************************************/
+
+typedef enum {
FLASH_OK = 0,
FLASH_ERROR,
FLASH_ERASE_ERROR,
@@ -9,8 +56,45 @@ typedef enum
FLASH_ERROR_SUICIDE,
FLASH_ERROR_AFU,
- } flash_error_t;
+} flash_error_t;
+
+/****************************************************************************
+ * Global Variables
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+/****************************************************************************
+ * Name: bl_flash_erase
+ *
+ * Description:
+ * This function erases the flash starting at the given address
+ *
+ * Input Parameters:
+ * address - The word aligned address of the flash to erase
+ *
+ * Returned value:
+ * On sucess FLASH_OK On Error one of the flash_error_t
+ *
+ ****************************************************************************/
+
+flash_error_t bl_flash_erase(size_t address);
+
+/****************************************************************************
+ * Name: bl_flash_write_word
+ *
+ * Description:
+ * This function erases the flash starting at the given address
+ *
+ * Input Parameters:
+ * flash_address - The address of the flash to write
+ * data - A pointer to a buffer of 4 bytes to be written
+ * to the flash.
+ *
+ * Returned value:
+ * On sucess FLASH_OK On Error one of the flash_error_t
+ *
+ ****************************************************************************/
-flash_error_t bl_flash_erase(void);
flash_error_t bl_flash_write_word(uint32_t flash_address, const uint8_t * word);
-uint64_t flash_crc(uint32_t flash_address, size_t length, uint64_t initial_crc);