summaryrefslogtreecommitdiffstats
path: root/testsuites/validation/tc-intr-is-pending.c
blob: 9a81cb9c23dd50f607eda4102de58c5b2c6b3171 (plain)
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSTestCaseRtemsIntrReqIsPending
 */

/*
 * 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 "tx-support.h"

#include <rtems/test.h>

/**
 * @defgroup RTEMSTestCaseRtemsIntrReqIsPending spec:/rtems/intr/req/is-pending
 *
 * @ingroup RTEMSTestSuiteTestsuitesValidation0
 *
 * @{
 */

typedef enum {
  RtemsIntrReqIsPending_Pre_Vector_Valid,
  RtemsIntrReqIsPending_Pre_Vector_Invalid,
  RtemsIntrReqIsPending_Pre_Vector_NA
} RtemsIntrReqIsPending_Pre_Vector;

typedef enum {
  RtemsIntrReqIsPending_Pre_Pending_Obj,
  RtemsIntrReqIsPending_Pre_Pending_Null,
  RtemsIntrReqIsPending_Pre_Pending_NA
} RtemsIntrReqIsPending_Pre_Pending;

typedef enum {
  RtemsIntrReqIsPending_Pre_IsPending_Yes,
  RtemsIntrReqIsPending_Pre_IsPending_No,
  RtemsIntrReqIsPending_Pre_IsPending_NA
} RtemsIntrReqIsPending_Pre_IsPending;

typedef enum {
  RtemsIntrReqIsPending_Post_Status_Ok,
  RtemsIntrReqIsPending_Post_Status_InvAddr,
  RtemsIntrReqIsPending_Post_Status_InvId,
  RtemsIntrReqIsPending_Post_Status_NA
} RtemsIntrReqIsPending_Post_Status;

typedef enum {
  RtemsIntrReqIsPending_Post_IsPending_Nop,
  RtemsIntrReqIsPending_Post_IsPending_Yes,
  RtemsIntrReqIsPending_Post_IsPending_No,
  RtemsIntrReqIsPending_Post_IsPending_NA
} RtemsIntrReqIsPending_Post_IsPending;

/**
 * @brief Test context for spec:/rtems/intr/req/is-pending test case.
 */
