1 /****************************************************************************** 2 * Filename: aon_ioc_doc.h 3 * 4 * Copyright (c) 2015 - 2022, Texas Instruments Incorporated 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions are met: 9 * 10 * 1) Redistributions of source code must retain the above copyright notice, 11 * this list of conditions and the following disclaimer. 12 * 13 * 2) Redistributions in binary form must reproduce the above copyright notice, 14 * this list of conditions and the following disclaimer in the documentation 15 * and/or other materials provided with the distribution. 16 * 17 * 3) Neither the name of the ORGANIZATION nor the names of its contributors may 18 * be used to endorse or promote products derived from this software without 19 * specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 * 33 ******************************************************************************/ 34 //! \addtogroup aonioc_api 35 //! @{ 36 //! \section sec_aonioc Introduction 37 //! 38 //! The Input/Output Controller (IOC) controls the functionality of the pins (called DIO). 39 //! The IOC consists of two APIs: 40 //! - MCU IOC API selects which peripheral module is connected to the individual DIO and thus allowed to control it. 41 //! It also controls individual drive strength, slew rate, pull-up/pull-down, edge detection, etc. 42 //! - AON IOC API controls the general drive strength definitions, IO latches, and if the LF clock is 43 //! routed to a DIO for external use. 44 //! 45 //! For more information on the MCU IOC see the [IOC API](\ref ioc_api). 46 //! 47 //! \section sec_aonioc_api API 48 //! 49 //! The API functions can be grouped like this: 50 //! 51 //! Freeze IOs while MCU domain is powered down: 52 //! - \ref AONIOCFreezeEnable() 53 //! - \ref AONIOCFreezeDisable() 54 //! 55 //! Output LF clock to a DIO: 56 //! - \ref AONIOC32kHzOutputEnable() 57 //! - \ref AONIOC32kHzOutputDisable() 58 //! 59 //! Configure the value of drive strength for the three manual MCU IOC settings (MIN, MED, MAX): 60 //! - \ref AONIOCDriveStrengthSet() 61 //! - \ref AONIOCDriveStrengthGet() 62 //! 63 //! @} 64
