Files
threadx/common_smp/src/txe_event_flags_set.c
2020-09-30 15:42:41 -07:00

127 lines
6.1 KiB
C

/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** ThreadX Component */
/** */
/** Event Flags */
/** */
/**************************************************************************/
/**************************************************************************/
#define TX_SOURCE_CODE
/* Include necessary system files. */
#include "tx_api.h"
#include "tx_event_flags.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _txe_event_flags_set PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks for errors in the set event flags function */
/* call. */
/* */
/* INPUT */
/* */
/* group_ptr Pointer to group control block */
/* flags_to_set Event flags to set */
/* set_option Specified either AND or OR */
/* operation on the event flags */
/* */
/* OUTPUT */
/* */
/* TX_GROUP_ERROR Invalid event flags group pointer */
/* TX_OPTION_ERROR Invalid set option */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _tx_event_flags_set Actual set event flags function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 09-30-2020 William E. Lamie Initial Version 6.1 */
/* */
/**************************************************************************/
UINT _txe_event_flags_set(TX_EVENT_FLAGS_GROUP *group_ptr, ULONG flags_to_set, UINT set_option)
{
UINT status;
/* Default status to success. */
status = TX_SUCCESS;
/* Check for an invalid event flag group pointer. */
if (group_ptr == TX_NULL)
{
/* Event flags group pointer is invalid, return appropriate error code. */
status = TX_GROUP_ERROR;
}
/* Now check for invalid event flag group ID. */
else if (group_ptr -> tx_event_flags_group_id != TX_EVENT_FLAGS_ID)
{
/* Event flags group pointer is invalid, return appropriate error code. */
status = TX_GROUP_ERROR;
}
else
{
/* Check for invalid set option. */
if (set_option != TX_AND)
{
if (set_option != TX_OR)
{
/* Invalid set events option, return appropriate error. */
status = TX_OPTION_ERROR;
}
}
}
/* Determine if everything is okay. */
if (status == TX_SUCCESS)
{
/* Call actual event flags set function. */
status = _tx_event_flags_set(group_ptr, flags_to_set, set_option);
}
/* Return completion status. */
return(status);
}