typedef struct {
  /**
   * @brief This member contains the count of serviced interrupts.
   */
  volatile uint32_t interrupt_count;

  /**
   * @brief If this member is true, then the interrupt shall be cleared.
   */
  bool do_clear;

  /**
   * @brief This member contains the current vector number.
   */
  rtems_vector_number vector;

  /**
   * @brief This member provides the ``bool`` object.
   */
  bool pending_obj;

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

  /**
   * @brief This member specifies if the ``pending`` parameter value.
   */
  bool *pending;;

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

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

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

static RtemsIntrReqIsPending_Context
  RtemsIntrReqIsPending_Instance;

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

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

static const char * const RtemsIntrReqIsPending_PreDesc_IsPending[] = {
  "Yes",
  "No",
  "NA"
};

static const char * const * const RtemsIntrReqIsPending_PreDesc[] = {
  RtemsIntrReqIsPending_PreDesc_Vector,
  RtemsIntrReqIsPending_PreDesc_Pending,
  RtemsIntrReqIsPending_PreDesc_IsPending,
  NULL
};

typedef RtemsIntrReqIsPending_Context Context;

static bool IsEnabled( const Context *ctx )
{
  rtems_status_code sc;
  bool              enabled;

  enabled = false;
  sc = rtems_interrupt_vector_is_enabled( ctx->vector, &enabled );
  T_rsc_success( sc );

  return enabled;
}

static bool IsPending( const Context *ctx )
{
  rtems_status_code sc;
  bool              pending;

  pending = false;
  sc = rtems_interrupt_is_pending( ctx->vector, &pending );
  T_rsc_success( sc );

  return pending;
}

static void Disable( const Context *ctx )
{
  rtems_status_code sc;

  sc = rtems_interrupt_vector_disable( ctx->vector );
  T_rsc_success( sc );
}

static void Raise( const Context *ctx )
{
  rtems_status_code sc;

  sc = rtems_interrupt_raise( ctx->vector );
  T_rsc_success( sc );
}

static void EntryRoutine( void *arg )
{
  Context *ctx;
  uint32_t count;

  (void) arg;
  ctx = T_fixture_context();

  count = ctx->interrupt_count;
  ctx->interrupt_count = count + 1;

  if ( ctx->do_clear ) {
    rtems_status_code sc;

    sc = rtems_interrupt_clear( ctx->vector );
    T_rsc_success( sc );
  }

  if ( count > 2 ) {
    /* Some interrupts are probably cased by a peripheral */
    Disable( ctx );
  }
}

static void CheckIsPending(
  Context                          *ctx,
  const rtems_interrupt_attributes *attr,
  bool                              has_installed_entries
)
{
  rtems_status_code sc;

  if ( has_installed_entries ) {
    /*
     * We cannot test this vector thoroughly, since it is used by a device
     * driver.
     */
    T_false( IsPending( ctx ) );
  } else if ( !attr->is_maskable ) {
    /* We can only safely test maskable interrupts */
    T_false( IsPending( ctx ) );
  } else if (
    attr->can_disable && ( attr->can_clear || attr->cleared_by_acknowledge )
  ) {
    rtems_interrupt_entry entry;
    rtems_interrupt_level level;

    ctx->interrupt_count = 0;
    ctx->do_clear = attr->can_clear && !attr->cleared_by_acknowledge;
    rtems_interrupt_entry_initialize( &entry, EntryRoutine, ctx, "Info" );
    sc = rtems_interrupt_entry_install(
      ctx->vector,
      RTEMS_INTERRUPT_UNIQUE,
      &entry
    );
    T_rsc_success( sc );

    if ( !IsPending( ctx) && ( attr->can_enable || IsEnabled( ctx ) ) ) {
      if ( attr->can_disable ) {
        Disable( ctx );
        Raise( ctx );
        T_true( IsPending( ctx ) );

        sc = rtems_interrupt_vector_enable( ctx->vector );
        T_rsc_success( sc );

        while ( ctx->interrupt_count < 1 ) {
          /* Wait */
        }
      } else {
        ++ctx->interrupt_count;
      }

      rtems_interrupt_local_disable( level );
      Raise( ctx );
      T_true( IsPending( ctx ) );
      rtems_interrupt_local_enable( level );

      while ( ctx->interrupt_count < 2 ) {
        /* Wait */
      }
    }

    sc = rtems_interrupt_entry_remove( ctx->vector, &entry );
    T_rsc_success( sc );
  }
}

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

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

    case RtemsIntrReqIsPending_Pre_Vector_NA:
      break;
  }
}

static void RtemsIntrReqIsPending_Pre_Pending_Prepare(
  RtemsIntrReqIsPending_Context    *ctx,
  RtemsIntrReqIsPending_Pre_Pending state
)
{
  switch ( state ) {
    case RtemsIntrReqIsPending_Pre_Pending_Obj: {
      /*
       * While the ``pending`` parameter references an object of type ``bool``.
       */
      ctx->pending = &ctx->pending_obj;
      break;
    }

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

    case RtemsIntrReqIsPending_Pre_Pending_NA:
      break;
  }
}

