event.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2014, 2021 embedded brains GmbH & Co. KG
 * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 *
 * 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.
 */
 
/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */
 
/* Generated from spec:/rtems/event/if/header */
 
#ifndef _RTEMS_RTEMS_EVENT_H
#define _RTEMS_RTEMS_EVENT_H
 
#include <stdint.h>
#include <rtems/rtems/options.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Generated from spec:/rtems/event/if/group */
 
/* Generated from spec:/rtems/event/if/all-events */
 
#define RTEMS_ALL_EVENTS 0xffffffff
 
/* Generated from spec:/rtems/event/if/event-00 */
 
#define RTEMS_EVENT_0 0x00000001
 
/* Generated from spec:/rtems/event/if/event-01 */
 
#define RTEMS_EVENT_1 0x00000002
 
/* Generated from spec:/rtems/event/if/event-02 */
 
#define RTEMS_EVENT_2 0x00000004
 
/* Generated from spec:/rtems/event/if/event-03 */
 
#define RTEMS_EVENT_3 0x00000008
 
/* Generated from spec:/rtems/event/if/event-04 */
 
#define RTEMS_EVENT_4 0x00000010
 
/* Generated from spec:/rtems/event/if/event-05 */
 
#define RTEMS_EVENT_5 0x00000020
 
/* Generated from spec:/rtems/event/if/event-06 */
 
#define RTEMS_EVENT_6 0x00000040
 
/* Generated from spec:/rtems/event/if/event-07 */
 
#define RTEMS_EVENT_7 0x00000080
 
/* Generated from spec:/rtems/event/if/event-08 */
 
#define RTEMS_EVENT_8 0x00000100
 
/* Generated from spec:/rtems/event/if/event-09 */
 
#define RTEMS_EVENT_9 0x00000200
 
/* Generated from spec:/rtems/event/if/event-10 */
 
#define RTEMS_EVENT_10 0x00000400
 
/* Generated from spec:/rtems/event/if/event-11 */
 
#define RTEMS_EVENT_11 0x00000800
 
/* Generated from spec:/rtems/event/if/event-12 */
 
#define RTEMS_EVENT_12 0x00001000
 
/* Generated from spec:/rtems/event/if/event-13 */
 
#define RTEMS_EVENT_13 0x00002000
 
/* Generated from spec:/rtems/event/if/event-14 */
 
#define RTEMS_EVENT_14 0x00004000
 
/* Generated from spec:/rtems/event/if/event-15 */
 
#define RTEMS_EVENT_15 0x00008000
 
/* Generated from spec:/rtems/event/if/event-16 */
 
#define RTEMS_EVENT_16 0x00010000
 
/* Generated from spec:/rtems/event/if/event-17 */
 
#define RTEMS_EVENT_17 0x00020000
 
/* Generated from spec:/rtems/event/if/event-18 */
 
#define RTEMS_EVENT_18 0x00040000
 
/* Generated from spec:/rtems/event/if/event-19 */
 
#define RTEMS_EVENT_19 0x00080000
 
/* Generated from spec:/rtems/event/if/event-20 */
 
#define RTEMS_EVENT_20 0x00100000
 
/* Generated from spec:/rtems/event/if/event-21 */
 
#define RTEMS_EVENT_21 0x00200000
 
/* Generated from spec:/rtems/event/if/event-22 */
 
#define RTEMS_EVENT_22 0x00400000
 
/* Generated from spec:/rtems/event/if/event-23 */
 
#define RTEMS_EVENT_23 0x00800000
 
/* Generated from spec:/rtems/event/if/event-24 */
 
#define RTEMS_EVENT_24 0x01000000
 
/* Generated from spec:/rtems/event/if/event-25 */
 
#define RTEMS_EVENT_25 0x02000000
 
/* Generated from spec:/rtems/event/if/event-26 */
 
#define RTEMS_EVENT_26 0x04000000
 
