summaryrefslogtreecommitdiffstats
path: root/testsuites/validation/tc-intr-get-attributes.c
blob: 16860a08cdcc2e7afcd2eaba88212d72fa02e8e8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSTestCaseRtemsIntrReqGetAttributes
 */

/*
 * Copyright (C) 2021 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.
 */

/*
 * 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
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <string.h>
#include <bsp/irq-generic.h>
#include <rtems/irq-extension.h>

#include <rtems/test.h>

/**
 * @defgroup RTEMSTestCaseRtemsIntrReqGetAttributes \
 *   spec:/rtems/intr/req/get-attributes
 *
 * @ingroup RTEMSTestSuiteTestsuitesValidation0
 *
 * @{
 */

typedef enum {
  RtemsIntrReqGetAttributes_Pre_Vector_Valid,
  RtemsIntrReqGetAttributes_Pre_Vector_Invalid,
  RtemsIntrReqGetAttributes_Pre_Vector_NA
} RtemsIntrReqGetAttributes_Pre_Vector;

typedef enum {
  RtemsIntrReqGetAttributes_Pre_Attributes_Obj,
  RtemsIntrReqGetAttributes_Pre_Attributes_Null,
  RtemsIntrReqGetAttributes_Pre_Attributes_NA
} RtemsIntrReqGetAttributes_Pre_Attributes;

typedef enum {
  RtemsIntrReqGetAttributes_Post_Status_Ok,
  RtemsIntrReqGetAttributes_Post_Status_InvAddr,
  RtemsIntrReqGetAttributes_Post_Status_InvId,
  RtemsIntrReqGetAttributes_Post_Status_NA
} RtemsIntrReqGetAttributes_Post_Status;

typedef enum {
  RtemsIntrReqGetAttributes_Post_Attributes_Nop,
  RtemsIntrReqGetAttributes_Post_Attributes_Zero,
  RtemsIntrReqGetAttributes_Post_Attributes_Set,
  RtemsIntrReqGetAttributes_Post_Attributes_NA
} RtemsIntrReqGetAttributes_Post_Attributes;

/**
 * @brief Test context for spec:/rtems/intr/req/get-attributes test case.
 */
typedef struct {
  /**
   * @brief This member provides the rtems_interrupt_attributes object.
   */
  rtems_interrupt_attributes attributes_obj;

  /**
   * @brief If this member is true, then the ``vector`` parameter shall be
   *   valid.
   */
  bool valid_vector;

  /**
   * @brief This member specifies if the ``attributes`` parameter value.
   */
  rtems_interrupt_attributes *attributes;;

  /**
   * @brief This member contains the return value of the
   *   rtems_interrupt_get_attributes() call.
   */
  rtems_status_code status;

  /**
   * @brief This member defines the pre-condition states for the next action.
   */
  size_t pcs[ 2 ];

  /**
   * @brief This member indicates if the test action loop is currently
   *   executed.
   */
  bool in_action_loop;
} RtemsIntrReqGetAttributes_Context;

static RtemsIntrReqGetAttributes_Context
  RtemsIntrReqGetAttributes_Instance;

static const char * const RtemsIntrReqGetAttributes_PreDesc_Vector[] = {
  "Valid",
  "Invalid",
  "NA"
};

static const char * const RtemsIntrReqGetAttributes_PreDesc_Attributes[] = {
  "Obj",
  "Null",
  "NA"
};

static const char * const * const RtemsIntrReqGetAttributes_PreDesc[] = {
  RtemsIntrReqGetAttributes_PreDesc_Vector,
  RtemsIntrReqGetAttributes_PreDesc_Attributes,
  NULL
};

static void RtemsIntrReqGetAttributes_Pre_Vector_Prepare(
  RtemsIntrReqGetAttributes_Context   *ctx,
  RtemsIntrReqGetAttributes_Pre_Vector state
)
{
  switch ( state ) {
    case RtemsIntrReqGetAttributes_Pre_Vector_Valid: {
      /*
       * While the ``vector`` parameter is associated with an interrupt vector.
       */
      ctx->valid_vector = true;
      break;
    }

    case RtemsIntrReqGetAttributes_Pre_Vector_Invalid: {
      /*
       * While the ``vector`` parameter is not associated with an interrupt
       * vector.
       */
      ctx->valid_vector = false;
      break;
    }

    case RtemsIntrReqGetAttributes_Pre_Vector_NA:
      break;
  }
}

