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