summaryrefslogtreecommitdiffstats
path: root/spec/rtems/part/req/get-buffer.yml
blob: 999d7cf44e76636e0cb2cfd453a3156d078d7d37 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
functional-type: action
links:
- role: interface-function
  uid: ../if/get-buffer
post-conditions:
- name: Status
  states:
  - name: Ok
    test-code: |
      T_rsc_success( ctx->status );
      T_eq_ptr( ctx->buffer_pointer, buffers );
    text: |
      The status shall be RTEMS_SUCCESSFUL.  The buffer pointer variable shall
      reference a buffer in the buffer area used to create the partition.
  - name: InvId
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_ID );
      T_eq_ptr( ctx->buffer_pointer, (void *) (uintptr_t) 1 );
    text: |
      The status shall be RTEMS_INVALID_ID.  If the buffer parameter is not
      NULL, then the value of the buffer pointer referenced by the buffer
      parameter shall be unchanged.
  - name: InvAddr
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
    text: |
      The status shall be RTEMS_INVALID_ADDRESS.
  - name: Unsatisfied
    test-code: |
      T_rsc( ctx->status, RTEMS_UNSATISFIED );
      T_eq_ptr( ctx->buffer_pointer, (void *) (uintptr_t) 1 );
    text: |
      The status shall be RTEMS_UNSATISFIED.  If the buffer parameter is not
      NULL, then the value of the buffer pointer referenced by the buffer
      parameter shall be unchanged.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: Id
  states:
  - name: NoObj
    test-code: |
      ctx->id = 0xffffffff;
    text: |
      The ${../if/get-buffer:/params[0]/name} parameter shall be invalid.
  - name: Part
    test-code: |
      ctx->id = ctx->id_value;
    text: |
      The ${../if/get-buffer:/params[0]/name} parameter shall be associated with a
      partition.
  test-epilogue: null
  test-prologue: null
- name: Buf
  states:
  - name: Valid
    test-code: |
      ctx->buffer = &ctx->buffer_pointer;
    text: |
      The ${../if/get-buffer:/params[1]/name} parameter shall reference an
      object of type ``void *``.
  - name: 'Null'
    test-code: |
      ctx->buffer = NULL;
    text: |
      The ${../if/get-buffer:/params[1]/name} parameter shall be
      ${/c/if/null:/name}.
  test-epilogue: null
  test-prologue: null
- name: Avail
  states:
  - name: 'Yes'
    test-code: |
      /* Nothing to do */
    text: |
      The partition shall have at least one free buffer available.
  - name: 'No'
    test-code: |
      sc = rtems_partition_get_buffer( ctx->id_value, &ctx->stolen_buffer );
      T_rsc_success( sc );
    text: |
      The partition shall have no buffer available.
  test-epilogue: null
  test-prologue: |
    rtems_status_code sc;
rationale: null
references: []
requirement-type: functional
skip-reasons: {}
test-action: |
  ctx->status = rtems_partition_get_buffer( ctx->id, ctx->buffer );
test-brief: null
test-cleanup: |
  rtems_status_code sc;

  if ( (uintptr_t) ctx->buffer_pointer != 1 ) {
    sc = rtems_partition_return_buffer( ctx->id_value, ctx->buffer_pointer );
    T_rsc_success( sc );
  }

  if ( ctx->stolen_buffer != NULL ) {
    sc = rtems_partition_return_buffer( ctx->id_value, ctx->stolen_buffer );
    T_rsc_success( sc );
  }
test-context:
- brief: null
  description: null
  member: rtems_status_code status
- brief: null
  description: null
  member: rtems_id id
- brief: null
  description: null
  member: rtems_id id_value
- brief: null
  description: null
  member: void **buffer
- brief: null
  description: null
  member: void *buffer_pointer
- brief: null
  description: null
  member: void *stolen_buffer
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
test-local-includes: []
test-prepare: |
  ctx->buffer_pointer = (void *) (uintptr_t) 1;
  ctx->stolen_buffer = NULL;
test-setup:
  brief: null
  code: |
    rtems_status_code sc;

    ctx->id_value = 0;
    sc = rtems_partition_create(
      rtems_build_name( 'N', 'A', 'M', 'E' ),
      buffers,
      sizeof( buffers ),
      sizeof( buffers[ 0 ] ),
      RTEMS_DEFAULT_ATTRIBUTES,
      &ctx->id_value
    );
    T_assert_rsc_success( sc );
  description: null
test-stop: null
test-support: |
  #define BUFFER_COUNT 1

  #define BUFFER_SIZE ( 2 * sizeof( void * ) )

  static RTEMS_ALIGNED( RTEMS_PARTITION_ALIGNMENT ) uint8_t
    buffers[ BUFFER_COUNT ][ BUFFER_SIZE ];
test-target: testsuites/validation/tc-part-get.c
test-teardown:
  brief: null
  code: |
    if ( ctx->id_value != 0 ) {
      rtems_status_code sc;

      sc = rtems_partition_delete( ctx->id_value );
      T_rsc_success( sc );
    }
  description: null
text: ${.:text-template}
transition-map:
- enabled-by: true
  post-conditions:
    Status: Ok
  pre-conditions:
    Avail:
    - 'Yes'
    Buf:
    - Valid
    Id:
    - Part
- enabled-by: true
  post-conditions:
    Status: InvAddr
  pre-conditions:
    Avail: all
    Buf:
    - 'Null'
    Id: all
- enabled-by: true
  post-conditions:
    Status: InvId
  pre-conditions:
    Avail: all
    Buf:
    - Valid
    Id:
    - NoObj
- enabled-by: true
  post-conditions:
    Status: Unsatisfied
  pre-conditions:
    Avail:
    - 'No'
    Buf:
    - Valid
    Id:
    - Part
type: requirement