summaryrefslogtreecommitdiffstats
path: root/testsuites/validation/bsps/tc-fatal-sparc-leon3-shutdown-request.c
blob: 46bc44e7cb7fb1f6d3c135cfbd171c1ee55d2e7e (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
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup BspSparcLeon3ValFatalShutdownRequest
 */

/*
 * Copyright (C) 2021, 2022 embedded brains GmbH & Co. KG
 *
 * 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 <bsp/leon3.h>
#include <rtems/sysinit.h>
#include <rtems/score/smpimpl.h>

#include "tx-support.h"

#include <rtems/test.h>

/**
 * @defgroup BspSparcLeon3ValFatalShutdownRequest \
 *   spec:/bsp/sparc/leon3/val/fatal-shutdown-request
 *
 * @ingroup TestsuitesBspsFatalSparcLeon3Shutdown
 *
 * @brief Tests the leon3 BSP family SMP-specific shutdown procedure.
 *
 * This test case performs the following actions:
 *
 * - Check the effects of the leon3 BSP family shutdown procedure.
 *
 *   - Check that the second processor was not powered down during system
 *     initialization.
 *
 *   - Wait until the second processor is powered down.
 *
 *   - Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
 *     fatal error occurred exactly once.
 *
 *   - Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
 *     fatal error occurred on the second processor.
 *
 * @{
 */

static uint32_t mpstat_during_sysinit;

static Atomic_Uint shutdown_response_counter;

static uint32_t shutdown_response_cpu_index = UINT32_MAX;

static unsigned int Add( Atomic_Uint *a, unsigned int b )
{
  return _Atomic_Fetch_add_uint( a, b, ATOMIC_ORDER_RELAXED );
}

static void ShutdownFatalHandler(
  rtems_fatal_source source,
  rtems_fatal_code   code,
  void              *arg
)
{
  T_null( arg );

  if (
    source == RTEMS_FATAL_SOURCE_SMP &&
    code == SMP_FATAL_SHUTDOWN_RESPONSE
  ) {
    (void) Add( &shutdown_response_counter, 1 );
    shutdown_response_cpu_index = rtems_scheduler_get_processor();
  }
}

static void InitBspSparcLeon3ValFatalShutdownRequest( void )
{
  irqamp                *regs;

  regs = LEON3_IrqCtrl_Regs;
  mpstat_during_sysinit = grlib_load_32( &regs->mpstat );
  SetFatalHandler( ShutdownFatalHandler, NULL );
}

RTEMS_SYSINIT_ITEM(
  InitBspSparcLeon3ValFatalShutdownRequest,
  RTEMS_SYSINIT_DEVICE_DRIVERS,
  RTEMS_SYSINIT_ORDER_MIDDLE
);

/**
 * @brief Check the effects of the leon3 BSP family shutdown procedure.
 */
static void BspSparcLeon3ValFatalShutdownRequest_Action_0( void )
{
  irqamp  *regs;
  uint32_t counter;

  regs = LEON3_IrqCtrl_Regs;

  /*
   * Check that the second processor was not powered down during system
   * initialization.
   */
  T_step_eq_u32( 0, mpstat_during_sysinit & 0x2, 0 );

  /*
   * Wait until the second processor is powered down.
   */
  while ( ( grlib_load_32( &regs->mpstat ) & 0x2 ) != 0x2U ) {
    /* Wait */
  }

  /*
   * Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
   * fatal error occurred exactly once.
   */
  counter = Add( &shutdown_response_counter, 0 );
  T_step_eq_uint( 1, counter, 1 );

  /*
   * Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
   * fatal error occurred on the second processor.
   */
  T_step_eq_u32( 2, shutdown_response_cpu_index, 1 );
}

/**
 * @fn void T_case_body_BspSparcLeon3ValFatalShutdownRequest( void )
 */
T_TEST_CASE( BspSparcLeon3ValFatalShutdownRequest )
{
  T_plan( 3 );

  BspSparcLeon3ValFatalShutdownRequest_Action_0();
}

/** @} */