RTEMS
region.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 
11 /*
12  * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
13  * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  * notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in the
22  * documentation and/or other materials provided with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 /*
38  * Do not manually edit this file. It is part of the RTEMS quality process
39  * and was automatically generated.
40  *
41  * If you find something that needs to be fixed or worded better please
42  * post a report to an RTEMS mailing list or raise a bug report:
43  *
44  * https://docs.rtems.org/branches/master/user/support/bugs.html
45  *
46  * For information on updating and regenerating please refer to:
47  *
48  * https://docs.rtems.org/branches/master/eng/req/howto.html
49  */
50 
51 /* Generated from spec:/rtems/region/if/header */
52 
53 #ifndef _RTEMS_RTEMS_REGION_H
54 #define _RTEMS_RTEMS_REGION_H
55 
56 #include <stdint.h>
57 #include <rtems/rtems/attr.h>
58 #include <rtems/rtems/options.h>
59 #include <rtems/rtems/status.h>
60 #include <rtems/rtems/types.h>
61 #include <rtems/score/heapinfo.h>
62 
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66 
67 /* Generated from spec:/rtems/region/if/group */
68 
78 /* Generated from spec:/rtems/region/if/create */
79 
98  rtems_name name,
99  void *starting_address,
100  uintptr_t length,
101  uintptr_t page_size,
102  rtems_attribute attribute_set,
103  rtems_id *id
104 );
105 
106 /* Generated from spec:/rtems/region/if/delete */
107 
116 
117 /* Generated from spec:/rtems/region/if/extend */
118 
131  rtems_id id,
132  void *starting_address,
133  uintptr_t length
134 );
135 
136 /* Generated from spec:/rtems/region/if/get-free-information */
137 
148  rtems_id id,
149  Heap_Information_block *the_info
150 );
151 
152 /* Generated from spec:/rtems/region/if/get-information */
153 
164  rtems_id id,
165  Heap_Information_block *the_info
166 );
167 
168 /* Generated from spec:/rtems/region/if/get-segment */
169 
186  rtems_id id,
187  uintptr_t size,
188  rtems_option option_set,
189  rtems_interval timeout,
190  void **segment
191 );
192 
193 /* Generated from spec:/rtems/region/if/get-segment-size */
194 
207  rtems_id id,
208  void *segment,
209  uintptr_t *size
210 );
211 
212 /* Generated from spec:/rtems/region/if/ident */
213 
247 
248 /* Generated from spec:/rtems/region/if/resize-segment */
249 
264  rtems_id id,
265  void *segment,
266  uintptr_t size,
267  uintptr_t *old_size
268 );
269 
270 /* Generated from spec:/rtems/region/if/return-segment */
271 
282 
283 #ifdef __cplusplus
284 }
285 #endif
286 
287 #endif /* _RTEMS_RTEMS_REGION_H */
This header file defines types provided by the Classic API.
uint32_t rtems_name
This type is used to represent a Classic API object name.
Definition: types.h:227
uint32_t rtems_option
This type is used to represent an option set.
Definition: options.h:121
rtems_status_code rtems_region_get_information(rtems_id id, Heap_Information_block *the_info)
%
rtems_status_code rtems_region_get_free_information(rtems_id id, Heap_Information_block *the_info)
%
Information block returned by _Heap_Get_information().
Definition: heapinfo.h:145
rtems_status_code rtems_region_return_segment(rtems_id id, void *segment)
%
rtems_status_code rtems_region_resize_segment(rtems_id id, void *segment, uintptr_t size, uintptr_t *old_size)
%
This header file defines the status codes and support functions of the Classic API.
rtems_status_code rtems_region_get_segment_size(rtems_id id, void *segment, uintptr_t *size)
%
rtems_status_code
This enumeration provides status codes for directives of the Classic API.
Definition: status.h:82
This header file defines attributes provided by the Classic API.
Heap Handler Information API.
uint32_t rtems_attribute
This type is used to represent Classic API attributes.
Definition: attr.h:91
rtems_status_code rtems_region_get_segment(rtems_id id, uintptr_t size, rtems_option option_set, rtems_interval timeout, void **segment)
%
Watchdog_Interval rtems_interval
This type is used to represent clock tick intervals.
Definition: types.h:90
Objects_Id rtems_id
Values of this type identify an RTEMS object.
Definition: types.h:99
rtems_status_code rtems_region_ident(rtems_name name, rtems_id *id)
Identifies a region object by the specified object name.
rtems_status_code rtems_region_extend(rtems_id id, void *starting_address, uintptr_t length)
%
rtems_status_code rtems_region_create(rtems_name name, void *starting_address, uintptr_t length, uintptr_t page_size, rtems_attribute attribute_set, rtems_id *id)
%
This header file defines options provided by the Classic API.
rtems_status_code rtems_region_delete(rtems_id id)
%