1 /******************************************************************************
2 *  Filename:       ioc_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 ioc_api
37 //! @{
38 //! \section sec_ioc 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 AON IOC see the [AON IOC API](\ref aonioc_api).
48 //!
49 //! \note The output driver of a DIO is not configured by the IOC API (except for drive strength); instead, it is controlled by the
50 //! peripheral module which is selected to control the DIO.
51 //!
52 //! A DIO is considered "software controlled" if it is configured for GPIO control which allows the
53 //! System CPU to set the value of the DIO via the [GPIO API](\ref gpio_api). Alternatively, a DIO
54 //! can be "hardware controlled" if it is controlled by other modules than GPIO.
55 //!
56 //! \section sec_ioc_api API
57 //!
58 //! The API functions can be grouped like this:
59 //!
60 //! Configure all settings at the same time:
61 //! - \ref IOCPortConfigureSet()
62 //! - \ref IOCPortConfigureGet()
63 //!
64 //! Configure individual settings:
65 //! - \ref IOCIODrvStrengthSet()
66 //! - \ref IOCIOHystSet()
67 //! - \ref IOCIOInputSet()
68 //! - \ref IOCIOIntSet()
69 //! - \ref IOCIOModeSet()
70 //! - \ref IOCIOPortIdSet()
71 //! - \ref IOCIOPortPullSet()
72 //! - \ref IOCIOShutdownSet()
73 //! - \ref IOCIOSlewCtrlSet()
74 //!
75 //! Handle edge detection events:
76 //! - \ref IOCIntEnable()
77 //! - \ref IOCIntDisable()
78 //! - \ref IOCIntClear()
79 //! - \ref IOCIntStatus()
80 //! - \ref IOCIntRegister()
81 //! - \ref IOCIntUnregister()
82 //!
83 //! Configure IOCs for typical use cases (can also be used as example code):
84 //! - \ref IOCPinTypeAux()
85 //! - \ref IOCPinTypeGpioInput()
86 //! - \ref IOCPinTypeGpioOutput()
87 //! - \ref IOCPinTypeI2c()
88 //! - \ref IOCPinTypeSsiMaster()
89 //! - \ref IOCPinTypeSsiSlave()
90 //! - \ref IOCPinTypeUart()
91 //!
92 //! @}
93