RCL_Event.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2023, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __rcl_events_h__
#define __rcl_events_h__

#include <stdint.h>

#define RCL_EventNone                  ((RCL_Events){ .value = (0 << 0)})   
#define RCL_EventCmdStarted            ((RCL_Events){ .value = (1 << 0)})   
#define RCL_EventLastCmdDone           ((RCL_Events){ .value = (1 << 1)})   
#define RCL_EventRxEntryAvail          ((RCL_Events){ .value = (1 << 2)})   
#define RCL_EventRxBufferFinished      ((RCL_Events){ .value = (1 << 3)})   
#define RCL_EventTxBufferFinished      ((RCL_Events){ .value = (1 << 4)})   
#define RCL_EventSoftwareTriggered     ((RCL_Events){ .value = (1 << 5)})   
#define RCL_EventTimerStart            ((RCL_Events){ .value = (1 << 6)})   
#define RCL_EventDescheduleStop        ((RCL_Events){ .value = (1 << 7)})   
#define RCL_EventGracefulStop          ((RCL_Events){ .value = (1 << 8)})   
#define RCL_EventHardStop              ((RCL_Events){ .value = (1 << 9)})   
#define RCL_EventStopDelayed           ((RCL_Events){ .value = (1 << 10)})  
#define RCL_EventStopRejected          ((RCL_Events){ .value = (1 << 11)})  
#define RCL_EventStartDelayed          ((RCL_Events){ .value = (1 << 12)})  
#define RCL_EventStartRejected         ((RCL_Events){ .value = (1 << 13)})  
#define RCL_EventSetup                 ((RCL_Events){ .value = (1 << 14)})  
#define RCL_EventPartialSetup          ((RCL_Events){ .value = (1 << 15)})  
#define RCL_EventRxBufferUpdate        ((RCL_Events){ .value = (1 << 16)})  
#define RCL_EventTxBufferUpdate        ((RCL_Events){ .value = (1 << 17)})  
#define RCL_EventHandlerCmdUpdate      ((RCL_Events){ .value = (1 << 18)})  
#define RCL_EventCmdStepDone           ((RCL_Events){ .value = (1 << 19)})  
#define RCL_EventStopTimesUpdated      ((RCL_Events){ .value = (1 << 20)})  
union RCL_Events_u {
    struct {
        uint32_t cmdStarted          : 1; 
        uint32_t lastCmdDone         : 1; 
        uint32_t rxEntryAvail        : 1; 
        uint32_t rxBufferFinished    : 1; 
        uint32_t txBufferFinished    : 1; 
        uint32_t swTriggered         : 1; 
        uint32_t timerStart          : 1; 
        uint32_t descheduleStop      : 1; 
        uint32_t gracefulStop        : 1; 
        uint32_t hardStop            : 1; 
        uint32_t stopDelayed         : 1; 
        uint32_t stopRejected        : 1; 
        uint32_t startDelayed        : 1; 
        uint32_t startRejected       : 1; 
        uint32_t setup               : 1; 
        uint32_t partialSetup        : 1; 
        uint32_t rxBufferUpdate      : 1; 
        uint32_t txBufferUpdate      : 1; 
        uint32_t handlerCmdUpdate    : 1; 
        uint32_t cmdStepDone         : 1; 
        uint32_t stopTimesUpdated    : 1; 
    };
    uint32_t value;
};

#endif