1 /******************************************************************************
2 *  Filename:       group_aux_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 aux_group
35 //! @{
36 //! \section sec_aux Introduction
37 //!
38 //! The AUX is a collective description of all the analog peripherals (ADC, comparators, and current source) and
39 //! the digital modules in the AUX power domain (AUX_PD) such as the sensor controller, timers, time-to-digital
40 //! converter, etc. AUX_PD is located within the AON voltage domain of the device.
41 //!
42 //! The sensor controller has the ability to
43 //! do its own power and clock management of AUX_PD, independently of the MCU domain. The sensor
44 //! controller can also continue doing tasks while the MCU subsystem is powered down, but with limited
45 //! resources compared to the larger MCU domain.
46 //!
47 //! The AUX power domain is connected to the MCU system through an asynchronous interface, ensuring
48 //! that all modules connected to the AUX bus are accessible from the system CPU.
49 //! Accessing the analog peripherals from the system CPU must be done by using TI-provided
50 //! drivers to ensure proper control of power management.
51 //!
52 //! \note To ease development of program code running on the sensor controller, TI provides a tool
53 //! chain for writing software for the controller, Sensor Controller Studio (SCS), which is a fully
54 //! integrated tool consisting of an IDE, compiler, assembler, and linker.
55 //!
56 //! @}
57