1 //***************************************************************************** 2 // 3 //! @file am_hal_bootrom_helper.h 4 //! 5 //! @brief BootROM Helper Function Table 6 //! 7 //! @addtogroup bootrom4_4p Bootrom Functionality 8 //! @ingroup apollo4p_hal 9 //! @{ 10 // 11 //***************************************************************************** 12 13 //***************************************************************************** 14 // 15 // Copyright (c) 2023, Ambiq Micro, Inc. 16 // All rights reserved. 17 // 18 // Redistribution and use in source and binary forms, with or without 19 // modification, are permitted provided that the following conditions are met: 20 // 21 // 1. Redistributions of source code must retain the above copyright notice, 22 // this list of conditions and the following disclaimer. 23 // 24 // 2. Redistributions in binary form must reproduce the above copyright 25 // notice, this list of conditions and the following disclaimer in the 26 // documentation and/or other materials provided with the distribution. 27 // 28 // 3. Neither the name of the copyright holder nor the names of its 29 // contributors may be used to endorse or promote products derived from this 30 // software without specific prior written permission. 31 // 32 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 33 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 34 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 35 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 36 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 37 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 38 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 39 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 40 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 41 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 42 // POSSIBILITY OF SUCH DAMAGE. 43 // 44 // This is part of revision release_sdk_4_4_0-3c5977e664 of the AmbiqSuite Development Package. 45 // 46 //***************************************************************************** 47 #ifndef AM_HAL_BOOTROM_HELPER_H 48 #define AM_HAL_BOOTROM_HELPER_H 49 50 #ifdef __cplusplus 51 extern "C" 52 { 53 #endif 54 55 #include <stdint.h> 56 #include <stdbool.h> 57 58 //***************************************************************************** 59 // 60 //! Structure of pointers to helper functions invoking flash operations. 61 // 62 //! The functions we are pointing to here are in the Apollo 4 63 //! integrated BOOTROM. 64 // 65 //***************************************************************************** 66 typedef struct am_hal_bootrom_helper_struct 67 { 68 // 69 //! Basics functions required by most toolchains. 70 // 71 int (*nv_mass_erase)(uint32_t, uint32_t); 72 int (*nv_page_erase)(uint32_t, uint32_t, uint32_t); 73 int (*nv_program_main)(uint32_t, uint32_t *, uint32_t *, uint32_t); 74 75 // 76 //! Infospace programming function. 77 // 78 int (*nv_program_info_area)(uint32_t, uint32_t *, uint32_t, uint32_t); 79 80 // 81 //! Helpful utilities. 82 // 83 int (*nv_program_main2)(uint32_t, uint32_t, uint32_t, uint32_t, uint32_t); 84 85 uint32_t (*bootrom_util_read_word)( uint32_t *); 86 void (*bootrom_util_write_word)( uint32_t *, uint32_t); 87 88 // 89 //! Infospace erase functions. 90 // 91 int (*nv_info_erase)( uint32_t); 92 93 // 94 //! Non-Volatile Recovery function. 95 // 96 int (*nv_recovery)( uint32_t value); 97 98 // 99 //! Cycle accurate delay function. 100 // 101 void (*bootrom_delay_cycles)(uint32_t ui32Cycles); 102 103 } am_hal_bootrom_helper_t; 104 105 extern const am_hal_bootrom_helper_t g_am_hal_bootrom_helper; 106 107 #ifdef __cplusplus 108 } 109 #endif 110 111 #endif // AM_HAL_BOOTROM_HELPER_H 112 113 //***************************************************************************** 114 // 115 // End Doxygen group. 116 //! @} 117 // 118 //***************************************************************************** 119 120