static void RtemsIntrReqGetAttributes_Pre_Attributes_Prepare(
  RtemsIntrReqGetAttributes_Context       *ctx,
  RtemsIntrReqGetAttributes_Pre_Attributes state
)
{
  switch ( state ) {
    case RtemsIntrReqGetAttributes_Pre_Attributes_Obj: {
      /*
       * While the ``attributes`` parameter references an object of type
       * rtems_interrupt_attributes.
       */
      ctx->attributes = &ctx->attributes_obj;
      break;
    }

    case RtemsIntrReqGetAttributes_Pre_Attributes_Null: {
      /*
       * While the ``attributes`` parameter is equal to NULL.
       */
      ctx->attributes = NULL;
      break;
    }

    case RtemsIntrReqGetAttributes_Pre_Attributes_NA:
      break;
  }
}

static void RtemsIntrReqGetAttributes_Post_Status_Check(
  RtemsIntrReqGetAttributes_Context    *ctx,
  RtemsIntrReqGetAttributes_Post_Status state
)
{
  switch ( state ) {
    case RtemsIntrReqGetAttributes_Post_Status_Ok: {
      /*
       * The return status of rtems_interrupt_get_attributes() shall be
       * RTEMS_SUCCESSFUL.
       */
      T_rsc_success( ctx->status );
      break;
    }

    case RtemsIntrReqGetAttributes_Post_Status_InvAddr: {
      /*
       * The return status of rtems_interrupt_get_attributes() shall be
       * RTEMS_INVALID_ADDRESS.
       */
      T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
      break;
    }

    case RtemsIntrReqGetAttributes_Post_Status_InvId: {
      /*
       * The return status of rtems_interrupt_get_attributes() shall be
       * RTEMS_INVALID_ID.
       */
      T_rsc( ctx->status, RTEMS_INVALID_ID );
      break;
    }

    case RtemsIntrReqGetAttributes_Post_Status_NA:
      break;
  }
}

static void RtemsIntrReqGetAttributes_Post_Attributes_Check(
  RtemsIntrReqGetAttributes_Context        *ctx,
  RtemsIntrReqGetAttributes_Post_Attributes state
)
{
  rtems_interrupt_attributes attr;

  switch ( state ) {
    case RtemsIntrReqGetAttributes_Post_Attributes_Nop: {
      /*
       * Objects referenced by the ``attributes`` parameter in past calls to
       * rtems_interrupt_get_attributes() shall not be accessed by the
       * rtems_interrupt_get_attributes() call.
       */
      memset( &attr, 0xa5, sizeof( attr ) );
      T_eq_mem( &ctx->attributes_obj, &attr, sizeof( attr ) );
      break;
    }

    case RtemsIntrReqGetAttributes_Post_Attributes_Zero: {
      /*
       * The object referenced by the ``attributes`` parameter shall cleared to
       * zero.
       */
      memset( &attr, 0, sizeof( attr ) );
      T_eq_mem( &ctx->attributes_obj, &attr, sizeof( attr ) );
      break;
    }

    case RtemsIntrReqGetAttributes_Post_Attributes_Set: {
      /*
       * The members of the object referenced by the ``attributes`` parameter
       * shall be set to the attributes of the interrupt vector specified by
       * ``vector``.
       */
      memset( &attr, 0xa5, sizeof( attr ) );
      T_ne_mem( &ctx->attributes_obj, &attr, sizeof( attr ) );
      break;
    }

    case RtemsIntrReqGetAttributes_Post_Attributes_NA:
      break;
  }
}

static void RtemsIntrReqGetAttributes_Prepare(
  RtemsIntrReqGetAttributes_Context *ctx
)
{
  memset( &ctx->attributes_obj, 0xa5, sizeof( ctx->attributes_obj ) );
}

static void RtemsIntrReqGetAttributes_Action(
  RtemsIntrReqGetAttributes_Context *ctx
)
{
  rtems_vector_number vector;

  if ( ctx->valid_vector && ctx->attributes != NULL ) {
    ctx->status = RTEMS_INTERNAL_ERROR;

    for ( vector = 0; vector < BSP_INTERRUPT_VECTOR_COUNT; ++vector ) {
      rtems_status_code sc;

      memset( &ctx->attributes_obj, 0xff, sizeof( ctx->attributes_obj ) );
      sc = rtems_interrupt_get_attributes( vector, ctx->attributes );

      if ( sc == RTEMS_INVALID_ID ) {
        continue;
      }

      T_rsc_success( sc );
      ctx->status = sc;

      if ( ctx->attributes_obj.can_enable ) {
        T_true( ctx->attributes_obj.maybe_enable );
      }

      if ( ctx->attributes_obj.can_disable ) {
        T_true( ctx->attributes_obj.maybe_disable );
        T_true(
          ctx->attributes_obj.can_enable || ctx->attributes_obj.maybe_enable
        );
      }
    }
  } else {
    if ( ctx->valid_vector ) {
      vector = 0;
    } else {
      vector = BSP_INTERRUPT_VECTOR_COUNT;
    }

    ctx->status = rtems_interrupt_get_attributes( vector, ctx->attributes );
  }
}

