tr-event-send.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

/*
 * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * 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 _TR_EVENT_SEND_H
#define _TR_EVENT_SEND_H

#include <rtems.h>
#include <rtems/score/thread.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
  ReqRtemsEventSendReceive_Pre_Id_InvId,
  ReqRtemsEventSendReceive_Pre_Id_Task,
  ReqRtemsEventSendReceive_Pre_Id_NA
} ReqRtemsEventSendReceive_Pre_Id;

typedef enum {
  ReqRtemsEventSendReceive_Pre_Send_Zero,
  ReqRtemsEventSendReceive_Pre_Send_Unrelated,
  ReqRtemsEventSendReceive_Pre_Send_Any,
  ReqRtemsEventSendReceive_Pre_Send_All,
  ReqRtemsEventSendReceive_Pre_Send_MixedAny,
  ReqRtemsEventSendReceive_Pre_Send_MixedAll,
  ReqRtemsEventSendReceive_Pre_Send_NA
} ReqRtemsEventSendReceive_Pre_Send;

typedef enum {
  ReqRtemsEventSendReceive_Pre_ReceiverState_NotWaiting,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Poll,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Timeout,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Lower,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Equal,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Higher,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Other,
  ReqRtemsEventSendReceive_Pre_ReceiverState_Intend,
  ReqRtemsEventSendReceive_Pre_ReceiverState_NA
} ReqRtemsEventSendReceive_Pre_ReceiverState;

typedef enum {
  ReqRtemsEventSendReceive_Pre_Satisfy_All,
  ReqRtemsEventSendReceive_Pre_Satisfy_Any,
  ReqRtemsEventSendReceive_Pre_Satisfy_NA
} ReqRtemsEventSendReceive_Pre_Satisfy;

typedef enum {
  ReqRtemsEventSendReceive_Post_SendStatus_Ok,
  ReqRtemsEventSendReceive_Post_SendStatus_InvId,
  ReqRtemsEventSendReceive_Post_SendStatus_NA
} ReqRtemsEventSendReceive_Post_SendStatus;

typedef enum {
  ReqRtemsEventSendReceive_Post_ReceiveStatus_None,
  ReqRtemsEventSendReceive_Post_ReceiveStatus_Pending,
  ReqRtemsEventSendReceive_Post_ReceiveStatus_Timeout,
  ReqRtemsEventSendReceive_Post_ReceiveStatus_Satisfied,
  ReqRtemsEventSendReceive_Post_ReceiveStatus_Unsatisfied,
  ReqRtemsEventSendReceive_Post_ReceiveStatus_Blocked,
  ReqRtemsEventSendReceive_Post_ReceiveStatus_NA
} ReqRtemsEventSendReceive_Post_ReceiveStatus;

typedef enum {
  ReqRtemsEventSendReceive_Post_SenderPreemption_No,
  ReqRtemsEventSendReceive_Post_SenderPreemption_Yes,
  ReqRtemsEventSendReceive_Post_SenderPreemption_NA
} ReqRtemsEventSendReceive_Post_SenderPreemption;

void ReqRtemsEventSendReceive_Run(
  rtems_status_code ( *send )( rtems_id, rtems_event_set ),
  rtems_status_code ( *receive )( rtems_event_set, rtems_option, rtems_interval, rtems_event_set * ),
  rtems_event_set (   *get_pending_events )( Thread_Control * )
);

#ifdef __cplusplus
}
#endif

#endif /* _TR_EVENT_SEND_H */