1 /****************************************************************************** 2 * Filename: 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 event_api 35 //! @{ 36 //! \section sec_event 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 AON event fabric, see [AON event API](@ref aonevent_api). 41 //! 42 //! The MCU event fabric is a combinational router between event sources and event subscribers. Most 43 //! event subscribers have statically routed event sources but several event subscribers have 44 //! configurable event sources which is configured in the MCU event fabric through this API. Although 45 //! configurable only a subset of event sources are available to each of the configurable event subscribers. 46 //! This is explained in more details in the function @ref EventRegister() which does all the event routing 47 //! configuration. 48 //! 49 //! MCU event fabric also contains four software events which allow software to trigger certain event 50 //! subscribers. Each of the four software events is an independent event source which must be set and 51 //! cleared in the MCU event fabric through the functions: 52 //! - @ref EventSwEventSet() 53 //! - @ref EventSwEventClear() 54 //! - @ref EventSwEventGet() 55 //! 56 //! @} 57
