testsuites/validation/tc-message-macros.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RtemsMessageValMessageMacros
0007  */
0008
0009 /*
0010  * Copyright (C) 2021 embedded brains GmbH & Co. KG
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 /*
0035  * This file is part of the RTEMS quality process and was automatically
0036  * generated.  If you find something that needs to be fixed or
0037  * worded better please post a report or patch to an RTEMS mailing list
0038  * or raise a bug report:
0039  *
0040  * https://www.rtems.org/bugs.html
0041  *
0042  * For information on updating and regenerating please refer to the How-To
0043  * section in the Software Requirements Engineering chapter of the
0044  * RTEMS Software Engineering manual.  The manual is provided as a part of
0045  * a release.  For development sources please refer to the online
0046  * documentation at:
0047  *
0048  * https://docs.rtems.org
0049  */
0050
0051 #ifdef HAVE_CONFIG_H
0052 #include "config.h"
0053 #endif
0054
0055 #include <rtems.h>
0056
0057 #include <rtems/test.h>
0058
0059 /**
0060  * @defgroup RtemsMessageValMessageMacros \
0061  *   spec:/rtems/message/val/message-macros
0062  *
0063  * @ingroup TestsuitesValidationNoClock0
0064  *
0065  * @brief Tests the macros of the @ref RTEMSAPIClassicMessage.
0066  *
0067  * This test case performs the following actions:
0068  *
0069  * - Check the RTEMS_MESSAGE_QUEUE_BUFFER() macro.
0070  *
0071  *   - Check that the object defined by the RTEMS_MESSAGE_QUEUE_BUFFER()
0072  *     expression has the desired size. rtems_message_queue_construct() will
0073  *     return RTEMS_UNSATISFIED instead of RTEMS_SUCCESSFUL if the object
0074  *     defined by the RTEMS_MESSAGE_QUEUE_BUFFER() expression has incorrect
0075  *     size.
0076  *
0077  * @{
0078  */
0079
0080 /**
0081  * @brief Check the RTEMS_MESSAGE_QUEUE_BUFFER() macro.
0082  */
0083 static void RtemsMessageValMessageMacros_Action_0( void )
0084 {
0085   rtems_status_code     status;
0086   rtems_id              id;
0087
0088   static const uint32_t maximum_pending_messages_0 = 1;
0089   static const size_t   maximum_message_size_0 = 1;
0090   RTEMS_MESSAGE_QUEUE_BUFFER( maximum_message_size_0 )
0091                         storage_area_0[ maximum_pending_messages_0 ];
0092   rtems_message_queue_config config_0 = {
0093     .name = rtems_build_name( 'M', 'S', 'G', '0' ),
0094     .maximum_pending_messages = maximum_pending_messages_0,
0095     .maximum_message_size = maximum_message_size_0,
0096     .storage_area = storage_area_0,
0097     .storage_size = sizeof( storage_area_0 ),
0098     .storage_free = NULL,
0099     .attributes = RTEMS_DEFAULT_OPTIONS
0100   };
0101
0102   static const uint32_t maximum_pending_messages_1 = 3;
0103   static const size_t   maximum_message_size_1 = 5;
0104   RTEMS_MESSAGE_QUEUE_BUFFER( maximum_message_size_1 )
0105                         storage_area_1[ maximum_pending_messages_1 ];
0106   rtems_message_queue_config config_1 = {
0107     .name = rtems_build_name( 'M', 'S', 'G', '1' ),
0108     .maximum_pending_messages = maximum_pending_messages_1,
0109     .maximum_message_size = maximum_message_size_1,
0110     .storage_area = storage_area_1,
0111     .storage_size = sizeof( storage_area_1 ),
0112     .storage_free = NULL,
0113     .attributes = RTEMS_DEFAULT_OPTIONS
0114   };
0115
0116   /*
0117    * Check that the object defined by the RTEMS_MESSAGE_QUEUE_BUFFER()
0118    * expression has the desired size. rtems_message_queue_construct() will
0119    * return RTEMS_UNSATISFIED instead of RTEMS_SUCCESSFUL if the object defined
0120    * by the RTEMS_MESSAGE_QUEUE_BUFFER() expression has incorrect size.
0121    */
0122   status = rtems_message_queue_construct(
0123     &config_0,
0124     &id
0125   );
0126   T_step_rsc_success( 0, status );
0127   T_step_rsc_success( 1, rtems_message_queue_delete( id ) );
0128
0129   status = rtems_message_queue_construct(
0130     &config_1,
0131     &id
0132   );
0133   T_step_rsc_success( 2, status );
0134   T_step_rsc_success( 3, rtems_message_queue_delete( id ) );
0135 }
0136
0137 /**
0138  * @fn void T_case_body_RtemsMessageValMessageMacros( void )
0139  */
0140 T_TEST_CASE( RtemsMessageValMessageMacros )
0141 {
0142   T_plan( 4 );
0143
0144   RtemsMessageValMessageMacros_Action_0();
0145 }
0146
0147 /** @} */