From 8de874b7666062e811ab825cce1dc1aad5f42251 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 4 Jun 2020 19:50:25 +0200 Subject: rtems: Generate Change license to BSD-2-Clause according to file histories and documentation re-licensing agreement. Update #3899. Update #3993. --- cpukit/include/rtems/rtems/options.h | 131 +++++++++++++++++++++++++---------- 1 file changed, 95 insertions(+), 36 deletions(-) diff --git a/cpukit/include/rtems/rtems/options.h b/cpukit/include/rtems/rtems/options.h index e50c4d1429..d8431c151d 100644 --- a/cpukit/include/rtems/rtems/options.h +++ b/cpukit/include/rtems/rtems/options.h @@ -1,80 +1,139 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * - * @ingroup ClassicOptions + * @brief This header file provides the Classic API directive options. + */ + +/* + * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + * Copyright (C) 1989, 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 include file contains information which defines the - * options available on many directives. + * 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. */ -/* COPYRIGHT (c) 1989-2008. - * On-Line Applications Research Corporation (OAR). +/* + * 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: * - * The license and distribution terms for this file may be - * found in the file LICENSE in this distribution or at - * http://www.rtems.org/license/LICENSE. + * https://docs.rtems.org/branches/master/user/support/bugs.html + * + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ +/* Generated from spec:/rtems/option/if/header */ + #ifndef _RTEMS_RTEMS_OPTIONS_H #define _RTEMS_RTEMS_OPTIONS_H -#include +#include #ifdef __cplusplus extern "C" { #endif +/* Generated from spec:/rtems/option/if/group */ + /** - * @defgroup ClassicOptions Classic API Options + * @defgroup RTEMSAPIClassicOptions Directive Options * * @ingroup RTEMSAPIClassic * - * This encapsulates functionality related to the options argument - * to Classic API blocking operations. The primary option is whether - * or not a task is willing to wait for the operation to complete. + * @brief This group contains the Classic API directive options. */ -/**@{*/ + +/* Generated from spec:/rtems/option/if/default */ /** - * The following type defines the control block used to manage - * option sets. + * @ingroup RTEMSAPIClassicOptions + * + * @brief This option constant represents the default option set. */ -typedef uint32_t rtems_option; +#define RTEMS_DEFAULT_OPTIONS 0x00000000 + +/* Generated from spec:/rtems/option/if/event-all */ /** - * The following constants define the individual options which may - * be used to compose an option set. + * @ingroup RTEMSAPIClassicOptions + * + * @brief This option constant indicates that the task wishes to wait until all + * events of interest are available in rtems_event_receive() and + * rtems_event_system_receive(). */ -#define RTEMS_DEFAULT_OPTIONS 0x00000000 +#define RTEMS_EVENT_ALL 0x00000000 + +/* Generated from spec:/rtems/option/if/event-any */ /** - * This option constants indicates that the task is to wait on resource. + * @ingroup RTEMSAPIClassicOptions + * + * @brief This option constant indicates that the task wishes to wait until at + * least one of the events of interest is available in rtems_event_receive() + * and rtems_event_system_receive(). */ -#define RTEMS_WAIT 0x00000000 +#define RTEMS_EVENT_ANY 0x00000002 + +/* Generated from spec:/rtems/option/if/no-wait */ + /** - * This option constants indicates that the task is to not wait on - * the resource. If it is not available, return immediately with - * a status to indicate unsatisfied. + * @ingroup RTEMSAPIClassicOptions + * + * @brief This option constant indicates that the task does not want to wait on + * the resource. + * + * If the resource is not available, then the directives shall return + * immediately with a status to indicate that the request is unsatisfied. */ -#define RTEMS_NO_WAIT 0x00000001 +#define RTEMS_NO_WAIT 0x00000001 + +/* Generated from spec:/rtems/option/if/option */ /** - * This option constants indicates that the task wishes to wait until - * all events of interest are available. + * @ingroup RTEMSAPIClassicOptions + * + * @brief This type represents a Classic API directive option set. */ -#define RTEMS_EVENT_ALL 0x00000000 +typedef uint32_t rtems_option; + +/* Generated from spec:/rtems/option/if/wait */ /** - * This option constants indicates that the task wishes to wait until - * ANY events of interest are available. + * @ingroup RTEMSAPIClassicOptions + * + * @brief This option constant indicates that the task wants to wait on the + * resource. + * + * If the resource is not available, then the task shall block and wait for + * request completion. */ -#define RTEMS_EVENT_ANY 0x00000002 - -/**@}*/ +#define RTEMS_WAIT 0x00000000 #ifdef __cplusplus } #endif -#endif -/* end of include file */ +#endif /* _RTEMS_RTEMS_OPTIONS_H */ -- cgit v1.2.3