summaryrefslogtreecommitdiffstats
path: root/spec/rtems/part/req/return-buffer.yml
blob: 2869b998787d318489414888fd80589d03de8fd1 (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
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/return-buffer
post-conditions:
- name: Status
  states:
  - name: Ok
    test-code: |
      T_rsc_success( ctx->status );

      sc = rtems_partition_get_buffer( ctx->id_value, &ctx->buffer_in_use );
      T_rsc_success( sc );
      T_eq_ptr( ctx->buffer_in_use, buffers );
    text: |
      The status shall be RTEMS_SUCCESSFUL.  The returned buffer shall be made
      available for re-use.
  - name: InvId
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_ID );
    text: |
      The status shall be RTEMS_INVALID_ID.
  - name: InvAddr
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
    text: |
      The status shall be RTEMS_INVALID_ADDRESS.
  test-epilogue: null
  test-prologue: |
    rtems_status_code sc;
pre-conditions:
- name: Id
  states:
  - name: Id
    test-code: |
      ctx->id = ctx->id_value;
    text: |
      The id parameter shall reference a partition object.
  - name: Invalid
    test-code: |
      ctx->id = 0;
    text: |
      The id parameter shall not reference a partition object.
  test-epilogue: null
  test-prologue: null
- name: Buf
  states:
  - name: Valid
    test-code: |
      ctx->buffer = ctx->buffer_in_use;
    text: |
      The buffer parameter shall reference a buffer previously returned by
      ${../if/get-buffer:/name}.
  - name: Invalid
    test-code: |
      ctx->buffer = (void *) (uintptr_t) 1;
    text: |
      The buffer parameter shall be an address outside the buffer area of the
      partition.
  test-epilogue: null
  test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons: {}
test-action: |
  ctx->status = rtems_partition_return_buffer( ctx->id, ctx->buffer );
test-brief: null
test-cleanup: null
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_in_use
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
test-local-includes: []
test-prepare: null
test-setup:
  brief: null
  code: |
    rtems_status_code sc;

    ctx->buffer_in_use = 0;
    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 );

    sc = rtems_partition_get_buffer( ctx->id_value, &ctx->buffer_in_use );
    T_assert_rsc_success( sc );
    T_assert_eq_ptr( ctx->buffer_in_use, buffers );
  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-return.c
test-teardown:
  brief: null
  code: |
    rtems_status_code sc;

    if ( ctx->buffer_in_use != NULL ) {
      sc = rtems_partition_return_buffer( ctx->id_value, ctx->buffer_in_use );
      T_rsc_success( sc );
    }

    if ( ctx->id_value != 0 ) {
      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:
    Buf:
    - Valid
    Id:
    - Id
- enabled-by: true
  post-conditions:
    Status: InvId
  pre-conditions:
    Buf: all
    Id:
    - Invalid
- enabled-by: true
  post-conditions:
    Status: InvAddr
  pre-conditions:
    Buf:
    - Invalid
    Id:
    - Id
type: requirement