blob: 3e1843978a84009dbdd42795b75b02251ac45f27 (
plain) (
tree)
|
|
/**
* @file rtems/rtems/part.h
*
* This include file contains all the constants and structures associated
* with the Partition Manager. This manager provides facilities to
* dynamically allocate memory in fixed-sized units which are returned
* as buffers.
*
* Directives provided are:
*
* - create a partition
* - get an ID of a partition
* - delete a partition
* - get a buffer from a partition
* - return a buffer to a partition
*/
/* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
* $Id$
*/
#ifndef _RTEMS_RTEMS_PART_H
#define _RTEMS_RTEMS_PART_H
/**
* This constant is defined to extern most of the time when using
* this header file. However by defining it to nothing, the data
* declared in this header file can be instantiated. This is done
* in a single per manager file.
*/
#ifndef RTEMS_PART_EXTERN
#define RTEMS_PART_EXTERN extern
#endif
#ifdef __cplusplus
extern "C" {
#endif
#include <rtems/score/address.h>
#include <rtems/score/object.h>
#include <rtems/rtems/attr.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/support.h>
#include <rtems/rtems/types.h>
/**
* @defgroup ClassicPart Classic API Partition
*
* This encapsulates functionality which XXX
*/
/**@{*/
/**
* The following defines the control block used to manage each partition.
*/
typedef struct {
Objects_Control Object;
void *starting_address; /* physical address */
uint32_t length; /* in bytes */
uint32_t buffer_size; /* in bytes */
rtems_attribute attribute_set; /* attributes */
uint32_t number_of_used_blocks; /* or allocated buffers */
Chain_Control Memory; /* buffer chain */
} Partition_Control;
/**
* The following defines the information control block used to
* manage this class of objects.
*/
RTEMS_PART_EXTERN Objects_Information _Partition_Information;
/**
* @brief Partition_Manager_initialization
*
* This routine performs the initialization necessary for this manager.
*/
void _Partition_Manager_initialization(
uint32_t maximum_partitions
);
/**
* @brief rtems_partition_create
*
* This routine implements the rtems_partition_create directive. The
* partition will have the name name. The memory area managed by
* the partition is of length bytes and starts at starting_address.
* The memory area will be divided into as many buffers of
* buffer_size bytes as possible. The attribute_set determines if
* the partition is global or local. It returns the id of the
* created partition in ID.
*/
rtems_status_code rtems_partition_create(
rtems_name name,
void *starting_address,
uint32_t length,
uint32_t buffer_size,
rtems_attribute attribute_set,
Objects_Id *id
);
/**
* @brief rtems_partition_ident
*
* This routine implements the rtems_partition_ident directive.
* This directive returns the partition ID associated with name.
* If more than one partition is named name, then the partition
* to which the ID belongs is arbitrary. node indicates the
* extent of the search for the ID of the partition named name.
* The search can be limited to a particular node or allowed to
* encompass all nodes.
*/
rtems_status_code rtems_partition_ident(
rtems_name name,
uint32_t node,
Objects_Id *id
);
/**
* @brief rtems_partition_delete
*
* This routine implements the rtems_partition_delete directive. The
* partition indicated by ID is deleted.
*/
rtems_status_code rtems_partition_delete(
Objects_Id id
);
/**
* @brief rtems_partition_get_buffer
*
* This routine implements the rtems_partition_get_buffer directive. It
* attempts to allocate a buffer from the partition associated with ID.
* If a buffer is allocated, its address is returned in buffer.
*/
rtems_status_code rtems_partition_get_buffer(
Objects_Id id,
void **buffer
);
/**
* @brief rtems_partition_return_buffer
*
* This routine implements the rtems_partition_return_buffer directive. It
* frees the buffer to the partition associated with ID. The buffer must
* have been previously allocated from the same partition.
*/
rtems_status_code rtems_partition_return_buffer(
Objects_Id id,
void *buffer
);
#ifndef __RTEMS_APPLICATION__
#include <rtems/rtems/part.inl>
#endif
#if defined(RTEMS_MULTIPROCESSING)
#include <rtems/rtems/partmp.h>
#endif
#ifdef __cplusplus
}
#endif
/**@}*/
#endif
/* end of include file */
|
