1 /****************************************************************************** 2 * Filename: aon_event_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 aonevent_api 35 //! @{ 36 //! \section sec_aonevent Introduction 37 //! 38 //! The event fabric consists of two event modules. One in the MCU power domain (MCU event fabric) and 39 //! the other in the AON power domain (AON event fabric). The MCU event fabric is one of the subscribers 40 //! to the AON event fabric. For more information on MCU event fabric, see [MCU event API](@ref event_api). 41 //! 42 //! The AON event fabric is a configurable combinatorial router between AON event sources and event 43 //! subscribers in both AON and MCU domains. The API to control the AON event fabric configuration 44 //! can be grouped based on the event subscriber to configure: 45 //! 46 //! - Wake-up events. 47 //! - MCU wake-up event 48 //! - @ref AONEventMcuWakeUpSet() 49 //! - @ref AONEventMcuWakeUpGet() 50 //! - AON RTC receives a single programmable event line from the AON event fabric. For more information, see [AON RTC API](@ref aonrtc_api). 51 //! - @ref AONEventRtcSet() 52 //! - @ref AONEventRtcGet() 53 //! - MCU event fabric receives a number of programmable event lines from the AON event fabric. For more information, see [MCU event API](@ref event_api). 54 //! - @ref AONEventMcuSet() 55 //! - @ref AONEventMcuGet() 56 //! @} 57