static void RtemsIntrReqIsPending_Pre_IsPending_Prepare(
  RtemsIntrReqIsPending_Context      *ctx,
  RtemsIntrReqIsPending_Pre_IsPending state
)
{
  switch ( state ) {
    case RtemsIntrReqIsPending_Pre_IsPending_Yes: {
      /*
       * While the interrupt associated with the interrupt vector specified by
       * ``vector`` was pending for the processor executing the
       * rtems_interrupt_is_pending() call at some time point during the call.
       */
      /* Validation is done by CheckIsPending() for each interrupt vector */
      break;
    }

    case RtemsIntrReqIsPending_Pre_IsPending_No: {
      /*
       * While the interrupt associated with the interrupt vector specified by
       * ``vector`` was not pending for the processor executing the
       * rtems_interrupt_is_pending() call at some time point during the call.
       */
      /* Validation is done by CheckIsPending() for each interrupt vector */
      break;
    }

    case RtemsIntrReqIsPending_Pre_IsPending_NA:
      break;
  }
}

static void RtemsIntrReqIsPending_Post_Status_Check(
  RtemsIntrReqIsPending_Context    *ctx,
  RtemsIntrReqIsPending_Post_Status state
)
{
  switch ( state ) {
    case RtemsIntrReqIsPending_Post_Status_Ok: {
      /*
       * The return status of rtems_interrupt_is_pending() shall be
       * RTEMS_SUCCESSFUL.
       */
      T_rsc_success( ctx->status );
      break;
    }

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

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

    case RtemsIntrReqIsPending_Post_Status_NA:
      break;
  }
}

static void RtemsIntrReqIsPending_Post_IsPending_Check(
  RtemsIntrReqIsPending_Context       *ctx,
  RtemsIntrReqIsPending_Post_IsPending state
)
{
  bool pending;

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

    case RtemsIntrReqIsPending_Post_IsPending_Yes: {
      /*
       * The value of the object referenced by the ``pending`` parameter shall
       * be set to true.
       */
      /* Validation is done by CheckIsPending() for each interrupt vector */
      break;
    }

    case RtemsIntrReqIsPending_Post_IsPending_No: {
      /*
       * The value of the object referenced by the ``pending`` parameter shall
       * be set to false.
       */
      /* Validation is done by CheckIsPending() for each interrupt vector */
      break;
    }

    case RtemsIntrReqIsPending_Post_IsPending_NA:
      break;
  }
}

static void RtemsIntrReqIsPending_Action( RtemsIntrReqIsPending_Context *ctx )
{
  if ( ctx->valid_vector && ctx->pending != NULL ) {
    for (
      ctx->vector = 0;
      ctx->vector < BSP_INTERRUPT_VECTOR_COUNT;
      ++ctx->vector
    ) {
      rtems_status_code          sc;
      rtems_interrupt_attributes attr;
      bool                       has_installed_entries;

      memset( &attr, 0, sizeof( attr ) );
      sc = rtems_interrupt_get_attributes( ctx->vector, &attr );

      if ( sc == RTEMS_INVALID_ID ) {
        continue;
      }

      T_rsc_success( sc );

      has_installed_entries = HasInterruptVectorEntriesInstalled( ctx->vector );
      CheckIsPending( ctx, &attr, has_installed_entries );
    }
  } else {
    if ( ctx->valid_vector ) {
      ctx->vector = 0;
    } else {
      ctx->vector = BSP_INTERRUPT_VECTOR_COUNT;
    }

    memset( &ctx->pending_obj, 0xa5, sizeof( ctx->pending_obj ) );

    ctx->status = rtems_interrupt_is_pending( ctx->vector, ctx->pending );
  }
}

typedef struct {
  uint8_t Skip : 1;
  uint8_t Pre_Vector_NA : 1;
  uint8_t Pre_Pending_NA : 1;
  uint8_t Pre_IsPending_NA : 1;
  uint8_t Post_Status : 2;
  uint8_t Post_IsPending : 2;
} RtemsIntrReqIsPending_Entry;

