1 /****************************************************************************** 2 * Filename: ccfgread_doc.h 3 * Revised: 2016-03-30 13:03:59 +0200 (Wed, 30 Mar 2016) 4 * Revision: 45971 5 * 6 * Copyright (c) 2015 - 2020, Texas Instruments Incorporated 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions are met: 11 * 12 * 1) Redistributions of source code must retain the above copyright notice, 13 * this list of conditions and the following disclaimer. 14 * 15 * 2) Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 19 * 3) Neither the name of the ORGANIZATION nor the names of its contributors may 20 * be used to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 * POSSIBILITY OF SUCH DAMAGE. 34 * 35 ******************************************************************************/ 36 //! \addtogroup ccfgread_api 37 //! @{ 38 //! \section sec_ccfgread Introduction 39 //! 40 //! The values of customer configuration (CCFG) settings in flash are determined by ccfg.c and typically 41 //! a user application does not need to read these CCFG values as they are used mainly during ROM boot 42 //! and device trimming. However, a subset of the CCFG settings need to be read by application 43 //! code thus DriverLib provides this API to allow easy read access to these specific settings. 44 //! 45 //! The remaining settings not accessible through this API can of course be read directly at the CCFG 46 //! addresses in the flash (starting at CCFG_BASE) using the HWREG macro and the provided defines. 47 //! CCFG settings are documented as part of the register descriptions in the CPU memory map. 48 //! 49 //! \note CCFG settings are located in flash and should be considered read-only from an application 50 //! point-of-view. 51 //! @} 52