typedef struct {
  uint8_t Skip : 1;
  uint8_t Pre_Vector_NA : 1;
  uint8_t Pre_Attributes_NA : 1;
  uint8_t Post_Status : 2;
  uint8_t Post_Attributes : 2;
} RtemsIntrReqGetAttributes_Entry;

static const RtemsIntrReqGetAttributes_Entry
RtemsIntrReqGetAttributes_Entries[] = {
  { 0, 0, 0, RtemsIntrReqGetAttributes_Post_Status_InvAddr,
    RtemsIntrReqGetAttributes_Post_Attributes_Nop },
  { 0, 0, 0, RtemsIntrReqGetAttributes_Post_Status_Ok,
    RtemsIntrReqGetAttributes_Post_Attributes_Set },
  { 0, 0, 0, RtemsIntrReqGetAttributes_Post_Status_InvId,
    RtemsIntrReqGetAttributes_Post_Attributes_Zero }
};

static const uint8_t
RtemsIntrReqGetAttributes_Map[] = {
  1, 0, 2, 0
};

static size_t RtemsIntrReqGetAttributes_Scope( void *arg, char *buf, size_t n )
{
  RtemsIntrReqGetAttributes_Context *ctx;

  ctx = arg;

  if ( ctx->in_action_loop ) {
    return T_get_scope( RtemsIntrReqGetAttributes_PreDesc, buf, n, ctx->pcs );
  }

  return 0;
}

static T_fixture RtemsIntrReqGetAttributes_Fixture = {
  .setup = NULL,
  .stop = NULL,
  .teardown = NULL,
  .scope = RtemsIntrReqGetAttributes_Scope,
  .initial_context = &RtemsIntrReqGetAttributes_Instance
};

static inline RtemsIntrReqGetAttributes_Entry
RtemsIntrReqGetAttributes_GetEntry( size_t index )
{
  return RtemsIntrReqGetAttributes_Entries[
    RtemsIntrReqGetAttributes_Map[ index ]
  ];
}

/**
 * @fn void T_case_body_RtemsIntrReqGetAttributes( void )
 */
T_TEST_CASE_FIXTURE(
  RtemsIntrReqGetAttributes,
  &RtemsIntrReqGetAttributes_Fixture
)
{
  RtemsIntrReqGetAttributes_Context *ctx;
  size_t index;

  ctx = T_fixture_context();
  ctx->in_action_loop = true;
  index = 0;

  for (
    ctx->pcs[ 0 ] = RtemsIntrReqGetAttributes_Pre_Vector_Valid;
    ctx->pcs[ 0 ] < RtemsIntrReqGetAttributes_Pre_Vector_NA;
    ++ctx->pcs[ 0 ]
  ) {
    for (
      ctx->pcs[ 1 ] = RtemsIntrReqGetAttributes_Pre_Attributes_Obj;
      ctx->pcs[ 1 ] < RtemsIntrReqGetAttributes_Pre_Attributes_NA;
      ++ctx->pcs[ 1 ]
    ) {
      RtemsIntrReqGetAttributes_Entry entry;

      entry = RtemsIntrReqGetAttributes_GetEntry( index );
      ++index;

      RtemsIntrReqGetAttributes_Prepare( ctx );
      RtemsIntrReqGetAttributes_Pre_Vector_Prepare( ctx, ctx->pcs[ 0 ] );
      RtemsIntrReqGetAttributes_Pre_Attributes_Prepare( ctx, ctx->pcs[ 1 ] );
      RtemsIntrReqGetAttributes_Action( ctx );
      RtemsIntrReqGetAttributes_Post_Status_Check( ctx, entry.Post_Status );
      RtemsIntrReqGetAttributes_Post_Attributes_Check(
        ctx,
        entry.Post_Attributes
      );
    }
  }
}

/** @} */