| /****************************************************************************** |
| * Filename: ccfgread_doc.h |
| * Revised: 2016-03-30 13:03:59 +0200 (Wed, 30 Mar 2016) |
| * Revision: 45971 |
| * |
| * Copyright (c) 2015 - 2016, Texas Instruments Incorporated |
| * All rights reserved. |
| * |
| * 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 of the ORGANIZATION 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 HOLDER 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. |
| * |
| ******************************************************************************/ |
| //! \addtogroup ccfgread_api |
| //! @{ |
| //! \section sec_ccfgread Introduction |
| //! |
| //! The values of customer configuration (CCFG) settings in flash are determined by ccfg.c and typically |
| //! a user application does not need to read these CCFG values as they are used mainly during ROM boot |
| //! and device trimming. However, a subset of the CCFG settings need to be read by application |
| //! code thus DriverLib provides this API to allow easy read access to these specific settings. |
| //! |
| //! The remaining settings not accessible through this API can of course be read directly at the CCFG |
| //! addresses in the flash (starting at CCFG_BASE) using the HWREG macro and the provided defines. |
| //! CCFG settings are documented as part of the register descriptions in the CPU memory map. |
| //! |
| //! \note CCFG settings are located in flash and should be considered read-only from an application |
| //! point-of-view. |
| //! @} |
