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