1 /******************************************************************************
2 *  Filename:       aon_ioc_doc.h
3 *  Revised:        2016-03-30 11:01:30 +0200 (Wed, 30 Mar 2016)
4 *  Revision:       45969
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 aonioc_api
37 //! @{
38 //! \section sec_aonioc Introduction
39 //!
40 //! The Input/Output Controller (IOC) controls the functionality of the pins (called DIO).
41 //! The IOC consists of two APIs:
42 //! - MCU IOC API selects which peripheral module is connected to the individual DIO and thus allowed to control it.
43 //!   It also controls individual drive strength, slew rate, pull-up/pull-down, edge detection, etc.
44 //! - AON IOC API controls the general drive strength definitions, IO latches, and if the LF clock is
45 //!   routed to a DIO for external use.
46 //!
47 //! For more information on the MCU IOC see the [IOC API](\ref ioc_api).
48 //!
49 //! \section sec_aonioc_api API
50 //!
51 //! The API functions can be grouped like this:
52 //!
53 //! Freeze IOs while MCU domain is powered down:
54 //! - \ref AONIOCFreezeEnable()
55 //! - \ref AONIOCFreezeDisable()
56 //!
57 //! Output LF clock to a DIO:
58 //! - \ref AONIOC32kHzOutputEnable()
59 //! - \ref AONIOC32kHzOutputDisable()
60 //!
61 //! Configure the value of drive strength for the three manual MCU IOC settings (MIN, MED, MAX):
62 //! - \ref AONIOCDriveStrengthSet()
63 //! - \ref AONIOCDriveStrengthGet()
64 //!
65 //! @}
66