1 //***************************************************************************** 2 // 3 //! @file am_hal_otp.h 4 //! 5 //! @brief Implementation for One-Time Programmable Functionality 6 //! 7 //! @addtogroup otp_4p OTP - One-Time Programmable 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 48 #ifndef AM_HAL_OTP_H 49 #define AM_HAL_OTP_H 50 51 #define AM_REG_OTP_SIZE 0x2000 52 53 #ifdef __cplusplus 54 extern "C" 55 { 56 #endif 57 58 //***************************************************************************** 59 // 60 //! @brief Read OTP word 61 //! 62 //! @param offset - word aligned offset in OTP to be read 63 //! @param pVal - Pointer to word for returned data 64 //! 65 //! This will retrieve the OTP information 66 //! 67 //! @return Returns AM_HAL_STATUS_SUCCESS on success 68 // 69 //***************************************************************************** 70 uint32_t am_hal_otp_read_word(uint32_t offset, uint32_t *pVal); 71 72 //***************************************************************************** 73 // 74 //! @brief Write OTP word 75 //! 76 //! @param offset - word aligned offset in OTP to be read 77 //! @param value - value to be written 78 //! 79 //! This will write a word to the supplied offset in the OTP 80 //! 81 //! @return Returns AM_HAL_STATUS_SUCCESS on success 82 // 83 //***************************************************************************** 84 uint32_t am_hal_otp_write_word(uint32_t offset, uint32_t value); 85 86 #ifdef __cplusplus 87 } 88 #endif 89 90 #endif // AM_HAL_OTP_H 91 92 //***************************************************************************** 93 // 94 // End Doxygen group. 95 //! @} 96 // 97 //***************************************************************************** 98 99