static const RtemsIntrReqIsPending_Entry
RtemsIntrReqIsPending_Entries[] = {
  { 0, 0, 0, 0, RtemsIntrReqIsPending_Post_Status_InvAddr,
    RtemsIntrReqIsPending_Post_IsPending_Nop },
  { 0, 0, 0, 1, RtemsIntrReqIsPending_Post_Status_InvId,
    RtemsIntrReqIsPending_Post_IsPending_Nop },
  { 0, 0, 0, 1, RtemsIntrReqIsPending_Post_Status_InvAddr,
    RtemsIntrReqIsPending_Post_IsPending_Nop },
  { 0, 0, 0, 0, RtemsIntrReqIsPending_Post_Status_Ok,
    RtemsIntrReqIsPending_Post_IsPending_Yes },
  { 0, 0, 0, 0, RtemsIntrReqIsPending_Post_Status_Ok,
    RtemsIntrReqIsPending_Post_IsPending_No }
};

static const uint8_t
RtemsIntrReqIsPending_Map[] = {
  3, 4, 0, 0, 1, 1, 2, 2
};

static size_t RtemsIntrReqIsPending_Scope( void *arg, char *buf, size_t n )
{
  RtemsIntrReqIsPending_Context *ctx;

  ctx = arg;

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

  return 0;
}

static T_fixture RtemsIntrReqIsPending_Fixture = {
  .setup = NULL,
  .stop = NULL,
  .teardown = NULL,
  .scope = RtemsIntrReqIsPending_Scope,
  .initial_context = &RtemsIntrReqIsPending_Instance
};

static inline RtemsIntrReqIsPending_Entry RtemsIntrReqIsPending_GetEntry(
  size_t index
)
{
  return RtemsIntrReqIsPending_Entries[
    RtemsIntrReqIsPending_Map[ index ]
  ];
}

/**
 * @fn void T_case_body_RtemsIntrReqIsPending( void )
 */
T_TEST_CASE_FIXTURE( RtemsIntrReqIsPending, &RtemsIntrReqIsPending_Fixture )
{
  RtemsIntrReqIsPending_Context *ctx;
  size_t index;

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

  for (
    ctx->pcs[ 0 ] = RtemsIntrReqIsPending_Pre_Vector_Valid;
    ctx->pcs[ 0 ] < RtemsIntrReqIsPending_Pre_Vector_NA;
    ++ctx->pcs[ 0 ]
  ) {
    for (
      ctx->pcs[ 1 ] = RtemsIntrReqIsPending_Pre_Pending_Obj;
      ctx->pcs[ 1 ] < RtemsIntrReqIsPending_Pre_Pending_NA;
      ++ctx->pcs[ 1 ]
    ) {
      for (
        ctx->pcs[ 2 ] = RtemsIntrReqIsPending_Pre_IsPending_Yes;
        ctx->pcs[ 2 ] < RtemsIntrReqIsPending_Pre_IsPending_NA;
        ++ctx->pcs[ 2 ]
      ) {
        RtemsIntrReqIsPending_Entry entry;
        size_t pcs[ 3 ];

        entry = RtemsIntrReqIsPending_GetEntry( index );
        ++index;

        memcpy( pcs, ctx->pcs, sizeof( pcs ) );

        if ( entry.Pre_IsPending_NA ) {
          ctx->pcs[ 2 ] = RtemsIntrReqIsPending_Pre_IsPending_NA;
        }

        RtemsIntrReqIsPending_Pre_Vector_Prepare( ctx, ctx->pcs[ 0 ] );
        RtemsIntrReqIsPending_Pre_Pending_Prepare( ctx, ctx->pcs[ 1 ] );
        RtemsIntrReqIsPending_Pre_IsPending_Prepare( ctx, ctx->pcs[ 2 ] );
        RtemsIntrReqIsPending_Action( ctx );
        RtemsIntrReqIsPending_Post_Status_Check( ctx, entry.Post_Status );
        RtemsIntrReqIsPending_Post_IsPending_Check(
          ctx,
          entry.Post_IsPending
        );
        memcpy( ctx->pcs, pcs, sizeof( ctx->pcs ) );
      }
    }
  }
}

/** @} */