RTEMS
part.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/part/if/header */
52 
53 #ifndef _RTEMS_RTEMS_PART_H
54 #define _RTEMS_RTEMS_PART_H
55 
56 #include <stddef.h>
57 #include <stdint.h>
58 #include <rtems/rtems/attr.h>
59 #include <rtems/rtems/status.h>
60 #include <rtems/rtems/types.h>
61 #include <rtems/score/cpu.h>
62 
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66 
67 /* Generated from spec:/rtems/part/if/group */
68 
78 /* Generated from spec:/rtems/part/if/alignment */
79 
89 #define RTEMS_PARTITION_ALIGNMENT CPU_SIZEOF_POINTER
90 
91 /* Generated from spec:/rtems/part/if/create */
92 
192  rtems_name name,
193  void *starting_address,
194  uintptr_t length,
195  size_t buffer_size,
196  rtems_attribute attribute_set,
197  rtems_id *id
198 );
199 
200 /* Generated from spec:/rtems/part/if/delete */
201 
238 
239 /* Generated from spec:/rtems/part/if/get-buffer */
240 
276 
277 /* Generated from spec:/rtems/part/if/ident */
278 
335  rtems_name name,
336  uint32_t node,
337  rtems_id *id
338 );
339 
340 /* Generated from spec:/rtems/part/if/return-buffer */
341 
372 
373 #ifdef __cplusplus
374 }
375 #endif
376 
377 #endif /* _RTEMS_RTEMS_PART_H */
This header file defines types provided by the Classic API.
rtems_status_code rtems_partition_get_buffer(rtems_id id, void **buffer)
Tries to get a buffer from the specified partition.
Definition: partgetbuffer.c:23
uint32_t rtems_name
This type is used to represent a Classic API object name.
Definition: types.h:227
rtems_status_code rtems_partition_create(rtems_name name, void *starting_address, uintptr_t length, size_t buffer_size, rtems_attribute attribute_set, rtems_id *id)
Creates a partition.
Definition: partcreate.c:30
rtems_status_code rtems_partition_delete(rtems_id id)
Deletes the specified partition.
Definition: partdelete.c:24
This header file defines the status codes and support functions of the Classic API.
rtems_status_code rtems_partition_return_buffer(rtems_id id, void *buffer)
Returns a buffer to the specified partition.
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.
SPARC CPU Department Source.
uint32_t rtems_attribute
This type is used to represent Classic API attributes.
Definition: attr.h:91
Objects_Id rtems_id
Values of this type identify an RTEMS object.
Definition: types.h:99
rtems_status_code rtems_partition_ident(rtems_name name, uint32_t node, rtems_id *id)
Identifies a partition object by the specified object name.
Definition: partident.c:44