summaryrefslogtreecommitdiffstats
path: root/spec/rtems/task/req/wake-after.yml
blob: 860796f801641c3e1978b362a0011e0226212404 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
functional-type: action
links:
- role: interface-function
  uid: ../if/wake-after
post-conditions:
- name: Status
  states:
  - name: Ok
    test-code: |
      T_rsc_success( ctx->status );
    text: |
      The return status of ${../if/wake-after:/name} shall be
      ${../../status/if/successful:/name}.
  test-epilogue: null
  test-prologue: null
- name: Timer
  states:
  - name: Inactive
    test-code: |
      T_eq_int( ctx->timer_info.state, TASK_TIMER_INACTIVE );
    text: |
      The timer of the calling task shall be inactive.
  - name: Ticks
    test-code: |
      T_eq_int( ctx->timer_info.state, TASK_TIMER_TICKS );
    text: |
      The timer of the calling task shall be active using the
      ${/glossary/clock-tick:/term}.
  test-epilogue: null
  test-prologue: null
- name: Expire
  states:
  - name: Relative
    test-code: |
      T_eq_u64( ctx->timer_info.expire_ticks, ctx->now + UINT32_MAX );
    text: |
      The timer of the calling task shall expire at the time point specified by
      the sum of the current ${/glossary/clock-tick:/term} and the interval
      specified by the ${../if/wake-after:/params[0]/name} parameter.
  test-epilogue: null
  test-prologue: null
- name: Scheduler
  states:
  - name: Block
    test-code: |
      T_eq_sz( ctx->scheduler_log.header.recorded, 1 );
      T_eq_int(
        ctx->scheduler_log.events[ 0 ].operation,
        T_SCHEDULER_BLOCK
      );
    text: |
      The calling task shall be blocked by the scheduler exactly once by the
      ${../if/wake-after:/name} call.
  - name: Yield
    test-code: |
      T_eq_sz( ctx->scheduler_log.header.recorded, 1 );
      T_eq_int(
        ctx->scheduler_log.events[ 0 ].operation,
        T_SCHEDULER_YIELD
      );
    text: |
      The calling task shall yield by the scheduler exactly once by the
      ${../if/wake-after:/name} call.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: Ticks
  states:
  - name: Yield
    test-code: |
      ctx->ticks = RTEMS_YIELD_PROCESSOR;
    text: |
      While the ${../if/wake-after:/params[0]/name} parameter is equal to
      ${../if/yield-processor:/name}.
  - name: Interval
    test-code: |
      ctx->ticks = UINT32_MAX;
    text: |
      While the ${../if/wake-after:/params[0]/name} parameter is not equal to
      ${../if/yield-processor:/name}.
  test-epilogue: null
  test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons: {}
test-action: |
  ResumeTask( ctx->worker_id );
  (void) T_scheduler_record( NULL );
  GetTaskTimerInfo( ctx->worker_id, &ctx->timer_info );
  FinalClockTick();
test-brief: null
test-cleanup: null
test-context:
- brief: |
    This member provides the scheduler operation records.
  description: null
  member: |
    T_scheduler_log_4 scheduler_log;
- brief: |
    This member contains the ${/glossary/clock-tick:/term} value before the
    ${../if/wake-after:/name} call.
  description: null
  member: |
    uint64_t now;
- brief: |
    This member contains the worker task identifier.
  description: null
  member: |
    rtems_id worker_id;
- brief: |
    This member contains the timer information of the worker task.
  description: null
  member: |
    TaskTimerInfo timer_info;
- brief: |
    This member contains the return value of the ${../if/wake-after:/name}
    call.
  description: null
  member: |
    rtems_status_code status
- brief: |
    This member specifies the ${../if/wake-after:/params[0]/name} parameter
    value.
  description: null
  member: |
    rtems_interval ticks
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
- rtems/test-scheduler.h
- rtems/score/timecounter.h
test-local-includes:
- tx-support.h
test-prepare: |
  ctx->status = RTEMS_NOT_IMPLEMENTED;
test-setup:
  brief: null
  code: |
    SetSelfPriority( PRIO_NORMAL );
    ctx->worker_id = CreateTask( "WORK", PRIO_HIGH );
    StartTask( ctx->worker_id, Worker, ctx );
  description: null
test-stop: null
test-support: |
  typedef RtemsTaskReqWakeAfter_Context Context;

  static void Worker( rtems_task_argument arg )
  {
    Context *ctx;

    ctx = (Context *) arg;

    while ( true ) {
      T_scheduler_log *log;

      SuspendSelf();

      log = T_scheduler_record_4( &ctx->scheduler_log );
      T_null( log );

      ctx->now = rtems_clock_get_ticks_since_boot();

      ctx->status = rtems_task_wake_after( ctx->ticks );

      (void) T_scheduler_record( NULL );
    }
  }
test-target: testsuites/validation/tc-task-wake-after.c
test-teardown:
  brief: null
  code: |
    DeleteTask( ctx->worker_id );
    RestoreRunnerPriority();
  description: null
text: ${.:text-template}
transition-map:
- enabled-by: true
  post-conditions:
    Status: Ok
    Timer: Ticks
    Expire: Relative
    Scheduler: Block
  pre-conditions:
    Ticks:
    - Interval
- enabled-by: true
  post-conditions:
    Status: Ok
    Timer: Inactive
    Expire: N/A
    Scheduler: Yield
  pre-conditions:
    Ticks:
    - Yield
type: requirement