/* Generated from spec:/rtems/event/if/event-27 */
 
#define RTEMS_EVENT_27 0x08000000
 
/* Generated from spec:/rtems/event/if/event-28 */
 
#define RTEMS_EVENT_28 0x10000000
 
/* Generated from spec:/rtems/event/if/event-29 */
 
#define RTEMS_EVENT_29 0x20000000
 
/* Generated from spec:/rtems/event/if/event-30 */
 
#define RTEMS_EVENT_30 0x40000000
 
/* Generated from spec:/rtems/event/if/event-31 */
 
#define RTEMS_EVENT_31 0x80000000
 
/* Generated from spec:/rtems/event/if/pending-events */
 
#define RTEMS_PENDING_EVENTS 0
 
/* Generated from spec:/rtems/event/if/set */
 
typedef uint32_t rtems_event_set;
 
/* Generated from spec:/rtems/event/if/system-network-close */
 
#define RTEMS_EVENT_SYSTEM_NETWORK_CLOSE RTEMS_EVENT_26
 
/* Generated from spec:/rtems/event/if/system-network-sbwait */
 
#define RTEMS_EVENT_SYSTEM_NETWORK_SBWAIT RTEMS_EVENT_24
 
/* Generated from spec:/rtems/event/if/system-network-sosleep */
 
#define RTEMS_EVENT_SYSTEM_NETWORK_SOSLEEP RTEMS_EVENT_25
 
/* Generated from spec:/rtems/event/if/system-receive */
 
rtems_status_code rtems_event_system_receive(
  rtems_event_set  event_in,
  rtems_option     option_set,
  rtems_interval   ticks,
  rtems_event_set *event_out
);
 
/* Generated from spec:/rtems/event/if/system-send */
 
rtems_status_code rtems_event_system_send(
  rtems_id        id,
  rtems_event_set event_in
);
 
/* Generated from spec:/rtems/event/if/system-server */
 
#define RTEMS_EVENT_SYSTEM_SERVER RTEMS_EVENT_30
 
/* Generated from spec:/rtems/event/if/system-server-resume */
 
#define RTEMS_EVENT_SYSTEM_SERVER_RESUME RTEMS_EVENT_29
 
/* Generated from spec:/rtems/event/if/system-transient */
 
#define RTEMS_EVENT_SYSTEM_TRANSIENT RTEMS_EVENT_31
 
/* Generated from spec:/rtems/event/if/transient-clear */
 
static inline void rtems_event_transient_clear( void )
{
  rtems_event_set event_out;
 
  (void) rtems_event_system_receive(
    RTEMS_EVENT_SYSTEM_TRANSIENT,
    RTEMS_EVENT_ALL | RTEMS_NO_WAIT,
    0,
    &event_out
  );
}
 
/* Generated from spec:/rtems/event/if/transient-receive */
 
static inline rtems_status_code rtems_event_transient_receive(
  rtems_option   option_set,
  rtems_interval ticks
)
{
  rtems_event_set event_out;
 
  return rtems_event_system_receive(
    RTEMS_EVENT_SYSTEM_TRANSIENT,
    RTEMS_EVENT_ALL | option_set,
    ticks,
    &event_out
  );
}
 
/* Generated from spec:/rtems/event/if/transient-send */
 
static inline rtems_status_code rtems_event_transient_send( rtems_id id )
{
  return rtems_event_system_send( id, RTEMS_EVENT_SYSTEM_TRANSIENT );
}
 
/* Generated from spec:/rtems/event/if/send */
 
rtems_status_code rtems_event_send( rtems_id id, rtems_event_set event_in );
 
/* Generated from spec:/rtems/event/if/receive */
 
rtems_status_code rtems_event_receive(
  rtems_event_set  event_in,
  rtems_option     option_set,
  rtems_interval   ticks,
  rtems_event_set *event_out
);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTEMS_RTEMS_EVENT_H */